feat: schema version promotion by n1ru4l · Pull Request #8031 · graphql-hive/console

n1ru4l · 2026-05-10T21:07:33Z

Background

Description

Introduces functionality for promoting a schema version from one target to another target (or the same target), making it the latest version within that target.

This enables workflows such as:

Promote schema version from one environment to another environment (staging to production)
Quick rollbacks to a specific previous schema version within one environment

Alongside a new CLI command for performing these promotions this change also comes along a new UI for schema versions with more insights into the individual changes of the subgraphs.

n1ru4l · 2026-05-10T21:09:13Z

+      ALTER COLUMN IF EXISTS "action_id" DROP NOT NULL
+      , ADD COLUMN IF NOT EXISTS "origin" jsonb NULL


There is now no longer "one" single action that caused a schema version.

Instead we have now a origin column that stores the information (subgraph/schema publish; subgraph removal; schema promotion) in a more flexible way.

github-actions · 2026-05-10T21:09:20Z

🚀 Snapshot Release (`alpha`)

The latest changes of this PR are available as alpha on npm (based on the declared changesets):

Package	Version	Info
`hive`	`11.1.1-alpha-20260514114711-308bfead7053c7d3b0683041a5e0b6f3daca2ce6`	npm ↗︎ unpkg ↗︎

n1ru4l · 2026-05-10T21:11:07Z

+    ALTER TABLE "schema_versions"
+      ALTER COLUMN IF EXISTS "action_id" DROP NOT NULL
+      , ADD COLUMN IF NOT EXISTS "origin" jsonb NULL
+      , ADD COLUMN IF NOT EXISTS "supergraph_changes" jsonb NULL


We store the public schema changes in a separate table schema_version_changes. However, we do not do anything with that table aside from loading the rows. No custom indices etc.

Thus I made the decision to add the column to store supergraph changes to the schema_versions table directly.

n1ru4l · 2026-05-10T21:12:44Z

+    log: RegistryLog!
+      @tag(name: "public")
+      @deprecated(reason: "Please use 'SchemaVersion.origin' instead.")


Note: I plan to remove this field as part of this pull request. I just deprecated it for now as it is used in unit tests.

Conditional breaking changes says its safe to remove it.

github-actions · 2026-05-10T21:13:19Z

🐋 This PR was built and pushed to the following Docker images:

Targets: build

Platforms: linux/arm64

Image Tag: 308bfead7053c7d3b0683041a5e0b6f3daca2ce6

gemini-code-assist

Code Review

This pull request introduces a schema version promotion feature, allowing users to promote a schema version from one target to another within a project. It includes a new database migration, GraphQL schema updates for the schemaVersionPromote mutation and PromotionSchemaLog type, and significant logic in SchemaPublisher and SchemaVersionStore to handle the promotion process and track version origins. Feedback includes identifying a missing crypto import that will cause runtime errors, a typo in a SQL string, and unsafe array access. Additionally, there are suggestions to update an incorrect migration comment, reconsider the use of a dummy field in the GraphQL schema, and evaluate if STITCHING projects should also support this feature.

gemini-code-assist · 2026-05-10T21:13:54Z

+          throw new Error('INVARIANT: Remove logs require a service name.');
+        }
+        // Note: we seed the ID here so we do not need to map some more within the logic within `SchemaVersions.promoteSchemaVersionToTarget`
+        const logId = crypto.randomUUID();


The variable crypto is not defined in this scope. Only createHash is explicitly imported from node:crypto at the top of the file. Unless crypto is available globally in your environment, this will cause a runtime error. Consider importing randomUUID from node:crypto and using it directly.

gemini-code-assist · 2026-05-10T21:13:54Z

+  /**
+   * Adds an expiration date to tokens. This expiration doesn't need to
+   * be an index since we're always looking up by ID and then can verify
+   * the timestamp via a filter. Since these lookups are always be done
+   * via provider methods and not via a raw table query, this is safe.
+   */


The comment block appears to be copied from a different migration related to token expiration. It should be updated to reflect the actual purpose of this migration, which is schema version promotion.

gemini-code-assist · 2026-05-10T21:13:54Z

+    """
+    The origin of this schema log promotion.
+    """
+    _: Boolean! @tag(name: "public")


Using a dummy field _ in PromotionSchemaLog is not ideal for API clarity. Even if the type currently has no specific fields, consider adding meaningful metadata such as promotedAt or information about the source target/version to make the API more descriptive and useful for clients.

gemini-code-assist · 2026-05-10T21:13:54Z

