breaking: Clean up deprecated functionality for v1 #562

tstirrat15 · 2025-10-12T15:18:36Z

Description

Part of getting a v1 of Zed out the door. We want to take the opportunity to get rid of some deprecated codepaths, which will keep complexity down in the long term.

Changes

Remove zed preview schema compile - it's now just zed schema compile
Remove zed watch - it's now just zed relationship watch
Remove deprecated revision flag - use the other consistency flags
Remove zed permission lookup - it's zed permission lookup-resources
Remove deprecated estimated-count flag on bulk-delete - use limit instead

Testing

Review. See that tests still pass.

codecov-commenter · 2025-10-12T15:21:58Z

Codecov Report

❌ Patch coverage is 50.00000% with 6 lines in your changes missing coverage. Please review.
✅ Project coverage is 41.92%. Comparing base (7ed5ab0) to head (e5c14c4).
⚠️ Report is 18 commits behind head on main.

Files with missing lines	Patch %	Lines
internal/commands/permission.go	0.00%	5 Missing ⚠️
internal/commands/relationship.go	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #562      +/-   ##
==========================================
+ Coverage   39.28%   41.92%   +2.64%     
==========================================
  Files          37       37              
  Lines        5448     4718     -730     
==========================================
- Hits         2140     1978     -162     
+ Misses       3063     2482     -581     
- Partials      245      258      +13

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

miparnisari · 2025-10-14T17:56:16Z

internal/commands/permission.go

 	registerConsistencyFlags(checkCmd.Flags())

 	permissionCmd.AddCommand(checkBulkCmd)
-	checkBulkCmd.Flags().String("revision", "", "optional revision at which to check")


this one wasn't marked as hidden, can we actually remove it?

i also see this

readCmd.Flags().String("revision", "", "optional revision at which to check") _ = readCmd.Flags().MarkHidden("revision")

I would argue yes, as long as we document it

miparnisari · 2025-10-14T18:06:38Z

I wonder if we could take this PR as an opportunity to:

have zed permission bulk-check and zed permission check-bulk be an alias for zed permission bulk (will match zed relationship bulk-delete)
have zed relationship write be an alias for zed relationship create (will match zed schema write)

This would be in the name of consistency 😄

miparnisari

I ran mage gen:docForPublish and inspected the docs at https://github.com/authzed/zed/blob/main/docs/zed.md. I saw this, can we update it?

zed/internal/cmd/schema.go

Lines 97 to 101 in 57fdb03

    
           	Example: ` 
        
           	Write to stdout: 
        
           		zed preview schema compile root.zed 
        
           	Write to an output file: 
        
           		zed preview schema compile root.zed --out compiled.zed

tstirrat15

See comments

tstirrat15 · 2025-11-20T22:39:03Z

internal/cmd/cmd.go


 	relCmd := commands.RegisterRelationshipCmd(rootCmd)

-	commands.RegisterWatchCmd(rootCmd)


This is one of the aliases that we removed.

tstirrat15 · 2025-11-20T22:39:30Z

internal/cmd/cmd.go

-	schemaCompileCmd := registerAdditionalSchemaCmds(schemaCmd)
-	registerPreviewCmd(rootCmd, schemaCompileCmd)


We no longer pass out the schemaCompileCmd as it's no longer needed as an arg to the preview command.

tstirrat15 · 2025-11-20T22:39:41Z

internal/cmd/preview.go

-	schemaCmd := &cobra.Command{
-		Use:        "schema <subcommand>",
-		Short:      "Manage schema for a permissions system",
-		Deprecated: "please use `zed schema compile`",
-	}


No longer any commands under this.

tstirrat15 · 2025-11-20T22:39:54Z

internal/cmd/schema.go

 	schemaCmd.AddCommand(schemaCompileCmd)
 	schemaCompileCmd.Flags().String("out", "", "output filepath; omitting writes to stdout")
-
-	return schemaCompileCmd


See note about no longer passing things out of this command.

tstirrat15 · 2025-11-20T22:40:20Z

internal/commands/permission.go

-	// Deprecated (hidden) flag.
-	if revision := cobrautil.MustGetStringExpanded(cmd, "revision"); revision != "" {


This is now covered by the consistency option; we want to get rid of the old way of doing things.

tstirrat15 · 2025-11-20T22:40:27Z

internal/commands/permission.go

+		Short:   "Check permissions in bulk exist for resource-permission-subject triplets",
+		Args:    ValidationWrapper(cobra.MinimumNArgs(1)),
+		RunE:    checkBulkCmdFunc,
+		Aliases: []string{"check-bulk", "bulk-check"},


Adding aliases here.

tstirrat15 · 2025-11-20T22:40:44Z

internal/commands/permission.go

-	lookupCmd := &cobra.Command{
-		Use:               "lookup <type> <permission> <subject:id>",


No longer using a separate command for lookup. This is covered by lookup-resources.

tstirrat15 · 2025-11-20T22:41:16Z

internal/commands/permission.go


 	permissionCmd.AddCommand(expandCmd)
 	expandCmd.Flags().Bool("json", false, "output as JSON")
-	expandCmd.Flags().String("revision", "", "optional revision at which to check")


Same deal here.

tstirrat15 · 2025-11-20T22:41:44Z

internal/commands/relationship.go

 		Args:              ValidationWrapper(StdinOrExactArgs(3)),
 		ValidArgsFunction: GetArgs(ResourceID, Permission, SubjectTypeWithOptionalRelation),
 		RunE:              writeRelationshipCmdFunc(v1.RelationshipUpdate_OPERATION_CREATE, os.Stdin),
+		Aliases:           []string{"write"},


Adding zed relationship write as an alias - this is what i always want to write.

tstirrat15 force-pushed the clean-up-deprecations branch from 54f4359 to f54b029 Compare October 12, 2025 15:24

miparnisari reviewed Oct 14, 2025

View reviewed changes

miparnisari requested changes Oct 14, 2025

View reviewed changes

tstirrat15 force-pushed the clean-up-deprecations branch from f54b029 to f3e2bb1 Compare November 20, 2025 22:31

tstirrat15 mentioned this pull request Nov 20, 2025

Remove preview markers from composable schemas authzed/docs#415

Open

breaking: Clean up deprecated functionality for v1

e5c14c4

tstirrat15 force-pushed the clean-up-deprecations branch from f3e2bb1 to e5c14c4 Compare November 20, 2025 22:38

tstirrat15 commented Nov 20, 2025

View reviewed changes

barakmich approved these changes Nov 20, 2025

View reviewed changes

	Example: `
	Write to stdout:
	zed preview schema compile root.zed
	Write to an output file:
	zed preview schema compile root.zed --out compiled.zed


		relCmd := commands.RegisterRelationshipCmd(rootCmd)

		commands.RegisterWatchCmd(rootCmd)

		schemaCompileCmd := registerAdditionalSchemaCmds(schemaCmd)
		registerPreviewCmd(rootCmd, schemaCompileCmd)

		// Deprecated (hidden) flag.
		if revision := cobrautil.MustGetStringExpanded(cmd, "revision"); revision != "" {

		lookupCmd := &cobra.Command{
		Use: "lookup <type> <permission> <subject:id>",

breaking: Clean up deprecated functionality for v1 #562

Are you sure you want to change the base?

breaking: Clean up deprecated functionality for v1 #562

Uh oh!

Conversation

tstirrat15 commented Oct 12, 2025

Description

Changes

Testing

Uh oh!

codecov-commenter commented Oct 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

miparnisari Oct 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Uh oh!

miparnisari left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tstirrat15 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codecov-commenter commented Oct 12, 2025 •

edited

Loading

miparnisari Oct 14, 2025 •

edited

Loading

miparnisari commented Oct 14, 2025 •

edited

Loading

miparnisari left a comment •

edited

Loading