Add schema proposal composition background job by jdolle · Pull Request #7706 · graphql-hive/console

jdolle · 2026-02-19T01:24:27Z

Background

Schema proposals need to run composition when they're updated. By creating a workflow, composition can be ran in the background on proposal update.

Description

This adds a background job to run composition when proposals are updated, and adds more columns to the schema proposal record to store the latest composition state.

A subscription was added to allow async updating of the composition state but the frontend logic for the subscription is not yet added because this PR is getting large.

Also, the redis pubsub instance was factored out into a separate package to avoid a circular dependency between the workflows and api packages.

Checklist

Testing

gemini-code-assist · 2026-02-19T01:24:47Z

Summary of Changes

Hello @jdolle, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the system's ability to manage schema proposals by offloading the composition and validation process to an asynchronous background job. This architectural change improves responsiveness and scalability by preventing blocking operations during schema updates. It establishes the necessary infrastructure within the workflows service to interact with an external schema composition service, laying the groundwork for more robust and efficient schema management.

Highlights

Background Job for Schema Composition: A new background job has been introduced to handle schema proposal composition, allowing this computationally intensive task to run asynchronously when schema proposals are updated.
SchemaProvider Implementation: A dedicated SchemaProvider has been implemented within the workflows service. This provider encapsulates the logic for composing and validating schemas, as well as retrieving the latest and proposed schema versions from the database.
External Schema Service Integration: The workflows service is now configured to connect to an external schema composition service via a SCHEMA_SERVICE_URL environment variable, enabling distributed schema processing.
New Workflow Task: A new task, SchemaProposalCompositionTask, has been defined to orchestrate the fetching of proposed schemas, their composition, and validation using the newly introduced SchemaProvider.

Changelog

deployment/services/workflows.ts
- Added schemaServiceUrl as a new parameter to the deployWorkflows function.
- Injected SCHEMA_SERVICE_URL as an environment variable into the deployed workflow service.
packages/services/api/src/modules/shared/providers/storage.ts
- Removed a // @todo comment related to schema checks.
packages/services/workflows/.env.template
- Added SCHEMA_SERVICE_URL with a default value for local development.
packages/services/workflows/src/context.ts
- Imported SchemaProvider and added it to the Context type definition.
packages/services/workflows/src/environment.ts
- Extended the EnvironmentModel schema to validate the SCHEMA_SERVICE_URL environment variable.
- Configured env.schema.serviceUrl from the validated environment variable.
packages/services/workflows/src/index.ts
- Imported the schemaProvider function.
- Initialized the schema property in the application's context object using the schemaProvider.
packages/services/workflows/src/lib/schema/provider.ts
- Added a new file defining the schemaProvider function.
- Implemented composeAndValidate to interact with an external schema service via tRPC, including timeout handling.
- Implemented latestSchemas to retrieve the most recent schema version for a given target.
- Implemented proposedSchemas to fetch and apply schema changes from checks for a specific proposal.
packages/services/workflows/src/tasks/schema-proposal-composition.ts
- Added a new file defining the SchemaProposalCompositionTask using defineTask.
- Implemented the task to fetch proposed schemas, compose and validate them using the SchemaProvider, and log any composition errors.

Activity

The pull request is currently marked as a DRAFT.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

github-actions · 2026-02-19T01:26:17Z

🚀 Snapshot Release (`alpha`)

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

Package	Version	Info
`hive`	`9.5.0-alpha-20260226020947-8544455864702df54d566684a7079d0f17acfb1f`	npm ↗︎ unpkg ↗︎
`@graphql-hive/pubsub`	`0.0.1`	npm ↗︎ unpkg ↗︎

github-actions · 2026-02-19T01:27:29Z

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

Targets: build

Platforms: linux/amd64

Image Tag: 1aa49aae1b0fbd2ed6c2779ae652b8a1ac64831f

gemini-code-assist

Code Review

This pull request introduces a background job for schema proposal composition, including a new workflow and schema provider. However, a critical pagination logic error in proposedSchemas can lead to an infinite loop, causing a Denial of Service (DoS) for background workers. Additionally, there's a risk of worker crashes due to unhandled empty arrays and a missing ownership check (IDOR). Addressing these critical issues, along with other identified data fetching problems, potential runtime errors, and opportunities for improved type safety and style guide adherence, is crucial before merging.

packages/services/workflows/src/lib/schema/provider.ts

packages/services/workflows/src/tasks/schema-proposal-composition.ts

packages/services/workflows/src/lib/schema/provider.ts

github-actions · 2026-02-19T01:30:08Z

💻 Website Preview

The latest changes are available as preview in: https://pr-7706.hive-landing-page.pages.dev

jdolle · 2026-02-24T06:25:04Z

packages/migrations/src/actions/2026.02.24T00-00-00.proposal-composition.ts

