Skip to content

feat(apollo-react): deprecate exclude runtime constraints in favor of include [SW-33601] - #1463

Open
mhagape wants to merge 1 commit into
mainfrom
feat/deprecate-runtime-constraints-exclude
Open

mhagape wants to merge 1 commit into
mainfrom
feat/deprecate-runtime-constraints-exclude

Conversation

@mhagape

@mhagape mhagape commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

Summary

A node manifest with runtimeConstraints: { exclude: [...] } is available in every runtime that ships later. Each new runtime then forces a manifest update just to opt the node back out. include doesn't have this problem, because a new runtime gets no node until a manifest lists it.

This PR marks the exclude variant of nodeRuntimeConstraintsManifestSchema as @deprecated and points the schema docs to include.

Impact

  • Manifests that use exclude still parse, so nothing breaks at runtime.
  • Code that reads constraints.exclude through the exported RuntimeConstraints type shows a deprecation strike-through in the editor, with the reason.
  • Removing exclude is left for a later major release, after the manifests move to include.

Verification

  • A probe file run through the TypeScript language service reports 'exclude' is deprecated (6385) when it reads c.exclude, and nothing when it reads c.include.
  • tsc --noEmit reports 0 errors, Biome is clean, and the 15 schema tests pass.

🤖 Generated with Claude Code

Copilot AI balanced review requested due to automatic review settings October 23, 2026 13:32
@github-actions
github-actions Bot temporarily deployed to preview/apollo-docs October 23, 2026 13:32 Destroyed
@github-actions
github-actions Bot temporarily deployed to preview/apollo-design October 23, 2026 13:32 Destroyed
@github-actions
github-actions Bot temporarily deployed to preview/apollo-landing October 23, 2026 13:32 Destroyed
@github-actions
github-actions Bot temporarily deployed to preview/apollo-vertex October 23, 2026 13:32 Destroyed
@github-actions github-actions Bot added the size:S 10-29 changed lines. label Oct 23, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The change is limited to documentation and deprecation metadata, with no runtime behavior changes or unresolved findings.

No open issues 🎉

What changed in this PR

Deprecates exclusion-based runtime constraints in Apollo React’s node manifest schema, encouraging explicit include lists so nodes are not automatically enabled in future runtimes.

Changes:

  • Updates schema documentation to recommend include.
  • Adds @deprecated documentation to exclude while preserving existing validation and runtime compatibility.
File Description
packages/​apollo-react/​src/​canvas/​schema/​node-definition/​node-manifest.ts Documents the exclude deprecation and its rationale without changing validation logic.

Review effort: Balanced

@github-actions

Copy link
Copy Markdown
Contributor

Dependency License Review

  • ✅ 1957 package(s) scanned
  • ✅ No license issues found
  • ⚠️ 2 package(s) excluded (see details below)
License distribution
License Packages
MIT 1721
ISC 91
Apache-2.0 57
BSD-3-Clause 28
BSD-2-Clause 23
BlueOak-1.0.0 8
MPL-2.0 4
CC0-1.0 4
MIT-0 3
MIT OR Apache-2.0 2
(MIT OR Apache-2.0) 2
Unlicense 2
LGPL-3.0-or-later 1
Python-2.0 1
CC-BY-4.0 1
(MPL-2.0 OR Apache-2.0) 1
Unknown 1
Artistic-2.0 1
(WTFPL OR MIT) 1
(BSD-2-Clause OR MIT OR Apache-2.0) 1
CC-BY-3.0 1
0BSD 1
(MIT OR CC0-1.0) 1
MIT AND ISC 1
Excluded packages
Package Version License Reason
@img/sharp-libvips-linux-x64 1.3.4 LGPL-3.0-or-later LGPL pre-built binary, not linked
khroma 2.1.0 Unknown MIT per GitHub repo, missing license field in package.json

… include

A node with { exclude: [...] } is available in every runtime added later,
so each new runtime forces a manifest update to opt the node back out.
The exclude variant is now marked @deprecated and the schema docs point
to include. Existing manifests still parse.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@mhagape
mhagape force-pushed the feat/deprecate-runtime-constraints-exclude branch from b8ef47c to c1db00b Compare October 23, 2026 13:37
@github-actions

github-actions Bot commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

📊 Coverage + size by package

Per-package coverage and bundle size on this PR. New-line coverage = of the source lines this PR adds or changes, the % hit by tests.

Package Coverage New-line coverage Packed (gzip) Unpacked vs main
@uipath/apollo-core — — 42.02 MB 50.17 MB ±0
@uipath/apollo-react 58.4% — (8 untracked) 8.14 MB 32.17 MB ±0
@uipath/apollo-ui-icons — — 2.86 MB 6.97 MB ±0
@uipath/apollo-vertex — — — — —
@uipath/apollo-wind — — 810.7 KB 4.68 MB −5 B
@uipath/ap-chat 85.8% — 40.42 MB 45.71 MB ±0

"Coverage" is each package's own coverage.include scope (e.g. apollo-core instruments only scripts/). "Packed"/"Unpacked" come from npm pack --dry-run and only cover built packages — "—" means not measured this run (package not affected / not built). "vs main" is the packed (gzipped) delta against the last successful main build (the package-sizes artifact from the Release workflow); "—" there means no main baseline was available this run. The baseline is main's latest build, not this PR's exact merge-base, so it includes any drift since the branch diverged. Packages with no vitest config are omitted.

@mhagape mhagape changed the title feat(apollo-react): deprecate exclude runtime constraints in favor of include feat(apollo-react): deprecate exclude runtime constraints in favor of include [SW-33601] Oct 23, 2026
@mhagape
mhagape requested a review from snuziale October 23, 2026 13:42
@github-actions

Copy link
Copy Markdown
Contributor

Storybook visual diff

⚠️ Visual changes detected: 15 changed, 4 added (of 406 compared, 387 unchanged). View report

Baseline is the deployed main Storybook, so changes merged to main after this branch was last updated can also appear here. Logs

Updated (PT): Oct 23, 2026, 07:07:40 AM

This branch was successfully deployed

4 active deployments
preview/apollo-vertex — c1db00b7 Deployed Oct 23, 2026 by github-actions[bot]
preview/apollo-landing — c1db00b7 Deployed Oct 23, 2026 by github-actions[bot]
preview/apollo-docs — c1db00b7 Deployed Oct 23, 2026 by github-actions[bot]
preview/apollo-design — c1db00b7 Deployed Oct 23, 2026 by github-actions[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pkg:apollo-react size:S 10-29 changed lines.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants