Skip to content

Implement planned topic: 0025-preload-modules#205

Open
skill-temporal-developer-updater[bot] wants to merge 2 commits into
mainfrom
draft/0025-preload-modules
Open

Implement planned topic: 0025-preload-modules#205
skill-temporal-developer-updater[bot] wants to merge 2 commits into
mainfrom
draft/0025-preload-modules

Conversation

@skill-temporal-developer-updater
Copy link
Copy Markdown
Contributor

Validation Report — Preload Modules

Skill root: . (skill-temporal-developer/)
Scope under validation: commits on draft/0025-preload-modules vs. main — single commit e91acbc adding a "Preload Modules" subsection to references/typescript/advanced-features.md (35 inserted lines).
Validator session: independent of authoring. Authoring artifacts under hidden-from-validator/ were not read.


Go / no-go

Check Status Notes
1. Citation audit PASS (with caveat) 1/1 in-repo docs citation resolves; 8 sdk-typescript: ecosystem citations point at SDK source not present in this validation environment and were not deeply verified.
2. Reverse-grep audit PASS Every grep-miss against the docs clone is on a token explicitly tagged with the sdk-typescript: ecosystem source category. Zero unexplained misses.
3. Regression on known bugs PASS Zero hits against the universal regression table.
4. Independent re-verification PASS (small sample) The single docs-grounded claim is consistent with the cited docs line. Sample size is bounded by the change's small number of in-repo docs citations.
5. Integration-layout audit N/A Not a third-party integration topic; references/integrations.md is unrelated to this change. Skipped per template.
6. Tone and scope audit PASS No workaround-disclosure (pattern 1) findings. No Public-Preview admonition is required (cited docs lines do not mark the feature as Public Preview).

Overall verdict: GO. No blocking findings. One advisory note (see "Caveats & advisories"); a couple of minor wording tweaks are optional and listed under "Minor (non-blocking) observations".


Plan placeholders (Phase 1 fill, for the record)

  • {{SKILL_NAME}}Preload Modules (TypeScript SDK preloadModules bundler option).
  • {{SKILL_ROOT}}.
  • §2 docs paths cited by the change:
    • docs/develop/worker-tuning-reference.mdx (line 93 only).
  • Secondary sources cited: sdk-typescript: (TypeScript SDK source tree — packages/worker/src/workflow/bundler.ts and packages/worker/src/worker-options.ts).
  • Check 2 token classes observed in the change:
    • TS identifiers / API names: preloadModules, reuseV8Context, bundleWorkflowCode, BundleOptions, WorkerOptions, bundlerOptions, ignoreModules, Worker.create, workflowsPath.
    • JSDoc-style annotations quoted in prose: @default true.
    • Quoted error string: `Cannot preload modules that are also ignored: '<module>'`.
  • Check 3 topic-specific patterns: none beyond the universal table — the change is a small, focused subsection.
  • Integration topic? No. Check 5 skipped.

Check 1 — citation audit

Citations extracted from references/typescript/advanced-features.md (the only file in the diff):

# Line Tag Resolves? Note
1 107 <!-- sdk-typescript: packages/worker/src/workflow/bundler.ts --> Ecosystem Source not in validation env.
2 107 <!-- sdk-typescript: packages/worker/src/workflow/bundler.ts --> Ecosystem Source not in validation env.
3 107 <!-- sdk-typescript: packages/worker/src/worker-options.ts --> Ecosystem Source not in validation env.
4 107 <!-- docs/develop/worker-tuning-reference.mdx:93 --> YES File exists; line 93 = ``
5 109 <!-- sdk-typescript: packages/worker/src/workflow/bundler.ts --> Ecosystem Source not in validation env.
6 120 <!-- sdk-typescript: packages/worker/src/worker-options.ts --> Ecosystem Source not in validation env.
7 135 <!-- sdk-typescript: packages/worker/src/worker-options.ts --> Ecosystem Source not in validation env.
8 136 <!-- sdk-typescript: packages/worker/src/workflow/bundler.ts --> Ecosystem Source not in validation env.
9 137 <!-- sdk-typescript: packages/worker/src/workflow/bundler.ts --> Ecosystem Source not in validation env.
10 138 <!-- sdk-typescript: packages/worker/src/workflow/bundler.ts --> Ecosystem Source not in validation env.

