Skip to content

[APPS-2792] Add: v3 to v4 migration guide entry - #511

Merged
gh-worker-dd-mergequeue-cf854d[bot] merged 4 commits into
masterfrom
tiffany.trinh/apps-2792-migrations-v3-to-v4
Sep 11, 2026
Merged

gh-worker-dd-mergequeue-cf854d[bot] merged 4 commits into
masterfrom
tiffany.trinh/apps-2792-migrations-v3-to-v4

Conversation

@tyffical

@tyffical tyffical commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Motivation

  • Local Node execution for App Builder backend functions is landing across several already-merged PRs (in-process execution, npm run dev:verify, the runtime network/subprocess guard, build-time rejection of Node built-ins/raw network globals, Custom Credentials local resolution, and real-identity hydration for getInitiatingUser()/getExecutionUser()), with process.env scoping.
  • This bundle of changes is breaking for existing apps and is intended to ship as the next major version bump — MIGRATIONS.md needs a ## v3 to v4 entry describing it before that bump goes out.
  • This PR can be reviewed and merged now; the actual version bump (bump.yaml dispatch) should wait until all the implementation PRs land.

Changes

7 changes across MIGRATIONS.md, README.md
What changed File
Added a ## v3 to v4 entry covering in-process local execution, npm run dev:verify, and the process.env allowlist, plus its Table of Contents entry MIGRATIONS.md
Added subsections covering Custom Credentials local resolution (datadog-app.local.json) and real-identity hydration for getInitiatingUser()/getExecutionUser(), plus their Table of Contents entries MIGRATIONS.md
Extended the entry with accuracy fixes: dynamic-import rejection alongside static, a runtime network/subprocess guard scoped to function-body execution (not a dependency's own import-time code), a module-top-level credential caveat, and a preview-identity caveat MIGRATIONS.md
Corrected four further accuracy gaps: the dynamic-import check requires a literal string specifier, the build-time check already covers the whole app-local module graph, a CLI equivalent for a missing dev:verify script, and dev:verify can't simulate a real trigger's identity MIGRATIONS.md
Corrected three more accuracy gaps: a documented dns.lookup() exception to the runtime guard, module-cached state now covering the backend file's own code (not just a dependency's), and a call-serialization caveat MIGRATIONS.md
Documented the CLI's inline dev:verify nudge before draft/upload/publish — accepting runs the check and blocks on cancellation, declining just reminds and continues MIGRATIONS.md
Linked the new v3 to v4 section from the Migrations list README.md

QA Instructions

Docs-only change — no functional QA applies.

yarn cli integrity
# Regenerates the file's Table of Contents from its headings and runs the repo's install/format/typecheck/OSS-compliance checks
# Expected: exits 0; `git status --short` shows no changes ✅ VERIFIED

Every described behavior was cross-checked against the actual merged code, grouped by area:

Blast Radius

  • Documentation-only change (MIGRATIONS.md). Zero runtime risk.

Out of Scope / Follow-ups

