-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #432 from authzed/add-zed-schema-compile-command
Add zed schema compile command
- Loading branch information
Showing
6 changed files
with
132 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,5 @@ | ||
| dist/ | ||
| temp/ | ||
|
|
||
| # Local-only files | ||
| go.work | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,119 @@ | ||
| package cmd | ||
|
|
||
| import ( | ||
| "errors" | ||
| "fmt" | ||
| "os" | ||
| "path/filepath" | ||
|
|
||
| newcompiler "github.com/authzed/spicedb/pkg/composableschemadsl/compiler" | ||
| newinput "github.com/authzed/spicedb/pkg/composableschemadsl/input" | ||
| "github.com/authzed/spicedb/pkg/schemadsl/compiler" | ||
| "github.com/authzed/spicedb/pkg/schemadsl/generator" | ||
| "github.com/ccoveille/go-safecast" | ||
| "github.com/jzelinskie/cobrautil/v2" | ||
| "github.com/rs/zerolog/log" | ||
| "github.com/spf13/cobra" | ||
| "golang.org/x/term" | ||
|
|
||
| "github.com/authzed/zed/internal/commands" | ||
| ) | ||
|
|
||
| func registerPreviewCmd(rootCmd *cobra.Command) { | ||
| rootCmd.AddCommand(previewCmd) | ||
|
|
||
| previewCmd.AddCommand(schemaCmd) | ||
|
|
||
| schemaCmd.AddCommand(schemaCompileCmd) | ||
| schemaCompileCmd.Flags().String("out", "", "output filepath; omitting writes to stdout") | ||
| } | ||
|
|
||
| var previewCmd = &cobra.Command{ | ||
| Use: "preview <subcommand>", | ||
| Short: "Experimental commands that have been made available for preview", | ||
| } | ||
|
|
||
| var schemaCmd = &cobra.Command{ | ||
| Use: "schema <subcommand>", | ||
| Short: "Manage schema for a permissions system", | ||
| } | ||
|
|
||
| var schemaCompileCmd = &cobra.Command{ | ||
| Use: "compile <file>", | ||
| Args: cobra.ExactArgs(1), | ||
| Short: "Compile a schema that uses extended syntax into one that can be written to SpiceDB", | ||
| Example: ` | ||
| Write to stdout: | ||
| zed preview schema compile root.zed | ||
| Write to an output file: | ||
| zed preview schema compile --out compiled.zed | ||
| `, | ||
| ValidArgsFunction: commands.FileExtensionCompletions("zed"), | ||
| RunE: schemaCompileCmdFunc, | ||
| } | ||
|
|
||
| // Compiles an input schema written in the new composable schema syntax | ||
| // and produces it as a fully-realized schema | ||
| func schemaCompileCmdFunc(cmd *cobra.Command, args []string) error { | ||
| stdOutFd, err := safecast.ToInt(uint(os.Stdout.Fd())) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| outputFilepath := cobrautil.MustGetString(cmd, "out") | ||
| if outputFilepath == "" && !term.IsTerminal(stdOutFd) { | ||
| return fmt.Errorf("must provide stdout or output file path") | ||
| } | ||
|
|
||
| inputFilepath := args[0] | ||
| inputSourceFolder := filepath.Dir(inputFilepath) | ||
| var schemaBytes []byte | ||
| schemaBytes, err = os.ReadFile(inputFilepath) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to read schema file: %w", err) | ||
| } | ||
| log.Trace().Str("schema", string(schemaBytes)).Str("file", args[0]).Msg("read schema from file") | ||
|
|
||
| if len(schemaBytes) == 0 { | ||
| return errors.New("attempted to compile empty schema") | ||
| } | ||
|
|
||
| compiled, err := newcompiler.Compile(newcompiler.InputSchema{ | ||
| Source: newinput.Source(inputFilepath), | ||
| SchemaString: string(schemaBytes), | ||
| }, newcompiler.AllowUnprefixedObjectType(), | ||
| newcompiler.SourceFolder(inputSourceFolder)) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| // Attempt to cast one kind of OrderedDefinition to another | ||
| oldDefinitions := make([]compiler.SchemaDefinition, 0, len(compiled.OrderedDefinitions)) | ||
| for _, definition := range compiled.OrderedDefinitions { | ||
| oldDefinition, ok := definition.(compiler.SchemaDefinition) | ||
| if !ok { | ||
| return fmt.Errorf("could not convert definition to old schemadefinition: %v", oldDefinition) | ||
| } | ||
| oldDefinitions = append(oldDefinitions, oldDefinition) | ||
| } | ||
|
|
||
| // This is where we functionally assert that the two systems are compatible | ||
| generated, _, err := generator.GenerateSchema(oldDefinitions) | ||
| if err != nil { | ||
| return fmt.Errorf("could not generate resulting schema: %w", err) | ||
| } | ||
|
|
||
| // Add a newline at the end for hygiene's sake | ||
| terminated := generated + "\n" | ||
|
|
||
| if outputFilepath == "" { | ||
| // Print to stdout | ||
| fmt.Print(terminated) | ||
| } else { | ||
| err = os.WriteFile(outputFilepath, []byte(terminated), 0o_600) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| } |