Counts: 10 inline citations total. 1 docs citation; 9 sdk-typescript: ecosystem citations (some referencing the same file from different sentences).

Findings: none. The single in-repo docs citation resolves and substantively supports the adjacent claim ("It is only beneficial when reuseV8Context is enabled" — the cited line establishes reuseV8Context as a TypeScript Worker option for reusing V8 context).

Caveat: the 9 sdk-typescript: citations are ecosystem-tagged in the same style the validation plan's optional ecosystem-regression subsection prescribes (<!-- go: … -->, <!-- grpc: … -->, <!-- man: … -->). A sdk-typescript: category is a sensible fourth member of that family, and the citations are well-formed (path + filename) — but their contents are not verifiable without a checked-out TypeScript SDK tree. If you require source-level verification of those claims, run a follow-up pass with temporalio/sdk-typescript cloned alongside documentation/.


Check 2 — reverse-grep audit

Tokens extracted and checked against documentation/docs/:

Token Found in docs? Tagged? Verdict
preloadModules No sdk-typescript: everywhere it appears Acceptable (ecosystem)
reuseV8Context Yesdocs/develop/worker-tuning-reference.mdx:74, 93 docs cite at line 107 Acceptable
bundleWorkflowCode Yes — several locations under docs/develop/typescript/workers/ sdk-typescript: tag (sufficient) Acceptable
BundleOptions Yesdocs/develop/typescript/workflows/basics.mdx:128 (worker.BundleOptions link) sdk-typescript: tag Acceptable
WorkerOptions / bundlerOptions WorkerOptions is the standard TS option type; bundlerOptions not in docs sdk-typescript: tag Acceptable (ecosystem)
ignoreModules Yesdocs/develop/typescript/workflows/basics.mdx:128 implicit via context (referenced only inside a constraint that is sdk-typescript:-tagged) Acceptable
Worker.create / workflowsPath Yes — multiple docs/develop/typescript/ examples n/a Acceptable
@default true No (JSDoc convention) sdk-typescript: tag Acceptable (ecosystem)
Error string Cannot preload modules that are also ignored: '<module>' No sdk-typescript: tag Acceptable (ecosystem)

Findings: zero unexplained grep-misses. Every token absent from the docs is paired with a sdk-typescript: ecosystem source comment.


Check 3 — regression on known bugs

Universal patterns scanned across the new content:

Pattern Present in diff?
--profile flag No
TEMPORAL_TLS_CLIENT_CERT_PATH No
TEMPORAL_TLS_CLIENT_KEY_PATH No
TEMPORAL_TLS_SERVER_CA_CERT_PATH No
tcld service-account No
--output text / --output jsonl No
saas-api.tmprl.cloud:7233 No

Findings: zero hits.


Check 4 — independent re-verification

Only one in-repo docs citation exists in the diff (worker-tuning-reference.mdx:93), so the population to sample is N = 1. Read the cited line independently of the authored text:

  • Cited line (docs): | `reuseV8Context` (TypeScript) | Reuse V8 context for Workflows |
  • Authored claim using this citation: "It is only beneficial when reuseV8Context is enabled, which is the default (@default true)."

The docs line confirms that reuseV8Context exists and is a TypeScript-only memory setting governing V8 context reuse. The "only beneficial when enabled" and "default true" portions are not stated in this specific docs line — they ride on the adjacent sdk-typescript: packages/worker/src/worker-options.ts citation, which the validator could not open in this environment. The docs citation is correctly positioned as supporting context (it justifies the existence and role of reuseV8Context), and the SDK-source tag is what backs the default value. No misrepresentation of the cited docs line.

Findings: none. Sample match rate 1/1 = 100%.

Caveat: with N = 1, statistical confidence is low. The skill's depth is intentionally narrow (one feature, one paragraph + four constraint bullets + two code snippets), so this is expected; if the SDK source is later checked out, the 9 ecosystem citations can be re-verified to bring the effective sample size up.


