Skip to content

Commit 8c9bd8f

Browse files
claude[bot]claude
andauthored
docs(metadata-protocol,objectql,cli): correct six comments describing the standalone stamp as proj_local (#17295)
* docs(metadata-protocol,objectql,cli): correct six comments describing the standalone stamp as `proj_local` #13366 completed the v5.0 `project` to `environment` rename at the two stamps it had not reached (`runtime/src/standalone-stack.ts`, `metadata/src/plugin.ts`); both now stamp `env_local`. Six comments in three other packages still described the old value. Judged per site rather than search-and-replaced: - Five sites whose verb describing the stamp is present indicative — they describe today's tree, and two of them point the reader at `standalone-stack.ts` to go look — take the current spelling `env_local`. - `cli/src/utils/schema-migrate.ts` names `'proj_local'` as the value the historical #9380 deduction consumed, so the literal stays and its present-tense relative clause moves into the past, with today's spelling named beside it. The causal claim at every site is about PRESENCE, not spelling: the retired gate read `environmentId === undefined`, so it would have misfired identically under either literal. That reading is preserved at all six. Comments only: 21 of 21 changed lines are comment lines. No behaviour, no export, no assertion reads either literal. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XTBcV7zZHmokdyQgXjbyEU * chore(changeset): patch the three packages whose shipped bytes carry the corrected comments Graded by measurement rather than by the "comments only" shape. Built the three packages and grepped the paths their `files[]` actually ships, with a positive control: @objectstack/metadata-protocol dist/index.d.ts, dist/index.d.cts HIT @objectstack/objectql dist/index.d.ts, dist/index.d.mts HIT @objectstack/cli dist/utils/schema-migrate.js HIT positive control `runPlatformMigrations` / `bootSchemaStack` HIT old spelling `standalone stack stamps `'proj_local'`` in dist 0 Two of the six sites are TSDoc on exported interface members, so they land in the shipped declaration files; the CLI site lands in shipped JS because that package builds with `removeComments` unset. All three packages are public and ship `dist`, so `skip-changeset` — which is for a diff that publishes nothing from any released package — does not describe this diff. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01XTBcV7zZHmokdyQgXjbyEU --------- Co-authored-by: Claude <noreply@anthropic.com>
1 parent 4062aef commit 8c9bd8f

6 files changed

Lines changed: 29 additions & 10 deletions

File tree

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
"@objectstack/metadata-protocol": patch
3+
"@objectstack/objectql": patch
4+
"@objectstack/cli": patch
5+
---
6+
7+
docs(metadata-protocol,objectql,cli): comments describing the standalone stamp now name `env_local`, the value the tree actually produces
8+
9+
The v5.0 `project` to `environment` rename reached the two remaining stamps in `@objectstack/runtime` and `@objectstack/metadata` in a previous release: `createStandaloneStack` and `MetadataPlugin` both stamp **`env_local`**. Six comments in three other packages still described that stamp as `'proj_local'`, so they named a value nothing in the tree produces any more.
10+
11+
No behaviour changes. The reason this is a `patch` rather than a no-publish diff is measured, not assumed: two of the six sites are TSDoc on **exported** interface members (`AssembleMetadataProtocolOptions.runPlatformMigrations`, `ObjectQLPluginOptions.runPlatformMigrations`) and land in the shipped `dist/*.d.ts`, and the `@objectstack/cli` site lands in the shipped `dist/utils/schema-migrate.js` because that package builds with `removeComments` unset. All three packages ship `dist` in `files[]`, so the corrected text is what an author reads on hover after upgrading.
12+
13+
The sites were judged individually rather than search-and-replaced, because they are not all the same edit:
14+
15+
- Five sites whose verb describing the stamp is present indicative describe today's tree — two of them point the reader at `runtime/src/standalone-stack.ts` to go and look — and take the current spelling.
16+
- `packages/cli/src/utils/schema-migrate.ts` names `'proj_local'` as the value the historical arming deduction consumed. There the literal is preserved as history and its present-tense relative clause moves into the past, with today's spelling named beside it; rewriting it to `env_local` would have falsified the record in the other direction.
17+
18+
The causal claim at every site is about **presence**, not spelling: the retired gate read `environmentId === undefined`, so it would have misfired identically under either literal. That reading is preserved at all six.

packages/cli/src/utils/platform-migrations-arming.integration.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
* plane and must NOT provision these tables locally."
1313
*
1414
* The gate deduced that from `environmentId === undefined`, and
15-
* `runtime/src/standalone-stack.ts` stamps `'proj_local'` on every boot. So the
15+
* `runtime/src/standalone-stack.ts` stamps `'env_local'` on every boot. So the
1616
* block never ran on `os dev` / `os serve` / `os start` at all, and #8686's own
1717
* header — "repairs an install that is ALREADY in that state, which covers
1818
* every existing deployment" — covered no self-hosted deployment.

packages/cli/src/utils/schema-migrate.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -297,9 +297,10 @@ export async function bootSchemaStack(
297297
// #9380 armed the three `kernel:ready` platform-table migrations on the
298298
// standalone stack (they had never run on a self-hosted install, because
299299
// the assembly deduced "cloud per-project kernel" from the `'proj_local'`
300-
// the stack stamps). Every boot through THIS function inherits that default
301-
// unless it is turned off here, and every one of them is a command that
302-
// reports or applies exactly what the operator asked for:
300+
// the stack stamped then — `'env_local'` since #13366). Every boot through
301+
// THIS function inherits that default unless it is turned off here, and
302+
// every one of them is a command that reports or applies exactly what the
303+
// operator asked for:
303304
//
304305
// • `os migrate plan` / `os migrate duplicates` boot deferred + read-only
305306
// and are declared dry runs;

packages/metadata-protocol/src/plugin.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ export interface AssembleMetadataProtocolOptions {
130130
* Declared, not deduced — the same lesson `authoringChannel` records one
131131
* field above. The gate used to read `environmentId === undefined`, and
132132
* `environmentId` is a ROW-SCOPING KEY, not a topology signal: the
133-
* standalone stack stamps `'proj_local'` on every `os dev` / `os serve` /
133+
* standalone stack stamps `'env_local'` on every `os dev` / `os serve` /
134134
* `os start` / `os migrate` boot (`runtime/src/standalone-stack.ts`), so
135135
* the block the gate guards never ran on a self-hosted install at all —
136136
* #8686's "repairs an install that is ALREADY in that state, which covers
@@ -276,7 +276,7 @@ export function assembleMetadataProtocol(
276276
// [#9380] The gate is now DECLARED (`runPlatformMigrations`) rather
277277
// than deduced from `environmentId === undefined`. The deduction was
278278
// wrong in the direction that mattered: the standalone stack stamps
279-
// `'proj_local'`, so this whole block never armed on a self-hosted
279+
// `'env_local'`, so this whole block never armed on a self-hosted
280280
// boot and the three migrations below reached no self-hosted
281281
// install. The registerApp block above keeps the old predicate on
282282
// purpose — see the note there.

packages/metadata-protocol/src/protocol.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4768,9 +4768,9 @@ export class ObjectStackProtocolImplementation implements
47684768
// This line used to read `if (this.environmentId === undefined)
47694769
// return;` — the carve-out keyed off a ROW-SCOPING key. #6285 measured
47704770
// that short-circuit and found every *regular* serving path safely on
4771-
// the gated side (`os dev` / `os start` bind `env_local`, the
4772-
// standalone artifact stack `proj_local`, a cloud per-project kernel
4773-
// its own), and concluded the only thing behind it was the
4771+
// the gated side (`os dev` / `os start` and the standalone artifact
4772+
// stack bind `env_local`, a cloud per-project kernel its own), and
4773+
// concluded the only thing behind it was the
47744774
// control-plane bootstrap kernel. That conclusion was incomplete, and
47754775
// #6710 measured the counter-example at boot level: the CLI's
47764776
// lightweight host-config assembler (`serve.ts`'s

packages/objectql/src/plugin.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ export interface ObjectQLPluginOptions {
141141
*
142142
* Same lesson as `authoringChannel` right above: the gate used to be deduced
143143
* from `environmentId === undefined`, which is a row-scoping key and not a
144-
* topology signal — the standalone stack stamps `'proj_local'`, so the three
144+
* topology signal — the standalone stack stamps `'env_local'`, so the three
145145
* migrations never armed on a self-hosted boot at all. Forwarded verbatim to
146146
* `assembleMetadataProtocol`; see
147147
* `AssembleMetadataProtocolOptions.runPlatformMigrations` for the two facts

0 commit comments

Comments
 (0)