+      }),
+    ]);
+
+    if (project.type !== Types.ProjectType.FEDERATION) {


The check restricts promotion to FEDERATION projects only. However, STITCHING is also a composite project type supported by the CompositeModel and other helpers in this module. Consider if STITCHING projects should also support schema version promotion.

gemini-code-assist · 2026-05-10T21:13:54Z

+          const schemas = await this.schemaVersions.getSchemasBySchemaVersionId(schemaVersion.id);
+          actionId = schemas[0].id;


Unsafe access to schemas[0]. If getSchemasBySchemaVersionId returns an empty array, this will throw a runtime error. It is safer to check if the array has elements before accessing them.

const schemas = await this.schemaVersions.getSchemasBySchemaVersionId(schemaVersion.id); if (schemas.length === 0) { throw new Error('INVARIANT: No schemas found for the version'); } actionId = schemas[0].id;

n1ru4l · 2026-05-13T15:52:32Z

+      ALTER COLUMN "action_id" DROP NOT NULL
+      , ADD COLUMN IF NOT EXISTS "origin" jsonb NULL
+      , ADD COLUMN IF NOT EXISTS "supergraph_changes" jsonb NULL
+      , ADD COLUMN IF NOT EXISTS "meta" jsonb NULL


This column stores additional user-provided metadata such as commit and author. Previously this was exclusively stored on the schema_log. However, since now a schema version is no longer exclusively triggered by "one" schema_log, we need to store that metadata on the schema version directly in order to make other existing functionality still work as expected.

n1ru4l · 2026-05-13T15:53:26Z

+    ALTER TABLE "schema_version_to_log"
+      ADD COLUMN IF NOT EXISTS type hive_subgraph_log_type DEFAULT NULL
+      , ADD COLUMN IF NOT EXISTS "previous_action_id" UUID DEFAULT NULL REFERENCES "schema_log"("id") ON DELETE CASCADE
+      , ADD COLUMN IF NOT EXISTS "schema_changes" JSONB DEFAULT NULL
+      , ADD COLUMN IF NOT EXISTS "subgraph_name" TEXT NULL
+    ;


This type stores now more complex information that serves the purpose of tracking how the subgraphs changed between schema versions.

n1ru4l commented May 10, 2026

View reviewed changes

gemini-code-assist Bot reviewed May 10, 2026

View reviewed changes

n1ru4l force-pushed the feat-schema-version-promotion branch 2 times, most recently from 91ca78a to 05a3f05 Compare May 10, 2026 21:18

Base automatically changed from chore-refactor-schema-version-store to main May 11, 2026 20:59

n1ru4l force-pushed the feat-schema-version-promotion branch 5 times, most recently from f15a85c to c0f20b4 Compare May 13, 2026 10:48

n1ru4l added 10 commits May 13, 2026 12:49

add new PromotionSchemaLog

93c3983

feat: promote schema versions

ce0b195

contract handling

ae38f36

fix typo

e7ea2d0

either promote target or specific version

103dc7b

missing db migration run lol

927dd45

fix em names

8ea4fd7

fix: failing tests

4c11abe

fix: metadata issue

7d1ec25

new schema version navigation ui

9d6cac5

n1ru4l force-pushed the feat-schema-version-promotion branch from c0f20b4 to 9d6cac5 Compare May 13, 2026 10:49

n1ru4l added 3 commits May 13, 2026 14:35

fix test

f7efad6

feat: new schema version ui

1700879

fix schema diffs

88feea3

n1ru4l changed the title ~~Feat schema version promotion~~ feat: schema version promotion May 13, 2026

n1ru4l commented May 13, 2026

View reviewed changes

n1ru4l added 5 commits May 14, 2026 13:05

contracts ui

6c35b7c

more ui tweaks

8d573b5

fix exceptions

035ddec

publish contracts to cdn in promotion

c713e71

cli command anyone

308bfea

n1ru4l force-pushed the feat-schema-version-promotion branch from 9867645 to 308bfea Compare May 14, 2026 11:45

		ALTER COLUMN IF EXISTS "action_id" DROP NOT NULL
		, ADD COLUMN IF NOT EXISTS "origin" jsonb NULL

		const schemas = await this.schemaVersions.getSchemasBySchemaVersionId(schemaVersion.id);
		actionId = schemas[0].id;

Conversation

n1ru4l commented May 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Background

Description

Uh oh!

n1ru4l May 10, 2026

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

🚀 Snapshot Release (alpha)

Uh oh!

n1ru4l May 10, 2026

Choose a reason for hiding this comment

Uh oh!

n1ru4l May 10, 2026

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Uh oh!

gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist Bot May 10, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot May 10, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot May 10, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot May 10, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist Bot May 10, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

n1ru4l May 13, 2026

Choose a reason for hiding this comment

Uh oh!

n1ru4l May 13, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

1 participant

n1ru4l commented May 10, 2026 •

edited

Loading

github-actions Bot commented May 10, 2026 •

edited

Loading

🚀 Snapshot Release (`alpha`)

github-actions Bot commented May 10, 2026 •

edited

Loading