Check 5 — integration-layout audit

Not applicable. The change touches references/typescript/advanced-features.md only; no edits to references/integrations.md, no new file under references/{language}/integrations/, no SKILL.md edit. This is a per-language advanced-features addition, not a third-party integration.


Check 6 — tone and scope audit

Read the new subsection (advanced-features.md:105-138) end-to-end and judged bullet-by-bullet.

Item Pattern Verdict
Opening paragraph (line 107) Definition + applicability statement. Clean.
AOT bundling code example (lines 109-118) Single canonical call site. Clean.
Startup-bundling code example (lines 120-131) Single canonical call site. Clean.
Constraint bullet 1: "only beneficial when reuseV8Context is enabled … if disabled, leave the list empty" Constraint + supported fix. Clean — matches the acceptable "terse hard-constraint statement combining limit + supported fix" form.
Constraint bullet 2: "Module top-level code runs once … Only preload modules whose initialization is safe to execute that early" Constraint + supported scope statement. Clean.
Constraint bullet 3: "Preloading a module that internally stores per-workflow state will leak context … Remove such modules from preloadModules" Constraint + supported fix. Clean.
Constraint bullet 4: error-string + "Remove the module from one of the two lists" Constraint + supported fix. Clean.

Workaround-disclosure (pattern 1) findings: none. No bullet describes how to subvert a documented limit; every negative bullet pairs with a supported alternative.

Public-Preview admonition (pattern 4): the only cited docs line (worker-tuning-reference.mdx:93) does not mark the feature as Public Preview. The Public-Preview admonition is not required for this change.

Other patterns (2 / 3): no in-the-weeds rationale or multi-sentence bullets where sentence #2 is noise. Each bullet's second sentence is the supported fix, which is action-bearing.

Findings: none.


Caveats & advisories (not findings)

  1. Ecosystem citations dominate. 9 of 10 inline source comments are sdk-typescript: ecosystem tags pointing at SDK source files (packages/worker/src/workflow/bundler.ts, packages/worker/src/worker-options.ts). The validator could not open these files in this environment. If your release gate requires source-level verification of every claim, run a second pass with temporalio/sdk-typescript cloned and verify each tagged claim against the named TS source file.
  2. New source category. sdk-typescript: does not appear elsewhere in the existing skill (grepped the whole references/ tree — only this file uses it). It is structurally analogous to the go: / grpc: / man: categories the validation template's optional ecosystem-regression subsection describes, so the pattern is sound, but you may want to (a) document the category in the authoring conventions and (b) update the validation plan template to list sdk-typescript: alongside the others.

Minor (non-blocking) observations

  • Line 107 stacks four citation comments inside one sentence; the reading is unambiguous but dense. A future polish pass could split into two sentences to make the docs↔SDK provenance separation more obvious. Not a finding.
  • The @default true annotation is inlined verbatim from JSDoc. Readers unfamiliar with @default may parse it as Markdown; consider rewording as "the default" with the sdk-typescript: tag carrying provenance. Not a finding.

Statistics

  • Files changed in diff: 1 (references/typescript/advanced-features.md).
  • Lines added: 35.
  • Inline citation comments: 10 total (1 docs + 9 sdk-typescript: ecosystem).
  • In-repo docs citations resolved: 1 / 1 (100%).
  • Reverse-grep unexplained misses: 0.
  • Regression-table hits: 0.
  • Check 4 sample size / match rate: 1 / 1 (100%).
  • Workaround-disclosure findings: 0.

End of report.

skill-sync[bot] and others added 2 commits May 14, 2026 18:46
Documents the `preloadModules` bundler option on `BundleOptions` and
`WorkerOptions.bundlerOptions`, including the `reuseV8Context`
precondition, the per-workflow-state warning, and the bundle-time
conflict with `ignoreModules`. Sourced from sdk-typescript JSDoc since
the docs clone is silent on this option.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@skill-temporal-developer-updater skill-temporal-developer-updater Bot requested a review from a team as a code owner May 14, 2026 18:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants