feat(core/schema): extract global document references types by skogsmaskin · Pull Request #8973 · sanity-io/sanity

skogsmaskin · 2025-03-18T14:56:24Z

Description

This will extract globalDocumentReference types with extractSchema and. extractManifest.

However I'm not sure about the implications of this as I don't know how too much about how those functions are used.

Please help me review this.

What to review

That introducing this new type in the output will not break stuff somewhere?

What about the GraphQL API?

Testing

Notes for release

vercel · 2025-03-18T14:56:30Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Review	Updated (UTC)
page-building-studio	Ready	Preview, Comment	Jan 26, 2026 4:18pm
performance-studio	Ready	Preview, Comment	Jan 26, 2026 4:18pm
test-studio	Ready	Preview, Comment	Jan 26, 2026 4:18pm

2 Skipped Deployments

Project	Deployment	Review	Updated (UTC)
studio-workshop	Ignored	Preview	Jan 26, 2026 4:18pm
test-next-studio	Ignored		Jan 26, 2026 4:18pm

github-actions · 2025-03-18T15:01:19Z

Coverage Report

Status	Category	Percentage	Covered / Total
🔵	Lines	35.59%	22306 / 62673
🔵	Statements	30.22%	26924 / 89067
🔵	Functions	34.13%	4558 / 13351
🔵	Branches	23.63%	17535 / 74184

File Coverage

File	Stmts	Branches	Functions	Lines	Uncovered Lines
Changed Files
packages/@sanity/schema/src/sanity/extractSchema.ts	90.54%	84.54%	95.55%	90.52%	102, 113-114, 125, 129, 149, 162, 171-172, 180, 195, 249, 264-272, 299, 332, 417, 427, 544, 575-580, 639, 686, 786

Generated in workflow #50840 for commit 12cac73 by the Vitest Coverage Report Action

github-actions · 2025-03-18T15:01:56Z

No changes to documentation

github-actions · 2025-03-18T15:09:59Z

⚡️ Editor Performance Report

Deploying studio and running performance tests…

skogsmaskin · 2025-03-18T15:19:21Z

Found out that test/cli/graphql/gen3.test needs to add tests for this type.

snorrees · 2025-03-18T15:38:59Z

+                type: 'book',
+              },
+            ],
+            type: 'globalDocumentReference',


This will need a fix on the Create side (both backend and frontend) so we ignore gdr fields there for now.
Ie, we would have to get that out first before this can be merged.
If left as is, Create form will render this as an object with whatever fields GDR type has (i think, or it will crash, idk).

Is GDR available in the lastest version of sanity package? I can do a quick discov

@snorrees - it will go out with the release today. Was merged to next earlier today.

(I will will make the final adjustments to the AI-Assist Plugin btw as soon as I know the version number)

@snorrees - to clarify my message above:

The unexposed GDR support will go out today, not this one :)

Ie, we would have to get that out first before this can be merged.

Yes. Noted.

Watch your PR inbox

sgulseth · 2025-03-19T08:29:25Z

        },
