feat: support wildcards in model paths #543

SoulPancake · 2025-07-14T06:03:46Z

Solves _
#538

Review Checklist

I have clicked on "allow edits by maintainers".
I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
The correct base branch is being used, if not main
I have added tests to validate that the change in functionality is working as expected

Summary by CodeRabbit

New Features
- Added support for using wildcard (glob) patterns when specifying module files in the authorization model configuration, allowing for more flexible file inclusion.
Bug Fixes
- Improved error reporting for cases where wildcard patterns do not match any files or file loading fails.
Tests
- Introduced comprehensive tests to verify correct handling of wildcard patterns and error scenarios in model loading.

coderabbitai · 2025-07-14T06:03:52Z

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes update the authorization model loader to support glob patterns in module file references within the fga.mod file. The loader now expands file patterns, reads all matching files, and improves error handling. Corresponding tests were added to verify correct behavior for wildcards, explicit files, and error scenarios.

Changes

File(s)	Change Summary
internal/authorizationmodel/model.go	Enhanced `ReadModelFromModFGA` to support glob patterns, expanded error handling, and file loading logic.
internal/authorizationmodel/model_test.go	Added tests for wildcard support in module loading and a helper for writing module fragments.

Sequence Diagram(s)

sequenceDiagram
    participant Test as Test Runner
    participant AuthzModel as AuthzModel
    participant FileSystem as File System

    Test->>AuthzModel: ReadModelFromModFGA(modFile)
    AuthzModel->>FileSystem: Read fga.mod
    loop For each file pattern in fga.mod
        AuthzModel->>FileSystem: Expand pattern with Glob
        alt Matches found
            loop For each matched file
                AuthzModel->>FileSystem: Read file
                AuthzModel->>AuthzModel: Append content
            end
        else No matches
            AuthzModel->>AuthzModel: Record error
        end
    end
    AuthzModel-->>Test: Return error (if any) and loaded types

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.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

rhamzeh · 2025-07-14T16:55:45Z

internal/authorizationmodel/model_test.go

+
+func writeModuleFragment(t *testing.T, dir, name, content string) {
+	t.Helper()
+	fullPath := filepath.Join(dir, name+".fga")


If a test needs to write a file to the filesystem, then it must be under the system's tmp files and not the project directory.

https://gobyexample.com/temporary-files-and-directories

Agreed, I will do that asap

aaguiarz · 2025-07-15T15:16:12Z

Hi @SoulPancake

To have confidence about the approach, we'd need to explore what's possible on the VS Code integration side. Currently, the VS code add-in loads the fga.mod file and complies all the modules to validate tuples/tests.

Once the fga.mod support wildcards, we'll need to have a strategy to reload the model when a module is added to a folder that's included in the wildcard. We can reload every X seconds, or 'watch' for changes in the folder hierarchy. That needs to be implemented in the VS code integration repository https://github.com/openfga/vscode-ext.

Would it be possible for you to give that a try?

cc @rhamzeh

SoulPancake · 2025-07-15T16:12:39Z

Yes sure @aaguiarz
I'm happy to dive into the VS Code integration and explore how we can implement the strategy for reloading the model when a new module is added.

That said, just to clarify, this PR for the CLI is somewhat separate from the VS Code extension. So, we can definitely move ahead with reviews and progress on that side of things while I work on the VS Code-related changes.

aaguiarz · 2025-07-15T16:45:54Z

Yes, it's a different PR can be merged independently, but we want to make sure we have a good solution for VS Code before merging it.

feat: support wildcards in model paths

b1ac03d

SoulPancake requested a review from a team as a code owner July 14, 2025 06:03

SoulPancake mentioned this pull request Jul 14, 2025

[Feature] Support wildcards in model paths for '.fga' files #538

Open

rhamzeh reviewed Jul 14, 2025

View reviewed changes

feat: use temp writes for tests

8e38e4c

Copilot AI mentioned this pull request Jul 19, 2025

Add wildcard module path support to fga.mod files SoulPancake/openFGAVSCExt#1

Merged

SoulPancake mentioned this pull request Jul 24, 2025

feat: Wildcard file watcher changes, reload model openfga/vscode-ext#388

Open

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: support wildcards in model paths #543

feat: support wildcards in model paths #543

Uh oh!

SoulPancake commented Jul 14, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jul 14, 2025 •

edited

Loading

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

rhamzeh Jul 14, 2025

Uh oh!

SoulPancake Jul 14, 2025

Uh oh!

aaguiarz commented Jul 15, 2025

Uh oh!

SoulPancake commented Jul 15, 2025

Uh oh!

aaguiarz commented Jul 15, 2025

Uh oh!

Uh oh!

feat: support wildcards in model paths #543

Are you sure you want to change the base?

feat: support wildcards in model paths #543

Uh oh!

Conversation

SoulPancake commented Jul 14, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review Checklist

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jul 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

rhamzeh Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

SoulPancake Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

aaguiarz commented Jul 15, 2025

Uh oh!

SoulPancake commented Jul 15, 2025

Uh oh!

aaguiarz commented Jul 15, 2025

Uh oh!

Uh oh!

SoulPancake commented Jul 14, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 14, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)