feat: update DevContext and LSP to support composable schemas by tstirrat15 · Pull Request #2965 · authzed/spicedb

tstirrat15 · 2026-03-10T20:23:07Z

Description

Filesystem-aware development system — The DevContext and schema compilation now accept a filesystem
(fs.FS), enabling validation of schemas that use import syntax (composable schemas).

Key changes:

pkg/development/ — devcontext.go and schema.go updated to thread an fs.FS through schema
compilation. The position mapper (schema_position_mapper.go) was reworked significantly to
handle multi-file schemas correctly, with new tests.
pkg/schemadsl/compiler/ — The importer and position mapper now work with filesystem-backed
sources. development.go gained helpers for filesystem-aware compilation. The translator
tracks source file information more precisely.
LSP (internal/lsp/) — New overlay filesystem (overlay.go) lets the LSP validate open/unsaved files
by layering in-memory content over the real filesystem. Handlers updated to support
textDocument/definition (go-to-definition) and fix requestDiagnostics. Substantial new tests.

Testing

you can test this by bringing it over to VSCode and trying it out with schemas of your own. you have to

On spicedb repo: gh pr checkout 2965 && mage build:binary
On vscode repo : gh pr checkout 51
edit line 95 on package.json to point to the binary you created in step 1
hit F5 to run the extension

if you want to test in zed:

On zed repo: gh pr checkout 635 && mage build:binary
you can now do ./zed validate ....

codecov · 2026-03-10T23:26:02Z

Codecov Report

❌ Patch coverage is 76.33136% with 80 lines in your changes missing coverage. Please review.
✅ Project coverage is 74.92%. Comparing base (5d081d3) to head (e09bfdd).

Files with missing lines	Patch %	Lines
internal/lsp/handlers.go	75.61%	15 Missing and 5 partials ⚠️
pkg/development/devcontext.go	53.49%	17 Missing and 3 partials ⚠️
pkg/schemadsl/compiler/development.go	70.22%	9 Missing and 5 partials ⚠️
pkg/development/schema_position_mapper.go	82.44%	11 Missing and 2 partials ⚠️
internal/lsp/overlay.go	83.34%	5 Missing ⚠️
pkg/schemadsl/compiler/importer.go	78.58%	3 Missing ⚠️
pkg/schemadsl/compiler/translator.go	70.00%	2 Missing and 1 partial ⚠️
pkg/schemadsl/compiler/positionmapper.go	87.50%	2 Missing ⚠️

❌ Your project check has failed because the head coverage (74.92%) is below the target coverage (75.00%). You can increase the head coverage or adjust the target coverage.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2965      +/-   ##
==========================================
+ Coverage   74.79%   74.92%   +0.14%     
==========================================
  Files         499      500       +1     
  Lines       61065    61229     +164     
==========================================
+ Hits        45666    45869     +203     
+ Misses      12200    12158      -42     
- Partials     3199     3202       +3

☔ 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 · 2026-03-17T06:26:32Z

 					Context: errWithSource.SourceCodeString,
 					Line:    lineNumber,
 					Column:  columnPosition,
+					Path:    []string{path},


FYI zed uses this to show the correct content from the file that has the error

josephschorr · 2026-03-17T18:35:58Z

