feat: support use of module keyword

ewanharris commented 7 months ago

Description

Adds support for the module keyword in the grammar, there's a couple things that I'm not 100% certain of (hence draft for feedback):

Passing both module and model causes an error, but I don't know if we can improve the error message received - no viable alternative at input '\nmodule'
Currently validation fails because when parsing the DSL we don't know the schema version to use so will error, I think we might need to allow passing the version obtained from a go.mod file into validate in some way? Which is probably outside the scope of this PR.
I changed the existing validation to throw if we can't determine a schema version, otherwise when we get to the switch further down we can't blow up trying to determine line numbers, this might want to be changed to only throw in the case of a single file module.

References

Closes #150, #151

Review Checklist

[x] 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]
[x] 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

rhamzeh commented 7 months ago

We shouldn't be validating a partial model, only after all the pieces are collected can we validate

ewanharris commented 7 months ago

@rhamzeh I'm not sure I follow, are you saying that when processing modular models the intention is to construct the final model and then pass that to validateDSL rather than the individual model modules?

rhamzeh commented 7 months ago

when processing modular models the intention is to construct the final model and then pass that to validateDSL rather than the individual model modules?

Yes, the parser will handle validating the model syntactically, but you cannot validate it semantically, because it will need data from the other files.

E.g. user is not in that file, so validation will naturally fail until you have collected all the files in the model

ewanharris commented 7 months ago

So should validateDSL throw an error along the lines of cannot validate individual module if passed a module DSL?

ewanharris commented 7 months ago

@rhamzeh I've added a folder that represents the JSON<->DSL transform expected cases but have skipped it and the module name setting for now until we extend the AuthorizationModel definition to include the extra metadata we'll be adding

openfga / language