+      query: sql`
+        ALTER TABLE IF EXISTS "schema_proposals"
+            ADD COLUMN IF NOT EXISTS "composition_status" TEXT
+          , ADD COLUMN IF NOT EXISTS "composition_timestamp" TIMESTAMPTZ


Looking for feedback on this.
Should the composition state for the proposal be per-save or is it acceptable to be per-proposal (latest state only)?

I think the current/latest state is the only relevant composition state in a proposal.

jdolle · 2026-02-25T00:17:16Z

deployment/index.ts

+  observability,
+  sentry,
+  heartbeat: heartbeatsConfig.get('webhooks'),
+  schema,


moved after the schema instance because i need to reference it.

packages/services/api/src/modules/schema/providers/schema-publisher.ts

…integration test for proposals

Add schema proposal composition background job

667a15a

jdolle self-assigned this Feb 19, 2026

gemini-code-assist bot reviewed Feb 19, 2026

View reviewed changes

github-actions bot deployed to preview February 19, 2026 01:30 View deployment

Add pubsub, subscrition, and composition state for proposals

88f515f

jdolle commented Feb 24, 2026

View reviewed changes

jdolle added 7 commits February 23, 2026 22:28

revert log change

e259a34

note

0eb9cdd

Remove unused function

ffeef08

Remove log

49d1a2c

Add limits to patch fetching; check targetId

406062c

Linting errors

d841a41

Merge branch 'main' into composition-job

2e274ba

github-actions bot deployed to preview February 24, 2026 18:47 View deployment

Add composition reason; fix timestamp format

f8cafbb

github-actions bot deployed to preview February 24, 2026 19:22 View deployment

jdolle added 3 commits February 24, 2026 13:21

Remove @hive/api from workflows' dependencies

e42665b

Fix type import

6b65344

Update lockfile

b2185a3

github-actions bot deployed to preview February 24, 2026 21:42 View deployment

Fix generated type

2c42fd9

github-actions bot deployed to preview February 24, 2026 21:52 View deployment

Fix workflows deployment

9f008c1

github-actions bot deployed to preview February 24, 2026 23:25 View deployment

Fix community & env name

699a373

github-actions bot deployed to preview February 24, 2026 23:42 View deployment

jdolle added 2 commits February 24, 2026 16:05

Basic composition ui; fix names

0dc136e

add key

1aa49aa

github-actions bot deployed to preview February 25, 2026 00:13 View deployment

jdolle marked this pull request as ready for review February 25, 2026 00:15

jdolle commented Feb 25, 2026

View reviewed changes

Unify redis logger utilities

4d00a88

github-actions bot deployed to preview February 25, 2026 00:44 View deployment

jdolle marked this pull request as draft February 25, 2026 00:49

Fix packages

887918c

jdolle commented Feb 25, 2026

View reviewed changes

packages/services/api/src/modules/schema/providers/schema-publisher.ts Outdated Show resolved Hide resolved

github-actions bot deployed to preview February 25, 2026 00:57 View deployment

jdolle added 2 commits February 24, 2026 18:30

Later version of graphile worker

e26cf7f

Use nullable instead of optional

1c974ed

github-actions bot deployed to preview February 25, 2026 02:40 View deployment

Remove proposal version select

5d954d7

github-actions bot deployed to preview February 25, 2026 20:52 View deployment

Pass in external composition state

201f156

github-actions bot deployed to preview February 25, 2026 22:02 View deployment

jdolle marked this pull request as ready for review February 25, 2026 23:02

Fix proposal manager permissions; fix workflow redis env var; add an …

8544455

…integration test for proposals

github-actions bot deployed to preview February 26, 2026 02:14 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add schema proposal composition background job#7706

Add schema proposal composition background job#7706
jdolle wants to merge 25 commits intomainfrom
composition-job

jdolle commented Feb 19, 2026 •

edited

Loading

Uh oh!

gemini-code-assist bot commented Feb 19, 2026

Uh oh!

github-actions bot commented Feb 19, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Feb 19, 2026 •

edited

Loading

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Feb 19, 2026 •

edited

Loading

Uh oh!

jdolle Feb 24, 2026

Uh oh!

jonathanawesome Feb 24, 2026

Uh oh!

jdolle Feb 25, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants

Conversation

jdolle commented Feb 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Background

Description

Checklist

Uh oh!

gemini-code-assist bot commented Feb 19, 2026

Summary of Changes

Highlights

Footnotes

Uh oh!

github-actions bot commented Feb 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Snapshot Release (alpha)

Uh oh!

github-actions bot commented Feb 19, 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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Feb 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

💻 Website Preview

Uh oh!

jdolle Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

jonathanawesome Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

jdolle Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants

jdolle commented Feb 19, 2026 •

edited

Loading

github-actions bot commented Feb 19, 2026 •

edited

Loading

🚀 Snapshot Release (`alpha`)

github-actions bot commented Feb 19, 2026 •

edited

Loading

github-actions bot commented Feb 19, 2026 •

edited

Loading