-
 		// Get errors.
 		for _, devErr := range devErrs.GetInputErrors() {
+			if !slices.Contains(devErr.Path, string(uri)) {


If I recall correctly, I had a map somewhere from URI <-> Path; if not, we likely should add it or helper functions, to make it clear when using one vs the other

josephschorr · 2026-03-17T18:37:14Z

+		targetURI := params.TextDocument.URI
+		if resolved.TargetSource != nil && *resolved.TargetSource != "schema" {
+			sourceDir := uriToSourceDir(params.TextDocument.URI)
+			targetURI = lsp.DocumentURI("file://" + filepath.Join(sourceDir, string(*resolved.TargetSource)))


And you'd use the new map/mapping functions here

miparnisari · 2026-03-17T06:28:27Z

 			return nil, err
 		}

+		targetSource := r.resolveTargetSource(relation.Name, source)


FYI this is what VSCode uses to know which file contains the error and display the right text content

miparnisari · 2026-03-17T06:30:05Z

+// DefinitionNodeSource returns the input source for the AST node defining the given name.
+// For definitions compiled from imports, this will be the imported file path (e.g. "users.zed").
+// For definitions in the root schema, this will be the root source (e.g. "schema").


If there is a better way to do this please let me know

miparnisari · 2026-03-17T06:33:11Z

+		nodeSource, _ := toplevel.GetString(dslshape.NodePredicateSource)
+		errMsg := fmt.Errorf("failed to read import %q: %w", filePath, err)
+		return nil, "", toContextError(errMsg.Error(), nodeSource, toplevel, mapper)


FYI changing to contextError so that we don't lose line number info of where the error happened

…d support for textDocument/definition, support composable schemas). fix position mapper

tstirrat15

See comments, otherwise LGTM

tstirrat15 · 2026-03-23T15:46:14Z

+// resolveURI resolves a relative path against the directory of baseURI,
+// returning a new file:// DocumentURI.
+func resolveURI(baseURI lsp.DocumentURI, relativePath string) lsp.DocumentURI {
+	return lsp.DocumentURI("file://" + filepath.Join(uriToSourceDir(baseURI), relativePath))


Could use net/url here by replacing Scheme: https://stackoverflow.com/questions/63197536/replacing-protocol-and-hostname-in-url-in-go

tstirrat15 · 2026-03-23T15:47:46Z

+// WithRootFileName saves the root file of the schema
+// so errors can be displayed accurately on UIs.
+func WithRootFileName(name string) CompileOption {
+	return func(cfg *compileConfig) { cfg.rootFileName = name }
+}


Barak and I were talking about this - would it make sense to hang the filename off of the definition such that error handling can look up the filename along with the position straight off the node?

I'll do this in a follow-on PR

tstirrat15 · 2026-03-23T15:48:41Z

+func (r *SchemaPositionMapper) resolveTargetSource(name string, fallback input.Source) input.Source {
+	if defSource := r.schema.GetPathToDefinitionOrPartialOrCaveat(name); defSource != "" {
+		return input.Source(defSource)
+	}
+	return fallback
+}


Yeah, I think that would clean up this code a bit

TODO for later

tstirrat15 · 2026-03-23T15:49:46Z

+	sourceFS := fstest.MapFS{
+		"path/partials.zed": &fstest.MapFile{Data: []byte("use partial\npartial secret {\nrelation secret: user\n}")},
+		"path/users.zed":    &fstest.MapFile{Data: []byte("definition user {}\ncaveat is_raining(day string) {\nday == \"saturday\"\n}")},
+	}


Oooh I like this

tstirrat15 · 2026-03-23T15:52:57Z

+// GetPathToDefinitionOrPartialOrCaveat returns the input source for the AST node defining the given name.
+// For definitions compiled from imports, this will be the imported file path (e.g. "users.zed").
+// For definitions in the root schema, this will be the root source (e.g. "schema").
+// Returns empty string if not found.
+func (cs *CompiledSchema) GetPathToDefinitionOrPartialOrCaveat(name string) string {


Yeah, I think we should annotate the node rather than treating it as a calculated value. I can make that change today.

Deferring to future refactor

tstirrat15 · 2026-03-23T19:42:48Z

+	// Skip nodes from imported files whose rune positions may overlap with the root file.
+	if nodeSource, err := node.GetString(dslshape.NodePredicateSource); err == nil {
+		if nodeSource != rootSource {
+			return nil, nil
+		}
+	}


Why is this part necessary?

Makes this test pass: "cursor on the import path" on schema_position_mapper_test.go

tstirrat15 · 2026-03-23T19:43:51Z


 // Take a filepath and ensure that it's local to the current context.
-func validateFilepath(path string) error {
+func validateFilepath(path string, toplevel *dslNode, mapper input.PositionMapper) error {


I think we might be able to delegate this to DirFS's restrictions. I guess we'd still need to rewrite the error in that case, though.

github-actions bot added the area/schema Affects the Schema Language label Mar 10, 2026

tstirrat15 added the Skip-Changelog label Mar 10, 2026

tstirrat15 force-pushed the tstirrat/file-aware-development-system branch from cffe476 to e20db9f Compare March 10, 2026 20:38

tstirrat15 mentioned this pull request Mar 11, 2026

chore: bring in spicedb and update compilation authzed/zed#635

Merged

miparnisari force-pushed the tstirrat/file-aware-development-system branch 2 times, most recently from 3998ee0 to e20db9f Compare March 13, 2026 20:57

miparnisari mentioned this pull request Mar 13, 2026

feat: support composable schemas authzed/spicedb-vscode#51

Merged

github-actions bot added the area/tooling Affects the dev or user toolchain (e.g. tests, ci, build tools) label Mar 13, 2026

miparnisari force-pushed the tstirrat/file-aware-development-system branch 5 times, most recently from 9ef3b65 to 5dcc950 Compare March 16, 2026 17:37

miparnisari changed the title ~~chore: make development system filesystem-aware~~ feat: update DevContext and LSP to support composable schemas Mar 16, 2026

miparnisari force-pushed the tstirrat/file-aware-development-system branch 10 times, most recently from 12bc73d to a1130f6 Compare March 17, 2026 02:39

miparnisari marked this pull request as ready for review March 17, 2026 02:41

miparnisari requested a review from a team as a code owner March 17, 2026 02:41

miparnisari force-pushed the tstirrat/file-aware-development-system branch 2 times, most recently from 254aa41 to 10d5e84 Compare March 17, 2026 06:22