2 items deferred
Item Status Next step
The actual major version bump (bump.yaml dispatch) this entry documents blocked Wait until the process.env scoping (Secret Store parity, #504) and env-guard hardening (#510) work merge, then dispatch the bump separately
The npm run dev:verify package.json script this entry tells users to run is defined in the create-apps template, not in this repo Independent Tracked in a separate private repo (dev:verify script + --verify CLI flag) — merge before the version bump ships so the documented script exists for new projects

@datadog-prod-us1-5

datadog-prod-us1-5 Bot commented Sep 9, 2026

Copy link
Copy Markdown

Tests

⚠️ Warnings

⚠️ Your PR has warnings. Tests failed — unable to determine if these are from required jobs.

🧪 4 Tests failed in 1 job

Continuous Integration | unit-test — ❌ 4 tests failed

View more details · View in GitHub Actions

❌ Dev Server Middleware dynamic discovery Should not find stale function after re-transform (HMR) from ../plugins/apps/src/vite/dev-server.test.ts   View in Datadog
Exceeded timeout of 10000 ms for a test.
Add a timeout value to this test to increase the timeout, if this is a long-running test. See https://jestjs.io/docs/api#testname-fn-timeout.
❌ Dev Server Middleware executeAction handler (local) Should eventually time out and return a clear error when getAllowedConnectionIds never settles from ../plugins/apps/src/vite/dev-server.test.ts   View in Datadog
Exceeded timeout of 10000 ms for a test.
Add a timeout value to this test to increase the timeout, if this is a long-running test. See https://jestjs.io/docs/api#testname-fn-timeout.
❌ Dev Server Middleware executeAction handler (local) Should never let two concurrent requests for different cold functions race their priming loads from ../plugins/apps/src/vite/dev-server.test.ts   View in Datadog
expect(received).toEqual(expected) // deep equality

- Expected  - 0
+ Received  + 1

  Array [
    "greet-priming-start",
+   "greet-priming-start",
  ]
❌ Dev Server Middleware executeAction handler (local) Should never prime (evaluate) the entry when getAllowedConnectionIds rejects from ../plugins/apps/src/vite/dev-server.test.ts   View in Datadog
Exceeded timeout of 10000 ms for a test.
Add a timeout value to this test to increase the timeout, if this is a long-running test. See https://jestjs.io/docs/api#testname-fn-timeout.

ℹ️ Info

No other issues found (see more)

❄️ No new flaky tests detected

Useful? React with 👍 / 👎

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 2fbb0ea | Docs | View more details | Give us feedback!

@tyffical
tyffical force-pushed the tiffany.trinh/apps-2792-migrations-v3-to-v4 branch from 5395c22 to c01b3b9 Compare September 10, 2026 04:55
@tyffical
tyffical changed the base branch from master to tiffany.trinh/apps-2792-custom-credentials-local-resolution September 10, 2026 04:55
@tyffical
tyffical added this pull request to stack #499 September 10, 2026 05:00
@tyffical
tyffical force-pushed the tiffany.trinh/apps-2792-migrations-v3-to-v4 branch from 4687e4c to b39e663 Compare September 10, 2026 05:05
@tyffical
tyffical requested a lite review from Copilot September 10, 2026 05:23

This comment was marked as resolved.

@tyffical
tyffical force-pushed the tiffany.trinh/apps-2792-migrations-v3-to-v4 branch from b39e663 to 281ac50 Compare September 10, 2026 05:39
@tyffical
tyffical requested a lite review from Copilot September 10, 2026 06:40
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 10, 2026

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-09-10T19:59:13.235328Z 85ca1c6 Manual request
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

This comment was marked as resolved.

chatgpt-codex-connector[bot]

This comment was marked as resolved.

@tyffical
tyffical force-pushed the tiffany.trinh/apps-2792-migrations-v3-to-v4 branch 3 times, most recently from e3c9bda to 3e35c51 Compare September 10, 2026 07:33
chatgpt-codex-connector[bot]

This comment was marked as resolved.

This comment was marked as resolved.

datadog-prod-us1-5[bot]

This comment was marked as resolved.

@tyffical
tyffical force-pushed the tiffany.trinh/apps-2792-migrations-v3-to-v4 branch 2 times, most recently from fdf2c87 to 67a04f8 Compare September 10, 2026 16:01
@tyffical
tyffical force-pushed the tiffany.trinh/apps-2792-migrations-v3-to-v4 branch from 67a04f8 to b52f75b Compare September 10, 2026 16:08
@tyffical
tyffical force-pushed the tiffany.trinh/apps-2792-migrations-v3-to-v4 branch from b52f75b to c8de74e Compare September 10, 2026 16:38
@tyffical
tyffical requested a lite review from Copilot September 10, 2026 17:25
@tyffical
tyffical removed the request for review from sarenji September 10, 2026 20:59
@tyffical
tyffical requested a review from a team as a code owner September 10, 2026 22:53
@tyffical
tyffical force-pushed the tiffany.trinh/apps-2792-migrations-v3-to-v4 branch from e115347 to 086f9f8 Compare September 10, 2026 22:55
@tyffical
tyffical force-pushed the tiffany.trinh/apps-2792-migrations-v3-to-v4 branch 2 times, most recently from b0d6a58 to 71d450e Compare September 11, 2026 01:26
@tyffical
tyffical force-pushed the tiffany.trinh/apps-2792-migrations-v3-to-v4 branch 2 times, most recently from 3797fba to 03d1671 Compare September 11, 2026 06:28
@tyffical
tyffical force-pushed the tiffany.trinh/apps-2792-migrations-v3-to-v4 branch from 03d1671 to a973d82 Compare September 11, 2026 08:01
Documents the upcoming breaking change to how `npm run dev` runs
backend functions: in-process execution instead of a cloud round
trip, the new `npm run dev:verify` cloud-parity check, and the
process.env allowlist during local execution.
Base automatically changed from tiffany.trinh/apps-2792-custom-credentials-local-resolution to master September 11, 2026 20:29
@tyffical
tyffical force-pushed the tiffany.trinh/apps-2792-migrations-v3-to-v4 branch from a973d82 to 2fbb0ea Compare September 11, 2026 20:29
@tyffical

Copy link
Copy Markdown
Contributor Author

/merge

🤖 Posted by Claude Code

@gh-worker-devflow-routing-ef8351

gh-worker-devflow-routing-ef8351 Bot commented Sep 11, 2026

Copy link
Copy Markdown

View all feedbacks in Devflow UI.

2026-09-11 20:45:29 UTC ℹ️ Start processing command `/merge

🤖 Posted by Claude Code`


2026-09-11 20:45:35 UTC ℹ️ MergeQueue: pull request added to the queue

The expected merge time in master is approximately 2m (p90).


2026-09-11 20:47:09 UTC ℹ️ MergeQueue: This merge request was merged

@gh-worker-dd-mergequeue-cf854d
gh-worker-dd-mergequeue-cf854d Bot merged commit d2b4981 into master Sep 11, 2026
11 of 12 checks passed
@gh-worker-dd-mergequeue-cf854d
gh-worker-dd-mergequeue-cf854d Bot deleted the tiffany.trinh/apps-2792-migrations-v3-to-v4 branch September 11, 2026 20:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants