Implement planned topic: 0025-preload-modules#205
Open
skill-temporal-developer-updater[bot] wants to merge 2 commits into
Open
Implement planned topic: 0025-preload-modules#205skill-temporal-developer-updater[bot] wants to merge 2 commits into
skill-temporal-developer-updater[bot] wants to merge 2 commits into
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Validation Report — Preload Modules
Skill root:
.(skill-temporal-developer/)Scope under validation: commits on
draft/0025-preload-modulesvs.main— single commite91acbcadding a "Preload Modules" subsection toreferences/typescript/advanced-features.md(35 inserted lines).Validator session: independent of authoring. Authoring artifacts under
hidden-from-validator/were not read.Go / no-go
sdk-typescript:ecosystem citations point at SDK source not present in this validation environment and were not deeply verified.sdk-typescript:ecosystem source category. Zero unexplained misses.references/integrations.mdis unrelated to this change. Skipped per template.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 SDKpreloadModulesbundler option).{{SKILL_ROOT}}→.docs/develop/worker-tuning-reference.mdx(line 93 only).sdk-typescript:(TypeScript SDK source tree —packages/worker/src/workflow/bundler.tsandpackages/worker/src/worker-options.ts).preloadModules,reuseV8Context,bundleWorkflowCode,BundleOptions,WorkerOptions,bundlerOptions,ignoreModules,Worker.create,workflowsPath.@default true.`Cannot preload modules that are also ignored: '<module>'`.Check 1 — citation audit
Citations extracted from
references/typescript/advanced-features.md(the only file in the diff):<!-- sdk-typescript: packages/worker/src/workflow/bundler.ts --><!-- sdk-typescript: packages/worker/src/workflow/bundler.ts --><!-- sdk-typescript: packages/worker/src/worker-options.ts --><!-- docs/develop/worker-tuning-reference.mdx:93 --><!-- sdk-typescript: packages/worker/src/workflow/bundler.ts --><!-- sdk-typescript: packages/worker/src/worker-options.ts --><!-- sdk-typescript: packages/worker/src/worker-options.ts --><!-- sdk-typescript: packages/worker/src/workflow/bundler.ts --><!-- sdk-typescript: packages/worker/src/workflow/bundler.ts --><!-- sdk-typescript: packages/worker/src/workflow/bundler.ts -->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
reuseV8Contextis enabled" — the cited line establishesreuseV8Contextas 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: … -->). Asdk-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 withtemporalio/sdk-typescriptcloned alongsidedocumentation/.Check 2 — reverse-grep audit
Tokens extracted and checked against
documentation/docs/:preloadModulessdk-typescript:everywhere it appearsreuseV8Contextdocs/develop/worker-tuning-reference.mdx:74, 93bundleWorkflowCodedocs/develop/typescript/workers/sdk-typescript:tag (sufficient)BundleOptionsdocs/develop/typescript/workflows/basics.mdx:128(worker.BundleOptionslink)sdk-typescript:tagWorkerOptions/bundlerOptionsWorkerOptionsis the standard TS option type;bundlerOptionsnot in docssdk-typescript:tagignoreModulesdocs/develop/typescript/workflows/basics.mdx:128sdk-typescript:-tagged)Worker.create/workflowsPathdocs/develop/typescript/examples@default truesdk-typescript:tagCannot preload modules that are also ignored: '<module>'sdk-typescript:tagFindings: 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:
--profileflagTEMPORAL_TLS_CLIENT_CERT_PATHTEMPORAL_TLS_CLIENT_KEY_PATHTEMPORAL_TLS_SERVER_CA_CERT_PATHtcld service-account--output text/--output jsonlsaas-api.tmprl.cloud:7233Findings: 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:
| `reuseV8Context` (TypeScript) | Reuse V8 context for Workflows |reuseV8Contextis enabled, which is the default (@default true)."The docs line confirms that
reuseV8Contextexists 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 adjacentsdk-typescript: packages/worker/src/worker-options.tscitation, which the validator could not open in this environment. The docs citation is correctly positioned as supporting context (it justifies the existence and role ofreuseV8Context), 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.mdonly; no edits toreferences/integrations.md, no new file underreferences/{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.reuseV8Contextis enabled … if disabled, leave the list empty"preloadModules"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)
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 withtemporalio/sdk-typescriptcloned and verify each tagged claim against the named TS source file.sdk-typescript:does not appear elsewhere in the existing skill (grepped the wholereferences/tree — only this file uses it). It is structurally analogous to thego:/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 listsdk-typescript:alongside the others.Minor (non-blocking) observations
@default trueannotation is inlined verbatim from JSDoc. Readers unfamiliar with@defaultmay parse it as Markdown; consider rewording as "the default" with thesdk-typescript:tag carrying provenance. Not a finding.Statistics
references/typescript/advanced-features.md).sdk-typescript:ecosystem).End of report.