feat: support initial model and tuple loading#171
Conversation
Adds OpenFGA startup initialization analogous to Spring Boot's schema.sql/data.sql. When openfga.initialization.mode=embedded, an OpenFgaInitializer ApplicationRunner writes the configured authorization model and optional initial tuples into the store at startup, skipping when a model already exists. Closes openfga#57
|
Warning Review limit reached
More reviews will be available in 25 minutes and 55 seconds. Learn how PR review limits work. Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file). ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits. 🚦 How do rate limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (8)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
Adds optional OpenFGA startup initialization (model + optional tuples) driven by new openfga.initialization.* properties, similar in spirit to Spring Boot SQL initialization.
Changes:
- Introduces
OpenFgaInitializer(ApplicationRunner) to write an authorization model and optional tuples at startup whenmode=embedded. - Extends
OpenFgaPropertieswith initialization configuration + validation for requiredmodel-locationin embedded mode. - Wires initializer creation into
OpenFgaAutoConfigurationand addsApplicationContextRunnertests plus JSON fixtures.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/main/java/dev/openfga/autoconfigure/OpenFgaInitializer.java | New startup initializer that checks for an existing model, writes model, then optionally writes tuples. |
| src/main/java/dev/openfga/autoconfigure/OpenFgaAutoConfiguration.java | Conditionally registers OpenFgaInitializer bean when openfga.initialization.mode=embedded. |
| src/main/java/dev/openfga/autoconfigure/OpenFgaProperties.java | Adds initialization config block and validates model-location for embedded mode. |
| src/test/java/dev/openfga/autoconfigure/OpenFgaAutoConfigurationTests.java | Adds coverage for initializer bean conditional creation and validation failure case. |
| src/test/resources/fga/model.json | Test fixture for an example authorization model payload. |
| src/test/resources/fga/tuples.json | Test fixture for an example initial tuples payload. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| if (initialization != null | ||
| && initialization.getMode() == InitializationMode.EMBEDDED | ||
| && !StringUtils.hasText(initialization.getModelLocation())) { | ||
| throw new IllegalStateException( | ||
| "initialization.model-location must be set when initialization.mode is 'EMBEDDED'"); | ||
| } |
| private boolean authorizationModelExists() throws Exception { | ||
| return fgaClient.readLatestAuthorizationModel().get().getAuthorizationModel() != null; | ||
| } |
| String authorizationModelId = | ||
| fgaClient.writeAuthorizationModel(request).get().getAuthorizationModelId(); |
| fgaClient | ||
| .write( | ||
| request, | ||
| new ClientWriteOptions() | ||
| .authorizationModelId(authorizationModelId) | ||
| .disableTransactions(true)) | ||
| .get(); |
| stubResource("classpath:fga/tuples.json", "[]".getBytes()); | ||
| when(objectMapper.readValue("{}".getBytes(), WriteAuthorizationModelRequest.class)) | ||
| .thenReturn(new WriteAuthorizationModelRequest()); | ||
| when(objectMapper.readValue("[]".getBytes(), ClientWriteRequest.class)).thenReturn(new ClientWriteRequest()); |
Adds startup initialization, the OpenFGA analogue of
data.sql: whenopenfga.initialization.mode=embedded, it writes an authorization model (and optional tuples) from configured resource locations. Idempotent (skips if the store already has a model) and fails fast on bad config.Assumes
openfga.store-idis set; auto-creating a store could be a follow-up.Closes #57.