+        {
+          "fieldName": "productReference",
+          "type": "GlobalDocumentReference",


afaict GlobalDocumentReference isn't declared anywhere? 🤔

I think its a new core type.

@skogsmaskin its too late to remodel GDRs as just objects right? This was why assist blew up too right? And why auto updating studios with assist are gonna be in a bad way.

Yeah; it's similar to "type": "CrossDatasetReference", which is how the GQL schema types end up loooking.

github-actions · 2025-03-27T14:55:36Z

📊 Playwright Test Report

Download Full E2E Report

This report contains test results, including videos of failing tests.

justshiv · 2026-01-22T14:26:13Z

Hey @skogsmaskin what's the current status on this PR? Is it worth getting this into a shippable state or can we close this?

github-actions · 2026-01-22T14:41:00Z

🧪 E2E Preview environment

🔑 Environment Variables for Local Testing

This is the preview URL for the E2E tests: https://e2e-studio-baxjxnrov.sanity.dev

To run the E2E tests locally, you can use the following environment variables, then run pnpm test:e2e --ui to open the Playwright test runner.

💬 Remember to build the project first with pnpm build:e2e.

  SANITY_E2E_PROJECT_ID=ittbm412
  SANITY_E2E_BASE_URL=https://e2e-studio-baxjxnrov.sanity.dev
  SANITY_E2E_DATASET="update depending the project you want to test (pr-8973-chromium-21364898781 || pr-8973-firefox-21364898781 )"
  SANITY_E2E_DATASET_CHROMIUM=pr-8973-chromium-21364898781
  SANITY_E2E_DATASET_FIREFOX=pr-8973-firefox-21364898781

skogsmaskin · 2026-01-26T16:16:18Z

@snorrees - I see you have added some stuff touching upon this some time after this PR. Can you please have another look?

@kristofferlund - I know you have been working lately with the schema types. Adding you as an reviewer on this.

skogsmaskin · 2026-01-26T16:18:38Z

Hey @skogsmaskin what's the current status on this PR? Is it worth getting this into a shippable state or can we close this?

Yes, if we want correct typings on the global document reference type (schema and GraphQL), it's worth getting this in.

It is up to date with main now. My first comment still stands though, I don't know the implications of this change (in code elsewhere), so I need help to review.

sgulseth

I don't think this is what we can support at the moment. typegen is not aware of GDRs, and has no way of resolving the external schema. I think we first need to migrate typegen to use the new schema store. For now unknown is the only thing reasonable to return for GDRs

skogsmaskin · 2026-01-27T08:59:26Z

I don't think this is what we can support at the moment. typegen is not aware of GDRs, and has no way of resolving the external schema. I think we first need to migrate typegen to use the new schema store. For now unknown is the only thing reasonable to return for GDRs

Right! Sounds like something that could take a while to get in place.

@justshiv - feel free to close this if it's causing noise in the "Open PRs". But maybe we can keep the branch for future reference.

skogsmaskin requested a review from a team as a code owner March 18, 2025 14:56

skogsmaskin requested review from ricokahler and removed request for a team March 18, 2025 14:56

skogsmaskin requested review from sgulseth and snorrees March 18, 2025 14:59

vercel Bot deployed to Preview – performance-studio March 18, 2025 15:01 View deployment

vercel Bot deployed to Preview – page-building-studio March 18, 2025 15:01 View deployment

vercel Bot deployed to Preview – test-studio March 18, 2025 15:02 View deployment

skogsmaskin force-pushed the feat/gdr-extract-schema branch from b49da28 to 59022f0 Compare March 18, 2025 15:38

snorrees reviewed Mar 18, 2025

View reviewed changes

snorrees self-requested a review March 18, 2025 15:43

skogsmaskin force-pushed the feat/gdr-extract-schema branch from 59022f0 to eb96415 Compare March 18, 2025 15:43

vercel Bot deployed to Preview – page-building-studio March 18, 2025 15:52 View deployment

vercel Bot deployed to Preview – performance-studio March 18, 2025 15:52 View deployment

vercel Bot deployed to Preview – test-studio March 18, 2025 15:54 View deployment

sgulseth requested changes Mar 19, 2025

View reviewed changes

skogsmaskin force-pushed the feat/gdr-extract-schema branch from eb96415 to d74cef9 Compare March 27, 2025 14:38

vercel Bot deployed to Preview – page-building-studio March 27, 2025 14:45 View deployment

vercel Bot deployed to Preview – performance-studio March 27, 2025 14:45 View deployment

vercel Bot deployed to Preview – test-studio March 27, 2025 14:45 View deployment

skogsmaskin force-pushed the feat/gdr-extract-schema branch from d74cef9 to c1c12d9 Compare January 22, 2026 14:40

vercel Bot had a problem deploying to Preview – test-studio January 22, 2026 14:42 Failure

vercel Bot had a problem deploying to Preview – page-building-studio January 22, 2026 14:42 Failure

skogsmaskin force-pushed the feat/gdr-extract-schema branch from c1c12d9 to 711d673 Compare January 26, 2026 16:00

skogsmaskin added 4 commits January 26, 2026 17:01

fix(core): handle global document references when extracting workspace

be2d2dc

fix(schema): extract global document references type

2cd36f9

fix(cli): add globalDocumentReference to the API and tests

5c8ea3f

fix(internal): fix conflicts

c945208

skogsmaskin force-pushed the feat/gdr-extract-schema branch from 711d673 to c945208 Compare January 26, 2026 16:01

vercel Bot deployed to Preview – page-building-studio January 26, 2026 16:05 View deployment

vercel Bot deployed to Preview – test-studio January 26, 2026 16:05 View deployment

test(schema): update tests for globalDocumentReferene type

12cac73

skogsmaskin requested review from kbrabrand and removed request for ricokahler January 26, 2026 16:15

vercel Bot deployed to Preview – page-building-studio January 26, 2026 16:17 View deployment

vercel Bot deployed to Preview – test-studio January 26, 2026 16:18 View deployment

skogsmaskin requested a review from sgulseth January 26, 2026 16:19

sgulseth requested changes Jan 26, 2026

View reviewed changes

justshiv closed this Jan 27, 2026

Conversation

skogsmaskin commented Mar 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

What to review

Testing

Notes for release

Uh oh!

vercel Bot commented Mar 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Mar 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report

Uh oh!

github-actions Bot commented Mar 18, 2025

Uh oh!

github-actions Bot commented Mar 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚡️ Editor Performance Report

Uh oh!

skogsmaskin commented Mar 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

snorrees Mar 18, 2025

Choose a reason for hiding this comment

Uh oh!

skogsmaskin Mar 18, 2025

Choose a reason for hiding this comment

Uh oh!

skogsmaskin Mar 18, 2025

Choose a reason for hiding this comment

Uh oh!

snorrees Mar 18, 2025

Choose a reason for hiding this comment

Uh oh!

sgulseth Mar 19, 2025

Choose a reason for hiding this comment

Uh oh!

snorrees Mar 20, 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!

skogsmaskin Jan 26, 2026 • 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!

github-actions Bot commented Mar 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📊 Playwright Test Report

Uh oh!

justshiv commented Jan 22, 2026

Uh oh!

github-actions Bot commented Jan 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🧪 E2E Preview environment

Uh oh!

skogsmaskin commented Jan 26, 2026

Uh oh!

skogsmaskin commented Jan 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sgulseth left a comment

Choose a reason for hiding this comment

Uh oh!

skogsmaskin commented Jan 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

skogsmaskin commented Mar 18, 2025 •

edited

Loading

vercel Bot commented Mar 18, 2025 •

edited

Loading

github-actions Bot commented Mar 18, 2025 •

edited

Loading

github-actions Bot commented Mar 18, 2025 •

edited

Loading

skogsmaskin commented Mar 18, 2025 •

edited

Loading

snorrees Mar 20, 2025 •

edited

Loading

skogsmaskin Jan 26, 2026 •

edited

Loading

github-actions Bot commented Mar 27, 2025 •

edited

Loading

github-actions Bot commented Jan 22, 2026 •

edited

Loading

skogsmaskin commented Jan 26, 2026 •

edited

Loading