diff --git a/README.md b/README.md index 25f407e..dd2df81 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ OpenAI-compatible model endpoints, and returns generated output with validation metadata. The application uses -[PromptKit v0.23.2](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/) +[PromptKit v0.23.3](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/) for prompt, profile, schema, preparation, generation, and validation behavior. Scriptorium owns executable configuration, CLI and HTTP mapping, process behavior, output presentation, and HTTP artifact-containment policy. @@ -41,8 +41,8 @@ a model. For complete invocation and output behavior, see the - [Upgrade Promptkit source selectors and definitions](docs/consumers/upgrading-promptkit.md) - [Subprocess integration](docs/integrations/subprocess.md) - [Architecture policy](docs/policy/architecture.md) -- [Promptkit framework formats](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/formats.md) -- [Promptkit Go consumer guide](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/consumers/pkg-promptkit.md) +- [Promptkit framework formats](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/formats.md) +- [Promptkit Go consumer guide](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/consumers/pkg-promptkit.md) ## Examples diff --git a/docs/api.md b/docs/api.md index c3746eb..ae0924d 100644 --- a/docs/api.md +++ b/docs/api.md @@ -67,11 +67,11 @@ The optional `model` object accepts `endpoint`, `model`, `temperature`, `max_tokens`, `top_p`, `timeout_seconds`, `service_tier`, `reasoning_effort`, `api_key_env`, and `extra_params`. Numeric ranges and framework credential semantics are defined by the -[PromptKit v0.23.2 format reference](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/formats.md). +[PromptKit v0.23.3 format reference](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/formats.md). Explicit zero values for the numeric fields are overrides; zero `timeout_seconds` disables the per-attempt generation deadline only, retaining the request context and configured transport cap. The timeout layers are defined in -the [PromptKit v0.23.2 outbound integration contract](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/integrations/openai-compatible-chat.md#timeout-and-cancellation). +the [PromptKit v0.23.3 outbound integration contract](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/integrations/openai-compatible-chat.md#timeout-and-cancellation). Each built-in transient retry gets a fresh generation timeout; the caller's request context remains the outer cancellation boundary. @@ -221,14 +221,6 @@ attempt timeout while the parent remains live retains `502 llm_failed`. A succes run remains successful even if cancellation races with response formatting; delivery after a client disconnect cannot be guaranteed. -With the selected PromptKit release and Go 1.27.4, an operation budget that -expires during an in-flight built-in HTTP request can currently surface as -`502 llm_failed` instead of the intended `504`: the transport may return the -operation's cancellation cause without the typed timeout. Retry and capacity -waits are attributed correctly. In the affected case, an opted-in terminal -report can likewise classify the failure as `transport`. Treat this as a known -upstream limitation. - ## Retry And Idempotency Scriptorium provides no idempotency keys, pagination, caching headers, or rate diff --git a/docs/cli.md b/docs/cli.md index 506dffc..dfca66a 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -92,7 +92,7 @@ only; the caller context and configured transport cap remain active. CLI durations are converted to whole seconds by truncation toward zero, so any duration whose absolute value is below one second becomes an explicit zero-second override. The timeout layers are defined in the -[Promptkit outbound integration contract](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/integrations/openai-compatible-chat.md#timeout-and-cancellation). +[Promptkit outbound integration contract](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/integrations/openai-compatible-chat.md#timeout-and-cancellation). With the built-in client, each transient retry gets a fresh generation timeout; this flag does not limit the complete run. `--run-timeout` keeps subsecond precision and starts immediately before engine @@ -100,9 +100,7 @@ execution. It bounds preparation, capacity waits, retry waits, generation, and repairs where they honor context. Parsing, engine construction, and output writes are outside that interval. A failed run identified by PromptKit as an operation timeout exits 1 with a safe deadline diagnostic; a completed invalid -output still exits 2. Synchronous work may not stop immediately. The selected -PromptKit release can report an in-flight built-in HTTP operation timeout as a -transport failure rather than a typed deadline; see the [API reference](api.md#error-responses). +output still exits 2. Synchronous work may not stop immediately. Omitting `--transient-retries` inherits the application setting or Promptkit's current default of two additional attempts. The flag overrides only this request; it does not alter the configured engine. Structural repair generations @@ -332,7 +330,7 @@ name inspection, so treat these reports as sensitive. This redaction policy is limited to framework configuration reports; it does not add redaction to `inspect profile` or prepared-run output. Credentials are not resolved by any of these inspection operations. Promptkit owns detailed field and source -semantics; see its tagged [format reference](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/formats.md). +semantics; see its tagged [format reference](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/formats.md). Warnings and errors go to stderr. Successful `validate` writes nothing to stdout; successful `show`, `sources`, and `explain` write their reports there. diff --git a/docs/config.md b/docs/config.md index 8c905bc..08bf203 100644 --- a/docs/config.md +++ b/docs/config.md @@ -3,7 +3,7 @@ This is the canonical reference for Scriptorium application settings. Prompt, profile, backend, schema, execution-setting, built-in profile, and framework credential semantics are defined by the -[PromptKit v0.23.2 format reference](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/formats.md). +[PromptKit v0.23.3 format reference](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/formats.md). For command syntax, see the [CLI reference](cli.md); for HTTP request shapes and outcomes, see the [HTTP API reference](api.md). For migration examples, see [Upgrading Promptkit sources and definitions](consumers/upgrading-promptkit.md). @@ -65,7 +65,7 @@ still applies. A later sequence item overlays an earlier one. Files within a selected directory are composed together, so conflicting definitions in that group fail instead of using filename order as precedence. An explicit file may use ConfigKit imports. The complete framework format and -source rules belong to the [PromptKit v0.23.2 format reference](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/formats.md). +source rules belong to the [PromptKit v0.23.3 format reference](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/formats.md). Selector paths are relative to the process working directory, not to the application configuration file. Application validation checks the selector @@ -128,8 +128,8 @@ inherited policy, declare `mode: replace` at for policy lifetime and combination rules. These application root `config` controls do not change the separate -PromptKit v0.23.2 framework format: its selected framework files use the -[Promptkit contract](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/formats.md) +PromptKit v0.23.3 framework format: its selected framework files use the +[Promptkit contract](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/formats.md) and their own native ConfigKit `config` controls. `--config-overlay NAME` selects one file at `overlays/NAME.yml` below that @@ -224,7 +224,7 @@ file formats. contracts. See the -[tagged Promptkit format reference](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/formats.md) +[tagged Promptkit format reference](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/formats.md) for all of those definitions. The files under [`examples/prompts`](../examples/prompts/), [`examples/profiles`](../examples/profiles/), and @@ -266,7 +266,7 @@ client retains its own retry behavior. The tagged integration contract owns eligibility and timing. Promptkit's -[OpenAI-compatible integration contract](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/integrations/openai-compatible-chat.md) +[OpenAI-compatible integration contract](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/integrations/openai-compatible-chat.md) defines outbound authentication, provider request mapping, transport limits, and timeout layering. @@ -275,4 +275,4 @@ and timeout layering. - [CLI reference](cli.md) - [HTTP API reference](api.md) - [Operations guide](operations.md) -- [Promptkit framework formats](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/formats.md) +- [Promptkit framework formats](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/formats.md) diff --git a/docs/consumers/api.md b/docs/consumers/api.md index adc7d5a..f74c9c2 100644 --- a/docs/consumers/api.md +++ b/docs/consumers/api.md @@ -14,7 +14,7 @@ and the HTTP service according to the boundary your application needs. Go applications that need an in-process prompt framework should import `go.maximumdirect.net/promptkit` directly. The tagged -[Promptkit Go consumer guide](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/consumers/pkg-promptkit.md) +[Promptkit Go consumer guide](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/consumers/pkg-promptkit.md) owns that interface; Scriptorium does not provide a Go library package. Consumers arriving from the former Scriptorium Go API should follow the [migration guide](migrating-to-promptkit.md). @@ -35,4 +35,4 @@ Scriptorium does not persist run state. A retry can produce different output and can incur another provider request. CLI exits belong to the [CLI reference](../cli.md), HTTP status behavior belongs to the [HTTP API reference](../api.md), and framework semantics belong to -[PromptKit v0.23.2](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/formats.md). +[PromptKit v0.23.3](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/formats.md). diff --git a/docs/consumers/migrating-to-promptkit.md b/docs/consumers/migrating-to-promptkit.md index 3fcaa34..a080867 100644 --- a/docs/consumers/migrating-to-promptkit.md +++ b/docs/consumers/migrating-to-promptkit.md @@ -4,7 +4,7 @@ This historical first hop targets Promptkit v0.11.1 and its former module path. For the current public module `go.maximumdirect.net/promptkit` and the ID-only configuration cutover, follow the [current upgrade guide](upgrading-promptkit.md) afterward and consult the -[current Go consumer guide](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/consumers/pkg-promptkit.md). +[current Go consumer guide](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/consumers/pkg-promptkit.md). ## Supported Migration Boundary diff --git a/docs/consumers/upgrading-promptkit.md b/docs/consumers/upgrading-promptkit.md index 25b30f5..a77191e 100644 --- a/docs/consumers/upgrading-promptkit.md +++ b/docs/consumers/upgrading-promptkit.md @@ -1,8 +1,8 @@ # Upgrade PromptKit Sources And Definitions This guide covers the CLI and framework configuration cutover to -[PromptKit v0.23.2](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/consumers/configuration-migration.md) -and ConfigKit v1.2.1. See the [framework format reference](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/formats.md) +[PromptKit v0.23.3](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/consumers/configuration-migration.md) +and ConfigKit v1.2.1. See the [framework format reference](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/formats.md) for the full upstream contract. Removing version selectors and changing framework definition shapes are diff --git a/docs/development.md b/docs/development.md index 540ec11..fad41f5 100644 --- a/docs/development.md +++ b/docs/development.md @@ -2,7 +2,7 @@ This is the contributor entry point for Scriptorium. Scriptorium is an application that consumes the public -[PromptKit v0.23.2 package](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/consumers/pkg-promptkit.md); +[PromptKit v0.23.3 package](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/consumers/pkg-promptkit.md); framework implementation work belongs in Promptkit. Application configuration uses ConfigKit v1.2.1; keep Scriptorium's schema and source selection local. PromptKit uses the same ConfigKit release to load framework sources under its @@ -48,13 +48,13 @@ Before recommending, planning, or implementing work: | Application configuration or precedence | [Configuration contract](config.md), [adapter internals](internal/adapters.md), [source internals](internal/sources.md), and `internal/config` definition/load tests | | Prepared-run presentation | [CLI contract](cli.md), [adapter internals](internal/adapters.md), and `internal/format` | | Promptkit source selection or captured framework inspection | [Configuration contract](config.md#promptkit-source-selectors), [framework configuration CLI contract](cli.md#framework-configuration-inspection), and [source internals](internal/sources.md) | -| Prompt, profile, schema, generation, or validation semantics | [PromptKit v0.23.2 framework formats](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/formats.md) and the [Promptkit consumer guide](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/consumers/pkg-promptkit.md) | -| OpenAI-compatible outbound behavior or timeout layering | [PromptKit v0.23.2 integration contract](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/integrations/openai-compatible-chat.md) | +| Prompt, profile, schema, generation, or validation semantics | [PromptKit v0.23.3 framework formats](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/formats.md) and the [Promptkit consumer guide](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/consumers/pkg-promptkit.md) | +| OpenAI-compatible outbound behavior or timeout layering | [PromptKit v0.23.3 integration contract](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/integrations/openai-compatible-chat.md) | | Subprocess behavior | [Subprocess integration](integrations/subprocess.md) and [CLI contract](cli.md) | | Runtime operation or recovery | [Operations](operations.md) | | Dependencies, copied assets, or attribution | The [OSS policy](policy/oss.md), [component attributions](oss/attribution.md), and [architecture policy](policy/architecture.md) | | Release documentation, packaging, or publication | The [release policy](policy/release.md), [OSS policy](policy/oss.md), [release procedure](release.md), [hosted release workflow](../.woodpecker/release.yml), and [architecture policy](policy/architecture.md) | -| Examples or copyable assets | The owning Scriptorium contract, the relevant [PromptKit v0.23.2 format contract](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/formats.md), and the related files under `examples/` | +| Examples or copyable assets | The owning Scriptorium contract, the relevant [PromptKit v0.23.3 format contract](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/formats.md), and the related files under `examples/` | | Architecture decisions or future work | The [documentation policy](policy/documentation.md), relevant accepted ADRs, and relevant roadmap documents | Cross-project changes land and release in Promptkit before Scriptorium adopts diff --git a/docs/integrations/subprocess.md b/docs/integrations/subprocess.md index bae09be..7783c26 100644 --- a/docs/integrations/subprocess.md +++ b/docs/integrations/subprocess.md @@ -56,8 +56,7 @@ protocol. For `run`, callers may set the [whole-run deadline](../cli.md) to bound the engine invocation. It is separate from the per-attempt generation timeout and does not include child startup or output writing. A typed operation deadline -failure exits 1; an in-flight built-in HTTP timeout can currently be reported -as a transport failure as described in the [API reference](../api.md#error-responses). +failure exits 1. Supervisors still own process termination when they need to stop the child outside that engine interval. diff --git a/docs/internal/adapters.md b/docs/internal/adapters.md index d81e490..261e2f1 100644 --- a/docs/internal/adapters.md +++ b/docs/internal/adapters.md @@ -9,7 +9,7 @@ own IO and presentation mechanics, not framework decisions. External contracts are canonical in the [CLI reference](../cli.md) and [HTTP API reference](../api.md). Promptkit's public engine contract is described by its tagged -[Go consumer guide](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/consumers/pkg-promptkit.md). +[Go consumer guide](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/consumers/pkg-promptkit.md). ## Components And Collaborators @@ -97,7 +97,7 @@ mutating the shared engine. Negative values are rejected before invocation; Promptkit controls retries and backend admission for concurrent requests. CLI and HTTP operation budgets map to PromptKit's `OperationTimeout`; HTTP passes the caller context through unchanged. The public sentinels determine -timeout classification, subject to the documented transport limitation. +timeout classification. Failure mapping uses `errors.Is` against Promptkit's public sentinels and the HTTP reader's Scriptorium-owned containment and size errors. Wrapped reader diff --git a/docs/internal/overview.md b/docs/internal/overview.md index 088d555..03c20ad 100644 --- a/docs/internal/overview.md +++ b/docs/internal/overview.md @@ -15,5 +15,5 @@ public behavior belongs in the linked contracts. | `internal/report` | Projects one terminal Promptkit observation into Scriptorium-owned execution metadata. | [adapter internals](adapters.md) | Framework implementation packages are provided by -[PromptKit v0.23.2](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/consumers/pkg-promptkit.md) +[PromptKit v0.23.3](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/consumers/pkg-promptkit.md) and are not part of this repository. diff --git a/docs/internal/sources.md b/docs/internal/sources.md index 23c0eb3..8962e2c 100644 --- a/docs/internal/sources.md +++ b/docs/internal/sources.md @@ -5,7 +5,7 @@ This document covers Scriptorium-owned source locations and the restricted HTTP artifact reader. Prompt, profile, schema, and ordinary artifact semantics are owned by the tagged -[PromptKit v0.23.2 format reference](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/formats.md). +[PromptKit v0.23.3 format reference](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/formats.md). ## Application Source Locations diff --git a/docs/operations.md b/docs/operations.md index 01df1f2..2623d66 100644 --- a/docs/operations.md +++ b/docs/operations.md @@ -11,7 +11,7 @@ fields, or HTTP wire behavior. locations, defaults, and credential mapping. - [Promptkit source upgrade guide](consumers/upgrading-promptkit.md): concise source-selector and definition migration examples. -- [PromptKit v0.23.2 framework formats](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/formats.md): +- [PromptKit v0.23.3 framework formats](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/formats.md): prompt, profile, schema, execution-setting, and framework credential contracts. - [HTTP API reference](api.md): route, request/response schema, status codes, @@ -43,7 +43,7 @@ without a report. Provide the process with readable selected Promptkit source files/directories and schema sources that follow the tagged framework formats. At engine -construction, PromptKit v0.23.2 validates every selected effective definition, +construction, PromptKit v0.23.3 validates every selected effective definition, including unused definitions, and captures referenced message-file contents and static template syntax. `serve` constructs one engine at startup; it does not reload changed configuration or message content. Restart the process to @@ -164,7 +164,7 @@ setting and then Promptkit's default, while explicit zero disables additional attempts. Existing generation timeouts apply per attempt, while the caller context covers the complete operation. Provider `Retry-After` timing can exceed Promptkit's ordinary backoff cap; consult the -[outbound integration contract](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/integrations/openai-compatible-chat.md) +[outbound integration contract](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/integrations/openai-compatible-chat.md) for details. CLI `run` can set a [whole-run deadline](cli.md) when total execution time must @@ -175,8 +175,7 @@ context cancellation; it excludes parsing, engine setup, and output writes. HTTP callers can use [`run_timeout_seconds`](api.md) to set the engine's operation budget for the same interval. The API distinguishes a typed expired execution deadline from caller cancellation and from a provider-attempt -timeout, subject to the documented in-flight transport limitation. A canceled -capacity waiter releases its Promptkit admission state. +timeout. A canceled capacity waiter releases its Promptkit admission state. Before increasing a limit: diff --git a/docs/oss/attribution.md b/docs/oss/attribution.md index f3c014e..cf2f993 100644 --- a/docs/oss/attribution.md +++ b/docs/oss/attribution.md @@ -20,7 +20,7 @@ License and notices: [CC BY-SA 4.0](licenses/CC-BY-SA-4.0.txt) | ## PromptKit -Selected module: `go.maximumdirect.net/promptkit` at `v0.23.2`. +Selected module: `go.maximumdirect.net/promptkit` at `v0.23.3`. Copyright (C) 2026 Eric Rakestraw @@ -28,10 +28,10 @@ SPDX-License-Identifier: LGPL-3.0-or-later License and notices: [LGPL 3.0](licenses/LGPL-3.0.txt) | [GPL 3.0](licenses/GPL-3.0.txt) | -[COPYRIGHT](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/COPYRIGHT) | -[LICENSE](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/LICENSE). +[COPYRIGHT](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/COPYRIGHT) | +[LICENSE](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/LICENSE). -[Source](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71). +[Source](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f). ## ConfigKit diff --git a/docs/policy/architecture.md b/docs/policy/architecture.md index 3e08247..6888534 100644 --- a/docs/policy/architecture.md +++ b/docs/policy/architecture.md @@ -50,15 +50,15 @@ inventory; [adapter internals](../internal/adapters.md) and ## Framework And Application Boundaries Scriptorium consumes -[PromptKit v0.23.2](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/consumers/pkg-promptkit.md) +[PromptKit v0.23.3](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/consumers/pkg-promptkit.md) through its supported public root package. Promptkit owns prompt execution, preparation, prompt and profile formats, built-in profiles, model-client behavior, validation, and framework defaults. Scriptorium owns application configuration, executable CLI and HTTP adapters, prepared-run and definition-inspection presentation, captured-configuration inspection exposure, process behavior, and HTTP deployment policy. The [format -reference](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/formats.md) -and [outbound integration contract](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/382ccfb14b9630fd8f48c8364dbe2b6159637d71/docs/integrations/openai-compatible-chat.md) +reference](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/formats.md) +and [outbound integration contract](https://forge.maximumdirect.net/base-layer/promptkit/src/commit/804a4d32b23aa2e7973400bb0a322a7016574c9f/docs/integrations/openai-compatible-chat.md) remain Promptkit's contracts. Scriptorium uses ConfigKit v1.2.1 for strict application YAML decoding, diff --git a/docs/roadmap/implementation.md b/docs/roadmap/implementation.md index 7c11b2b..daafe8f 100644 --- a/docs/roadmap/implementation.md +++ b/docs/roadmap/implementation.md @@ -7,6 +7,11 @@ repository policies, and [ADR 0004](../adr/0004-definition-boundary.md) and [ADR 0005](../adr/0005-configkit-boundary.md). Use the pinned upstream references in the feature roadmap, not either sibling checkout's moving HEAD. +For final verification, the selected PromptKit release is v0.23.3 at commit +`804a4d32b23aa2e7973400bb0a322a7016574c9f`. The maintainer approved this +patch update after v0.23.2 exposed an in-flight HTTP timeout attribution bug; +it supersedes the earlier PromptKit pin below. ConfigKit remains v1.2.1. + Execute these stages in order as one sprint. Intermediate stages may leave unresolved imports, outdated fixtures, or failing tests that a later stage explicitly addresses. Do not add shims or split the migration into separately @@ -339,6 +344,8 @@ scaffolding, or conversation and coordination features. ## Stage 8: Verify the complete cutover +**Status: Complete.** + 1. Use the selected Go 1.27.4 toolchain. Finish `GOWORK=off go mod tidy` after all imports and fixtures are in place and confirm `GOWORK=off go mod tidy -diff` is empty. Inspect `go list -m all` for diff --git a/docs/roadmap/promptkit-v0.23.2-adoption.md b/docs/roadmap/promptkit-v0.23.2-adoption.md index 4778f34..d5b7dd1 100644 --- a/docs/roadmap/promptkit-v0.23.2-adoption.md +++ b/docs/roadmap/promptkit-v0.23.2-adoption.md @@ -2,8 +2,12 @@ ## Status And Scope -Accepted direction; not yet implemented. Upgrade the existing Scriptorium -product in one native cutover. Use the released PromptKit and ConfigKit APIs +Implemented. The original v0.23.2 target below was superseded for final +verification by PromptKit v0.23.3 at commit +`804a4d32b23aa2e7973400bb0a322a7016574c9f`, with the maintainer's approval, +to correct in-flight HTTP operation-timeout attribution. ConfigKit remains +v1.2.1. This roadmap upgrades the existing Scriptorium product in one native +cutover. Use the released PromptKit and ConfigKit APIs for framework and configuration mechanisms that they already own. Provide migration guidance for configuration, definitions, and CLI usage, not a second application schema, a legacy definition reader, or compatibility diff --git a/go.mod b/go.mod index ab04592..606dc08 100644 --- a/go.mod +++ b/go.mod @@ -4,7 +4,7 @@ go 1.27.0 require ( go.maximumdirect.net/configkit v1.2.1 - go.maximumdirect.net/promptkit v0.23.2 + go.maximumdirect.net/promptkit v0.23.3 ) require ( diff --git a/go.sum b/go.sum index 9cd020a..f94e6d1 100644 --- a/go.sum +++ b/go.sum @@ -4,8 +4,8 @@ github.com/santhosh-tekuri/jsonschema/v6 v6.0.3 h1:1EYB5IzjZawrrnELUi78f9fPu57Hu github.com/santhosh-tekuri/jsonschema/v6 v6.0.3/go.mod h1:JXeL+ps8p7/KNMjDQk3TCwPpBy0wYklyWTfbkIzdIFU= go.maximumdirect.net/configkit v1.2.1 h1:f+/6WjNl6CULbMr6ZSVwi4aty9rmuDfJlvpeU7I+HZM= go.maximumdirect.net/configkit v1.2.1/go.mod h1:ewu6blSokUDCMovy8JBXAdXRikGmlHXAQpFghnPWRfs= -go.maximumdirect.net/promptkit v0.23.2 h1:nE+Qqqbw5GN4PHD2e5OEWUHXcYkESZm3ryZVBsKWwFQ= -go.maximumdirect.net/promptkit v0.23.2/go.mod h1:vPFg76VXcffP0JBFMS2WADCHwV5FYvO2O4bvIoiDlwc= +go.maximumdirect.net/promptkit v0.23.3 h1:bKbrkluwfgXUsm0e/mxz/TpV9b60yUtJLVUROLsM3VU= +go.maximumdirect.net/promptkit v0.23.3/go.mod h1:vPFg76VXcffP0JBFMS2WADCHwV5FYvO2O4bvIoiDlwc= go.yaml.in/yaml/v4 v4.0.0 h1:/LG1pNO84Z4l603j/xMn69CcS5OYhMQ/f7l2LoQUGuw= go.yaml.in/yaml/v4 v4.0.0/go.mod h1:aZqd9kCMsGL7AuUv/m/PvWLdg5sjJsZ4oHDEnfPPfY0= golang.org/x/text v0.44.0 h1:YItdp/mQNGnsmrgpcdA5yQ3bnRxCfo/Tj/iByGW9GGo= diff --git a/internal/adapter/http/handler_test.go b/internal/adapter/http/handler_test.go index 2849cec..7e58ed0 100644 --- a/internal/adapter/http/handler_test.go +++ b/internal/adapter/http/handler_test.go @@ -1227,6 +1227,42 @@ func TestHandlerDeadlineCancelsBuiltInRetryWait(t *testing.T) { } } +func TestHandlerDeadlineDuringBuiltInGeneration(t *testing.T) { + started := make(chan struct{}, 1) + release := make(chan struct{}) + provider := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + started <- struct{}{} + <-release + })) + defer provider.Close() + defer close(release) + h := newRetryHandler(t, provider.URL+"/v1", intPointer(0), 0, nil) + failures := observeRunnerFailures(h) + w := httptest.NewRecorder() + h.ServeHTTP(w, httptest.NewRequest(http.MethodPost, "/v1/runs", strings.NewReader(`{"prompt_id":"p","run_timeout_seconds":1,"include_execution_report":true}`))) + select { + case <-started: + default: + t.Fatal("provider call did not start") + } + err := <-failures + if !errors.Is(err, promptkit.ErrOperationTimeout) || !errors.Is(err, context.DeadlineExceeded) { + t.Errorf("engine did not attribute in-flight generation to operation timeout: %v (deadline cause: %t)", err, errors.Is(err, context.DeadlineExceeded)) + } + var response struct { + Execution *struct { + Failure string `json:"failure"` + } `json:"execution"` + } + if err := json.Unmarshal(w.Body.Bytes(), &response); err != nil { + t.Fatal(err) + } + if response.Execution == nil || response.Execution.Failure != "deadline" { + t.Errorf("terminal report did not classify deadline: %+v", response.Execution) + } + assertHTTPErrorCode(t, w, http.StatusGatewayTimeout, "deadline_exceeded") +} + func TestHandlerDeadlineCancelsCapacityWaitAndReleasesAdmission(t *testing.T) { started := make(chan struct{}, 1) release := make(chan struct{})