OpenFGA v1.9.0 Update #1063
OpenFGA v1.9.0 Update #1063
Conversation
- Update configuration documentation to reference v1.8.15 - Update resolveNodeBreadthLimit default value from 100 to 10 - Update dependencies to latest versions
- Update configuration documentation to reference v1.9.0 - Update schema reference links to point to v1.9.0 release
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughThe documentation for OpenFGA's configuration was updated to version 1.9.0, with new and reorganized configuration options, including secondary datastore parameters and iterator cache settings. Dependency versions in Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Documentation
User ->> Documentation: Reads configuration options
Documentation -->> User: Presents updated options (v1.9.0)
User ->> Documentation: Looks for datastore and caching settings
Documentation -->> User: Shows new secondary datastore and iterator cache configs
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
package-lock.jsonis excluded by!**/package-lock.json
📒 Files selected for processing (2)
docs/content/getting-started/setup-openfga/configuration.mdx(4 hunks)package.json(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)
- GitHub Check: deploy-preview
- GitHub Check: Test deployment
- GitHub Check: markdown-link-check
- GitHub Check: Run Checks
- GitHub Check: markdown-link-check-md
- GitHub Check: Socket Security: Pull Request Alerts
🔇 Additional comments (5)
package.json (2)
28-32: Confirm Docusaurus 3.8.1 requirements & breaking-change notes
@docusaurus/*was bumped from 3.7.0 → 3.8.1.
The minor bump may introduce peer-dependency or Node-engine shifts (e.g. minimum Node 18). Please confirm the docs site still builds in CI and locally after this upgrade.
56-57: Major ESLint jump – ensure config compatibility
eslintjumped 8 → 9. This is a semver-major release; many core rules were renamed/removed and the default parser options changed. Runnpm run lintlocally and in CI to catch any rule breakage or phantom errors, and upgrade shareable configs/plugins if needed (eslint-plugin-react@7is still compatible but double-check).docs/content/getting-started/setup-openfga/configuration.mdx (3)
119-119: Default reduced from 100 → 10 – double-check source code
resolveNodeBreadthLimitdefault is now documented as 10. Verify the server actually ships with this new default; otherwise the doc will mislead users.
137-141: Secondary datastore options look goodNice addition of
secondaryUri,secondaryUsername, andsecondaryPassword; the Env-Var and flag names follow the existing pattern.
191-197: Iterator-cache options added – wording matches Check cacheThe new
listObjectsIteratorCache.*rows are clear and consistent.
| | `listUsersDispatchThrottling.frequency` | <div id="OPENFGA_LIST_USERS_DISPATCH_THROTTLING_FREQUENCY"><code>OPENFGA_LIST_USERS_DISPATCH_THROTTLING_FREQUENCY</code></div> | `list-users-dispatch-throttling-frequency` | string (duration) | the frequency period that the deprioritized throttling queue is evaluated for a list users request. A higher value will result in more aggressive throttling | `10µs` | | ||
| | `listUsersDispatchThrottling.threshold` | <div id="OPENFGA_LIST_USERS_DISPATCH_THROTTLING_THRESHOLD"><code>OPENFGA_LIST_USERS_DISPATCH_THROTTLING_THRESHOLD</code></div> | `list-users-dispatch-throttling-threshold` | integer | define the number of recursive operations to occur before getting throttled for a list users request | `100` | | ||
| | `listUsersDispatchThrottling.maxThreshold` | <div id="OPENFGA_LIST_USERS_DISPATCH_THROTTLING_MAX_THRESHOLD"><code>OPENFGA_LIST_USERS_DISPATCH_THROTTLING_MAX_THRESHOLD</code></div> | `list-users-dispatch-throttling-max-threshold` | integer | define the maximum dispatch threshold beyond above which requests will be throttled for a list users request. 0 will use the 'dispatchThrottling.threshold' value as maximum | `0` | | ||
| | `sharedIterator` | | `` | | | | |
There was a problem hiding this comment.
sharedIterator row is blank – fill in or remove
The table entry for sharedIterator has no Env Var, flag, type, description, or default. Either supply the missing details or drop the row to avoid confusing readers.
-| `sharedIterator` | | `` | | | |
+| `sharedIterator.enabled` | <div id="OPENFGA_SHARED_ITERATOR_ENABLED"><code>OPENFGA_SHARED_ITERATOR_ENABLED</code></div> | `shared-iterator-enabled` | boolean | (add description here) | `false` |📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | `sharedIterator` | | `` | | | | | |
| -| `sharedIterator` | | `` | | | | | |
| +| `sharedIterator.enabled` | <div id="OPENFGA_SHARED_ITERATOR_ENABLED"><code>OPENFGA_SHARED_ITERATOR_ENABLED</code></div> | `shared-iterator-enabled` | boolean | (add description here) | `false` | |
🤖 Prompt for AI Agents
In docs/content/getting-started/setup-openfga/configuration.mdx at line 202, the
table row for `sharedIterator` is completely blank with no environment variable,
flag, type, description, or default value. Either fill in all the missing
details for `sharedIterator` to provide complete information or remove the
entire row from the table to prevent confusion for readers.
|
Hey @Siddhant-K-code! Thanks for splitting it out! Can you make sure to update the eslint config so that the tests pass? |
rhamzeh
left a comment
rhamzeh
left a comment
There was a problem hiding this comment.
Can you remove the unrelated parts from this PR?
|
@rhamzeh, Lint checks are failing due to unrelated changes 👀 
We need to update link or remove the following section: |
|
That's OK I fixed that in your other PR |
2 participants
Documentation update from v1.8.15 → v1.9.0
Related #1054
Summary by CodeRabbit