Compare commits
94 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 2126864153 | |||
| 47c2a711f0 | |||
| 41304e4eea | |||
| 3d7c9aa324 | |||
| 9ac7006a79 | |||
| 36e7e857f5 | |||
| 207c75dda3 | |||
| e6e7d5c52b | |||
| c016af04b7 | |||
| 43eea5c7c4 | |||
| 979697f19d | |||
| b399ebe391 | |||
| 6508ccc036 | |||
| e177d7c71d | |||
| aca50de9bf | |||
| c60813e490 | |||
| edc1f8abd9 | |||
| f77bd4b528 | |||
| 7de2b02891 | |||
| 911ca5485a | |||
| a4ef91fb7e | |||
| acf511fc0d | |||
| 2a06a911bc | |||
| 5c3b0cf4f6 | |||
| 604c1f1678 | |||
| e4405966c8 | |||
| 537bddf40c | |||
| f33af20524 | |||
| 85d14784ca | |||
| edca9fbbc1 | |||
| 6c2541c1ee | |||
| b9b98b2aec | |||
| 8936ca7c18 | |||
| 3e5f5c5198 | |||
| 68ebe9ee50 | |||
| 36c7c5a358 | |||
| 157209f097 | |||
| 06b37c2bae | |||
| 1a0f15e210 | |||
| 5f946a5a1f | |||
| 1806df9888 | |||
| c35ac5a0cb | |||
| 40f8a1c628 | |||
| 27d7ad5057 | |||
| 1f08a1a94c | |||
| 2f42bdde39 | |||
| 9a00f30c7b | |||
| f71d2bbb73 | |||
| 6f64947e42 | |||
| 7bb4cf35b9 | |||
| fb0b21c51d | |||
| 5a00ca81a2 | |||
| e13610481d | |||
| 309fe9b7ea | |||
| adfd08ffe2 | |||
| c7263ab2a8 | |||
| 532c31c09a | |||
| 68cd90c657 | |||
| 416438d80d | |||
| 9298d8ae73 | |||
| 4c7278febc | |||
| 096208532e | |||
| 50bd19b9d1 | |||
| 2fc7204bd5 | |||
| c0d4ea0d4e | |||
| 4d7e1327ad | |||
| 3c33b52b15 | |||
| 280916bf4a | |||
| 033bc93d3c | |||
| 45c2644b9d | |||
| a74c03bd9b | |||
| ad115a2259 | |||
| 3074b3165a | |||
| 8703793b0c | |||
| 4cb4943a57 | |||
| c6c747e94d | |||
| 2bbf13e739 | |||
| 5edb24a9c1 | |||
| 99d5e96316 | |||
| 144d840fbe | |||
| ed0c9f6370 | |||
| a0e905ce46 | |||
| 719243e90c | |||
| a9e1b7435c | |||
| eb6dfb19b0 | |||
| d86b65adad | |||
| 31faaf4259 | |||
| 9932153b97 | |||
| f0ca233c25 | |||
| ff31f8daf8 | |||
| c927b7819d | |||
| 6d1fb66dd7 | |||
| e0b1d6a0dc | |||
| 33698903be |
3
.gitignore
vendored
3
.gitignore
vendored
@@ -56,6 +56,8 @@ mono_crash.*
|
|||||||
[Dd]ebugPublic/
|
[Dd]ebugPublic/
|
||||||
[Rr]elease/
|
[Rr]elease/
|
||||||
[Rr]eleases/
|
[Rr]eleases/
|
||||||
|
!docs/releases/
|
||||||
|
!docs/releases/*.md
|
||||||
x64/
|
x64/
|
||||||
x86/
|
x86/
|
||||||
[Ww][Ii][Nn]32/
|
[Ww][Ii][Nn]32/
|
||||||
@@ -433,4 +435,3 @@ FodyWeavers.xsd
|
|||||||
|
|
||||||
# JetBrains Rider
|
# JetBrains Rider
|
||||||
*.sln.iml
|
*.sln.iml
|
||||||
|
|
||||||
|
|||||||
@@ -11,9 +11,16 @@ steps:
|
|||||||
version="$CI_COMMIT_TAG"
|
version="$CI_COMMIT_TAG"
|
||||||
dist="dist"
|
dist="dist"
|
||||||
pkg="gitea.maximumdirect.net/eric/scriptorium/cmd/scriptorium"
|
pkg="gitea.maximumdirect.net/eric/scriptorium/cmd/scriptorium"
|
||||||
|
notes="docs/releases/$version.md"
|
||||||
|
|
||||||
|
if [ ! -f "$notes" ]; then
|
||||||
|
printf 'release notes not found: %s\n' "$notes" >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
rm -rf "$dist"
|
rm -rf "$dist"
|
||||||
mkdir -p "$dist"
|
mkdir -p "$dist"
|
||||||
|
cp "$notes" "$dist/RELEASE_NOTES.md"
|
||||||
|
|
||||||
build_binary() {
|
build_binary() {
|
||||||
goos="$1"
|
goos="$1"
|
||||||
@@ -22,7 +29,7 @@ steps:
|
|||||||
output="$dist/scriptorium-$version-$goos-$goarch$suffix"
|
output="$dist/scriptorium-$version-$goos-$goarch$suffix"
|
||||||
|
|
||||||
CGO_ENABLED=0 GOOS="$goos" GOARCH="$goarch" \
|
CGO_ENABLED=0 GOOS="$goos" GOARCH="$goarch" \
|
||||||
go build -trimpath -ldflags "-s -w -X gitea.maximumdirect.net/eric/scriptorium/internal/buildinfo.Version=$version" \
|
go build -trimpath -ldflags "-s -w" \
|
||||||
-o "$output" "$pkg"
|
-o "$output" "$pkg"
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -38,6 +45,7 @@ steps:
|
|||||||
from_secret: GITEA_RELEASE_TOKEN
|
from_secret: GITEA_RELEASE_TOKEN
|
||||||
files:
|
files:
|
||||||
- dist/scriptorium-*
|
- dist/scriptorium-*
|
||||||
|
note: dist/RELEASE_NOTES.md
|
||||||
checksum: sha256
|
checksum: sha256
|
||||||
checksum-file: SHA256SUMS
|
checksum-file: SHA256SUMS
|
||||||
checksum-flatten: true
|
checksum-flatten: true
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
Please carefully review the relevant documents in `docs/policy` before making any changes to this repository.
|
Please review `docs/development.md` for initial orientation in this repository and follow its task-specific reading guide.
|
||||||
- `development.md` defines the contributor workflow for this application.
|
|
||||||
- `architecture.md` provides the canonical high-level architecture policy for this repository, and should be reviewed before writing or changing any code.
|
Review and follow `docs/policy/agents.md` before recommending, planning, or
|
||||||
- `documentation.md` provides the canonical documentation policy for this repository, and should be reviewed before writing or changing any documentation.
|
implementing changes to this repository.
|
||||||
|
|||||||
44
README.md
44
README.md
@@ -1,12 +1,15 @@
|
|||||||
# scriptorium
|
# Scriptorium
|
||||||
|
|
||||||
Scriptorium is a narrow prompt-execution application for rendering prompt
|
Scriptorium is a prompt-execution application with a command-line interface and
|
||||||
requests, running them against OpenAI-compatible chat-completions endpoints, and
|
an HTTP service. It prepares prompt requests, runs them against
|
||||||
serving the same run workflow over HTTP.
|
OpenAI-compatible model endpoints, and returns generated output with validation
|
||||||
|
metadata.
|
||||||
|
|
||||||
It keeps prompt definitions, execution profiles, schemas, and input artifacts as
|
The application uses
|
||||||
separate files so prompts can be reviewed and reused without baking model
|
[Promptkit v0.11.0](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/)
|
||||||
runtime settings into application code.
|
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.
|
||||||
|
|
||||||
## Quickstart
|
## Quickstart
|
||||||
|
|
||||||
@@ -21,25 +24,34 @@ go run ./cmd/scriptorium render \
|
|||||||
--format json
|
--format json
|
||||||
```
|
```
|
||||||
|
|
||||||
This command renders the prepared prompt and effective runtime settings without calling an LLM.
|
This renders the prepared prompt and effective runtime settings without calling
|
||||||
|
a model. For complete invocation and output behavior, see the
|
||||||
|
[CLI reference](docs/cli.md).
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
- [CLI reference](docs/cli.md)
|
- [CLI reference](docs/cli.md)
|
||||||
- [Configuration reference](docs/config.md)
|
- [Configuration reference](docs/config.md)
|
||||||
|
- [Application configuration inspection](docs/cli.md#application-configuration-inspection)
|
||||||
- [HTTP API reference](docs/api.md)
|
- [HTTP API reference](docs/api.md)
|
||||||
- [Operations guide](docs/operations.md)
|
- [Operations guide](docs/operations.md)
|
||||||
- [Troubleshooting](docs/troubleshooting.md)
|
|
||||||
- [Consumer integration overview](docs/consumers/api.md)
|
- [Consumer integration overview](docs/consumers/api.md)
|
||||||
- [Go library package](docs/consumers/pkg-scriptorium.md)
|
- [Migration from the former Go package](docs/consumers/migrating-to-promptkit.md)
|
||||||
- [Subprocess integration](docs/integrations/subprocess.md)
|
- [Subprocess integration](docs/integrations/subprocess.md)
|
||||||
- [OpenAI-compatible chat integration](docs/integrations/openai-compatible-chat.md)
|
|
||||||
- [Architecture policy](docs/policy/architecture.md)
|
- [Architecture policy](docs/policy/architecture.md)
|
||||||
|
- [Promptkit framework formats](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/docs/formats.md)
|
||||||
|
- [Promptkit Go consumer guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/docs/consumers/pkg-promptkit.md)
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
- `examples/config.yml`
|
- [Minimal configuration](examples/config.yml) and
|
||||||
- `examples/config.full.yml`
|
[complete configuration](examples/config.full.yml), plus a
|
||||||
- `examples/render-markdown-summary.sh`
|
[composed import/overlay example](examples/config.composed.yml)
|
||||||
- `examples/http-run.json`
|
- [Prompt definitions](examples/prompts/), [execution profiles](examples/profiles/),
|
||||||
- `examples/go-library/prepare`
|
[schemas](examples/schemas/), and [synthetic input fixtures](examples/fixtures/)
|
||||||
|
- [Render script](examples/render-markdown-summary.sh)
|
||||||
|
- [HTTP request](examples/http-run.json)
|
||||||
|
|
||||||
|
Scriptorium is licensed under the [BSD 3-Clause License](LICENSE).
|
||||||
|
|
||||||
|
[Open Source attribution notices](docs/oss/attribution.md) are available.
|
||||||
|
|||||||
406
convert.go
406
convert.go
@@ -1,406 +0,0 @@
|
|||||||
package scriptorium
|
|
||||||
|
|
||||||
import (
|
|
||||||
"reflect"
|
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/domain"
|
|
||||||
)
|
|
||||||
|
|
||||||
func toDomainRunRequest(req RunRequest) (domain.RunRequest, error) {
|
|
||||||
execution, err := toDomainExecutionTargetOverride(req.Execution)
|
|
||||||
if err != nil {
|
|
||||||
return domain.RunRequest{}, err
|
|
||||||
}
|
|
||||||
return domain.RunRequest{
|
|
||||||
PromptID: req.PromptID,
|
|
||||||
PromptVersion: req.PromptVersion,
|
|
||||||
ProfileID: req.ProfileID,
|
|
||||||
APIKey: req.APIKey,
|
|
||||||
Inputs: toDomainArtifactRefMap(req.Inputs),
|
|
||||||
Vars: copyStringMap(req.Vars),
|
|
||||||
Execution: execution,
|
|
||||||
Validation: toDomainOutputContractPtr(req.Validation),
|
|
||||||
Metadata: copyStringMap(req.Metadata),
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func fromDomainPreparedRun(prepared *domain.PreparedRun) *PreparedRun {
|
|
||||||
if prepared == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
return &PreparedRun{
|
|
||||||
PromptID: prepared.PromptID,
|
|
||||||
PromptVersion: prepared.PromptVersion,
|
|
||||||
PromptHash: prepared.PromptHash,
|
|
||||||
SelectedProfileID: prepared.SelectedProfileID,
|
|
||||||
EffectiveModelParams: fromDomainExecutionTarget(prepared.EffectiveModelParams),
|
|
||||||
OutputContract: fromDomainOutputContract(prepared.OutputContract),
|
|
||||||
StructuredOutput: fromDomainStructuredOutputSpec(prepared.StructuredOutput),
|
|
||||||
InputHashes: copyStringMap(prepared.InputHashes),
|
|
||||||
SessionID: prepared.SessionID,
|
|
||||||
RenderedPromptHash: prepared.RenderedPromptHash,
|
|
||||||
Messages: fromDomainRenderedMessages(prepared.Messages),
|
|
||||||
StartTime: prepared.StartTime,
|
|
||||||
EndTime: prepared.EndTime,
|
|
||||||
DurationMS: prepared.DurationMS,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func fromDomainRunResult(result *domain.RunResult) *RunResult {
|
|
||||||
if result == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
return &RunResult{
|
|
||||||
RunID: result.RunID,
|
|
||||||
Artifact: fromDomainArtifact(result.Artifact),
|
|
||||||
RawOutput: result.RawOutput,
|
|
||||||
Validation: fromDomainValidationResult(result.Validation),
|
|
||||||
PromptID: result.PromptID,
|
|
||||||
PromptVersion: result.PromptVersion,
|
|
||||||
PromptHash: result.PromptHash,
|
|
||||||
RenderedPromptHash: result.RenderedPromptHash,
|
|
||||||
SelectedProfileID: result.SelectedProfileID,
|
|
||||||
ModelName: result.ModelName,
|
|
||||||
Endpoint: result.Endpoint,
|
|
||||||
EffectiveModelParams: fromDomainExecutionTarget(result.EffectiveModelParams),
|
|
||||||
InputHashes: copyStringMap(result.InputHashes),
|
|
||||||
Usage: fromDomainTokenUsage(result.Usage),
|
|
||||||
StartTime: result.StartTime,
|
|
||||||
EndTime: result.EndTime,
|
|
||||||
Duration: result.Duration,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func fromDomainGenerateRequest(req domain.GenerateRequest) GenerateRequest {
|
|
||||||
return GenerateRequest{
|
|
||||||
Prompt: fromDomainRenderedPrompt(req.Prompt),
|
|
||||||
Target: fromDomainExecutionTarget(req.Target),
|
|
||||||
TargetPresence: fromDomainExecutionTargetPresence(req.TargetPresence),
|
|
||||||
StructuredOutput: fromDomainStructuredOutputSpec(req.StructuredOutput),
|
|
||||||
APIKey: req.Target.APIKey,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func toDomainGenerateResponse(resp *GenerateResponse) *domain.GenerateResponse {
|
|
||||||
if resp == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
return &domain.GenerateResponse{
|
|
||||||
Content: resp.Content,
|
|
||||||
Usage: toDomainTokenUsage(resp.Usage),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func fromDomainRenderedPrompt(prompt domain.RenderedPrompt) RenderedPrompt {
|
|
||||||
return RenderedPrompt{
|
|
||||||
SessionID: prompt.SessionID,
|
|
||||||
Messages: fromDomainRenderedMessages(prompt.Messages),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func toDomainArtifactRefMap(src map[string]ArtifactRef) map[string]domain.ArtifactRef {
|
|
||||||
if src == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
out := make(map[string]domain.ArtifactRef, len(src))
|
|
||||||
for k, v := range src {
|
|
||||||
out[k] = toDomainArtifactRef(v)
|
|
||||||
}
|
|
||||||
return out
|
|
||||||
}
|
|
||||||
|
|
||||||
func toDomainArtifactRef(ref ArtifactRef) domain.ArtifactRef {
|
|
||||||
return domain.ArtifactRef{
|
|
||||||
Type: domain.ArtifactRefType(ref.Type),
|
|
||||||
URI: ref.URI,
|
|
||||||
Body: ref.Body,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func fromDomainArtifact(artifact domain.Artifact) Artifact {
|
|
||||||
return Artifact{
|
|
||||||
Name: artifact.Name,
|
|
||||||
ContentType: artifact.ContentType,
|
|
||||||
Body: copyBytes(artifact.Body),
|
|
||||||
URI: artifact.URI,
|
|
||||||
Size: artifact.Size,
|
|
||||||
Hash: artifact.Hash,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func toDomainExecutionTargetOverride(override *ExecutionTargetOverride) (*domain.ExecutionTargetOverride, error) {
|
|
||||||
if override == nil {
|
|
||||||
return nil, nil
|
|
||||||
}
|
|
||||||
extraParams, err := copyPublicJSONMap(override.ExtraParams)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return &domain.ExecutionTargetOverride{
|
|
||||||
Endpoint: override.Endpoint,
|
|
||||||
Model: override.Model,
|
|
||||||
Temperature: copyFloat64Ptr(override.Temperature),
|
|
||||||
MaxTokens: copyIntPtr(override.MaxTokens),
|
|
||||||
TopP: copyFloat64Ptr(override.TopP),
|
|
||||||
TimeoutSeconds: copyIntPtr(override.TimeoutSeconds),
|
|
||||||
ServiceTier: override.ServiceTier,
|
|
||||||
ReasoningEffort: override.ReasoningEffort,
|
|
||||||
APIKeyEnv: override.APIKeyEnv,
|
|
||||||
ExtraParams: extraParams,
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func fromDomainExecutionTarget(target domain.ExecutionTarget) ExecutionTarget {
|
|
||||||
return ExecutionTarget{
|
|
||||||
Endpoint: target.Endpoint,
|
|
||||||
Model: target.Model,
|
|
||||||
Temperature: target.Temperature,
|
|
||||||
MaxTokens: target.MaxTokens,
|
|
||||||
TopP: target.TopP,
|
|
||||||
TimeoutSeconds: target.TimeoutSeconds,
|
|
||||||
ServiceTier: target.ServiceTier,
|
|
||||||
ReasoningEffort: target.ReasoningEffort,
|
|
||||||
APIKeyEnv: target.APIKeyEnv,
|
|
||||||
ExtraParams: copyAnyMap(target.ExtraParams),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func fromDomainExecutionTargetPresence(presence domain.ExecutionTargetPresence) ExecutionTargetPresence {
|
|
||||||
return ExecutionTargetPresence{
|
|
||||||
Temperature: presence.Temperature,
|
|
||||||
MaxTokens: presence.MaxTokens,
|
|
||||||
TopP: presence.TopP,
|
|
||||||
TimeoutSeconds: presence.TimeoutSeconds,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func toDomainOutputContractPtr(contract *OutputContract) *domain.OutputContract {
|
|
||||||
if contract == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
out := toDomainOutputContract(*contract)
|
|
||||||
return &out
|
|
||||||
}
|
|
||||||
|
|
||||||
func toDomainOutputContract(contract OutputContract) domain.OutputContract {
|
|
||||||
return domain.OutputContract{
|
|
||||||
Format: domain.OutputFormat(contract.Format),
|
|
||||||
ValidationMode: domain.ValidationMode(contract.ValidationMode),
|
|
||||||
SchemaPath: contract.SchemaPath,
|
|
||||||
RepairAttempts: contract.RepairAttempts,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func fromDomainOutputContract(contract domain.OutputContract) OutputContract {
|
|
||||||
return OutputContract{
|
|
||||||
Format: OutputFormat(contract.Format),
|
|
||||||
ValidationMode: ValidationMode(contract.ValidationMode),
|
|
||||||
SchemaPath: contract.SchemaPath,
|
|
||||||
RepairAttempts: contract.RepairAttempts,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func fromDomainValidationResult(result domain.ValidationResult) ValidationResult {
|
|
||||||
return ValidationResult{
|
|
||||||
Status: ValidationStatus(result.Status),
|
|
||||||
Mode: ValidationMode(result.Mode),
|
|
||||||
Errors: copyStringSlice(result.Errors),
|
|
||||||
SchemaPath: result.SchemaPath,
|
|
||||||
RepairAttempts: result.RepairAttempts,
|
|
||||||
IsValid: result.IsValid,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func fromDomainTokenUsage(usage domain.TokenUsage) TokenUsage {
|
|
||||||
return TokenUsage{
|
|
||||||
PromptTokens: usage.PromptTokens,
|
|
||||||
CompletionTokens: usage.CompletionTokens,
|
|
||||||
TotalTokens: usage.TotalTokens,
|
|
||||||
CachedTokens: usage.CachedTokens,
|
|
||||||
CacheWriteTokens: usage.CacheWriteTokens,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func toDomainTokenUsage(usage TokenUsage) domain.TokenUsage {
|
|
||||||
return domain.TokenUsage{
|
|
||||||
PromptTokens: usage.PromptTokens,
|
|
||||||
CompletionTokens: usage.CompletionTokens,
|
|
||||||
TotalTokens: usage.TotalTokens,
|
|
||||||
CachedTokens: usage.CachedTokens,
|
|
||||||
CacheWriteTokens: usage.CacheWriteTokens,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func fromDomainRenderedMessages(messages []domain.RenderedMessage) []RenderedMessage {
|
|
||||||
if messages == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
out := make([]RenderedMessage, len(messages))
|
|
||||||
for i, msg := range messages {
|
|
||||||
out[i] = RenderedMessage{
|
|
||||||
Role: msg.Role,
|
|
||||||
Content: msg.Content,
|
|
||||||
CacheControl: fromDomainCacheControl(msg.CacheControl),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return out
|
|
||||||
}
|
|
||||||
|
|
||||||
func fromDomainCacheControl(cacheControl *domain.CacheControl) *CacheControl {
|
|
||||||
if cacheControl == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
return &CacheControl{
|
|
||||||
Type: CacheControlType(cacheControl.Type),
|
|
||||||
TTL: cacheControl.TTL,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func fromDomainStructuredOutputSpec(spec *domain.StructuredOutputSpec) *StructuredOutputSpec {
|
|
||||||
if spec == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
out := &StructuredOutputSpec{
|
|
||||||
Type: StructuredOutputType(spec.Type),
|
|
||||||
}
|
|
||||||
if spec.JSONSchema != nil {
|
|
||||||
out.JSONSchema = &StructuredOutputJSONSpec{
|
|
||||||
Name: spec.JSONSchema.Name,
|
|
||||||
Strict: spec.JSONSchema.Strict,
|
|
||||||
Schema: copyAny(spec.JSONSchema.Schema),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return out
|
|
||||||
}
|
|
||||||
|
|
||||||
func copyStringMap(src map[string]string) map[string]string {
|
|
||||||
if src == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
out := make(map[string]string, len(src))
|
|
||||||
for k, v := range src {
|
|
||||||
out[k] = v
|
|
||||||
}
|
|
||||||
return out
|
|
||||||
}
|
|
||||||
|
|
||||||
func copyAnyMap(src map[string]any) map[string]any {
|
|
||||||
if src == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
out := make(map[string]any, len(src))
|
|
||||||
for k, v := range src {
|
|
||||||
out[k] = copyAny(v)
|
|
||||||
}
|
|
||||||
return out
|
|
||||||
}
|
|
||||||
|
|
||||||
func copyAny(value any) any {
|
|
||||||
if value == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
switch v := value.(type) {
|
|
||||||
case map[string]any:
|
|
||||||
return copyAnyMap(v)
|
|
||||||
case []any:
|
|
||||||
out := make([]any, len(v))
|
|
||||||
for i, item := range v {
|
|
||||||
out[i] = copyAny(item)
|
|
||||||
}
|
|
||||||
return out
|
|
||||||
case []string:
|
|
||||||
return copyStringSlice(v)
|
|
||||||
case []byte:
|
|
||||||
return copyBytes(v)
|
|
||||||
default:
|
|
||||||
return copyReflectValue(reflect.ValueOf(value)).Interface()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func copyReflectValue(value reflect.Value) reflect.Value {
|
|
||||||
if !value.IsValid() {
|
|
||||||
return value
|
|
||||||
}
|
|
||||||
|
|
||||||
switch value.Kind() {
|
|
||||||
case reflect.Interface:
|
|
||||||
if value.IsNil() {
|
|
||||||
return reflect.Zero(value.Type())
|
|
||||||
}
|
|
||||||
copied := copyReflectValue(value.Elem())
|
|
||||||
if copied.IsValid() && copied.Type().AssignableTo(value.Type()) {
|
|
||||||
return copied
|
|
||||||
}
|
|
||||||
out := reflect.New(value.Type()).Elem()
|
|
||||||
out.Set(copied)
|
|
||||||
return out
|
|
||||||
case reflect.Pointer:
|
|
||||||
if value.IsNil() {
|
|
||||||
return reflect.Zero(value.Type())
|
|
||||||
}
|
|
||||||
out := reflect.New(value.Type().Elem())
|
|
||||||
out.Elem().Set(copyReflectValue(value.Elem()))
|
|
||||||
return out
|
|
||||||
case reflect.Map:
|
|
||||||
if value.IsNil() {
|
|
||||||
return reflect.Zero(value.Type())
|
|
||||||
}
|
|
||||||
out := reflect.MakeMapWithSize(value.Type(), value.Len())
|
|
||||||
iter := value.MapRange()
|
|
||||||
for iter.Next() {
|
|
||||||
out.SetMapIndex(copyReflectValue(iter.Key()), copyReflectValue(iter.Value()))
|
|
||||||
}
|
|
||||||
return out
|
|
||||||
case reflect.Slice:
|
|
||||||
if value.IsNil() {
|
|
||||||
return reflect.Zero(value.Type())
|
|
||||||
}
|
|
||||||
out := reflect.MakeSlice(value.Type(), value.Len(), value.Cap())
|
|
||||||
for i := 0; i < value.Len(); i++ {
|
|
||||||
out.Index(i).Set(copyReflectValue(value.Index(i)))
|
|
||||||
}
|
|
||||||
return out
|
|
||||||
case reflect.Array:
|
|
||||||
out := reflect.New(value.Type()).Elem()
|
|
||||||
for i := 0; i < value.Len(); i++ {
|
|
||||||
out.Index(i).Set(copyReflectValue(value.Index(i)))
|
|
||||||
}
|
|
||||||
return out
|
|
||||||
default:
|
|
||||||
return value
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func copyStringSlice(src []string) []string {
|
|
||||||
if src == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
out := make([]string, len(src))
|
|
||||||
copy(out, src)
|
|
||||||
return out
|
|
||||||
}
|
|
||||||
|
|
||||||
func copyBytes(src []byte) []byte {
|
|
||||||
if src == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
out := make([]byte, len(src))
|
|
||||||
copy(out, src)
|
|
||||||
return out
|
|
||||||
}
|
|
||||||
|
|
||||||
func copyFloat64Ptr(src *float64) *float64 {
|
|
||||||
if src == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
v := *src
|
|
||||||
return &v
|
|
||||||
}
|
|
||||||
|
|
||||||
func copyIntPtr(src *int) *int {
|
|
||||||
if src == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
v := *src
|
|
||||||
return &v
|
|
||||||
}
|
|
||||||
48
docs/adr/0001-adopt-canonical-documentation-ownership.md
Normal file
48
docs/adr/0001-adopt-canonical-documentation-ownership.md
Normal file
@@ -0,0 +1,48 @@
|
|||||||
|
# ADR 0001: Adopt Canonical Documentation Ownership
|
||||||
|
|
||||||
|
## Status
|
||||||
|
|
||||||
|
Accepted
|
||||||
|
|
||||||
|
## Date
|
||||||
|
|
||||||
|
2026-07-26
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
Scriptorium's documentation grew alongside its CLI, HTTP, public Go, and
|
||||||
|
integration interfaces. As a result, several documents repeated mutable
|
||||||
|
contracts such as flags, configuration fields, and status behavior. Those
|
||||||
|
parallel definitions made it unclear which document to update when behavior
|
||||||
|
changed and increased the risk of documentation drift.
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
Assign each documentation topic one canonical owner, as defined in
|
||||||
|
[`docs/policy/documentation.md`](../policy/documentation.md). Non-owning
|
||||||
|
documents may provide short orientation and links, but do not redefine volatile
|
||||||
|
contracts. Current behavior is documented outside `docs/roadmap/`; roadmaps own
|
||||||
|
future work, sequencing, and implementation status.
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
- Keep broad reference material in several audience-specific documents. This
|
||||||
|
would preserve local convenience but leave conflicting contract definitions
|
||||||
|
likely.
|
||||||
|
- Consolidate all documentation into one reference. This would reduce duplicate
|
||||||
|
text but would not serve the distinct needs of users, operators, consumers,
|
||||||
|
and contributors.
|
||||||
|
|
||||||
|
## Rationale
|
||||||
|
|
||||||
|
Canonical ownership retains audience-specific guidance while making the source
|
||||||
|
of truth for each contract discoverable. It also makes documentation changes
|
||||||
|
reviewable alongside the implementation change that requires them.
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
- Changes to behavior must update the canonical owner in the same change.
|
||||||
|
- Cross-cutting documentation links to the owner instead of copying its
|
||||||
|
details.
|
||||||
|
- Documentation restructuring followed a dedicated implementation roadmap;
|
||||||
|
repository history, not this ADR, records its completion.
|
||||||
288
docs/adr/0002-split-promptkit-from-scriptorium.md
Normal file
288
docs/adr/0002-split-promptkit-from-scriptorium.md
Normal file
@@ -0,0 +1,288 @@
|
|||||||
|
# ADR 0002: Split Promptkit From Scriptorium
|
||||||
|
|
||||||
|
## Status
|
||||||
|
|
||||||
|
Accepted
|
||||||
|
|
||||||
|
## Date
|
||||||
|
|
||||||
|
2026-07-26
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
Scriptorium currently combines two products in one Go module:
|
||||||
|
|
||||||
|
- a reusable prompt-execution framework with a public Go facade; and
|
||||||
|
- a runnable application with CLI and HTTP interfaces.
|
||||||
|
|
||||||
|
Downstream Go projects increasingly import the framework directly and do not
|
||||||
|
use the executable interfaces. Keeping both products in one module couples
|
||||||
|
framework releases, dependencies, documentation, and public API evolution to
|
||||||
|
application-specific transport concerns.
|
||||||
|
|
||||||
|
Promptkit will become the framework project, and Scriptorium will become a slim
|
||||||
|
application that consumes it. This ADR records that end-state boundary. It does
|
||||||
|
not assert that the split has been implemented; until then, the current
|
||||||
|
repository structure and contracts remain authoritative.
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
### Projects And Module Paths
|
||||||
|
|
||||||
|
Create a repository named `promptkit` alongside Scriptorium:
|
||||||
|
|
||||||
|
| Project | Repository and Go module path | Root Go package |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| Promptkit | `gitea.maximumdirect.net/eric/promptkit` | `promptkit` |
|
||||||
|
| Scriptorium | `gitea.maximumdirect.net/eric/scriptorium` | No reusable root facade after migration |
|
||||||
|
|
||||||
|
Promptkit will expose its supported public API from the module root. Its
|
||||||
|
implementation packages will remain under `internal/` unless a real consumer
|
||||||
|
extension point requires a public type or interface.
|
||||||
|
|
||||||
|
Scriptorium will import only Promptkit's supported public packages. It will not
|
||||||
|
import Promptkit implementation packages or reproduce Promptkit orchestration.
|
||||||
|
|
||||||
|
### Product Responsibilities
|
||||||
|
|
||||||
|
Promptkit owns application-neutral framework behavior:
|
||||||
|
|
||||||
|
- the engine and its `Prepare` and `Run` workflow;
|
||||||
|
- public request, result, profile, option, extension, and error APIs;
|
||||||
|
- prompt-definition loading and rendering;
|
||||||
|
- profile loading, overlays, and the embedded built-in profile registry;
|
||||||
|
- schema loading and output validation;
|
||||||
|
- provider-neutral model-client boundaries and the OpenAI-compatible client;
|
||||||
|
- artifact types, artifact-reader injection, and general-purpose inline and
|
||||||
|
caller-selected file readers;
|
||||||
|
- execution-setting resolution and framework defaults; and
|
||||||
|
- framework-level secret redaction and error classification.
|
||||||
|
|
||||||
|
Scriptorium owns executable and transport behavior:
|
||||||
|
|
||||||
|
- the `scriptorium` process and its `run`, `render`, and `serve` commands;
|
||||||
|
- CLI parsing, streams, output files, formatting, exit codes, and process
|
||||||
|
cancellation behavior;
|
||||||
|
- application-configuration discovery and CLI-over-configuration precedence;
|
||||||
|
- HTTP routing, strict request decoding, DTO mapping, response encoding,
|
||||||
|
status codes, and transport limits;
|
||||||
|
- HTTP artifact-root containment and deployment policy;
|
||||||
|
- server construction, server defaults, and process logging; and
|
||||||
|
- executable release artifacts.
|
||||||
|
|
||||||
|
The dependency direction is:
|
||||||
|
|
||||||
|
```text
|
||||||
|
Scriptorium CLI and HTTP adapters
|
||||||
|
|
|
||||||
|
v
|
||||||
|
Promptkit public API
|
||||||
|
|
|
||||||
|
v
|
||||||
|
injected sources, readers, and model clients
|
||||||
|
```
|
||||||
|
|
||||||
|
### Current Package Disposition
|
||||||
|
|
||||||
|
Implementation may reorganize files during extraction, but each current package
|
||||||
|
has this target owner:
|
||||||
|
|
||||||
|
| Current package or file group | Target owner | Disposition |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| Root `scriptorium` facade files and tests | Promptkit | Move and rename the public package to `promptkit`; Scriptorium retains no compatibility facade. |
|
||||||
|
| `internal/domain`, `internal/usecase` | Promptkit | Move as internal engine implementation. |
|
||||||
|
| `internal/promptdef`, `internal/prompt` | Promptkit | Move as internal prompt loading and rendering. |
|
||||||
|
| `internal/profile`, `internal/profile/builtin` | Promptkit | Move with embedded built-in assets and registry tests. |
|
||||||
|
| `internal/filecatalog` | Promptkit | Move as source-loading support. |
|
||||||
|
| `internal/validate` | Promptkit | Move as schema and output-validation implementation. |
|
||||||
|
| `internal/llm` | Promptkit | Move with the OpenAI-compatible integration. |
|
||||||
|
| `internal/artifact` | Split | Move general inline/file reading to Promptkit; keep rooted, denied, and byte-limited HTTP file reading in Scriptorium behind a Promptkit reader interface. |
|
||||||
|
| `internal/defaults` | Split | Move framework, execution, output-artifact, content-type, and model-client defaults to Promptkit; keep CLI, HTTP, and server defaults in Scriptorium. |
|
||||||
|
| `internal/adapter/cli`, `internal/adapter/http` | Scriptorium | Keep and refactor to use Promptkit's public API. |
|
||||||
|
| `internal/config` | Scriptorium | Keep application settings, discovery, validation, and CLI precedence. |
|
||||||
|
| `internal/format` | Scriptorium | Keep prepared-run presentation, rewritten against Promptkit public values. |
|
||||||
|
| `cmd/scriptorium` | Scriptorium | Keep as the process entrypoint. |
|
||||||
|
|
||||||
|
Tests move with the behavior they protect. Cross-boundary tests will live with
|
||||||
|
the consuming side: Promptkit protects framework contracts, while Scriptorium
|
||||||
|
protects adapter mapping, HTTP containment, and executable behavior.
|
||||||
|
|
||||||
|
### Public Boundary
|
||||||
|
|
||||||
|
Promptkit's initial facade will preserve the useful shape of the current
|
||||||
|
Scriptorium Go API where that reduces extraction risk. It will expose only the
|
||||||
|
capabilities required by Promptkit consumers and by Scriptorium:
|
||||||
|
|
||||||
|
- engine construction, preparation, and execution;
|
||||||
|
- public request, result, profile, and error values;
|
||||||
|
- prompt, profile, schema, artifact-reader, validator, and model-client source
|
||||||
|
or injection options that have demonstrated consumers; and
|
||||||
|
- enough stable error identity for Scriptorium to map CLI and HTTP outcomes.
|
||||||
|
|
||||||
|
Promptkit will not export its domain package, runner implementation,
|
||||||
|
repositories, adapter DTOs, or general internal constructors merely to
|
||||||
|
simplify the move.
|
||||||
|
|
||||||
|
Scriptorium's CLI and HTTP adapters will depend on a small consumer-facing
|
||||||
|
`Prepare`/`Run` interface where test substitution is needed. That interface
|
||||||
|
belongs at the consuming boundary rather than forcing adapter concepts into
|
||||||
|
Promptkit.
|
||||||
|
|
||||||
|
### Artifact Reading And HTTP Containment
|
||||||
|
|
||||||
|
Promptkit will define the artifact-reader extension point used during
|
||||||
|
preparation. Its ordinary file reader may read a path deliberately supplied by
|
||||||
|
an in-process or CLI caller and does not claim to be a deployment sandbox.
|
||||||
|
|
||||||
|
Scriptorium will implement the HTTP-specific reader that:
|
||||||
|
|
||||||
|
- denies file references when no artifact root is configured;
|
||||||
|
- applies the configured artifact byte limit;
|
||||||
|
- enforces Scriptorium's documented lexical root-containment rule; and
|
||||||
|
- maps reader failures to Scriptorium HTTP error responses.
|
||||||
|
|
||||||
|
Scriptorium will inject that reader through Promptkit's public construction
|
||||||
|
boundary. Promptkit will not know about HTTP roots, status codes, request DTOs,
|
||||||
|
or deployment policy.
|
||||||
|
|
||||||
|
### Configuration And Default Ownership
|
||||||
|
|
||||||
|
Configuration ownership follows the behavior configured, not the current file
|
||||||
|
location:
|
||||||
|
|
||||||
|
| Configuration category | Owner |
|
||||||
|
| --- | --- |
|
||||||
|
| Application configuration discovery, configuration-file precedence, `prompt_dir`, `profile_dir`, and `schema_dir` | Scriptorium |
|
||||||
|
| CLI flags and their mapping to application settings or request overrides | Scriptorium |
|
||||||
|
| `server.*`, render-output settings, HTTP byte limits, and server defaults | Scriptorium |
|
||||||
|
| Prompt-definition, profile, and output-contract file formats | Promptkit |
|
||||||
|
| Prompt/profile source selection, overlays, schema behavior, and built-in profiles | Promptkit |
|
||||||
|
| Execution settings, presence-aware request overrides, and execution defaults | Promptkit |
|
||||||
|
| Built-in OpenAI-compatible client settings, timeout behavior, and provider wire mapping | Promptkit |
|
||||||
|
| HTTP request and response fields, including their mapping to framework values | Scriptorium |
|
||||||
|
|
||||||
|
Scriptorium will translate its application settings and external request
|
||||||
|
values into Promptkit construction options and requests. When an omitted
|
||||||
|
Scriptorium setting means “use the framework default,” Scriptorium will omit
|
||||||
|
the override rather than copy Promptkit's numeric default.
|
||||||
|
|
||||||
|
### Compatibility And Versioning
|
||||||
|
|
||||||
|
This migration is intentionally breaking:
|
||||||
|
|
||||||
|
- new Go consumers will import `gitea.maximumdirect.net/eric/promptkit`;
|
||||||
|
- Scriptorium will not provide aliases, forwarding wrappers, or deprecated
|
||||||
|
compatibility packages for its former Go facade;
|
||||||
|
- existing consumers may remain pinned to the final framework-bearing
|
||||||
|
Scriptorium tag until migrated; and
|
||||||
|
- intermediate migration phases need not preserve source compatibility, but
|
||||||
|
each merged phase must be internally buildable and tested.
|
||||||
|
|
||||||
|
Promptkit's first release will be `v0.1.0`. During the migration, incompatible
|
||||||
|
Promptkit changes may advance its minor version until a stable `v1` contract is
|
||||||
|
declared. The first slim Scriptorium release will advance the Scriptorium minor
|
||||||
|
version beyond the final framework-bearing release. Normal semantic-versioning
|
||||||
|
rules apply independently to both projects after the migration.
|
||||||
|
|
||||||
|
Promptkit must be tagged before Scriptorium or another consumer publishes a
|
||||||
|
release that depends on it. Release branches must use tagged module
|
||||||
|
dependencies, not local replacements or unpublished revisions.
|
||||||
|
|
||||||
|
### Local Development And Cross-Repository Coordination
|
||||||
|
|
||||||
|
For coordinated local work, place both repositories in a temporary Go
|
||||||
|
workspace or use an uncommitted module replacement. `go.work`,
|
||||||
|
`go.work.sum`, and local filesystem `replace` directives must not be committed
|
||||||
|
to release branches.
|
||||||
|
|
||||||
|
Cross-repository changes follow this order:
|
||||||
|
|
||||||
|
1. land and tag the required Promptkit capability;
|
||||||
|
2. update Scriptorium and other consumers to that tag;
|
||||||
|
3. run each repository's own CI and smoke checks; and
|
||||||
|
4. release consumers only after the Promptkit tag is available.
|
||||||
|
|
||||||
|
Migration coordination must confirm out-of-band repository creation, Promptkit
|
||||||
|
tags, and downstream migrations before dependent work proceeds.
|
||||||
|
Cross-repository changes are coordinated, not treated as atomic commits.
|
||||||
|
|
||||||
|
### Documentation And Maintained Assets
|
||||||
|
|
||||||
|
Each repository will maintain its own README, contributor guide, architecture,
|
||||||
|
documentation, testing, release, and operations material appropriate to that
|
||||||
|
project. Cross-project documents will link to the canonical owner rather than
|
||||||
|
copy its contract.
|
||||||
|
|
||||||
|
Existing documentation and maintained assets have these target owners:
|
||||||
|
|
||||||
|
| Current material | Target owner |
|
||||||
|
| --- | --- |
|
||||||
|
| Current README and executable quickstart | Scriptorium; Promptkit creates its own framework orientation |
|
||||||
|
| Public Go package and Go-consumer guidance | Promptkit |
|
||||||
|
| Prompt, profile, schema, execution-setting, and framework credential reference | Promptkit |
|
||||||
|
| OpenAI-compatible integration contract and framework internal documents | Promptkit |
|
||||||
|
| CLI, HTTP API, subprocess, and Scriptorium operations contracts | Scriptorium |
|
||||||
|
| Consumer interface overview | Scriptorium, revised to route Go consumers to Promptkit |
|
||||||
|
| Application-configuration discovery, server settings, and adapter internals | Scriptorium |
|
||||||
|
| Current internal overview and source documentation | Split into repository-local overviews; Promptkit owns framework sources and Scriptorium owns HTTP containment |
|
||||||
|
| This ADR and cross-project migration records | Scriptorium |
|
||||||
|
| `examples/go-library` | Promptkit |
|
||||||
|
| `examples/config*.yml`, `examples/render-markdown-summary.sh`, and `examples/http-run.json` | Scriptorium |
|
||||||
|
| Example prompts, profiles, schemas, and synthetic fixtures used by the executable examples | Scriptorium |
|
||||||
|
| Embedded built-in profile assets | Promptkit |
|
||||||
|
| Scriptorium release workflow and executable packaging | Scriptorium |
|
||||||
|
| Repository-level license, ignore rules, agent guidance, and development policies | Each repository maintains its own applicable copy |
|
||||||
|
|
||||||
|
Promptkit will create or retain its own minimal framework examples and test
|
||||||
|
fixtures rather than making either repository's tests depend on the other's
|
||||||
|
working tree. Scriptorium's framework-format documentation will become a short
|
||||||
|
version-appropriate link to Promptkit, while its maintained executable examples
|
||||||
|
remain self-contained.
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
- Keep the current combined repository and improve package naming. This avoids
|
||||||
|
migration work but retains release and ownership coupling between the
|
||||||
|
framework and executable.
|
||||||
|
- Add Promptkit as a wrapper around the Scriptorium public package. This gives
|
||||||
|
consumers a new import path but leaves framework ownership and dependency
|
||||||
|
direction inverted.
|
||||||
|
- Extract Promptkit while retaining a Scriptorium compatibility facade. This
|
||||||
|
reduces immediate consumer changes but creates a second public API surface
|
||||||
|
and prolongs duplicate maintenance.
|
||||||
|
- Move all artifact reading into Promptkit. This would place HTTP containment,
|
||||||
|
byte limits, and deployment policy in the application-neutral framework.
|
||||||
|
- Keep Promptkit and Scriptorium as separate modules in one repository. This
|
||||||
|
separates imports but not repository permissions, release workflows,
|
||||||
|
issue ownership, or independent project evolution.
|
||||||
|
|
||||||
|
## Rationale
|
||||||
|
|
||||||
|
A separate Promptkit project makes the reusable framework the direct owner of
|
||||||
|
the API that downstream Go projects already consume. Keeping Scriptorium as a
|
||||||
|
public-API consumer exercises the same boundary as other consumers and prevents
|
||||||
|
its adapters from relying on framework internals.
|
||||||
|
|
||||||
|
The selected split keeps transport and deployment policy close to the
|
||||||
|
Scriptorium interfaces that expose it, while allowing Promptkit to remain
|
||||||
|
useful to in-process consumers with different IO and security requirements.
|
||||||
|
Explicit package, configuration, documentation, and asset ownership reduces
|
||||||
|
ambiguity during extraction and after release.
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
- All Go consumers of the framework must change their import path.
|
||||||
|
- Promptkit and Scriptorium gain independent issue, release, CI, policy, and
|
||||||
|
documentation lifecycles.
|
||||||
|
- Scriptorium becomes a real downstream integration test of Promptkit's public
|
||||||
|
facade.
|
||||||
|
- Framework changes that affect Scriptorium require tagged, ordered
|
||||||
|
cross-repository coordination.
|
||||||
|
- Some current packages, especially artifact reading and defaults, must be
|
||||||
|
separated by responsibility rather than moved intact.
|
||||||
|
- Scriptorium's current configuration and documentation references must be
|
||||||
|
split between application and framework owners.
|
||||||
|
- Maintainers must inventory and migrate downstream consumers explicitly; no
|
||||||
|
compatibility facade will hide incomplete migration.
|
||||||
|
- Until the split is implemented, the current repository structure and
|
||||||
|
contracts remain authoritative.
|
||||||
@@ -0,0 +1,67 @@
|
|||||||
|
# ADR 0003: Use Maintainer-Run Validation and Tag-Only Releases for Promptkit
|
||||||
|
|
||||||
|
## Status
|
||||||
|
|
||||||
|
Accepted
|
||||||
|
|
||||||
|
## Date
|
||||||
|
|
||||||
|
2026-07-28
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
[ADR 0002](0002-split-promptkit-from-scriptorium.md) established Promptkit as
|
||||||
|
an independent Go library with its own repository, version history, validation,
|
||||||
|
and release coordination. It anticipated independent hosted CI for Promptkit
|
||||||
|
alongside Scriptorium's existing executable build and CI policy.
|
||||||
|
|
||||||
|
Promptkit is presently a single-maintainer library. It does not produce a
|
||||||
|
runnable command, so executable packaging and binary-release automation do not
|
||||||
|
apply. Its validation and release model should be explicit before repository
|
||||||
|
guidance relies on it.
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
Promptkit will use maintainer-run validation rather than hosted CI at this
|
||||||
|
stage. From a clean checkout, the maintainer will run the repository-documented
|
||||||
|
test, vet, build, formatting, documentation-link, and repository-hygiene checks
|
||||||
|
before changes are accepted and before a release tag is published.
|
||||||
|
|
||||||
|
Promptkit releases consist of source commits and semantic Go module tags. The
|
||||||
|
project does not release runnable binaries or maintain binary-packaging
|
||||||
|
automation.
|
||||||
|
|
||||||
|
Scriptorium's executable build, hosted CI, and binary-release policies are
|
||||||
|
unaffected. The repository boundary, independent version history, release
|
||||||
|
ordering, and other migration decisions accepted by ADR 0002 remain in force.
|
||||||
|
Where ADR 0002 anticipated independent hosted CI for Promptkit, this later ADR
|
||||||
|
controls Promptkit validation.
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
- Add hosted Promptkit CI now. This would provide automated remote enforcement,
|
||||||
|
but its setup and maintenance are not proportionate to the present
|
||||||
|
single-maintainer library and do not replace the maintainer's release
|
||||||
|
responsibility.
|
||||||
|
- Require local Git hooks. Hooks can provide fast feedback, but they are
|
||||||
|
machine-local, can be bypassed, and are not a durable substitute for the
|
||||||
|
documented clean-checkout validation procedure.
|
||||||
|
|
||||||
|
## Rationale
|
||||||
|
|
||||||
|
A documented maintainer-run procedure provides a clear acceptance and release
|
||||||
|
gate with little operational overhead for the project's current contribution
|
||||||
|
pattern. If maintenance load or contributor patterns change, a later ADR may
|
||||||
|
introduce hosted CI without changing Promptkit's library or tag-based release
|
||||||
|
model.
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
- Promptkit repository guidance must define the complete local validation
|
||||||
|
procedure and the checks required before accepting or tagging a change.
|
||||||
|
- Release evidence is the maintainer's successful clean-checkout validation,
|
||||||
|
not a hosted CI result.
|
||||||
|
- Promptkit releases contain source and semantic Go module tags only.
|
||||||
|
- A future move to hosted CI requires a later architectural decision.
|
||||||
|
- Scriptorium continues to validate, build, package, and release its executable
|
||||||
|
under its own policies.
|
||||||
112
docs/adr/0004-definition-boundary.md
Normal file
112
docs/adr/0004-definition-boundary.md
Normal file
@@ -0,0 +1,112 @@
|
|||||||
|
# Preserve Definition Compatibility And A Simple Execution Model
|
||||||
|
|
||||||
|
## Status
|
||||||
|
|
||||||
|
Accepted.
|
||||||
|
|
||||||
|
## Date
|
||||||
|
|
||||||
|
2026-08-29.
|
||||||
|
|
||||||
|
## Context
|
||||||
|
|
||||||
|
Scriptorium is a user-facing application built on Promptkit. Promptkit is a Go
|
||||||
|
library with both declarative framework formats and public APIs intended for
|
||||||
|
applications that need to assemble specialized integrations or workflows.
|
||||||
|
|
||||||
|
Scriptorium needs a durable rule for deciding which upstream capabilities it
|
||||||
|
must support. Treating every new Promptkit public API as an application feature
|
||||||
|
would steadily expand Scriptorium into a workflow framework. Selecting an
|
||||||
|
arbitrary subset of prompt or profile fields would instead make valid Promptkit
|
||||||
|
definitions unexpectedly unusable through Scriptorium.
|
||||||
|
|
||||||
|
The intended product is narrower: Scriptorium provides simple executable
|
||||||
|
interfaces that select and execute predefined prompts and return their results
|
||||||
|
in a consistent, repeatable form. It is not intended to own conversations,
|
||||||
|
modify prompts dynamically, coordinate follow-up messages, or manage complex
|
||||||
|
multi-step workflows.
|
||||||
|
|
||||||
|
## Decision
|
||||||
|
|
||||||
|
Scriptorium will aim to support the complete set of features expressible in
|
||||||
|
valid Promptkit prompt and profile definitions for the Promptkit version it
|
||||||
|
selects. This includes the schema, backend, source, and request plumbing needed
|
||||||
|
to prepare and execute those definitions without Scriptorium imposing a
|
||||||
|
narrower field-level format contract.
|
||||||
|
|
||||||
|
Promptkit remains the canonical parser and validator for its definitions.
|
||||||
|
Scriptorium will pass its configured framework sources and mapped request
|
||||||
|
values through the supported Promptkit public facade rather than copying
|
||||||
|
Promptkit formats, defaults, or validation rules.
|
||||||
|
|
||||||
|
Promptkit library features that are not required to use valid prompt or profile
|
||||||
|
definitions are considered individually. They may be incorporated when they
|
||||||
|
serve Scriptorium's simple execution model and fit its application-owned CLI,
|
||||||
|
HTTP, configuration, presentation, security, and process boundaries. A public
|
||||||
|
Promptkit declaration does not by itself require a corresponding Scriptorium
|
||||||
|
interface.
|
||||||
|
|
||||||
|
Each execution request will remain self-contained from the caller's
|
||||||
|
perspective. A request must not depend on conversation or workflow state
|
||||||
|
retained from a completed request, and Scriptorium will not become a general
|
||||||
|
workflow or conversation system. Application-managed prompt modification,
|
||||||
|
appended or follow-up message flows, conversation state, prepared-handle
|
||||||
|
coordination, multi-step orchestration, and similar higher-level workflows are
|
||||||
|
outside its intended scope.
|
||||||
|
|
||||||
|
Scriptorium may, and when necessary must, maintain process-scoped operational
|
||||||
|
state shared by concurrent requests. This includes the configured Promptkit
|
||||||
|
engine and backend registry, capacity admission and queue accounting,
|
||||||
|
in-flight request coordination, cancellation, and ordinary server lifecycle
|
||||||
|
resources. The state must be scoped so configured backend limits apply across
|
||||||
|
all relevant in-flight requests. But this is operational implementation state,
|
||||||
|
not durable user workflow or conversation state.
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
### Expose Every Promptkit Public Feature
|
||||||
|
|
||||||
|
This would make the application surface track the library API closely, but it
|
||||||
|
would blur the boundary between a reusable Go library and a simple executable
|
||||||
|
consumer. Library-oriented lifecycle, source-construction, extension, and
|
||||||
|
workflow primitives would add commands, wire contracts, configuration, and
|
||||||
|
state without necessarily improving predefined prompt execution.
|
||||||
|
|
||||||
|
### Support A Curated Subset Of Definition Fields
|
||||||
|
|
||||||
|
This would keep the application small in the short term, but valid Promptkit
|
||||||
|
definitions could fail or behave differently solely because they were invoked
|
||||||
|
through Scriptorium. Maintaining a parallel field-level compatibility list
|
||||||
|
would also duplicate upstream format ownership and create recurring drift.
|
||||||
|
|
||||||
|
### Expand Scriptorium Into A Workflow Service
|
||||||
|
|
||||||
|
Scriptorium could own conversations, prompt changes, follow-up messages,
|
||||||
|
retries, checkpoints, and multi-step execution. That is a different product
|
||||||
|
with durable state, lifecycle, recovery, privacy, and operational requirements
|
||||||
|
that are not justified by Scriptorium's current purpose.
|
||||||
|
|
||||||
|
## Consequences
|
||||||
|
|
||||||
|
- Promptkit upgrades require an audit of the complete prompt and profile format
|
||||||
|
contracts, not only a source-compatibility build.
|
||||||
|
- Scriptorium adapters must not add unconditional request requirements that
|
||||||
|
reject a definition Promptkit can validly prepare or execute.
|
||||||
|
- Application configuration may need new plumbing, such as custom backend
|
||||||
|
registration, when it is necessary to use a valid profile feature.
|
||||||
|
- Definition parsing, validation, precedence, inheritance, defaults, and
|
||||||
|
built-in catalogs remain Promptkit responsibilities.
|
||||||
|
- A running HTTP server must share its appropriately scoped Promptkit engine
|
||||||
|
across requests so the engine's backend admission and concurrency limits
|
||||||
|
cannot be bypassed by per-request construction.
|
||||||
|
- Process-scoped counters, queues, in-flight request records, cancellation, and
|
||||||
|
lifecycle resources are permitted implementation state. They must be
|
||||||
|
concurrency-safe and do not create a durable resume or conversation
|
||||||
|
contract.
|
||||||
|
- Library-only source constructors, injected collaborators, opaque lifecycle
|
||||||
|
handles, and request-composition primitives remain optional Scriptorium
|
||||||
|
features rather than automatic requirements.
|
||||||
|
- New application features must be evaluated against the simple,
|
||||||
|
request-independent predefined-prompt execution model.
|
||||||
|
- Work that implements this decision remains tracked in roadmaps until it is
|
||||||
|
delivered and incorporated into current-state contracts.
|
||||||
406
docs/api.md
406
docs/api.md
@@ -2,296 +2,226 @@
|
|||||||
|
|
||||||
This is the canonical public HTTP contract for Scriptorium.
|
This is the canonical public HTTP contract for Scriptorium.
|
||||||
|
|
||||||
Implemented route:
|
## Service And Route
|
||||||
|
|
||||||
- `POST /v1/runs`
|
`POST /v1/runs` runs one prompt request and returns generated output,
|
||||||
|
validation, and metadata. The service has no built-in authentication or
|
||||||
|
authorization; deploy it behind appropriate network and authentication controls.
|
||||||
|
|
||||||
For CLI behavior, see [CLI reference](cli.md). For config and prompt/profile
|
The service address and HTTP limits are configured as described in the
|
||||||
file formats, see [Configuration reference](config.md).
|
[configuration reference](config.md). `serve` invocation is defined in the
|
||||||
|
[CLI reference](cli.md).
|
||||||
|
|
||||||
The maintained request-shape example is `examples/http-run.json`. It requires a
|
Requests and responses are JSON objects. Requests are decoded as JSON regardless
|
||||||
running `serve` process with an artifact root that can read the referenced
|
of their `Content-Type`; successful JSON responses use
|
||||||
files, plus a reachable model endpoint for full execution.
|
`Content-Type: application/json`. There are no query parameters.
|
||||||
|
|
||||||
## Base URL And Deployment
|
|
||||||
|
|
||||||
`scriptorium serve` listens on `server.addr` or `serve --addr`. The default is
|
|
||||||
`:8080`.
|
|
||||||
|
|
||||||
The route path is always:
|
|
||||||
|
|
||||||
```text
|
|
||||||
/v1/runs
|
|
||||||
```
|
|
||||||
|
|
||||||
The HTTP adapter has no built-in authentication or authorization. Deploy it
|
|
||||||
behind trusted network and authentication controls.
|
|
||||||
|
|
||||||
## Media Types
|
|
||||||
|
|
||||||
- Request body: JSON object.
|
|
||||||
- Response body: JSON object.
|
|
||||||
- Response `Content-Type`: `application/json`.
|
|
||||||
|
|
||||||
Requests are decoded as JSON regardless of the request `Content-Type` header.
|
|
||||||
There are no shared query parameters.
|
|
||||||
|
|
||||||
## Request Limits
|
## Request Limits
|
||||||
|
|
||||||
HTTP limits are configured through `server.*` config fields or `serve` flags:
|
The configured request-body limit includes inline artifact bodies. The artifact
|
||||||
|
limit applies to HTTP `file` inputs. The response limit applies to the encoded
|
||||||
|
response, including the artifact body, optional raw output, and optional execution report. A limit of zero
|
||||||
|
disables that limit.
|
||||||
|
|
||||||
- `server.max_request_bytes`: encoded JSON request body limit, including inline input bodies.
|
A request body over its limit returns `413 request_too_large`; an oversized
|
||||||
- `server.max_artifact_bytes`: file artifact limit for HTTP `file` input references.
|
file input returns `413 artifact_too_large`; an oversized encoded response
|
||||||
- `server.max_response_bytes`: encoded JSON response limit, including artifact body and optional raw output.
|
returns `413 response_too_large`.
|
||||||
|
|
||||||
Each limit defaults to `16777216` bytes. `0` disables that limit.
|
|
||||||
|
|
||||||
## `POST /v1/runs`
|
## `POST /v1/runs`
|
||||||
|
|
||||||
Runs one prompt request and returns the generated artifact, validation result,
|
|
||||||
and metadata.
|
|
||||||
|
|
||||||
### Request Body
|
### Request Body
|
||||||
|
|
||||||
|
The maintained [request example](../examples/http-run.json) is a complete
|
||||||
|
copyable shape. At the HTTP adapter boundary, the smallest valid shape is:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"prompt_id": "generic.markdown_summary",
|
"prompt_id": "generic.markdown_summary"
|
||||||
"profile_id": "local-fast",
|
|
||||||
"prompt_version": "1.0.0",
|
|
||||||
"inputs": {
|
|
||||||
"transcript": {
|
|
||||||
"type": "file",
|
|
||||||
"uri": "./examples/fixtures/transcript.md"
|
|
||||||
},
|
|
||||||
"glossary": {
|
|
||||||
"type": "inline",
|
|
||||||
"body": "party:\n - Rin"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"vars": {
|
|
||||||
"session_date": "2026-05-04"
|
|
||||||
},
|
|
||||||
"model": {
|
|
||||||
"endpoint": "http://localhost:8000/v1",
|
|
||||||
"model": "gpt-4o-mini",
|
|
||||||
"temperature": 0,
|
|
||||||
"max_tokens": 800,
|
|
||||||
"top_p": 1,
|
|
||||||
"timeout_seconds": 120,
|
|
||||||
"service_tier": "priority",
|
|
||||||
"reasoning_effort": "medium",
|
|
||||||
"api_key_env": "SCRIPTORIUM_API_KEY",
|
|
||||||
"extra_params": {
|
|
||||||
"provider_option": "enabled"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"include_raw_output": false
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Request fields:
|
| Field | Required | Meaning |
|
||||||
|
|
||||||
| Field | Required | Description |
|
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `prompt_id` | yes | Prompt ID. Must not be blank. |
|
| `prompt_id` | yes | Non-blank prompt ID. |
|
||||||
| `prompt_version` | no | Prompt version filter. |
|
| `prompt_version` | no | Prompt version filter. |
|
||||||
| `profile_id` | no | Execution profile ID. If omitted, the prompt must define `default_profile`. |
|
| `profile_id` | no | Execution-profile ID; otherwise the prompt must set `default_profile`. |
|
||||||
| `inputs` | yes | Object mapping prompt input names to input references. Must contain at least one entry. |
|
| `session_id` | no | Optional direct, non-secret session identifier. |
|
||||||
| `vars` | no | Object mapping template variable names to string values. |
|
| `inputs` | no | Optional object mapping input names to references. Promptkit decides whether the selected definition needs them. |
|
||||||
| `model` | no | Runtime model override object. |
|
| `vars` | no | Object mapping template-variable names to strings. |
|
||||||
| `include_raw_output` | no | When `true`, include `raw_model_output` in the response. |
|
| `model` | no | Runtime model-override object. |
|
||||||
|
| `include_raw_output` | no | Include `raw_model_output` when true. |
|
||||||
|
| `include_execution_report` | no | Include a terminal `execution` report when true and Promptkit supplies a terminal observation. Omitted, `null`, or false leaves reporting off. |
|
||||||
|
| `transient_retries` | no | Nonnegative additional transient attempt count for this run. Omitted or `null` inherits the configured engine value and then Promptkit's default; `0` disables additional attempts. |
|
||||||
|
| `run_timeout_seconds` | no | Optional signed 64-bit whole-second limit for engine execution. Omitted, `null`, or `0` adds no deadline; positive values shorten the caller context deadline. |
|
||||||
|
|
||||||
Input reference fields:
|
An input reference has a required `type` of `file` or `inline`. A `file`
|
||||||
|
reference requires `uri`; an `inline` reference requires `body`.
|
||||||
|
|
||||||
| Field | Required | Description |
|
HTTP file references require a configured artifact root. Relative paths resolve
|
||||||
| --- | --- | --- |
|
within that root. Absolute paths must be lexically within it; traversal outside
|
||||||
| `type` | yes | `file` or `inline`. |
|
it is rejected with `400 artifact_not_allowed`. This lexical check does not
|
||||||
| `uri` | for `file` | File URI/path. |
|
resolve symlinks: the operating system follows symlinks inside the root,
|
||||||
| `body` | for `inline` | Inline artifact body. |
|
including ones that target outside it. Keep the root narrow and inaccessible to
|
||||||
|
untrusted writers.
|
||||||
|
|
||||||
HTTP `file` references require `server.artifact_root` or `serve
|
The optional `model` object accepts `endpoint`, `model`, `temperature`,
|
||||||
--artifact-root`. Relative file URIs resolve against that root. Absolute file
|
`max_tokens`, `top_p`, `timeout_seconds`, `service_tier`,
|
||||||
URIs are accepted only when lexically inside the root. Relative traversal and
|
`reasoning_effort`, `api_key_env`, and `extra_params`. Numeric ranges and
|
||||||
absolute paths outside the root return `400 artifact_not_allowed`.
|
framework credential semantics are defined by the
|
||||||
|
[Promptkit format reference](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/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 outbound integration contract](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/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.
|
||||||
|
|
||||||
The containment check is lexical and does not resolve symlinks. Symlinks inside
|
Raw API-key values are not accepted. `api_key` and any other unknown model
|
||||||
the artifact root are followed by the operating system, including symlinks that
|
field cause `400 invalid_json`.
|
||||||
point outside the root. Keep the artifact root narrow and not writable by
|
|
||||||
untrusted users.
|
|
||||||
|
|
||||||
Model override fields:
|
`model.reasoning_effort` is an optional JSON string with three states: omission
|
||||||
|
inherits the selected profile, a non-empty string replaces its value, and an
|
||||||
|
empty string explicitly clears it. JSON `null` is treated as omission.
|
||||||
|
|
||||||
| Field | Description |
|
`session_id` is passed directly to Promptkit. A nonblank value replaces a
|
||||||
| --- | --- |
|
definition-rendered session ID; omission or a blank value lets the definition
|
||||||
| `endpoint` | Runtime endpoint override. |
|
provide one. Promptkit trims direct values and limits them to 256 Unicode code
|
||||||
| `model` | Runtime model override. |
|
points. Session IDs are not credentials and may be included in prepared data,
|
||||||
| `temperature` | Number in range `0..2`. Explicit `0` is an override. |
|
results, and provider-facing requests, so use stable non-sensitive identifiers.
|
||||||
| `max_tokens` | Integer greater than or equal to `0`. Explicit `0` is an override. |
|
|
||||||
| `top_p` | Number in range `0..1`. Explicit `0` is an override. |
|
|
||||||
| `timeout_seconds` | Integer greater than or equal to `0`. Explicit `0` disables the outbound client timeout. |
|
|
||||||
| `service_tier` | Provider-specific request tier. |
|
|
||||||
| `reasoning_effort` | Provider-specific reasoning setting. |
|
|
||||||
| `api_key_env` | Name of an environment variable containing the API key. |
|
|
||||||
| `extra_params` | JSON-compatible provider-specific top-level request fields. |
|
|
||||||
|
|
||||||
Raw API-key values are not accepted in HTTP payloads. A field such as
|
### Strict JSON
|
||||||
`api_key` is rejected as unknown JSON.
|
|
||||||
|
|
||||||
`extra_params` keys must not be empty and must not collide with reserved
|
Request decoding rejects malformed JSON, unknown fields at every request level,
|
||||||
outbound fields: `model`, `session_id`, `messages`, `temperature`,
|
and trailing JSON tokens with `400 invalid_json`. A blank `prompt_id` returns
|
||||||
`max_tokens`, `top_p`, `service_tier`, `reasoning_effort`, or
|
`400 invalid_request`. Omitted or empty `inputs` are passed to Promptkit, which
|
||||||
`response_format`.
|
reports any definition-required or template-referenced inputs.
|
||||||
|
`transient_retries` must be a JSON integer; a wrong type or noninteger number
|
||||||
### Strict JSON Rules
|
returns `400 invalid_json`, while a negative integer returns
|
||||||
|
`400 invalid_request` before execution. A request override does not change the
|
||||||
Request decoding is strict:
|
shared engine setting used by other requests. Promptkit owns eligible statuses,
|
||||||
|
retry waits, and the separate transient budget for each repair generation.
|
||||||
- malformed JSON returns `400 invalid_json`
|
`run_timeout_seconds` must be a JSON int64. A wrong type or int64 overflow
|
||||||
- unknown request fields return `400 invalid_json`
|
returns `400 invalid_json`; a negative value or one whose conversion to a Go
|
||||||
- unknown `inputs` item fields return `400 invalid_json`
|
duration would overflow returns `400 invalid_request`. The deadline starts
|
||||||
- unknown `model` fields return `400 invalid_json`
|
immediately before engine execution and excludes body decoding and response
|
||||||
- trailing JSON tokens after the request object return `400 invalid_json`
|
writing. An earlier caller deadline or cancellation still wins. Synchronous
|
||||||
- request bodies above the configured limit return `413 request_too_large`
|
work is not guaranteed to stop immediately.
|
||||||
|
|
||||||
### Success Response
|
### Success Response
|
||||||
|
|
||||||
Status: `200 OK`
|
A completed run returns `200 OK`, including when generated content fails its
|
||||||
|
validation contract. The response contains:
|
||||||
|
|
||||||
```json
|
- `artifact`: `name`, `content_type`, `body`, `size`, `hash`, and
|
||||||
{
|
optional `uri`;
|
||||||
"artifact": {
|
- `validation`: `status`, `mode`, `repair_attempts`, `is_valid`, plus
|
||||||
"name": "output",
|
optional `errors` and `schema_path`;
|
||||||
"content_type": "text/markdown",
|
- `metadata`: run, prompt, rendered-prompt, profile, optional backend identity, model, input-hash, usage,
|
||||||
"body": "Generated content",
|
timing, validation, and repair-attempt metadata; and
|
||||||
"size": 17,
|
- optional `raw_model_output` when requested.
|
||||||
"hash": "..."
|
- optional `execution` when requested and a terminal observation exists.
|
||||||
},
|
|
||||||
"validation": {
|
|
||||||
"status": "passed",
|
|
||||||
"mode": "basic",
|
|
||||||
"repair_attempts": 0,
|
|
||||||
"is_valid": true
|
|
||||||
},
|
|
||||||
"metadata": {
|
|
||||||
"run_id": "...",
|
|
||||||
"prompt_id": "generic.markdown_summary",
|
|
||||||
"prompt_version": "1.0.0",
|
|
||||||
"prompt_hash": "...",
|
|
||||||
"rendered_prompt_hash": "...",
|
|
||||||
"selected_profile_id": "local-fast",
|
|
||||||
"model_name": "gpt-4o-mini",
|
|
||||||
"endpoint": "http://localhost:8000/v1",
|
|
||||||
"model_params": {
|
|
||||||
"endpoint": "http://localhost:8000/v1",
|
|
||||||
"model": "gpt-4o-mini",
|
|
||||||
"temperature": 0.2,
|
|
||||||
"max_tokens": 500,
|
|
||||||
"top_p": 1,
|
|
||||||
"timeout_seconds": 90
|
|
||||||
},
|
|
||||||
"input_hashes": {
|
|
||||||
"transcript": "..."
|
|
||||||
},
|
|
||||||
"usage": {
|
|
||||||
"prompt_tokens": 11,
|
|
||||||
"completion_tokens": 22,
|
|
||||||
"total_tokens": 33,
|
|
||||||
"cached_tokens": 0,
|
|
||||||
"cache_write_tokens": 0
|
|
||||||
},
|
|
||||||
"start_time": "2026-05-04T12:00:00Z",
|
|
||||||
"end_time": "2026-05-04T12:00:01Z",
|
|
||||||
"duration_ms": 1000,
|
|
||||||
"validation_mode": "basic",
|
|
||||||
"validation_status": "passed",
|
|
||||||
"repair_attempts_used": 0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Response fields:
|
`metadata.model_params` has `endpoint`, `model`, `temperature`,
|
||||||
|
`max_tokens`, `top_p`, and `timeout_seconds`, plus optional
|
||||||
|
`backend_id`, `service_tier`, `reasoning_effort`, `api_key_env`, and `extra_params`.
|
||||||
|
`metadata.usage` always includes `prompt_tokens`, `completion_tokens`,
|
||||||
|
`total_tokens`, `cached_tokens`, and `cache_write_tokens`; unavailable
|
||||||
|
cache usage is reported as zero.
|
||||||
|
|
||||||
- `artifact`: generated output artifact.
|
When Promptkit resolves a direct or definition-rendered session ID,
|
||||||
- `validation`: validation result for the generated artifact.
|
`metadata.session_id` contains that effective result value. It is omitted when
|
||||||
- `metadata`: run and effective runtime metadata.
|
no effective session ID exists.
|
||||||
- `raw_model_output`: omitted unless `include_raw_output` is `true`.
|
|
||||||
|
|
||||||
`artifact.uri` is omitted when empty. `validation.errors` and
|
`metadata.selected_backend_id` and `metadata.model_params.backend_id` report
|
||||||
`validation.schema_path` are omitted when empty. `model_params.service_tier`,
|
the corresponding Promptkit result fields independently when present. Both are
|
||||||
`model_params.reasoning_effort`, `model_params.api_key_env`, and
|
omitted for an endpoint-only profile; Scriptorium does not infer backend
|
||||||
`model_params.extra_params` are omitted when empty.
|
identity from an endpoint.
|
||||||
|
|
||||||
`metadata.usage.cached_tokens` and `metadata.usage.cache_write_tokens` are
|
A validation failure has `validation.status: "failed"`, `is_valid: false`,
|
||||||
always present as numbers. They are `0` when the provider omits compatible cache
|
and any available diagnostic errors, while still returning the artifact and
|
||||||
usage fields or reports no cache activity.
|
metadata.
|
||||||
|
|
||||||
### Validation Failure Response
|
### Execution Report
|
||||||
|
|
||||||
Generated-content validation failures still return `200 OK`.
|
The opt-in `execution` object projects one Promptkit terminal observation. It
|
||||||
|
is independent of `metadata.usage`, which retains its existing result-based
|
||||||
|
meaning. A terminal event can describe a failed invocation even when no provider
|
||||||
|
call was dispatched; if there is no terminal event, `execution` is omitted.
|
||||||
|
|
||||||
```json
|
| Field | Meaning |
|
||||||
{
|
| --- | --- |
|
||||||
"validation": {
|
| `run_id`, `prompt_id`, `prompt_version`, `profile_id`, `backend_id`, `model` | Terminal identifiers; absent values are omitted. |
|
||||||
"status": "failed",
|
| `outcome` | `success`, `invalid_output`, `error`, or `other` for an unrecognized upstream value. |
|
||||||
"mode": "json",
|
| `failure` | The known terminal failure category, `none`, or `other` for an unrecognized value. |
|
||||||
"errors": ["invalid JSON: ..."],
|
| `status_code` | Provider status, omitted when unavailable. |
|
||||||
"repair_attempts": 0,
|
| `retries_exhausted` | Boolean independent of the failure category. |
|
||||||
"is_valid": false
|
| `attempts`, `transient_retries`, `repair_calls` | Unsigned terminal aggregate counts. |
|
||||||
}
|
| `duration_ms`, `capacity_wait_ms`, `generation_duration_ms`, `retry_delay_ms` | Terminal observed durations in integer milliseconds; their sum need not equal wall time. |
|
||||||
}
|
| `usage` | Object containing `prompt_tokens`, `completion_tokens`, `total_tokens`, `cached_tokens`, and `cache_write_tokens`. |
|
||||||
```
|
|
||||||
|
|
||||||
The response still includes `artifact` and `metadata`.
|
Each `usage` count contains `value` (integer), `known` (boolean), and
|
||||||
|
`complete` (boolean). Reported zero differs from an unknown count; an
|
||||||
|
incomplete total does not establish complete billing. All counts, durations,
|
||||||
|
`retries_exhausted`, and `usage` are present even when zero or unknown. The
|
||||||
|
recognized failure values are `none`, `canceled`, `deadline`, `transport`,
|
||||||
|
`provider_status`, `malformed_response`, `capacity`, `invalid_config`,
|
||||||
|
`invalid_request`, `prompt_not_found`, `profile_not_found`, `prompt_load`,
|
||||||
|
`profile_load`, `artifact_load`, `prompt_render`, `validation`, `generation`,
|
||||||
|
and `other`.
|
||||||
|
|
||||||
|
The report excludes content, credentials, URLs, headers, and raw errors, but
|
||||||
|
its identifiers can still be sensitive. Apply appropriate access and retention
|
||||||
|
controls to responses that include it.
|
||||||
|
|
||||||
## Error Responses
|
## Error Responses
|
||||||
|
|
||||||
Error body shape:
|
Errors have this shape:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{"error":{"code":"invalid_request","message":"prompt_id is required"}}
|
||||||
"error": {
|
|
||||||
"code": "invalid_request",
|
|
||||||
"message": "prompt_id is required"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Current status/code mapping:
|
Messages are concise and do not expose wrapped internal causes.
|
||||||
|
For an opted-in failed invocation, the error envelope can also include the
|
||||||
|
optional top-level `execution` object described above. Decode and validation
|
||||||
|
failures before engine invocation do not have a report. Report-bearing error
|
||||||
|
responses are subject to the complete encoded response-size limit; if they
|
||||||
|
exceed it, the response is the compact `413 response_too_large` error without
|
||||||
|
`execution`. The existing compact error fallback itself is not re-limited.
|
||||||
|
|
||||||
| Status | Code | Meaning |
|
| Status | Code | Meaning |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `400` | `invalid_json` | Malformed JSON, unknown JSON field, or trailing JSON token. |
|
| `400` | `invalid_json` | Malformed JSON, unknown field, or trailing JSON. |
|
||||||
| `400` | `invalid_request` | Missing/invalid request fields or invalid runtime overrides. |
|
| `400` | `invalid_request` | Missing or invalid request data or runtime override. |
|
||||||
| `400` | `profile_required` | No `profile_id` and prompt has no `default_profile`. |
|
| `400` | `profile_required` | No profile ID and no prompt default profile. |
|
||||||
| `400` | `prompt_load_failed` | Prompt definition YAML/contract failed to load. |
|
| `400` | `prompt_load_failed` | Prompt definition failed to load. |
|
||||||
| `400` | `profile_load_failed` | Profile YAML/contract failed to load, including raw `api_key`. |
|
| `400` | `profile_load_failed` | Profile failed to load. |
|
||||||
| `400` | `artifact_not_allowed` | HTTP file refs are disabled or requested path is outside artifact root. |
|
| `400` | `artifact_not_allowed` | HTTP file input is disabled or outside the artifact root. |
|
||||||
| `400` | `artifact_read_failed` | Input artifact could not be read or input ref was unsupported/invalid. |
|
| `400` | `artifact_read_failed` | Input artifact is invalid or cannot be read. |
|
||||||
| `400` | `prompt_render_failed` | Prompt template rendering failed. |
|
| `400` | `prompt_render_failed` | Prompt template rendering failed. |
|
||||||
| `400` | `api_key_env_missing` | Selected `api_key_env` variable is unset or empty. |
|
| `400` | `api_key_env_missing` | The selected credential environment variable is unset or empty. |
|
||||||
| `404` | `not_found` | Route path is unknown. |
|
| `404` | `not_found` | Route does not exist. |
|
||||||
| `404` | `prompt_not_found` | Prompt ID/version was not found. |
|
| `404` | `prompt_not_found` | Prompt ID or version does not exist. |
|
||||||
| `404` | `profile_not_found` | Profile ID was not found. |
|
| `404` | `profile_not_found` | Profile ID does not exist. |
|
||||||
| `405` | `method_not_allowed` | Method is not `POST` on `/v1/runs`. |
|
| `405` | `method_not_allowed` | The route does not accept the method. |
|
||||||
| `413` | `request_too_large` | Encoded JSON request body exceeds configured request limit. |
|
| `408` | `request_canceled` | The caller context was canceled during a failed run. |
|
||||||
| `413` | `artifact_too_large` | HTTP file input artifact exceeds configured artifact limit. |
|
| `413` | `request_too_large` | Encoded request exceeds its limit. |
|
||||||
| `413` | `response_too_large` | Encoded JSON response exceeds configured response limit. |
|
| `413` | `artifact_too_large` | File input exceeds its limit. |
|
||||||
| `500` | `validation_runtime_failed` | Validator runtime/schema loading failed. |
|
| `413` | `response_too_large` | Encoded response exceeds its limit. |
|
||||||
| `500` | `internal_error` | Unclassified server error. |
|
| `500` | `validation_runtime_failed` | Schema or validator runtime failure. |
|
||||||
|
| `500` | `internal_error` | Unclassified server failure. |
|
||||||
| `502` | `llm_failed` | Outbound model request failed. |
|
| `502` | `llm_failed` | Outbound model request failed. |
|
||||||
|
| `503` | `capacity_exceeded` | The selected model backend has no admission capacity. No retry timing is supplied. |
|
||||||
|
| `504` | `deadline_exceeded` | The execution context's deadline expired during a failed run. |
|
||||||
|
|
||||||
HTTP error messages are intentionally concise and do not include sensitive
|
These context outcomes require the execution context to have ended. A provider
|
||||||
internal causes.
|
attempt timeout while it remains live retains `502 llm_failed`. A successful
|
||||||
|
run remains successful even if cancellation races with response formatting;
|
||||||
|
delivery after a client disconnect cannot be guaranteed.
|
||||||
|
|
||||||
## Retry And Idempotency
|
## Retry And Idempotency
|
||||||
|
|
||||||
Scriptorium does not provide idempotency keys, pagination, caching headers, or
|
Scriptorium provides no idempotency keys, pagination, caching headers, or rate
|
||||||
rate limiting.
|
limits. Clients may retry transport failures or `5xx` responses only when
|
||||||
|
their workflow tolerates another model call: a retry can produce different
|
||||||
Clients may retry transport failures or `5xx` responses when their surrounding
|
output and incur another provider request.
|
||||||
workflow can tolerate another model call. A retry can generate different output
|
|
||||||
and incur another provider request.
|
|
||||||
|
|
||||||
## Example File
|
|
||||||
|
|
||||||
- `examples/http-run.json`
|
|
||||||
|
|||||||
429
docs/cli.md
429
docs/cli.md
@@ -1,5 +1,10 @@
|
|||||||
# CLI Reference
|
# CLI Reference
|
||||||
|
|
||||||
|
This is the canonical contract for invoking Scriptorium. Configuration discovery,
|
||||||
|
precedence, application source locations, and server settings are defined in the
|
||||||
|
[configuration reference](config.md). The [HTTP API reference](api.md) owns
|
||||||
|
service request and response behavior.
|
||||||
|
|
||||||
## Shortest Useful Command
|
## Shortest Useful Command
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -10,224 +15,290 @@ go run ./cmd/scriptorium render \
|
|||||||
--input glossary=./examples/fixtures/glossary.yml
|
--input glossary=./examples/fixtures/glossary.yml
|
||||||
```
|
```
|
||||||
|
|
||||||
`render` prepares the prompt, loads input artifacts, resolves the execution
|
`render` prepares a request without calling an LLM.
|
||||||
profile, and prints the prepared request without calling an LLM.
|
|
||||||
|
|
||||||
## Command Overview
|
## Commands
|
||||||
|
|
||||||
- `scriptorium run`: prepare a prompt, call the configured LLM, write generated output, and print a run summary.
|
- `scriptorium run`: prepare a prompt, call the configured LLM, and write the
|
||||||
- `scriptorium render`: prepare a prompt only; write prepared-run output as `text` or `json`.
|
generated artifact.
|
||||||
- `scriptorium serve`: start the HTTP server for `POST /v1/runs`.
|
- `scriptorium render`: prepare a prompt and write prepared-run output.
|
||||||
|
- `scriptorium serve`: start the HTTP server.
|
||||||
|
- `scriptorium inspect prompt`: inspect one prompt definition without model execution.
|
||||||
|
- `scriptorium inspect profile`: inspect one effective profile without model execution.
|
||||||
|
- `scriptorium config validate`: validate application configuration without building an engine.
|
||||||
|
- `scriptorium config show`: show the resolved application configuration.
|
||||||
|
- `scriptorium config sources`: show the ordered configuration sources.
|
||||||
|
- `scriptorium config explain`: explain one effective or historical configuration path.
|
||||||
|
|
||||||
Canonical related references:
|
All commands accept `--config <path>` and `--config-overlay <name>` and reject
|
||||||
|
positional arguments. `--config-overlay` selects one application configuration
|
||||||
|
overlay; it is separate from `--profile`, which selects a Promptkit execution
|
||||||
|
profile. See [configuration composition](config.md#explicit-imports-and-selected-overlays)
|
||||||
|
for name, root, and no-base behavior. `run`,
|
||||||
|
`render`, `serve`, and `inspect prompt` require an effective `prompt_dir`;
|
||||||
|
`inspect profile` does not. Supply the directory through the configuration
|
||||||
|
contract or a supported `--prompt-dir` flag. Explicit application flags,
|
||||||
|
including empty values, override file settings. Configuration load diagnostics
|
||||||
|
go to stderr and exit with status 1; successful load warnings are printed once
|
||||||
|
before command work.
|
||||||
|
|
||||||
- [Configuration reference](config.md)
|
## `scriptorium run`
|
||||||
- [HTTP API reference](api.md)
|
|
||||||
- [Subprocess integration](integrations/subprocess.md)
|
|
||||||
|
|
||||||
## Common Rules
|
```text
|
||||||
|
|
||||||
- `--config` is supported by `run`, `render`, and `serve`.
|
|
||||||
- Positional arguments are rejected.
|
|
||||||
- `run` and `render` require `--prompt`, at least one `--input`, and an effective `prompt_dir`.
|
|
||||||
- `serve` requires an effective `prompt_dir`.
|
|
||||||
- `profile_dir` is optional. Without it, only built-in profiles are available.
|
|
||||||
- If `profile_dir` is set, custom profiles override built-in profiles with the same ID.
|
|
||||||
- Prompt cache control, `session_id`, structured output, and provider-specific profile fields are configured in YAML, not with CLI flags.
|
|
||||||
|
|
||||||
Config precedence is:
|
|
||||||
|
|
||||||
1. built-in defaults
|
|
||||||
2. config file values
|
|
||||||
3. CLI flags
|
|
||||||
|
|
||||||
## Flag Reference
|
|
||||||
|
|
||||||
### `scriptorium run`
|
|
||||||
|
|
||||||
```bash
|
|
||||||
scriptorium run [flags]
|
scriptorium run [flags]
|
||||||
```
|
```
|
||||||
|
|
||||||
Required through flags or config:
|
Required flags:
|
||||||
|
|
||||||
- `--prompt-dir <dir>`: prompt definition directory.
|
| Flag | Meaning |
|
||||||
|
| --- | --- |
|
||||||
Required as flags:
|
| `--prompt <id>` | Prompt ID to execute. |
|
||||||
|
|
||||||
- `--prompt <id>`: prompt ID to execute.
|
|
||||||
- `--input name=path`: input file mapping. Repeat or use comma-separated mappings.
|
|
||||||
|
|
||||||
Optional flags:
|
Optional flags:
|
||||||
|
|
||||||
- `--config <path>`: application config file.
|
| Flag | Meaning |
|
||||||
- `--profile-dir <dir>`: custom profile definition directory.
|
| --- | --- |
|
||||||
- `--schema-dir <dir>`: schema base directory for `json_schema` validation.
|
| `--config <path>` | Application configuration file. |
|
||||||
- `--profile <id>`: execution profile override. If omitted, the prompt `default_profile` is used.
|
| `--config-overlay <name>` | Selected application configuration overlay. |
|
||||||
- `--var name=value`: template variable mapping. Repeat or use comma-separated mappings.
|
| `--prompt-dir <dir>` | Prompt-definition directory override. |
|
||||||
- `--out <path>`: write generated artifact body to a file instead of stdout.
|
| `--profile-dir <dir>` | Custom profile-directory override. |
|
||||||
- `--llm-base-url <url>`: runtime endpoint override.
|
| `--schema-dir <dir>` | Schema base-directory override. |
|
||||||
- `--model <name>`: runtime model override.
|
| `--prompt-version <version>` | Optional prompt-definition version selector. |
|
||||||
- `--api-key-env <name>`: runtime API-key environment variable name override.
|
| `--profile <id>` | Execution-profile override. |
|
||||||
- `--temperature <float>`: runtime temperature override.
|
| `--session-id <id>` | Optional direct session identifier. |
|
||||||
- `--max-tokens <int>`: runtime max tokens override.
|
| `--input name=path` | Optional input file mapping; repeat or use comma-separated mappings. |
|
||||||
- `--top-p <float>`: runtime top-p override.
|
| `--var name=value` | Template-variable mapping; repeat or use comma-separated mappings. |
|
||||||
- `--timeout <duration>`: runtime timeout override using Go duration syntax, such as `30s` or `2m`.
|
| `--out <path>` | Write generated content to this file instead of stdout. |
|
||||||
|
| `--execution-report <path>` | Write an opt-in terminal execution report as newline-terminated JSON to a separate file. |
|
||||||
|
| `--llm-base-url <url>` | Runtime endpoint override. |
|
||||||
|
| `--model <name>` | Runtime model override. |
|
||||||
|
| `--api-key-env <name>` | Runtime API-key environment-variable name override. |
|
||||||
|
| `--temperature <float>` | Runtime temperature override. |
|
||||||
|
| `--max-tokens <int>` | Runtime maximum-token override. |
|
||||||
|
| `--top-p <float>` | Runtime top-p override. |
|
||||||
|
| `--reasoning-effort <value>` | Runtime reasoning-effort override. |
|
||||||
|
| `--timeout <duration>` | Runtime timeout override using Go duration syntax. |
|
||||||
|
| `--run-timeout <duration>` | Optional whole-run engine deadline using Go duration syntax; zero or omission adds no deadline, negative values are invalid. |
|
||||||
|
| `--transient-retries <integer>` | Nonnegative additional transient attempt count for this request; `0` disables additional attempts. |
|
||||||
|
|
||||||
Deprecated aliases:
|
Deprecated aliases: `--prompt-id` for `--prompt`, and `--profile-id` for
|
||||||
|
`--profile`.
|
||||||
|
|
||||||
- `--prompt-id <id>`: alias for `--prompt`.
|
Omitted numeric runtime flags preserve the selected effective value; explicit
|
||||||
- `--profile-id <id>`: alias for `--profile`.
|
zero values override it. `--timeout 0s` disables the per-attempt generation deadline
|
||||||
|
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://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/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
|
||||||
|
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 whose execution context reaches
|
||||||
|
this deadline exits 1 with a safe deadline diagnostic; a completed invalid
|
||||||
|
output still exits 2. It does not promise immediate interruption of synchronous
|
||||||
|
work.
|
||||||
|
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
|
||||||
|
have separate transient retry budgets.
|
||||||
|
|
||||||
Runtime override notes:
|
There is no raw API-key flag. Use `--api-key-env`.
|
||||||
|
|
||||||
- Omitted numeric override flags preserve the selected profile/default value.
|
`--prompt-version` is passed directly to Promptkit. When it is omitted, the
|
||||||
- Explicit zero values override the selected profile/default value.
|
selected prompt ID must have exactly one available version. `--input` is
|
||||||
- `--timeout 0s` disables the outbound HTTP client timeout for that request.
|
optional at the CLI boundary: Promptkit decides whether the selected definition
|
||||||
- There is no raw API-key flag; use `--api-key-env`.
|
requires declared inputs or template-referenced values.
|
||||||
|
|
||||||
### `scriptorium render`
|
`--session-id` supplies a direct, non-secret session identifier. A nonblank
|
||||||
|
value replaces a definition-rendered session ID; an omitted or blank value lets
|
||||||
|
the definition supply one. Promptkit trims direct values and limits them to 256
|
||||||
|
Unicode code points. Use stable, non-sensitive identifiers because effective
|
||||||
|
session IDs may appear in prepared output, run metadata, and provider-facing
|
||||||
|
requests.
|
||||||
|
|
||||||
```bash
|
`--reasoning-effort` is presence-aware: omitting it inherits the selected
|
||||||
|
profile value, a nonblank value replaces that value, and
|
||||||
|
`--reasoning-effort=` explicitly clears inherited reasoning. Promptkit treats
|
||||||
|
nonblank values as provider-specific opaque strings.
|
||||||
|
|
||||||
|
### Execution report file
|
||||||
|
|
||||||
|
`--execution-report` requires a nonempty path. It is available only for `run`;
|
||||||
|
`-` is an ordinary filename. Parent directories are not created. An existing
|
||||||
|
file is replaced through ordinary file writing, without rollback or an atomic
|
||||||
|
replacement guarantee. Generated content still goes to stdout or `--out`.
|
||||||
|
Equal output/report paths, including existing paths that refer to the same
|
||||||
|
file, are rejected before execution.
|
||||||
|
|
||||||
|
The file is written after engine execution when Promptkit supplies a terminal
|
||||||
|
event, including for a failed run or invalid generated output. A failure before
|
||||||
|
invocation leaves the report path untouched. If no terminal event is supplied,
|
||||||
|
Scriptorium leaves the path untouched and emits a diagnostic; an existing file
|
||||||
|
may therefore contain an older report. Artifact output is attempted first on a
|
||||||
|
successful run, and report writing is attempted even if artifact writing fails.
|
||||||
|
Any output or report write failure exits 1; already-written output is not
|
||||||
|
undone. Without a write failure, the actual run keeps its usual exit status.
|
||||||
|
|
||||||
|
The [HTTP API reference](api.md#execution-report) defines the shared report
|
||||||
|
fields and usage-presence semantics. The file contains that JSON object followed
|
||||||
|
by a newline.
|
||||||
|
|
||||||
|
The report excludes content, credentials, URLs, headers, and raw errors, but
|
||||||
|
its identifiers can still be sensitive. The caller owns file retention and
|
||||||
|
access.
|
||||||
|
|
||||||
|
## `scriptorium render`
|
||||||
|
|
||||||
|
```text
|
||||||
scriptorium render [flags]
|
scriptorium render [flags]
|
||||||
```
|
```
|
||||||
|
|
||||||
Required through flags or config:
|
`--prompt <id>` is required. The following optional flags are supported:
|
||||||
|
`--config`, `--config-overlay`, `--prompt-dir`, `--profile-dir`, `--schema-dir`, `--prompt-version`, `--profile`,
|
||||||
|
`--input`, `--var`, `--out`, `--llm-base-url`,
|
||||||
|
`--model`, `--api-key-env`, `--temperature`, `--max-tokens`, `--top-p`,
|
||||||
|
`--reasoning-effort`, `--session-id`, `--timeout`, `--transient-retries`, and `--format text|json`. Their meanings match the corresponding
|
||||||
|
`run` flags; `--format` selects prepared-run output and otherwise uses
|
||||||
|
`defaults.render_format`.
|
||||||
|
|
||||||
- `--prompt-dir <dir>`: prompt definition directory.
|
The same deprecated aliases and numeric/timeout behavior as `run` apply.
|
||||||
|
The same session and reasoning inheritance, replacement, and clearing behavior
|
||||||
|
also applies.
|
||||||
|
`render` validates the retry override but does not generate model output or
|
||||||
|
include a retry field in prepared output.
|
||||||
|
`render` resolves profiles and schemas as part of preparation but
|
||||||
|
does not call an LLM.
|
||||||
|
|
||||||
Required as flags:
|
## `scriptorium serve`
|
||||||
|
|
||||||
- `--prompt <id>`: prompt ID to render.
|
```text
|
||||||
- `--input name=path`: input file mapping. Repeat or use comma-separated mappings.
|
|
||||||
|
|
||||||
Optional flags:
|
|
||||||
|
|
||||||
- `--config <path>`: application config file.
|
|
||||||
- `--prompt-dir <dir>`: prompt definition directory.
|
|
||||||
- `--profile-dir <dir>`: custom profile definition directory.
|
|
||||||
- `--profile <id>`: execution profile override.
|
|
||||||
- `--var name=value`: template variable mapping. Repeat or use comma-separated mappings.
|
|
||||||
- `--out <path>`: write prepared-run output to a file instead of stdout.
|
|
||||||
- `--llm-base-url <url>`: runtime endpoint override for the prepared request.
|
|
||||||
- `--model <name>`: runtime model override for the prepared request.
|
|
||||||
- `--api-key-env <name>`: runtime API-key environment variable name override.
|
|
||||||
- `--temperature <float>`: runtime temperature override.
|
|
||||||
- `--max-tokens <int>`: runtime max tokens override.
|
|
||||||
- `--top-p <float>`: runtime top-p override.
|
|
||||||
- `--timeout <duration>`: runtime timeout override using Go duration syntax.
|
|
||||||
- `--format text|json`: prepared-run output format. Defaults to config `defaults.render_format`, then `text`.
|
|
||||||
|
|
||||||
Deprecated aliases:
|
|
||||||
|
|
||||||
- `--prompt-id <id>`: alias for `--prompt`.
|
|
||||||
- `--profile-id <id>`: alias for `--profile`.
|
|
||||||
|
|
||||||
Notes:
|
|
||||||
|
|
||||||
- `render` resolves profiles, loads schemas for `json_schema` prompts, and validates `api_key_env`.
|
|
||||||
- `render` does not accept `--schema-dir`; use config `schema_dir` for render-time schema lookup.
|
|
||||||
- `render` does not call the LLM.
|
|
||||||
|
|
||||||
### `scriptorium serve`
|
|
||||||
|
|
||||||
```bash
|
|
||||||
scriptorium serve [flags]
|
scriptorium serve [flags]
|
||||||
```
|
```
|
||||||
|
|
||||||
Required through flags or config:
|
|
||||||
|
|
||||||
- `--prompt-dir <dir>`: prompt definition directory.
|
|
||||||
|
|
||||||
Optional flags:
|
Optional flags:
|
||||||
|
|
||||||
- `--config <path>`: application config file.
|
| Flag | Meaning |
|
||||||
- `--addr <listen-address>`: HTTP listen address.
|
| --- | --- |
|
||||||
- `--prompt-dir <dir>`: prompt definition directory.
|
| `--config <path>` | Application configuration file. |
|
||||||
- `--profile-dir <dir>`: custom profile definition directory.
|
| `--config-overlay <name>` | Selected application configuration overlay. |
|
||||||
- `--schema-dir <dir>`: schema base directory for `json_schema` validation.
|
| `--addr <listen-address>` | HTTP listen-address override. |
|
||||||
- `--artifact-root <dir>`: base directory for HTTP `file` input references.
|
| `--prompt-dir <dir>` | Prompt-definition directory override. |
|
||||||
- `--max-request-bytes <n>`: maximum HTTP request body bytes; `0` disables the limit.
|
| `--profile-dir <dir>` | Custom profile-directory override. |
|
||||||
- `--max-artifact-bytes <n>`: maximum HTTP file artifact bytes; `0` disables the limit.
|
| `--schema-dir <dir>` | Schema base-directory override. |
|
||||||
- `--max-response-bytes <n>`: maximum encoded HTTP response body bytes; `0` disables the limit.
|
| `--artifact-root <dir>` | Root for HTTP `file` input references. |
|
||||||
|
| `--max-request-bytes <n>` | Maximum encoded HTTP request-body bytes; `0` disables the limit. |
|
||||||
|
| `--max-artifact-bytes <n>` | Maximum HTTP file-input artifact bytes; `0` disables the limit. |
|
||||||
|
| `--max-response-bytes <n>` | Maximum encoded HTTP response bytes; `0` disables the limit. |
|
||||||
|
|
||||||
Notes:
|
`serve` accepts no runtime model override flags. HTTP request fields, response
|
||||||
|
schemas, and error codes are defined in the [HTTP API reference](api.md).
|
||||||
|
|
||||||
- `serve` does not accept runtime model override flags such as `--model` or `--llm-base-url`.
|
## `scriptorium inspect prompt`
|
||||||
- HTTP request fields and error codes are documented in the [HTTP API reference](api.md).
|
|
||||||
- HTTP `file` input references are rejected unless an artifact root is configured.
|
```text
|
||||||
- HTTP size-limit flags affect only `serve`.
|
scriptorium inspect prompt --prompt ID [--prompt-version VERSION]
|
||||||
|
[--config PATH] [--config-overlay NAME] [--prompt-dir DIR] [--format text|json] [--out PATH]
|
||||||
|
```
|
||||||
|
|
||||||
|
`--prompt` is required. Inspection uses normal configuration discovery and a
|
||||||
|
`--prompt-dir` override, defaults to text regardless of `defaults.render_format`,
|
||||||
|
and writes to stdout unless `--out` is supplied. It loads and normalizes the
|
||||||
|
selected definition but does not resolve a profile, load a schema, render a
|
||||||
|
template, reserve backend capacity, or call a model.
|
||||||
|
|
||||||
|
## `scriptorium inspect profile`
|
||||||
|
|
||||||
|
```text
|
||||||
|
scriptorium inspect profile --profile ID
|
||||||
|
[--config PATH] [--config-overlay NAME] [--profile-dir DIR] [--format text|json] [--out PATH]
|
||||||
|
```
|
||||||
|
|
||||||
|
`--profile` is required; built-in profiles need no prompt directory. Inspection
|
||||||
|
resolves profile inheritance and backend defaults, but never reads a credential
|
||||||
|
value, loads a prompt, reserves capacity, or calls a model. Unset provider
|
||||||
|
controls are shown as zero values when Promptkit leaves them unspecified.
|
||||||
|
|
||||||
|
## Application configuration inspection
|
||||||
|
|
||||||
|
```text
|
||||||
|
scriptorium config validate [flags]
|
||||||
|
scriptorium config show [flags]
|
||||||
|
scriptorium config sources [flags]
|
||||||
|
scriptorium config explain --path JSON_POINTER [flags]
|
||||||
|
```
|
||||||
|
|
||||||
|
Each accepts `--config`, `--config-overlay`, `--prompt-dir`, `--profile-dir`,
|
||||||
|
`--schema-dir`, `--addr`, `--artifact-root`, `--max-request-bytes`,
|
||||||
|
`--max-artifact-bytes`, and `--max-response-bytes`. These are application
|
||||||
|
configuration selectors and overrides; request, credential, backend-editing,
|
||||||
|
output-format, and output-file flags are not accepted. Positional arguments
|
||||||
|
are rejected.
|
||||||
|
|
||||||
|
`validate` writes no success output; status 0 means the application configuration
|
||||||
|
loaded and passed its own validation. It does not establish that a prompt
|
||||||
|
directory exists, credentials are present, or Promptkit can construct an
|
||||||
|
engine. `show` writes ConfigKit's resolved, redacted YAML snapshot. `sources`
|
||||||
|
writes one newline-terminated JSON array of source records in load order. Each
|
||||||
|
record has `id`, `label`, and `layer`, plus `path` when available; explicit CLI
|
||||||
|
overrides appear as synthetic sources. Defaults-only input without overrides
|
||||||
|
produces `[]` for `sources`.
|
||||||
|
|
||||||
|
`explain` requires an explicitly supplied `--path` in JSON Pointer syntax.
|
||||||
|
The empty string selects the root; `/server/addr` selects a field; `~1` and
|
||||||
|
`~0` escape `/` and `~` inside mapping keys. Numeric tokens are interpreted
|
||||||
|
according to the containing mapping or sequence. Dotted paths, file paths,
|
||||||
|
and URL fragments are not accepted. ConfigKit writes a human-readable account
|
||||||
|
of the effective value and its chronological default, base, overlay, CLI,
|
||||||
|
and normalization history, including removed historical values. This is not a
|
||||||
|
JSON schema or a byte-for-byte stable prose format. Unknown and malformed paths
|
||||||
|
exit 1 without successful explanation output.
|
||||||
|
|
||||||
|
Diagnostics and warnings go to stderr, never into successful stdout. Parse,
|
||||||
|
load, output, and diagnostic-write failures exit 1. Ordinary output writes may
|
||||||
|
leave partial data on failure. The inspection output can contain paths,
|
||||||
|
identifiers, `api_key_env` reference names, and ordinary `extra_params` values,
|
||||||
|
including displaced historical values in explanations;
|
||||||
|
protect it accordingly. Raw API-key values are not read or emitted by these
|
||||||
|
commands.
|
||||||
|
|
||||||
## Input And Variable Syntax
|
## Input And Variable Syntax
|
||||||
|
|
||||||
- `--input name=path` maps prompt input names to local file paths.
|
`--input name=path` maps an input name to a local file; `--var name=value`
|
||||||
- `--var name=value` maps prompt template variables to string values.
|
maps a template variable to a string. Both flags can be repeated or contain
|
||||||
- Both flags can be repeated.
|
comma-separated mappings. Values may contain `=` after the first separator.
|
||||||
- Both flags also accept comma-separated mappings, such as `--input transcript=./t.md,glossary=./g.yml`.
|
Empty names and values are rejected.
|
||||||
- Values may contain `=` after the first separator, such as `--var note=a=b=c`.
|
|
||||||
- Empty names and empty values are rejected.
|
|
||||||
|
|
||||||
CLI `run` and `render` convert every `--input` mapping to a `file` artifact
|
CLI inputs are file references. HTTP inline inputs are defined by the
|
||||||
reference. HTTP also supports `inline` input references; see [HTTP API
|
[HTTP API reference](api.md).
|
||||||
reference](api.md).
|
|
||||||
|
|
||||||
## Output Behavior
|
## Output And Exit Behavior
|
||||||
|
|
||||||
`run`:
|
- `run` writes generated content to stdout, or to `--out` when supplied, and
|
||||||
|
writes a concise summary to stderr. The summary includes `backend=<id>` when
|
||||||
|
Promptkit selected a backend; endpoint-only profiles omit it.
|
||||||
|
- `render` writes prepared-run output to stdout, or to `--out` when supplied,
|
||||||
|
without a success summary. Text output includes `selected_backend_id` after
|
||||||
|
`selected_profile_id` when Promptkit selected one; endpoint-only profiles
|
||||||
|
omit it.
|
||||||
|
- `serve` writes startup and server errors to stderr.
|
||||||
|
|
||||||
- Writes generated artifact content to stdout by default.
|
Exit statuses:
|
||||||
- Writes generated artifact content to `--out` when provided.
|
|
||||||
- Prints a success summary to stderr.
|
|
||||||
- Prints errors to stderr on failure.
|
|
||||||
|
|
||||||
`render`:
|
| Status | Meaning |
|
||||||
|
| --- | --- |
|
||||||
|
| `0` | Success. |
|
||||||
|
| `1` | Parse, configuration, loading, rendering, generation, output-write, or other runtime error. |
|
||||||
|
| `2` | `run` generated and wrote output, but validation failed. |
|
||||||
|
|
||||||
- Writes prepared-run output to stdout by default.
|
A backend admission rejection is a runtime error and prints `run error: model
|
||||||
- Writes prepared-run output to `--out` when provided.
|
backend capacity is exhausted`. The HTTP capacity response is defined in the
|
||||||
- Does not print a success summary.
|
[HTTP API reference](api.md).
|
||||||
|
|
||||||
`serve`:
|
## Workflows And Examples
|
||||||
|
|
||||||
- Logs startup and server errors to stderr.
|
The [maintained render script](../examples/render-markdown-summary.sh) is a
|
||||||
|
copyable render workflow. The [HTTP request example](../examples/http-run.json)
|
||||||
## Exit Codes
|
is for a running `serve` process.
|
||||||
|
|
||||||
- `0`: success.
|
|
||||||
- `1`: parse, config, load, render, generation, output-write, or runtime error.
|
|
||||||
- `2`: `run` completed and wrote output, but validation status is `failed`.
|
|
||||||
|
|
||||||
## Common Workflows
|
|
||||||
|
|
||||||
Render prompt inputs and variables as JSON:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
go run ./cmd/scriptorium render \
|
|
||||||
--config ./examples/config.yml \
|
|
||||||
--prompt generic.markdown_summary \
|
|
||||||
--input transcript=./examples/fixtures/transcript.md \
|
|
||||||
--input glossary=./examples/fixtures/glossary.yml \
|
|
||||||
--var session_date=2026-05-04 \
|
|
||||||
--format json
|
|
||||||
```
|
|
||||||
|
|
||||||
Run a prompt with an explicit profile and file output:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
go run ./cmd/scriptorium run \
|
|
||||||
--config ./examples/config.yml \
|
|
||||||
--prompt generic.markdown_summary \
|
|
||||||
--profile local-fast \
|
|
||||||
--input transcript=./examples/fixtures/transcript.md \
|
|
||||||
--input glossary=./examples/fixtures/glossary.yml \
|
|
||||||
--out ./summary.md
|
|
||||||
```
|
|
||||||
|
|
||||||
Start the HTTP server with example config:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
go run ./cmd/scriptorium serve --config ./examples/config.yml
|
|
||||||
```
|
|
||||||
|
|
||||||
Copyable maintained script:
|
|
||||||
|
|
||||||
- `examples/render-markdown-summary.sh`
|
|
||||||
|
|||||||
463
docs/config.md
463
docs/config.md
@@ -1,324 +1,207 @@
|
|||||||
# Configuration Reference
|
# Configuration Reference
|
||||||
|
|
||||||
## Config Discovery And Precedence
|
This is the canonical reference for Scriptorium application settings. Prompt,
|
||||||
|
profile, schema, execution-setting, built-in profile, and framework credential
|
||||||
|
semantics are defined by the
|
||||||
|
[Promptkit v0.11.0 format reference](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/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).
|
||||||
|
|
||||||
|
## Discovery And Precedence
|
||||||
|
|
||||||
Application settings are resolved in this order:
|
Application settings are resolved in this order:
|
||||||
|
|
||||||
1. built-in defaults
|
1. built-in Scriptorium defaults;
|
||||||
2. `config.yml` values
|
2. a configuration file; then
|
||||||
3. CLI overrides
|
3. CLI overrides.
|
||||||
|
|
||||||
When `--config` is omitted, Scriptorium searches:
|
When `--config` is omitted, Scriptorium searches
|
||||||
|
`/usr/local/etc/scriptorium/config.yml` and then `/etc/scriptorium/config.yml`.
|
||||||
|
If neither exists, it uses built-in defaults. An explicit `--config` path must
|
||||||
|
exist and decode successfully.
|
||||||
|
|
||||||
1. `/usr/local/etc/scriptorium/config.yml`
|
The maintained [minimal configuration](../examples/config.yml),
|
||||||
2. `/etc/scriptorium/config.yml`
|
[complete configuration](../examples/config.full.yml), and
|
||||||
|
[composed configuration](../examples/config.composed.yml) are copyable examples.
|
||||||
|
|
||||||
If neither file exists, Scriptorium uses built-in defaults. When
|
## Application Configuration File
|
||||||
`--config <path>` is provided, that file must exist and decode successfully.
|
|
||||||
|
|
||||||
## Minimal Working Config
|
Configuration is decoded by ConfigKit v0.4.0 as strict YAML. Unknown fields,
|
||||||
|
empty files, multiple YAML documents, and YAML aliases/anchors are rejected.
|
||||||
|
An explicit empty string is a value: it clears a file-provided optional path
|
||||||
|
or, for required `prompt_dir`, fails the command's prerequisite. A scalar
|
||||||
|
`null` is not an empty string and is rejected for scalar fields; nullable
|
||||||
|
fields such as `transient_retries` retain their documented meaning. Raw
|
||||||
|
API-key fields are not accepted.
|
||||||
|
|
||||||
```yaml
|
ConfigKit applies defaults, the selected file, then only explicitly supplied
|
||||||
prompt_dir: ./examples/prompts
|
application CLI flags before validating the result. Paths in the application
|
||||||
|
document remain relative to the process working directory, not to the file's
|
||||||
|
directory. Load diagnostics are printed safely on stderr; invalid application
|
||||||
|
configuration exits with status 1.
|
||||||
|
|
||||||
|
### Explicit imports and selected overlays
|
||||||
|
|
||||||
|
A file-backed configuration may declare `configkit.imports` with relative
|
||||||
|
`path` or `glob` entries. Each entry is explicit; Scriptorium does not scan
|
||||||
|
for fragments on its own. ConfigKit composes the selected file and imports by
|
||||||
|
conflict, so two fragments cannot define the same field merely to establish
|
||||||
|
precedence. A required missing import fails; an entry may use
|
||||||
|
`optional: true` to suppress target nonexistence. Imports are resolved from
|
||||||
|
the declaring file's canonical directory and remain within the selected
|
||||||
|
file's canonical directory by default. Scriptorium does not widen that root.
|
||||||
|
|
||||||
|
`--config-overlay NAME` selects one file at `overlays/NAME.yml` below that
|
||||||
|
root. The name must use letters, digits, `_`, or `-`; it is not a path. Empty
|
||||||
|
and exact lowercase `default` select no overlay. There is no fallback,
|
||||||
|
case folding, inherited stack, or automatic selection; a missing selected
|
||||||
|
overlay fails. ConfigKit merges mapping fields and replaces other values,
|
||||||
|
including sequences and explicit nulls, before applying explicit CLI flags.
|
||||||
|
An active overlay needs a selected base file. No-source defaults-only loads
|
||||||
|
cannot use imports or an active overlay.
|
||||||
|
|
||||||
|
The [composed example](../examples/config.composed.yml) imports two fragments
|
||||||
|
and has a selectable [local overlay](../examples/overlays/local.yml). From the
|
||||||
|
repository root:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
go run ./cmd/scriptorium render \
|
||||||
|
--config ./examples/config.composed.yml --config-overlay local \
|
||||||
|
--prompt generic.markdown_summary \
|
||||||
|
--input transcript=./examples/fixtures/transcript.md \
|
||||||
|
--input glossary=./examples/fixtures/glossary.yml
|
||||||
```
|
```
|
||||||
|
|
||||||
This is enough for `run` and `render` when selected prompts use built-in
|
Import and overlay file locations are constrained by ConfigKit;
|
||||||
profiles. Set `profile_dir` when prompts or requests use custom profiles.
|
*application path values* such as `prompt_dir` remain relative
|
||||||
|
to the process working directory even when authored in a fragment or overlay.
|
||||||
|
These source constraints are separate from HTTP artifact containment.
|
||||||
|
|
||||||
The maintained repository example is `examples/config.yml`.
|
| Field | Default | Meaning |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `prompt_dir` | unset | Promptkit prompt-definition source directory. `run`, `render`, `serve`, and `inspect prompt` require an effective value. |
|
||||||
|
| `profile_dir` | unset | Optional custom Promptkit profile source directory overlaid on Promptkit built-ins. |
|
||||||
|
| `schema_dir` | `.` | Promptkit schema source directory for relative schema paths. |
|
||||||
|
| `server.addr` | `:8080` | Address used by `serve`. |
|
||||||
|
| `server.artifact_root` | unset | Root that enables HTTP `file` input references. |
|
||||||
|
| `server.max_request_bytes` | `16777216` | Maximum encoded HTTP request-body bytes; `0` disables the limit. |
|
||||||
|
| `server.max_artifact_bytes` | `16777216` | Maximum HTTP file-input artifact bytes; `0` disables the limit. |
|
||||||
|
| `server.max_response_bytes` | `16777216` | Maximum encoded HTTP response bytes; `0` disables the limit. |
|
||||||
|
| `defaults.render_format` | `text` | Default prepared-run output format: `text` or `json`. |
|
||||||
|
| `backends` | unset | Optional mapping of custom Promptkit backend IDs to engine-scoped connection and capacity settings. |
|
||||||
|
| `transient_retries` | Promptkit default | Optional nonnegative count of additional built-in transient generation attempts. Omitted or `null` delegates to Promptkit; `0` disables additional attempts. |
|
||||||
|
|
||||||
## Production-Oriented Config
|
The size fields must be zero or greater. The [HTTP API](api.md) defines how
|
||||||
|
each limit is enforced and reported. `server.artifact_root` configures an HTTP
|
||||||
|
deployment boundary; see [operations](operations.md) for deployment handling.
|
||||||
|
|
||||||
|
The `config validate`, `config show`, `config sources`, and `config explain`
|
||||||
|
commands inspect this
|
||||||
|
application configuration without creating a Promptkit engine. `show` is a
|
||||||
|
resolved inspection snapshot, not necessarily a reloadable file. Application
|
||||||
|
validation does not check framework sources, backend connectivity, or credential
|
||||||
|
availability. `api_key_env` is an environment-variable *name* and remains
|
||||||
|
visible in inspection; its environment value is never read by ConfigKit.
|
||||||
|
Ordinary backend `extra_params` values also remain visible, so keep secrets out
|
||||||
|
of those fields and protect inspection output as potentially sensitive.
|
||||||
|
`config explain --path /server/addr` uses JSON Pointer syntax to show the
|
||||||
|
selected field's current value and history from defaults, files, overlays,
|
||||||
|
explicit CLI overrides, and normalization. `--path ''` selects the root.
|
||||||
|
History includes replaced and removed values; `show` presents the final
|
||||||
|
resolved snapshot. Neither renderer looks up credential bytes, and neither
|
||||||
|
claims to identify arbitrary secrets in unclassified parameter values.
|
||||||
|
|
||||||
|
## Custom Backends
|
||||||
|
|
||||||
|
Use `backends` when a profile selects an application-defined backend ID:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
prompt_dir: /opt/scriptorium/prompts
|
backends:
|
||||||
profile_dir: /opt/scriptorium/profiles
|
local-gpu:
|
||||||
schema_dir: /opt/scriptorium/schemas
|
endpoint: http://localhost:11434/v1
|
||||||
|
api_key_env: LOCAL_GPU_API_KEY
|
||||||
server:
|
extra_params:
|
||||||
addr: 127.0.0.1:8080
|
provider_option: enabled
|
||||||
artifact_root: /var/lib/scriptorium/artifacts
|
concurrency_limit: 2
|
||||||
max_request_bytes: 16777216
|
queue_capacity: 0
|
||||||
max_artifact_bytes: 16777216
|
|
||||||
max_response_bytes: 16777216
|
|
||||||
|
|
||||||
defaults:
|
|
||||||
render_format: text
|
|
||||||
```
|
```
|
||||||
|
|
||||||
The maintained full example is `examples/config.full.yml`.
|
Each mapping key is the case-sensitive backend ID. `endpoint` is required;
|
||||||
|
`api_key_env`, `extra_params`, `concurrency_limit`, and `queue_capacity` are
|
||||||
|
optional. `concurrency_limit: 0` leaves the backend unlimited. Omitting
|
||||||
|
`queue_capacity` lets Promptkit use its default for a limited backend, while
|
||||||
|
an explicit `queue_capacity: 0` disables queueing.
|
||||||
|
|
||||||
## App Config Reference
|
Configuration strictly owns the YAML shape and rejects unknown fields. Promptkit
|
||||||
|
validates backend IDs, endpoints, environment-variable names, extra parameters,
|
||||||
|
and capacity relationships when Scriptorium constructs its engine. There are no
|
||||||
|
backend command-line overrides. Store only an environment-variable name in
|
||||||
|
`api_key_env`; raw API-key fields are not accepted.
|
||||||
|
|
||||||
Top-level fields:
|
## Framework Source Mapping
|
||||||
|
|
||||||
| Field | Default | Description |
|
Scriptorium passes `prompt_dir`, `profile_dir`, and `schema_dir` to Promptkit
|
||||||
| --- | --- | --- |
|
when constructing its engine. Scriptorium does not redefine or independently
|
||||||
| `prompt_dir` | unset | Directory containing prompt definition YAML files. Required effectively by `run`, `render`, and `serve`. |
|
parse those framework file formats.
|
||||||
| `profile_dir` | unset | Directory containing custom profile YAML files. Built-in profiles remain available when unset. |
|
|
||||||
| `schema_dir` | `.` | Base directory for relative JSON Schema paths. |
|
|
||||||
| `server` | `{}` | HTTP service settings used by `serve`. |
|
|
||||||
| `defaults` | `{}` | Adapter defaults. |
|
|
||||||
|
|
||||||
`server` fields:
|
- Prompt selection, versions, message templates, inputs, output contracts, and
|
||||||
|
session IDs are Promptkit contracts.
|
||||||
|
- Profile fields, numeric ranges, execution defaults, overlay precedence,
|
||||||
|
built-in profiles, and credential rules are Promptkit contracts.
|
||||||
|
- Schema path behavior and generated-content validation are Promptkit
|
||||||
|
contracts.
|
||||||
|
|
||||||
| Field | Default | Description |
|
See the
|
||||||
| --- | --- | --- |
|
[tagged Promptkit format reference](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/docs/formats.md)
|
||||||
| `server.addr` | `:8080` | Listen address for `serve`. |
|
for all of those definitions. The files under
|
||||||
| `server.artifact_root` | unset | Base directory for HTTP `file` input references. Without it, HTTP file refs are rejected. |
|
[`examples/prompts`](../examples/prompts/),
|
||||||
| `server.max_request_bytes` | `16777216` | Maximum encoded HTTP request body bytes. `0` disables the limit. |
|
[`examples/profiles`](../examples/profiles/), and
|
||||||
| `server.max_artifact_bytes` | `16777216` | Maximum HTTP file artifact bytes. `0` disables the limit. |
|
[`examples/schemas`](../examples/schemas/) are maintained Scriptorium
|
||||||
| `server.max_response_bytes` | `16777216` | Maximum encoded HTTP response bytes. `0` disables the limit. |
|
application inputs using that tagged format.
|
||||||
|
|
||||||
`defaults` fields:
|
Promptkit supplies the opt-in profile IDs `promptkit-openrouter-standard` and
|
||||||
|
`promptkit-openrouter-auto`. They can be selected as a prompt default or request
|
||||||
|
profile, and custom profile sources retain precedence. Their effective model
|
||||||
|
settings may change with a catalog upgrade; use a complete application-owned
|
||||||
|
profile when fixed settings are required. See the tagged format reference for
|
||||||
|
the maintained-profile contract.
|
||||||
|
|
||||||
| Field | Default | Description |
|
## Credentials And Outbound Behavior
|
||||||
| --- | --- | --- |
|
|
||||||
| `defaults.render_format` | `text` | Default `render` output format: `text` or `json`. |
|
|
||||||
|
|
||||||
Config rules:
|
Scriptorium maps `--api-key-env` and HTTP `model.api_key_env` into Promptkit
|
||||||
|
request overrides. Keep secret values in environment variables and store only
|
||||||
|
their names in configuration or framework source files. Do not place raw keys
|
||||||
|
in configuration, prompts, profiles, CLI arguments, examples, or HTTP
|
||||||
|
payloads.
|
||||||
|
|
||||||
- YAML decoding is strict; unknown fields are rejected.
|
An optional `api_key_env` whose environment value is absent or empty can result
|
||||||
- HTTP size limits must be greater than or equal to `0`.
|
in an unauthenticated provider request. A profile that declares credentials
|
||||||
- Empty string config values are ignored.
|
required still fails as an invalid request when no credential source is
|
||||||
- Raw API key fields are not supported in app config.
|
selected, and fails with `ErrAPIKeyEnvMissing` when its selected environment
|
||||||
|
source is absent or empty. Scriptorium never reads or emits the environment
|
||||||
|
value itself.
|
||||||
|
|
||||||
## Prompt Definition Files
|
Unset optional provider controls are omitted from compatible provider requests.
|
||||||
|
A positive Promptkit `repair_attempts` budget can add provider calls, latency,
|
||||||
|
token use, and cost; see the tagged format reference for its permitted values
|
||||||
|
and validation-mode requirements.
|
||||||
|
|
||||||
Prompt definitions are YAML files anywhere under `prompt_dir`. Nested
|
Promptkit's built-in client makes up to two additional attempts for eligible
|
||||||
directories are organizational; callers select prompts by YAML `id`, not file
|
transient HTTP statuses by default. The application `transient_retries` setting
|
||||||
path.
|
changes that budget for its constructed engine; an explicit `run` request
|
||||||
|
override takes precedence. This can increase latency, request count, and cost.
|
||||||
|
Each initial or repair generation has its own transient budget; an injected
|
||||||
|
client retains its own retry behavior. The tagged integration contract owns
|
||||||
|
eligibility and timing.
|
||||||
|
|
||||||
Example:
|
Promptkit's
|
||||||
|
[OpenAI-compatible integration contract](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/docs/integrations/openai-compatible-chat.md)
|
||||||
|
defines outbound authentication, provider request mapping, transport limits,
|
||||||
|
and timeout layering.
|
||||||
|
|
||||||
```yaml
|
## Related References
|
||||||
id: generic.structured_events
|
|
||||||
version: "1.0.0"
|
|
||||||
default_profile: local-quality
|
|
||||||
description: Produce structured event JSON from a transcript.
|
|
||||||
|
|
||||||
inputs:
|
|
||||||
- name: transcript
|
|
||||||
required: true
|
|
||||||
content_type: text/markdown
|
|
||||||
description: Source transcript content
|
|
||||||
- name: glossary
|
|
||||||
required: false
|
|
||||||
content_type: text/yaml
|
|
||||||
description: Optional glossary context
|
|
||||||
|
|
||||||
messages:
|
|
||||||
- role: system
|
|
||||||
content_file: ./generic.structured_events.system.md
|
|
||||||
- role: user
|
|
||||||
content_file: ./generic.structured_events.user.md
|
|
||||||
|
|
||||||
output:
|
|
||||||
format: json
|
|
||||||
validation_mode: json_schema
|
|
||||||
schema_path: structured_events.schema.json
|
|
||||||
repair_attempts: 0
|
|
||||||
```
|
|
||||||
|
|
||||||
Prompt fields:
|
|
||||||
|
|
||||||
| Field | Required | Description |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| `id` | yes | Prompt identifier used by `--prompt` and HTTP `prompt_id`. |
|
|
||||||
| `version` | yes | Prompt version. |
|
|
||||||
| `default_profile` | no | Profile ID used when a request does not provide a profile. |
|
|
||||||
| `description` | no | Human-readable description. |
|
|
||||||
| `session_id` | no | Go-template string rendered from request vars and forwarded as provider `session_id` when non-empty. |
|
|
||||||
| `inputs` | no | Named input declarations. |
|
|
||||||
| `messages` | yes | Chat message templates. |
|
|
||||||
| `output` | yes | Output format and validation contract. |
|
|
||||||
|
|
||||||
`inputs[]` fields:
|
|
||||||
|
|
||||||
- `name` (required)
|
|
||||||
- `required` (optional boolean)
|
|
||||||
- `content_type` (optional metadata)
|
|
||||||
- `description` (optional)
|
|
||||||
|
|
||||||
`messages[]` fields:
|
|
||||||
|
|
||||||
- `role` (required)
|
|
||||||
- exactly one of `content` or `content_file`
|
|
||||||
- `cache_control` (optional)
|
|
||||||
|
|
||||||
Message rules:
|
|
||||||
|
|
||||||
- `content_file` resolves relative to the prompt YAML file location.
|
|
||||||
- Repeated roles are allowed.
|
|
||||||
- Prompt YAML decoding is strict.
|
|
||||||
- Duplicate input names are invalid.
|
|
||||||
- Duplicate prompt IDs are invalid for a requested ID/version.
|
|
||||||
|
|
||||||
`messages[].cache_control` fields:
|
|
||||||
|
|
||||||
| Field | Required | Supported values |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| `type` | yes | `ephemeral` |
|
|
||||||
| `ttl` | no | `1h` |
|
|
||||||
|
|
||||||
`session_id` behavior:
|
|
||||||
|
|
||||||
- Rendered with the same variable context as message templates.
|
|
||||||
- Trimmed and omitted when empty.
|
|
||||||
- Rejected when longer than 256 Unicode code points.
|
|
||||||
- CLI callers pass variables with `--var`; HTTP callers use `vars`.
|
|
||||||
|
|
||||||
`output` fields:
|
|
||||||
|
|
||||||
| Field | Required | Supported values |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| `format` | yes | `text`, `markdown`, `json` |
|
|
||||||
| `validation_mode` | yes | `none`, `basic`, `json`, `json_schema` |
|
|
||||||
| `schema_path` | only for `json_schema` | Relative to `schema_dir` unless absolute. |
|
|
||||||
| `repair_attempts` | yes | Integer greater than or equal to `0`. |
|
|
||||||
|
|
||||||
Repair boundary:
|
|
||||||
|
|
||||||
- `repair_attempts` is part of the prompt contract.
|
|
||||||
- The current CLI and HTTP wiring constructs the runner without a repairer, so normal `run` and `serve` execution does not perform repair attempts.
|
|
||||||
|
|
||||||
## Profile Definition Files
|
|
||||||
|
|
||||||
Execution profiles are YAML files anywhere under `profile_dir`. Nested
|
|
||||||
directories are organizational; callers select profiles by YAML `id`, not file
|
|
||||||
path.
|
|
||||||
|
|
||||||
Scriptorium also ships built-in profiles. Custom profiles override built-ins
|
|
||||||
with the same ID.
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
id: local-fast
|
|
||||||
endpoint: http://localhost:8000/v1
|
|
||||||
model: gpt-4o-mini
|
|
||||||
temperature: 0.2
|
|
||||||
max_tokens: 500
|
|
||||||
top_p: 1.0
|
|
||||||
timeout_seconds: 90
|
|
||||||
api_key_env: SCRIPTORIUM_API_KEY
|
|
||||||
service_tier: priority
|
|
||||||
reasoning_effort: medium
|
|
||||||
extra_params:
|
|
||||||
provider_route: primary
|
|
||||||
```
|
|
||||||
|
|
||||||
Profile fields:
|
|
||||||
|
|
||||||
| Field | Required | Description |
|
|
||||||
| --- | --- | --- |
|
|
||||||
| `id` | yes | Profile identifier. |
|
|
||||||
| `endpoint` | yes | OpenAI-compatible base URL including `/v1`. |
|
|
||||||
| `model` | yes | Provider model name. |
|
|
||||||
| `temperature` | no | Range `0..2`. |
|
|
||||||
| `max_tokens` | no | Integer greater than or equal to `0`. |
|
|
||||||
| `top_p` | no | Range `0..1`. |
|
|
||||||
| `timeout_seconds` | no | Integer greater than or equal to `0`. |
|
|
||||||
| `service_tier` | no | Provider-specific request tier. |
|
|
||||||
| `reasoning_effort` | no | Provider-specific reasoning setting. |
|
|
||||||
| `api_key_env` | no | Environment variable name containing the API key. |
|
|
||||||
| `extra_params` | no | JSON-compatible provider-specific top-level request fields. |
|
|
||||||
|
|
||||||
Execution defaults before profile/request overrides:
|
|
||||||
|
|
||||||
| Field | Default |
|
|
||||||
| --- | --- |
|
|
||||||
| `temperature` | `0.0` |
|
|
||||||
| `max_tokens` | `0` |
|
|
||||||
| `top_p` | `1.0` |
|
|
||||||
| `timeout_seconds` | `600` |
|
|
||||||
|
|
||||||
Profile rules:
|
|
||||||
|
|
||||||
- Profile YAML decoding is strict.
|
|
||||||
- Duplicate custom profile IDs are invalid.
|
|
||||||
- Matching custom and built-in IDs are valid override behavior.
|
|
||||||
- Raw `api_key` is rejected; use `api_key_env`.
|
|
||||||
- If `api_key_env` is set, the named environment variable must be set before `run`, `render`, or HTTP execution can prepare the request.
|
|
||||||
- Profile numeric fields merge by non-zero value. Request overrides are presence-aware, so explicit zero values are supported through CLI flags or HTTP model overrides.
|
|
||||||
- `extra_params` keys must not be empty and must not collide with reserved outbound fields: `model`, `session_id`, `messages`, `temperature`, `max_tokens`, `top_p`, `service_tier`, `reasoning_effort`, or `response_format`.
|
|
||||||
|
|
||||||
Built-in profile catalog:
|
|
||||||
|
|
||||||
| Provider | ID | Model | API key env |
|
|
||||||
| --- | --- | --- | --- |
|
|
||||||
| aion-labs | `aion-2` | `aion-labs/aion-2.0` | `OPENROUTER_API_KEY` |
|
|
||||||
| anthropic | `claude-fable-latest` | `~anthropic/claude-fable-latest` | `OPENROUTER_API_KEY` |
|
|
||||||
| anthropic | `claude-haiku-latest` | `~anthropic/claude-haiku-latest` | `OPENROUTER_API_KEY` |
|
|
||||||
| anthropic | `claude-opus-latest` | `~anthropic/claude-opus-latest` | `OPENROUTER_API_KEY` |
|
|
||||||
| anthropic | `claude-sonnet-latest` | `~anthropic/claude-sonnet-latest` | `OPENROUTER_API_KEY` |
|
|
||||||
| deepseek | `deepseek-3-2` | `deepseek/deepseek-v3.2` | `OPENROUTER_API_KEY` |
|
|
||||||
| deepseek | `deepseek-4-pro` | `deepseek/deepseek-v4-pro` | `OPENROUTER_API_KEY` |
|
|
||||||
| google | `gemini-2-flash` | `google/gemini-2.5-flash` | `OPENROUTER_API_KEY` |
|
|
||||||
| google | `gemini-2-flash-lite` | `google/gemini-2.5-flash-lite` | `OPENROUTER_API_KEY` |
|
|
||||||
| google | `gemini-2-pro` | `google/gemini-2.5-pro` | `OPENROUTER_API_KEY` |
|
|
||||||
| google | `gemini-3-flash-lite` | `google/gemini-3.1-flash-lite` | `OPENROUTER_API_KEY` |
|
|
||||||
| google | `gemini-flash-latest` | `~google/gemini-flash-latest` | `OPENROUTER_API_KEY` |
|
|
||||||
| google | `gemini-pro-latest` | `~google/gemini-pro-latest` | `OPENROUTER_API_KEY` |
|
|
||||||
| google | `gemma-4-31b` | `google/gemma-4-31b-it:exacto` | `OPENROUTER_API_KEY` |
|
|
||||||
| minimax | `minimax-m2` | `minimax/minimax-m2.5` | `OPENROUTER_API_KEY` |
|
|
||||||
| minimax | `minimax-m3` | `minimax/minimax-m3` | `OPENROUTER_API_KEY` |
|
|
||||||
| mistral | `mistral-large-2512` | `mistralai/mistral-large-2512` | `OPENROUTER_API_KEY` |
|
|
||||||
| mistral | `mistral-medium-3-5` | `mistralai/mistral-medium-3-5` | `OPENROUTER_API_KEY` |
|
|
||||||
| mistral | `mistral-small-3` | `mistralai/mistral-small-3.2-24b-instruct` | `OPENROUTER_API_KEY` |
|
|
||||||
| mistral | `mistral-small-4` | `mistralai/mistral-small-2603` | `OPENROUTER_API_KEY` |
|
|
||||||
| nvidia | `nemotron-3-ultra` | `nvidia/nemotron-3-ultra-550b-a55b` | `OPENROUTER_API_KEY` |
|
|
||||||
| openai | `gpt-5-mini` | `openai/gpt-5.4-mini` | `OPENROUTER_API_KEY` |
|
|
||||||
| openai | `gpt-5-nano` | `openai/gpt-5.4-nano` | `OPENROUTER_API_KEY` |
|
|
||||||
|
|
||||||
## Schema Behavior
|
|
||||||
|
|
||||||
Schemas are JSON files, typically under `schema_dir`.
|
|
||||||
|
|
||||||
Rules:
|
|
||||||
|
|
||||||
- `output.validation_mode: json_schema` requires `output.schema_path`.
|
|
||||||
- Relative `schema_path` values resolve from `schema_dir`.
|
|
||||||
- Absolute `schema_path` values are used directly.
|
|
||||||
- Nested schemas must be referenced by relative path; schemas are not searched recursively by basename.
|
|
||||||
- Missing or invalid schema documents are runtime validation errors.
|
|
||||||
- Invalid generated JSON produces validation status `failed`, not a runtime error.
|
|
||||||
|
|
||||||
## Artifact References
|
|
||||||
|
|
||||||
Supported request input artifact reference types are:
|
|
||||||
|
|
||||||
- `file`
|
|
||||||
- `inline`
|
|
||||||
|
|
||||||
CLI `run` and `render` create `file` references from `--input name=path`.
|
|
||||||
|
|
||||||
HTTP `file` references require `server.artifact_root` or `serve
|
|
||||||
--artifact-root`. Relative file URIs resolve under that root. Absolute paths
|
|
||||||
and relative traversal outside the root are rejected by lexical checks. Symlinks
|
|
||||||
inside the root are followed by the operating system, including symlinks that
|
|
||||||
point outside the root.
|
|
||||||
|
|
||||||
HTTP `inline` references do not require an artifact root.
|
|
||||||
|
|
||||||
## Secrets Handling
|
|
||||||
|
|
||||||
- Keep secret values in environment variables.
|
|
||||||
- Store only environment-variable names in `api_key_env`.
|
|
||||||
- Do not put raw API keys in config, prompts, profiles, CLI arguments, examples, or HTTP request bodies.
|
|
||||||
|
|
||||||
## Maintained Examples
|
|
||||||
|
|
||||||
- Minimal app config: `examples/config.yml`
|
|
||||||
- Full app config: `examples/config.full.yml`
|
|
||||||
- Prompt examples: `examples/prompts/`
|
|
||||||
- Custom profile examples: `examples/profiles/`
|
|
||||||
- Schema examples: `examples/schemas/`
|
|
||||||
- Input fixtures: `examples/fixtures/`
|
|
||||||
- Render script: `examples/render-markdown-summary.sh`
|
|
||||||
- HTTP request-shape example: `examples/http-run.json`
|
|
||||||
|
|
||||||
## Integration References
|
|
||||||
|
|
||||||
- [CLI reference](cli.md)
|
- [CLI reference](cli.md)
|
||||||
- [HTTP API reference](api.md)
|
- [HTTP API reference](api.md)
|
||||||
- [Outbound OpenAI-compatible contract](integrations/openai-compatible-chat.md)
|
- [Operations guide](operations.md)
|
||||||
|
- [Promptkit framework formats](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/docs/formats.md)
|
||||||
|
|||||||
@@ -1,122 +1,38 @@
|
|||||||
# Consumer Integration Overview
|
# Consumer Integration Overview
|
||||||
|
|
||||||
This guide is for applications that call Scriptorium from another codebase.
|
Scriptorium exposes executable interfaces. Choose between a local subprocess
|
||||||
|
and the HTTP service according to the boundary your application needs.
|
||||||
|
|
||||||
Scriptorium exposes three integration surfaces:
|
| Interface | Use when |
|
||||||
|
|
||||||
| Surface | Use when |
|
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| Go package | The consumer is Go, needs typed requests/results, or wants injected LLM clients for tests. |
|
| CLI subprocess | The consumer needs a synchronous local process boundary or prepared output. |
|
||||||
| CLI subprocess | The consumer wants process isolation or is not written in Go. |
|
| HTTP API | The consumer needs a service boundary or remote access. |
|
||||||
| HTTP API | The consumer needs a service boundary or remote access to `POST /v1/runs`. |
|
|
||||||
|
|
||||||
Canonical references:
|
- CLI subprocess: [subprocess integration](../integrations/subprocess.md)
|
||||||
|
- HTTP service: [HTTP API reference](../api.md)
|
||||||
|
- Application configuration: [configuration reference](../config.md)
|
||||||
|
|
||||||
- Go package: [Package scriptorium](pkg-scriptorium.md)
|
Go applications that need an in-process prompt framework should import
|
||||||
- CLI subprocess: [Subprocess integration](../integrations/subprocess.md)
|
Promptkit directly. The tagged
|
||||||
- HTTP: [HTTP API reference](../api.md)
|
[Promptkit Go consumer guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/docs/consumers/pkg-promptkit.md)
|
||||||
- File formats: [Configuration reference](../config.md)
|
owns that interface; Scriptorium does not provide a Go library package.
|
||||||
|
Consumers arriving from the former Scriptorium Go API should follow the
|
||||||
## Required Deployment Inputs
|
[migration guide](migrating-to-promptkit.md).
|
||||||
|
|
||||||
Every integration needs operators to provide:
|
|
||||||
|
|
||||||
- prompt definitions;
|
|
||||||
- profile definitions or built-in profile IDs;
|
|
||||||
- schema files when prompts use `json_schema`;
|
|
||||||
- input artifacts or inline input bodies;
|
|
||||||
- API-key environment variables or direct per-request keys where supported.
|
|
||||||
|
|
||||||
Raw API keys do not belong in config, prompt files, profile YAML, CLI
|
|
||||||
arguments, or HTTP request bodies.
|
|
||||||
|
|
||||||
## Recommended Workflow
|
|
||||||
|
|
||||||
Use the Go package when:
|
|
||||||
|
|
||||||
- the consumer is a Go application;
|
|
||||||
- the application needs `context.Context` cancellation;
|
|
||||||
- repeated calls should avoid subprocess startup;
|
|
||||||
- tests need a fake LLM client;
|
|
||||||
- direct per-request `RunRequest.APIKey` is required.
|
|
||||||
|
|
||||||
Use the CLI subprocess when:
|
|
||||||
|
|
||||||
- the consumer is not Go;
|
|
||||||
- process isolation is useful;
|
|
||||||
- stdout/stderr separation and exit codes are enough;
|
|
||||||
- the consumer already manages local files and environment variables.
|
|
||||||
|
|
||||||
Use HTTP when:
|
|
||||||
|
|
||||||
- Scriptorium should run as a service;
|
|
||||||
- multiple clients need a shared prompt/profile deployment;
|
|
||||||
- clients can reach a trusted, protected HTTP boundary.
|
|
||||||
|
|
||||||
## Minimal Go Example
|
|
||||||
|
|
||||||
```go
|
|
||||||
engine, err := scriptorium.NewEngine(scriptorium.Config{
|
|
||||||
PromptDir: "./examples/prompts",
|
|
||||||
ProfileDir: "./examples/profiles",
|
|
||||||
SchemaDir: "./examples/schemas",
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
prepared, err := engine.Prepare(ctx, scriptorium.RunRequest{
|
|
||||||
PromptID: "generic.markdown_summary",
|
|
||||||
Inputs: map[string]scriptorium.ArtifactRef{
|
|
||||||
"transcript": scriptorium.File("./examples/fixtures/transcript.md"),
|
|
||||||
"glossary": scriptorium.File("./examples/fixtures/glossary.yml"),
|
|
||||||
},
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
_ = prepared.Messages
|
|
||||||
```
|
|
||||||
|
|
||||||
Run the maintained package example:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
go run ./examples/go-library/prepare
|
|
||||||
```
|
|
||||||
|
|
||||||
## Subprocess Workflow
|
|
||||||
|
|
||||||
Invoke `scriptorium render` for preflight and `scriptorium run` for generation.
|
|
||||||
Capture stdout and stderr separately. Treat exit code `2` from `run` as a
|
|
||||||
completed generation with failed validation.
|
|
||||||
|
|
||||||
See [Subprocess integration](../integrations/subprocess.md) for the stable
|
|
||||||
invocation contract.
|
|
||||||
|
|
||||||
## HTTP Workflow
|
|
||||||
|
|
||||||
Run `scriptorium serve` behind trusted controls and send JSON requests to
|
|
||||||
`POST /v1/runs`.
|
|
||||||
|
|
||||||
Do not duplicate endpoint schemas in consumers. Use the [HTTP API
|
|
||||||
reference](../api.md) as the authoritative contract.
|
|
||||||
|
|
||||||
## Consumer Responsibilities
|
## Consumer Responsibilities
|
||||||
|
|
||||||
Consumers are responsible for:
|
Consumers are responsible for:
|
||||||
|
|
||||||
- selecting prompt/profile IDs as deployment configuration;
|
- selecting and deploying prompt, profile, and schema assets;
|
||||||
- supplying all required inputs and vars;
|
- supplying required inputs and template variables;
|
||||||
- protecting generated artifacts and rendered prompts as sensitive data;
|
- supplying credentials through the chosen interface;
|
||||||
- deciding whether to keep output when validation fails;
|
- protecting rendered prompts and generated artifacts as potentially
|
||||||
- implementing retries only when another model call is acceptable.
|
sensitive;
|
||||||
|
- deciding whether validation-failed output is usable; and
|
||||||
|
- retrying only when another model call is acceptable.
|
||||||
|
|
||||||
Scriptorium does not persist run state. Retrying a failed or timed-out request
|
Scriptorium does not persist run state. A retry can produce different output
|
||||||
can produce different output and can incur another provider request.
|
and can incur another provider request. CLI exits belong to the
|
||||||
|
[CLI reference](../cli.md), HTTP status behavior belongs to the
|
||||||
## Status Behavior
|
[HTTP API reference](../api.md), and framework semantics belong to
|
||||||
|
[Promptkit v0.11.0](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/docs/formats.md).
|
||||||
- Go package methods return typed results or errors that support `errors.Is`.
|
|
||||||
- CLI `run` exits `2` when generation succeeds but validation fails.
|
|
||||||
- HTTP returns `200 OK` for generated-content validation failures and exposes the failed status in the response body.
|
|
||||||
- Runtime validation failures are errors.
|
|
||||||
|
|||||||
109
docs/consumers/migrating-to-promptkit.md
Normal file
109
docs/consumers/migrating-to-promptkit.md
Normal file
@@ -0,0 +1,109 @@
|
|||||||
|
# Migrate From Scriptorium To Promptkit
|
||||||
|
|
||||||
|
## Supported Migration Boundary
|
||||||
|
|
||||||
|
Scriptorium `v0.11.1` at
|
||||||
|
`gitea.maximumdirect.net/eric/scriptorium` is the final release that provides
|
||||||
|
the former in-process Go framework. Promptkit `v0.11.0` at
|
||||||
|
`gitea.maximumdirect.net/eric/promptkit` is the destination for that framework
|
||||||
|
API. Scriptorium `v0.12.0` and later provide the CLI and HTTP application only.
|
||||||
|
|
||||||
|
There is no Scriptorium compatibility facade, alias package, forwarding
|
||||||
|
package, or deprecated wrapper. A consumer that cannot migrate may remain
|
||||||
|
pinned to Scriptorium `v0.11.1`, but that framework-bearing line does not
|
||||||
|
provide the slim application release.
|
||||||
|
|
||||||
|
## Update A Go Consumer
|
||||||
|
|
||||||
|
Start from a clean consumer checkout and review the pending diff before
|
||||||
|
committing it. Add the published Promptkit module:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
go get gitea.maximumdirect.net/eric/promptkit@v0.11.0
|
||||||
|
```
|
||||||
|
|
||||||
|
For an ordinary consumer that imports the former root package under its
|
||||||
|
default name, replace the exact import and package qualifier, then format the
|
||||||
|
changed Go files:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git grep -l \
|
||||||
|
'"gitea.maximumdirect.net/eric/scriptorium"' \
|
||||||
|
-- '*.go' |
|
||||||
|
while IFS= read -r go_file
|
||||||
|
do
|
||||||
|
perl -pi -e \
|
||||||
|
's{"gitea.maximumdirect.net/eric/scriptorium"}{"gitea.maximumdirect.net/eric/promptkit"}g; s{\bscriptorium\.}{promptkit.}g' \
|
||||||
|
"$go_file"
|
||||||
|
gofmt -w "$go_file"
|
||||||
|
done
|
||||||
|
```
|
||||||
|
|
||||||
|
Inspect the resulting diff. Consumers that used an import alias should retain
|
||||||
|
or deliberately rename that alias instead of applying the qualifier
|
||||||
|
replacement mechanically.
|
||||||
|
|
||||||
|
Remove the now-unused Scriptorium requirement through module tidiness and run
|
||||||
|
the consumer's complete tests:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
go mod tidy
|
||||||
|
go test ./...
|
||||||
|
```
|
||||||
|
|
||||||
|
Confirm that `go.mod` selects Promptkit `v0.11.0` and that no Go file imports
|
||||||
|
the former Scriptorium package:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
test "$(
|
||||||
|
go list -m -f '{{.Path}}@{{.Version}}' \
|
||||||
|
gitea.maximumdirect.net/eric/promptkit
|
||||||
|
)" = 'gitea.maximumdirect.net/eric/promptkit@v0.11.0'
|
||||||
|
if git grep -n \
|
||||||
|
'gitea.maximumdirect.net/eric/scriptorium' \
|
||||||
|
-- '*.go'
|
||||||
|
then
|
||||||
|
printf '%s\n' 'a former Scriptorium Go import remains' >&2
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
```
|
||||||
|
|
||||||
|
## Compatibility And Additions
|
||||||
|
|
||||||
|
Promptkit preserves the established engine, request, result, profile,
|
||||||
|
source-option, model-client, artifact, validation-value, and public-error
|
||||||
|
shapes where practical. Exact declarations and current behavior belong to the
|
||||||
|
tagged [Promptkit consumer guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/docs/consumers/pkg-promptkit.md)
|
||||||
|
and Go source.
|
||||||
|
|
||||||
|
Promptkit also includes migration-relevant public contracts that were not in
|
||||||
|
Scriptorium `v0.11.1`:
|
||||||
|
|
||||||
|
- [`WithArtifactReader`](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/engine.go#L169-L174)
|
||||||
|
and the
|
||||||
|
[`ArtifactReader` declaration](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/types.go#L315)
|
||||||
|
provide the artifact-reading extension described by the tagged
|
||||||
|
[extension-interface guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/docs/consumers/pkg-promptkit.md#extension-interfaces).
|
||||||
|
- [`ErrProfileRequired` and `ErrAPIKeyEnvMissing`](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/engine.go#L33-L48)
|
||||||
|
provide the specific identities described by the tagged
|
||||||
|
[error guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/docs/consumers/pkg-promptkit.md#handle-errors).
|
||||||
|
|
||||||
|
Use those tagged owners for exact signatures, wrapping guarantees, and
|
||||||
|
extension behavior.
|
||||||
|
|
||||||
|
## Verify Consumer Behavior
|
||||||
|
|
||||||
|
Source compatibility is only the first check. Exercise the behavior the
|
||||||
|
consumer actually relies upon, especially:
|
||||||
|
|
||||||
|
- prompt, profile, and schema source selection;
|
||||||
|
- direct and environment-based credentials;
|
||||||
|
- caller, generation, and transport timeout layering;
|
||||||
|
- output validation and validation-failure handling;
|
||||||
|
- injected model-client and artifact-reader extensions; and
|
||||||
|
- every `errors.Is` branch used for recovery or classification.
|
||||||
|
|
||||||
|
Also verify any serialized values, redaction expectations, filesystem policy,
|
||||||
|
and provider integration behavior that crosses the consumer's own boundary.
|
||||||
|
Promptkit owns the in-process framework contract; Scriptorium owns only its
|
||||||
|
executable CLI and HTTP application interfaces.
|
||||||
@@ -1,284 +0,0 @@
|
|||||||
# Package scriptorium
|
|
||||||
|
|
||||||
Import path:
|
|
||||||
|
|
||||||
```go
|
|
||||||
import "gitea.maximumdirect.net/eric/scriptorium"
|
|
||||||
```
|
|
||||||
|
|
||||||
The root package is the public Go facade for Scriptorium's prompt prepare/run
|
|
||||||
workflow. It exposes typed requests, results, source options, injected LLM
|
|
||||||
clients, and stable public errors while keeping `internal/*` packages private.
|
|
||||||
|
|
||||||
## Intended Use Cases
|
|
||||||
|
|
||||||
Use the package when a Go application needs:
|
|
||||||
|
|
||||||
- in-process prompt preparation or execution;
|
|
||||||
- typed request/result structs;
|
|
||||||
- direct `context.Context` cancellation;
|
|
||||||
- injected/fake LLM clients for tests;
|
|
||||||
- direct per-request `RunRequest.APIKey`.
|
|
||||||
|
|
||||||
Use [Subprocess integration](../integrations/subprocess.md) or the [HTTP API](../api.md)
|
|
||||||
when a process or service boundary is preferred.
|
|
||||||
|
|
||||||
## Construct An Engine
|
|
||||||
|
|
||||||
```go
|
|
||||||
engine, err := scriptorium.NewEngine(scriptorium.Config{
|
|
||||||
PromptDir: "./examples/prompts",
|
|
||||||
ProfileDir: "./examples/profiles",
|
|
||||||
SchemaDir: "./examples/schemas",
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
`Config` fields:
|
|
||||||
|
|
||||||
| Field | Description |
|
|
||||||
| --- | --- |
|
|
||||||
| `PromptDir` | Prompt definition directory. Required unless `WithPromptFS` or `WithPromptFile` is used. |
|
|
||||||
| `ProfileDir` | Optional custom profile directory overlaid above built-in profiles. |
|
|
||||||
| `SchemaDir` | Schema directory. Defaults to `.` when empty. |
|
|
||||||
| `Timeout` | Default timeout for the built-in OpenAI-compatible client. |
|
|
||||||
| `HTTPClient` | Optional HTTP client for the built-in OpenAI-compatible client. |
|
|
||||||
|
|
||||||
`NewEngine` accepts `nil` options and ignores them. Invalid construction wraps
|
|
||||||
`ErrInvalidConfig`.
|
|
||||||
|
|
||||||
## Source Options
|
|
||||||
|
|
||||||
Directory fields are the compatibility path. Explicit source options override
|
|
||||||
the matching directory field.
|
|
||||||
|
|
||||||
Prompt sources:
|
|
||||||
|
|
||||||
- `WithPromptFS(fsys, root)`
|
|
||||||
- `WithPromptFile(path)`
|
|
||||||
|
|
||||||
Profile sources:
|
|
||||||
|
|
||||||
- `WithProfileFS(fsys, root)`
|
|
||||||
- `WithProfileFile(path)`
|
|
||||||
- `WithProfiles(profiles...)`
|
|
||||||
|
|
||||||
Schema sources:
|
|
||||||
|
|
||||||
- `WithSchemaFS(fsys, root)`
|
|
||||||
- `WithSchemaFile(path)`
|
|
||||||
|
|
||||||
LLM source:
|
|
||||||
|
|
||||||
- `WithLLMClient(client)`
|
|
||||||
|
|
||||||
Source behavior:
|
|
||||||
|
|
||||||
- Prompt and profile YAML use the same strict rules as directory loading.
|
|
||||||
- Prompt `content_file` values resolve relative to the prompt file.
|
|
||||||
- `fs.FS` roots are containment boundaries for prompt content files and schema paths.
|
|
||||||
- File options expose the selected file by its base name.
|
|
||||||
- Profile source precedence is in-memory profiles, then explicit profile file/FS/directory source, then built-ins.
|
|
||||||
- `WithLLMClient(nil)` returns `ErrInvalidConfig`.
|
|
||||||
|
|
||||||
## In-Memory Profiles
|
|
||||||
|
|
||||||
Use `WithProfiles` when the application already has typed model settings:
|
|
||||||
|
|
||||||
```go
|
|
||||||
profile := scriptorium.OpenAICompatibleProfile(scriptorium.OpenAICompatibleProfileConfig{
|
|
||||||
ID: "app.default",
|
|
||||||
Endpoint: "https://openrouter.ai/api/v1",
|
|
||||||
Model: "mistralai/mistral-small-3.2-24b-instruct",
|
|
||||||
APIKeyRequired: true,
|
|
||||||
})
|
|
||||||
|
|
||||||
engine, err := scriptorium.NewEngine(cfg, scriptorium.WithProfiles(profile))
|
|
||||||
```
|
|
||||||
|
|
||||||
`Profile` and `OpenAICompatibleProfileConfig` include:
|
|
||||||
|
|
||||||
- `ID`
|
|
||||||
- `Endpoint`
|
|
||||||
- `Model`
|
|
||||||
- `Temperature`
|
|
||||||
- `MaxTokens`
|
|
||||||
- `TopP`
|
|
||||||
- `TimeoutSeconds`
|
|
||||||
- `ServiceTier`
|
|
||||||
- `ReasoningEffort`
|
|
||||||
- `APIKeyRequired`
|
|
||||||
- `ExtraParams`
|
|
||||||
|
|
||||||
`WithProfiles` rejects duplicate IDs in one call. In-memory profiles do not
|
|
||||||
store raw keys. When `APIKeyRequired` is true, pass the secret on each request
|
|
||||||
with `RunRequest.APIKey`.
|
|
||||||
|
|
||||||
`ExtraParams` must be JSON-compatible: strings, booleans, finite numbers,
|
|
||||||
objects with string keys, arrays/slices, and nil. Unsupported values, non-string
|
|
||||||
map keys, non-finite floats, and cycles return `ErrInvalidConfig` for profiles
|
|
||||||
or `ErrInvalidRequest` for request overrides.
|
|
||||||
|
|
||||||
## Prepare Workflow
|
|
||||||
|
|
||||||
`Prepare` resolves prompt/profile/input/schema state and renders messages
|
|
||||||
without calling an LLM.
|
|
||||||
|
|
||||||
```go
|
|
||||||
prepared, err := engine.Prepare(ctx, scriptorium.RunRequest{
|
|
||||||
PromptID: "generic.markdown_summary",
|
|
||||||
Inputs: map[string]scriptorium.ArtifactRef{
|
|
||||||
"transcript": scriptorium.File("./examples/fixtures/transcript.md"),
|
|
||||||
"glossary": scriptorium.File("./examples/fixtures/glossary.yml"),
|
|
||||||
},
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
_ = prepared.EffectiveModelParams
|
|
||||||
```
|
|
||||||
|
|
||||||
`PreparedRun` includes prompt ID/version/hash, selected profile, effective
|
|
||||||
model params, output contract, structured-output metadata, input hashes,
|
|
||||||
rendered prompt hash, rendered messages, and timing fields. It does not include
|
|
||||||
raw API-key values, model output, validation results, or internal target
|
|
||||||
presence metadata.
|
|
||||||
|
|
||||||
## Run Workflow
|
|
||||||
|
|
||||||
`Run` calls `Prepare`, invokes the configured LLM client, builds the output
|
|
||||||
artifact, and validates the output.
|
|
||||||
|
|
||||||
```go
|
|
||||||
result, err := engine.Run(ctx, scriptorium.RunRequest{
|
|
||||||
PromptID: "generic.markdown_summary",
|
|
||||||
APIKey: apiKey,
|
|
||||||
Inputs: map[string]scriptorium.ArtifactRef{
|
|
||||||
"transcript": scriptorium.File("./examples/fixtures/transcript.md"),
|
|
||||||
"glossary": scriptorium.File("./examples/fixtures/glossary.yml"),
|
|
||||||
},
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
_ = result.Artifact
|
|
||||||
```
|
|
||||||
|
|
||||||
`RunResult` includes run ID, output artifact, raw output, validation result,
|
|
||||||
prompt/profile/model metadata, effective model params, input hashes, usage, and
|
|
||||||
timing fields.
|
|
||||||
|
|
||||||
Generated-content validation failures return a successful `RunResult` with
|
|
||||||
`Validation.Status == ValidationFailed`. Runtime/schema validation errors
|
|
||||||
return an error that matches `ErrValidation`.
|
|
||||||
|
|
||||||
## Inputs
|
|
||||||
|
|
||||||
Input helpers:
|
|
||||||
|
|
||||||
- `File(path)`: file-backed artifact reference.
|
|
||||||
- `Inline(body)`: inline artifact body.
|
|
||||||
- `InlineWithURI(uri, body)`: inline artifact body with URI metadata.
|
|
||||||
|
|
||||||
Input map keys must match the prompt's expected input names.
|
|
||||||
|
|
||||||
## Injected LLM Clients
|
|
||||||
|
|
||||||
Use `WithLLMClient` for tests or custom model integrations:
|
|
||||||
|
|
||||||
```go
|
|
||||||
type fakeLLM struct{}
|
|
||||||
|
|
||||||
func (fakeLLM) Generate(ctx context.Context, req scriptorium.GenerateRequest) (*scriptorium.GenerateResponse, error) {
|
|
||||||
return &scriptorium.GenerateResponse{
|
|
||||||
Content: "generated text",
|
|
||||||
Usage: scriptorium.TokenUsage{TotalTokens: 12},
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
engine, err := scriptorium.NewEngine(cfg, scriptorium.WithLLMClient(fakeLLM{}))
|
|
||||||
```
|
|
||||||
|
|
||||||
Injected clients receive:
|
|
||||||
|
|
||||||
- rendered prompt;
|
|
||||||
- effective execution target;
|
|
||||||
- numeric target presence metadata;
|
|
||||||
- structured-output spec when applicable;
|
|
||||||
- direct request API key when provided.
|
|
||||||
|
|
||||||
Custom clients should not log raw prompts or API keys by default.
|
|
||||||
|
|
||||||
## Overrides And API Keys
|
|
||||||
|
|
||||||
`RunRequest` fields:
|
|
||||||
|
|
||||||
| Field | Description |
|
|
||||||
| --- | --- |
|
|
||||||
| `PromptID` | Prompt ID. |
|
|
||||||
| `PromptVersion` | Optional prompt version filter. |
|
|
||||||
| `ProfileID` | Optional profile override. |
|
|
||||||
| `APIKey` | Direct per-request API key. |
|
|
||||||
| `Inputs` | Input artifact references. |
|
|
||||||
| `Vars` | Template variables. |
|
|
||||||
| `Execution` | Per-request model overrides. |
|
|
||||||
| `Validation` | Per-request output contract override. |
|
|
||||||
| `Metadata` | Request metadata reserved for callers. |
|
|
||||||
|
|
||||||
`RunRequest.Execution` uses pointer fields for numeric values so explicit zero
|
|
||||||
overrides are preserved:
|
|
||||||
|
|
||||||
```go
|
|
||||||
zero := 0
|
|
||||||
req.Execution = &scriptorium.ExecutionTargetOverride{
|
|
||||||
MaxTokens: &zero,
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Direct `RunRequest.APIKey` takes precedence over profile `api_key_env` for the
|
|
||||||
default OpenAI-compatible client. It is request-scoped, uses `json:"-"`, and is
|
|
||||||
not included in `PreparedRun` or `RunResult` JSON. Normal Go string formatting
|
|
||||||
of `RunRequest` and `GenerateRequest` reports only whether a direct key is set.
|
|
||||||
|
|
||||||
Raw API keys do not belong in profile YAML, in-memory profiles, or app config.
|
|
||||||
Avoid reflection-based debug dumps of request structs because exported fields
|
|
||||||
remain visible to tools that bypass `String` and `GoString`.
|
|
||||||
|
|
||||||
## Errors
|
|
||||||
|
|
||||||
Public methods wrap context while preserving stable sentinel checks with
|
|
||||||
`errors.Is`:
|
|
||||||
|
|
||||||
- `ErrInvalidConfig`
|
|
||||||
- `ErrInvalidRequest`
|
|
||||||
- `ErrPromptNotFound`
|
|
||||||
- `ErrProfileNotFound`
|
|
||||||
- `ErrPromptLoad`
|
|
||||||
- `ErrProfileLoad`
|
|
||||||
- `ErrArtifactLoad`
|
|
||||||
- `ErrPromptRender`
|
|
||||||
- `ErrLLMGenerate`
|
|
||||||
- `ErrValidation`
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
```go
|
|
||||||
if errors.Is(err, scriptorium.ErrPromptNotFound) {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Examples
|
|
||||||
|
|
||||||
Run the maintained prepare-only example from the repository root:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
go run ./examples/go-library/prepare
|
|
||||||
```
|
|
||||||
|
|
||||||
See also:
|
|
||||||
|
|
||||||
- [Configuration reference](../config.md)
|
|
||||||
- [Consumer integration overview](api.md)
|
|
||||||
59
docs/development.md
Normal file
59
docs/development.md
Normal file
@@ -0,0 +1,59 @@
|
|||||||
|
# Development
|
||||||
|
|
||||||
|
This is the contributor entry point for Scriptorium. Scriptorium is an
|
||||||
|
application that consumes the public
|
||||||
|
[Promptkit v0.11.0 package](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/docs/consumers/pkg-promptkit.md);
|
||||||
|
framework implementation work belongs in Promptkit. Application configuration
|
||||||
|
uses ConfigKit v0.4.0; keep Scriptorium's schema and source selection local.
|
||||||
|
|
||||||
|
## Initial Orientation
|
||||||
|
|
||||||
|
Before recommending, planning, or implementing work:
|
||||||
|
|
||||||
|
1. read the [agent policy](policy/agents.md);
|
||||||
|
2. inspect the working tree and preserve unrelated changes;
|
||||||
|
3. read the [architecture policy](policy/architecture.md);
|
||||||
|
4. follow the task-specific contracts and internal documents below; and
|
||||||
|
5. inspect the relevant implementation and tests before changing them.
|
||||||
|
|
||||||
|
Also read the [documentation policy](policy/documentation.md) before changing
|
||||||
|
documentation and the [testing policy](policy/testing.md) before changing
|
||||||
|
tests.
|
||||||
|
|
||||||
|
## Task-Specific Reading Guide
|
||||||
|
|
||||||
|
| Task | Read before changing |
|
||||||
|
| --- | --- |
|
||||||
|
| Repository orientation or component responsibility | [Internal component overview](internal/overview.md) and [architecture policy](policy/architecture.md) |
|
||||||
|
| CLI commands, flags, output, or exit behavior | [CLI contract](cli.md) and [adapter internals](internal/adapters.md) |
|
||||||
|
| HTTP routes, DTOs, limits, status mapping, or artifact policy | [HTTP API contract](api.md), [adapter internals](internal/adapters.md), and [source internals](internal/sources.md) |
|
||||||
|
| 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` |
|
||||||
|
| Prompt, profile, schema, generation, or validation semantics | [Promptkit framework formats](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/docs/formats.md) and the [Promptkit consumer guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/docs/consumers/pkg-promptkit.md) |
|
||||||
|
| OpenAI-compatible outbound behavior or timeout layering | [Promptkit integration contract](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/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 format contract](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/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
|
||||||
|
the tagged version. Do not commit a Go workspace, local replacement, vendored
|
||||||
|
Promptkit source, or an import of a Promptkit `internal` package.
|
||||||
|
|
||||||
|
## Baseline Validation
|
||||||
|
|
||||||
|
For code changes, run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
go test ./...
|
||||||
|
go test -race ./...
|
||||||
|
go vet ./...
|
||||||
|
go build ./cmd/scriptorium
|
||||||
|
```
|
||||||
|
|
||||||
|
Check formatting with `gofmt`, run `git diff --check`, and validate affected
|
||||||
|
examples and documentation links. Documentation-only work does not require
|
||||||
|
unrelated new tests, but commands and examples changed by documentation must be
|
||||||
|
run.
|
||||||
@@ -1,193 +0,0 @@
|
|||||||
# OpenAI-Compatible Chat Integration
|
|
||||||
|
|
||||||
## Scope
|
|
||||||
|
|
||||||
This document defines the outbound LLM contract implemented by `internal/llm/openai_compatible_client.go`.
|
|
||||||
|
|
||||||
It documents only fields and behaviors currently serialized by code.
|
|
||||||
|
|
||||||
## Endpoint Construction
|
|
||||||
|
|
||||||
Request endpoint is built as:
|
|
||||||
|
|
||||||
1. choose base URL:
|
|
||||||
- `GenerateRequest.Target.Endpoint` if set
|
|
||||||
- otherwise client config `BaseURL`
|
|
||||||
2. trim trailing slash
|
|
||||||
3. append `/chat/completions`
|
|
||||||
|
|
||||||
Example:
|
|
||||||
|
|
||||||
- base URL: `http://localhost:8000/v1`
|
|
||||||
- final URL: `http://localhost:8000/v1/chat/completions`
|
|
||||||
|
|
||||||
## Request Fields Sent
|
|
||||||
|
|
||||||
Serialized JSON fields:
|
|
||||||
|
|
||||||
- `model` (required after fallback resolution)
|
|
||||||
- `session_id` (only when the rendered prompt includes a non-empty session ID)
|
|
||||||
- `messages` (rendered prompt messages)
|
|
||||||
- `temperature` (when non-zero, or when explicitly overridden to zero)
|
|
||||||
- `max_tokens` (when non-zero, or when explicitly overridden to zero)
|
|
||||||
- `top_p` (when non-zero, or when explicitly overridden to zero)
|
|
||||||
- `service_tier` (only when non-empty)
|
|
||||||
- `reasoning_effort` (only when non-empty)
|
|
||||||
- `response_format` (only when structured output is provided)
|
|
||||||
- profile/request `extra_params` as additional provider-specific top-level fields
|
|
||||||
|
|
||||||
`service_tier` is provider-specific. OpenRouter currently documents request values such as `flex` and `priority`; Scriptorium forwards any non-empty configured value and lets the backend validate support.
|
|
||||||
|
|
||||||
`reasoning_effort` is provider-specific. Scriptorium forwards any non-empty configured value as top-level `reasoning_effort` and lets the backend validate support.
|
|
||||||
|
|
||||||
`extra_params` are flattened into the outbound JSON object. They are not wrapped in an `extra_params` object:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"model": "gpt-4o-mini",
|
|
||||||
"messages": [
|
|
||||||
{
|
|
||||||
"role": "user",
|
|
||||||
"content": "rendered text"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"provider_route": "primary",
|
|
||||||
"provider_options": {
|
|
||||||
"retry_budget": 2
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
`extra_params` values must be JSON-compatible. Supported value shapes include strings, numbers, booleans, objects, and arrays.
|
|
||||||
|
|
||||||
Reserved `extra_params` keys are rejected before the HTTP request is made:
|
|
||||||
|
|
||||||
- `model`
|
|
||||||
- `session_id`
|
|
||||||
- `messages`
|
|
||||||
- `temperature`
|
|
||||||
- `max_tokens`
|
|
||||||
- `top_p`
|
|
||||||
- `service_tier`
|
|
||||||
- `reasoning_effort`
|
|
||||||
- `response_format`
|
|
||||||
|
|
||||||
Empty `extra_params` keys and values that cannot be encoded as JSON are also rejected before the HTTP request is made.
|
|
||||||
|
|
||||||
`session_id` is rendered from prompt YAML using request variables and serialized as a top-level JSON request field. Scriptorium does not send an `x-session-id` header. Empty rendered session IDs are omitted, and values longer than 256 characters are rejected before the HTTP request.
|
|
||||||
|
|
||||||
Messages without prompt cache control serialize with string `content`:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"role": "system",
|
|
||||||
"content": "rendered text"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Messages with prompt cache control serialize as a single text content-block array:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"role": "system",
|
|
||||||
"content": [
|
|
||||||
{
|
|
||||||
"type": "text",
|
|
||||||
"text": "rendered text",
|
|
||||||
"cache_control": {
|
|
||||||
"type": "ephemeral",
|
|
||||||
"ttl": "1h"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
When cache-control `ttl` is unset in the prompt definition, `ttl` is omitted from the outbound payload.
|
|
||||||
|
|
||||||
Structured output is currently `json_schema` only, serialized as:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"response_format": {
|
|
||||||
"type": "json_schema",
|
|
||||||
"json_schema": {
|
|
||||||
"name": "...",
|
|
||||||
"strict": true,
|
|
||||||
"schema": {"type": "object"}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
## Authentication Header
|
|
||||||
|
|
||||||
If `Target.APIKey` is set:
|
|
||||||
|
|
||||||
- set `Authorization: Bearer <value>`
|
|
||||||
- do not read `Target.APIKeyEnv`
|
|
||||||
|
|
||||||
If `Target.APIKey` is empty and `Target.APIKeyEnv` is set:
|
|
||||||
|
|
||||||
- resolve environment variable value at request time
|
|
||||||
- set `Authorization: Bearer <value>`
|
|
||||||
|
|
||||||
If the environment variable is unset/empty:
|
|
||||||
|
|
||||||
- request fails before HTTP call (`ErrInvalidRequest`)
|
|
||||||
|
|
||||||
If both `Target.APIKey` and `Target.APIKeyEnv` are empty:
|
|
||||||
|
|
||||||
- no `Authorization` header is sent
|
|
||||||
|
|
||||||
## Timeout Behavior
|
|
||||||
|
|
||||||
Base timeout comes from client configuration.
|
|
||||||
|
|
||||||
Per-request override:
|
|
||||||
|
|
||||||
- if `Target.TimeoutSeconds > 0`, use that value for request timeout
|
|
||||||
- if `Target.TimeoutSeconds == 0` and the value came from an explicit request override, disable the HTTP client timeout
|
|
||||||
- if `Target.TimeoutSeconds < 0`, request is rejected (`ErrInvalidRequest`)
|
|
||||||
|
|
||||||
## Response Expectations
|
|
||||||
|
|
||||||
Expected successful response shape (subset used):
|
|
||||||
|
|
||||||
- `choices[0].message.content`
|
|
||||||
- `usage.prompt_tokens`
|
|
||||||
- `usage.completion_tokens`
|
|
||||||
- `usage.total_tokens`
|
|
||||||
- `usage.prompt_tokens_details.cached_tokens` (optional)
|
|
||||||
- `usage.cache_write_tokens` (optional)
|
|
||||||
|
|
||||||
Absent cache usage fields are treated as zero. Parsed cache usage is exposed through run results and adapter response surfaces as:
|
|
||||||
|
|
||||||
- `cached_tokens`
|
|
||||||
- `cache_write_tokens`
|
|
||||||
|
|
||||||
Malformed response conditions include:
|
|
||||||
|
|
||||||
- invalid JSON
|
|
||||||
- empty `choices`
|
|
||||||
- empty `choices[0].message.content`
|
|
||||||
|
|
||||||
Malformed responses return `ErrMalformedResponse`.
|
|
||||||
|
|
||||||
## Error Handling
|
|
||||||
|
|
||||||
- network/request-construction failures: `ErrRequestFailed`
|
|
||||||
- non-2xx HTTP status: `ErrUnexpectedStatus` (includes status code; provider response bodies are not included)
|
|
||||||
- malformed response shape/content: `ErrMalformedResponse`
|
|
||||||
|
|
||||||
## Unsupported Or Non-Serialized Fields
|
|
||||||
|
|
||||||
The client does not serialize top-level `cache_control`.
|
|
||||||
|
|
||||||
No built-in retries, tool-calls, or multi-request payload modes are implemented in this client.
|
|
||||||
|
|
||||||
## Relationship To Runner
|
|
||||||
|
|
||||||
When prompt validation mode is `json_schema`, runner prepares a structured-output schema spec and passes it to the client as `StructuredOutput`.
|
|
||||||
|
|
||||||
The client only serializes the provider request payload; it does not load schema files itself.
|
|
||||||
@@ -1,130 +1,63 @@
|
|||||||
# Subprocess Integration
|
# Subprocess Integration
|
||||||
|
|
||||||
This document defines the supported subprocess contract for downstream
|
This document covers process-boundary behavior for callers that invoke
|
||||||
applications invoking Scriptorium through the public CLI.
|
Scriptorium as a child process. Command syntax, flags, output, and exit codes
|
||||||
|
are defined by the [CLI reference](../cli.md). Interface selection belongs in
|
||||||
|
the [consumer integration overview](../consumers/api.md).
|
||||||
|
|
||||||
This is a CLI contract. Go callers that want an in-process typed API should use
|
## Process Contract
|
||||||
the [package guide](../consumers/pkg-scriptorium.md).
|
|
||||||
|
|
||||||
## Supported Commands
|
Use `scriptorium render` when the caller needs prepared output without a model
|
||||||
|
call, and `scriptorium run` for generation. Pass an explicit `--config` or
|
||||||
|
make the configuration search paths available to the child process; configuration
|
||||||
|
discovery, fields, profile selection, and credential mechanisms are defined in
|
||||||
|
the [configuration reference](../config.md).
|
||||||
|
|
||||||
Downstream applications should invoke:
|
Pass required API-key environment variables through the child environment. Do
|
||||||
|
not place raw API keys in arguments. Keep the environment limited to the values
|
||||||
|
needed for the selected profile.
|
||||||
|
|
||||||
- `scriptorium render` for preflight/debug output without LLM execution.
|
For application-only preflight, invoke `scriptorium config validate`; it exits
|
||||||
- `scriptorium run` for generation.
|
0 with empty stdout when the application configuration loads, but does not
|
||||||
|
prove that Promptkit sources or credentials are usable. `config show` emits
|
||||||
|
resolved YAML and `config sources` emits newline-terminated JSON provenance.
|
||||||
|
All three use the same source selection and explicit overrides as execution
|
||||||
|
commands and require separate stderr capture for diagnostics. Their output can
|
||||||
|
include source paths, identifiers, credential reference names, and ordinary
|
||||||
|
backend parameters; treat it as potentially sensitive.
|
||||||
|
|
||||||
`scriptorium serve` is an HTTP service command, not the recommended subprocess
|
## Streams And Output Ownership
|
||||||
contract for per-request execution.
|
|
||||||
|
|
||||||
## Recommended Invocation Shapes
|
Capture stdout and stderr separately. Stdout contains the requested artifact or
|
||||||
|
prepared output unless the caller selects an output file; stderr contains
|
||||||
|
summaries, diagnostics, and server messages. The exact destinations and status
|
||||||
|
meanings are part of the [CLI reference](../cli.md), not a stable stderr data
|
||||||
|
protocol.
|
||||||
|
|
||||||
Render:
|
When using `--out`, the caller owns the output path, its permissions, and
|
||||||
|
cleanup. Treat rendered prompts, generated artifacts, stdout, and stderr as
|
||||||
|
potentially sensitive.
|
||||||
|
|
||||||
```bash
|
For `run`, an optional [execution report file](../cli.md) contains terminal
|
||||||
scriptorium render \
|
metadata separate from generated stdout or `--out`. The caller owns that
|
||||||
--config <config_path> \
|
path's permissions and retention. Output and report files are not a
|
||||||
--prompt <prompt_id> \
|
transaction: one may be written when the other fails, and a preexisting report
|
||||||
--input transcript=<path> \
|
may remain when the invocation has no terminal event. Check the exit status
|
||||||
--format json
|
and diagnostics rather than assuming a report path contains this run's data.
|
||||||
```
|
|
||||||
|
|
||||||
Run:
|
## Cancellation And Recovery
|
||||||
|
|
||||||
```bash
|
A CLI invocation performs one synchronous request and creates no durable run
|
||||||
scriptorium run \
|
state. A supervising process that needs cancellation must terminate the child
|
||||||
--config <config_path> \
|
process according to its own process-management policy. A later invocation is a
|
||||||
--prompt <prompt_id> \
|
new request and can make another model call; there is no resume or checkpoint
|
||||||
--input transcript=<path> \
|
protocol.
|
||||||
--out <artifact_path>
|
|
||||||
```
|
|
||||||
|
|
||||||
Callers may add:
|
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 deadline failure exits 1;
|
||||||
|
supervisors still own process termination when they need to stop the child
|
||||||
|
outside that engine interval.
|
||||||
|
|
||||||
- `--profile <profile_id>`
|
For deployment, filesystem permissions, and sensitive-artifact handling, see
|
||||||
- repeatable `--input name=path`
|
the [operations guide](../operations.md).
|
||||||
- repeatable `--var name=value`
|
|
||||||
- runtime overrides when explicitly needed, such as `--model`, `--llm-base-url`, `--api-key-env`, and `--timeout`
|
|
||||||
|
|
||||||
Do not pass raw API keys as command arguments.
|
|
||||||
|
|
||||||
## Config And Directory Behavior
|
|
||||||
|
|
||||||
Callers can rely on resolved app config or pass explicit paths.
|
|
||||||
|
|
||||||
Default config search order:
|
|
||||||
|
|
||||||
1. `/usr/local/etc/scriptorium/config.yml`
|
|
||||||
2. `/etc/scriptorium/config.yml`
|
|
||||||
|
|
||||||
Rules:
|
|
||||||
|
|
||||||
- Explicit `--config` requires file existence and valid syntax.
|
|
||||||
- CLI flags override config values.
|
|
||||||
- `run` and `render` require an effective `prompt_dir`.
|
|
||||||
- `profile_dir` is optional because built-in profiles are available.
|
|
||||||
|
|
||||||
## Profile Selection
|
|
||||||
|
|
||||||
Profile selection follows runner behavior:
|
|
||||||
|
|
||||||
1. explicit `--profile`
|
|
||||||
2. prompt `default_profile`
|
|
||||||
3. error if neither is available
|
|
||||||
|
|
||||||
Treat prompt and profile IDs as deployment configuration, not hardcoded business
|
|
||||||
logic.
|
|
||||||
|
|
||||||
## Input And Variable Contract
|
|
||||||
|
|
||||||
- Inputs use repeated `--input name=path`.
|
|
||||||
- Input names must match prompt definition input names.
|
|
||||||
- Variables use repeated `--var name=value`.
|
|
||||||
- Both flags also accept comma-separated mappings.
|
|
||||||
- Prefer file inputs for large content.
|
|
||||||
|
|
||||||
CLI inputs are file references. HTTP-only `inline` references are documented in
|
|
||||||
the [HTTP API reference](../api.md).
|
|
||||||
|
|
||||||
## Environment Contract
|
|
||||||
|
|
||||||
- Pass through required API-key environment variables referenced by `api_key_env`.
|
|
||||||
- Keep subprocess environments scoped to required variables.
|
|
||||||
- Use `--api-key-env` only to name an environment variable.
|
|
||||||
- Never pass raw API keys via argv.
|
|
||||||
|
|
||||||
## Stdout And Stderr
|
|
||||||
|
|
||||||
`run`:
|
|
||||||
|
|
||||||
- stdout: generated artifact body unless `--out` is used.
|
|
||||||
- stderr: success summary and errors.
|
|
||||||
|
|
||||||
`render`:
|
|
||||||
|
|
||||||
- stdout: prepared-run output unless `--out` is used.
|
|
||||||
- stderr: errors.
|
|
||||||
|
|
||||||
Capture stdout and stderr separately. Do not parse stderr as a stable data
|
|
||||||
format beyond exit status handling.
|
|
||||||
|
|
||||||
## Exit Status Contract
|
|
||||||
|
|
||||||
- `0`: success.
|
|
||||||
- `1`: parse, config, load, render, generation, IO, or runtime error.
|
|
||||||
- `2`: `run` completed and output was written, but validation failed.
|
|
||||||
|
|
||||||
A `run` exit code `2` can still produce output on stdout or at `--out`.
|
|
||||||
Consumers must decide whether to keep or discard that output.
|
|
||||||
|
|
||||||
## Security Notes
|
|
||||||
|
|
||||||
- Treat generated artifacts, rendered prompts, stdout, and stderr as potentially sensitive.
|
|
||||||
- Use controlled output paths and access controls for persisted artifacts.
|
|
||||||
- Avoid logging full rendered prompts or generated artifacts by default.
|
|
||||||
|
|
||||||
## Canonical References
|
|
||||||
|
|
||||||
- CLI behavior: [CLI reference](../cli.md)
|
|
||||||
- Config and file formats: [Configuration reference](../config.md)
|
|
||||||
- Operations: [Operations guide](../operations.md)
|
|
||||||
- Troubleshooting: [Troubleshooting](../troubleshooting.md)
|
|
||||||
|
|||||||
@@ -2,154 +2,135 @@
|
|||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
|
|
||||||
Adapters translate external interfaces into domain requests and translate domain results back out. They wire dependencies, apply app config, and own IO concerns, but they do not make runner decisions.
|
Scriptorium adapters translate executable inputs into Promptkit public requests
|
||||||
|
and translate Promptkit results or errors back to CLI or HTTP behavior. They
|
||||||
|
own IO and presentation mechanics, not framework decisions.
|
||||||
|
|
||||||
Source-loading behavior belongs in `docs/internal/sources.md`. User-facing CLI, HTTP, and package contracts belong in `docs/cli.md`, `docs/api.md`, and `docs/consumers/pkg-scriptorium.md`.
|
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://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/docs/consumers/pkg-promptkit.md).
|
||||||
|
|
||||||
## Adapter Map
|
## Components And Collaborators
|
||||||
|
|
||||||
- `cmd/scriptorium`: process entrypoint.
|
- `cmd/scriptorium` passes process arguments and streams to
|
||||||
- `internal/adapter/cli`: command parsing, config handoff, runner construction, stdout/stderr, exit codes.
|
`internal/adapter/cli`.
|
||||||
- `internal/adapter/http`: `POST /v1/runs` request/response mapping and HTTP error/status mapping.
|
- `internal/adapter/cli` resolves settings through `internal/config`,
|
||||||
- root package `scriptorium`: public Go facade over internal runner types and dependencies.
|
constructs `promptkit.Engine`, maps CLI values to `promptkit.RunRequest`,
|
||||||
|
and owns output files, summaries, and exit codes.
|
||||||
|
- `internal/config` delegates application YAML decoding, default resolution,
|
||||||
|
overrides, and validation ordering to ConfigKit. The CLI supplies only
|
||||||
|
explicitly visited application flags as overrides and renders safe structured
|
||||||
|
load diagnostics on stderr.
|
||||||
|
- `internal/adapter/http` strictly decodes request DTOs, maps them to Promptkit
|
||||||
|
public values, calls its adapter-owned `Runner` interface, and maps results
|
||||||
|
and errors to HTTP DTOs.
|
||||||
|
- `internal/format` renders `promptkit.PreparedRun` values as deterministic text
|
||||||
|
or JSON.
|
||||||
|
- `internal/report` maps Promptkit's terminal execution event to a small
|
||||||
|
application-owned value without invoking the engine or writing output.
|
||||||
|
|
||||||
Supporting implementation packages used during adapter wiring:
|
## Wiring Flows
|
||||||
|
|
||||||
- `internal/config`
|
### CLI
|
||||||
- `internal/defaults`
|
|
||||||
- `internal/format`
|
|
||||||
- `internal/llm`
|
|
||||||
- `internal/prompt`
|
|
||||||
|
|
||||||
## Inputs And Outputs
|
`run` calls `promptkit.Engine.Run`; `render` calls
|
||||||
|
`promptkit.Engine.Prepare`. Both share request mapping for prompt ID/version
|
||||||
|
and profile selection, optional file inputs, variables, and presence-aware
|
||||||
|
execution overrides. Omitted framework settings remain zero values so Promptkit
|
||||||
|
resolves its own defaults and definition-required inputs.
|
||||||
|
The application retry setting enters shared engine construction, while a
|
||||||
|
run/render flag enters only the mapped request. The server uses the same engine
|
||||||
|
setting and retains one backend admission state. Render prepares without
|
||||||
|
generation.
|
||||||
|
|
||||||
CLI adapter:
|
`inspect prompt` maps the selected ID and optional version to
|
||||||
|
`promptkit.Engine.InspectPrompt`, then formats Scriptorium-owned inspection
|
||||||
|
data. It constructs the same configuration-aware engine but does not perform
|
||||||
|
preparation or generation.
|
||||||
|
|
||||||
- Input: process args, optional config file, filesystem sources, environment variables.
|
`inspect profile` maps an explicit profile ID to `Engine.InspectProfile` and
|
||||||
- Output: process exit code, stdout artifact/prepared output, stderr summaries and errors.
|
formats a safe application-owned effective profile view. It intentionally does
|
||||||
|
not require prompt, schema, or artifact sources.
|
||||||
|
|
||||||
HTTP adapter:
|
The `config` family loads the same application ConfigKit result once and uses
|
||||||
|
its validation, effective-output, source, and explanation views directly. It
|
||||||
|
does not construct a Promptkit engine. The CLI maps source records into a small
|
||||||
|
JSON DTO for `sources`; `show` and `explain` use ConfigKit's own writers.
|
||||||
|
|
||||||
- Input: HTTP request method/path/headers/body for `POST /v1/runs`.
|
`serve` constructs Scriptorium's restricted HTTP artifact reader, injects it
|
||||||
- Output: JSON success or error body with mapped status code.
|
with `promptkit.WithArtifactReader`, passes the engine through the HTTP
|
||||||
|
adapter's consumer-owned `Runner` interface, and starts the server.
|
||||||
|
|
||||||
Public Go facade:
|
The command paths assemble the engine from the same resolved prompt, profile,
|
||||||
|
and schema directories plus configured custom backends. Each backend is mapped
|
||||||
|
to Promptkit's public `Backend` value and registered during engine construction,
|
||||||
|
so one constructed server engine retains one immutable backend registry and its
|
||||||
|
associated capacity state.
|
||||||
|
|
||||||
- Input: typed `scriptorium.Config`, `Option`, and `RunRequest` values.
|
### HTTP
|
||||||
- Output: typed `PreparedRun` and `RunResult` values plus public sentinel errors.
|
|
||||||
|
|
||||||
## Boundaries
|
The handler enforces transport limits and strict JSON decoding before mapping
|
||||||
|
DTOs into `promptkit.RunRequest`, `promptkit.ArtifactRef`, and
|
||||||
|
`promptkit.ExecutionTargetOverride`. On success it reads Promptkit artifact,
|
||||||
|
validation, model, usage, and metadata values directly.
|
||||||
|
The optional HTTP retry count maps to `RunRequest.TransientRetries` without
|
||||||
|
mutating the shared engine. Negative values are rejected before invocation;
|
||||||
|
Promptkit controls retries and backend admission for concurrent requests.
|
||||||
|
|
||||||
- Adapters convert external shapes to `domain.RunRequest` and back.
|
Failure mapping uses `errors.Is` against Promptkit's public sentinels and the
|
||||||
- Runner orchestration remains in `internal/usecase`.
|
HTTP reader's Scriptorium-owned containment and size errors. Wrapped reader
|
||||||
- Prompt/profile/schema/artifact source rules remain in repository, validator, and artifact packages.
|
errors preserve their identity through Promptkit's artifact-load boundary.
|
||||||
- LLM provider request serialization remains in `internal/llm`.
|
|
||||||
- Public package types are facade types; internal domain types do not leak across the package boundary.
|
|
||||||
|
|
||||||
## Config Fields Used
|
The report collector is per invocation. It ignores nonterminal events and
|
||||||
|
copies terminal aggregates once, including usage presence and completeness.
|
||||||
|
It retains no history or shared state; adapters decide whether to attach it and
|
||||||
|
how to present its snapshot.
|
||||||
|
CLI `run` attaches one only when a report path is selected, writes generated
|
||||||
|
output first on success, and then writes the terminal snapshot when present.
|
||||||
|
Its report path remains untouched for pre-invocation failures or absent
|
||||||
|
terminal observations; report and artifact writes are independent.
|
||||||
|
HTTP `POST /v1/runs` attaches a separate collector to each invocation only when
|
||||||
|
`include_execution_report` is true. Its optional top-level `execution` field
|
||||||
|
appears in success or error envelopes only when Promptkit emits a terminal
|
||||||
|
event. Pre-invocation adapter errors and absent terminal events leave it out.
|
||||||
|
The complete serialized success or report-bearing error response is subject to
|
||||||
|
the configured response-size limit; overflow returns the compact 413 error
|
||||||
|
without a report. Field meanings are owned by the [API contract](../api.md#execution-report).
|
||||||
|
|
||||||
Adapter app settings:
|
## Package-Local Guarantees
|
||||||
|
|
||||||
- `prompt_dir`
|
- Adapters contain no copied framework types or orchestration.
|
||||||
- `profile_dir`
|
- Configuration is resolved before Promptkit engine construction.
|
||||||
- `schema_dir`
|
- Explicit numeric overrides preserve presence, including zero.
|
||||||
- `server.addr`
|
- HTTP DTO and error mapping remains stable and transport-owned.
|
||||||
- `server.artifact_root`
|
- Resolved secrets are not serialized or printed.
|
||||||
- `server.max_request_bytes`
|
- No adapter creates durable run state.
|
||||||
- `server.max_artifact_bytes`
|
|
||||||
- `server.max_response_bytes`
|
|
||||||
- `defaults.render_format`
|
|
||||||
|
|
||||||
Execution request/profile settings passed through the runner:
|
## Verification
|
||||||
|
|
||||||
- `endpoint`
|
Inspect:
|
||||||
- `model`
|
|
||||||
- `temperature`
|
|
||||||
- `max_tokens`
|
|
||||||
- `top_p`
|
|
||||||
- `timeout_seconds`
|
|
||||||
- `service_tier`
|
|
||||||
- `api_key_env`
|
|
||||||
- `reasoning_effort`
|
|
||||||
- `extra_params`
|
|
||||||
|
|
||||||
CLI and HTTP preserve numeric override presence so omitted values and explicit zero values remain distinct.
|
|
||||||
|
|
||||||
## CLI Adapter
|
|
||||||
|
|
||||||
Implemented commands:
|
|
||||||
|
|
||||||
- `run`
|
|
||||||
- `render`
|
|
||||||
- `serve`
|
|
||||||
|
|
||||||
Behavior:
|
|
||||||
|
|
||||||
- `run` constructs a runner with direct filesystem artifact reading and calls `Runner.Run`.
|
|
||||||
- `render` constructs a runner and calls `Runner.Prepare`; it does not call the LLM.
|
|
||||||
- `serve` constructs a restricted artifact reader and HTTP handler, then starts an unauthenticated HTTP server.
|
|
||||||
- `run` exits `2` when generation succeeds but validation fails.
|
|
||||||
- parse, runtime, and output-write errors exit `1`.
|
|
||||||
- deprecated `--prompt-id` and `--profile-id` aliases are accepted.
|
|
||||||
|
|
||||||
## HTTP Adapter
|
|
||||||
|
|
||||||
Behavior:
|
|
||||||
|
|
||||||
- Accepts only `POST /v1/runs`.
|
|
||||||
- Decodes JSON strictly and rejects unknown fields and trailing JSON tokens.
|
|
||||||
- Rejects empty `prompt_id` and empty `inputs` before calling the runner.
|
|
||||||
- Does not accept raw API key values in the request body.
|
|
||||||
- Returns validation failures as `200` responses with failed validation details.
|
|
||||||
- Maps request-body, artifact, and encoded-response size failures to `413`.
|
|
||||||
- Maps domain and repository errors to stable error codes without returning wrapped internal cause text.
|
|
||||||
|
|
||||||
The HTTP adapter has no built-in authentication or authorization. Deployment controls must be provided outside the process.
|
|
||||||
|
|
||||||
## Public Go Facade
|
|
||||||
|
|
||||||
Behavior:
|
|
||||||
|
|
||||||
- `NewEngine` wires the same default runner components as CLI/HTTP unless options override them.
|
|
||||||
- Prompt, profile, and schema sources may come from directories, single files, or `fs.FS` roots.
|
|
||||||
- `WithProfiles` adds in-memory profiles ahead of file-backed and built-in profiles.
|
|
||||||
- `WithLLMClient` injects custom model behavior.
|
|
||||||
- `RunRequest.APIKey` is request-scoped and direct; it is used only for generation and is stripped from public results.
|
|
||||||
- internal errors are mapped to public sentinels in `errors.go`.
|
|
||||||
|
|
||||||
## Failure Behavior
|
|
||||||
|
|
||||||
Adapters should:
|
|
||||||
|
|
||||||
- keep external error payloads concise and stable.
|
|
||||||
- avoid leaking raw secret values.
|
|
||||||
- use sentinels and typed errors for mapping.
|
|
||||||
- preserve strict external input decoding.
|
|
||||||
- keep validation content failures distinct from runtime errors.
|
|
||||||
|
|
||||||
CLI writes human-readable summaries to stderr. HTTP writes JSON error envelopes. The public Go facade returns typed errors.
|
|
||||||
|
|
||||||
## State And Manifests
|
|
||||||
|
|
||||||
Adapters do not add durable run state.
|
|
||||||
|
|
||||||
- No adapter writes run manifests.
|
|
||||||
- No adapter implements checkpoint, skip, or resume behavior.
|
|
||||||
- CLI output files are caller-selected artifacts, not internal state.
|
|
||||||
|
|
||||||
## Tests To Inspect
|
|
||||||
|
|
||||||
- `internal/adapter/cli/run_test.go`
|
- `internal/adapter/cli/run_test.go`
|
||||||
- `internal/adapter/http/handler_test.go`
|
- `internal/adapter/http/handler_test.go`
|
||||||
- `engine_test.go`
|
- `internal/adapter/http/artifact_reader_test.go`
|
||||||
- `internal/format/prepared_run_test.go`
|
- `internal/format/prepared_run_test.go`
|
||||||
- `internal/llm/openai_compatible_client_test.go`
|
- `internal/adapter/dependency_test.go`
|
||||||
|
|
||||||
## Architectural Invariants
|
The adapter tests protect parsing, configuration mapping, output, status
|
||||||
|
mapping, restricted artifacts, and representative real Promptkit-engine
|
||||||
|
workflows. The dependency test protects the repository boundary.
|
||||||
|
|
||||||
- Adapter packages stay thin and translation-focused.
|
## Change Recipes
|
||||||
- App config is resolved before dependency construction.
|
|
||||||
- External input strictness is part of contract stability.
|
For a CLI or HTTP change:
|
||||||
- CLI and HTTP construct runners without a repairer.
|
|
||||||
- HTTP endpoint details remain canonical in `docs/api.md`.
|
1. identify the Scriptorium-owned external contract;
|
||||||
- Public Go package details remain canonical in `docs/consumers/pkg-scriptorium.md`.
|
2. map through Promptkit public values without copying framework semantics;
|
||||||
|
3. add or update the narrow application-owned test;
|
||||||
|
4. update the canonical Scriptorium contract; and
|
||||||
|
5. coordinate and tag Promptkit first if a required public capability is
|
||||||
|
genuinely absent.
|
||||||
|
|
||||||
|
Update [source internals](sources.md) when application source locations or HTTP
|
||||||
|
artifact containment changes.
|
||||||
|
|||||||
19
docs/internal/overview.md
Normal file
19
docs/internal/overview.md
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# Internal Component Overview
|
||||||
|
|
||||||
|
This is the complete inventory of Scriptorium's implemented Go components.
|
||||||
|
The [architecture policy](../policy/architecture.md) owns normative boundaries;
|
||||||
|
public behavior belongs in the linked contracts.
|
||||||
|
|
||||||
|
| Component | Implemented responsibility | References |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `cmd/scriptorium` | Process entrypoint that delegates arguments and streams to the CLI adapter. | [CLI contract](../cli.md), [adapter internals](adapters.md) |
|
||||||
|
| `internal/adapter/cli` | Parses execution and application-configuration inspection commands, resolves settings, constructs Promptkit engines only for execution/definition inspection, maps requests, and owns process output and exit behavior. | [CLI contract](../cli.md), [adapter internals](adapters.md) |
|
||||||
|
| `internal/adapter/http` | Owns routes, DTOs, strict decoding, limits, Promptkit request/result mapping, public error mapping, and restricted HTTP artifact reading. | [HTTP API](../api.md), [adapter internals](adapters.md), [source internals](sources.md) |
|
||||||
|
| `internal/config` | Selects application sources, supplies the ConfigKit definition and explicit overrides, and converts resolved settings for runtime use. | [configuration contract](../config.md), [adapter internals](adapters.md) |
|
||||||
|
| `internal/defaults` | Holds Scriptorium-owned application and HTTP defaults. | [configuration contract](../config.md) |
|
||||||
|
| `internal/format` | Formats Promptkit prepared-run and prompt/profile inspection values for CLI text or JSON output. | [CLI contract](../cli.md), [adapter internals](adapters.md) |
|
||||||
|
| `internal/report` | Projects one terminal Promptkit observation into Scriptorium-owned execution metadata. | [adapter internals](adapters.md) |
|
||||||
|
|
||||||
|
Framework implementation packages are provided by
|
||||||
|
[Promptkit v0.11.0](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/docs/consumers/pkg-promptkit.md)
|
||||||
|
and are not part of this repository.
|
||||||
@@ -1,146 +0,0 @@
|
|||||||
# Runner Internals
|
|
||||||
|
|
||||||
## Purpose
|
|
||||||
|
|
||||||
`internal/usecase.Runner` is the core prompt-execution orchestrator. It prepares prompt requests, calls the configured LLM client for `Run`, validates generated output, and returns domain results.
|
|
||||||
|
|
||||||
Transport parsing, DTOs, CLI output, HTTP status mapping, and public package type conversion belong outside the runner.
|
|
||||||
|
|
||||||
## Inputs And Outputs
|
|
||||||
|
|
||||||
Primary inputs:
|
|
||||||
|
|
||||||
- `domain.RunRequest`
|
|
||||||
- repositories/readers/renderers/validators injected at construction
|
|
||||||
- `context.Context` for cancellation
|
|
||||||
|
|
||||||
Primary outputs:
|
|
||||||
|
|
||||||
- `domain.PreparedRun` from `Prepare`
|
|
||||||
- `domain.RunResult` from `Run`
|
|
||||||
- wrapped sentinel errors for adapter mapping
|
|
||||||
|
|
||||||
LLM boundary types:
|
|
||||||
|
|
||||||
- `domain.GenerateRequest`
|
|
||||||
- `domain.GenerateResponse`
|
|
||||||
|
|
||||||
## Dependencies
|
|
||||||
|
|
||||||
`Runner` depends on package interfaces instead of concrete adapter types:
|
|
||||||
|
|
||||||
- `promptdef.Repository`
|
|
||||||
- `profile.Repository`
|
|
||||||
- `artifact.Reader`
|
|
||||||
- `prompt.Renderer`
|
|
||||||
- `llm.Client`
|
|
||||||
- `validate.Validator`
|
|
||||||
- optional `usecase.OutputRepairer`
|
|
||||||
|
|
||||||
The CLI, HTTP adapter, and public Go package construct these dependencies and pass them in.
|
|
||||||
|
|
||||||
## Config Fields
|
|
||||||
|
|
||||||
`Runner` does not read app config files. Effective behavior is determined by injected dependencies and the `domain.RunRequest`.
|
|
||||||
|
|
||||||
Adapter wiring commonly reflects these app config fields:
|
|
||||||
|
|
||||||
- `prompt_dir`
|
|
||||||
- `profile_dir`
|
|
||||||
- `schema_dir`
|
|
||||||
- `server.artifact_root`
|
|
||||||
- HTTP request/artifact/response size limits
|
|
||||||
|
|
||||||
Runtime model settings are resolved from the selected profile plus request overrides.
|
|
||||||
|
|
||||||
## Prepare Flow
|
|
||||||
|
|
||||||
`Prepare`:
|
|
||||||
|
|
||||||
1. requires a non-empty prompt ID.
|
|
||||||
2. loads the prompt definition and computes its hash.
|
|
||||||
3. selects the profile from request `profile_id`, then prompt `default_profile`.
|
|
||||||
4. loads the selected execution profile.
|
|
||||||
5. merges built-in execution defaults, profile values, and request overrides.
|
|
||||||
6. applies request-scoped direct API key values for public Go callers.
|
|
||||||
7. validates endpoint, model, and credential requirements.
|
|
||||||
8. resolves the output contract and JSON Schema document when required.
|
|
||||||
9. reads input artifacts.
|
|
||||||
10. renders prompt messages and hashes the rendered prompt.
|
|
||||||
11. returns a prepared run without calling the LLM.
|
|
||||||
|
|
||||||
Numeric request overrides are presence-aware: omitted values preserve the current effective value, while explicit zero values are real overrides.
|
|
||||||
|
|
||||||
## Run Flow
|
|
||||||
|
|
||||||
`Run`:
|
|
||||||
|
|
||||||
1. creates a run ID and start timestamp.
|
|
||||||
2. calls `Prepare`.
|
|
||||||
3. calls the injected LLM client with rendered messages, effective target, target presence, and structured-output settings.
|
|
||||||
4. builds the output artifact.
|
|
||||||
5. validates the output.
|
|
||||||
6. optionally attempts bounded repair when a repairer is injected and the contract permits repair.
|
|
||||||
7. returns the run result with artifact, raw output, validation, hashes, selected profile/model metadata, usage, and timing.
|
|
||||||
|
|
||||||
`Run` must reuse `Prepare`; prepare logic should not be duplicated elsewhere.
|
|
||||||
|
|
||||||
## Validation And Repair
|
|
||||||
|
|
||||||
Validation content failures are returned as successful run results with `Validation.Status == failed`. They are not runtime errors.
|
|
||||||
|
|
||||||
Validation runtime failures, such as schema load or compile errors, return `ErrValidation`.
|
|
||||||
|
|
||||||
Repair attempts occur only when all conditions are true:
|
|
||||||
|
|
||||||
- a repairer is injected
|
|
||||||
- `repair_attempts` is greater than zero
|
|
||||||
- validation status is `failed`
|
|
||||||
- validation mode is `json` or `json_schema`
|
|
||||||
|
|
||||||
CLI and HTTP wiring call `usecase.NewRunner(...)`, which does not inject a repairer. Normal CLI and HTTP execution therefore does not repair invalid output.
|
|
||||||
|
|
||||||
## Failure Behavior
|
|
||||||
|
|
||||||
Stable runner sentinels include:
|
|
||||||
|
|
||||||
- `ErrInvalidRequest`
|
|
||||||
- `ErrProfileRequired`
|
|
||||||
- `ErrAPIKeyEnvMissing`
|
|
||||||
- `ErrAPIKeyRequired`
|
|
||||||
- `ErrPromptLoad`
|
|
||||||
- `ErrProfileLoad`
|
|
||||||
- `ErrArtifactLoad`
|
|
||||||
- `ErrPromptRender`
|
|
||||||
- `ErrLLMGenerate`
|
|
||||||
- `ErrValidation`
|
|
||||||
|
|
||||||
Adapters should use `errors.Is` against sentinels and lower-level repository errors instead of matching message text.
|
|
||||||
|
|
||||||
Secret values must not appear in prepared output, run results, logs, HTTP responses, or serialized public package results. The effective API-key environment-variable name may appear.
|
|
||||||
|
|
||||||
## State And Manifests
|
|
||||||
|
|
||||||
The runner is stateless across requests.
|
|
||||||
|
|
||||||
- No durable run store.
|
|
||||||
- No manifest files.
|
|
||||||
- No checkpoint, skip, or resume behavior.
|
|
||||||
- Recovery is a new request after correcting inputs, config, or environment.
|
|
||||||
|
|
||||||
## Tests To Inspect
|
|
||||||
|
|
||||||
- `internal/usecase/runner_test.go`
|
|
||||||
- `internal/usecase/integration_test.go`
|
|
||||||
- `engine_test.go`
|
|
||||||
- `internal/adapter/cli/run_test.go`
|
|
||||||
- `internal/adapter/http/handler_test.go`
|
|
||||||
|
|
||||||
## Architectural Invariants
|
|
||||||
|
|
||||||
- Use-case decisions stay in `internal/usecase`.
|
|
||||||
- `Run` reuses `Prepare`.
|
|
||||||
- Prompt/profile/artifact/schema loading remains behind injected boundaries.
|
|
||||||
- Validation content failures are result state; validation runtime failures are errors.
|
|
||||||
- Repair loops are bounded by `repair_attempts` and repairer presence.
|
|
||||||
- Resolved secret values are never serialized or emitted.
|
|
||||||
@@ -2,156 +2,100 @@
|
|||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
|
|
||||||
This document covers implemented prompt, profile, schema, artifact, and catalog source behavior. It is for developers changing loaders or source wiring.
|
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 format reference](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/docs/formats.md).
|
||||||
|
|
||||||
Full user-facing YAML and config reference material belongs in `docs/config.md`.
|
## Application Source Locations
|
||||||
|
|
||||||
## Prompt Definition Sources
|
`internal/config` resolves `prompt_dir`, `profile_dir`, and `schema_dir` from
|
||||||
|
Scriptorium defaults, configuration files, and CLI overrides. It also resolves
|
||||||
|
the application-owned `backends` mapping into sorted engine settings.
|
||||||
|
`internal/adapter/cli` passes the directories into `promptkit.Config` and maps
|
||||||
|
each configured backend to Promptkit's public engine registration when
|
||||||
|
constructing an engine shared by the command path.
|
||||||
|
|
||||||
`internal/promptdef` provides directory-backed and `fs.FS` repositories.
|
Scriptorium does not search, parse, validate, or overlay framework source files
|
||||||
|
itself. Promptkit owns prompt selection, profile built-ins and overlays, schema
|
||||||
|
resolution, ordinary file artifacts, and the related error identities.
|
||||||
|
|
||||||
Behavior:
|
The [configuration reference](../config.md) owns Scriptorium's source-location
|
||||||
|
fields and precedence. Maintained files under `examples/` are application
|
||||||
|
inputs that use Promptkit's tagged formats.
|
||||||
|
|
||||||
- recursively scans `.yaml` and `.yml` files.
|
## Application Configuration Boundary
|
||||||
- decodes YAML with known-fields checking.
|
|
||||||
- looks up prompts by YAML `id`, not by path.
|
|
||||||
- optionally filters by prompt `version`.
|
|
||||||
- rejects duplicate matching prompt IDs.
|
|
||||||
- requires `id`, `version`, and at least one message.
|
|
||||||
- requires each message to set exactly one of `content` or `content_file`.
|
|
||||||
- resolves filesystem `content_file` values relative to the prompt YAML file.
|
|
||||||
- resolves `fs.FS` `content_file` values inside the configured source root.
|
|
||||||
- permits prompt subdirectories only as organization; they are not part of prompt identity.
|
|
||||||
|
|
||||||
For `fs.FS` roots, absolute paths and relative traversal outside the source root are rejected by catalog path helpers.
|
`internal/config` contains a ConfigKit-native `Document` definition. Its
|
||||||
|
fresh defaults come from Scriptorium's existing default constants; its resolver
|
||||||
|
records only actual trimming, path cleaning, and render-format normalization.
|
||||||
|
The validator reports application retry, size-limit, and format errors without
|
||||||
|
mutating the document or exposing rejected values. Application path values keep
|
||||||
|
working-directory-relative meaning. ConfigKit owns strict YAML decoding and
|
||||||
|
presence semantics, including dynamic integer values in backend parameters.
|
||||||
|
|
||||||
## Profile Sources
|
The `Load` boundary selects an explicit file, the first existing implicit
|
||||||
|
configuration file, or ConfigKit's defaults-only source. Only absence advances
|
||||||
|
implicit discovery. One ConfigKit load applies explicit application overrides
|
||||||
|
before validation and returns a result containing the resolved document and
|
||||||
|
its frozen inspection records. `Settings` converts that document into the
|
||||||
|
existing runtime settings with backend IDs sorted; it does not read files or
|
||||||
|
apply another merge. File-backed loads enable explicit ConfigKit imports and
|
||||||
|
select one named overlay when requested. ConfigKit uses the selected file's
|
||||||
|
canonical directory as the source root; the application does not widen it.
|
||||||
|
Application path values retain process-working-directory-relative meaning.
|
||||||
|
|
||||||
`internal/profile` provides directory-backed, `fs.FS`, and overlay repositories. `internal/profile/builtin` embeds built-in profile YAML assets and exposes them through the same repository interface.
|
Every configuration-loading command uses this boundary. The CLI maps only
|
||||||
|
explicitly visited application flags to ConfigKit overrides and prints
|
||||||
|
structured load diagnostics before engine construction. The old application
|
||||||
|
YAML decoder and merge path have been removed.
|
||||||
|
Application `config` inspection reuses the result's frozen effective,
|
||||||
|
provenance, and history views without constructing an engine or reloading
|
||||||
|
sources. It does not resolve API-key environment values; ordinary backend
|
||||||
|
parameters remain visible by the selected inspection policy.
|
||||||
|
|
||||||
Behavior:
|
## Restricted HTTP Artifact Reader
|
||||||
|
|
||||||
- recursively scans `.yaml` and `.yml` files.
|
`internal/adapter/http` implements `promptkit.ArtifactReader` for HTTP
|
||||||
- decodes YAML with known-fields checking.
|
requests. The `serve` path injects it with
|
||||||
- looks up profiles by YAML `id`, not by path.
|
`promptkit.WithArtifactReader`, replacing Promptkit's ordinary reader for
|
||||||
- rejects duplicate IDs inside the same source.
|
inbound HTTP inputs.
|
||||||
- rejects raw `api_key` fields in YAML; file-backed profiles must use `api_key_env`.
|
|
||||||
- validates required `endpoint` and `model` values.
|
|
||||||
- validates numeric profile ranges.
|
|
||||||
|
|
||||||
Overlay behavior:
|
The reader:
|
||||||
|
|
||||||
- custom profiles are primary.
|
- accepts inline references without an artifact root;
|
||||||
- built-in profiles are fallback.
|
- denies file references when no root is configured;
|
||||||
- fallback occurs only after a primary `ErrProfileNotFound`.
|
- resolves relative paths below the configured root;
|
||||||
- primary validation, YAML, duplicate, and raw-key errors are returned directly.
|
- accepts absolute paths only when they are lexically within that root;
|
||||||
- duplicate IDs across custom and built-in sources are allowed because the custom profile overrides the built-in one.
|
- rejects lexical traversal outside the root;
|
||||||
|
- applies the configured file byte limit, with zero meaning unlimited;
|
||||||
|
- preserves content type, body, size, hash, name, and URI metadata; and
|
||||||
|
- honors context cancellation.
|
||||||
|
|
||||||
The public Go facade can add in-memory profiles ahead of file-backed and built-in profiles.
|
Containment is lexical and does not resolve symlinks. The operating system
|
||||||
|
follows symlinks after the check. The [HTTP API](../api.md) owns observable
|
||||||
|
request outcomes, and [operations](../operations.md) owns safe deployment
|
||||||
|
permissions and root selection.
|
||||||
|
|
||||||
## Schema Sources
|
Reader errors remain identifiable after Promptkit wraps them as artifact-load
|
||||||
|
failures, allowing the HTTP adapter to preserve Scriptorium status and error
|
||||||
|
codes.
|
||||||
|
|
||||||
`internal/validate` provides:
|
## Verification And Change Recipe
|
||||||
|
|
||||||
- `StandardValidator` for filesystem paths.
|
Inspect:
|
||||||
- `FSValidator` for `fs.FS` roots and single-file public schema sources.
|
|
||||||
|
|
||||||
Behavior:
|
- `internal/config/document_test.go`
|
||||||
|
- `internal/config/load_test.go`
|
||||||
|
- `internal/adapter/cli/run_test.go`
|
||||||
|
- `internal/adapter/http/artifact_reader_test.go`
|
||||||
|
- `internal/adapter/http/handler_test.go`
|
||||||
|
|
||||||
- `json_schema` validation requires a non-empty `schema_path`.
|
When changing an application source location or HTTP artifact policy:
|
||||||
- filesystem schema paths resolve relative to `schema_dir` unless absolute.
|
|
||||||
- directory-backed schema lookup uses the explicit `schema_path`; it does not search recursively by basename.
|
|
||||||
- `fs.FS` schema paths must remain inside the configured source root.
|
|
||||||
- single-file schema sources match by the configured file base name.
|
|
||||||
- schema documents are loaded before the LLM call for structured output.
|
|
||||||
- JSON parse failures are validation content failures.
|
|
||||||
- schema access, decode, registration, and compile failures are runtime validation errors.
|
|
||||||
|
|
||||||
## Artifact Sources
|
1. preserve strict configuration precedence and the Promptkit public boundary;
|
||||||
|
2. keep containment and size policy in Scriptorium;
|
||||||
`internal/artifact` supports two input artifact reference types:
|
3. update focused configuration, reader, and handler tests;
|
||||||
|
4. update the [configuration](../config.md), [HTTP](../api.md), and
|
||||||
- `inline`
|
[operations](../operations.md) contracts as applicable; and
|
||||||
- `file`
|
5. do not duplicate Promptkit loaders, formats, or ordinary artifact behavior.
|
||||||
|
|
||||||
Inline behavior:
|
|
||||||
|
|
||||||
- requires a non-empty body.
|
|
||||||
- produces text/plain artifacts.
|
|
||||||
- hashes the body bytes.
|
|
||||||
|
|
||||||
Direct file behavior:
|
|
||||||
|
|
||||||
- used by CLI `run`, CLI `render`, and the public Go facade.
|
|
||||||
- requires a non-empty URI.
|
|
||||||
- reads from the process filesystem without HTTP artifact-root restrictions.
|
|
||||||
- infers content type from file extension, defaulting to text/plain.
|
|
||||||
|
|
||||||
Restricted file behavior:
|
|
||||||
|
|
||||||
- used by HTTP `serve`.
|
|
||||||
- allows inline artifacts even when no artifact root is configured.
|
|
||||||
- denies file artifacts when no artifact root is configured.
|
|
||||||
- resolves relative file URIs against `server.artifact_root`.
|
|
||||||
- accepts absolute file URIs only when they pass containment checks.
|
|
||||||
- applies `server.max_artifact_bytes` when configured.
|
|
||||||
|
|
||||||
Restricted containment is lexical. It cleans paths and checks the relative path against the configured root; it does not resolve symlinks. Symlinks inside the root are followed by the operating system, including symlinks that target files outside the root.
|
|
||||||
|
|
||||||
## Catalog Helpers
|
|
||||||
|
|
||||||
`internal/filecatalog` centralizes shared source helpers:
|
|
||||||
|
|
||||||
- recursive YAML discovery for filesystem and `fs.FS` roots.
|
|
||||||
- deterministic sorting.
|
|
||||||
- `.yaml` and `.yml` filtering.
|
|
||||||
- display paths for diagnostics.
|
|
||||||
- YAML file stems.
|
|
||||||
- `fs.FS` root cleaning and containment checks.
|
|
||||||
|
|
||||||
Repository code should use these helpers instead of reimplementing path traversal and containment rules.
|
|
||||||
|
|
||||||
## Failure Behavior
|
|
||||||
|
|
||||||
Common source failures:
|
|
||||||
|
|
||||||
- missing prompt/profile/schema/artifact files.
|
|
||||||
- invalid YAML or JSON.
|
|
||||||
- unknown YAML fields.
|
|
||||||
- duplicate prompt or profile IDs.
|
|
||||||
- prompt/profile validation errors.
|
|
||||||
- raw API key fields in profile YAML.
|
|
||||||
- unsupported artifact reference type.
|
|
||||||
- missing inline body or file URI.
|
|
||||||
- artifact outside HTTP root.
|
|
||||||
- artifact exceeding HTTP size limit.
|
|
||||||
- schema load or compile failure.
|
|
||||||
|
|
||||||
Prompt/profile repository lookup errors are mapped by adapters separately from runtime runner errors. Validation content failures remain result state; source and schema runtime failures return errors.
|
|
||||||
|
|
||||||
## State And Manifests
|
|
||||||
|
|
||||||
Source packages do not persist run state.
|
|
||||||
|
|
||||||
- No manifests are read or written.
|
|
||||||
- No source package implements skip or resume behavior.
|
|
||||||
- Source reads reflect the current filesystem or `fs.FS` state for each request.
|
|
||||||
|
|
||||||
## Tests To Inspect
|
|
||||||
|
|
||||||
- `internal/promptdef/repository_test.go`
|
|
||||||
- `internal/profile/repository_test.go`
|
|
||||||
- `internal/profile/builtin/repository_test.go`
|
|
||||||
- `internal/artifact/reader_test.go`
|
|
||||||
- `internal/validate/standard_validator_test.go`
|
|
||||||
- `internal/usecase/integration_test.go`
|
|
||||||
- `engine_test.go`
|
|
||||||
|
|
||||||
## Architectural Invariants
|
|
||||||
|
|
||||||
- Prompt/profile identity comes from YAML `id`.
|
|
||||||
- External YAML decoding remains strict.
|
|
||||||
- File-backed profile YAML never accepts raw API key values.
|
|
||||||
- Built-in profiles are fallback, not a replacement for custom source validation.
|
|
||||||
- HTTP file artifacts remain rooted by lexical containment.
|
|
||||||
- Schema runtime failures remain errors, while JSON/schema content mismatches remain validation results.
|
|
||||||
|
|||||||
@@ -1,164 +1,229 @@
|
|||||||
# Operations Guide
|
# Operations Guide
|
||||||
|
|
||||||
## Scope
|
## Scope And References
|
||||||
|
|
||||||
This guide covers operating the implemented CLI commands and HTTP service. It
|
This runbook covers deployment, normal operation, capacity planning, and safe
|
||||||
does not replace the [CLI reference](cli.md), [Configuration reference](config.md),
|
recovery for Scriptorium. It does not redefine invocation syntax, configuration
|
||||||
or [HTTP API reference](api.md).
|
fields, or HTTP wire behavior.
|
||||||
|
|
||||||
## Operational Model
|
- [CLI reference](cli.md): commands, output destinations, and exit codes.
|
||||||
|
- [Configuration reference](config.md): application settings, source
|
||||||
|
locations, defaults, and credential mapping.
|
||||||
|
- [Promptkit framework formats](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/docs/formats.md):
|
||||||
|
prompt, profile, schema, execution-setting, and framework credential
|
||||||
|
contracts.
|
||||||
|
- [HTTP API reference](api.md): route, request/response schema, status codes,
|
||||||
|
limits, and HTTP artifact access.
|
||||||
|
- [Consumer integration overview](consumers/api.md): caller responsibilities.
|
||||||
|
|
||||||
Scriptorium executes one prompt request per CLI invocation or HTTP request.
|
## Operational Model And State
|
||||||
|
|
||||||
Important boundaries:
|
Scriptorium handles one prompt request for each CLI invocation or HTTP request.
|
||||||
|
It has no durable run store, archive, checkpoint, cache, or resume mechanism.
|
||||||
|
A failed or interrupted request is recovered by correcting its inputs,
|
||||||
|
configuration, or environment and submitting a new request.
|
||||||
|
|
||||||
- No durable run state is stored.
|
Generated artifacts, rendered prompts, model output, and run metadata are
|
||||||
- No manifest, archive, checkpoint, or built-in backup workflow is written.
|
caller-owned data. Retention, encryption, backup, and deletion are deployment
|
||||||
- No built-in resume behavior exists.
|
responsibilities.
|
||||||
- Recovery is rerun-based: correct inputs, config, or environment, then run again.
|
Optional [CLI execution reports](cli.md) also belong to the caller. They can
|
||||||
|
contain sensitive identifiers even though they omit prompt and response bodies.
|
||||||
|
Keep report paths separate from generated output and apply the same access and
|
||||||
|
retention controls. Output and report writes are not transactional; an older
|
||||||
|
report may remain when no terminal observation was produced.
|
||||||
|
HTTP callers may also request a [terminal execution report](api.md#execution-report).
|
||||||
|
It shares the same identifier sensitivity and should receive response access
|
||||||
|
and retention controls. An opted-in report increases the encoded response size;
|
||||||
|
an oversized success or report-bearing error becomes the compact 413 response
|
||||||
|
without a report.
|
||||||
|
|
||||||
## Filesystem Layout
|
## Deploy The Filesystem And Process
|
||||||
|
|
||||||
Operational deployments usually provide:
|
Provide the process with readable configured Promptkit prompt, profile, and
|
||||||
|
schema sources that follow the tagged framework formats. For an HTTP deployment
|
||||||
|
that accepts file artifacts, use a dedicated, narrow artifact directory rather
|
||||||
|
than a general-purpose or sensitive filesystem tree.
|
||||||
|
|
||||||
- `prompt_dir`: prompt definition YAML files and adjacent `content_file` templates.
|
If application configuration uses explicit imports or a selected overlay,
|
||||||
- `profile_dir`: optional custom profile YAML files.
|
deploy those files beneath the selected configuration file's canonical
|
||||||
- `schema_dir`: optional JSON Schema files.
|
directory. ConfigKit keeps imported and overlay files within that root;
|
||||||
- `server.artifact_root`: optional HTTP file-input root for `serve`.
|
Scriptorium does not widen it. Application path values inside those files still
|
||||||
|
resolve from the process working directory, so set that directory deliberately
|
||||||
|
in the service manager. This configuration-source boundary is distinct from
|
||||||
|
the HTTP artifact root and does not constrain prompt or schema directories.
|
||||||
|
|
||||||
Keep these directories readable by the Scriptorium process. Keep
|
When upgrading existing definitions, review selected profile IDs.
|
||||||
`server.artifact_root` narrow and not writable by untrusted users.
|
`deepseek-3-2`, `deepseek-4-flash`, and `deepseek-4-pro` were removed from the
|
||||||
|
selected catalog. Choose an available catalog profile, one of Promptkit's
|
||||||
|
maintained names, or a complete application-owned profile. New DeepSeek names
|
||||||
|
are not aliases for the removed ones; see the
|
||||||
|
[v0.10 migration guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.10.0/docs/releases/v0.10.0.md).
|
||||||
|
|
||||||
## Normal CLI Workflow
|
Run Scriptorium under an identity that can:
|
||||||
|
|
||||||
Use `render` before `run` when changing prompt/profile/input wiring:
|
- read only the prompt, profile, schema, and allowed input-artifact paths it
|
||||||
|
needs;
|
||||||
|
- read the required credential environment variables without writing them to
|
||||||
|
files or logs; and
|
||||||
|
- write only caller-selected output locations when CLI output files are used.
|
||||||
|
|
||||||
```bash
|
Do not make the HTTP artifact directory writable by untrusted users. The HTTP
|
||||||
go run ./cmd/scriptorium render \
|
artifact containment behavior is lexical and the operating system follows
|
||||||
--config ./examples/config.yml \
|
symlinks; account for that when choosing ownership and mount boundaries. See
|
||||||
--prompt generic.markdown_summary \
|
the [HTTP API reference](api.md) for the externally observable behavior.
|
||||||
--input transcript=./examples/fixtures/transcript.md \
|
|
||||||
--input glossary=./examples/fixtures/glossary.yml \
|
|
||||||
--format json
|
|
||||||
```
|
|
||||||
|
|
||||||
Use `run` for generation after preflight:
|
## Supply Credentials And Protect Runtime Data
|
||||||
|
|
||||||
```bash
|
Set secret values in the process environment and configure only their
|
||||||
go run ./cmd/scriptorium run \
|
environment-variable names. Do not put raw keys in configuration, prompt or
|
||||||
--config ./examples/config.yml \
|
profile files, process arguments, HTTP payloads, captured command lines, or
|
||||||
--prompt generic.markdown_summary \
|
debug dumps.
|
||||||
--input transcript=./examples/fixtures/transcript.md \
|
|
||||||
--input glossary=./examples/fixtures/glossary.yml \
|
|
||||||
--out ./summary.md
|
|
||||||
```
|
|
||||||
|
|
||||||
Before production runs, confirm:
|
Treat stdout, stderr, prepared-run output, generated artifacts, and HTTP
|
||||||
|
responses as potentially sensitive. Send service logs to a controlled collector
|
||||||
|
and apply the same retention and access rules as for model input and output.
|
||||||
|
|
||||||
- the effective config path is the intended one;
|
## Run A Normal Workflow
|
||||||
- prompt/profile/schema directories are readable;
|
|
||||||
- input file paths exist and match prompt input names;
|
|
||||||
- required API-key environment variables are set;
|
|
||||||
- the selected model endpoint is reachable from the process environment.
|
|
||||||
|
|
||||||
## HTTP Service Operation
|
Before changing production inputs, profiles, or schemas:
|
||||||
|
|
||||||
Start the service with:
|
1. use `config validate`, `config show`, or `config sources` to check the
|
||||||
|
application configuration and its selected sources without constructing an
|
||||||
|
engine; this does not verify prompt files, provider access, or credentials;
|
||||||
|
2. confirm the deployed configuration selects the intended sources and model
|
||||||
|
credentials;
|
||||||
|
3. use [`render`](cli.md) with the same request inputs and variables to confirm
|
||||||
|
preparation without a model call;
|
||||||
|
4. use [`run`](cli.md) for generation; and
|
||||||
|
5. retain or discard validation-failed output according to the caller's
|
||||||
|
policy.
|
||||||
|
|
||||||
```bash
|
Inspection output can include configuration paths, names, and ordinary backend
|
||||||
go run ./cmd/scriptorium serve --config ./examples/config.yml
|
parameters. `config explain --path` uses JSON Pointer paths and can show
|
||||||
```
|
displaced historical values as well as the final value. Protect both the
|
||||||
|
selected paths and the output, especially when backend parameters contain
|
||||||
|
sensitive identifiers; ConfigKit does not infer arbitrary secrets in those
|
||||||
|
parameters. Apply
|
||||||
|
access and retention controls; the application stores only API-key environment
|
||||||
|
reference names, not the resolved credential bytes.
|
||||||
|
|
||||||
The implemented HTTP route is `POST /v1/runs`; request and response fields are
|
The [maintained render script](../examples/render-markdown-summary.sh) is a
|
||||||
defined in the [HTTP API reference](api.md).
|
copyable preflight example. The CLI reference owns its complete invocation and
|
||||||
|
exit semantics.
|
||||||
|
|
||||||
The maintained HTTP request-shape example is `examples/http-run.json`.
|
## Expose The HTTP Service
|
||||||
|
|
||||||
HTTP service notes:
|
The HTTP service has no built-in authentication or authorization. Place it on a
|
||||||
|
trusted network or behind an authenticated reverse proxy, API gateway, or
|
||||||
|
equivalent access control. Restrict who can reach it and who can read the
|
||||||
|
artifact root.
|
||||||
|
|
||||||
- Unknown JSON fields are rejected.
|
Use a service manager or supervisor appropriate to the deployment to manage
|
||||||
- `inline` input references work without an artifact root.
|
process lifetime, restart policy, log capture, and environment injection. The
|
||||||
- `file` input references require `server.artifact_root` or `serve --artifact-root`.
|
[HTTP API reference](api.md) owns client request shapes, status behavior, and
|
||||||
- Request bodies, HTTP file input artifacts, and encoded JSON responses are size-limited.
|
artifact-access outcomes.
|
||||||
- Validation content failures return `200 OK` with `validation.status: "failed"`.
|
|
||||||
|
|
||||||
Security boundary:
|
## Plan Capacity And Limits
|
||||||
|
|
||||||
- `serve` has no built-in authentication or authorization.
|
Capacity is primarily determined by concurrent model calls, input and output
|
||||||
- Put it behind trusted controls such as a private network, authenticated reverse proxy, or API gateway.
|
sizes, schema complexity, provider latency, and network behavior. Size limits
|
||||||
- Do not expose an artifact root containing unrelated sensitive files.
|
protect request bodies, HTTP file artifacts, and encoded responses; configure
|
||||||
- Symlinks inside the artifact root are followed by the operating system.
|
them through the [configuration reference](config.md) and rely on the
|
||||||
|
[HTTP API reference](api.md) for their response effects.
|
||||||
|
|
||||||
## Secrets Handling
|
Configured backend concurrency and queue capacity are enforced per constructed
|
||||||
|
Promptkit engine. A `serve` process constructs one engine for its handler, so
|
||||||
|
concurrent HTTP requests share that transient admission state. Scriptorium does
|
||||||
|
not retain workflow state: capacity is neither durable nor a queue of resumable
|
||||||
|
runs. When admission is exhausted, HTTP returns `503 capacity_exceeded` without
|
||||||
|
retry timing; callers choose any retry policy that is safe for another model
|
||||||
|
call.
|
||||||
|
|
||||||
Raw API keys are not accepted in app config, profiles, CLI flags, or HTTP
|
Promptkit's built-in client now allows two additional attempts for eligible
|
||||||
request bodies.
|
transient provider statuses by default. Account for added calls, latency, and
|
||||||
|
cost when planning capacity. Each repair generation has its own transient
|
||||||
|
budget, separate from the structural repair count. Configure the engine budget
|
||||||
|
with [`transient_retries`](config.md); `run` and `render` accept a request
|
||||||
|
override described in the [CLI contract](cli.md), and HTTP callers can select
|
||||||
|
one through the [API contract](api.md). Omission inherits the engine
|
||||||
|
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://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/docs/integrations/openai-compatible-chat.md)
|
||||||
|
for details.
|
||||||
|
|
||||||
Use this pattern:
|
CLI `run` can set a [whole-run deadline](cli.md) when total execution time must
|
||||||
|
be bounded. The existing generation timeout applies afresh to each attempt and
|
||||||
|
does not cap retry waits or the complete invocation. The whole-run interval
|
||||||
|
covers the engine call, including capacity waiting and repairs as supported by
|
||||||
|
context cancellation; it excludes parsing, engine setup, and output writes.
|
||||||
|
HTTP callers can use [`run_timeout_seconds`](api.md) to shorten their request
|
||||||
|
context for the same engine interval. The API distinguishes an expired
|
||||||
|
execution deadline from caller cancellation and from a provider-attempt
|
||||||
|
timeout. A canceled capacity waiter releases its Promptkit admission state.
|
||||||
|
|
||||||
1. Set an environment variable containing the secret value.
|
Before increasing a limit:
|
||||||
2. Store only the variable name in profile `api_key_env` or request override `api_key_env`.
|
|
||||||
3. Scope the process environment to the minimum required variables.
|
|
||||||
|
|
||||||
## Output, Logs, And Exit Codes
|
1. measure representative input, generated-output, and optional raw-output
|
||||||
|
sizes;
|
||||||
|
2. confirm memory, network, and upstream-provider capacity;
|
||||||
|
3. retain an upstream request-size and authentication boundary; and
|
||||||
|
4. test the intended workload in a non-production environment.
|
||||||
|
|
||||||
`run`:
|
For large local inputs, prefer a controlled file-artifact directory over
|
||||||
|
placing arbitrary paths on the service host. Avoid disabling a limit unless an
|
||||||
|
equivalent trusted control exists elsewhere.
|
||||||
|
|
||||||
- stdout: generated artifact body unless `--out` is used.
|
## Diagnose And Recover
|
||||||
- stderr: summary on success, errors on failure.
|
|
||||||
- exit `2`: generation completed and output was written, but validation failed.
|
|
||||||
|
|
||||||
`render`:
|
### Preparation Or Configuration Failure
|
||||||
|
|
||||||
- stdout: prepared-run output unless `--out` is used.
|
Capture the CLI diagnostic or HTTP error response, then verify the selected
|
||||||
- stderr: errors.
|
configuration, prompt ID, profile selection, source readability, and input
|
||||||
- exit `0` on success, `1` on failure.
|
mapping. Use `render` with the same request when it is unclear whether failure
|
||||||
|
occurs before model execution. Consult the [CLI reference](cli.md), the
|
||||||
|
[configuration reference](config.md), and the [HTTP API reference](api.md) for
|
||||||
|
the exact interface contract.
|
||||||
|
|
||||||
`serve`:
|
### Credential Or Provider Failure
|
||||||
|
|
||||||
- stderr: startup and server errors.
|
Confirm that the process environment contains the configured credential name
|
||||||
- HTTP response body: JSON success or error envelope.
|
without printing the secret. Check endpoint reachability and provider health
|
||||||
|
from the process network. If preparation succeeds but generation fails, inspect
|
||||||
|
the selected model settings in prepared output and the service's controlled
|
||||||
|
logs. Correct the deployment or provider issue, then submit a new request.
|
||||||
|
|
||||||
## Validation Behavior
|
### Artifact Or Permission Failure
|
||||||
|
|
||||||
Prompt `output.validation_mode` controls validation:
|
Verify that the process can read the intended local input. For HTTP file
|
||||||
|
artifacts, verify the deployment's artifact root, ownership, path layout, and
|
||||||
|
file size. Do not widen filesystem permissions or the allowed root merely to
|
||||||
|
make an arbitrary path work; move or copy the required artifact into the
|
||||||
|
controlled location instead.
|
||||||
|
|
||||||
- `none`: skipped.
|
### Validation Failure
|
||||||
- `basic`: output body must not be empty.
|
|
||||||
- `json`: output body must parse as JSON.
|
|
||||||
- `json_schema`: output body must parse as JSON and satisfy the configured schema.
|
|
||||||
|
|
||||||
Runtime/schema failures are hard failures (`run` exit `1`, HTTP error).
|
A generated-content validation failure is distinct from a runtime failure.
|
||||||
Generated-content validation failures are soft failures (`run` exit `2`, HTTP
|
CLI `run` reports the validation result and error count in its success summary;
|
||||||
`200 OK` with failed validation status).
|
it does not print the individual validation messages. For HTTP, inspect the
|
||||||
|
validation object in the response according to the [HTTP API reference](api.md).
|
||||||
|
|
||||||
## Size Limits
|
Use rendered input and generated output to determine whether prompt instructions,
|
||||||
|
the selected model, or the schema needs correction. If schema loading or
|
||||||
|
compilation itself fails, correct the source deployment or schema document
|
||||||
|
before rerunning.
|
||||||
|
|
||||||
Defaults are documented in [Configuration reference](config.md). Operationally:
|
### HTTP Limit Or Request Failure
|
||||||
|
|
||||||
- Keep default HTTP limits unless larger payloads are measured and expected.
|
Compare the request, artifact, or expected response size with the deployed
|
||||||
- Prefer `inline` HTTP inputs for small payloads.
|
configuration, and validate the request against the [HTTP API reference](api.md).
|
||||||
- Prefer `file` HTTP inputs for larger local artifacts under a controlled artifact root.
|
Reduce the payload, use an appropriate controlled artifact source, omit
|
||||||
- Increase `server.max_response_bytes` when generated artifacts or requested raw output are expected to be large.
|
unneeded raw output, or adjust the deployment limit after capacity review.
|
||||||
- Use `0` only when another trusted layer enforces size limits.
|
|
||||||
|
|
||||||
## Maintained Examples
|
## Cleanup And Reruns
|
||||||
|
|
||||||
- `examples/config.yml`
|
Because no run state is retained, cleanup concerns caller-owned output files,
|
||||||
- `examples/config.full.yml`
|
logs, and artifacts only. Remove or rotate them using the deployment's normal
|
||||||
- `examples/render-markdown-summary.sh`
|
retention policy. After a correction, rerun the request from the beginning;
|
||||||
- `examples/http-run.json`
|
there is no safe resume point.
|
||||||
|
|
||||||
## Safe Recovery
|
|
||||||
|
|
||||||
For failed CLI commands or HTTP requests:
|
|
||||||
|
|
||||||
1. Capture stderr or the HTTP error `code` and `message`.
|
|
||||||
2. Confirm config path and effective directory settings.
|
|
||||||
3. Verify prompt ID, profile ID, schema path, and input mappings.
|
|
||||||
4. Verify required API-key environment variables.
|
|
||||||
5. Reproduce with `render --format json` when pre-LLM resolution is uncertain.
|
|
||||||
6. Rerun after correction.
|
|
||||||
|
|
||||||
Because Scriptorium does not persist run state, rerun is the supported recovery
|
|
||||||
path.
|
|
||||||
|
|||||||
127
docs/oss/attribution.md
Normal file
127
docs/oss/attribution.md
Normal file
@@ -0,0 +1,127 @@
|
|||||||
|
# Open-Source Attribution
|
||||||
|
|
||||||
|
Scriptorium's own terms are in the repository [LICENSE](../../LICENSE).
|
||||||
|
The [OSS policy](../policy/oss.md) governs these entries. Dependency versions
|
||||||
|
are recorded in [go.mod](../../go.mod) and [go.sum](../../go.sum); source and
|
||||||
|
notice links below identify the exact commits for the selected versions.
|
||||||
|
|
||||||
|
## Promptkit
|
||||||
|
|
||||||
|
Copyright (C) 2026 Eric Rakestraw
|
||||||
|
|
||||||
|
SPDX-License-Identifier: LGPL-3.0-or-later
|
||||||
|
|
||||||
|
License and notices: [LGPL v3](licenses/LGPL-3.0.txt) |
|
||||||
|
[GPL v3 companion](licenses/GPL-3.0.txt) |
|
||||||
|
[upstream LICENSE](https://gitea.maximumdirect.net/eric/promptkit/src/commit/db05b56166ca2d8650dfaf660e1cf0eed3932e1d/LICENSE)
|
||||||
|
|
||||||
|
Source: [Promptkit v0.11.0](https://gitea.maximumdirect.net/eric/promptkit/src/commit/db05b56166ca2d8650dfaf660e1cf0eed3932e1d)
|
||||||
|
|
||||||
|
## ConfigKit
|
||||||
|
|
||||||
|
Upstream copyright statement: no project-specific statement is present in the
|
||||||
|
selected module; the FSF copyright in its license text belongs to that license
|
||||||
|
document and is not substituted for a project notice.
|
||||||
|
|
||||||
|
SPDX-License-Identifier: LGPL-3.0-only
|
||||||
|
|
||||||
|
License and notices: [LGPL v3](licenses/LGPL-3.0.txt) |
|
||||||
|
[GPL v3 companion](licenses/GPL-3.0.txt) |
|
||||||
|
[upstream LICENSE](https://gitea.maximumdirect.net/eric/ConfigKit/src/commit/e6ced0d3d1194b58e0b3dc8970089471ba175258/LICENSE)
|
||||||
|
|
||||||
|
Source: [ConfigKit v0.4.0](https://gitea.maximumdirect.net/eric/ConfigKit/src/commit/e6ced0d3d1194b58e0b3dc8970089471ba175258)
|
||||||
|
|
||||||
|
## Promptkit OpenRouter Catalog
|
||||||
|
|
||||||
|
Upstream copyright statement: no project-specific statement is present in the
|
||||||
|
selected module. The linked upstream README records the profile assets'
|
||||||
|
Promptkit origin and the copyright holder's deliberate relicensing.
|
||||||
|
|
||||||
|
SPDX-License-Identifier: LGPL-3.0-only
|
||||||
|
|
||||||
|
License and notices: [LGPL v3](licenses/LGPL-3.0.txt) |
|
||||||
|
[GPL v3 companion](licenses/GPL-3.0.txt) |
|
||||||
|
[upstream LICENSE](https://gitea.maximumdirect.net/eric/promptkit-backend-openrouter/src/commit/f7518043ebdd70b8959506201639903dff0b85ab/LICENSE) |
|
||||||
|
[asset licensing notice](https://gitea.maximumdirect.net/eric/promptkit-backend-openrouter/src/commit/f7518043ebdd70b8959506201639903dff0b85ab/README.md)
|
||||||
|
|
||||||
|
Source: [OpenRouter catalog v2.20260922.1](https://gitea.maximumdirect.net/eric/promptkit-backend-openrouter/src/commit/f7518043ebdd70b8959506201639903dff0b85ab)
|
||||||
|
|
||||||
|
## Promptkit Rakestrawhome Catalog
|
||||||
|
|
||||||
|
Upstream copyright statement: no project-specific statement is present in the
|
||||||
|
selected module. The linked upstream README records the profile asset's
|
||||||
|
Promptkit origin and the copyright holder's deliberate relicensing.
|
||||||
|
|
||||||
|
SPDX-License-Identifier: LGPL-3.0-only
|
||||||
|
|
||||||
|
License and notices: [LGPL v3](licenses/LGPL-3.0.txt) |
|
||||||
|
[GPL v3 companion](licenses/GPL-3.0.txt) |
|
||||||
|
[upstream LICENSE](https://gitea.maximumdirect.net/eric/promptkit-backend-rakestrawhome/src/commit/d664696142bf7c2d93db2a6b2e07f3deb55f2226/LICENSE) |
|
||||||
|
[asset licensing notice](https://gitea.maximumdirect.net/eric/promptkit-backend-rakestrawhome/src/commit/d664696142bf7c2d93db2a6b2e07f3deb55f2226/README.md)
|
||||||
|
|
||||||
|
Source: [Rakestrawhome catalog v2.20260922.0](https://gitea.maximumdirect.net/eric/promptkit-backend-rakestrawhome/src/commit/d664696142bf7c2d93db2a6b2e07f3deb55f2226)
|
||||||
|
|
||||||
|
## jsonschema/v6
|
||||||
|
|
||||||
|
Upstream copyright statement: no project-specific statement is present in the
|
||||||
|
selected module; no substitute statement is inferred here.
|
||||||
|
|
||||||
|
SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
License and notices: [Apache 2.0](licenses/Apache-2.0.txt) |
|
||||||
|
[upstream LICENSE](https://github.com/santhosh-tekuri/jsonschema/blob/29cbed948d24a04700eb94436416b18a07953b71/LICENSE)
|
||||||
|
|
||||||
|
Source: [jsonschema/v6 v6.0.2](https://github.com/santhosh-tekuri/jsonschema/tree/29cbed948d24a04700eb94436416b18a07953b71)
|
||||||
|
|
||||||
|
## golang.org/x/text
|
||||||
|
|
||||||
|
Copyright (c) 2009 The Go Authors. All rights reserved.
|
||||||
|
|
||||||
|
SPDX-License-Identifier: BSD-3-Clause
|
||||||
|
|
||||||
|
License and notices: [BSD 3-Clause](licenses/BSD-3-Clause.txt) |
|
||||||
|
[upstream LICENSE](https://go.googlesource.com/text/+/6c97a165dd661335ff7bce6104a008558123c353/LICENSE)
|
||||||
|
|
||||||
|
Source: [golang.org/x/text v0.14.0](https://go.googlesource.com/text/+/6c97a165dd661335ff7bce6104a008558123c353)
|
||||||
|
|
||||||
|
## gopkg.in/yaml.v3
|
||||||
|
|
||||||
|
Copyright (c) 2006-2010 Kirill Simonov
|
||||||
|
|
||||||
|
Copyright (c) 2006-2011 Kirill Simonov
|
||||||
|
|
||||||
|
Copyright (c) 2011-2019 Canonical Ltd
|
||||||
|
|
||||||
|
Copyright 2011-2016 Canonical Ltd.
|
||||||
|
|
||||||
|
SPDX-License-Identifier: MIT AND Apache-2.0
|
||||||
|
|
||||||
|
The upstream LICENSE assigns MIT to files ported from libyaml and Apache 2.0
|
||||||
|
to the remaining files; these are file-specific terms, not alternatives.
|
||||||
|
|
||||||
|
License and notices: [MIT](licenses/MIT.txt) |
|
||||||
|
[Apache 2.0](licenses/Apache-2.0.txt) |
|
||||||
|
[upstream LICENSE](https://github.com/go-yaml/yaml/blob/f6f7691b1fdeb513f56608cd2c32c51f8194bf51/LICENSE) |
|
||||||
|
[upstream NOTICE](https://github.com/go-yaml/yaml/blob/f6f7691b1fdeb513f56608cd2c32c51f8194bf51/NOTICE)
|
||||||
|
|
||||||
|
Source: [gopkg.in/yaml.v3 v3.0.1](https://github.com/go-yaml/yaml/tree/f6f7691b1fdeb513f56608cd2c32c51f8194bf51)
|
||||||
|
|
||||||
|
## go.yaml.in/yaml/v4
|
||||||
|
|
||||||
|
Copyright 2006-2010 Kirill Simonov
|
||||||
|
|
||||||
|
Copyright 2011-2019 Canonical Ltd
|
||||||
|
|
||||||
|
Copyright 2025 The go-yaml Project Contributors
|
||||||
|
|
||||||
|
SPDX-License-Identifier: MIT AND Apache-2.0
|
||||||
|
|
||||||
|
The upstream NOTICE assigns MIT to files ported from libyaml and Apache 2.0
|
||||||
|
to the remaining files; these are file-specific terms, not alternatives.
|
||||||
|
|
||||||
|
License and notices: [MIT](licenses/MIT.txt) |
|
||||||
|
[Apache 2.0](licenses/Apache-2.0.txt) |
|
||||||
|
[upstream LICENSE](https://github.com/yaml/go-yaml/blob/1c17b9cee72bf81ae73a8be50fbd7dd3a9985125/LICENSE) |
|
||||||
|
[upstream NOTICE](https://github.com/yaml/go-yaml/blob/1c17b9cee72bf81ae73a8be50fbd7dd3a9985125/NOTICE)
|
||||||
|
|
||||||
|
Source: [go.yaml.in/yaml/v4 v4.0.0-rc.6](https://github.com/yaml/go-yaml/tree/1c17b9cee72bf81ae73a8be50fbd7dd3a9985125)
|
||||||
202
docs/oss/licenses/Apache-2.0.txt
Normal file
202
docs/oss/licenses/Apache-2.0.txt
Normal file
@@ -0,0 +1,202 @@
|
|||||||
|
|
||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following
|
||||||
|
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||||
|
replaced with your own identifying information. (Don't include
|
||||||
|
the brackets!) The text should be enclosed in the appropriate
|
||||||
|
comment syntax for the file format. We also recommend that a
|
||||||
|
file or class name and description of purpose be included on the
|
||||||
|
same "printed page" as the copyright notice for easier
|
||||||
|
identification within third-party archives.
|
||||||
|
|
||||||
|
Copyright [yyyy] [name of copyright owner]
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
11
docs/oss/licenses/BSD-3-Clause.txt
Normal file
11
docs/oss/licenses/BSD-3-Clause.txt
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
Copyright (c) <year> <owner>.
|
||||||
|
|
||||||
|
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
|
||||||
|
|
||||||
|
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
|
||||||
|
|
||||||
|
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
|
||||||
|
|
||||||
|
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
||||||
|
|
||||||
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
674
docs/oss/licenses/GPL-3.0.txt
Normal file
674
docs/oss/licenses/GPL-3.0.txt
Normal file
@@ -0,0 +1,674 @@
|
|||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||||
165
docs/oss/licenses/LGPL-3.0.txt
Normal file
165
docs/oss/licenses/LGPL-3.0.txt
Normal file
@@ -0,0 +1,165 @@
|
|||||||
|
GNU LESSER GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
|
||||||
|
This version of the GNU Lesser General Public License incorporates
|
||||||
|
the terms and conditions of version 3 of the GNU General Public
|
||||||
|
License, supplemented by the additional permissions listed below.
|
||||||
|
|
||||||
|
0. Additional Definitions.
|
||||||
|
|
||||||
|
As used herein, "this License" refers to version 3 of the GNU Lesser
|
||||||
|
General Public License, and the "GNU GPL" refers to version 3 of the GNU
|
||||||
|
General Public License.
|
||||||
|
|
||||||
|
"The Library" refers to a covered work governed by this License,
|
||||||
|
other than an Application or a Combined Work as defined below.
|
||||||
|
|
||||||
|
An "Application" is any work that makes use of an interface provided
|
||||||
|
by the Library, but which is not otherwise based on the Library.
|
||||||
|
Defining a subclass of a class defined by the Library is deemed a mode
|
||||||
|
of using an interface provided by the Library.
|
||||||
|
|
||||||
|
A "Combined Work" is a work produced by combining or linking an
|
||||||
|
Application with the Library. The particular version of the Library
|
||||||
|
with which the Combined Work was made is also called the "Linked
|
||||||
|
Version".
|
||||||
|
|
||||||
|
The "Minimal Corresponding Source" for a Combined Work means the
|
||||||
|
Corresponding Source for the Combined Work, excluding any source code
|
||||||
|
for portions of the Combined Work that, considered in isolation, are
|
||||||
|
based on the Application, and not on the Linked Version.
|
||||||
|
|
||||||
|
The "Corresponding Application Code" for a Combined Work means the
|
||||||
|
object code and/or source code for the Application, including any data
|
||||||
|
and utility programs needed for reproducing the Combined Work from the
|
||||||
|
Application, but excluding the System Libraries of the Combined Work.
|
||||||
|
|
||||||
|
1. Exception to Section 3 of the GNU GPL.
|
||||||
|
|
||||||
|
You may convey a covered work under sections 3 and 4 of this License
|
||||||
|
without being bound by section 3 of the GNU GPL.
|
||||||
|
|
||||||
|
2. Conveying Modified Versions.
|
||||||
|
|
||||||
|
If you modify a copy of the Library, and, in your modifications, a
|
||||||
|
facility refers to a function or data to be supplied by an Application
|
||||||
|
that uses the facility (other than as an argument passed when the
|
||||||
|
facility is invoked), then you may convey a copy of the modified
|
||||||
|
version:
|
||||||
|
|
||||||
|
a) under this License, provided that you make a good faith effort to
|
||||||
|
ensure that, in the event an Application does not supply the
|
||||||
|
function or data, the facility still operates, and performs
|
||||||
|
whatever part of its purpose remains meaningful, or
|
||||||
|
|
||||||
|
b) under the GNU GPL, with none of the additional permissions of
|
||||||
|
this License applicable to that copy.
|
||||||
|
|
||||||
|
3. Object Code Incorporating Material from Library Header Files.
|
||||||
|
|
||||||
|
The object code form of an Application may incorporate material from
|
||||||
|
a header file that is part of the Library. You may convey such object
|
||||||
|
code under terms of your choice, provided that, if the incorporated
|
||||||
|
material is not limited to numerical parameters, data structure
|
||||||
|
layouts and accessors, or small macros, inline functions and templates
|
||||||
|
(ten or fewer lines in length), you do both of the following:
|
||||||
|
|
||||||
|
a) Give prominent notice with each copy of the object code that the
|
||||||
|
Library is used in it and that the Library and its use are
|
||||||
|
covered by this License.
|
||||||
|
|
||||||
|
b) Accompany the object code with a copy of the GNU GPL and this license
|
||||||
|
document.
|
||||||
|
|
||||||
|
4. Combined Works.
|
||||||
|
|
||||||
|
You may convey a Combined Work under terms of your choice that,
|
||||||
|
taken together, effectively do not restrict modification of the
|
||||||
|
portions of the Library contained in the Combined Work and reverse
|
||||||
|
engineering for debugging such modifications, if you also do each of
|
||||||
|
the following:
|
||||||
|
|
||||||
|
a) Give prominent notice with each copy of the Combined Work that
|
||||||
|
the Library is used in it and that the Library and its use are
|
||||||
|
covered by this License.
|
||||||
|
|
||||||
|
b) Accompany the Combined Work with a copy of the GNU GPL and this license
|
||||||
|
document.
|
||||||
|
|
||||||
|
c) For a Combined Work that displays copyright notices during
|
||||||
|
execution, include the copyright notice for the Library among
|
||||||
|
these notices, as well as a reference directing the user to the
|
||||||
|
copies of the GNU GPL and this license document.
|
||||||
|
|
||||||
|
d) Do one of the following:
|
||||||
|
|
||||||
|
0) Convey the Minimal Corresponding Source under the terms of this
|
||||||
|
License, and the Corresponding Application Code in a form
|
||||||
|
suitable for, and under terms that permit, the user to
|
||||||
|
recombine or relink the Application with a modified version of
|
||||||
|
the Linked Version to produce a modified Combined Work, in the
|
||||||
|
manner specified by section 6 of the GNU GPL for conveying
|
||||||
|
Corresponding Source.
|
||||||
|
|
||||||
|
1) Use a suitable shared library mechanism for linking with the
|
||||||
|
Library. A suitable mechanism is one that (a) uses at run time
|
||||||
|
a copy of the Library already present on the user's computer
|
||||||
|
system, and (b) will operate properly with a modified version
|
||||||
|
of the Library that is interface-compatible with the Linked
|
||||||
|
Version.
|
||||||
|
|
||||||
|
e) Provide Installation Information, but only if you would otherwise
|
||||||
|
be required to provide such information under section 6 of the
|
||||||
|
GNU GPL, and only to the extent that such information is
|
||||||
|
necessary to install and execute a modified version of the
|
||||||
|
Combined Work produced by recombining or relinking the
|
||||||
|
Application with a modified version of the Linked Version. (If
|
||||||
|
you use option 4d0, the Installation Information must accompany
|
||||||
|
the Minimal Corresponding Source and Corresponding Application
|
||||||
|
Code. If you use option 4d1, you must provide the Installation
|
||||||
|
Information in the manner specified by section 6 of the GNU GPL
|
||||||
|
for conveying Corresponding Source.)
|
||||||
|
|
||||||
|
5. Combined Libraries.
|
||||||
|
|
||||||
|
You may place library facilities that are a work based on the
|
||||||
|
Library side by side in a single library together with other library
|
||||||
|
facilities that are not Applications and are not covered by this
|
||||||
|
License, and convey such a combined library under terms of your
|
||||||
|
choice, if you do both of the following:
|
||||||
|
|
||||||
|
a) Accompany the combined library with a copy of the same work based
|
||||||
|
on the Library, uncombined with any other library facilities,
|
||||||
|
conveyed under the terms of this License.
|
||||||
|
|
||||||
|
b) Give prominent notice with the combined library that part of it
|
||||||
|
is a work based on the Library, and explaining where to find the
|
||||||
|
accompanying uncombined form of the same work.
|
||||||
|
|
||||||
|
6. Revised Versions of the GNU Lesser General Public License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions
|
||||||
|
of the GNU Lesser General Public License from time to time. Such new
|
||||||
|
versions will be similar in spirit to the present version, but may
|
||||||
|
differ in detail to address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Library as you received it specifies that a certain numbered version
|
||||||
|
of the GNU Lesser General Public License "or any later version"
|
||||||
|
applies to it, you have the option of following the terms and
|
||||||
|
conditions either of that published version or of any later version
|
||||||
|
published by the Free Software Foundation. If the Library as you
|
||||||
|
received it does not specify a version number of the GNU Lesser
|
||||||
|
General Public License, you may choose any version of the GNU Lesser
|
||||||
|
General Public License ever published by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Library as you received it specifies that a proxy can decide
|
||||||
|
whether future versions of the GNU Lesser General Public License shall
|
||||||
|
apply, that proxy's public statement of acceptance of any version is
|
||||||
|
permanent authorization for you to choose that version for the
|
||||||
|
Library.
|
||||||
18
docs/oss/licenses/MIT.txt
Normal file
18
docs/oss/licenses/MIT.txt
Normal file
@@ -0,0 +1,18 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) <year> <copyright holders>
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
|
||||||
|
associated documentation files (the "Software"), to deal in the Software without restriction, including
|
||||||
|
without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
|
||||||
|
following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all copies or substantial
|
||||||
|
portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
|
||||||
|
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
|
||||||
|
EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
||||||
|
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
|
||||||
|
USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
77
docs/policy/agents.md
Normal file
77
docs/policy/agents.md
Normal file
@@ -0,0 +1,77 @@
|
|||||||
|
# Agent Policy
|
||||||
|
|
||||||
|
**Base Policy Version:** 1.1
|
||||||
|
|
||||||
|
**Last Updated:** 2026-09-26
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
Agents working in this repository must read and adhere to the following house rules.
|
||||||
|
|
||||||
|
## Implementation Discipline
|
||||||
|
|
||||||
|
**KEY PRINCIPLES:** Write the simplest idiomatic code that satisfies the user's
|
||||||
|
request. Do not implicitly strengthen requirements, restrictions, or guarantees
|
||||||
|
beyond what the user actually requested.
|
||||||
|
|
||||||
|
**Keep implementation machinery proportionate.** Use straightforward,
|
||||||
|
idiomatic code and introduce only the machinery needed to support the requested
|
||||||
|
behavior and flexibility. Optimize for conceptual simplicity and
|
||||||
|
maintainability, not for the fewest lines, fewest options, or narrowest product
|
||||||
|
surface.
|
||||||
|
|
||||||
|
**Do not invent restrictions.** Do not reject, prohibit, constrain, cap,
|
||||||
|
harden, or otherwise narrow behavior unless required by the user, an explicit
|
||||||
|
repository contract, or an unavoidable correctness constraint. Preserve
|
||||||
|
operator and caller choice where policy has not been established. If an
|
||||||
|
additional restriction appears advisable, present it as a decision rather than
|
||||||
|
silently implementing it.
|
||||||
|
|
||||||
|
**Do not invent guarantees.** Do not strengthen public contracts, guarantees,
|
||||||
|
or invariants beyond those expressly requested by the user.
|
||||||
|
|
||||||
|
**Use the standard library.** For example: in almost every case, the best
|
||||||
|
approach to copying files is to use the standard library. Writing custom code to
|
||||||
|
implement power-loss protection at the application level, or to guard against
|
||||||
|
bad actors with privileged and concurrent access to the host's filesystem,
|
||||||
|
is wasteful, unnecessary, and not idiomatic. Stick to the simple, standard, and
|
||||||
|
idiomatic approach unless another path is expressly requested by the user.
|
||||||
|
|
||||||
|
**An implementation detail is not repository policy.** Tests and documentation
|
||||||
|
must not elevate incidental behavior into a durable guarantee or restriction
|
||||||
|
unless that behavior was expressly selected as part of the contract.
|
||||||
|
|
||||||
|
## Git Commit Policy
|
||||||
|
|
||||||
|
By default, create a commit after completing each coherent unit of work, using a
|
||||||
|
concise, plain-English message describing what changed. This policy is standing
|
||||||
|
authorization to create those local commits; a separate user request is not
|
||||||
|
required. An explicit user instruction to leave work uncommitted takes precedence.
|
||||||
|
|
||||||
|
A unit of work is a focused, reviewable outcome, including its relevant tests and
|
||||||
|
documentation. Do not commit after every intermediate edit or create empty commits.
|
||||||
|
Complete the appropriate validation before committing. If work is incomplete or
|
||||||
|
validation is blocked, report that state rather than presenting it as completed.
|
||||||
|
|
||||||
|
Before committing:
|
||||||
|
|
||||||
|
1. Run `git status --short` and review the relevant diff, including any staged
|
||||||
|
changes. Identify changes that predate the current unit of work.
|
||||||
|
2. Exclude secrets, local environment files, generated junk, and unrelated changes.
|
||||||
|
3. Stage only the files or hunks belonging to the completed unit. Use `git add .`
|
||||||
|
only when every included change belongs to that unit. Do not disturb unrelated
|
||||||
|
staged or unstaged work.
|
||||||
|
4. Review `git diff --staged` and run appropriate checks for the change. Do not
|
||||||
|
repeat checks already passed for unchanged content merely to create a commit.
|
||||||
|
5. Review `git log --oneline -n 10` and use
|
||||||
|
`git commit -m "<concise plain-English commit message>"`.
|
||||||
|
6. Report the commit identifier and any remaining uncommitted work.
|
||||||
|
|
||||||
|
If the unit cannot be safely separated from pre-existing work, leave it uncommitted
|
||||||
|
and explain the overlap rather than silently including that work. If a commit
|
||||||
|
fails, preserve the changes and report the failure; do not bypass hooks.
|
||||||
|
|
||||||
|
Default commit authorization does not authorize pushing, publishing, amending,
|
||||||
|
resetting, reverting, or rewriting history. Those actions require a separate user
|
||||||
|
instruction. Do not use `git commit -a` or `git commit --no-verify` to bypass the
|
||||||
|
staging and validation discipline above.
|
||||||
@@ -1,118 +1,157 @@
|
|||||||
# Architecture
|
# Architecture Policy
|
||||||
|
|
||||||
This document is the development architecture policy for Scriptorium.
|
**Base Policy Version:** 1.1
|
||||||
|
|
||||||
It is for developers and LLM coding agents. User-facing behavior belongs in `README.md` and the docs under `docs/` that target operators/users.
|
**Last Updated:** 2026-09-26
|
||||||
|
|
||||||
## Project Shape
|
## Purpose And Ownership
|
||||||
|
|
||||||
Scriptorium is a narrow prompt-execution application with three entry paths:
|
This policy defines Scriptorium's purpose, responsibility and dependency
|
||||||
|
boundaries, established invariants, and non-goals. Concrete component inventory
|
||||||
|
and implementation mechanics belong in [internal documentation](../internal/overview.md);
|
||||||
|
public behavior belongs in its canonical contracts.
|
||||||
|
|
||||||
- CLI `run`
|
Adopted constraints govern future development without implying that every
|
||||||
- CLI `render`
|
capability they could govern exists or is planned. Keep proposed structure and
|
||||||
- HTTP `POST /v1/runs` through `serve`
|
implementation status in roadmaps, and decision rationale in ADRs. Acceptance
|
||||||
- public Go package `gitea.maximumdirect.net/eric/scriptorium`
|
of a decision is not proof of implementation. Do not turn incidental choices
|
||||||
|
into architectural invariants.
|
||||||
|
|
||||||
Domain behavior is centralized in `internal/usecase` and `internal/domain`.
|
## System Shape
|
||||||
|
|
||||||
## Core Principles
|
Scriptorium is an executable application with four command entry paths: CLI
|
||||||
|
`run`, CLI `render`, CLI `inspect`, and the HTTP service started by `serve`.
|
||||||
|
The `inspect` command has prompt and profile modes. Scriptorium does not expose
|
||||||
|
a reusable root Go package.
|
||||||
|
|
||||||
- Keep orchestration narrow: Scriptorium executes one prompt request; it is not a multi-step workflow engine.
|
The application consumes
|
||||||
- Keep adapter logic thin: adapters map external shapes to domain requests/results and should not hold domain decisions.
|
[Promptkit v0.11.0](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/docs/consumers/pkg-promptkit.md)
|
||||||
- Keep boundaries explicit: repositories/loaders/renderers/validators/LLM client stay behind package interfaces.
|
through its supported root package. Promptkit owns prompt execution,
|
||||||
- Keep config strict: YAML/JSON decoding for external inputs should reject unknown fields.
|
preparation, source formats, built-in profiles, model-client behavior, and
|
||||||
- Keep secrets out of payloads: raw API key values must not be accepted or emitted.
|
validation. Scriptorium owns application configuration, executable adapters,
|
||||||
|
prepared-run and definition-inspection presentation, process behavior, and HTTP
|
||||||
|
deployment policy.
|
||||||
|
|
||||||
## Package Boundaries
|
Scriptorium also consumes ConfigKit v0.4.0 for application configuration
|
||||||
|
decoding, resolution, and validation flow. Scriptorium owns its application
|
||||||
|
schema, defaults, normalization, validation rules, source selection, and CLI
|
||||||
|
flag mapping; ConfigKit does not own Promptkit framework sources or HTTP
|
||||||
|
artifact containment.
|
||||||
|
|
||||||
Current package map:
|
The concrete package inventory is maintained in the
|
||||||
|
[internal overview](../internal/overview.md).
|
||||||
|
|
||||||
- root package `scriptorium`: public Go facade over engine construction, source options, request/result types, and error mapping.
|
As established by [ADR 0004](../adr/0004-definition-boundary.md), Scriptorium
|
||||||
- `cmd/scriptorium`: process entrypoint.
|
aims to support the complete set of features in valid Promptkit prompt and
|
||||||
- `internal/adapter/cli`: command parsing, app wiring for CLI commands, output behavior.
|
profile definitions for its selected upstream version. Promptkit remains the
|
||||||
- `internal/adapter/http`: HTTP DTO mapping and error/status mapping.
|
canonical parser and validator. Library-only features are considered
|
||||||
- `internal/config`: application settings loading and CLI override precedence.
|
individually against the simple predefined-prompt execution model.
|
||||||
- `internal/defaults`: compile-time default constants.
|
|
||||||
- `internal/domain`: core request/result and contract types.
|
|
||||||
- `internal/usecase`: `Runner` prepare/run orchestration and repair-hook boundary.
|
|
||||||
- `internal/promptdef`: filesystem prompt-definition repository.
|
|
||||||
- `internal/profile`: filesystem, `fs.FS`, and overlay execution-profile repositories.
|
|
||||||
- `internal/profile/builtin`: embedded built-in execution profiles.
|
|
||||||
- `internal/filecatalog`: shared YAML discovery and `fs.FS` source helpers.
|
|
||||||
- `internal/artifact`: artifact reference readers.
|
|
||||||
- `internal/prompt`: template renderer.
|
|
||||||
- `internal/llm`: provider-neutral LLM client interface and OpenAI-compatible implementation.
|
|
||||||
- `internal/validate`: validator interfaces and standard implementation.
|
|
||||||
- `internal/format`: prepared-run output formatting.
|
|
||||||
|
|
||||||
Detailed component behavior is documented in:
|
Maintain adapter boundaries with proportionate, idiomatic code. This approach
|
||||||
|
does not require an interface for every type, additional wrappers, or a fixed
|
||||||
|
directory tree for integrations that do not exist.
|
||||||
|
|
||||||
- `docs/internal/runner.md`
|
## Dependency Direction
|
||||||
- `docs/internal/adapters.md`
|
|
||||||
- `docs/internal/sources.md`
|
|
||||||
|
|
||||||
## Configuration And Precedence
|
```text
|
||||||
|
cmd/scriptorium
|
||||||
|
|
|
||||||
|
v
|
||||||
|
CLI and HTTP adapters, configuration, defaults, and formatting
|
||||||
|
|
|
||||||
|
v
|
||||||
|
Promptkit (execution) and ConfigKit (application configuration)
|
||||||
|
```
|
||||||
|
|
||||||
Application settings are resolved as:
|
- Retained application packages may import Promptkit's root package.
|
||||||
|
- They must not import Promptkit `internal` packages.
|
||||||
|
- They must not import Promptkit catalog modules directly.
|
||||||
|
- They must not import the removed Scriptorium root facade or recreate former
|
||||||
|
framework package families.
|
||||||
|
- Adapter-owned interfaces use Promptkit public values when a consumer-side
|
||||||
|
substitution boundary is needed.
|
||||||
|
- Scriptorium passes omitted framework settings as zero values so Promptkit
|
||||||
|
applies its own defaults.
|
||||||
|
|
||||||
1. built-in defaults
|
The repository architecture guard enforces these import and removal
|
||||||
2. config file values
|
invariants.
|
||||||
3. CLI overrides
|
|
||||||
|
|
||||||
`config.yml` is for application wiring (directories, server address, render default format), not prompt/profile runtime execution settings.
|
Cross-project changes land and release in Promptkit before Scriptorium adopts
|
||||||
|
the tagged dependency. Do not commit Go workspaces, local replacements,
|
||||||
|
vendored Promptkit implementation, or unpublished dependency assumptions.
|
||||||
|
|
||||||
Profile selection and runtime model resolution remain use-case concerns.
|
## Retained Boundaries
|
||||||
|
|
||||||
## State And Persistence Policy
|
- `internal/adapter/cli` owns commands, flags, configuration precedence,
|
||||||
|
process streams, output files, summaries, and exit codes.
|
||||||
|
- `internal/adapter/http` owns routes, strict JSON DTOs, size limits, response
|
||||||
|
mapping, status mapping, and the restricted artifact reader.
|
||||||
|
- `internal/config` owns discovery and Scriptorium's application definition;
|
||||||
|
ConfigKit owns strict YAML decoding and the load/override pipeline.
|
||||||
|
- `internal/defaults` owns Scriptorium application and HTTP defaults only.
|
||||||
|
- `internal/format` owns deterministic prepared-run and definition-inspection
|
||||||
|
text and JSON presentation.
|
||||||
|
- Promptkit owns framework orchestration and contracts. Its
|
||||||
|
[format reference](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/docs/formats.md)
|
||||||
|
and
|
||||||
|
[outbound integration contract](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/docs/integrations/openai-compatible-chat.md)
|
||||||
|
are canonical.
|
||||||
|
|
||||||
Scriptorium has no durable run-state store.
|
## HTTP Artifact Security Boundary
|
||||||
|
|
||||||
- No built-in resume/checkpoint/archive behavior.
|
Ordinary CLI file loading is provided by Promptkit. Scriptorium's HTTP adapter
|
||||||
- Recovery model is rerun after correcting inputs/config/environment.
|
injects a restricted `promptkit.ArtifactReader` for inbound HTTP requests.
|
||||||
|
That reader denies file references without an artifact root, enforces the
|
||||||
|
configured byte limit, and applies Scriptorium's lexical root-containment rule.
|
||||||
|
The operating system still follows symlinks after the lexical check.
|
||||||
|
|
||||||
## External Integration Policy
|
This boundary handles untrusted request references under the documented
|
||||||
|
deployment model; it is not a filesystem sandbox. Defending against a
|
||||||
|
privileged actor concurrently modifying the host filesystem is outside the
|
||||||
|
adopted scope, not a claim that such activity cannot occur. Do not infer
|
||||||
|
additional defenses or guarantees from hypothetical threats; raise unsettled
|
||||||
|
scope decisions under the [agent policy](agents.md).
|
||||||
|
|
||||||
Current external contracts:
|
The [HTTP API](../api.md) owns observable request outcomes, and
|
||||||
|
[operations](../operations.md) owns deployment permissions and root selection.
|
||||||
|
|
||||||
- inbound HTTP contract: `POST /v1/runs`, documented canonically in `docs/api.md`
|
## State, Errors, And Secrets
|
||||||
- outbound model contract: OpenAI-compatible chat completions subset
|
|
||||||
- subprocess contract for integrators: CLI `run`/`render`
|
|
||||||
- public Go package contract: `docs/consumers/pkg-scriptorium.md`
|
|
||||||
|
|
||||||
Integration docs belong under `docs/integrations/`.
|
Scriptorium has no durable run-state store, checkpoint, cache, or resume
|
||||||
|
mechanism. Recovery is a new request after correcting inputs, configuration, or
|
||||||
|
environment.
|
||||||
|
|
||||||
## Error Handling And Logging
|
Each request is self-contained from the caller's perspective, without
|
||||||
|
conversation or workflow state retained from completed requests. This does
|
||||||
|
not mean the process is internally stateless. Shared engines, backend capacity
|
||||||
|
and queue accounting, in-flight coordination, cancellation, and server
|
||||||
|
lifecycle resources are permitted and must be shared where necessary to
|
||||||
|
enforce configured backend limits across concurrent requests. Such state must
|
||||||
|
be concurrency-safe and does not create a durable user-workflow contract.
|
||||||
|
|
||||||
- Wrap errors with domain/operation context.
|
Adapters map Promptkit public error identities into CLI exits or HTTP statuses
|
||||||
- Map domain errors to adapter-appropriate statuses/codes without leaking sensitive internals.
|
without classifying by message text. Raw API keys are not accepted in
|
||||||
- Keep stderr summaries concise for CLI success/error paths.
|
Scriptorium configuration, CLI arguments, or HTTP payloads, and resolved
|
||||||
- Never emit raw secret values.
|
secrets must not be emitted.
|
||||||
|
|
||||||
## Testing Expectations
|
|
||||||
|
|
||||||
- Core runner behavior should be covered with isolated unit tests and fixture-based integration tests.
|
|
||||||
- Adapter behavior should be tested for parse/mapping/error semantics.
|
|
||||||
- Config parsing, prompt/profile loading, validator behavior, and LLM client error handling should remain covered by package tests.
|
|
||||||
- Repository-level docs/examples that claim runnable behavior should be validated by tests or smoke commands.
|
|
||||||
|
|
||||||
## Documentation Expectations
|
|
||||||
|
|
||||||
- Document implemented behavior only outside `docs/roadmap/`.
|
|
||||||
- Keep canonical reference locations stable (`docs/cli.md`, `docs/config.md`, `docs/operations.md`, `docs/troubleshooting.md`, `docs/internal/`).
|
|
||||||
- Update docs in the same change when architecture-relevant behavior changes.
|
|
||||||
|
|
||||||
## Architectural Invariants
|
## Architectural Invariants
|
||||||
|
|
||||||
- `Runner.Run` reuses `Runner.Prepare` flow.
|
- External YAML and JSON decoding remains strict.
|
||||||
- CLI and HTTP currently instantiate `Runner` without a repairer.
|
- CLI and HTTP behavior remains presentation and transport logic rather than
|
||||||
- Artifact reading supports `inline` and `file` references.
|
framework orchestration.
|
||||||
- Unknown input fields in config/prompt/profile/http JSON should be rejected by strict decoding.
|
- Explicit numeric request overrides preserve presence, including zero.
|
||||||
- Raw API key values must not be accepted through config/HTTP payloads.
|
- HTTP artifact containment and byte limits remain Scriptorium policy.
|
||||||
|
- No application package depends on Promptkit implementation packages.
|
||||||
|
|
||||||
## Non-Goals
|
## Non-Goals
|
||||||
|
|
||||||
- Do not move orchestration responsibilities from external callers into Scriptorium.
|
- Do not recreate an in-process Scriptorium framework API or compatibility
|
||||||
- Do not add adapter-specific business logic in `internal/adapter/*` packages.
|
facade.
|
||||||
- Do not bypass repository/renderer/validator/LLM boundaries by introducing cross-package coupling.
|
- Do not copy Promptkit types, defaults, built-in profiles, or implementation
|
||||||
|
into Scriptorium.
|
||||||
|
- Do not move CLI, inbound HTTP, process, or deployment policy into Promptkit.
|
||||||
|
- Do not add durable workflow, archive, or resume behavior.
|
||||||
|
- Do not add application-managed prompt modification, follow-up message flows,
|
||||||
|
conversation management, or multi-step workflow orchestration.
|
||||||
|
|
||||||
Work that is not implemented belongs in `docs/roadmap/`.
|
Work that is not implemented belongs in `docs/roadmap/`.
|
||||||
|
|||||||
@@ -1,110 +0,0 @@
|
|||||||
# Development Guide
|
|
||||||
|
|
||||||
This document defines contributor workflow for Scriptorium.
|
|
||||||
|
|
||||||
## Repository Layout
|
|
||||||
|
|
||||||
- root package `scriptorium`: public Go facade, options, types, and error mapping.
|
|
||||||
- `cmd/scriptorium`: application entrypoint.
|
|
||||||
- `internal/domain`: core contracts.
|
|
||||||
- `internal/usecase`: runner orchestration.
|
|
||||||
- `internal/adapter/cli`: CLI adapter.
|
|
||||||
- `internal/adapter/http`: HTTP adapter.
|
|
||||||
- `internal/config`: application settings loading and precedence.
|
|
||||||
- `internal/defaults`: default constants.
|
|
||||||
- `internal/promptdef`: prompt-definition repository.
|
|
||||||
- `internal/profile`: execution-profile repository.
|
|
||||||
- `internal/profile/builtin`: embedded built-in execution profiles.
|
|
||||||
- `internal/filecatalog`: shared source discovery and path helpers.
|
|
||||||
- `internal/artifact`: artifact readers.
|
|
||||||
- `internal/prompt`: prompt rendering.
|
|
||||||
- `internal/llm`: LLM client interface and OpenAI-compatible implementation.
|
|
||||||
- `internal/validate`: validation interfaces and implementation.
|
|
||||||
- `internal/format`: prepared-run formatting.
|
|
||||||
- `docs/`: canonical documentation.
|
|
||||||
- `examples/`: copyable maintained examples and fixtures.
|
|
||||||
|
|
||||||
## Common Commands
|
|
||||||
|
|
||||||
Build:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
go build ./cmd/scriptorium
|
|
||||||
```
|
|
||||||
|
|
||||||
Test:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
go test ./...
|
|
||||||
```
|
|
||||||
|
|
||||||
Targeted test runs commonly used during changes:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
go test .
|
|
||||||
go test ./internal/adapter/cli ./internal/adapter/http ./internal/usecase
|
|
||||||
go test ./internal/...
|
|
||||||
```
|
|
||||||
|
|
||||||
## Coding Conventions
|
|
||||||
|
|
||||||
- Prefer small interfaces at package boundaries.
|
|
||||||
- Keep adapter packages focused on translation and IO concerns.
|
|
||||||
- Keep domain/use-case logic outside adapters.
|
|
||||||
- Wrap errors with operation context.
|
|
||||||
- Use strict decoding for user-provided YAML/JSON where applicable.
|
|
||||||
- Avoid introducing dependencies unless they materially reduce risk/complexity.
|
|
||||||
|
|
||||||
## Dependency Policy
|
|
||||||
|
|
||||||
- Prefer standard library unless an external library is clearly justified.
|
|
||||||
- Current non-stdlib dependencies are intentionally small:
|
|
||||||
- `gopkg.in/yaml.v3` for YAML decoding.
|
|
||||||
- `github.com/santhosh-tekuri/jsonschema/v6` for JSON Schema validation.
|
|
||||||
- Do not leak dependency-specific types across unrelated package boundaries.
|
|
||||||
|
|
||||||
## How To Add App Config Fields
|
|
||||||
|
|
||||||
1. Add fields in `internal/config/config.go` (`Config`, `AppSettings`, and/or `CLIOverrides` as needed).
|
|
||||||
2. Apply defaults in `BuiltInDefaults()` when required.
|
|
||||||
3. Parse and validate in `applyConfig` / `ApplyCLIOverrides`.
|
|
||||||
4. Wire the field through the consuming adapter(s).
|
|
||||||
5. Add/update config tests in `internal/config/config_test.go`.
|
|
||||||
6. Update canonical docs (`docs/config.md`, and other affected docs).
|
|
||||||
|
|
||||||
## How To Add CLI Flags
|
|
||||||
|
|
||||||
1. Add flags in `internal/adapter/cli/run.go` for the relevant command.
|
|
||||||
2. Ensure precedence behavior remains consistent with app config rules.
|
|
||||||
3. Keep `run`, `render`, and `serve` flag surfaces intentionally scoped.
|
|
||||||
4. Add/update parser and command tests in `internal/adapter/cli/run_test.go`.
|
|
||||||
5. Update `docs/cli.md` and any related docs/examples.
|
|
||||||
|
|
||||||
## How To Add Adapters Or Adapter Capabilities
|
|
||||||
|
|
||||||
1. Define or reuse the appropriate interface boundary in domain/use-case packages.
|
|
||||||
2. Implement adapter code under `internal/adapter/<name>` (or relevant boundary package).
|
|
||||||
3. Keep business decisions in `internal/usecase`.
|
|
||||||
4. Add focused adapter tests for mapping, parse, and error behavior.
|
|
||||||
5. Document the new/changed boundary in `docs/internal/adapters.md`.
|
|
||||||
6. If source-loading behavior changes, update `docs/internal/sources.md`.
|
|
||||||
7. If an external contract changes, update the canonical public or integration doc in the same change.
|
|
||||||
|
|
||||||
## How To Update Prompt/Profile/Schema Assets
|
|
||||||
|
|
||||||
1. Keep prompt/profile/schema files valid under strict loaders.
|
|
||||||
2. Keep examples secret-free.
|
|
||||||
3. Re-run tests that cover prompt/profile/validation behavior.
|
|
||||||
4. Update `docs/config.md` and any docs that reference changed contracts.
|
|
||||||
|
|
||||||
## Documentation Update Expectations
|
|
||||||
|
|
||||||
When behavior changes:
|
|
||||||
|
|
||||||
1. Update canonical doc locations, not duplicate files.
|
|
||||||
2. Keep non-roadmap docs limited to implemented behavior.
|
|
||||||
3. Update links after file moves/renames.
|
|
||||||
4. Re-run relevant tests and smoke commands.
|
|
||||||
5. For internal boundary docs, check references with `rg "docs/internal|internal/sources" docs/policy docs/internal`.
|
|
||||||
|
|
||||||
Docs work is complete only when code/tests/examples/docs agree.
|
|
||||||
@@ -1,446 +1,200 @@
|
|||||||
# Go Project Documentation Policy
|
# Documentation Policy
|
||||||
|
|
||||||
|
**Base Policy Version:** 1.4
|
||||||
|
|
||||||
|
**Last Updated:** 2026-09-26
|
||||||
|
|
||||||
## Purpose
|
## Purpose
|
||||||
|
|
||||||
Project documentation must help five audiences:
|
This policy assigns each documentation topic to one canonical owner. Its goal is
|
||||||
|
to keep this repository's documentation accurate, concise, discoverable, and
|
||||||
1. users who need to run the application;
|
resistant to drift for users, operators, developers, integrators, and LLM
|
||||||
2. administrators/operators who need to configure and operate it;
|
coding agents.
|
||||||
3. developers who need to understand and change it safely;
|
|
||||||
4. LLM coding agents that need clear scope, boundaries, and invariants;
|
|
||||||
5. developers and LLM coding agents integrating this project from another codebase.
|
|
||||||
|
|
||||||
Docs should be accurate, concise, task-oriented, and organized by audience. Prefer links to canonical docs over repetition.
|
|
||||||
|
|
||||||
## Core Rules
|
## Core Rules
|
||||||
|
|
||||||
### 1. Keep docs concise
|
### One Canonical Owner
|
||||||
|
|
||||||
Each document should cover a defined scope and only the essentials for that scope.
|
Each authoritative fact belongs in one document. A non-owning document may give
|
||||||
|
a short, stable summary for orientation, but it must link to the canonical owner
|
||||||
Avoid:
|
instead of repeating volatile details.
|
||||||
- long background explanations;
|
|
||||||
- repeated reference material;
|
Volatile details include commands, flags, configuration fields and defaults,
|
||||||
- implementation detail in user-facing docs;
|
module keys, schemas, file names, paths, status codes, retry behavior, and
|
||||||
- aspirational language outside roadmap docs;
|
runtime guarantees. If readers could reasonably treat a statement as a
|
||||||
- verbose examples where one minimal example is clearer.
|
contract, maintain it only in the owning document.
|
||||||
|
|
||||||
### 2. Document only implemented behavior outside roadmap files
|
Minimal tested usage examples are allowed outside the owning contract when this
|
||||||
|
policy assigns them an orientation or instructional purpose. They must link to
|
||||||
Unimplemented, planned, aspirational, experimental, or future work may be described only under:
|
the canonical contract and must not redefine complete syntax, defaults, or
|
||||||
|
semantics.
|
||||||
- `docs/roadmap/`
|
|
||||||
|
### Current And Future Behavior
|
||||||
No other documentation file, including `README.md`, should describe code, features, modules, stages, commands, config fields, or behaviors that do not currently exist.
|
|
||||||
|
Outside `docs/roadmap/`, documentation describes implemented behavior only.
|
||||||
If a feature is partial, non-roadmap docs may describe only the implemented portion and its current boundary.
|
Partial features may be described only to their implemented boundary.
|
||||||
|
|
||||||
### 3. Use canonical homes
|
Architectural constraints may govern future changes without implying that the
|
||||||
|
components or capabilities they would govern already exist. This does not
|
||||||
Each type of information should have one canonical location.
|
permit describing a proposed system structure as implemented.
|
||||||
|
|
||||||
Canonical homes:
|
ADRs may record an accepted architectural decision before implementation, but
|
||||||
|
acceptance must not be presented as proof that the behavior exists. The roadmap
|
||||||
- project purpose and quickstart: `README.md`
|
owns implementation status and sequencing until the decision is implemented.
|
||||||
- development principles: `docs/policy/architecture.md`
|
Current architecture, user, operator,
|
||||||
- public HTTP API reference: `docs/api.md`
|
integration, and internal documentation are updated when the behavior lands.
|
||||||
- configuration reference: `docs/config.md`
|
|
||||||
- CLI reference: `docs/cli.md`
|
### Audience And Detail
|
||||||
- operations and recovery: `docs/operations.md`
|
|
||||||
- troubleshooting: `docs/troubleshooting.md`
|
Write for the document's stated audience and include only the detail needed for
|
||||||
- public API/package consumer guidance: `docs/consumers/`
|
its owned topic. User and operator docs should not expose implementation detail.
|
||||||
- implemented internals: `docs/internal/`
|
Developer docs should link to user-facing and external contracts rather than
|
||||||
- external protocol, service, and file-format contracts: `docs/integrations/`
|
restate them.
|
||||||
- future work: `docs/roadmap/`
|
|
||||||
- contributor workflow: `docs/policy/development.md`
|
### Examples
|
||||||
- copyable examples: `examples/`
|
|
||||||
|
Complete copyable files belong in `examples/`. Documentation may use the
|
||||||
Other files should summarize briefly and link to the canonical source.
|
smallest illustrative snippet needed to explain its owned topic, but should link
|
||||||
|
to maintained examples instead of embedding a second complete copy.
|
||||||
### 4. Keep examples real
|
|
||||||
|
Examples must be valid, secret-free, and tested where practical. Commands and
|
||||||
Examples should be valid, maintained, and free of secrets.
|
configuration used in documentation should match the application.
|
||||||
|
|
||||||
Where practical:
|
### Security And Privacy
|
||||||
- example configs should load successfully;
|
|
||||||
- example commands should match real CLI syntax;
|
Documentation and examples must not contain real credentials, private keys,
|
||||||
- important examples should be covered by tests.
|
private environment dumps, sensitive source material, or private infrastructure
|
||||||
|
details unless intentionally public. Document secret-handling mechanisms, not
|
||||||
## Documentation Profiles
|
secret values.
|
||||||
|
|
||||||
All projects require:
|
## Canonical Ownership
|
||||||
|
|
||||||
- `README.md`
|
| Topic | Canonical owner | Owned content | Content owned elsewhere |
|
||||||
- `docs/policy/architecture.md`
|
| --- | --- | --- | --- |
|
||||||
|
| Product orientation and minimal end-to-end quickstart | `README.md` | What this project is, why it is useful, one shortest successful invocation, and links onward, including license and attribution navigation. | Complete command reference, configuration reference, operational procedures, implementation detail. |
|
||||||
Additional docs depend on the project.
|
| Contributor entry point | `docs/development.md` | Task-oriented reading guide, minimal contributor orientation, baseline validation commands, and links to canonical docs. | Package inventory, architecture rules, subsystem behavior, and detailed change recipes, which belong in the relevant internal component document. |
|
||||||
|
| Application architecture policy | `docs/policy/architecture.md` | System shape, normative ownership, dependency direction, architectural boundaries, invariants, safety properties, and non-goals. | Concrete package inventory, implementation mechanics, contributor procedures, decision history, future work. |
|
||||||
### Small library
|
| Agent policy | `docs/policy/agents.md` | Agent implementation discipline, proportionality, idiomatic simplicity, local commit rules, and rules against inventing requirements, restrictions, guarantees, or repository policy. | Application contracts, architecture, testing policy, and contributor procedures. |
|
||||||
|
| Documentation organization | `docs/policy/documentation.md` | Documentation ownership, audience boundaries, maintenance rules, and ADR/document lifecycle. | Application architecture or product behavior. |
|
||||||
Recommended:
|
| Testing policy | `docs/policy/testing.md` | Test philosophy, risk-based sufficiency, test boundaries, doubles, coverage guidance, regression-test policy, and criteria for adding, rewriting, or deleting tests. | Subsystem behavior, application contracts, subsystem-specific test inventories, and implementation plans. |
|
||||||
- `docs/policy/development.md`, if contributor conventions are non-obvious
|
| CLI contract | `docs/cli.md` | Commands, arguments, flags, invocation semantics, and exit codes. | End-to-end operating procedures, configuration field definitions, runtime filesystem layout, module implementation details. |
|
||||||
|
| Configuration contract | `docs/config.md` | Application discovery and precedence, source locations, server fields, render default, HTTP limits, and credential mapping. | Promptkit framework formats and defaults, complete example files, CLI syntax, runtime lifecycle, and implementation detail. |
|
||||||
### Simple CLI
|
| Operations | `docs/operations.md` | Runtime workflows, physical filesystem and state layout, output, cache, and debug handling, resume, cleanup, permissions, recovery, and operational limits. | CLI flag syntax, configuration field definitions, logical output schemas, implementation mechanics. |
|
||||||
|
| Release policy | `docs/policy/release.md` | Versioning and compatibility, release integrity and immutability, documentation requirements, proportionate gates, publication controls, source completion, and optional verification boundaries. | Repository-specific commands, installation guidance, historical summaries, and CI implementation details. |
|
||||||
Required:
|
| Release procedure | `docs/release.md` | Maintainer prerequisites, candidate preparation, publication command and guards, asynchronous delivery, optional diagnostics, and failure recovery. | General release requirements, runtime operations, historical announcements, and current application contracts. |
|
||||||
- `docs/cli.md`
|
| Version-specific release notes | `docs/releases/` | Immutable release summaries, compatibility notices, and migration announcements for one published version. | Complete CLI, HTTP, configuration, operations, or dependency contracts. |
|
||||||
|
| Open source licensing and attribution policy | `docs/policy/oss.md` | House attribution format, license-text and notice-link conventions, discoverability, maintenance, and handling of concrete exceptions. | Component entries, license texts, release commands, and dependency security review. |
|
||||||
Recommended:
|
| Project license | `LICENSE` | The project's own license terms. | Upstream component attribution and dependency license texts. |
|
||||||
- `docs/policy/development.md`
|
| Upstream component attribution | `docs/oss/attribution.md` | Component names, copyright statements, license identification, and license, notice, and source links. | General attribution policy and complete standard license texts. |
|
||||||
|
| Standard dependency license texts | `docs/oss/licenses/` | Complete, verbatim standard license texts shared by attribution entries where applicable. | Project-specific upstream notices, attribution prose, and policy interpretation. |
|
||||||
### Config-driven CLI
|
| Public HTTP contract | `docs/api.md` | Routes, authentication, media types, request and response schemas, status codes, pagination, caching, idempotency, rate limits, and HTTP retry semantics. | Client walkthroughs, upstream or downstream integration internals, implementation detail. |
|
||||||
|
| Consumer guidance | `docs/consumers/` | Choosing between Scriptorium's executable interfaces and understanding consumer responsibilities. | HTTP wire semantics, CLI syntax, Promptkit's Go package, and internal implementation detail. |
|
||||||
Required:
|
| External and durable integration contracts | `docs/integrations/` | Scriptorium-owned process and executable integration contracts. | Promptkit framework formats and outbound provider protocols, physical runtime placement, internal transformations, CLI syntax, and configuration defaults. |
|
||||||
- `docs/cli.md`
|
| Implemented component inventory | `docs/internal/overview.md` | Current packages and components, their implemented responsibilities, and links to focused internal docs. | Normative architecture, contributor reading policy, external contracts. |
|
||||||
- `docs/config.md`
|
| Internal component behavior | Other files under `docs/internal/` | Implementation flow, internal collaborators and state transitions, package-local guarantees and failures, and relevant tests. | Global architecture invariants, configuration definitions and defaults, external schemas, operator procedures. |
|
||||||
|
| Architectural decision history | `docs/adr/` | Significant decisions, context, alternatives, rationale, consequences, and supersession history. | Current behavior reference, implementation status, task sequencing. |
|
||||||
Recommended:
|
| Future work and implementation status | `docs/roadmap/` | Proposed, accepted, deferred, or rejected work; implementation status; sequencing; and task breakdowns. | Implemented behavior reference and architectural decision rationale. |
|
||||||
- `examples/`
|
| Complete copyable artifacts | `examples/` | Maintained configuration, inputs, and other files intended to be copied or run. | Field-by-field reference, command reference, prose explanation. |
|
||||||
- `docs/policy/development.md`
|
|
||||||
|
Documents that do not exist are required only when the corresponding interface
|
||||||
### Stateful or operator-facing application
|
or responsibility exists. Do not create placeholder API, consumer, integration,
|
||||||
|
or operations documents for behavior the application does not have.
|
||||||
Required:
|
|
||||||
- `docs/cli.md`, if CLI-based
|
## Boundary Rules
|
||||||
- `docs/config.md`, if config-driven
|
|
||||||
- `docs/operations.md`
|
### Orientation
|
||||||
|
|
||||||
Recommended:
|
The README owns product orientation. The developer guide routes contributors.
|
||||||
- `docs/troubleshooting.md`
|
Architecture owns normative structure. Internal overview owns the current
|
||||||
- `examples/`
|
concrete component map. These documents may link to one another but should not
|
||||||
- `docs/policy/development.md`
|
maintain parallel package or behavior descriptions.
|
||||||
|
|
||||||
### Modular, service-oriented, or orchestration application
|
### Commands, Configuration, And Operations
|
||||||
|
|
||||||
Required:
|
CLI documentation answers how to invoke the application. Configuration
|
||||||
- `docs/cli.md`, if CLI-based
|
documentation answers what settings mean. Operations answers what happens to
|
||||||
- `docs/config.md`, if config-driven
|
runtime state and how to operate or recover the application. When a workflow
|
||||||
- `docs/operations.md`
|
crosses these topics, choose the document that owns the task and link to the
|
||||||
- `docs/internal/`
|
other contracts.
|
||||||
- `docs/policy/development.md`
|
|
||||||
|
### Releases
|
||||||
Recommended:
|
|
||||||
- `docs/troubleshooting.md`
|
The release policy owns release requirements; the release procedure supplies
|
||||||
- validated examples under `examples/`
|
the commands that satisfy them. Release notes are historical summaries, not
|
||||||
|
current-state contract owners. The checked-in note at an immutable tag records
|
||||||
### Public HTTP API service
|
that release; current documentation changes with the behavior it describes.
|
||||||
|
Neither a procedure nor a note may weaken policy or defer required updates to
|
||||||
Required:
|
canonical contracts.
|
||||||
- `docs/api.md`
|
|
||||||
- `docs/cli.md`, if CLI-based
|
### Open Source Attribution
|
||||||
- `docs/config.md`, if config-driven
|
|
||||||
- `docs/operations.md`
|
The [OSS policy](oss.md) defines the House Format and README and release-link
|
||||||
- `docs/internal/`
|
conventions. Attribution entries own component-specific information. README
|
||||||
- `docs/policy/development.md`
|
and release documents provide navigation to those canonical materials; the
|
||||||
|
release procedure owns URL construction and publication mechanics.
|
||||||
Recommended:
|
|
||||||
- `docs/troubleshooting.md`
|
### Contracts And Implementation
|
||||||
- `docs/consumers/`, for task-oriented client integration guides
|
|
||||||
- `docs/integrations/`, for upstream/downstream service contracts
|
Integration and API documents define externally observable shapes and
|
||||||
- validated examples under `examples/`
|
semantics. Internal documents explain how this project implements or consumes
|
||||||
|
those contracts. Internal docs may name a field, file, or protocol to identify
|
||||||
### Project with public packages or consumer APIs
|
a dependency, but must link to its canonical contract for the definition.
|
||||||
|
|
||||||
Required:
|
### Security Topics
|
||||||
- `docs/consumers/api.md`
|
|
||||||
- one `docs/consumers/pkg-<name>.md` file per public package, if public packages exist
|
This policy owns what documentation and examples may contain. Architecture owns
|
||||||
|
application security invariants. Configuration owns credential-supply
|
||||||
Recommended:
|
mechanisms. Operations owns permissions and handling of sensitive runtime
|
||||||
- copyable consumer examples under `examples/`, if practical
|
artifacts. Internal docs own implementation mechanisms only.
|
||||||
|
|
||||||
## Required Documents
|
## Architecture Decision Records
|
||||||
|
|
||||||
### README.md
|
Use sequentially numbered ADR filenames such as
|
||||||
|
`0001-record-architecture-decisions.md`. Follow the lightweight Nygard format:
|
||||||
**Audience:** users, administrators, operators
|
|
||||||
|
1. title;
|
||||||
The README is the outward-facing project orientation page.
|
2. status;
|
||||||
|
3. date;
|
||||||
It should include, in order:
|
4. context;
|
||||||
|
5. decision;
|
||||||
1. concise description;
|
6. alternatives considered;
|
||||||
2. elevator pitch;
|
7. consequences.
|
||||||
3. shortest useful command or usage example;
|
|
||||||
4. links to targeted docs.
|
Use one of these statuses:
|
||||||
|
|
||||||
The README should be short. It is not a manual.
|
- **Proposed:** the decision is under consideration and may change;
|
||||||
|
- **Accepted:** the decision is approved, whether or not implementation is
|
||||||
The “shortest useful command” means the simplest command that performs the project’s core use case. (It does not mean `app --help`.)
|
complete;
|
||||||
|
- **Rejected:** the proposed decision was considered and not adopted;
|
||||||
### docs/policy/architecture.md
|
- **Superseded:** a later ADR replaces the accepted decision.
|
||||||
|
|
||||||
**Audience:** developers, LLM coding agents
|
A proposed ADR transitions to accepted or rejected. An accepted ADR transitions
|
||||||
|
to superseded only when a later accepted ADR replaces it. An ADR may be created
|
||||||
`docs/policy/architecture.md` is required for every project.
|
as accepted when the decision has already been made.
|
||||||
|
|
||||||
It is an inward-facing development policy document. It should describe how the project is intended to be built and changed.
|
Treat the decision content of an accepted ADR as immutable. Its status and
|
||||||
|
supersession metadata may be updated, but a changed decision requires a new ADR.
|
||||||
It should include:
|
A superseded ADR must link to its replacement, and the replacement must link
|
||||||
|
back to the superseded ADR. Rejected architectural alternatives belong in the
|
||||||
- project shape;
|
ADR; rejected product ideas belong in the roadmap.
|
||||||
- core design principles;
|
|
||||||
- package and boundary philosophy;
|
## Maintenance
|
||||||
- state/persistence philosophy, if applicable;
|
|
||||||
- external integration philosophy, if applicable;
|
Every policy document records its underlying template version and local
|
||||||
- error-handling and logging principles;
|
last-updated date immediately below the title. Update the date when revising
|
||||||
- testing expectations;
|
local policy; change the base version only when adopting a newer template.
|
||||||
- documentation expectations;
|
Do not retain template adoption instructions in the local policy.
|
||||||
- architectural invariants;
|
|
||||||
- explicit non-goals, if useful.
|
When behavior changes, update its canonical owner in the same change. If
|
||||||
|
ownership moves, remove the old definition and replace it with a link where
|
||||||
Notably, this file should prescribe a core development *policy* that should remain unchanged as the application evolves. It is not a place for details (e.g., CLI flags) that could change over time.
|
navigation remains useful.
|
||||||
|
|
||||||
The contents of `architecture.md` should be trim and concise. LLMs may be directed to review it routinely via AGENTS.md, CLAUDE.md, or similar.
|
Before completing documentation work:
|
||||||
|
|
||||||
### docs/api.md
|
- verify affected behavior and examples;
|
||||||
|
- check commands, flags, fields, defaults, schemas, and paths against their
|
||||||
**Audience:** external HTTP API consumers, developers, LLM coding agents integrating by HTTP
|
implementation;
|
||||||
|
- keep unimplemented behavior in the roadmap, subject to the ADR exception;
|
||||||
Required for projects whose primary public interface is HTTP.
|
- remove stale references and validate links;
|
||||||
|
- confirm that non-owning documents summarize and link rather than redefine;
|
||||||
`docs/api.md` is the canonical public HTTP API contract. It should be normative for external consumers and should not be duplicated by README, operations docs, consumer guides, or integration docs.
|
- confirm that no secrets or sensitive private data were added.
|
||||||
|
|
||||||
It should include:
|
|
||||||
|
|
||||||
1. base URL conventions;
|
|
||||||
2. authentication and authorization behavior, if implemented;
|
|
||||||
3. response envelope;
|
|
||||||
4. supported media types and content negotiation behavior;
|
|
||||||
5. shared query parameters;
|
|
||||||
6. endpoint reference grouped by route family;
|
|
||||||
7. request parameters and validation rules;
|
|
||||||
8. response fields, units, nullability, and optionality;
|
|
||||||
9. error response shape and status codes;
|
|
||||||
10. pagination, caching, rate-limit, idempotency, and retry behavior, if implemented;
|
|
||||||
11. compact request and response examples.
|
|
||||||
|
|
||||||
It must document only implemented endpoints and behavior. Planned endpoints, proposed fields, future filters, and experimental response shapes belong only under `docs/roadmap/`.
|
|
||||||
|
|
||||||
For HTTP API projects, `docs/consumers/` may provide task-oriented client integration guides, but those guides should link to `docs/api.md` for the authoritative endpoint contract.
|
|
||||||
|
|
||||||
### docs/policy/development.md
|
|
||||||
|
|
||||||
**Audience:** developers, LLM coding agents
|
|
||||||
|
|
||||||
Required for projects maintained by humans and LLM coding agents.
|
|
||||||
|
|
||||||
It should include:
|
|
||||||
|
|
||||||
- repository layout;
|
|
||||||
- build/test commands;
|
|
||||||
- coding conventions;
|
|
||||||
- dependency policy;
|
|
||||||
- how to add config fields;
|
|
||||||
- how to add CLI flags;
|
|
||||||
- how to add modules or adapters, if applicable;
|
|
||||||
- how to update examples;
|
|
||||||
- documentation update expectations.
|
|
||||||
|
|
||||||
### docs/config.md
|
|
||||||
|
|
||||||
**Audience:** administrators, operators, advanced users
|
|
||||||
|
|
||||||
Required for applications with configuration files.
|
|
||||||
|
|
||||||
It should include, in order:
|
|
||||||
|
|
||||||
1. config file locations and discovery precedence;
|
|
||||||
2. minimal working config;
|
|
||||||
3. production-oriented config;
|
|
||||||
4. full configuration reference;
|
|
||||||
5. secrets handling, if applicable;
|
|
||||||
6. links to maintained examples.
|
|
||||||
|
|
||||||
The full configuration reference should be canonical.
|
|
||||||
|
|
||||||
### docs/cli.md
|
|
||||||
|
|
||||||
**Audience:** users, administrators, operators
|
|
||||||
|
|
||||||
Required for CLI applications.
|
|
||||||
|
|
||||||
It should include, in order:
|
|
||||||
|
|
||||||
1. shortest useful command;
|
|
||||||
2. command overview;
|
|
||||||
3. complete flag reference;
|
|
||||||
4. common workflows;
|
|
||||||
5. diagnostic or recovery commands, if applicable.
|
|
||||||
|
|
||||||
Explain when commands are useful, not just their syntax.
|
|
||||||
|
|
||||||
### docs/operations.md
|
|
||||||
|
|
||||||
**Audience:** administrators, operators
|
|
||||||
|
|
||||||
Required for applications that maintain state, support resume behavior, run multi-step workflows, write durable artifacts, use remote storage, or require recovery procedures.
|
|
||||||
|
|
||||||
It should cover:
|
|
||||||
|
|
||||||
- normal workflow;
|
|
||||||
- filesystem layout;
|
|
||||||
- remote storage layout, if applicable;
|
|
||||||
- logs and manifests;
|
|
||||||
- resume/retry behavior;
|
|
||||||
- cleanup behavior;
|
|
||||||
- archive/backup behavior;
|
|
||||||
- safe recovery procedures;
|
|
||||||
- operational caveats.
|
|
||||||
|
|
||||||
### docs/troubleshooting.md
|
|
||||||
|
|
||||||
**Audience:** administrators, operators
|
|
||||||
|
|
||||||
Recommended once recurring failure modes exist.
|
|
||||||
|
|
||||||
Each entry should include:
|
|
||||||
|
|
||||||
- symptom;
|
|
||||||
- likely cause;
|
|
||||||
- diagnostic command or inspection step;
|
|
||||||
- safe fix;
|
|
||||||
- relevant links.
|
|
||||||
|
|
||||||
### docs/consumers/
|
|
||||||
|
|
||||||
**Audience:** developers and LLM coding agents integrating this project from another codebase
|
|
||||||
|
|
||||||
Required for projects with public packages, SDKs, client APIs, plugin APIs, or other application-facing integration surfaces.
|
|
||||||
|
|
||||||
This directory describes how an external codebase should consume the project's public API. It should be task-oriented and copyable where useful. It is not the place for internal implementation details or operator procedures.
|
|
||||||
|
|
||||||
For projects whose public API is HTTP, `docs/consumers/` is not required, and it should not duplicate the endpoint reference in `docs/api.md`. If present, it may provide practical integration workflows, client-specific examples, or migration notes that link back to `docs/api.md`.
|
|
||||||
|
|
||||||
`docs/consumers/api.md` should provide the consumer-facing overview and primary implementation workflow. It should include:
|
|
||||||
|
|
||||||
1. intended consumer audience and use cases;
|
|
||||||
2. required inputs supplied by operators or deployment configuration;
|
|
||||||
3. recommended public package or API workflow;
|
|
||||||
4. minimal copyable example;
|
|
||||||
5. consumer responsibilities and boundaries;
|
|
||||||
6. retry, idempotency, or status behavior, if applicable;
|
|
||||||
7. links to package-specific docs and canonical integration contracts.
|
|
||||||
|
|
||||||
Package-specific docs should be named `pkg-<name>.md` and should include:
|
|
||||||
|
|
||||||
1. import path;
|
|
||||||
2. intended use cases;
|
|
||||||
3. primary types and functions needed by consumers;
|
|
||||||
4. minimal examples;
|
|
||||||
5. validation, error, retry, and boundary behavior;
|
|
||||||
6. links to canonical file-format or wire-protocol contracts.
|
|
||||||
|
|
||||||
### docs/internal/
|
|
||||||
|
|
||||||
**Audience:** developers, LLM coding agents
|
|
||||||
|
|
||||||
Required for modular, service-oriented, or orchestration projects.
|
|
||||||
|
|
||||||
This directory describes implemented internal components. It is not the roadmap.
|
|
||||||
|
|
||||||
Use one file per major component where useful.
|
|
||||||
|
|
||||||
Each component doc should include:
|
|
||||||
|
|
||||||
1. purpose;
|
|
||||||
2. inputs and outputs;
|
|
||||||
3. boundaries;
|
|
||||||
4. config fields used;
|
|
||||||
5. external adapters used;
|
|
||||||
6. state or manifest behavior, if applicable;
|
|
||||||
7. skip/resume behavior, if applicable;
|
|
||||||
8. failure behavior;
|
|
||||||
9. tests to inspect before changing;
|
|
||||||
10. architectural invariants.
|
|
||||||
|
|
||||||
### docs/roadmap/
|
|
||||||
|
|
||||||
**Audience:** maintainers, developers, LLM coding agents
|
|
||||||
|
|
||||||
This is the only place for planned, future, aspirational, experimental, or unimplemented work.
|
|
||||||
|
|
||||||
Roadmap docs should clearly distinguish:
|
|
||||||
|
|
||||||
- proposed work;
|
|
||||||
- accepted plans;
|
|
||||||
- deferred ideas;
|
|
||||||
- rejected ideas;
|
|
||||||
- implementation prompts or task breakdowns, if useful.
|
|
||||||
|
|
||||||
Roadmap docs should not be confused with current behavior.
|
|
||||||
|
|
||||||
### docs/integrations/
|
|
||||||
|
|
||||||
**Audience:** developers, LLM coding agents
|
|
||||||
|
|
||||||
Required for projects that depend on external CLIs, APIs, services, protocols, or file formats where the integration contract is important to maintain.
|
|
||||||
|
|
||||||
This directory contains concise, versioned reference notes for external integration contracts. It should document only the parts of the external system that this project actually uses or exposes.
|
|
||||||
|
|
||||||
For public HTTP API services, `docs/integrations/` should document upstream, downstream, storage, protocol, or runtime contracts that the service depends on or bridges. It should not become a second copy of the public HTTP endpoint reference; that belongs in `docs/api.md`.
|
|
||||||
|
|
||||||
Use one file per integration where useful.
|
|
||||||
|
|
||||||
## Examples Directory
|
|
||||||
|
|
||||||
Projects with non-trivial configuration or workflows should include `examples/`.
|
|
||||||
|
|
||||||
Useful examples include:
|
|
||||||
|
|
||||||
- minimal working config;
|
|
||||||
- production-oriented config;
|
|
||||||
- full annotated config;
|
|
||||||
- local development config;
|
|
||||||
- remote/object-storage config;
|
|
||||||
- minimal session/input file.
|
|
||||||
|
|
||||||
Examples should be valid, maintained, tested when practical, and linked from relevant docs.
|
|
||||||
|
|
||||||
## Security and Privacy
|
|
||||||
|
|
||||||
Docs and examples must not include:
|
|
||||||
|
|
||||||
- real API keys;
|
|
||||||
- tokens;
|
|
||||||
- passwords;
|
|
||||||
- private keys;
|
|
||||||
- private environment dumps;
|
|
||||||
- sensitive user data;
|
|
||||||
- raw private transcripts;
|
|
||||||
- private infrastructure details unless intentionally public.
|
|
||||||
|
|
||||||
Document secret-handling mechanisms, not actual secret values.
|
|
||||||
|
|
||||||
## Maintenance Rules
|
|
||||||
|
|
||||||
When docs change, verify the affected behavior.
|
|
||||||
|
|
||||||
Where practical:
|
|
||||||
|
|
||||||
- load example config files in tests;
|
|
||||||
- test CLI examples or command parser behavior;
|
|
||||||
- validate documented flags against real flags;
|
|
||||||
- remove stale references;
|
|
||||||
- update links after renames;
|
|
||||||
- keep roadmap content out of non-roadmap docs.
|
|
||||||
|
|
||||||
If documentation and code disagree, fix the documentation and/or open a roadmap item; do not leave aspirational behavior in current-behavior docs.
|
|
||||||
|
|
||||||
Documentation is complete only when it matches the current code.
|
|
||||||
|
|
||||||
## Documentation Change Checklist
|
|
||||||
|
|
||||||
Before merging documentation changes, verify:
|
|
||||||
|
|
||||||
- README is concise and orientation-focused.
|
|
||||||
- `docs/policy/architecture.md` describes development principles.
|
|
||||||
- `docs/api.md` is the canonical HTTP contract for HTTP API services.
|
|
||||||
- Future work appears only under `docs/roadmap/`.
|
|
||||||
- User-facing docs avoid unnecessary internals.
|
|
||||||
- Consumer-facing docs explain public APIs without duplicating HTTP endpoint or integration contracts.
|
|
||||||
- Developer-facing docs preserve boundaries and invariants.
|
|
||||||
- Config examples match the schema.
|
|
||||||
- CLI examples match real commands and flags.
|
|
||||||
- Defaults appear in the canonical config reference.
|
|
||||||
- No secrets or private data are included.
|
|
||||||
- Links are accurate.
|
|
||||||
|
|||||||
139
docs/policy/oss.md
Normal file
139
docs/policy/oss.md
Normal file
@@ -0,0 +1,139 @@
|
|||||||
|
# Open Source Licensing And Attribution Policy
|
||||||
|
|
||||||
|
**Base Policy Version:** 1.1
|
||||||
|
|
||||||
|
**Last Updated:** 2026-09-26
|
||||||
|
|
||||||
|
## Purpose And Scope
|
||||||
|
|
||||||
|
This policy establishes a repeatable House Format for open source attribution
|
||||||
|
and license notices. It covers upstream components incorporated into or
|
||||||
|
distributed with the project, including relevant transitive dependencies and
|
||||||
|
copied code or assets. Treatment follows the component's terms and actual use,
|
||||||
|
rather than its classification as a direct dependency.
|
||||||
|
|
||||||
|
The baseline is a publicly available source repository with releases published
|
||||||
|
alongside it. The format is independent of language, forge, and build system.
|
||||||
|
It does not require attribution for every development tool, establish license
|
||||||
|
compatibility, or resolve obligations beyond attribution and notice handling.
|
||||||
|
|
||||||
|
## Canonical Locations
|
||||||
|
|
||||||
|
The [documentation policy](documentation.md) assigns ownership:
|
||||||
|
|
||||||
|
- `LICENSE` contains the project's own license. Dependency attribution does
|
||||||
|
not relicense the project.
|
||||||
|
- `docs/oss/attribution.md` contains the canonical component entries.
|
||||||
|
- `docs/oss/licenses/` contains complete, verbatim standard license texts,
|
||||||
|
including companion texts where applicable.
|
||||||
|
|
||||||
|
Use recognizable license filenames, such as `Apache-2.0.txt` or `LGPL-3.0.txt`.
|
||||||
|
A shared standard text may serve multiple entries. Keep explanations outside
|
||||||
|
license texts and preserve distinct versions and exceptions.
|
||||||
|
|
||||||
|
## House Format
|
||||||
|
|
||||||
|
Each component entry has five fields:
|
||||||
|
|
||||||
|
1. **Project name**, normally as the entry heading.
|
||||||
|
2. **Upstream copyright statement or statements**, preserving their wording.
|
||||||
|
3. **SPDX license identifier or expression**, when applicable.
|
||||||
|
4. **License and notice links**, covering the applicable standard texts and
|
||||||
|
upstream project-specific material.
|
||||||
|
5. **Source repository link**, identifying the source corresponding to the
|
||||||
|
imported version.
|
||||||
|
|
||||||
|
Illustrative Markdown, with placeholders for the actual upstream information:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
## Example Library
|
||||||
|
|
||||||
|
Copyright <upstream copyright statement>
|
||||||
|
|
||||||
|
SPDX-License-Identifier: Apache-2.0
|
||||||
|
|
||||||
|
License and notices: [Apache 2.0](licenses/Apache-2.0.txt) | [NOTICE](<upstream NOTICE URL at the imported commit>)
|
||||||
|
|
||||||
|
Source: [Example Library](<upstream repository URL at the imported commit>)
|
||||||
|
```
|
||||||
|
|
||||||
|
These are five fields, not a line limit. Include multiple statements and links
|
||||||
|
where needed. Omit the SPDX field when no applicable identifier exists; identify
|
||||||
|
nonstandard terms accurately through the linked text. Preserve licensing
|
||||||
|
alternatives and exceptions, and record a selected option when relevant. Do not
|
||||||
|
invent an identifier or silently resolve an unsettled licensing choice.
|
||||||
|
|
||||||
|
## License Texts And Upstream Links
|
||||||
|
|
||||||
|
Link standard license texts to their local copies. Link project-specific
|
||||||
|
notices to the upstream copies instead of storing them locally. Every upstream
|
||||||
|
repository or notice link must identify the exact commit corresponding to the
|
||||||
|
imported version, including the selected source revision for copied material.
|
||||||
|
Do not use moving branches or version tags as substitutes for that commit.
|
||||||
|
|
||||||
|
Classify material by its contents, not its filename. An upstream `LICENSE`,
|
||||||
|
`COPYING`, or similar file may contain project-specific notices or exceptions
|
||||||
|
in addition to standard wording. Link both the local standard text and the
|
||||||
|
commit-specific upstream file when needed. Make companion license texts directly
|
||||||
|
reachable from the entry rather than leaving readers to infer their location.
|
||||||
|
|
||||||
|
For project-specific license and attribution material, this policy accepts
|
||||||
|
direct links to the applicable upstream texts as satisfying reproduction,
|
||||||
|
inclusion, or copy requirements. This is the adopted house interpretation.
|
||||||
|
Agents must apply it without adding local-copy requirements or seeking repeated
|
||||||
|
approval solely because a license uses those terms.
|
||||||
|
|
||||||
|
This interpretation concerns notice reproduction. Concrete obligations such as
|
||||||
|
marking modified files or supplying corresponding source receive their own
|
||||||
|
applicable treatment. Preserve required notices already present in incorporated
|
||||||
|
source files; the central attribution entry does not authorize stripping them.
|
||||||
|
|
||||||
|
## Discoverability
|
||||||
|
|
||||||
|
End the project's README with two friendly statements linking to its actual
|
||||||
|
license and the attribution document. For Scriptorium:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
Scriptorium is licensed under the [BSD 3-Clause License](LICENSE).
|
||||||
|
|
||||||
|
[Open Source attribution notices](docs/oss/attribution.md) are available.
|
||||||
|
```
|
||||||
|
|
||||||
|
Each new checked-in release document and its hosted download page must end
|
||||||
|
with links whose visible text is `LICENSE | ATTRIBUTION`. Use absolute URLs to
|
||||||
|
those files at the release's immutable tag or corresponding immutable source
|
||||||
|
revision so the links work in both locations. This release navigation is distinct
|
||||||
|
from upstream component links, which must use the imported commit.
|
||||||
|
|
||||||
|
Reuse the checked-in release document as the hosted release body where supported.
|
||||||
|
The release procedure owns concrete URLs and publication mechanics for delivering
|
||||||
|
the links through the selected channel. Do not maintain duplicate notice lists.
|
||||||
|
These conventions do not by themselves require separate downloadable license
|
||||||
|
assets, source bundles, or a different binary package format.
|
||||||
|
|
||||||
|
## Maintenance And Exceptions
|
||||||
|
|
||||||
|
Update notices in the change that adds, removes, upgrades, copies, or changes
|
||||||
|
the distribution of a relevant component. Check the selected source's license
|
||||||
|
and notices rather than assuming they are unchanged. Update affected entries,
|
||||||
|
commit links, and texts; retain historical versions through Git.
|
||||||
|
|
||||||
|
Check affected statements, faithful standard-text copies, and link destinations
|
||||||
|
as part of ordinary change review. For a future release tag, check intended file
|
||||||
|
paths against the candidate source; the tag need not resolve remotely before
|
||||||
|
publication. Do not add publication-time network checks, CI polling, recurring
|
||||||
|
legal sign-offs, mandatory scanners, or a full software bill of materials merely
|
||||||
|
to implement this policy.
|
||||||
|
|
||||||
|
Use the House Format routinely. Raise an exception only for a concrete obligation
|
||||||
|
or unresolved rights question it does not address, including any arising from a
|
||||||
|
particular distribution channel. Record the issue and selected treatment in the
|
||||||
|
adopted policy or affected attribution entry as appropriate. Resolve the issue
|
||||||
|
before the affected use or distribution without reopening settled choices.
|
||||||
|
Common ownership of projects is neither required nor a blanket exception.
|
||||||
|
|
||||||
|
Apply the formatting convention prospectively. Do not rewrite published tags,
|
||||||
|
notes, binaries, or checksums to retrofit it. Address actual omissions deliberately
|
||||||
|
under the applicable terms and the [release correction policy](release.md#immutability-and-failure-recovery).
|
||||||
|
Ordinary attribution maintenance and release links are preparation work, not new
|
||||||
|
release approval gates.
|
||||||
213
docs/policy/release.md
Normal file
213
docs/policy/release.md
Normal file
@@ -0,0 +1,213 @@
|
|||||||
|
# Release Policy
|
||||||
|
|
||||||
|
**Base Policy Version:** 1.2
|
||||||
|
|
||||||
|
**Last Updated:** 2026-09-26
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
This policy defines a proportionate workflow for validating and publishing an
|
||||||
|
intended source revision under a fresh version. Releases should require little
|
||||||
|
routine intervention, avoid repeated work, and preserve published contents.
|
||||||
|
|
||||||
|
The repository-specific commands belong in `docs/release.md`. Historical release
|
||||||
|
summaries belong in `docs/releases/`. The procedure must agree with the adopted
|
||||||
|
policy and link to it rather than introduce additional release requirements.
|
||||||
|
|
||||||
|
## Release Model And Completion
|
||||||
|
|
||||||
|
A source release identifies one exact committed source revision through an
|
||||||
|
immutable version tag and a version-matched, checked-in release note. The
|
||||||
|
primary release branch is `main`; the authoritative publication remote is
|
||||||
|
`origin`.
|
||||||
|
|
||||||
|
A successful push of the intended tag, with its source commit available on the
|
||||||
|
authoritative primary branch, completes the release. Publish `main` before
|
||||||
|
invoking the publication command; the command requires
|
||||||
|
that the remote branch exactly identifies the validated candidate and pushes
|
||||||
|
only the selected annotated tag.
|
||||||
|
|
||||||
|
Release commands must finish at successful publication. They must not wait for
|
||||||
|
or poll CI, require successful CI status, inspect downloadable artifacts, or
|
||||||
|
check consumer installation or Go module availability as completion gates.
|
||||||
|
A failed or ambiguous push requires resolving the authoritative remote state
|
||||||
|
before declaring success or retrying; successful pushes do not require a
|
||||||
|
separate remote read-back gate.
|
||||||
|
|
||||||
|
Scriptorium publishes Linux binaries and checksums asynchronously from the
|
||||||
|
tagged source. The procedure must identify those deliverables and the
|
||||||
|
responsibility of their automation. Published deliverables must be traceable
|
||||||
|
to that source and identify the same version.
|
||||||
|
|
||||||
|
Artifact delivery is a separate status. A successful tag push is not evidence
|
||||||
|
that artifacts are available. Delivery failures do not reverse source-release
|
||||||
|
success, and optional investigation must not delay release completion.
|
||||||
|
|
||||||
|
## Versioning And Compatibility
|
||||||
|
|
||||||
|
Stable releases use Semantic Versioning in the form `vMAJOR.MINOR.PATCH`, with
|
||||||
|
no leading zeroes. Prereleases are not part of the adopted release channel.
|
||||||
|
|
||||||
|
The selected version must be unused locally and on the authoritative remote.
|
||||||
|
Do not require queries to every configured remote or publication service.
|
||||||
|
A version known to have already been published must not be reused, even if the
|
||||||
|
normal guards do not inspect that channel. Adding a distribution channel
|
||||||
|
requires a deliberate update to the policy and procedure where needed.
|
||||||
|
|
||||||
|
For releases at or after `v1.0.0`:
|
||||||
|
|
||||||
|
- a major release may make intentional incompatible changes;
|
||||||
|
- a minor release may add backward-compatible behavior; and
|
||||||
|
- a patch release may make backward-compatible fixes.
|
||||||
|
|
||||||
|
Before `v1.0.0`, a minor release may change a documented public, operational,
|
||||||
|
configuration, data, integration, or compatibility contract when the release
|
||||||
|
note explains the impact and required consumer action. A patch release must
|
||||||
|
not intentionally break those contracts within its minor line.
|
||||||
|
|
||||||
|
Additional compatibility promises and deliberate exceptions belong in the
|
||||||
|
adopted policy or canonical contract documentation. Release notes explain
|
||||||
|
changes; they do not redefine current compatibility contracts.
|
||||||
|
|
||||||
|
## Release Documentation And Preparation
|
||||||
|
|
||||||
|
Every new release must include `docs/releases/<version>.md` in the tagged
|
||||||
|
source tree. Use the complete version tag as the filename and begin with a
|
||||||
|
title containing the product name and that exact version.
|
||||||
|
|
||||||
|
Include a short summary and any relevant compatibility impact or upgrade
|
||||||
|
instructions. Keep the note proportionate to the change. Fixed sections and
|
||||||
|
explicit no-action boilerplate are not required. Existing historical notes
|
||||||
|
need not be rewritten to adopt this format.
|
||||||
|
|
||||||
|
Include the release footer defined by the [OSS policy](oss.md#discoverability)
|
||||||
|
in each new release document and preserve it on the hosted download page. The
|
||||||
|
release procedure defines the concrete URLs and publication mechanics. Prepare
|
||||||
|
these links with the release note; they do not add a network check or approval
|
||||||
|
gate.
|
||||||
|
|
||||||
|
Keep exact current contracts in their canonical documents and update affected
|
||||||
|
documentation with the behavior change. Link to those documents from the note
|
||||||
|
where useful. A release note must not substitute for current documentation.
|
||||||
|
Use annotated tags with their message derived from the checked-in note rather
|
||||||
|
than requiring a separately authored account of the same release.
|
||||||
|
|
||||||
|
Version selection, release-note content, and retirement of completed roadmaps
|
||||||
|
are preparation responsibilities, not separate human approval gates. Preserve
|
||||||
|
planned and deferred work and repair affected links when retiring roadmaps.
|
||||||
|
Ordinary change review covers unintended files, credentials, and private data;
|
||||||
|
do not repeat it as a release-specific sign-off. Ignored local files are not
|
||||||
|
prohibited merely because they exist: they are not included in the tagged source.
|
||||||
|
|
||||||
|
## Candidate Validation
|
||||||
|
|
||||||
|
Provide one publication command that validates the final committed candidate,
|
||||||
|
checks publication state, and publishes the intended refs. A validation-only
|
||||||
|
mode or command may be provided for diagnosis, but must not be a required step
|
||||||
|
before publication repeats the same checks.
|
||||||
|
|
||||||
|
Run the complete deterministic, offline default test suite once for the final
|
||||||
|
candidate, following the [testing policy](testing.md), and verify the required
|
||||||
|
build targets. Select those targets for the application's actual support
|
||||||
|
commitments; native testing on each platform and access to particular hardware
|
||||||
|
are not default release prerequisites.
|
||||||
|
|
||||||
|
The selected test invocation includes the race detector because the HTTP
|
||||||
|
service shares engines and backend capacity state across concurrent requests.
|
||||||
|
This single invocation covers both ordinary assertions and race detection.
|
||||||
|
Build both declared Linux architectures with the hosted release flags to catch
|
||||||
|
cross-compilation and packaging failures; native test hardware for each target
|
||||||
|
is not required. Existing architecture tests enforce dependency boundaries.
|
||||||
|
|
||||||
|
Retain narrow source guards against committed workspaces, vendor trees, and
|
||||||
|
module replacements: these can otherwise make a passing local build depend on
|
||||||
|
unpublished or substituted framework code. Disable workspace discovery and
|
||||||
|
vendor mode during validation. These guards preserve the established
|
||||||
|
cross-project boundary; they do not require exact dependency-version audits or
|
||||||
|
module-metadata rewrites at release time.
|
||||||
|
|
||||||
|
Additional gates must address a concrete risk that the existing checks do not
|
||||||
|
adequately cover. Do not automatically require linting, race testing, module
|
||||||
|
hygiene audits, documentation audits, credential scans, example validation, or
|
||||||
|
expanded platform matrices solely because they are possible. Retain such
|
||||||
|
checks when their distinct protection justifies their cost. A one-time migration
|
||||||
|
check must not silently become a permanent release requirement.
|
||||||
|
|
||||||
|
Release tests must not require real credentials, mutable application services,
|
||||||
|
paid APIs, provider probes, or inference calls. The procedure describes
|
||||||
|
dependency preparation separately from offline validation.
|
||||||
|
|
||||||
|
Avoid duplicate validation across release phases. Successful checks for the
|
||||||
|
same final candidate need not be repeated solely to satisfy another phase;
|
||||||
|
any reuse must clearly apply to that exact candidate. Persistent validation
|
||||||
|
caches are not required. If the candidate changes, validate the new candidate.
|
||||||
|
Cheap publication-state checks may be repeated immediately before pushing
|
||||||
|
because local or remote state may have changed during validation.
|
||||||
|
|
||||||
|
Automate mechanical guards. Human review gates are strongly disfavored: add one
|
||||||
|
only through an explicit project-specific policy decision explaining the
|
||||||
|
concrete risk and why ordinary change review or automation is insufficient.
|
||||||
|
Do not add routine confirmations for checks the command can perform itself.
|
||||||
|
|
||||||
|
## Publication Guards
|
||||||
|
|
||||||
|
Automate the checks needed to publish the intended source under a fresh version:
|
||||||
|
|
||||||
|
- the version has the adopted format and is unused locally and on the
|
||||||
|
authoritative remote;
|
||||||
|
- the worktree and index are clean on the primary release branch;
|
||||||
|
- the source being published is the exact candidate that passed validation,
|
||||||
|
including its matching release note;
|
||||||
|
- the remote primary branch already identifies that exact candidate; and
|
||||||
|
- the tag identifies the validated candidate and only the intended refs are
|
||||||
|
published.
|
||||||
|
|
||||||
|
Fetch the authoritative branch and tag state as needed for these checks.
|
||||||
|
Do not force branch or tag updates to bypass a failed guard. Publish explicit
|
||||||
|
refs rather than all local tags. Do not require CI success, publication-service
|
||||||
|
availability checks, or a separate manual confirmation for each guard.
|
||||||
|
|
||||||
|
## Immutability And Failure Recovery
|
||||||
|
|
||||||
|
Published version tags and published contents are immutable. Do not move,
|
||||||
|
overwrite, recreate, or delete a published tag, or replace a published artifact,
|
||||||
|
checksum, signature, provenance statement, or release note under that version.
|
||||||
|
The checked-in note at the immutable tag is that release's historical record.
|
||||||
|
|
||||||
|
If validation fails before publication, correct and commit the candidate and
|
||||||
|
rerun the publication command. If a push fails or its outcome is ambiguous,
|
||||||
|
inspect the authoritative remote before retrying. Remove an unpublished local
|
||||||
|
tag only after confirming it was never published or used by a release channel.
|
||||||
|
An unavailable remote leaves publication status unknown; do not overwrite a tag
|
||||||
|
to resolve uncertainty.
|
||||||
|
|
||||||
|
Transient network, authentication, CI, or consumer-availability failures do not
|
||||||
|
by themselves require a new version. Asynchronous delivery may be retried from
|
||||||
|
the same immutable tag. Missing artifacts may be published later, provided
|
||||||
|
existing published contents are not replaced and the additions remain consistent
|
||||||
|
with the tagged source and any already-published checksum manifest. If that
|
||||||
|
cannot be achieved, publish a new version.
|
||||||
|
|
||||||
|
A defect requiring changes to published source or contents requires a corrected
|
||||||
|
commit, a new semantically appropriate version, a matching release note, and
|
||||||
|
the release procedure again. Leave the original release intact. A channel's
|
||||||
|
yank, deprecation, or advisory mechanism may warn consumers away from a defective
|
||||||
|
release without replacing its contents or reusing its version.
|
||||||
|
|
||||||
|
## Repository Release Procedure
|
||||||
|
|
||||||
|
Maintain `docs/release.md` as a short, executable maintainer runbook. It must
|
||||||
|
identify:
|
||||||
|
|
||||||
|
1. prerequisites, primary branch, and authoritative remote;
|
||||||
|
2. version and release-note preparation;
|
||||||
|
3. one publication command with its selected local checks and automated guards;
|
||||||
|
4. declared deliverables, required build targets, and automation responsibilities;
|
||||||
|
5. the successful-push completion point and separately reported delivery status;
|
||||||
|
and
|
||||||
|
6. failure handling, ambiguous-push recovery, and asynchronous delivery retries.
|
||||||
|
|
||||||
|
Use copyable commands where practical. Keep optional diagnostics and consumer
|
||||||
|
verification clearly optional. The procedure must not turn preparation work,
|
||||||
|
ordinary change review, or post-publication investigation into additional
|
||||||
|
release gates.
|
||||||
291
docs/policy/testing.md
Normal file
291
docs/policy/testing.md
Normal file
@@ -0,0 +1,291 @@
|
|||||||
|
# Testing Policy
|
||||||
|
|
||||||
|
**Base Policy Version:** 1.1
|
||||||
|
|
||||||
|
**Last Updated:** 2026-09-26
|
||||||
|
|
||||||
|
## Purpose
|
||||||
|
|
||||||
|
Our tests exist to make **incorrect changes expensive and correct changes cheap**.
|
||||||
|
|
||||||
|
We do not optimize for test count, line coverage, exhaustive isolation, or the fewest possible tests. We optimize for sufficient confidence in important behavior while imposing as little unnecessary friction as possible on future development.
|
||||||
|
|
||||||
|
## Every test has a cost
|
||||||
|
|
||||||
|
Every test has an immediate and continuing cost: writing, review, execution,
|
||||||
|
diagnosis, fixture maintenance, and updates when legitimate behavior changes.
|
||||||
|
Tests can also constrain refactoring, duplicate policy, and add failure noise.
|
||||||
|
|
||||||
|
A test is warranted only when the confidence it provides justifies these costs.
|
||||||
|
Evaluate that tradeoff at two levels:
|
||||||
|
|
||||||
|
1. **Per test:** What realistic defect does this test detect, how consequential would that defect be, and is that protection worth the test's lifetime cost?
|
||||||
|
2. **Across the suite:** Does this collection provide materially more confidence than a smaller, simpler suite would?
|
||||||
|
|
||||||
|
Some friction is intentional. Tests should make dangerous changes—such as breaking compatibility, corrupting data, violating security boundaries, or reintroducing subtle bugs—require deliberate review. They should not make ordinary internal changes needlessly expensive.
|
||||||
|
|
||||||
|
The cost of a test is not a reason to omit testing by default. Do not cite maintenance cost abstractly. When omitting a plausible test, be able to state why the protected failure is low-risk, already covered, obvious, reversible, or cheaper to detect elsewhere. For consequential, subtle, or difficult-to-observe behavior, the presumption should favor testing.
|
||||||
|
|
||||||
|
## Default testing style
|
||||||
|
|
||||||
|
Use a **classical/Detroit-style** approach:
|
||||||
|
|
||||||
|
- Test observable behavior, resulting state, contracts, and invariants.
|
||||||
|
- Use real internal collaborators when they are fast and deterministic.
|
||||||
|
- Use fakes, stubs, or mocks primarily at expensive, nondeterministic, destructive, or external boundaries.
|
||||||
|
- Prefer package-level behavioral tests over tests coupled to private helpers or internal call sequences.
|
||||||
|
- Treat exact collaborator interactions as testable behavior only when the interaction itself is a requirement.
|
||||||
|
|
||||||
|
Examples of appropriate seams include clocks, randomness, subprocesses, remote APIs, object storage, email, and paid LLM calls.
|
||||||
|
|
||||||
|
## Test execution requirements
|
||||||
|
|
||||||
|
Tests in the default suite must be deterministic, offline, and independent of real credentials. They must not invoke paid APIs or depend on mutable external services. Tests that require live infrastructure must be explicitly opt-in and clearly separated from the default suite.
|
||||||
|
|
||||||
|
Control clocks, randomness, environment variables, and other process-global or machine-specific state when they affect behavior. Tests should be safe to run repeatedly and alongside other tests without depending on execution order or state left by an earlier test.
|
||||||
|
|
||||||
|
## What deserves tests
|
||||||
|
|
||||||
|
To the extent the following features are present in the application, prioritize tests for:
|
||||||
|
|
||||||
|
1. Public and package-level contracts.
|
||||||
|
2. Domain rules and important invariants.
|
||||||
|
3. Boundary conditions and malformed input.
|
||||||
|
4. Failure handling, cancellation, retries, recovery, and partial success.
|
||||||
|
5. Serialization, schemas, compatibility, and round trips.
|
||||||
|
6. Previously observed or plausible regressions.
|
||||||
|
7. Representative integration and end-to-end workflows.
|
||||||
|
|
||||||
|
A package-level contract is behavior relied upon by another package or major collaborator, not every observable detail of a package implementation.
|
||||||
|
|
||||||
|
Choose tests for requested behavior and established contracts. Tests must not
|
||||||
|
introduce new restrictions, guarantees, or threat scenarios merely because they
|
||||||
|
could be asserted. Follow the [agent policy](agents.md) when deciding whether a
|
||||||
|
behavior belongs to the contract; current implementation behavior alone is not
|
||||||
|
sufficient authority.
|
||||||
|
|
||||||
|
For established behavior involving **data integrity, destructive operations,
|
||||||
|
compatibility, security, concurrency, idempotency, or recovery**, favor durable
|
||||||
|
tests for realistic failures whose consequences warrant protection. Identify
|
||||||
|
the failure and the existing contract it would violate. These categories call
|
||||||
|
for attention, not an automatic test inventory or permission to strengthen the
|
||||||
|
application's guarantees. Account for protection already provided at other layers.
|
||||||
|
|
||||||
|
Do not add tests merely because a function, branch, or line exists. Do not add a test when the same meaningful risk is already adequately protected elsewhere.
|
||||||
|
|
||||||
|
## Choose the right test boundary
|
||||||
|
|
||||||
|
Test through the narrowest stable boundary that expresses the behavior clearly.
|
||||||
|
|
||||||
|
For application configuration, ConfigKit owns exhaustive YAML grammar,
|
||||||
|
source traversal, import/overlay composition, provenance, and inspection
|
||||||
|
renderer tests. Scriptorium tests its selected definition, source discovery,
|
||||||
|
CLI override presence, command prerequisites, runtime conversion, credential
|
||||||
|
boundary, and representative execution/inspection workflows with the tagged
|
||||||
|
library. Do not copy the upstream parser test matrix into this repository.
|
||||||
|
|
||||||
|
This is often the package API, but it may instead be:
|
||||||
|
|
||||||
|
- a smaller pure function when dense domain logic is most clearly isolated there;
|
||||||
|
- a package-level operation when several internal collaborators jointly produce the behavior; or
|
||||||
|
- a larger integration boundary when correctness emerges from interaction with a real dependency.
|
||||||
|
|
||||||
|
Do not force all behavior through oversized end-to-end tests. Do not test every private helper merely because it exists. Choose the boundary that gives durable confidence with the least incidental coupling.
|
||||||
|
|
||||||
|
## Test behavior, not implementation
|
||||||
|
|
||||||
|
A test should protect a decision, contract, or invariant. A test must not memorialize the current implementation.
|
||||||
|
|
||||||
|
A test is suspect when its main purpose is to detect that someone:
|
||||||
|
|
||||||
|
- changed an internal constant;
|
||||||
|
- renamed or split a private helper;
|
||||||
|
- reordered equivalent internal operations;
|
||||||
|
- changed incidental formatting;
|
||||||
|
- replaced one correct algorithm with another; or
|
||||||
|
- refactored internal object structure without changing behavior.
|
||||||
|
|
||||||
|
Refactoring should normally require no test edits unless the refactored structure is itself part of the contract.
|
||||||
|
|
||||||
|
## Expected effects of different changes
|
||||||
|
|
||||||
|
Use the following expectations when evaluating test failures and test maintenance:
|
||||||
|
|
||||||
|
| Change | Expected effect on tests |
|
||||||
|
|---|---|
|
||||||
|
| Internal refactor that preserves behavior | Existing tests should normally remain unchanged and continue to pass. |
|
||||||
|
| Change to an internal default with no contractual significance | Behavioral tests should normally remain unchanged; tests should derive expectations from configuration or relationships rather than duplicate the old value. |
|
||||||
|
| Intentional change to public behavior, policy, schema, or compatibility guarantees | The relevant tests should be reviewed and changed deliberately. |
|
||||||
|
| Accidental violation of a contract or invariant | Tests should fail; fix the production code rather than rewriting the tests to accept the defect. |
|
||||||
|
|
||||||
|
A test failing is not the same as a test needing to be edited. Many tests may correctly fail because of one production defect. The maintenance smell is a correct internal change that requires unrelated expectation updates throughout the suite.
|
||||||
|
|
||||||
|
## Separate mechanism from policy
|
||||||
|
|
||||||
|
Configurable thresholds and defaults must not be duplicated throughout the test suite.
|
||||||
|
|
||||||
|
For this example, assume the selected contract rejects a request to start more
|
||||||
|
processes than a configured limit. Do not encode its production default indirectly:
|
||||||
|
|
||||||
|
```go
|
||||||
|
// Production default:
|
||||||
|
const maxConcurrency = 4
|
||||||
|
|
||||||
|
// Brittle test:
|
||||||
|
err := startProcesses(5)
|
||||||
|
require.Error(t, err)
|
||||||
|
```
|
||||||
|
|
||||||
|
Instead, test the mechanism relationally:
|
||||||
|
|
||||||
|
```go
|
||||||
|
const limit = 2
|
||||||
|
runner := NewRunner(limit)
|
||||||
|
|
||||||
|
require.NoError(t, runner.Start(limit))
|
||||||
|
require.ErrorIs(t, runner.Start(limit+1), ErrTooMuchConcurrency)
|
||||||
|
```
|
||||||
|
|
||||||
|
For this selected contract, the test should prove:
|
||||||
|
|
||||||
|
- the configured limit is accepted; and
|
||||||
|
- one beyond the configured limit is rejected.
|
||||||
|
|
||||||
|
Rejection is not a general requirement for concurrency control. If the selected
|
||||||
|
contract queues excess work or limits active workers while accepting larger
|
||||||
|
batches, test that behavior instead. Do not add rejection or a configurable
|
||||||
|
limit solely to reproduce this example.
|
||||||
|
|
||||||
|
The production default should be tested exactly only when its literal value is itself a public, operational, safety, protocol, or compatibility requirement.
|
||||||
|
|
||||||
|
Apply the same rule to limits, timeouts, capacities, retry counts, and ranges: test relationships and behavior, not duplicated literals.
|
||||||
|
|
||||||
|
For established concurrency limits, distinguish these behaviors where the contract requires them:
|
||||||
|
|
||||||
|
1. **Configuration handling:** values are accepted or rejected according to the selected contract.
|
||||||
|
2. **Runtime enforcement:** observed peak concurrency never exceeds the configured limit.
|
||||||
|
|
||||||
|
Use a test-controlled limit and measure the behavior relative to that limit. Do not merely assert today's default value.
|
||||||
|
|
||||||
|
## Avoid semantic duplication across layers
|
||||||
|
|
||||||
|
Each behavior should have a clear test owner.
|
||||||
|
|
||||||
|
- Configuration tests own application YAML, strict decoding, discovery,
|
||||||
|
precedence, and application defaults.
|
||||||
|
- CLI tests own argument mapping, streams, summaries, exit behavior, and
|
||||||
|
representative command workflows.
|
||||||
|
- HTTP tests own DTOs, strict decoding, limits, status mapping, and restricted
|
||||||
|
artifact policy.
|
||||||
|
- Formatter tests own prepared-run and definition-inspection text and JSON
|
||||||
|
presentation.
|
||||||
|
- Architecture tests own dependency direction and removal invariants.
|
||||||
|
- Promptkit owns framework parsing, orchestration, validation, profiles, and
|
||||||
|
model-client behavior. Scriptorium's definition compatibility fixtures protect
|
||||||
|
its adapter plumbing without duplicating the upstream format contract.
|
||||||
|
|
||||||
|
Higher-level tests should not repeat every lower-level case. A single intentional policy change should not require unrelated edits across many test files.
|
||||||
|
|
||||||
|
## Use test doubles deliberately
|
||||||
|
|
||||||
|
Choose the least elaborate test double that provides the required control or observation.
|
||||||
|
|
||||||
|
As a default:
|
||||||
|
|
||||||
|
1. Prefer real collaborators when they are fast and deterministic.
|
||||||
|
2. Use small in-memory fakes when realistic stateful behavior is helpful.
|
||||||
|
3. Use stubs when a dependency only needs to provide controlled responses.
|
||||||
|
4. Use mocks when the interaction itself is contractual.
|
||||||
|
|
||||||
|
Mocks are appropriate when the contract includes facts such as:
|
||||||
|
|
||||||
|
- a notification is sent exactly once;
|
||||||
|
- a transaction is committed only after successful writes;
|
||||||
|
- cancellation reaches a subprocess;
|
||||||
|
- an expensive API is called no more than once; or
|
||||||
|
- a security audit event is emitted.
|
||||||
|
|
||||||
|
Do not use mocks merely to isolate every object or reproduce the implementation's call graph.
|
||||||
|
|
||||||
|
## Go-specific guidance
|
||||||
|
|
||||||
|
Select techniques according to the behavior and risk being tested. The following
|
||||||
|
are options, not a checklist that every package or application must satisfy:
|
||||||
|
|
||||||
|
- table-driven tests for meaningful behavioral categories and boundaries;
|
||||||
|
- `t.TempDir()` for real filesystem behavior;
|
||||||
|
- `httptest.Server` for realistic HTTP interactions;
|
||||||
|
- fuzz tests when exploring broad input spaces, such as parsers or path handling, adds useful protection beyond representative cases;
|
||||||
|
- golden files only when the complete output is intentionally stable;
|
||||||
|
- integration tests where correctness depends on component interaction; and
|
||||||
|
- a small number of representative end-to-end tests when assembled workflows expose meaningful risks not adequately covered at narrower boundaries.
|
||||||
|
|
||||||
|
Avoid exact error-string assertions unless the wording is itself contractual. Prefer `errors.Is`, `errors.As`, typed errors, or structured error fields.
|
||||||
|
|
||||||
|
At CLI boundaries, prefer exit classifications, structured output, and the smallest stable semantic fragment needed to identify the error. Do not snapshot complete diagnostic wording unless it is contractual.
|
||||||
|
|
||||||
|
Golden-file updates must require an explicit local flag. CI must not update golden files automatically, and reviewers must inspect the semantic diff before accepting an update.
|
||||||
|
|
||||||
|
Keep tests readable and direct. Test helpers and fixture frameworks must earn their own maintenance cost; do not build elaborate test infrastructure for small or isolated needs.
|
||||||
|
|
||||||
|
## Coverage
|
||||||
|
|
||||||
|
Coverage is a diagnostic, not a target.
|
||||||
|
|
||||||
|
Use it to find untested critical branches and unexpectedly weak packages. Do not write low-value tests solely to increase a percentage, and do not infer test quality from coverage alone.
|
||||||
|
|
||||||
|
Security-sensitive HTTP containment and external mappings may warrant denser
|
||||||
|
coverage than straightforward process wiring. Uneven coverage is acceptable
|
||||||
|
when it reflects risk.
|
||||||
|
|
||||||
|
## Regression tests
|
||||||
|
|
||||||
|
A bug fix should normally include a regression test that fails before the fix and passes afterward.
|
||||||
|
|
||||||
|
Retain the test when the defect could realistically recur and its consequences justify the ongoing cost. Prefer the narrowest durable test of the violated contract or invariant; do not preserve accidental implementation details from the original bug.
|
||||||
|
|
||||||
|
Not every historical bug requires a permanent test. If the underlying design has made recurrence impossible, the test has become redundant, or a stronger invariant test now subsumes it, remove or consolidate it.
|
||||||
|
|
||||||
|
## Deleting or rewriting tests
|
||||||
|
|
||||||
|
Tests are maintained code, not permanent historical artifacts.
|
||||||
|
|
||||||
|
Delete or rewrite a test when its maintenance cost exceeds the confidence it provides.
|
||||||
|
|
||||||
|
Strong candidates include tests that:
|
||||||
|
|
||||||
|
- require updates after harmless internal changes;
|
||||||
|
- directly assert private constants without protecting a real contract;
|
||||||
|
- duplicate the same policy across several layers;
|
||||||
|
- verify mock choreography rather than outcomes;
|
||||||
|
- snapshot large amounts of incidental output;
|
||||||
|
- test trivial private helpers already exercised through stable package behavior;
|
||||||
|
- protect risks already covered more effectively elsewhere;
|
||||||
|
- are flaky, misleading, obsolete, or disproportionately expensive to diagnose; or
|
||||||
|
- no longer correspond to a plausible failure mode.
|
||||||
|
|
||||||
|
Several brittle tests may encode one genuine requirement. Replace them with one durable behavior-level or invariant test rather than preserving all of them.
|
||||||
|
|
||||||
|
## Reviewing a proposed test
|
||||||
|
|
||||||
|
Use the following questions when the value, boundary, or durability of a proposed test is not self-evident. Significant test additions should be reviewable against them, but written answers are not required for every routine test.
|
||||||
|
|
||||||
|
1. Which requested behavior or established contract does it protect, and what realistic defect would violate it?
|
||||||
|
2. How likely and consequential is that defect, and is it already protected elsewhere?
|
||||||
|
3. What is the narrowest stable boundary that can test it clearly?
|
||||||
|
4. Would a correct internal refactor or a change to an incidental default require test edits?
|
||||||
|
5. Does its confidence justify its maintenance, execution, and diagnostic cost, or would a smaller test suffice?
|
||||||
|
|
||||||
|
## Definition of sufficient
|
||||||
|
|
||||||
|
A test suite is sufficient when:
|
||||||
|
|
||||||
|
- important requested behavior and established contracts are protected against realistic, consequential failures;
|
||||||
|
- boundaries and component interactions have coverage where they introduce meaningful risks not protected elsewhere;
|
||||||
|
- failures provide useful signal rather than redundant noise;
|
||||||
|
- legitimate internal changes usually do not require test edits; and
|
||||||
|
- additional tests would mostly repeat existing protection or preserve inconsequential implementation details.
|
||||||
|
|
||||||
|
Sufficiency is a risk judgment, not a coverage percentage, test count, or required
|
||||||
|
mix of testing techniques. Reassess it as the application, its users, and the
|
||||||
|
consequences of failure evolve.
|
||||||
143
docs/release.md
Normal file
143
docs/release.md
Normal file
@@ -0,0 +1,143 @@
|
|||||||
|
# Release Procedure
|
||||||
|
|
||||||
|
The [release policy](policy/release.md) owns versioning, compatibility,
|
||||||
|
publication completion, and immutability. This runbook supplies Scriptorium's
|
||||||
|
commands; release notes under `docs/releases/` are historical summaries. The
|
||||||
|
[OSS policy](policy/oss.md#discoverability) owns license and attribution
|
||||||
|
discoverability requirements.
|
||||||
|
|
||||||
|
## Prepare The Candidate
|
||||||
|
|
||||||
|
Use a POSIX shell, Git with a configured tagger identity and access to
|
||||||
|
`origin`, and a Go toolchain compatible with `go.mod`. The native host must
|
||||||
|
support Go's race detector and have its required C compiler. If Git is
|
||||||
|
configured to sign tags, its signing tool and key must be available. Run from the
|
||||||
|
repository root. Provision the toolchain and module cache before offline
|
||||||
|
validation; when dependencies are not cached:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
GOWORK=off go mod download
|
||||||
|
```
|
||||||
|
|
||||||
|
Choose an unused stable version under the release policy. Commit its note as
|
||||||
|
`docs/releases/<version>.md`, beginning with a title such as
|
||||||
|
`# Scriptorium v0.14.0` (an example, not an instruction to select that version).
|
||||||
|
Include a concise summary and relevant compatibility impact or upgrade action.
|
||||||
|
End the note with the following footer, replacing `<version>` in both absolute
|
||||||
|
URLs with the selected version tag (for example, `v0.14.0`):
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
[LICENSE](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/<version>/LICENSE) | [ATTRIBUTION](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/<version>/docs/oss/attribution.md)
|
||||||
|
```
|
||||||
|
|
||||||
|
Check that both URLs name files in the candidate tree at that tag. The tag may
|
||||||
|
not resolve online until publication. The checked-in note is copied unchanged
|
||||||
|
into the hosted release body by the existing workflow, so do not maintain a
|
||||||
|
second footer there.
|
||||||
|
Update affected canonical documentation with the change, and retire completed
|
||||||
|
roadmap material when appropriate while preserving deferred work and links.
|
||||||
|
No extra release-specific review signoff is required.
|
||||||
|
|
||||||
|
Finish and commit the intended candidate on `main`, then publish that branch:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git -c push.followTags=false push origin refs/heads/main:refs/heads/main
|
||||||
|
```
|
||||||
|
|
||||||
|
The publication command inspects the configured push endpoint of `origin`,
|
||||||
|
not a potentially stale remote-tracking ref. If a separate push URL is
|
||||||
|
configured, it is authoritative for both checks and publication. Configure one
|
||||||
|
publication URL; multiple push endpoints cannot be validated as one remote.
|
||||||
|
|
||||||
|
## Publish
|
||||||
|
|
||||||
|
Invoke the single [publication command](../scripts/release.sh), substituting
|
||||||
|
the selected version:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
sh scripts/release.sh v0.14.0
|
||||||
|
```
|
||||||
|
|
||||||
|
The command validates a clean worktree and index on `main`, an unused local and
|
||||||
|
remote version, exact agreement with authoritative remote `main`, and a
|
||||||
|
checked-in note whose first-level title contains Scriptorium and the exact
|
||||||
|
version. Ignored local files do not make the candidate dirty.
|
||||||
|
|
||||||
|
The existing source-boundary guards reject committed workspaces, vendor trees,
|
||||||
|
and module replacements. No migration-specific exact Promptkit version audit
|
||||||
|
is required.
|
||||||
|
|
||||||
|
It then runs the complete suite once with the race detector and builds Linux
|
||||||
|
amd64 and arm64 binaries using `CGO_ENABLED=0`, `-trimpath`, and
|
||||||
|
`-ldflags '-s -w'`. The native test run uses the host platform and enables cgo.
|
||||||
|
Validation disables workspaces, uses read-only module mode, and disables module
|
||||||
|
and toolchain downloads. Missing dependencies must be provisioned separately;
|
||||||
|
fix the environment and rerun the command. No persistent validation cache is
|
||||||
|
maintained by the release tool.
|
||||||
|
|
||||||
|
The command rechecks candidate and publication state, creates an annotated tag
|
||||||
|
from the committed note, and pushes only that tag's exact object to its explicit
|
||||||
|
ref. It does not push branches, follow other tags, force updates, or wait for
|
||||||
|
CI. Temporary notes and validation builds are removed on exit. The successful
|
||||||
|
summary identifies the source commit and tag object and reports binary
|
||||||
|
delivery separately as asynchronous and unverified.
|
||||||
|
|
||||||
|
## Asynchronous Binary Delivery
|
||||||
|
|
||||||
|
The tag-triggered [hosted workflow](../.woodpecker/release.yml) builds and
|
||||||
|
publishes:
|
||||||
|
|
||||||
|
- `scriptorium-<version>-linux-amd64`;
|
||||||
|
- `scriptorium-<version>-linux-arm64`; and
|
||||||
|
- `SHA256SUMS`.
|
||||||
|
|
||||||
|
The matching checked-in note supplies the hosted release body. The workflow
|
||||||
|
owns image selection, packaging, checksum generation, and upload configuration.
|
||||||
|
Its upload step skips existing files and does not overwrite the release.
|
||||||
|
Source-publication success does not attest to workflow success or asset
|
||||||
|
availability.
|
||||||
|
|
||||||
|
Workflow inspection, downloads, checksum verification, and a compatible-host
|
||||||
|
smoke test are optional delivery diagnostics. They must not delay or redefine
|
||||||
|
source-release completion. No polling or consumer-installation check is part
|
||||||
|
of the publication command.
|
||||||
|
|
||||||
|
## Failure Recovery
|
||||||
|
|
||||||
|
Before tag creation, correct and commit a failed candidate, publish `main`,
|
||||||
|
and invoke the publication command again. A changed candidate must pass its
|
||||||
|
own validation.
|
||||||
|
|
||||||
|
After an unsuccessful push, the command queries the authoritative endpoint.
|
||||||
|
If it confirms the exact tag object and candidate, it reports source success.
|
||||||
|
Otherwise it exits unsuccessfully and preserves the local tag. It never retries
|
||||||
|
a push or deletes a tag automatically. If the endpoint is unavailable, the
|
||||||
|
publication status is unknown, not evidence that nothing was published.
|
||||||
|
|
||||||
|
For manual diagnosis, select the affected version and compare the local tag
|
||||||
|
object and peeled commit with the authoritative remote:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
release_version=v0.14.0
|
||||||
|
release_remote=$(git remote get-url --push origin)
|
||||||
|
git rev-parse "refs/tags/$release_version" "refs/tags/$release_version^{commit}"
|
||||||
|
git ls-remote "$release_remote" refs/heads/main \
|
||||||
|
"refs/tags/$release_version" "refs/tags/$release_version^{}"
|
||||||
|
```
|
||||||
|
|
||||||
|
Do not retry while the outcome remains unknown. If the tag exists remotely,
|
||||||
|
do not move, recreate, or delete it. If the tag was never published or used by
|
||||||
|
any release channel, an explicitly authorized local cleanup may delete only
|
||||||
|
that unpublished tag; then rerun the command to validate and publish the
|
||||||
|
candidate. The command intentionally rejects an existing local tag rather than
|
||||||
|
assuming that a previous process validated it.
|
||||||
|
|
||||||
|
For transient delivery failures, inspect what has already been uploaded before
|
||||||
|
retrying the same immutable tag. The upload step's skip behavior alone does not
|
||||||
|
prove checksum consistency. Add missing assets only if they match the tagged
|
||||||
|
source and any already-published manifest, without replacing existing contents.
|
||||||
|
Compare rebuilt bytes with published checksums when recovering a partial
|
||||||
|
upload; do not assume toolchain changes reproduce identical binaries. If safe
|
||||||
|
completion is impossible, or published source, notes, packaging, or artifact
|
||||||
|
contents need correction, leave the original release intact and publish a new
|
||||||
|
version from a corrected commit.
|
||||||
36
docs/releases/v0.12.0.md
Normal file
36
docs/releases/v0.12.0.md
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
# Scriptorium v0.12.0
|
||||||
|
|
||||||
|
## Breaking Project Boundary
|
||||||
|
|
||||||
|
Scriptorium is now an executable-only CLI and HTTP application. This is a
|
||||||
|
breaking change for Go consumers: the former root Go package is not included,
|
||||||
|
and no compatibility facade is provided.
|
||||||
|
|
||||||
|
Scriptorium `v0.11.1` was the final framework-bearing release. Former Go
|
||||||
|
consumers should follow the
|
||||||
|
[migration guide](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.12.0/docs/consumers/migrating-to-promptkit.md)
|
||||||
|
and adopt
|
||||||
|
[Promptkit `v0.1.0`](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/consumers/pkg-promptkit.md)
|
||||||
|
for in-process prompt preparation and execution.
|
||||||
|
|
||||||
|
## Application Interfaces
|
||||||
|
|
||||||
|
The Scriptorium command-line and HTTP application interfaces remain. Their
|
||||||
|
canonical documentation defines the supported commands, configuration,
|
||||||
|
requests, responses, operational behavior, and deployment responsibilities:
|
||||||
|
|
||||||
|
- [CLI reference](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.12.0/docs/cli.md)
|
||||||
|
- [HTTP API reference](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.12.0/docs/api.md)
|
||||||
|
- [Configuration reference](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.12.0/docs/config.md)
|
||||||
|
- [Operations guide](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.12.0/docs/operations.md)
|
||||||
|
|
||||||
|
## Framework Dependency And Consumers
|
||||||
|
|
||||||
|
The released Scriptorium binaries use Promptkit `v0.1.0` as their framework
|
||||||
|
dependency. Promptkit owns the reusable engine, source formats, profiles,
|
||||||
|
generation boundary, and validation contracts. See the
|
||||||
|
[Promptkit Go consumer guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.1.0/docs/consumers/pkg-promptkit.md)
|
||||||
|
for that supported API.
|
||||||
|
|
||||||
|
All known downstream Go consumers were migrated to Promptkit before this
|
||||||
|
release.
|
||||||
59
docs/releases/v0.13.0.md
Normal file
59
docs/releases/v0.13.0.md
Normal file
@@ -0,0 +1,59 @@
|
|||||||
|
# Scriptorium v0.13.0
|
||||||
|
|
||||||
|
## Promptkit v0.9 Adoption
|
||||||
|
|
||||||
|
Scriptorium now uses
|
||||||
|
[Promptkit `v0.9.0`](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/)
|
||||||
|
and supports the complete Promptkit v0.9 prompt and profile definition format
|
||||||
|
through its configured directory sources. This includes prompt versions,
|
||||||
|
optional inputs, all supported message roles, cache control, session templates,
|
||||||
|
output schemas and repair budgets, profile inheritance, backend selection,
|
||||||
|
provider controls, optional credential environment names, and JSON-compatible
|
||||||
|
extra parameters.
|
||||||
|
|
||||||
|
Promptkit remains the canonical owner of definition parsing and framework
|
||||||
|
validation. Scriptorium continues to own its CLI, HTTP, configuration,
|
||||||
|
presentation, and deployment contracts.
|
||||||
|
|
||||||
|
## Application Features
|
||||||
|
|
||||||
|
- `run` and `render` can select an explicit prompt version and can execute
|
||||||
|
prompts that do not declare or reference inputs.
|
||||||
|
- CLI and HTTP requests can provide a direct session ID. Reasoning controls can
|
||||||
|
inherit, replace, or explicitly clear the selected profile value.
|
||||||
|
- Application configuration can register custom OpenAI-compatible backends
|
||||||
|
with optional credential environment names, extra parameters, concurrency
|
||||||
|
limits, and queue policy.
|
||||||
|
- `inspect prompt` and `inspect profile` provide deterministic text or JSON
|
||||||
|
views without invoking a model. Profile inspection does not read credential
|
||||||
|
values or require a prompt definition.
|
||||||
|
- Prepared output, CLI summaries, and HTTP metadata report effective backend
|
||||||
|
identity when available.
|
||||||
|
- HTTP requests rejected by backend capacity policy return `503` with the
|
||||||
|
stable `capacity_exceeded` code. One server-scoped Promptkit engine enforces
|
||||||
|
those limits across concurrent requests.
|
||||||
|
|
||||||
|
See the versioned application contracts for exact behavior:
|
||||||
|
|
||||||
|
- [CLI reference](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.13.0/docs/cli.md)
|
||||||
|
- [HTTP API reference](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.13.0/docs/api.md)
|
||||||
|
- [Configuration reference](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.13.0/docs/config.md)
|
||||||
|
- [Operations guide](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.13.0/docs/operations.md)
|
||||||
|
- [Promptkit v0.9 format reference](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/formats.md)
|
||||||
|
|
||||||
|
## Compatibility And Operations
|
||||||
|
|
||||||
|
There are no intentional removals from the v0.12 application interfaces. The
|
||||||
|
Promptkit upgrade does enforce its current definition-safety rules, including
|
||||||
|
supported message roles, absolute HTTP or HTTPS endpoints, contained content
|
||||||
|
and schema paths, bounded repair budgets, and JSON-compatible extra parameters.
|
||||||
|
Definitions rejected by these rules must be corrected before use.
|
||||||
|
|
||||||
|
Credential values remain outside configuration, definition files, CLI flags,
|
||||||
|
and HTTP payloads. Named environment sources are optional unless a selected
|
||||||
|
Promptkit profile explicitly requires a key. A positive repair budget permits
|
||||||
|
additional provider calls and can increase latency, token use, and cost.
|
||||||
|
|
||||||
|
The HTTP service retains only the shared operational state needed for backend
|
||||||
|
admission and in-flight request handling. Scriptorium does not retain durable
|
||||||
|
conversation, workflow, checkpoint, or resume state.
|
||||||
66
docs/releases/v0.14.0.md
Normal file
66
docs/releases/v0.14.0.md
Normal file
@@ -0,0 +1,66 @@
|
|||||||
|
# Scriptorium v0.14.0
|
||||||
|
|
||||||
|
This minor release adopts Promptkit v0.11.0 and ConfigKit v0.4.0, adds
|
||||||
|
application-configuration inspection, and exposes request retry controls,
|
||||||
|
whole-run deadlines, and optional terminal execution reports.
|
||||||
|
|
||||||
|
## Configuration migration
|
||||||
|
|
||||||
|
Scriptorium now uses ConfigKit for application configuration. This intentionally
|
||||||
|
changes accepted input and precedence:
|
||||||
|
|
||||||
|
- An existing empty file is invalid; use `{}` for an empty mapping. Explicit
|
||||||
|
empty strings and zeroes replace lower values, while `null` is accepted only
|
||||||
|
for nullable fields. `--config ''` is invalid. An explicitly empty server
|
||||||
|
address reaches the standard HTTP server rather than restoring `:8080`.
|
||||||
|
- YAML decoding is stricter: unknown fields, additional documents,
|
||||||
|
anchors/aliases, unsupported scalar forms, and other inputs rejected by
|
||||||
|
ConfigKit now fail. The `configkit` key is reserved, and ConfigKit's source
|
||||||
|
and resource limits apply. Backend parameter integers use its `int64` shape.
|
||||||
|
- File-backed configurations can explicitly import path or glob fragments and
|
||||||
|
select one named overlay with `--config-overlay`. These files stay under the
|
||||||
|
selected configuration file's canonical directory. Application path *values*
|
||||||
|
remain relative to the process working directory. Only explicitly supplied
|
||||||
|
application CLI flags override file or overlay settings.
|
||||||
|
|
||||||
|
Use `config validate`, `config show`, `config sources`, and `config explain` to
|
||||||
|
inspect application settings without creating an engine or contacting a model.
|
||||||
|
Validation is not a provider probe or complete Promptkit definition check;
|
||||||
|
effective output is not guaranteed reloadable. Inspection keeps ordinary
|
||||||
|
`extra_params` values, including historical values, and `api_key_env` reference
|
||||||
|
names visible. Keep secrets out of parameters and protect inspection output;
|
||||||
|
actual API-key values remain with Promptkit and are never resolved by ConfigKit.
|
||||||
|
Request retry overrides and Promptkit credential requirements are separate
|
||||||
|
from application configuration.
|
||||||
|
|
||||||
|
## Promptkit and execution changes
|
||||||
|
|
||||||
|
Promptkit v0.11.0 uses its `/v2` catalogs. The `deepseek-3-2`,
|
||||||
|
`deepseek-4-flash`, and `deepseek-4-pro` profile IDs are removed without aliases;
|
||||||
|
select an available catalog profile, a maintained Promptkit profile, or a
|
||||||
|
complete application-owned profile.
|
||||||
|
|
||||||
|
Promptkit's built-in transient retry default is two additional attempts. This
|
||||||
|
can increase provider calls, latency, and cost; an application or request
|
||||||
|
retry override of zero disables additional attempts. Repair generations have
|
||||||
|
their own retry budgets. Generation timeouts apply per attempt. CLI
|
||||||
|
`--run-timeout` and HTTP `run_timeout_seconds` add optional whole-run deadlines;
|
||||||
|
an expired HTTP execution returns `504 deadline_exceeded`, caller cancellation
|
||||||
|
returns `408 request_canceled`, and a live-context provider-attempt failure
|
||||||
|
remains a 502 response.
|
||||||
|
|
||||||
|
CLI `--execution-report` and HTTP `include_execution_report` expose optional
|
||||||
|
terminal reports. Reports are absent when no terminal observation exists, can
|
||||||
|
contain sensitive identifiers, and do not replace result usage. CLI report
|
||||||
|
writes are separate and nontransactional; HTTP report bytes count toward the
|
||||||
|
response-size limit.
|
||||||
|
|
||||||
|
For complete behavior, see the
|
||||||
|
[CLI](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.14.0/docs/cli.md),
|
||||||
|
[configuration](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.14.0/docs/config.md),
|
||||||
|
[HTTP API](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.14.0/docs/api.md),
|
||||||
|
and [operations](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.14.0/docs/operations.md)
|
||||||
|
references. The repository now includes
|
||||||
|
[dependency attribution and license texts](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.14.0/docs/oss/attribution.md).
|
||||||
|
|
||||||
|
[LICENSE](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.14.0/LICENSE) | [ATTRIBUTION](https://gitea.maximumdirect.net/eric/scriptorium/src/tag/v0.14.0/docs/oss/attribution.md)
|
||||||
231
docs/roadmap/configkit.md
Normal file
231
docs/roadmap/configkit.md
Normal file
@@ -0,0 +1,231 @@
|
|||||||
|
# ConfigKit Adoption
|
||||||
|
|
||||||
|
## Status And Intent
|
||||||
|
|
||||||
|
Implemented feature direction, drafted on 2026-09-26 and delivered through the
|
||||||
|
[implementation plan](implementation.md). This roadmap records the target
|
||||||
|
behavior and changes from the reviewed baseline; the implementation plan owns
|
||||||
|
sequencing, concrete interfaces, and verification evidence.
|
||||||
|
|
||||||
|
The user is adopting ConfigKit across an application suite to standardize
|
||||||
|
configuration semantics. Scriptorium will make a clean cutover to ConfigKit's
|
||||||
|
native conventions, including intentional breaking changes. Preserving the
|
||||||
|
legacy loader's behavior is not a goal: there will be no parallel legacy loader,
|
||||||
|
compatibility mode, or recreation of the old merging rules.
|
||||||
|
|
||||||
|
Alignment applies to application configuration, not to Promptkit-owned prompt,
|
||||||
|
profile, or schema definitions. Departures from ConfigKit conventions require an
|
||||||
|
application-specific reason or a genuine ownership boundary, not backward
|
||||||
|
compatibility alone. The [architecture policy](../policy/architecture.md) and
|
||||||
|
[ADR 0004](../adr/0004-definition-boundary.md) remain the scope boundaries.
|
||||||
|
|
||||||
|
## Reviewed Baseline (Historical)
|
||||||
|
|
||||||
|
Scriptorium consumes Promptkit v0.11.0. Its `internal/config` package uses
|
||||||
|
yaml.v3 directly and manually applies defaults, file settings, and CLI overrides.
|
||||||
|
It has a parser-specific integer decoder, ignores empty string overrides, and
|
||||||
|
treats an empty configuration file as defaults-only input. It has no application
|
||||||
|
configuration imports, selected overlays, or provenance/inspection interface.
|
||||||
|
The [configuration reference](../config.md), [CLI reference](../cli.md), and
|
||||||
|
[source internals](../internal/sources.md) own the current behavior.
|
||||||
|
|
||||||
|
The reviewed ConfigKit release is v0.4.0 at commit
|
||||||
|
`e6ced0d3d1194b58e0b3dc8970089471ba175258`. Adopt that published release as the
|
||||||
|
initial target, rather than a sibling checkout or unpublished replacement.
|
||||||
|
Its canonical references are:
|
||||||
|
|
||||||
|
- [Configuration contract](https://gitea.maximumdirect.net/eric/ConfigKit/src/commit/e6ced0d3d1194b58e0b3dc8970089471ba175258/docs/config.md).
|
||||||
|
- [Consumer adoption guide](https://gitea.maximumdirect.net/eric/ConfigKit/src/commit/e6ced0d3d1194b58e0b3dc8970089471ba175258/docs/consumers/README.md).
|
||||||
|
- [Release notes](https://gitea.maximumdirect.net/eric/ConfigKit/src/commit/e6ced0d3d1194b58e0b3dc8970089471ba175258/docs/releases/v0.4.0.md).
|
||||||
|
|
||||||
|
ConfigKit requires Go 1.25, within Scriptorium's existing toolchain requirement.
|
||||||
|
It selects `go.yaml.in/yaml/v4 v4.0.0-rc.6`. Removing Scriptorium's direct parser
|
||||||
|
usage does not remove yaml.v3 from the dependency graph: Promptkit still uses it.
|
||||||
|
The initial review passed ConfigKit's default test suite and Scriptorium's
|
||||||
|
configuration and CLI tests; that is baseline evidence, not migration validation.
|
||||||
|
|
||||||
|
## Target Ownership And Loading Model
|
||||||
|
|
||||||
|
| Owner | Responsibility |
|
||||||
|
| --- | --- |
|
||||||
|
| ConfigKit | Application YAML policy, source acquisition, composition, overlays, typed decoding, explicit override application, provenance, and redacted inspection. |
|
||||||
|
| Scriptorium | Source discovery, application schema and defaults, CLI parsing, recorded application normalization, semantic validation, command prerequisites, and runtime conversion. |
|
||||||
|
| Promptkit | Framework definition formats, backend semantics, credential lookup, engine defaults, and prompt execution. |
|
||||||
|
|
||||||
|
`internal/config` becomes a small application-specific ConfigKit integration,
|
||||||
|
not a second general-purpose configuration framework. Execution and inspection
|
||||||
|
share one configuration definition and loading pipeline. Defaults, selected base
|
||||||
|
and imports, selected overlay, and explicit application CLI overrides participate
|
||||||
|
in ConfigKit's lifecycle; resolution and validation follow its upstream rules.
|
||||||
|
Normalization that changes inspected values is recorded through its resolver.
|
||||||
|
Runtime conversion does not perform a hidden second merge or apply new defaults
|
||||||
|
after the inspection snapshot has been created.
|
||||||
|
|
||||||
|
Scriptorium retains its application field names and domain meanings unless a
|
||||||
|
specific change below requires otherwise. ConfigKit's public root API replaces
|
||||||
|
direct YAML decoding and parser-specific hooks. Application defaults remain
|
||||||
|
Scriptorium-owned; omitted framework settings still delegate to Promptkit.
|
||||||
|
Backend conversion retains deterministic registration and engine-scoped shared
|
||||||
|
capacity state. This work does not change the HTTP request contract or move
|
||||||
|
configuration loading into each HTTP request.
|
||||||
|
|
||||||
|
## Native Configuration Semantics
|
||||||
|
|
||||||
|
The target accepts ConfigKit's upstream YAML grammar, schema binding, limits,
|
||||||
|
composition, and value-presence rules without a legacy preprocessing layer.
|
||||||
|
Migration-visible changes include:
|
||||||
|
|
||||||
|
- An existing empty file is invalid; `{}` expresses an empty application mapping.
|
||||||
|
Defaults-only operation with no discovered file uses `NoSource` instead.
|
||||||
|
- Explicit empty strings, false values, and zeroes replace defaults. They are
|
||||||
|
not silently treated as omission. Application validation still decides whether
|
||||||
|
a resulting value is meaningful for its field or selected command.
|
||||||
|
- Null follows the application's declared nullable types. It is not a universal
|
||||||
|
spelling for omission. Scalars and structs do not accept null merely because
|
||||||
|
the former parser tolerated it.
|
||||||
|
- Anchors, aliases, merge keys, explicit tags, additional documents, unsupported
|
||||||
|
scalar spellings, and coercions rejected by ConfigKit are rejected here too.
|
||||||
|
- ConfigKit's reserved `configkit` key and resource limits apply, including in
|
||||||
|
dynamic application data. These constraints do not apply to independently
|
||||||
|
loaded Promptkit definitions or HTTP request bodies.
|
||||||
|
- Dynamic integers in backend `extra_params` use ConfigKit's `int64`
|
||||||
|
representation. Runtime mapping preserves their supported value semantics
|
||||||
|
rather than reserializing through YAML or demanding the old Go scalar type.
|
||||||
|
|
||||||
|
Presence remains meaningful at the framework boundary: omitted/null
|
||||||
|
`transient_retries` delegates to Promptkit, while explicit zero disables retries;
|
||||||
|
omitted backend queue capacity differs from explicit zero. Application HTTP
|
||||||
|
size defaults and zero-as-unlimited behavior remain. No new value ranges or
|
||||||
|
backend restrictions are introduced merely to adopt the library.
|
||||||
|
|
||||||
|
## Discovery, Imports, Overlays, And Paths
|
||||||
|
|
||||||
|
Source discovery remains Scriptorium-owned. The target retains the documented
|
||||||
|
explicit `--config` selection and ordered system-location search. An explicitly
|
||||||
|
empty config path is invalid rather than an implicit request for a default file.
|
||||||
|
If neither implicit candidate exists, loading uses defaults only; a selected
|
||||||
|
file that fails loading is not silently replaced with defaults. No implicit
|
||||||
|
working-directory configuration search, environment overlay, or directory scan
|
||||||
|
is added.
|
||||||
|
|
||||||
|
Application configuration supports ConfigKit's explicit path and glob imports.
|
||||||
|
Imports compose disjoint definitions; repeated non-mapping definitions are
|
||||||
|
conflicts, not last-writer-wins overrides. There is no implicit `conf.d` scan.
|
||||||
|
|
||||||
|
An optional `--config-overlay` selects ConfigKit's one named overlay using its
|
||||||
|
standard `overlays/<name>.yml` location, naming rules, and merge behavior. No
|
||||||
|
overlay is selected by default. Selecting an active overlay without a base
|
||||||
|
source follows ConfigKit's rejection of overlays with `NoSource`; Scriptorium
|
||||||
|
does not invent a root. Application overlays do not replace `--profile`,
|
||||||
|
`profile_dir`, or Promptkit's execution-profile selection.
|
||||||
|
|
||||||
|
Use the selected file's canonical directory as ConfigKit's default import and
|
||||||
|
overlay root. This root governs configuration source traversal only. Values of
|
||||||
|
`prompt_dir`, `profile_dir`, `schema_dir`, and `server.artifact_root` retain
|
||||||
|
working-directory-relative interpretation; absolute values remain absolute.
|
||||||
|
This is an explicit application path policy, not an upstream requirement or a
|
||||||
|
legacy parsing mode. ConfigKit's consumer examples demonstrate alternatives but
|
||||||
|
do not mandate source-file-relative application paths. This adoption does not
|
||||||
|
extend import containment to application data or alter HTTP artifact containment.
|
||||||
|
|
||||||
|
## CLI Overrides And Configuration Inspection
|
||||||
|
|
||||||
|
Only flags explicitly supplied by the user become ConfigKit application
|
||||||
|
override records. Parser defaults do not overwrite file or overlay settings.
|
||||||
|
Explicit empty values are not dropped. The existing invocation-specific prompt,
|
||||||
|
profile, input, model, timeout, output, and reporting options remain invocation
|
||||||
|
state rather than new application configuration fields. In particular, the
|
||||||
|
run/render retry flag remains a request override; it does not mutate the engine's
|
||||||
|
application retry setting or backend state.
|
||||||
|
|
||||||
|
Expose application configuration validation, effective redacted YAML, source
|
||||||
|
provenance, and explanation of an individual configuration path. These are
|
||||||
|
included features, not merely library capabilities available for future work.
|
||||||
|
They use ConfigKit diagnostics and inspection records from the shared loading
|
||||||
|
pipeline, including defaults, imports, overlays, explicit CLI values, and
|
||||||
|
recorded normalization. No separate inspection-only interpretation is maintained.
|
||||||
|
|
||||||
|
Configuration inspection does not execute prompts, make provider calls, or
|
||||||
|
resolve API-key values. Application validation is not a promise that every
|
||||||
|
Promptkit backend or definition is valid or that a provider is reachable.
|
||||||
|
Command-specific execution prerequisites remain with the relevant command;
|
||||||
|
inspection can explain an incomplete application configuration without requiring
|
||||||
|
an executable prompt selection. The interface is a CLI configuration command
|
||||||
|
family, not a second CLI framework or an HTTP configuration endpoint; the
|
||||||
|
implementation plan specifies its concrete commands and mappings.
|
||||||
|
|
||||||
|
Safe diagnostics must not restore raw parser errors or configuration values
|
||||||
|
that ConfigKit deliberately suppresses. Effective output and explanation use
|
||||||
|
the upstream redacted renderers; they are inspection output, not guaranteed
|
||||||
|
reloadable configuration. Under the maintainer's selected policy, backend
|
||||||
|
`extra_params` are visible in effective output and explanation, including
|
||||||
|
historical values. There is no blanket container masking, sensitive-key heuristic,
|
||||||
|
or new selective-redaction configuration surface.
|
||||||
|
|
||||||
|
## Credential Boundary And Deferred Features
|
||||||
|
|
||||||
|
Existing `api_key_env` values remain environment-name strings passed to Promptkit.
|
||||||
|
They do not become ConfigKit `Secret` fields. ConfigKit eagerly resolves effective
|
||||||
|
typed references and requires nonempty values; that would change Promptkit's
|
||||||
|
optional/required and selected-credential behavior. This departure from the
|
||||||
|
secret-reference feature is an ownership decision, not compatibility plumbing.
|
||||||
|
Raw API-key fields remain unsupported under the existing architecture policy.
|
||||||
|
|
||||||
|
API-key values are the only secrets requiring ConfigKit redaction in this
|
||||||
|
adoption. The application configuration holds environment-variable names, not
|
||||||
|
those values, so inspection neither resolves nor contains the actual keys.
|
||||||
|
Reference names remain visible. Do not tag `api_key_env` as secret merely to
|
||||||
|
hide its name, add an eager key lookup, or mask unrelated application settings.
|
||||||
|
The existing raw-key prohibition and Promptkit boundary provide the protection
|
||||||
|
without introducing a redundant credential-bearing configuration field.
|
||||||
|
|
||||||
|
Secrets-directory bootstrap and application schema versioning are deferred until
|
||||||
|
there is a concrete application need. Their availability in ConfigKit does not
|
||||||
|
make them mandatory. Hot reload, runtime resource replacement, remote imports,
|
||||||
|
automatic migrations, and general environment-variable overlays are outside
|
||||||
|
this adoption. These are scope limits for this feature, not new permanent
|
||||||
|
prohibitions on future explicitly requested work.
|
||||||
|
|
||||||
|
## Required Changes And Completion Criteria
|
||||||
|
|
||||||
|
- Replace manual decoding/default/override machinery with the shared ConfigKit
|
||||||
|
integration and retain only application-specific discovery, rules, and mapping.
|
||||||
|
- Support imports and selected overlays across commands that load application
|
||||||
|
configuration, and deliver the configuration inspection capabilities above.
|
||||||
|
- Update application configuration types, presence handling, CLI explicit-set
|
||||||
|
mapping, and diagnostics to match the selected native semantics.
|
||||||
|
- Update maintained examples and canonical configuration, CLI, operations,
|
||||||
|
architecture, and internal documentation when behavior lands. Upstream generic
|
||||||
|
contracts remain linked rather than copied into a competing specification.
|
||||||
|
- Add proportionate integration coverage for the cutover: defaults-only input,
|
||||||
|
explicit values and nulls, imports/conflicts, overlays, CLI precedence,
|
||||||
|
inspection agreement and API-key non-disclosure, visible dynamic backend
|
||||||
|
parameters, unchanged credential ownership, and representative
|
||||||
|
execution/server startup.
|
||||||
|
ConfigKit owns exhaustive parser and composition tests; Scriptorium tests its
|
||||||
|
adoption and application boundaries.
|
||||||
|
- Pin the published dependency and maintain ConfigKit and YAML attribution under
|
||||||
|
the [OSS policy](../policy/oss.md), using imported-commit source/notice links
|
||||||
|
and applicable standard and companion license texts.
|
||||||
|
- Document migration in a release appropriate for the intentional breaking
|
||||||
|
configuration changes under the [release policy](../policy/release.md).
|
||||||
|
Release selection and publication remain separate preparation work; this
|
||||||
|
roadmap adds no release gate, network probe, or new distribution format.
|
||||||
|
|
||||||
|
Completion means one ConfigKit-native application configuration path serves
|
||||||
|
execution and inspection, the selected user-facing features work, and migrated
|
||||||
|
examples and regression coverage demonstrate the documented semantics. It does
|
||||||
|
not require adopting every ConfigKit feature or changing Promptkit definitions.
|
||||||
|
|
||||||
|
## Resolved Inspection Policy
|
||||||
|
|
||||||
|
On 2026-09-26 the maintainer selected no redaction for `extra_params` and limited
|
||||||
|
the relevant secret to the API key. Inspection therefore preserves parameter
|
||||||
|
values and environment-reference names, while actual API-key values remain
|
||||||
|
outside the application configuration pipeline. Visibility is intentional;
|
||||||
|
this is not a promise to detect secrets placed inside arbitrary parameter values.
|
||||||
|
|
||||||
|
The delivered `config show` and `config explain` commands use ConfigKit's
|
||||||
|
inspection writers without secret tags or a second redaction path. Both
|
||||||
|
effective and historical parameter values remain visible; `api_key_env` names
|
||||||
|
remain visible while Promptkit alone resolves selected credential values.
|
||||||
536
docs/roadmap/implementation.md
Normal file
536
docs/roadmap/implementation.md
Normal file
@@ -0,0 +1,536 @@
|
|||||||
|
# ConfigKit Adoption Implementation Plan
|
||||||
|
|
||||||
|
## Status, Authority, And Historical Plans
|
||||||
|
|
||||||
|
Planned on 2026-09-26 against Scriptorium commit
|
||||||
|
`43eea5c7c41d2a8134b3dece60f3af5c98b8fd1c`. This document records the
|
||||||
|
ordered implementation and its completion evidence. The maintainer resolved
|
||||||
|
the inspection-policy question:
|
||||||
|
`extra_params` remain visible; only API-key values require secret protection.
|
||||||
|
|
||||||
|
The [feature roadmap](configkit.md) owns scope, target behavior, and user intent.
|
||||||
|
This plan owns implementation steps and the interface choices needed to execute
|
||||||
|
them. Read [development](../development.md) and every policy before work:
|
||||||
|
[agents](../policy/agents.md), [architecture](../policy/architecture.md),
|
||||||
|
[documentation](../policy/documentation.md), [testing](../policy/testing.md),
|
||||||
|
[release](../policy/release.md), and [OSS](../policy/oss.md).
|
||||||
|
[ADR 0004](../adr/0004-definition-boundary.md) continues to govern Promptkit's
|
||||||
|
definition boundary. Do not rewrite accepted ADR decisions.
|
||||||
|
|
||||||
|
This filename previously contained completed Promptkit plans. Older roadmap
|
||||||
|
links to this file refer to these historical records, not the ConfigKit stages:
|
||||||
|
|
||||||
|
- Completed v0.11 implementation and release handoff:
|
||||||
|
`git show 43eea5c7c41d2a8134b3dece60f3af5c98b8fd1c:docs/roadmap/implementation.md`.
|
||||||
|
- Completed v0.9 implementation:
|
||||||
|
`git show e4405966c87c8a7843b340146e90cc1e515bef42:docs/roadmap/implementation.md`.
|
||||||
|
|
||||||
|
Those deliveries must not be repeated or lost from upcoming release preparation.
|
||||||
|
These Git records are available locally without publishing the recent commits.
|
||||||
|
|
||||||
|
## Working Rules And Selected Design
|
||||||
|
|
||||||
|
The dependency target is `gitea.maximumdirect.net/eric/ConfigKit v0.4.0`,
|
||||||
|
commit `e6ced0d3d1194b58e0b3dc8970089471ba175258`. Use its public root package,
|
||||||
|
imported as `configkit`. The roadmap links the exact upstream contracts.
|
||||||
|
Do not opportunistically upgrade Promptkit or other dependencies, commit a
|
||||||
|
workspace/replacement, or depend on sibling source at runtime.
|
||||||
|
|
||||||
|
This is a clean configuration cutover, not a compatibility project. Native
|
||||||
|
ConfigKit syntax, presence, nullability, resource limits, and precedence apply.
|
||||||
|
Do not add a pre-parser, YAML serialization round trip, alternate merge engine,
|
||||||
|
legacy mode, generic provider abstraction, or a new CLI framework.
|
||||||
|
|
||||||
|
Keep application source discovery and domain rules in `internal/config`;
|
||||||
|
CLI parsing/output stays in `internal/adapter/cli`. Promptkit remains responsible
|
||||||
|
for prompt/profile/schema parsing, backend semantics, credentials, and engine
|
||||||
|
behavior. Keep one shared server engine and existing HTTP artifact policy.
|
||||||
|
No HTTP schema, execution-report, request-timeout, or retry-orchestration change
|
||||||
|
is part of this plan.
|
||||||
|
|
||||||
|
For every stage:
|
||||||
|
|
||||||
|
1. Inspect the working tree and relevant code/tests through the repository's
|
||||||
|
code-discovery guidance. Preserve unrelated changes.
|
||||||
|
2. Implement the listed outcome and only supporting refactoring it needs.
|
||||||
|
Internal names below are selected implementation guidance, not public APIs
|
||||||
|
or immutable package-layout contracts.
|
||||||
|
3. Update canonical current-state docs when behavior lands. Until Stage 3 the
|
||||||
|
new loader is internal preparation, not an advertised executable feature.
|
||||||
|
Never claim later stages are implemented.
|
||||||
|
4. Run focused tests and the development guide's baseline validation for code
|
||||||
|
changes. Tests stay offline, deterministic, and free of real credentials.
|
||||||
|
Reuse existing coverage rather than cloning ConfigKit's parser test matrix.
|
||||||
|
5. Format changed Go files, inspect the diff, validate affected docs/examples,
|
||||||
|
record stage status/evidence here, and commit the coherent unit. Do not push,
|
||||||
|
tag, publish, or add new release gates.
|
||||||
|
|
||||||
|
### Application Configuration Definition
|
||||||
|
|
||||||
|
Use a new `Document` type in `internal/config` for the native configuration
|
||||||
|
shape. It replaces the old on-disk `Config` after CLI cutover. Keep the familiar
|
||||||
|
YAML field names:
|
||||||
|
|
||||||
|
| YAML path | Go shape | Default and selected meaning |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `prompt_dir`, `profile_dir` | `string` | Empty; no source configured. |
|
||||||
|
| `schema_dir` | `string` | Existing schema-directory default. Empty remains empty at the application boundary; Promptkit owns any subsequent framework default. |
|
||||||
|
| `transient_retries` | `*int` | Nil; omitted/null delegates, zero disables additional attempts. |
|
||||||
|
| `server` | Non-pointer struct | Its children receive typed defaults; null is invalid. |
|
||||||
|
| `server.addr` | `string` | Existing listen-address default when absent; explicit empty is passed unchanged to the standard HTTP server, not replaced with the Scriptorium default. |
|
||||||
|
| `server.artifact_root` | `string` | Empty; HTTP file input remains disabled. |
|
||||||
|
| Three `server.max_*_bytes` fields | `int64` | Existing defaults; explicit zero disables the respective limit; null is invalid. |
|
||||||
|
| `defaults` | Non-pointer struct | Contains `render_format`; null is invalid. |
|
||||||
|
| `defaults.render_format` | `string` | Existing text default; resolved value must be text or json. Explicit empty is invalid, not defaulted. |
|
||||||
|
| `backends` | `map[string]BackendDocument` | Nil; null is permitted, an empty mapping follows ConfigKit semantics. |
|
||||||
|
|
||||||
|
`BackendDocument` keeps `endpoint string`, `api_key_env string`,
|
||||||
|
`extra_params map[string]any`, `concurrency_limit int`, and
|
||||||
|
`queue_capacity *int`. Scalar nulls are invalid; nullable maps/pointers retain
|
||||||
|
native semantics. No catalog IDs or Promptkit fields are added.
|
||||||
|
|
||||||
|
The fresh defaults factory reads existing `internal/defaults` and format
|
||||||
|
constants, not a duplicated set of literals. Normalization trims surrounding
|
||||||
|
whitespace from application directory strings, artifact root, and server
|
||||||
|
address; cleans only nonempty application paths; and lowercases/trims
|
||||||
|
`defaults.render_format`. Empty paths remain empty: never let
|
||||||
|
`filepath.Clean("")` turn disabled/unset into `.`. Record actual changes with
|
||||||
|
`configkit.Normalize`, using value-free reasons. Do not normalize backend
|
||||||
|
fields or parameter values on Promptkit's behalf.
|
||||||
|
|
||||||
|
The read-only validator reports negative application size limits, negative
|
||||||
|
nonnull application retries, and invalid render format through
|
||||||
|
`Validation.Error` at their field paths. It does not print rejected values.
|
||||||
|
Do not call the existing format parser's empty-as-default branch for this field.
|
||||||
|
Do not add endpoint, backend ID, credential-presence, directory-existence,
|
||||||
|
address-format, or positive-only-capacity checks. Existing Promptkit and
|
||||||
|
command-specific validation retains those responsibilities where applicable.
|
||||||
|
|
||||||
|
## Stage 1: Add The Dependency And Native Application Definition
|
||||||
|
|
||||||
|
**Status: Complete.** The pinned dependency, native definition, focused
|
||||||
|
presence/normalization/validation tests, and commit-specific attribution are in
|
||||||
|
place. The existing executable loader remains active pending the command cutover.
|
||||||
|
|
||||||
|
Primary files: `go.mod`, `go.sum`, new focused files under `internal/config`,
|
||||||
|
and `docs/oss/attribution.md`.
|
||||||
|
|
||||||
|
1. Add ConfigKit at the selected release. Retain Promptkit v0.11.0 and its
|
||||||
|
selected catalogs. Provision dependencies outside offline test execution.
|
||||||
|
ConfigKit's yaml/v4 release-candidate dependency is the reviewed upstream
|
||||||
|
choice, not an instruction to upgrade its parser independently.
|
||||||
|
2. Implement `Document`, `BackendDocument`, the fresh defaults factory,
|
||||||
|
recorded resolver, and read-only validator described above. Keep the old
|
||||||
|
loader operational until Stage 3 so this stage remains independently
|
||||||
|
buildable; this temporary development state is not a shipped compatibility
|
||||||
|
mode or a second user-selectable configuration path.
|
||||||
|
3. Test the new definition using real `configkit.Load[Document]` with
|
||||||
|
`Bytes` and `NoSource`. Cover explicit zero/empty/null distinctions,
|
||||||
|
retry/queue nil-versus-zero, safe application validation, and a normalized
|
||||||
|
path whose effective output agrees with the returned value. Include nested
|
||||||
|
unknown fields and a representative dynamic numeric parameter.
|
||||||
|
4. Add ConfigKit and yaml/v4 attribution from their selected source material.
|
||||||
|
Resolve the imported yaml/v4 commit from release/module metadata. Preserve
|
||||||
|
actual copyright statements; do not infer a project statement from the
|
||||||
|
FSF license-document copyright. Use applicable SPDX expressions, local
|
||||||
|
standard texts, and commit-pinned upstream license/notice links. Reuse GPL,
|
||||||
|
LGPL, MIT, and Apache texts where applicable, including companion links.
|
||||||
|
Retain yaml.v3 attribution because Promptkit still incorporates it.
|
||||||
|
5. Document the internal definition as preparation in the relevant internal
|
||||||
|
guide without claiming the CLI has switched. No current configuration
|
||||||
|
contract changes yet.
|
||||||
|
|
||||||
|
Acceptance: the dependency and definition compile, focused tests demonstrate
|
||||||
|
native semantics and audited normalization, and attribution follows the OSS
|
||||||
|
policy. Existing executable behavior still passes its tests.
|
||||||
|
|
||||||
|
## Stage 2: Build Discovery And The Shared Loading Boundary
|
||||||
|
|
||||||
|
**Status: Complete.** Ordered source discovery, one ConfigKit load, typed
|
||||||
|
diagnostics, and settings conversion are covered by focused file/default and
|
||||||
|
override tests. Existing commands still use the old entry point until cutover.
|
||||||
|
|
||||||
|
Primary files: `internal/config` and its tests; `docs/internal/sources.md`.
|
||||||
|
|
||||||
|
1. Add `LoadOptions` with `Path string`, `Explicit bool`, `Overlay string`,
|
||||||
|
and `Overrides []configkit.Override`, plus
|
||||||
|
`Load(LoadOptions) (*configkit.Result[Document], error)`.
|
||||||
|
Discovery chooses a source; the one ConfigKit call owns actual file reading
|
||||||
|
and decoding. Return the result so consumers retain the frozen inspection
|
||||||
|
snapshot as well as the typed configuration.
|
||||||
|
2. With `Explicit=true`, pass the selected path to `configkit.File`;
|
||||||
|
an explicitly empty path is invalid, not implicit discovery or a fallback
|
||||||
|
to the old system filename. Do not silently trim a source filename into a
|
||||||
|
different filename. ConfigKit validates and resolves file sources.
|
||||||
|
3. With `Explicit=false`, ignore the option's path value and examine the
|
||||||
|
existing ordered implicit search locations. Only nonexistence permits
|
||||||
|
examining the next candidate. Other stat failures are errors. Select the
|
||||||
|
first existing candidate and let ConfigKit load it. A selected file's later
|
||||||
|
disappearance/read/parse failure does not restart discovery.
|
||||||
|
4. If neither implicit candidate exists, use `NoSource`. Initially leave
|
||||||
|
imports disabled and the overlay empty; Stage 4 enables composition.
|
||||||
|
Defaults-only loads still accept explicit application overrides. Never
|
||||||
|
reinterpret an empty file as `NoSource`.
|
||||||
|
5. Pass overrides into the ConfigKit call before decoding/validation; do not
|
||||||
|
validate a separately merged lower configuration first. Native parsing and
|
||||||
|
composition failures still follow the upstream lifecycle and are not
|
||||||
|
bypassed by CLI overrides.
|
||||||
|
6. Add a small `Settings(Document) AppSettings` conversion for existing
|
||||||
|
executable wiring. It copies resolved fields, maps the already-validated
|
||||||
|
format, and converts the backend map into ID-sorted backend settings.
|
||||||
|
It performs no file IO, normalization, credential lookup, semantic backend
|
||||||
|
checks, or additional defaults. Dynamic values retain their decoded shapes.
|
||||||
|
7. Preserve ConfigKit's typed `*LoadError` through wrapping so the CLI can
|
||||||
|
render safe structured diagnostics. Discovery-only errors are concise and
|
||||||
|
quote paths safely; no new public error taxonomy is needed.
|
||||||
|
8. Test ordered discovery with temporary paths rather than host system files,
|
||||||
|
explicit missing/empty paths, empty-file rejection versus `{}`,
|
||||||
|
defaults-only loading, source records, override-before-validation behavior,
|
||||||
|
sorted backend conversion, and preservation of zero/nullable values.
|
||||||
|
Remove no existing entry point until all its CLI callers migrate in Stage 3.
|
||||||
|
|
||||||
|
Acceptance: real files and defaults-only inputs produce one reusable result,
|
||||||
|
runtime conversion agrees with it, and tests do not depend on machine-wide
|
||||||
|
configuration or secrets. The old and new internals are temporarily buildable,
|
||||||
|
with no new user-visible mode.
|
||||||
|
|
||||||
|
## Stage 3: Cut Existing Commands Over And Remove The Legacy Loader
|
||||||
|
|
||||||
|
**Status: Complete.** All five command modes use the shared ConfigKit loader;
|
||||||
|
the legacy decoder and merge path are removed. CLI and configuration contracts
|
||||||
|
now describe native YAML and override behavior. Full test, race, vet, build,
|
||||||
|
and diff checks passed.
|
||||||
|
|
||||||
|
Primary files: `internal/adapter/cli/run.go`, `inspect.go`,
|
||||||
|
`internal/config/config.go`, and associated tests.
|
||||||
|
|
||||||
|
1. Route run, render, serve, inspect prompt, and inspect profile through the
|
||||||
|
shared `Load` and `Settings` boundary. Preserve the explicit presence of
|
||||||
|
`--config` in every parser. Centralize the small application-flag mapping
|
||||||
|
rather than reproduce it in each command.
|
||||||
|
2. Use `flag.FlagSet.Visit` (or the existing explicit-set helper) to create
|
||||||
|
one `configkit.Override` per explicitly supplied application flag. Use
|
||||||
|
`configkit.Keys`, built-in scalar values, and a safe `Flag` label containing
|
||||||
|
only the flag name. Standard flag parsing's last occurrence supplies the
|
||||||
|
single override; do not emit duplicate records or parser defaults.
|
||||||
|
|
||||||
|
| Flag | Application path | Existing command scope after cutover |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `--prompt-dir` | `prompt_dir` | run, render, serve, inspect prompt |
|
||||||
|
| `--profile-dir` | `profile_dir` | run, render, serve, inspect profile |
|
||||||
|
| `--schema-dir` | `schema_dir` | run, render, serve |
|
||||||
|
| `--addr` | `server.addr` | serve |
|
||||||
|
| `--artifact-root` | `server.artifact_root` | serve |
|
||||||
|
| `--max-request-bytes` | `server.max_request_bytes` | serve |
|
||||||
|
| `--max-artifact-bytes` | `server.max_artifact_bytes` | serve |
|
||||||
|
| `--max-response-bytes` | `server.max_response_bytes` | serve |
|
||||||
|
|
||||||
|
Register the schema-directory flag on render as well as run/serve so the
|
||||||
|
advertised application path override is consistently usable. This is not a
|
||||||
|
general expansion of runtime/provider flags to other commands.
|
||||||
|
3. Keep `--format`, `--out`, request `--transient-retries`, prompt/profile
|
||||||
|
selection, model overrides, timeouts, inputs, variables, and reporting
|
||||||
|
options outside the application configuration tree. In particular,
|
||||||
|
`render --format` overrides that invocation's output format without
|
||||||
|
rewriting `defaults.render_format`; omitted format inherits its resolved
|
||||||
|
application value. Existing invocation-only parsing remains unchanged.
|
||||||
|
4. Remove post-load directory trimming/cleaning/defaulting from argument
|
||||||
|
finalizers, including unconditional schema-path cleaning. Keep only
|
||||||
|
invocation-owned transformations such as output-file paths. Explicit
|
||||||
|
empty profile/artifact-root overrides must clear file-provided values;
|
||||||
|
explicit empty prompt directory must reach the existing execution
|
||||||
|
prerequisite rather than revive the lower value.
|
||||||
|
5. Keep existing command prerequisites: run/render/serve and prompt inspection
|
||||||
|
need their effective prompt directory as currently required; profile
|
||||||
|
inspection does not acquire a prompt-directory requirement. All commands
|
||||||
|
still perform the common application schema validation. Do not introduce
|
||||||
|
eager filesystem or credential validation for inspection.
|
||||||
|
6. Add one CLI diagnostic path using `errors.As` and
|
||||||
|
`configkit.WriteDiagnostics` for load errors. Carry successful load warnings
|
||||||
|
to the command boundary and render them once on stderr before execution or
|
||||||
|
output. Handle diagnostic writer errors as command failures. Do not flatten
|
||||||
|
structured failures into raw parser text or print rejected values.
|
||||||
|
Preserve existing process exit classifications; application/parse/load
|
||||||
|
failures are exit 1, not generated-output validation exit 2.
|
||||||
|
7. Remove the old YAML decoder, `strictInteger.UnmarshalYAML`, old on-disk
|
||||||
|
types, `applyConfig`, `ApplyCLIOverrides`, and unused compatibility
|
||||||
|
sentinels/helpers after migrating all callers/tests. Keep only one defaults
|
||||||
|
factory. Remove the direct yaml.v3 import; module tidy may retain yaml.v3
|
||||||
|
as an indirect Promptkit dependency.
|
||||||
|
8. Update tests to the deliberate breaking semantics, not the legacy behavior.
|
||||||
|
Protect explicit empty path clearing, scalar-null rejection, unknown fields,
|
||||||
|
rejected empty/multi-document input, one representative YAML policy change,
|
||||||
|
unchanged request-versus-engine retry precedence, absent optional
|
||||||
|
credentials, and command-specific inspection prerequisites.
|
||||||
|
9. Update configuration and CLI contracts, source/adapter internals, architecture
|
||||||
|
ownership, and the contributor reading guide for the delivered cutover.
|
||||||
|
Preserve existing application defaults, Promptkit definition support,
|
||||||
|
HTTP containment, shared capacity, and report behavior. Adjust the current
|
||||||
|
CLI claim that every command requires a prompt directory to match actual
|
||||||
|
command-specific requirements.
|
||||||
|
|
||||||
|
Acceptance: all existing commands use ConfigKit, no legacy parser or second
|
||||||
|
application merge remains, relevant tests pass, and diagnostics and docs describe
|
||||||
|
the native breaking behavior. Imports/overlays and new inspection commands are
|
||||||
|
not yet advertised.
|
||||||
|
|
||||||
|
## Stage 4: Enable Explicit Imports And Selected Configuration Overlays
|
||||||
|
|
||||||
|
**Status: Complete.** File-backed loads support explicit imports and one
|
||||||
|
selected overlay under the selected file's canonical directory. All five
|
||||||
|
existing command modes accept `--config-overlay`; real-file composition and a
|
||||||
|
render workflow are tested. The composed example and contracts are updated;
|
||||||
|
full test, race, vet, build, and diff checks passed.
|
||||||
|
|
||||||
|
Primary files: shared loader, CLI source-selection wiring, configuration and
|
||||||
|
CLI tests, maintained configuration examples.
|
||||||
|
|
||||||
|
1. Enable `Options.Imports` for file-backed loads. Leave it false for
|
||||||
|
`NoSource`, which rejects imports. Use ConfigKit's default canonical
|
||||||
|
selected-file directory as the root; do not supply a wider filesystem root
|
||||||
|
or add application traversal code.
|
||||||
|
2. Wire `LoadOptions.Overlay` into `Options.Overlay`. Register
|
||||||
|
`--config-overlay` on all five existing configuration-loading command
|
||||||
|
modes. Treat the value exactly as an upstream overlay name: no trimming,
|
||||||
|
case folding, extension fallback, path expansion, or local inheritance.
|
||||||
|
Empty and exact lowercase default mean no active overlay under v0.4.0.
|
||||||
|
A requested active overlay without a selected base source fails through
|
||||||
|
ConfigKit; do not manufacture an empty base file or root.
|
||||||
|
3. Use native `configkit.imports` directives for explicit paths/globs. The
|
||||||
|
application enables the feature without requiring a second CLI opt-in;
|
||||||
|
absent directives cause no discovery. Retain conflict-based base
|
||||||
|
composition and native overlay replacement/null semantics.
|
||||||
|
4. Preserve working-directory-relative application path values even when
|
||||||
|
authored in fragments or overlays. Configuration-source containment is
|
||||||
|
not the HTTP artifact policy and is not applied to prompt/schema paths.
|
||||||
|
5. Add focused real-file tests for disjoint backend fragments, an import
|
||||||
|
conflict, overlay replacement, explicit CLI precedence, missing selected
|
||||||
|
overlay, and no-base overlay failure. Verify `--profile` still selects a
|
||||||
|
Promptkit execution profile independently of `--config-overlay`.
|
||||||
|
One real command workflow proves wiring; upstream owns exhaustive glob,
|
||||||
|
symlink, cycle, and parser-limit tests.
|
||||||
|
6. Add a small synthetic import/overlay example under `examples/`; preserve
|
||||||
|
a simple single-file quickstart. Update config/CLI contracts and operations
|
||||||
|
guidance for the new features, root selection, and relative-value policy.
|
||||||
|
|
||||||
|
Acceptance: supported commands load the same native composition pipeline;
|
||||||
|
imports are explicit, overlays remain distinct from execution profiles, and no
|
||||||
|
new scanning, remote acquisition, or path policy is introduced.
|
||||||
|
|
||||||
|
## Stage 5: Add Application Validation, Effective Output, And Source Inspection
|
||||||
|
|
||||||
|
**Status: Complete.** Application-only validation, effective YAML, and ordered
|
||||||
|
JSON source inspection use one shared ConfigKit result without an engine. Tests
|
||||||
|
cover source composition, CLI provenance, stream failures, and the credential
|
||||||
|
reference boundary. Public and internal contracts are updated; full test,
|
||||||
|
race, vet, build, and diff checks passed.
|
||||||
|
|
||||||
|
Primary files: a focused `internal/adapter/cli/config.go`, shared config
|
||||||
|
definition, CLI dispatch/help/tests, and canonical CLI/config documentation.
|
||||||
|
|
||||||
|
1. Apply the maintainer's selected inspection policy: no redaction for
|
||||||
|
`extra_params`, including historical values. API-key values are the only
|
||||||
|
relevant secrets, but this schema stores only `api_key_env` reference names.
|
||||||
|
Keep those names visible and never resolve them in the ConfigKit load.
|
||||||
|
Do not add secret tags to the reference name or parameter container, a
|
||||||
|
catch-all secret predicate, sensitive-key guessing, or a selective masking
|
||||||
|
interface. Actual credentials remain with Promptkit; raw API-key fields
|
||||||
|
remain rejected. Use upstream inspection renderers without adding a second
|
||||||
|
value-rendering path or a synthetic credential field.
|
||||||
|
2. Add a top-level `config` command family using the existing standard-library
|
||||||
|
flag style. The selected interfaces are:
|
||||||
|
|
||||||
|
| Command | Success stdout |
|
||||||
|
| --- | --- |
|
||||||
|
| `scriptorium config validate [flags]` | Empty; exit status communicates application validation success. |
|
||||||
|
| `scriptorium config show [flags]` | `Result.WriteEffective` redacted YAML. |
|
||||||
|
| `scriptorium config sources [flags]` | One newline-terminated JSON array of source records. |
|
||||||
|
| `scriptorium config explain --path <pointer> [flags]` | Added in Stage 6. |
|
||||||
|
|
||||||
|
These are prospective interface specifications, not commands to execute
|
||||||
|
before their stages are implemented.
|
||||||
|
3. All configuration subcommands accept `--config`, `--config-overlay`,
|
||||||
|
and the eight application override flags in Stage 3's table, regardless
|
||||||
|
of which execution command normally uses them. They do not accept request,
|
||||||
|
credential, backend-editing, output-format, or output-file flags. Shell
|
||||||
|
redirection is sufficient for these inspection outputs. No positional
|
||||||
|
arguments are accepted.
|
||||||
|
4. Load exactly once through the common loader. Do not construct a Promptkit
|
||||||
|
engine, restricted artifact reader, listener, or client. Missing prompt
|
||||||
|
directories, unselected/absent credentials, and framework backend validity
|
||||||
|
are not additional application-inspection gates. Invalid application
|
||||||
|
types/ranges/format still fail. Validation describes application load
|
||||||
|
validity, not end-to-end executability.
|
||||||
|
5. For sources, map `Result.Sources()` to a small local DTO with JSON keys
|
||||||
|
`id`, `label`, `layer` (always present), and `path` (omit when empty).
|
||||||
|
Preserve upstream source order; emit `[]\n` for defaults-only input without
|
||||||
|
overrides. Include synthetic CLI sources where present. Do not marshal
|
||||||
|
opaque ConfigKit implementation objects. The standard JSON encoder escapes
|
||||||
|
control characters; no custom terminal rendering is necessary.
|
||||||
|
6. Diagnostics/warnings go only to stderr through the shared diagnostic helper.
|
||||||
|
Successful operations exit 0; parse/load/output/diagnostic-write failures
|
||||||
|
exit 1. No exit 2 meaning is introduced for configuration validation.
|
||||||
|
Ordinary writer failures may leave partial output; do not promise atomic
|
||||||
|
streams or buffering of an entire configuration.
|
||||||
|
7. Test defaults-only show/sources, a composed load with CLI provenance,
|
||||||
|
explicit empty clearing, normalized effective values, failed loads producing
|
||||||
|
no successful stdout, and writer failure. Set a synthetic API-key environment
|
||||||
|
variable: effective output must show its reference name, not its value.
|
||||||
|
Repeat with the variable absent to establish that inspection does not require
|
||||||
|
credentials. Assert that ordinary synthetic parameter values remain visible
|
||||||
|
and runtime ExtraParams stay intact; no real environment or provider is used.
|
||||||
|
8. Update CLI/config contracts, README navigation, subprocess integration,
|
||||||
|
operations, and internal inventory to describe only these delivered modes.
|
||||||
|
Retain the README's license/attribution ending.
|
||||||
|
|
||||||
|
Acceptance: validation, effective output, and source inspection use the same
|
||||||
|
resolved configuration as execution, preserve stream separation, and honor the
|
||||||
|
selected API-key boundary without masking or changing backend parameter data.
|
||||||
|
|
||||||
|
## Stage 6: Add Per-Path Explanation And Verify Credential Boundaries
|
||||||
|
|
||||||
|
**Status: Complete.** `config explain` uses required JSON Pointer paths and
|
||||||
|
ConfigKit's snapshot renderer, including historical and normalized values.
|
||||||
|
Tests cover root, escaped/numeric keys, unknown paths, writer failures, and
|
||||||
|
synthetic credential-reference boundaries. Full test, race, vet, build, and
|
||||||
|
diff checks passed.
|
||||||
|
|
||||||
|
Primary files: configuration command implementation/tests and CLI/config docs.
|
||||||
|
|
||||||
|
1. Implement `config explain` with the same selectors and override flags as
|
||||||
|
Stage 5 plus a required, explicitly supplied `--path`. Parse using
|
||||||
|
`configkit.ParsePath`; syntax is JSON Pointer, not dotted notation, a file
|
||||||
|
path, or a URL fragment. Explicit `--path ""` selects the root; an omitted
|
||||||
|
flag is an error. Preserve escaped and numeric mapping-key semantics.
|
||||||
|
2. Use the successful shared result's `WriteExplanation`. Explain known
|
||||||
|
effective and historical paths, including removed values. An unknown or
|
||||||
|
malformed path exits 1 with no successful explanation output. Quote
|
||||||
|
user-supplied paths safely if included in application diagnostics.
|
||||||
|
Do not rebuild history, look up environment values, or reload sources.
|
||||||
|
3. Keep the upstream human-readable renderer and its redaction semantics rather
|
||||||
|
than inventing a JSON explanation schema or freezing the entire rendered
|
||||||
|
prose as an application guarantee. Writer failures exit 1 and can leave
|
||||||
|
partial output, as with effective output.
|
||||||
|
4. Test a value's default/base/overlay/CLI history, recorded normalization,
|
||||||
|
explicit equal-value writes, an escaped backend key, root selection, and
|
||||||
|
an unknown path. Cover a displaced historical backend parameter value:
|
||||||
|
it remains visible, including in a container/root explanation. Use distinct
|
||||||
|
synthetic environment names and key values to verify reference names remain
|
||||||
|
explainable but resolved API-key bytes are absent from all history/output.
|
||||||
|
5. Update CLI/config docs and operations guidance with path syntax,
|
||||||
|
historical-value meaning, representation differences, and sensitive
|
||||||
|
identifiers/paths. Do not claim that redaction detects arbitrary secrets
|
||||||
|
outside classified paths.
|
||||||
|
|
||||||
|
Acceptance: explain uses the existing snapshot and upstream semantics; its
|
||||||
|
history matches the selected inputs and normalization, parameters remain
|
||||||
|
visible, and explanation neither resolves nor discloses API-key values.
|
||||||
|
|
||||||
|
## Stage 7: Verify Integration, Finish Documentation, And Record Release Handoff
|
||||||
|
|
||||||
|
**Status: Complete.** The feature roadmap, command paths, dependency boundary,
|
||||||
|
documentation, and attribution were audited. Maintained single-file and
|
||||||
|
composed examples passed configuration inspection and no-provider rendering;
|
||||||
|
the optional-credential/integer-parameter backend path passed with a local
|
||||||
|
provider. The full test, race, vet, build, formatting, link, and diff checks
|
||||||
|
passed. Release preparation is recorded below; no tag or publication occurred.
|
||||||
|
|
||||||
|
1. Review the feature roadmap against actual code. Confirm all five original
|
||||||
|
command modes and all four new configuration subcommands use one definition
|
||||||
|
and load pipeline. Remove any transitional loader, duplicated defaults,
|
||||||
|
unused compatibility helpers, or post-snapshot configuration mutation.
|
||||||
|
Do not add architecture machinery merely to assert a particular file layout.
|
||||||
|
2. Exercise maintained single-file and import/overlay examples through the
|
||||||
|
implemented configuration commands and a no-provider render workflow.
|
||||||
|
Use focused backend integration evidence that dynamic integer parameters
|
||||||
|
reach Promptkit correctly and missing optional credentials retain their
|
||||||
|
established meaning. Use a local HTTP server only where provider serialization
|
||||||
|
must be checked; never a real service or credential.
|
||||||
|
3. Retain existing HTTP concurrency, containment, error mapping, retry,
|
||||||
|
timeout, and report tests. Add a representative configuration-to-server
|
||||||
|
wiring test only if existing coverage misses changed settings propagation;
|
||||||
|
do not reproduce all upstream scheduling or HTTP cases.
|
||||||
|
4. Run the development baseline on final code: `go test ./...`,
|
||||||
|
`go test -race ./...`, `go vet ./...`, and
|
||||||
|
`go build ./cmd/scriptorium`. Check formatting, affected examples/links,
|
||||||
|
and `git diff --check`. Do not stage the built binary or scratch files.
|
||||||
|
Compare any new standard license text byte-for-byte; preserve upstream
|
||||||
|
whitespace rather than editing license wording to satisfy a style check.
|
||||||
|
5. Ensure current configuration, CLI, subprocess, operations, internal docs,
|
||||||
|
contributor routing, and architecture ownership agree. Testing policy
|
||||||
|
should identify ConfigKit as the owner of exhaustive upstream loading tests,
|
||||||
|
while Scriptorium owns application adoption tests. Change policy dates when
|
||||||
|
revising policies, not base versions unless adopting new templates.
|
||||||
|
Keep accepted ADR text and published release notes immutable.
|
||||||
|
6. Record the release handoff below and mark only delivered stages complete.
|
||||||
|
Update the feature roadmap's status, including the resolved inspection
|
||||||
|
decision. Preserve deferred work. The next breaking release follows the
|
||||||
|
release policy; version selection, candidate publication validation, release
|
||||||
|
notes at that version, tag creation, and publishing are not this sprint.
|
||||||
|
7. Commit the final coherent handoff and report validation evidence, remaining
|
||||||
|
limitations, and any outstanding work without claiming source/binary
|
||||||
|
publication or complete legal compliance.
|
||||||
|
|
||||||
|
Acceptance: the ConfigKit-native target is delivered with proportionate
|
||||||
|
regression evidence and accurate documentation, and the workspace contains no
|
||||||
|
temporary dependency substitutions or uncommitted implementation artifacts.
|
||||||
|
|
||||||
|
### Release Handoff To Retain
|
||||||
|
|
||||||
|
The upcoming release needs migration guidance for empty files versus `{}`,
|
||||||
|
explicit empty values, nullable versus scalar fields, strict YAML/scalars,
|
||||||
|
reserved keys and upstream size limits, and the invalid explicit-empty config
|
||||||
|
path. Include imports/overlays, application path interpretation, CLI presence,
|
||||||
|
inspection command scope, and the selected API-key-only secret policy. Explicit
|
||||||
|
empty server address reaches standard HTTP server behavior instead of restoring
|
||||||
|
Scriptorium's default; operators should supply their intended listen address.
|
||||||
|
|
||||||
|
Keep request retry overrides and Promptkit credential semantics distinct from
|
||||||
|
application settings. Explain that configuration validation is not a provider
|
||||||
|
probe or complete Promptkit definition validator, and that inspection output
|
||||||
|
is not guaranteed reloadable. Include dependency/attribution changes and the
|
||||||
|
existing LICENSE | ATTRIBUTION footer. Preserve the still-relevant Promptkit
|
||||||
|
v0.11 release handoff identified above when preparing a combined next release.
|
||||||
|
|
||||||
|
### Implementation And Release Preparation Record
|
||||||
|
|
||||||
|
The ConfigKit v0.4.0 adoption is implemented in committed source. The next
|
||||||
|
breaking release still needs version selection, version-matched release notes,
|
||||||
|
candidate validation, tagging, and publication under the release policy; none
|
||||||
|
has occurred as part of this work. Keep the earlier Promptkit v0.11 handoff
|
||||||
|
linked above when preparing a combined release.
|
||||||
|
|
||||||
|
The release note should summarize the deliberate configuration migration:
|
||||||
|
empty files now fail and `{}` means an empty mapping; explicitly empty strings
|
||||||
|
and zero values override lower values; `null` follows declared nullable types;
|
||||||
|
strict YAML rejects additional documents, anchors/aliases, unsupported scalar
|
||||||
|
forms, and unknown fields; `configkit` is reserved and ConfigKit's source and
|
||||||
|
resource limits apply. Explicit `--config ''` is invalid. Imports are opt-in
|
||||||
|
per file directive, while `--config-overlay` selects one named overlay under
|
||||||
|
the selected file's canonical directory; application path *values* remain
|
||||||
|
process-working-directory-relative. Only explicitly supplied application CLI
|
||||||
|
flags override configuration. An explicit empty server address is passed to
|
||||||
|
the standard HTTP server and does not restore Scriptorium's default.
|
||||||
|
|
||||||
|
Document the four application-inspection modes and the selected policy:
|
||||||
|
`extra_params`, including history, and `api_key_env` reference names remain
|
||||||
|
visible, but actual API-key bytes are never resolved by ConfigKit. Inspection
|
||||||
|
output can be sensitive and is not guaranteed reloadable. Application
|
||||||
|
validation neither probes a provider nor completely validates Promptkit
|
||||||
|
definitions. Keep request retry overrides and Promptkit's credential rules
|
||||||
|
separate from application settings. Include the new dependency and attribution
|
||||||
|
notices, and retain the existing LICENSE | ATTRIBUTION footer. Deferred
|
||||||
|
secrets bootstrap, schema versioning, reload, and remote acquisition remain
|
||||||
|
deferred; do not imply source or binary publication has happened.
|
||||||
|
|
||||||
|
## Open Questions
|
||||||
|
|
||||||
|
None remain for this scope. On 2026-09-26 the maintainer selected no redaction
|
||||||
|
for `extra_params` and specified that the API key is the only secret requiring
|
||||||
|
ConfigKit redaction. Stages 5–6 implement that decision through visible parameter
|
||||||
|
values/reference names and the existing separation of actual credentials from
|
||||||
|
application configuration. Do not reopen it or substitute blanket masking.
|
||||||
|
|
||||||
|
This does not claim automatic detection of credentials embedded in arbitrary
|
||||||
|
strings or provider parameters. The application schema still rejects raw API-key
|
||||||
|
fields, and Promptkit remains responsible for resolving named credential sources.
|
||||||
63
docs/roadmap/policy.md
Normal file
63
docs/roadmap/policy.md
Normal file
@@ -0,0 +1,63 @@
|
|||||||
|
# OSS Policy Adoption
|
||||||
|
|
||||||
|
## Status
|
||||||
|
|
||||||
|
Completed on 2026-09-26. The upstream template work proposed here is now
|
||||||
|
available and adopted locally. This document records the adoption; the
|
||||||
|
[OSS policy](../policy/oss.md) is the canonical owner of the ongoing rules.
|
||||||
|
|
||||||
|
The adopted baseline is the standard policy repository at commit
|
||||||
|
`eea8bcd21a964b395e31971077d7fddb445f2c28`:
|
||||||
|
|
||||||
|
- OSS policy base version 1.1;
|
||||||
|
- documentation policy base version 1.4; and
|
||||||
|
- release policy base version 1.2.
|
||||||
|
|
||||||
|
Each affected policy records its base version and local update date. Template
|
||||||
|
adoption instructions were removed. Unchanged agent, architecture, and testing
|
||||||
|
policies retain their existing versions.
|
||||||
|
|
||||||
|
## Adoption Outcome
|
||||||
|
|
||||||
|
- [Documentation ownership](../policy/documentation.md) distinguishes the
|
||||||
|
project license, component entries, standard texts, and OSS policy.
|
||||||
|
- The [contributor guide](../development.md) routes dependency, copied-asset,
|
||||||
|
attribution, and release-document work to the OSS policy.
|
||||||
|
- [Component entries](../oss/attribution.md) cover the six selected direct and
|
||||||
|
transitive Go modules. Source and project-specific notice links identify the
|
||||||
|
imported commits. LGPL entries link directly to both LGPL v3 and GPL v3.
|
||||||
|
- Project-specific notices are linked upstream under the adopted house
|
||||||
|
interpretation. YAML's former local LICENSE and NOTICE copies were removed;
|
||||||
|
their history remains in Git. Missing upstream copyright statements are
|
||||||
|
identified in the affected entries rather than fabricated.
|
||||||
|
- The five applicable standard texts in `docs/oss/licenses/` match the upstream
|
||||||
|
reference collection byte-for-byte: GPL v3, LGPL v3, Apache 2.0, BSD 3-Clause,
|
||||||
|
and MIT. The reference collection documents their publisher/SPDX provenance.
|
||||||
|
Adoption removed a stray LGPL prefix, restored the complete Apache text,
|
||||||
|
separated the standard BSD text from the Go-specific notice, and added MIT.
|
||||||
|
- The [README](../../README.md) ends with friendly project-license and
|
||||||
|
attribution links. The [release policy](../policy/release.md) delegates footer
|
||||||
|
conventions to the OSS policy; the [release procedure](../release.md) retains
|
||||||
|
Scriptorium's immutable-tag URLs and existing hosted-body reuse.
|
||||||
|
|
||||||
|
## Preserved Scope
|
||||||
|
|
||||||
|
This adoption changes documentation and attribution, not Scriptorium's license,
|
||||||
|
dependencies, application architecture, or release machinery. Published notes,
|
||||||
|
tags, and assets remain unchanged. Existing source-release completion and
|
||||||
|
asynchronous binary-delivery behavior remain intact.
|
||||||
|
|
||||||
|
There is no new publication-time network check, approval gate, scanner, source
|
||||||
|
bundle, downloadable license asset, or modified-dependency rebuild exercise.
|
||||||
|
Concrete exceptions continue to receive the treatment specified by the adopted
|
||||||
|
OSS policy; the house format is not a universal legal-sufficiency guarantee.
|
||||||
|
|
||||||
|
## Validation
|
||||||
|
|
||||||
|
The standard texts were compared against the upstream reference collection.
|
||||||
|
The BSD reference intentionally retains its publisher's trailing space in the
|
||||||
|
copyright placeholder; it is not reformatted to satisfy a whitespace check.
|
||||||
|
Dependency commit references were resolved from Go module origin metadata or
|
||||||
|
the selected upstream tag, and affected local links and upstream attribution
|
||||||
|
destinations were checked. No runtime code, commands, or executable examples
|
||||||
|
changed.
|
||||||
351
docs/roadmap/promptkit-v0.9.0-adoption.md
Normal file
351
docs/roadmap/promptkit-v0.9.0-adoption.md
Normal file
@@ -0,0 +1,351 @@
|
|||||||
|
# Promptkit v0.9.0 Adoption Roadmap
|
||||||
|
|
||||||
|
## Status
|
||||||
|
|
||||||
|
Complete. This document records the delivered feature scope and targeted end
|
||||||
|
state. The completed delivery plan is maintained in
|
||||||
|
[implementation.md](implementation.md); current behavior remains defined by
|
||||||
|
the canonical application contracts linked below.
|
||||||
|
|
||||||
|
The durable product and integration boundary for this work is established by
|
||||||
|
[ADR 0004](../adr/0004-definition-boundary.md). This roadmap applies that
|
||||||
|
decision to Promptkit v0.9.0 and owns implementation scope and completion
|
||||||
|
status.
|
||||||
|
|
||||||
|
## Objective
|
||||||
|
|
||||||
|
Bring Scriptorium from Promptkit v0.1.0 to v0.9.0 and expose the newer
|
||||||
|
framework capabilities that fit Scriptorium's existing CLI, HTTP,
|
||||||
|
configuration, presentation, and process boundaries.
|
||||||
|
|
||||||
|
Scriptorium must accept the complete Promptkit v0.9.0 feature set expressed by
|
||||||
|
directory-backed prompt, profile, and schema definitions. Application adapters
|
||||||
|
must not narrow that format contract by requiring request values that the
|
||||||
|
selected definition does not require or by omitting selection values needed to
|
||||||
|
address a valid definition. Promptkit's tagged
|
||||||
|
[framework format reference](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.9.0/docs/formats.md)
|
||||||
|
remains canonical; Scriptorium must delegate parsing and framework validation
|
||||||
|
rather than reproduce those rules.
|
||||||
|
|
||||||
|
The completed application will retain Promptkit as the owner of reusable
|
||||||
|
prompt execution, source formats, profiles, backend definitions, capacity,
|
||||||
|
inspection, generation, and validation. Scriptorium will continue to own
|
||||||
|
application configuration, command and HTTP contracts, error and exit mapping,
|
||||||
|
output presentation, and deployment policy.
|
||||||
|
|
||||||
|
## Targeted End State
|
||||||
|
|
||||||
|
When this roadmap is complete:
|
||||||
|
|
||||||
|
- Scriptorium pins the released Promptkit v0.9.0 module without a workspace,
|
||||||
|
replacement, vendored source, direct catalog import, or Promptkit internal
|
||||||
|
import.
|
||||||
|
- Existing valid CLI, HTTP, configuration, prompt, profile, schema, and render
|
||||||
|
workflows remain supported subject to Promptkit's documented v0.2.0 through
|
||||||
|
v0.9.0 compatibility corrections.
|
||||||
|
- Every Promptkit v0.9.0 prompt and profile feature expressible in definitions
|
||||||
|
under Scriptorium's configured directory sources is usable through the
|
||||||
|
executable application, including prompts with no inputs and explicitly
|
||||||
|
selected prompt versions.
|
||||||
|
- CLI and HTTP requests can supply a direct non-secret session ID.
|
||||||
|
- HTTP requests and a presence-aware CLI flag can inherit, replace, or
|
||||||
|
explicitly clear reasoning effort.
|
||||||
|
- Prepared output, CLI run summaries, and HTTP result metadata expose effective
|
||||||
|
backend identity when Promptkit supplies one.
|
||||||
|
- HTTP capacity rejection has a stable Scriptorium-owned overload response.
|
||||||
|
- Application configuration can register reusable engine-scoped custom
|
||||||
|
backends, including bounded concurrency and queue policy, for selection by
|
||||||
|
Promptkit profiles.
|
||||||
|
- CLI users can inspect prompt and profile definitions without supplying
|
||||||
|
placeholder inputs or invoking a model.
|
||||||
|
- Scriptorium's contracts and examples point to Promptkit v0.9.0 and accurately
|
||||||
|
describe its current credential, validation-repair, provider-control,
|
||||||
|
message-role, backend, and source-validation semantics.
|
||||||
|
|
||||||
|
## Feature Scope
|
||||||
|
|
||||||
|
### Complete Prompt And Profile Definition Compatibility
|
||||||
|
|
||||||
|
Scriptorium will treat the tagged Promptkit v0.9.0 format contract as one
|
||||||
|
indivisible downstream compatibility boundary. This includes prompt identity
|
||||||
|
and version selection, optional and required input declarations, message and
|
||||||
|
content-file templates, supported roles, cache control, session templates,
|
||||||
|
default profiles, output contracts, schemas, and repair budgets. It also
|
||||||
|
includes standalone and inherited profiles, built-in and custom backend
|
||||||
|
selection, endpoint overrides, execution controls, optional credential
|
||||||
|
environment sources, and JSON-compatible extra parameters.
|
||||||
|
|
||||||
|
Most of this support is provided by passing configured prompt, profile, and
|
||||||
|
schema directories directly to Promptkit. Scriptorium will not independently
|
||||||
|
decode these framework definitions or maintain a field-level subset. Two
|
||||||
|
current adapter restrictions must be removed so the executable interfaces do
|
||||||
|
not reject definitions that Promptkit accepts:
|
||||||
|
|
||||||
|
- `run` and `render` will accept an optional prompt-version flag and map it to
|
||||||
|
`promptkit.RunRequest.PromptVersion`; and
|
||||||
|
- `run`, `render`, and `POST /v1/runs` will permit omitted or empty input maps.
|
||||||
|
Promptkit will decide whether an input is required by the selected
|
||||||
|
definition or referenced template.
|
||||||
|
|
||||||
|
The HTTP API already carries `prompt_version`; its mapping must remain covered
|
||||||
|
by adapter tests. CLI and HTTP callers may continue to supply extra inputs,
|
||||||
|
subject to their existing file, containment, and size policies. Removing the
|
||||||
|
application-level nonempty-input requirement does not weaken Promptkit's
|
||||||
|
declared-required-input or template-reference validation.
|
||||||
|
|
||||||
|
Profiles that name built-in backend IDs require no application registration.
|
||||||
|
Profiles that name other backend IDs become fully usable through the custom
|
||||||
|
backend configuration in this roadmap. Profile inheritance and all other
|
||||||
|
profile-field resolution remain Promptkit responsibilities.
|
||||||
|
|
||||||
|
This compatibility requirement concerns fields and behavior expressed in
|
||||||
|
Promptkit YAML definitions. Go-consumer construction alternatives such as
|
||||||
|
single-file sources, injected `fs.FS` sources, in-memory profiles, fallback
|
||||||
|
profile filesystems, and prepared-execution handles are library-integration
|
||||||
|
features and are not required merely to support the complete definition
|
||||||
|
format.
|
||||||
|
|
||||||
|
### Promptkit v0.9.0 Compatibility Baseline
|
||||||
|
|
||||||
|
Required dependency and source changes:
|
||||||
|
|
||||||
|
- update `go.mod` and `go.sum` to select Promptkit v0.9.0 and its selected
|
||||||
|
OpenRouter and Rakestrawhome catalog dependencies;
|
||||||
|
- change Scriptorium's inbound HTTP reasoning-effort representation to preserve
|
||||||
|
Promptkit's pointer semantics;
|
||||||
|
- retain keyed Promptkit public struct literals and confirm no removed
|
||||||
|
`RunRequest.Metadata` use exists;
|
||||||
|
- update tagged Promptkit links and version references throughout Scriptorium;
|
||||||
|
and
|
||||||
|
- preserve Scriptorium's architecture guard against replacements, workspaces,
|
||||||
|
vendored Promptkit code, former facade packages, and Promptkit internal
|
||||||
|
imports.
|
||||||
|
|
||||||
|
Required compatibility review:
|
||||||
|
|
||||||
|
- verify application and maintained example endpoints satisfy Promptkit's
|
||||||
|
absolute HTTP/HTTPS endpoint rules;
|
||||||
|
- verify prompt content paths, file artifacts, identities, JSON documents, and
|
||||||
|
JSON-compatible extra parameters satisfy the v0.6.0 safety boundaries;
|
||||||
|
- verify maintained prompt roles are limited to `developer`, `system`, `user`,
|
||||||
|
and `assistant`;
|
||||||
|
- verify every positive repair budget is no greater than three and is paired
|
||||||
|
with `basic`, `json`, or `json_schema` validation;
|
||||||
|
- document that positive repair budgets authorize additional provider calls,
|
||||||
|
latency, token use, and cost;
|
||||||
|
- document that unset optional provider controls are omitted and that a zero
|
||||||
|
effective value can represent an unspecified provider control unless an
|
||||||
|
explicit request override supplied it; and
|
||||||
|
- update credential guidance for Promptkit's optional environment lookup
|
||||||
|
behavior, profile `api_key_env` semantics, and Scriptorium's prohibition on
|
||||||
|
raw API-key inputs.
|
||||||
|
|
||||||
|
### Session And Reasoning Request Controls
|
||||||
|
|
||||||
|
The CLI `run` and `render` commands will accept a direct session-ID flag and map
|
||||||
|
it to `promptkit.RunRequest.SessionID`. The value remains non-secret
|
||||||
|
application correlation metadata and is subject to Promptkit's normalization
|
||||||
|
and length rules.
|
||||||
|
|
||||||
|
The HTTP run request will accept `session_id` and map it through the existing
|
||||||
|
strict DTO boundary. Successful HTTP metadata will report the effective
|
||||||
|
session ID when present.
|
||||||
|
|
||||||
|
The CLI `run` and `render` commands will also accept a presence-aware reasoning
|
||||||
|
effort flag. Omission inherits the selected profile, a nonblank value replaces
|
||||||
|
it, and an explicitly supplied empty value clears it. The existing HTTP
|
||||||
|
`model.reasoning_effort` field will gain the same three-state behavior while
|
||||||
|
remaining a JSON string when present.
|
||||||
|
|
||||||
|
These additions must not introduce raw direct API-key flags or fields.
|
||||||
|
|
||||||
|
### Backend Identity And Capacity Outcomes
|
||||||
|
|
||||||
|
Scriptorium presentation will expose `SelectedBackendID` and the effective
|
||||||
|
target's `BackendID` without deriving identity from endpoint text. Backend
|
||||||
|
identity will be included where applicable in:
|
||||||
|
|
||||||
|
- prepared-run text and JSON output;
|
||||||
|
- the CLI run summary; and
|
||||||
|
- HTTP response metadata and effective model parameters.
|
||||||
|
|
||||||
|
Endpoint-only profiles continue to have no backend ID, and empty identities
|
||||||
|
must remain distinguishable from registered built-in or custom backends.
|
||||||
|
|
||||||
|
The HTTP adapter will classify `promptkit.ErrCapacityExceeded` separately from
|
||||||
|
provider generation failures. The target public outcome is HTTP `503` with a
|
||||||
|
stable `capacity_exceeded` code and a generic message. Scriptorium will not
|
||||||
|
invent retry timing or expose an untrusted diagnostic. CLI capacity rejection
|
||||||
|
continues to be a runtime failure, with a clear safe diagnostic and the
|
||||||
|
existing runtime-error exit status.
|
||||||
|
|
||||||
|
The HTTP server will use one appropriately scoped Promptkit engine across its
|
||||||
|
requests so backend admission, active-generation limits, and queue capacity
|
||||||
|
apply across concurrent in-flight work. The server may retain the operational
|
||||||
|
state needed for those limits and for request cancellation and lifecycle
|
||||||
|
management. This does not create durable per-request, conversation, or resume
|
||||||
|
state.
|
||||||
|
|
||||||
|
Scriptorium will continue to return generic public model-generation failures.
|
||||||
|
Promptkit `GenerationError` provider code, type, and message values will not be
|
||||||
|
added to the public HTTP response because they are untrusted and potentially
|
||||||
|
sensitive.
|
||||||
|
|
||||||
|
### Custom Backend Configuration
|
||||||
|
|
||||||
|
The strict Scriptorium application configuration will gain an optional custom
|
||||||
|
backend collection. Each entry will support the application-owned mapping
|
||||||
|
needed to construct a public `promptkit.Backend`:
|
||||||
|
|
||||||
|
- backend ID;
|
||||||
|
- OpenAI-compatible endpoint;
|
||||||
|
- optional API-key environment-variable name;
|
||||||
|
- optional JSON-compatible request-wide extra parameters;
|
||||||
|
- non-negative concurrency limit; and
|
||||||
|
- queue capacity with presence preserved so omission and explicit zero remain
|
||||||
|
different.
|
||||||
|
|
||||||
|
Raw API-key values will remain invalid. Unknown fields will remain errors.
|
||||||
|
Configured backends will be registered through `promptkit.WithBackend` during
|
||||||
|
engine construction and will be immutable and engine-scoped. Promptkit will
|
||||||
|
remain the canonical validator for backend IDs, endpoints, reserved request
|
||||||
|
parameters, capacity bounds, duplicate or reserved IDs, environment-variable
|
||||||
|
names, and JSON-compatible values. Scriptorium will add context appropriate to
|
||||||
|
its configuration error boundary without copying those framework rules.
|
||||||
|
|
||||||
|
The collection will be configuration-file-owned. This roadmap does not add
|
||||||
|
per-backend CLI flags. Existing endpoint-only profiles remain valid, while
|
||||||
|
profiles may select configured custom backend IDs through Promptkit's existing
|
||||||
|
`backend` field. Promptkit's built-in OpenRouter and Rakestrawhome backends and
|
||||||
|
profiles remain available without Scriptorium registration.
|
||||||
|
|
||||||
|
The application configuration shape is a `backends` mapping whose keys are the
|
||||||
|
backend IDs registered with Promptkit:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
backends:
|
||||||
|
local-gpu:
|
||||||
|
endpoint: http://localhost:11434/v1
|
||||||
|
api_key_env: LOCAL_GPU_API_KEY
|
||||||
|
extra_params:
|
||||||
|
provider_option: enabled
|
||||||
|
concurrency_limit: 2
|
||||||
|
queue_capacity: 0
|
||||||
|
```
|
||||||
|
|
||||||
|
`endpoint` is required for each entry. The other fields are optional. Omitted
|
||||||
|
`queue_capacity` uses Promptkit's default queue policy when concurrency is
|
||||||
|
bounded, while an explicit zero disables queuing. The configuration contract
|
||||||
|
and complete maintained configuration example will document this shape when
|
||||||
|
the feature is implemented.
|
||||||
|
|
||||||
|
### Prompt And Profile Inspection CLI
|
||||||
|
|
||||||
|
Scriptorium will add a CLI inspection command with prompt and profile modes.
|
||||||
|
The intended command family is:
|
||||||
|
|
||||||
|
- `scriptorium inspect prompt`, backed by `Engine.InspectPrompt`; and
|
||||||
|
- `scriptorium inspect profile`, backed by `Engine.InspectProfile`.
|
||||||
|
|
||||||
|
Prompt inspection will select an ID and optional version and report the
|
||||||
|
normalized prompt identity, opaque prompt hash, declared default profile,
|
||||||
|
declared inputs, and normalized output contract. It will not require input
|
||||||
|
artifacts, resolve a profile, load a schema, render templates, reserve backend
|
||||||
|
capacity, or contact a model.
|
||||||
|
|
||||||
|
Profile inspection will select an explicit profile ID and report its resolved
|
||||||
|
effective target, backend identity, optional credential source name, and
|
||||||
|
whether a later request must provide credential configuration. It will not
|
||||||
|
read credential values, load a prompt, reserve capacity, or contact a model.
|
||||||
|
|
||||||
|
Inspection will support deterministic Scriptorium-owned text and JSON output
|
||||||
|
and normal output-file handling. Scriptorium will define explicit output DTOs
|
||||||
|
rather than treating Promptkit inspection structs as stable wire formats.
|
||||||
|
Inspection failures will use existing public Promptkit error identities and
|
||||||
|
Scriptorium-owned CLI diagnostics and exit behavior.
|
||||||
|
|
||||||
|
The prompt form accepts `--prompt`, optional `--prompt-version`, `--config`,
|
||||||
|
`--prompt-dir`, `--format text|json`, and `--out`. The profile form accepts
|
||||||
|
`--profile`, `--config`, `--profile-dir`, `--format text|json`, and `--out`.
|
||||||
|
Both forms reject positional arguments and default to text output independently
|
||||||
|
of `defaults.render_format`. Configuration discovery and CLI-over-file source
|
||||||
|
precedence match the existing command family. Prompt inspection requires an
|
||||||
|
effective prompt directory; profile inspection does not, because Promptkit's
|
||||||
|
built-in profiles remain inspectable without one.
|
||||||
|
|
||||||
|
## Documentation And Example Changes
|
||||||
|
|
||||||
|
Implementation of this roadmap requires coordinated updates to the canonical
|
||||||
|
owners of affected behavior:
|
||||||
|
|
||||||
|
- `docs/cli.md` for session and reasoning flags, inspection commands, output,
|
||||||
|
prompt-version selection, optional inputs, and exit behavior;
|
||||||
|
- `docs/api.md` for `session_id`, effective backend/session metadata, reasoning
|
||||||
|
presence semantics, optional inputs, and the capacity response;
|
||||||
|
- `docs/config.md` for custom backend configuration and current Promptkit
|
||||||
|
credential and provider-default semantics;
|
||||||
|
- `docs/operations.md` for capacity and custom-backend operational guidance
|
||||||
|
where deployment handling is affected;
|
||||||
|
- `docs/internal/adapters.md` and `docs/internal/sources.md` for implemented
|
||||||
|
mapping and engine-assembly behavior;
|
||||||
|
- `docs/policy/architecture.md` and `docs/internal/overview.md` only if concrete
|
||||||
|
component responsibilities or durable boundaries change; and
|
||||||
|
- maintained examples for valid v0.9.0 prompt/profile formats and custom
|
||||||
|
backend configuration.
|
||||||
|
|
||||||
|
Current-state documents must not describe these features as implemented until
|
||||||
|
the corresponding code lands.
|
||||||
|
|
||||||
|
## Validation And Completion Criteria
|
||||||
|
|
||||||
|
The roadmap is complete only when:
|
||||||
|
|
||||||
|
- ordinary and race-enabled tests pass against the tagged Promptkit v0.9.0
|
||||||
|
dependency;
|
||||||
|
- `go vet ./...` and `go build ./cmd/scriptorium` pass;
|
||||||
|
- Go formatting and `git diff --check` pass;
|
||||||
|
- the architecture guard passes with no workspace, replacement, vendor tree,
|
||||||
|
former facade, or Promptkit internal import;
|
||||||
|
- maintained render, custom-backend, session, reasoning, and inspection
|
||||||
|
examples execute successfully without real credentials or provider calls;
|
||||||
|
- CLI tests cover explicit and omitted prompt versions for prompt IDs with one
|
||||||
|
or multiple definitions;
|
||||||
|
- CLI and HTTP tests cover prompts with no declared inputs, omitted optional
|
||||||
|
inputs, missing required inputs, and template-referenced inputs;
|
||||||
|
- HTTP tests cover omitted, replacement, and clearing reasoning states;
|
||||||
|
- CLI and HTTP tests cover session propagation and invalid session handling;
|
||||||
|
- presentation tests cover registered and endpoint-only backend identity;
|
||||||
|
- HTTP tests cover capacity rejection independently from provider failure;
|
||||||
|
- concurrent HTTP tests demonstrate that one server's requests share backend
|
||||||
|
admission and cannot bypass capacity through per-request engine creation;
|
||||||
|
- configuration tests cover strict decoding, precedence, queue-capacity
|
||||||
|
presence, invalid backends, and secret-field rejection;
|
||||||
|
- inspection tests cover deterministic text and JSON, source selection,
|
||||||
|
output-file handling, safe credential presentation, and public error
|
||||||
|
mapping;
|
||||||
|
- all maintained prompt roles and repair budgets are valid under Promptkit
|
||||||
|
v0.9.0; and
|
||||||
|
- representative definition fixtures cover inline and file-backed messages,
|
||||||
|
cache control, session templates, every output validation mode, schemas,
|
||||||
|
profile inheritance, built-in and custom backends, execution controls,
|
||||||
|
credential environment names, and extra parameters without Scriptorium
|
||||||
|
independently parsing those fields; and
|
||||||
|
- affected documentation links and copyable examples validate successfully.
|
||||||
|
|
||||||
|
## Explicit Non-Goals
|
||||||
|
|
||||||
|
This roadmap does not include:
|
||||||
|
|
||||||
|
- appended request messages in either executable interface;
|
||||||
|
- retained or durable prepared-execution handles;
|
||||||
|
- HTTP prompt or profile inspection routes;
|
||||||
|
- embedded application fallback profiles;
|
||||||
|
- single-file, injected `fs.FS`, or in-memory prompt and profile source
|
||||||
|
configuration;
|
||||||
|
- request-level output-contract replacement through the executable interfaces;
|
||||||
|
- public disclosure of structured provider error details;
|
||||||
|
- direct imports or configuration of Promptkit's external catalog modules;
|
||||||
|
- raw API-key configuration, CLI flags, or HTTP fields;
|
||||||
|
- durable run state, conversations, retries, archives, checkpoints, or resume;
|
||||||
|
or
|
||||||
|
- changes to Promptkit itself.
|
||||||
77
docs/roadmap/remediation.md
Normal file
77
docs/roadmap/remediation.md
Normal file
@@ -0,0 +1,77 @@
|
|||||||
|
# Promptkit Upgrade Review Remediation
|
||||||
|
|
||||||
|
## Scope And Status
|
||||||
|
|
||||||
|
Review baseline: `e177d7c`, covering implementation commits after `5c3b0cf`.
|
||||||
|
This document records a resolved test-contract issue; it does not authorize
|
||||||
|
unrelated implementation changes. No runtime defect or missing planned feature
|
||||||
|
was identified in this review. Release preparation remains separate work.
|
||||||
|
|
||||||
|
## R1: Remove The Unrequested Context-Identity Invariant
|
||||||
|
|
||||||
|
Priority: P3 (low). Status: Complete.
|
||||||
|
|
||||||
|
Original location: `internal/adapter/http/handler_test.go:334–349`,
|
||||||
|
`TestHandlerRunTimeoutValidationAndContextMapping`, introduced in `7de2b02`.
|
||||||
|
|
||||||
|
The test's `child` field and `(ctx != parent) != tc.child` assertion required
|
||||||
|
the exact parent context object for omitted/null/zero timeouts and a distinct
|
||||||
|
object for a positive timeout. The requested contract concerns effective
|
||||||
|
deadlines and cancellation propagation, not Go interface identity. In
|
||||||
|
particular, a harmless derived context that preserves the parent's deadline,
|
||||||
|
values, and cancellation would fail the omission cases despite satisfying the
|
||||||
|
application contract.
|
||||||
|
|
||||||
|
This elevated an incidental implementation choice into a test-enforced
|
||||||
|
invariant, contrary to the [agent policy](../policy/agents.md) and
|
||||||
|
[testing policy](../policy/testing.md). The current handler's context behavior
|
||||||
|
is correct; this is a maintainability issue, not a runtime cancellation bug.
|
||||||
|
|
||||||
|
### Required Change
|
||||||
|
|
||||||
|
Remove the identity comparison and the identity-only table field. Retain
|
||||||
|
behavioral assertions that an earlier parent deadline is not extended and
|
||||||
|
parent cancellation reaches execution. For omitted/null/zero values, verify
|
||||||
|
that no deadline is introduced when the parent has none. Retain coverage of
|
||||||
|
positive deadlines and the distinction between a canceled execution context
|
||||||
|
and a provider-attempt timeout while the execution context remains live.
|
||||||
|
|
||||||
|
Use the existing runner seam and focused cases; do not introduce a context
|
||||||
|
wrapper framework, timer abstraction, new public guarantee, or production
|
||||||
|
refactor solely to change this test.
|
||||||
|
|
||||||
|
### Completion Criteria
|
||||||
|
|
||||||
|
- Tests protect effective deadline/cancellation behavior without requiring
|
||||||
|
context object identity.
|
||||||
|
- A semantically equivalent derived context does not fail merely because it
|
||||||
|
is a different object.
|
||||||
|
- Existing timeout validation and HTTP outcome coverage remains intact.
|
||||||
|
|
||||||
|
### Resolution And Validation
|
||||||
|
|
||||||
|
Removed the identity-only table field and context comparisons. The test now
|
||||||
|
checks effective deadlines, including omitted/null/zero requests with no
|
||||||
|
parent deadline, and explicitly checks that parent cancellation reaches the
|
||||||
|
runner. Existing positive-deadline integration tests and live-context
|
||||||
|
provider-timeout mapping remain intact. No production code changed.
|
||||||
|
|
||||||
|
Focused HTTP timeout tests, `go test ./...`, `go test -race ./...`,
|
||||||
|
`go vet ./...`, a native build outside the repository, and `git diff --check`
|
||||||
|
all passed after remediation.
|
||||||
|
|
||||||
|
## Original Review Verification
|
||||||
|
|
||||||
|
- `go test -race -count=1 ./...` passed, including retry, shared-capacity,
|
||||||
|
deadline, report, definition-conformance, and architecture-boundary tests.
|
||||||
|
- `go vet ./...` passed.
|
||||||
|
- A native `cmd/scriptorium` build passed, with output outside the repository.
|
||||||
|
- The selected dependency is Promptkit v0.11.0 with its intended v2 catalogs.
|
||||||
|
- Application code, tests, release automation, and historical releases were
|
||||||
|
not changed during this review.
|
||||||
|
|
||||||
|
The runtime ownership boundaries remain as intended: Promptkit owns framework
|
||||||
|
formats, execution, retries, and backend admission; Scriptorium owns executable
|
||||||
|
adapters, application settings, HTTP artifact policy, deadlines, and terminal
|
||||||
|
report presentation. No additional runtime restrictions, durable workflow
|
||||||
|
state, or extra release compliance gates were identified in the reviewed diff.
|
||||||
273
docs/roadmap/upgrade-kit.md
Normal file
273
docs/roadmap/upgrade-kit.md
Normal file
@@ -0,0 +1,273 @@
|
|||||||
|
# Promptkit v0.11 Adoption
|
||||||
|
|
||||||
|
## Status And Intent
|
||||||
|
|
||||||
|
Accepted feature direction, recorded on 2026-09-26. Implementation is complete
|
||||||
|
to the pre-release boundary; version selection, release-candidate validation,
|
||||||
|
and publication remain separate release preparation. The baseline descriptions
|
||||||
|
below record the state when this roadmap was written, not current behavior.
|
||||||
|
Upgrade directly from Promptkit v0.9.0 to v0.11.0, including the intervening
|
||||||
|
v0.10.0 catalog transition. This document defines the desired end state and
|
||||||
|
the changes from the current baseline. The [implementation plan](implementation.md)
|
||||||
|
owns sequencing, concrete interface choices, verification steps, and unresolved
|
||||||
|
implementation decisions.
|
||||||
|
|
||||||
|
The target is complete definition compatibility, controllable transient
|
||||||
|
retries, an optional whole-run deadline, and modest opt-in execution diagnostics.
|
||||||
|
This is a focused adapter and configuration update, not another architecture
|
||||||
|
migration. Optional diagnostics are included in the desired feature set.
|
||||||
|
“Optional” means callers opt in, not that diagnostics may be silently omitted
|
||||||
|
from the completed adoption or appear in default output.
|
||||||
|
|
||||||
|
[ADR 0004](../adr/0004-definition-boundary.md) and the
|
||||||
|
[architecture policy](../policy/architecture.md) govern scope. Promptkit remains
|
||||||
|
the parser, validator, execution engine, and owner of framework defaults.
|
||||||
|
Scriptorium remains a simple executable application for independent prompt
|
||||||
|
executions, with shared operational state where required for backend limits.
|
||||||
|
|
||||||
|
## Baseline And Upstream Changes
|
||||||
|
|
||||||
|
Scriptorium currently selects Promptkit v0.9.0 and the v1.0.0 backend catalog
|
||||||
|
modules. It already supports CLI execution, rendering, prompt/profile
|
||||||
|
inspection, HTTP execution, configured backends, and presence-aware execution
|
||||||
|
overrides. It does not expose transient retry settings, a whole-run deadline,
|
||||||
|
or execution observers. CLI execution currently supplies a background context.
|
||||||
|
|
||||||
|
The upstream review covered the local tagged release v0.11.0 at commit
|
||||||
|
`db05b56166ca2d8650dfaf660e1cf0eed3932e1d`. Its canonical references are:
|
||||||
|
|
||||||
|
- [v0.10.0 migration guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.10.0/docs/releases/v0.10.0.md);
|
||||||
|
- [v0.11.0 release notes](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/docs/releases/v0.11.0.md);
|
||||||
|
- [definition formats](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/docs/formats.md);
|
||||||
|
- [execution and retry integration contract](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/docs/integrations/openai-compatible-chat.md);
|
||||||
|
- [consumer guide](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/docs/consumers/pkg-promptkit.md); and
|
||||||
|
- [observation declarations](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/observations.go).
|
||||||
|
|
||||||
|
A diagnostic run using a temporary module file compiled Scriptorium against
|
||||||
|
v0.11.0. The existing test suite reported one failing profile-inspection case
|
||||||
|
that selects the removed `deepseek-4-flash` profile; other packages passed.
|
||||||
|
This establishes an initial migration issue, not proof of complete behavioral
|
||||||
|
compatibility or coverage of the new capabilities. The diagnostic did not
|
||||||
|
change the repository dependency pin.
|
||||||
|
|
||||||
|
Neither intervening release adds declarative prompt/profile fields requiring
|
||||||
|
new adapter plumbing. The definition-facing changes concern catalog contents
|
||||||
|
and resolution precedence. Retry and observer APIs are execution controls;
|
||||||
|
their adoption is a deliberate case-by-case choice under ADR 0004.
|
||||||
|
|
||||||
|
## Dependency And Definition Compatibility
|
||||||
|
|
||||||
|
### Target End State
|
||||||
|
|
||||||
|
Scriptorium uses tagged Promptkit v0.11.0 through its supported root package,
|
||||||
|
with the catalog versions selected by that release:
|
||||||
|
|
||||||
|
- `promptkit-backend-openrouter/v2` v2.20260922.1;
|
||||||
|
- `promptkit-backend-rakestrawhome/v2` v2.20260922.0.
|
||||||
|
|
||||||
|
Valid definitions for the selected Promptkit version remain usable through
|
||||||
|
Scriptorium's existing sources and adapters, subject to its established HTTP
|
||||||
|
artifact and deployment boundaries. Rendering and inspection remain offline
|
||||||
|
operations that do not generate model output.
|
||||||
|
|
||||||
|
The maintained names `promptkit-openrouter-standard` and
|
||||||
|
`promptkit-openrouter-auto` work wherever a profile ID is accepted, including
|
||||||
|
prompt defaults, explicit selection, inheritance, and profile inspection.
|
||||||
|
They are opt-in choices, not new Scriptorium defaults. Ordinary custom-source
|
||||||
|
precedence remains intact.
|
||||||
|
|
||||||
|
A stable maintained name is not a frozen model/settings selection. External
|
||||||
|
catalog entries can change or disappear across upgrades; inheriting from one
|
||||||
|
does not create a frozen copy. Complete application-owned profiles remain the
|
||||||
|
appropriate choice when an application owns its model and settings.
|
||||||
|
|
||||||
|
### Change From Baseline
|
||||||
|
|
||||||
|
The module graph and active definition fixtures reflect the released v0.11
|
||||||
|
catalogs rather than v0.9's catalogs. The selected catalog removes
|
||||||
|
`deepseek-3-2`, `deepseek-4-flash`, and `deepseek-4-pro`; newer DeepSeek names
|
||||||
|
are not compatibility aliases. Migration guidance offers an available catalog
|
||||||
|
profile, a maintained Promptkit name, or a complete application-owned definition.
|
||||||
|
Application-owned examples retain fixed settings where that is their purpose.
|
||||||
|
|
||||||
|
Definition conformance and focused resolution coverage protect Scriptorium's
|
||||||
|
adapter boundary without duplicating the upstream parser or catalog. Existing
|
||||||
|
dependency boundaries also apply to the new `/v2` module paths.
|
||||||
|
|
||||||
|
## Controllable Transient Retries
|
||||||
|
|
||||||
|
### Target End State
|
||||||
|
|
||||||
|
Expose `transient_retries` in application configuration, with a CLI execution
|
||||||
|
override and an HTTP request override. Preserve value presence throughout:
|
||||||
|
|
||||||
|
| Value | Meaning |
|
||||||
|
| --- | --- |
|
||||||
|
| Omitted | Inherit the engine setting, ultimately Promptkit's default. |
|
||||||
|
| Zero | Disable additional transient attempts. |
|
||||||
|
| Positive integer | Permit that many additional transient attempts. |
|
||||||
|
| Negative integer | Invalid configuration or request. |
|
||||||
|
|
||||||
|
Adopt Promptkit's default of two additional attempts rather than silently
|
||||||
|
pinning the previous single-attempt behavior. Users must be able to select zero
|
||||||
|
explicitly. Request overrides take precedence over application configuration;
|
||||||
|
omission must not accidentally become an explicit zero.
|
||||||
|
|
||||||
|
Promptkit alone owns eligible statuses, attempt execution, backoff,
|
||||||
|
`Retry-After`, and capacity coordination. Scriptorium adds no outer model retry
|
||||||
|
loop. Transient retries and structural repairs have distinct budgets: each
|
||||||
|
generation, including each repair generation, receives its transient budget.
|
||||||
|
Retries do not imply exactly-once generation or complete billing knowledge.
|
||||||
|
|
||||||
|
### Change From Baseline
|
||||||
|
|
||||||
|
Application settings reach `promptkit.Config.TransientRetries`, including the
|
||||||
|
shared server engine, and request overrides reach
|
||||||
|
`promptkit.RunRequest.TransientRetries`. This adds execution controls, not
|
||||||
|
prompt/profile schema fields or provider model parameters. Strict decoding and
|
||||||
|
presence-aware mapping preserve inheritance and explicit zero. User and
|
||||||
|
operations guidance makes the changed default, latency/cost implications, and
|
||||||
|
independent repair budget visible. Cancellation and shared backend limits
|
||||||
|
remain effective during retrying executions.
|
||||||
|
|
||||||
|
## Optional Whole-Run Deadline
|
||||||
|
|
||||||
|
### Target End State
|
||||||
|
|
||||||
|
Callers can opt into a total execution deadline independently of the existing
|
||||||
|
generation timeout. No new default deadline is imposed. Existing timeout
|
||||||
|
controls must not silently change meaning: in v0.11.0 they apply per generation
|
||||||
|
attempt, whereas a whole-run deadline bounds the overall operation, including
|
||||||
|
preparation, capacity waiting, retry delays, attempts, and repairs as supported
|
||||||
|
by the upstream context contract.
|
||||||
|
|
||||||
|
Expose this choice through CLI execution and HTTP execution. Derive any timeout
|
||||||
|
context from the caller's existing context, so a caller cancellation or earlier
|
||||||
|
deadline still wins. This is a cancellation boundary, not a guarantee of
|
||||||
|
instantaneous interruption of arbitrary callback or filesystem code.
|
||||||
|
|
||||||
|
### Change From Baseline
|
||||||
|
|
||||||
|
CLI execution can carry a selected deadline instead of always using an
|
||||||
|
unbounded background context. HTTP execution can shorten the incoming context
|
||||||
|
without losing parent cancellation or changing server lifecycle behavior.
|
||||||
|
Total-run duration handling is separate from existing attempt-timeout conversion.
|
||||||
|
The interval covers the engine invocation, not adapter parsing, engine creation,
|
||||||
|
or output writing. Provider retry timing can exceed local backoff limits;
|
||||||
|
per-attempt timeouts do not cap that complete invocation.
|
||||||
|
|
||||||
|
## Opt-In Execution Reports
|
||||||
|
|
||||||
|
### Target End State
|
||||||
|
|
||||||
|
Provide a modest terminal execution report for CLI and HTTP callers who opt
|
||||||
|
in. Capture selected metadata through `RunRequest.Observer`, including attempt,
|
||||||
|
retry, repair, timing, outcome, and presence-aware usage information. Reports
|
||||||
|
should be available for completed successful and failed execution invocations
|
||||||
|
when Promptkit supplies terminal observations. Do not invent execution data for
|
||||||
|
failures that occur before invocation.
|
||||||
|
|
||||||
|
Keep generated CLI content on stdout or the existing output path. Execution
|
||||||
|
reports use a separate destination. Ordinary CLI output and HTTP response
|
||||||
|
shapes remain unchanged when reporting is not requested.
|
||||||
|
|
||||||
|
The report has a Scriptorium-owned schema rather than serializing upstream
|
||||||
|
events directly: `ExecutionEvent` has no stable JSON contract. Preserve unknown
|
||||||
|
usage versus reported zero, and incomplete versus complete observed totals.
|
||||||
|
Existing successful-result usage semantics remain unchanged. A terminal total
|
||||||
|
is an aggregate, not another attempt to add to the bill; no report is a billing
|
||||||
|
ledger.
|
||||||
|
|
||||||
|
### Change From Baseline
|
||||||
|
|
||||||
|
Both adapters have opt-in reporting and explicit application-owned report DTOs.
|
||||||
|
Per-request collection adds no shared mutable report state, durable storage,
|
||||||
|
callback I/O, or event archive. Operational failures can carry reports without
|
||||||
|
manufacturing partial `RunResult` values. Default output remains unchanged.
|
||||||
|
|
||||||
|
Reports exclude prompt and response bodies, credentials, headers, endpoint URLs,
|
||||||
|
provider diagnostic text, and raw errors. Selected identifiers remain potentially
|
||||||
|
sensitive even when observations are content-free. Reports are concise terminal
|
||||||
|
metadata, not a general telemetry framework, event stream, or durable history.
|
||||||
|
|
||||||
|
## Errors And Compatibility
|
||||||
|
|
||||||
|
Preserve existing CLI exit classifications and HTTP `502 / llm_failed`
|
||||||
|
classification for generation failures. Keep safe public messages rather than
|
||||||
|
exposing provider error bodies or parsing diagnostic strings.
|
||||||
|
|
||||||
|
Promptkit adds `ErrTransport`, `ErrMalformedResponse`, `ErrRetriesExhausted`, and
|
||||||
|
`RetryExhaustedError`. Use their public identities to support optional structured
|
||||||
|
failure details in execution diagnostics, including actual attempts where
|
||||||
|
available. Retry exhaustion and the final cause are distinct facts; do not lose
|
||||||
|
the underlying failure category by flattening them into one label.
|
||||||
|
|
||||||
|
Capacity and validation behavior remains intact. Whole-run deadline and caller
|
||||||
|
cancellation outcomes are deliberate adapter classifications, distinct from a
|
||||||
|
provider-attempt timeout while the caller context is still live. The implementation
|
||||||
|
plan owns the exact presentation choices. Existing generation-error codes do
|
||||||
|
not need a breaking replacement for this upgrade.
|
||||||
|
|
||||||
|
## Licensing And Distribution Review
|
||||||
|
|
||||||
|
Promptkit v0.11.0 changes from GPLv3 to LGPL-3.0-or-later. Scriptorium's current
|
||||||
|
binary workflow produces statically linked Go executables, and upstream's
|
||||||
|
[license summary](https://gitea.maximumdirect.net/eric/promptkit/src/tag/v0.11.0/README.md#license)
|
||||||
|
explicitly calls out distribution considerations for that model. Catalog and
|
||||||
|
other dependency licenses remain separate.
|
||||||
|
|
||||||
|
Before distributing the upgraded binaries, resolve the applicable notices,
|
||||||
|
license texts, source availability, and any required materials or permissions
|
||||||
|
for recombination with a modified library. Record the chosen distribution
|
||||||
|
approach and make any corresponding packaging/documentation changes. This
|
||||||
|
roadmap is not a legal determination or a complete compliance checklist.
|
||||||
|
|
||||||
|
Do not automatically relicense Scriptorium, assume that library source alone
|
||||||
|
settles every distribution requirement, or alter historical release contents.
|
||||||
|
Licensing review is a concrete adoption prerequisite, not a new blanket manual
|
||||||
|
approval gate for every future release.
|
||||||
|
|
||||||
|
## Documentation And Delivery
|
||||||
|
|
||||||
|
Current documentation links to the selected v0.11.0 contracts once implemented.
|
||||||
|
CLI, HTTP, configuration, and operations documents own their respective new
|
||||||
|
behavior; internal docs explain adapter mapping; release notes summarize
|
||||||
|
compatibility impact. Historical release notes and ADR decision content remain
|
||||||
|
unchanged. Current examples and migration guidance reflect the selected version.
|
||||||
|
|
||||||
|
The upgrade merits a minor Scriptorium release, not a compatibility patch,
|
||||||
|
with prominent migration guidance for removed profiles, changed retry behavior,
|
||||||
|
the explicit single-attempt option, and timeout layering. Any later decision to
|
||||||
|
defer part of the target leaves that feature visibly incomplete until delivered.
|
||||||
|
|
||||||
|
Use the existing [release policy](../policy/release.md) and
|
||||||
|
[runbook](../release.md). This roadmap authorizes no publication. No new ADR is
|
||||||
|
needed unless a later decision changes the established product or compatibility
|
||||||
|
boundaries.
|
||||||
|
|
||||||
|
## Completion Criteria
|
||||||
|
|
||||||
|
- The tagged dependency and selected catalog modules are adopted without
|
||||||
|
unsupported imports or local dependency substitutions.
|
||||||
|
- Existing definition conformance tests and focused maintained-profile tests
|
||||||
|
pass; removed profile IDs have explicit migration guidance, not silent aliases.
|
||||||
|
- Retry settings preserve omission and zero across configuration, CLI, and HTTP;
|
||||||
|
Promptkit remains the sole retry/capacity implementation.
|
||||||
|
- Optional total deadlines bound the caller operation without redefining
|
||||||
|
per-attempt timeouts or disabling parent cancellation.
|
||||||
|
- Opt-in terminal reports provide safe, isolated, presence-aware execution
|
||||||
|
metadata without changing default output or creating durable workflow state.
|
||||||
|
Any deferred reporting work remains visibly incomplete.
|
||||||
|
- Existing error classifications remain compatible, with deliberate handling
|
||||||
|
of the new public identities and context outcomes.
|
||||||
|
- The licensing/distribution approach is resolved before upgraded binary
|
||||||
|
distribution, and any required materials are included in the chosen workflow.
|
||||||
|
- Affected current contracts, examples, and migration guidance match
|
||||||
|
implemented behavior. Relevant tests remain offline and credential-free,
|
||||||
|
and normal development validation passes. Release-candidate validation and
|
||||||
|
the version-matched note remain release preparation.
|
||||||
|
|
||||||
|
Concrete interface decisions and the selected distribution approach are recorded
|
||||||
|
in the completed [implementation plan](implementation.md). They do not expand
|
||||||
|
the product into conversations, follow-up messages, application-owned semantic
|
||||||
|
retry loops, prepared-handle coordination, or multi-step workflows.
|
||||||
@@ -1,361 +0,0 @@
|
|||||||
# Troubleshooting
|
|
||||||
|
|
||||||
This guide lists common implemented failure modes and safe fixes.
|
|
||||||
|
|
||||||
Canonical references:
|
|
||||||
|
|
||||||
- [CLI reference](cli.md)
|
|
||||||
- [Configuration reference](config.md)
|
|
||||||
- [HTTP API reference](api.md)
|
|
||||||
- [Operations guide](operations.md)
|
|
||||||
|
|
||||||
## Missing Or Invalid Config
|
|
||||||
|
|
||||||
Symptom:
|
|
||||||
|
|
||||||
- CLI error includes `application config error`, `config file not found`, `invalid config YAML`, or `invalid config`.
|
|
||||||
|
|
||||||
Likely cause:
|
|
||||||
|
|
||||||
- `--config` points to a missing file.
|
|
||||||
- YAML syntax is invalid.
|
|
||||||
- Config contains unknown fields or negative HTTP size limits.
|
|
||||||
|
|
||||||
Diagnostic step:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
go run ./cmd/scriptorium render --config /path/to/config.yml --prompt generic.markdown_summary --input transcript=./examples/fixtures/transcript.md --input glossary=./examples/fixtures/glossary.yml
|
|
||||||
```
|
|
||||||
|
|
||||||
Safe fix:
|
|
||||||
|
|
||||||
- Correct the config path.
|
|
||||||
- Fix YAML syntax.
|
|
||||||
- Remove unknown fields.
|
|
||||||
- Keep raw secrets out of config.
|
|
||||||
|
|
||||||
Relevant links: [Configuration reference](config.md), [CLI reference](cli.md)
|
|
||||||
|
|
||||||
## Missing Prompt Directory
|
|
||||||
|
|
||||||
Symptom:
|
|
||||||
|
|
||||||
- CLI parse error says the prompt directory is required.
|
|
||||||
|
|
||||||
Likely cause:
|
|
||||||
|
|
||||||
- Neither config nor CLI flags provide an effective `prompt_dir`.
|
|
||||||
|
|
||||||
Diagnostic step:
|
|
||||||
|
|
||||||
- Re-run once with explicit `--prompt-dir`.
|
|
||||||
|
|
||||||
Safe fix:
|
|
||||||
|
|
||||||
- Set `prompt_dir` in config or pass `--prompt-dir`.
|
|
||||||
|
|
||||||
Relevant links: [Configuration reference](config.md), [CLI reference](cli.md)
|
|
||||||
|
|
||||||
## Unknown Flags
|
|
||||||
|
|
||||||
Symptom:
|
|
||||||
|
|
||||||
- CLI parse error for an unknown flag.
|
|
||||||
|
|
||||||
Likely cause:
|
|
||||||
|
|
||||||
- Typo.
|
|
||||||
- Flag is valid for another command.
|
|
||||||
- `serve` was given runtime model override flags.
|
|
||||||
|
|
||||||
Diagnostic step:
|
|
||||||
|
|
||||||
- Compare the command with the command-specific flag list.
|
|
||||||
|
|
||||||
Safe fix:
|
|
||||||
|
|
||||||
- Remove unsupported flags.
|
|
||||||
- Use `run` or `render` for runtime model overrides.
|
|
||||||
|
|
||||||
Relevant links: [CLI reference](cli.md)
|
|
||||||
|
|
||||||
## Prompt Load Failures
|
|
||||||
|
|
||||||
Symptom:
|
|
||||||
|
|
||||||
- CLI run/render fails during prompt loading.
|
|
||||||
- HTTP returns `404 prompt_not_found` or `400 prompt_load_failed`.
|
|
||||||
|
|
||||||
Likely cause:
|
|
||||||
|
|
||||||
- Prompt ID/version does not exist.
|
|
||||||
- Prompt YAML is invalid or has unknown fields.
|
|
||||||
- Prompt contract is invalid, such as missing messages, invalid output mode, bad `content_file`, or missing `schema_path` for `json_schema`.
|
|
||||||
|
|
||||||
Diagnostic step:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
go run ./cmd/scriptorium render --config ./examples/config.yml --prompt <prompt-id> --input transcript=./examples/fixtures/transcript.md --input glossary=./examples/fixtures/glossary.yml --format json
|
|
||||||
```
|
|
||||||
|
|
||||||
Safe fix:
|
|
||||||
|
|
||||||
- Correct prompt ID/version.
|
|
||||||
- Fix prompt YAML and referenced `content_file` paths.
|
|
||||||
- Fix output contract fields.
|
|
||||||
|
|
||||||
Relevant links: [Configuration reference](config.md), [CLI reference](cli.md)
|
|
||||||
|
|
||||||
## Profile Load Failures
|
|
||||||
|
|
||||||
Symptom:
|
|
||||||
|
|
||||||
- CLI run/render fails during profile loading.
|
|
||||||
- HTTP returns `404 profile_not_found`, `400 profile_load_failed`, or `400 profile_required`.
|
|
||||||
|
|
||||||
Likely cause:
|
|
||||||
|
|
||||||
- Profile ID does not exist.
|
|
||||||
- Request omitted profile and prompt has no `default_profile`.
|
|
||||||
- Profile YAML is invalid or has unknown fields.
|
|
||||||
- Profile contains raw `api_key`.
|
|
||||||
|
|
||||||
Diagnostic step:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
go run ./cmd/scriptorium render --config ./examples/config.yml --prompt generic.markdown_summary --profile <profile-id> --input transcript=./examples/fixtures/transcript.md --input glossary=./examples/fixtures/glossary.yml
|
|
||||||
```
|
|
||||||
|
|
||||||
Safe fix:
|
|
||||||
|
|
||||||
- Correct profile ID or prompt `default_profile`.
|
|
||||||
- Fix profile YAML and value ranges.
|
|
||||||
- Replace raw `api_key` with `api_key_env`.
|
|
||||||
|
|
||||||
Relevant links: [Configuration reference](config.md), [CLI reference](cli.md)
|
|
||||||
|
|
||||||
## Input Artifact Failures
|
|
||||||
|
|
||||||
Symptom:
|
|
||||||
|
|
||||||
- CLI run/render fails while reading inputs.
|
|
||||||
- HTTP returns `400 artifact_read_failed`, `400 artifact_not_allowed`, or `413 artifact_too_large`.
|
|
||||||
|
|
||||||
Likely cause:
|
|
||||||
|
|
||||||
- Input file path is missing or unreadable.
|
|
||||||
- HTTP input type is unsupported or missing required fields.
|
|
||||||
- HTTP file refs are disabled because no artifact root is configured.
|
|
||||||
- HTTP file path is lexically outside the artifact root.
|
|
||||||
- HTTP file input exceeds `server.max_artifact_bytes`.
|
|
||||||
|
|
||||||
Diagnostic step:
|
|
||||||
|
|
||||||
- Verify each input path exists and is readable by the process.
|
|
||||||
- For HTTP, verify input refs use `file` or `inline`.
|
|
||||||
- For HTTP file refs, verify the artifact root and compare file size to `server.max_artifact_bytes`.
|
|
||||||
|
|
||||||
Safe fix:
|
|
||||||
|
|
||||||
- Correct paths and permissions.
|
|
||||||
- Configure a narrow artifact root for HTTP file refs.
|
|
||||||
- Use relative paths under the artifact root or switch to `inline`.
|
|
||||||
- Increase `server.max_artifact_bytes` only for expected larger inputs.
|
|
||||||
|
|
||||||
Relevant links: [HTTP API reference](api.md), [Configuration reference](config.md)
|
|
||||||
|
|
||||||
## Missing API-Key Environment Variable
|
|
||||||
|
|
||||||
Symptom:
|
|
||||||
|
|
||||||
- CLI render/run fails with an API-key environment error.
|
|
||||||
- HTTP returns `400 api_key_env_missing`.
|
|
||||||
|
|
||||||
Likely cause:
|
|
||||||
|
|
||||||
- Selected profile or runtime override sets `api_key_env`, but the environment variable is unset or empty.
|
|
||||||
|
|
||||||
Diagnostic step:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
printenv SCRIPTORIUM_API_KEY
|
|
||||||
```
|
|
||||||
|
|
||||||
Safe fix:
|
|
||||||
|
|
||||||
- Set the required environment variable before starting the CLI command or HTTP service.
|
|
||||||
- Or use a profile that does not require provider API-key auth.
|
|
||||||
|
|
||||||
Relevant links: [Configuration reference](config.md), [Operations guide](operations.md)
|
|
||||||
|
|
||||||
## Prompt Template Render Failures
|
|
||||||
|
|
||||||
Symptom:
|
|
||||||
|
|
||||||
- CLI render/run fails during prompt rendering.
|
|
||||||
- HTTP returns `400 prompt_render_failed`.
|
|
||||||
|
|
||||||
Likely cause:
|
|
||||||
|
|
||||||
- Template references an input that was not supplied.
|
|
||||||
- Template syntax or variable reference is invalid.
|
|
||||||
|
|
||||||
Diagnostic step:
|
|
||||||
|
|
||||||
- Run `render --format json` with the same prompt, inputs, vars, and profile.
|
|
||||||
|
|
||||||
Safe fix:
|
|
||||||
|
|
||||||
- Align `{{input "name"}}` references with request input names.
|
|
||||||
- Fix template syntax and variable names.
|
|
||||||
|
|
||||||
Relevant links: [Configuration reference](config.md), [CLI reference](cli.md)
|
|
||||||
|
|
||||||
## LLM Request Failures
|
|
||||||
|
|
||||||
Symptom:
|
|
||||||
|
|
||||||
- CLI `run` fails during generation.
|
|
||||||
- HTTP returns `502 llm_failed`.
|
|
||||||
|
|
||||||
Likely cause:
|
|
||||||
|
|
||||||
- Endpoint is unreachable.
|
|
||||||
- Provider returns non-2xx.
|
|
||||||
- Request times out.
|
|
||||||
- Provider response is malformed.
|
|
||||||
|
|
||||||
Diagnostic step:
|
|
||||||
|
|
||||||
- Run `render` first to confirm pre-LLM preparation works.
|
|
||||||
- Check selected endpoint/model in prepared output.
|
|
||||||
- Check network/provider logs for timeout or non-2xx details.
|
|
||||||
|
|
||||||
Safe fix:
|
|
||||||
|
|
||||||
- Correct endpoint/model/profile settings.
|
|
||||||
- Adjust timeout when appropriate.
|
|
||||||
- Resolve provider or network issue.
|
|
||||||
|
|
||||||
Relevant links: [Operations guide](operations.md), [Configuration reference](config.md)
|
|
||||||
|
|
||||||
## Validation Failed
|
|
||||||
|
|
||||||
Symptom:
|
|
||||||
|
|
||||||
- CLI `run` exits `2`.
|
|
||||||
- HTTP returns `200 OK` with `validation.status` set to `failed`.
|
|
||||||
|
|
||||||
Likely cause:
|
|
||||||
|
|
||||||
- Generated output failed `basic`, `json`, or `json_schema` content validation.
|
|
||||||
|
|
||||||
Diagnostic step:
|
|
||||||
|
|
||||||
- Inspect validation errors in CLI stderr or the HTTP response.
|
|
||||||
|
|
||||||
Safe fix:
|
|
||||||
|
|
||||||
- Refine prompt instructions.
|
|
||||||
- Adjust schema or model/profile settings.
|
|
||||||
- Rerun after correction.
|
|
||||||
|
|
||||||
Relevant links: [Operations guide](operations.md), [HTTP API reference](api.md)
|
|
||||||
|
|
||||||
## Validation Runtime Failure
|
|
||||||
|
|
||||||
Symptom:
|
|
||||||
|
|
||||||
- CLI `run` fails with validation runtime error.
|
|
||||||
- HTTP returns `500 validation_runtime_failed`.
|
|
||||||
|
|
||||||
Likely cause:
|
|
||||||
|
|
||||||
- `json_schema` schema file is missing or unreadable.
|
|
||||||
- Schema JSON is invalid.
|
|
||||||
|
|
||||||
Diagnostic step:
|
|
||||||
|
|
||||||
- Verify `schema_dir` and prompt `output.schema_path`.
|
|
||||||
- Check schema file readability and JSON syntax.
|
|
||||||
|
|
||||||
Safe fix:
|
|
||||||
|
|
||||||
- Correct schema path or permissions.
|
|
||||||
- Fix schema JSON.
|
|
||||||
- Rerun.
|
|
||||||
|
|
||||||
Relevant links: [Configuration reference](config.md), [Operations guide](operations.md)
|
|
||||||
|
|
||||||
## HTTP JSON Or Request Contract Errors
|
|
||||||
|
|
||||||
Symptom:
|
|
||||||
|
|
||||||
- HTTP returns `400 invalid_json` or `400 invalid_request`.
|
|
||||||
|
|
||||||
Likely cause:
|
|
||||||
|
|
||||||
- JSON body is malformed.
|
|
||||||
- Request has unknown fields or trailing JSON tokens.
|
|
||||||
- Required `prompt_id` or `inputs` is missing.
|
|
||||||
- Runtime override values are out of range.
|
|
||||||
- `extra_params` collides with reserved outbound fields.
|
|
||||||
|
|
||||||
Diagnostic step:
|
|
||||||
|
|
||||||
- Revalidate request JSON and compare fields with the API reference.
|
|
||||||
|
|
||||||
Safe fix:
|
|
||||||
|
|
||||||
- Send one JSON object with only supported fields.
|
|
||||||
- Include `prompt_id` and at least one input.
|
|
||||||
- Use valid model override ranges.
|
|
||||||
- Remove reserved `extra_params` keys.
|
|
||||||
|
|
||||||
Relevant links: [HTTP API reference](api.md)
|
|
||||||
|
|
||||||
## HTTP Size Limit Errors
|
|
||||||
|
|
||||||
Symptom:
|
|
||||||
|
|
||||||
- HTTP returns `413 request_too_large`, `413 artifact_too_large`, or `413 response_too_large`.
|
|
||||||
|
|
||||||
Likely cause:
|
|
||||||
|
|
||||||
- JSON request body exceeds `server.max_request_bytes`.
|
|
||||||
- HTTP file input exceeds `server.max_artifact_bytes`.
|
|
||||||
- Encoded JSON response exceeds `server.max_response_bytes`.
|
|
||||||
|
|
||||||
Diagnostic step:
|
|
||||||
|
|
||||||
- Compare request, file input, and expected response sizes with configured limits.
|
|
||||||
|
|
||||||
Safe fix:
|
|
||||||
|
|
||||||
- Use smaller inline inputs or switch to file inputs under the artifact root.
|
|
||||||
- Reduce generated output size.
|
|
||||||
- Omit `include_raw_output`.
|
|
||||||
- Increase limits only when the deployment expects larger payloads.
|
|
||||||
|
|
||||||
Relevant links: [HTTP API reference](api.md), [Operations guide](operations.md)
|
|
||||||
|
|
||||||
## HTTP Route Or Method Errors
|
|
||||||
|
|
||||||
Symptom:
|
|
||||||
|
|
||||||
- HTTP returns `404 not_found` or `405 method_not_allowed`.
|
|
||||||
|
|
||||||
Likely cause:
|
|
||||||
|
|
||||||
- Path is not `/v1/runs`.
|
|
||||||
- Method on `/v1/runs` is not `POST`.
|
|
||||||
|
|
||||||
Diagnostic step:
|
|
||||||
|
|
||||||
- Check the request URL and method.
|
|
||||||
|
|
||||||
Safe fix:
|
|
||||||
|
|
||||||
- Send `POST /v1/runs`.
|
|
||||||
|
|
||||||
Relevant links: [HTTP API reference](api.md)
|
|
||||||
318
engine.go
318
engine.go
@@ -1,318 +0,0 @@
|
|||||||
package scriptorium
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io/fs"
|
|
||||||
"net/http"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"strings"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
artifactadapter "gitea.maximumdirect.net/eric/scriptorium/internal/artifact"
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/defaults"
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/llm"
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/profile"
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/profile/builtin"
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/prompt"
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/promptdef"
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/usecase"
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/validate"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ErrInvalidConfig indicates invalid public engine configuration.
|
|
||||||
var ErrInvalidConfig = errors.New("invalid engine configuration")
|
|
||||||
|
|
||||||
var (
|
|
||||||
ErrInvalidRequest = errors.New("invalid run request")
|
|
||||||
ErrPromptNotFound = errors.New("prompt not found")
|
|
||||||
ErrProfileNotFound = errors.New("profile not found")
|
|
||||||
ErrPromptLoad = errors.New("failed to load prompt definition")
|
|
||||||
ErrProfileLoad = errors.New("failed to load execution profile")
|
|
||||||
ErrArtifactLoad = errors.New("failed to load artifact")
|
|
||||||
ErrPromptRender = errors.New("failed to render prompt")
|
|
||||||
ErrLLMGenerate = errors.New("failed to generate output")
|
|
||||||
ErrValidation = errors.New("failed to validate output")
|
|
||||||
)
|
|
||||||
|
|
||||||
// Engine prepares and runs Scriptorium prompt requests.
|
|
||||||
type Engine struct {
|
|
||||||
runner *usecase.Runner
|
|
||||||
}
|
|
||||||
|
|
||||||
// Config configures a public Scriptorium engine.
|
|
||||||
type Config struct {
|
|
||||||
PromptDir string
|
|
||||||
ProfileDir string
|
|
||||||
SchemaDir string
|
|
||||||
Timeout time.Duration
|
|
||||||
HTTPClient *http.Client
|
|
||||||
}
|
|
||||||
|
|
||||||
// Option customizes engine construction.
|
|
||||||
type Option interface {
|
|
||||||
apply(*engineOptions) error
|
|
||||||
}
|
|
||||||
|
|
||||||
type optionFunc func(*engineOptions) error
|
|
||||||
|
|
||||||
func (f optionFunc) apply(options *engineOptions) error {
|
|
||||||
return f(options)
|
|
||||||
}
|
|
||||||
|
|
||||||
type engineOptions struct {
|
|
||||||
llmClient llm.Client
|
|
||||||
promptDefs promptdef.Repository
|
|
||||||
profiles profile.Repository
|
|
||||||
memoryProfiles profile.Repository
|
|
||||||
validator validate.Validator
|
|
||||||
promptSource bool
|
|
||||||
profileSource bool
|
|
||||||
memorySource bool
|
|
||||||
validatorSource bool
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithLLMClient injects a custom LLM client for execution.
|
|
||||||
func WithLLMClient(client LLMClient) Option {
|
|
||||||
return optionFunc(func(options *engineOptions) error {
|
|
||||||
if client == nil {
|
|
||||||
return ErrInvalidConfig
|
|
||||||
}
|
|
||||||
options.llmClient = publicLLMClientAdapter{client: client}
|
|
||||||
return nil
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithPromptFS loads prompt definitions from fsys under root.
|
|
||||||
//
|
|
||||||
// The source uses the same strict prompt YAML rules as configured prompt
|
|
||||||
// directories, and prompt content_file paths resolve within this source.
|
|
||||||
func WithPromptFS(fsys fs.FS, root string) Option {
|
|
||||||
return optionFunc(func(options *engineOptions) error {
|
|
||||||
if fsys == nil {
|
|
||||||
return ErrInvalidConfig
|
|
||||||
}
|
|
||||||
if strings.TrimSpace(root) == "" {
|
|
||||||
return ErrInvalidConfig
|
|
||||||
}
|
|
||||||
options.promptDefs = promptdef.NewFSRepository(fsys, root)
|
|
||||||
options.promptSource = true
|
|
||||||
return nil
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithPromptFile loads prompt definitions from the single prompt file at path.
|
|
||||||
//
|
|
||||||
// Relative prompt content_file paths resolve from the file's directory.
|
|
||||||
func WithPromptFile(path string) Option {
|
|
||||||
return optionFunc(func(options *engineOptions) error {
|
|
||||||
fsys, root, err := fileSource(path)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
options.promptDefs = promptdef.NewFSRepository(fsys, root)
|
|
||||||
options.promptSource = true
|
|
||||||
return nil
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithProfileFS loads execution profiles from fsys under root.
|
|
||||||
//
|
|
||||||
// Profiles from this source overlay built-in profiles. Profile YAML must use
|
|
||||||
// api_key_env for environment-based credentials; raw API keys are rejected.
|
|
||||||
func WithProfileFS(fsys fs.FS, root string) Option {
|
|
||||||
return optionFunc(func(options *engineOptions) error {
|
|
||||||
if fsys == nil {
|
|
||||||
return ErrInvalidConfig
|
|
||||||
}
|
|
||||||
if strings.TrimSpace(root) == "" {
|
|
||||||
return ErrInvalidConfig
|
|
||||||
}
|
|
||||||
options.profiles = profile.NewFSRepository(fsys, root)
|
|
||||||
options.profileSource = true
|
|
||||||
return nil
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithProfileFile loads execution profiles from the single profile file at path.
|
|
||||||
//
|
|
||||||
// The profile overlays built-in profiles. Profile YAML must use api_key_env for
|
|
||||||
// environment-based credentials; raw API keys are rejected.
|
|
||||||
func WithProfileFile(path string) Option {
|
|
||||||
return optionFunc(func(options *engineOptions) error {
|
|
||||||
fsys, root, err := fileSource(path)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
options.profiles = profile.NewFSRepository(fsys, root)
|
|
||||||
options.profileSource = true
|
|
||||||
return nil
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithProfiles configures in-memory profiles that take precedence over
|
|
||||||
// configured profile files and built-in profiles.
|
|
||||||
func WithProfiles(profiles ...Profile) Option {
|
|
||||||
return optionFunc(func(options *engineOptions) error {
|
|
||||||
repo, err := newMemoryProfileRepository(profiles)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
options.memoryProfiles = repo
|
|
||||||
options.memorySource = true
|
|
||||||
return nil
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithSchemaFS loads JSON Schema documents from fsys under root.
|
|
||||||
//
|
|
||||||
// Prompt schema_path values resolve within this source when schema validation
|
|
||||||
// or structured output is requested.
|
|
||||||
func WithSchemaFS(fsys fs.FS, root string) Option {
|
|
||||||
return optionFunc(func(options *engineOptions) error {
|
|
||||||
if fsys == nil {
|
|
||||||
return ErrInvalidConfig
|
|
||||||
}
|
|
||||||
if strings.TrimSpace(root) == "" {
|
|
||||||
return ErrInvalidConfig
|
|
||||||
}
|
|
||||||
options.validator = validate.NewFSValidator(fsys, root)
|
|
||||||
options.validatorSource = true
|
|
||||||
return nil
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithSchemaFile loads JSON Schema documents from the single schema file at path.
|
|
||||||
//
|
|
||||||
// Prompt schema_path values refer to the file's base name.
|
|
||||||
func WithSchemaFile(path string) Option {
|
|
||||||
return optionFunc(func(options *engineOptions) error {
|
|
||||||
fsys, root, err := fileSource(path)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
options.validator = validate.NewFSValidator(fsys, root)
|
|
||||||
options.validatorSource = true
|
|
||||||
return nil
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewEngine constructs an Engine using the same default internal components as
|
|
||||||
// the CLI and HTTP adapters.
|
|
||||||
func NewEngine(cfg Config, opts ...Option) (*Engine, error) {
|
|
||||||
var options engineOptions
|
|
||||||
for _, opt := range opts {
|
|
||||||
if opt == nil {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
if err := opt.apply(&options); err != nil {
|
|
||||||
return nil, fmt.Errorf("%w: %v", ErrInvalidConfig, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
promptDefs := options.promptDefs
|
|
||||||
if !options.promptSource {
|
|
||||||
if strings.TrimSpace(cfg.PromptDir) == "" {
|
|
||||||
return nil, fmt.Errorf("%w: prompt directory is required", ErrInvalidConfig)
|
|
||||||
}
|
|
||||||
promptDefs = promptdef.NewFilesystemRepository(cfg.PromptDir)
|
|
||||||
}
|
|
||||||
|
|
||||||
profiles := builtin.NewRepositoryWithDirectory(cfg.ProfileDir)
|
|
||||||
if options.profileSource {
|
|
||||||
profiles = builtin.NewRepositoryWithPrimary(options.profiles)
|
|
||||||
}
|
|
||||||
if options.memorySource {
|
|
||||||
profiles = profile.NewOverlayRepository(options.memoryProfiles, profiles)
|
|
||||||
}
|
|
||||||
|
|
||||||
validator := options.validator
|
|
||||||
if !options.validatorSource {
|
|
||||||
schemaDir := cfg.SchemaDir
|
|
||||||
if strings.TrimSpace(schemaDir) == "" {
|
|
||||||
schemaDir = defaults.SchemaDirDefault
|
|
||||||
}
|
|
||||||
validator = validate.NewStandardValidator(schemaDir)
|
|
||||||
}
|
|
||||||
|
|
||||||
llmClient := options.llmClient
|
|
||||||
if llmClient == nil {
|
|
||||||
var err error
|
|
||||||
llmClient, err = llm.NewOpenAICompatibleClient(llm.OpenAICompatibleConfig{
|
|
||||||
Timeout: cfg.Timeout,
|
|
||||||
HTTPClient: cfg.HTTPClient,
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("%w: %v", ErrInvalidConfig, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return &Engine{
|
|
||||||
runner: usecase.NewRunner(
|
|
||||||
promptDefs,
|
|
||||||
profiles,
|
|
||||||
artifactadapter.NewCompositeReader(),
|
|
||||||
prompt.NewGoRenderer(),
|
|
||||||
llmClient,
|
|
||||||
validator,
|
|
||||||
),
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func fileSource(name string) (fs.FS, string, error) {
|
|
||||||
cleanName := strings.TrimSpace(name)
|
|
||||||
if cleanName == "" {
|
|
||||||
return nil, "", ErrInvalidConfig
|
|
||||||
}
|
|
||||||
dir := filepath.Dir(cleanName)
|
|
||||||
base := filepath.Base(cleanName)
|
|
||||||
if base == "." || base == string(filepath.Separator) || strings.TrimSpace(base) == "" {
|
|
||||||
return nil, "", ErrInvalidConfig
|
|
||||||
}
|
|
||||||
info, err := os.Stat(cleanName)
|
|
||||||
if err != nil {
|
|
||||||
return nil, "", fmt.Errorf("%w: failed to access source file %q: %v", ErrInvalidConfig, cleanName, err)
|
|
||||||
}
|
|
||||||
if info.IsDir() {
|
|
||||||
return nil, "", fmt.Errorf("%w: source path %q must be a file", ErrInvalidConfig, cleanName)
|
|
||||||
}
|
|
||||||
return os.DirFS(dir), filepath.ToSlash(base), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Prepare resolves a prompt request without calling an LLM.
|
|
||||||
func (e *Engine) Prepare(ctx context.Context, req RunRequest) (*PreparedRun, error) {
|
|
||||||
if e == nil || e.runner == nil {
|
|
||||||
return nil, fmt.Errorf("%w: engine is nil", ErrInvalidConfig)
|
|
||||||
}
|
|
||||||
|
|
||||||
domainReq, err := toDomainRunRequest(req)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("%w: %v", ErrInvalidRequest, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
prepared, err := e.runner.Prepare(ctx, domainReq)
|
|
||||||
if err != nil {
|
|
||||||
return nil, mapPublicError(err)
|
|
||||||
}
|
|
||||||
return fromDomainPreparedRun(prepared), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Run executes a prompt request and returns the generated artifact and metadata.
|
|
||||||
func (e *Engine) Run(ctx context.Context, req RunRequest) (*RunResult, error) {
|
|
||||||
if e == nil || e.runner == nil {
|
|
||||||
return nil, fmt.Errorf("%w: engine is nil", ErrInvalidConfig)
|
|
||||||
}
|
|
||||||
|
|
||||||
domainReq, err := toDomainRunRequest(req)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("%w: %v", ErrInvalidRequest, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
result, err := e.runner.Run(ctx, domainReq)
|
|
||||||
if err != nil {
|
|
||||||
return nil, mapPublicError(err)
|
|
||||||
}
|
|
||||||
return fromDomainRunResult(result), nil
|
|
||||||
}
|
|
||||||
1799
engine_test.go
1799
engine_test.go
File diff suppressed because it is too large
Load Diff
79
errors.go
79
errors.go
@@ -1,79 +0,0 @@
|
|||||||
package scriptorium
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/profile"
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/promptdef"
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/usecase"
|
|
||||||
)
|
|
||||||
|
|
||||||
func mapPublicError(err error) error {
|
|
||||||
if err == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
if hasPublicError(err) {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
publicErr := publicErrorFor(err)
|
|
||||||
if publicErr == nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return fmt.Errorf("%w: %w", publicErr, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
func hasPublicError(err error) bool {
|
|
||||||
for _, publicErr := range []error{
|
|
||||||
ErrInvalidConfig,
|
|
||||||
ErrInvalidRequest,
|
|
||||||
ErrPromptNotFound,
|
|
||||||
ErrProfileNotFound,
|
|
||||||
ErrPromptLoad,
|
|
||||||
ErrProfileLoad,
|
|
||||||
ErrArtifactLoad,
|
|
||||||
ErrPromptRender,
|
|
||||||
ErrLLMGenerate,
|
|
||||||
ErrValidation,
|
|
||||||
} {
|
|
||||||
if errors.Is(err, publicErr) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
func publicErrorFor(err error) error {
|
|
||||||
switch {
|
|
||||||
case errors.Is(err, promptdef.ErrPromptDefinitionNotFound):
|
|
||||||
return ErrPromptNotFound
|
|
||||||
case errors.Is(err, profile.ErrProfileNotFound):
|
|
||||||
return ErrProfileNotFound
|
|
||||||
case errors.Is(err, usecase.ErrPromptLoad):
|
|
||||||
return ErrPromptLoad
|
|
||||||
case errors.Is(err, usecase.ErrProfileLoad):
|
|
||||||
return ErrProfileLoad
|
|
||||||
case errors.Is(err, promptdef.ErrInvalidYAML), errors.Is(err, promptdef.ErrInvalidPromptDefinition):
|
|
||||||
return ErrPromptLoad
|
|
||||||
case isProfileLoadCause(err):
|
|
||||||
return ErrProfileLoad
|
|
||||||
case errors.Is(err, usecase.ErrArtifactLoad):
|
|
||||||
return ErrArtifactLoad
|
|
||||||
case errors.Is(err, usecase.ErrPromptRender):
|
|
||||||
return ErrPromptRender
|
|
||||||
case errors.Is(err, usecase.ErrLLMGenerate):
|
|
||||||
return ErrLLMGenerate
|
|
||||||
case errors.Is(err, usecase.ErrValidation):
|
|
||||||
return ErrValidation
|
|
||||||
case errors.Is(err, usecase.ErrInvalidRequest):
|
|
||||||
return ErrInvalidRequest
|
|
||||||
default:
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func isProfileLoadCause(err error) bool {
|
|
||||||
return errors.Is(err, profile.ErrInvalidYAML) ||
|
|
||||||
errors.Is(err, profile.ErrInvalidProfile) ||
|
|
||||||
errors.Is(err, profile.ErrRawAPIKeyNotAllowed)
|
|
||||||
}
|
|
||||||
4
examples/config-fragments/backend.yml
Normal file
4
examples/config-fragments/backend.yml
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
backends:
|
||||||
|
local-gpu:
|
||||||
|
endpoint: http://localhost:11434/v1
|
||||||
|
api_key_env: LOCAL_GPU_API_KEY
|
||||||
3
examples/config-fragments/sources.yml
Normal file
3
examples/config-fragments/sources.yml
Normal file
@@ -0,0 +1,3 @@
|
|||||||
|
prompt_dir: ./examples/prompts
|
||||||
|
profile_dir: ./examples/profiles
|
||||||
|
schema_dir: ./examples/schemas
|
||||||
8
examples/config.composed.yml
Normal file
8
examples/config.composed.yml
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# Select from the repository root; application paths remain working-directory-relative.
|
||||||
|
configkit:
|
||||||
|
imports:
|
||||||
|
- path: config-fragments/sources.yml
|
||||||
|
- path: config-fragments/backend.yml
|
||||||
|
|
||||||
|
server:
|
||||||
|
addr: :8080
|
||||||
@@ -2,6 +2,15 @@ prompt_dir: ./examples/prompts
|
|||||||
profile_dir: ./examples/profiles
|
profile_dir: ./examples/profiles
|
||||||
schema_dir: ./examples/schemas
|
schema_dir: ./examples/schemas
|
||||||
|
|
||||||
|
backends:
|
||||||
|
local-gpu:
|
||||||
|
endpoint: http://localhost:11434/v1
|
||||||
|
api_key_env: LOCAL_GPU_API_KEY
|
||||||
|
extra_params:
|
||||||
|
provider_option: enabled
|
||||||
|
concurrency_limit: 2
|
||||||
|
queue_capacity: 0
|
||||||
|
|
||||||
server:
|
server:
|
||||||
addr: 127.0.0.1:8080
|
addr: 127.0.0.1:8080
|
||||||
artifact_root: .
|
artifact_root: .
|
||||||
|
|||||||
@@ -1,50 +0,0 @@
|
|||||||
package main
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"encoding/json"
|
|
||||||
"log"
|
|
||||||
"os"
|
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
engine, err := scriptorium.NewEngine(scriptorium.Config{
|
|
||||||
PromptDir: "./examples/prompts",
|
|
||||||
ProfileDir: "./examples/profiles",
|
|
||||||
SchemaDir: "./examples/schemas",
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
log.Fatal(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
prepared, err := engine.Prepare(context.Background(), scriptorium.RunRequest{
|
|
||||||
PromptID: "generic.markdown_summary",
|
|
||||||
Inputs: map[string]scriptorium.ArtifactRef{
|
|
||||||
"transcript": scriptorium.File("./examples/fixtures/transcript.md"),
|
|
||||||
"glossary": scriptorium.File("./examples/fixtures/glossary.yml"),
|
|
||||||
},
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
log.Fatal(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
summary := struct {
|
|
||||||
PromptID string `json:"prompt_id"`
|
|
||||||
SelectedProfileID string `json:"selected_profile_id"`
|
|
||||||
Model string `json:"model"`
|
|
||||||
MessageCount int `json:"message_count"`
|
|
||||||
InputHashes map[string]string `json:"input_hashes"`
|
|
||||||
}{
|
|
||||||
PromptID: prepared.PromptID,
|
|
||||||
SelectedProfileID: prepared.SelectedProfileID,
|
|
||||||
Model: prepared.EffectiveModelParams.Model,
|
|
||||||
MessageCount: len(prepared.Messages),
|
|
||||||
InputHashes: prepared.InputHashes,
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := json.NewEncoder(os.Stdout).Encode(summary); err != nil {
|
|
||||||
log.Fatal(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
4
examples/overlays/local.yml
Normal file
4
examples/overlays/local.yml
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
defaults:
|
||||||
|
render_format: json
|
||||||
|
server:
|
||||||
|
addr: 127.0.0.1:8080
|
||||||
4
examples/profiles/local-gpu.yml
Normal file
4
examples/profiles/local-gpu.yml
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
id: local-gpu
|
||||||
|
backend: local-gpu
|
||||||
|
model: local-model
|
||||||
|
reasoning_effort: low
|
||||||
25
examples/render-v0.9-features.sh
Executable file
25
examples/render-v0.9-features.sh
Executable file
@@ -0,0 +1,25 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
repo_root="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
|
||||||
|
cd "$repo_root"
|
||||||
|
|
||||||
|
go run ./cmd/scriptorium render \
|
||||||
|
--config ./examples/config.full.yml \
|
||||||
|
--prompt generic.markdown_summary \
|
||||||
|
--prompt-version 1.0.0 \
|
||||||
|
--profile local-gpu \
|
||||||
|
--session-id example-session \
|
||||||
|
--reasoning-effort= \
|
||||||
|
--input transcript=./examples/fixtures/transcript.md \
|
||||||
|
--input glossary=./examples/fixtures/glossary.yml
|
||||||
|
|
||||||
|
go run ./cmd/scriptorium inspect prompt \
|
||||||
|
--config ./examples/config.full.yml \
|
||||||
|
--prompt generic.markdown_summary \
|
||||||
|
--format json
|
||||||
|
|
||||||
|
go run ./cmd/scriptorium inspect profile \
|
||||||
|
--config ./examples/config.full.yml \
|
||||||
|
--profile local-gpu \
|
||||||
|
--format json
|
||||||
@@ -1,51 +0,0 @@
|
|||||||
package scriptorium
|
|
||||||
|
|
||||||
import "fmt"
|
|
||||||
|
|
||||||
// String returns a concise request summary without exposing direct API keys.
|
|
||||||
func (r RunRequest) String() string {
|
|
||||||
return r.redactedString()
|
|
||||||
}
|
|
||||||
|
|
||||||
// GoString returns a concise request summary without exposing direct API keys.
|
|
||||||
func (r RunRequest) GoString() string {
|
|
||||||
return r.redactedString()
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r RunRequest) redactedString() string {
|
|
||||||
return fmt.Sprintf(
|
|
||||||
"scriptorium.RunRequest{PromptID:%q PromptVersion:%q ProfileID:%q APIKeySet:%t Inputs:%d Vars:%d ExecutionSet:%t ValidationSet:%t Metadata:%d}",
|
|
||||||
r.PromptID,
|
|
||||||
r.PromptVersion,
|
|
||||||
r.ProfileID,
|
|
||||||
r.APIKey != "",
|
|
||||||
len(r.Inputs),
|
|
||||||
len(r.Vars),
|
|
||||||
r.Execution != nil,
|
|
||||||
r.Validation != nil,
|
|
||||||
len(r.Metadata),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
// String returns a concise request summary without exposing direct API keys or
|
|
||||||
// rendered prompt content.
|
|
||||||
func (r GenerateRequest) String() string {
|
|
||||||
return r.redactedString()
|
|
||||||
}
|
|
||||||
|
|
||||||
// GoString returns a concise request summary without exposing direct API keys or
|
|
||||||
// rendered prompt content.
|
|
||||||
func (r GenerateRequest) GoString() string {
|
|
||||||
return r.redactedString()
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r GenerateRequest) redactedString() string {
|
|
||||||
return fmt.Sprintf(
|
|
||||||
"scriptorium.GenerateRequest{Messages:%d Model:%q APIKeySet:%t StructuredOutputSet:%t ExtraParams:%d}",
|
|
||||||
len(r.Prompt.Messages),
|
|
||||||
r.Target.Model,
|
|
||||||
r.APIKey != "",
|
|
||||||
r.StructuredOutput != nil,
|
|
||||||
len(r.Target.ExtraParams),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
13
go.mod
13
go.mod
@@ -3,8 +3,15 @@ module gitea.maximumdirect.net/eric/scriptorium
|
|||||||
go 1.25.5
|
go 1.25.5
|
||||||
|
|
||||||
require (
|
require (
|
||||||
github.com/santhosh-tekuri/jsonschema/v6 v6.0.2
|
gitea.maximumdirect.net/eric/ConfigKit v0.4.0
|
||||||
gopkg.in/yaml.v3 v3.0.1
|
gitea.maximumdirect.net/eric/promptkit v0.11.0
|
||||||
)
|
)
|
||||||
|
|
||||||
require golang.org/x/text v0.14.0 // indirect
|
require (
|
||||||
|
gitea.maximumdirect.net/eric/promptkit-backend-openrouter/v2 v2.20260922.1 // indirect
|
||||||
|
gitea.maximumdirect.net/eric/promptkit-backend-rakestrawhome/v2 v2.20260922.0 // indirect
|
||||||
|
github.com/santhosh-tekuri/jsonschema/v6 v6.0.2 // indirect
|
||||||
|
go.yaml.in/yaml/v4 v4.0.0-rc.6 // indirect
|
||||||
|
golang.org/x/text v0.14.0 // indirect
|
||||||
|
gopkg.in/yaml.v3 v3.0.1 // indirect
|
||||||
|
)
|
||||||
|
|||||||
10
go.sum
10
go.sum
@@ -1,7 +1,17 @@
|
|||||||
|
gitea.maximumdirect.net/eric/ConfigKit v0.4.0 h1:fo+vKff3zTGeWqJIA38NtT84b6OUP//9ZmBH3lFuKgk=
|
||||||
|
gitea.maximumdirect.net/eric/ConfigKit v0.4.0/go.mod h1:tYWpsrbLyu05r8+1MapWp5fN6ZrX9I8hU2xEPedYmYk=
|
||||||
|
gitea.maximumdirect.net/eric/promptkit v0.11.0 h1:x7JguOUiInPVXK0GEitjyoRFqqvcuSTjYUvqJ+whtik=
|
||||||
|
gitea.maximumdirect.net/eric/promptkit v0.11.0/go.mod h1:0zEBVlJJC+ldDdXazAgybYBXNSe74vwFx5dyOuSos/w=
|
||||||
|
gitea.maximumdirect.net/eric/promptkit-backend-openrouter/v2 v2.20260922.1 h1:S2/Q/JDE+m8Ca3pDhAjVbfYrdlEhs9blj0STgNopHo0=
|
||||||
|
gitea.maximumdirect.net/eric/promptkit-backend-openrouter/v2 v2.20260922.1/go.mod h1:a3VBbh9oaGXD6ruxhtwHj+AWW6DY/SSyby1QtMmYSUo=
|
||||||
|
gitea.maximumdirect.net/eric/promptkit-backend-rakestrawhome/v2 v2.20260922.0 h1:Y0EXc3eh12eKW2NrOviVqdk3oBo6UUjopt1YAa1B3Oc=
|
||||||
|
gitea.maximumdirect.net/eric/promptkit-backend-rakestrawhome/v2 v2.20260922.0/go.mod h1:mtgD1E0SGm0e/I8Ffhz+AYX7GN7RKUWJXehNFIKHs4Y=
|
||||||
github.com/dlclark/regexp2 v1.11.0 h1:G/nrcoOa7ZXlpoa/91N3X7mM3r8eIlMBBJZvsz/mxKI=
|
github.com/dlclark/regexp2 v1.11.0 h1:G/nrcoOa7ZXlpoa/91N3X7mM3r8eIlMBBJZvsz/mxKI=
|
||||||
github.com/dlclark/regexp2 v1.11.0/go.mod h1:DHkYz0B9wPfa6wondMfaivmHpzrQ3v9q8cnmRbL6yW8=
|
github.com/dlclark/regexp2 v1.11.0/go.mod h1:DHkYz0B9wPfa6wondMfaivmHpzrQ3v9q8cnmRbL6yW8=
|
||||||
github.com/santhosh-tekuri/jsonschema/v6 v6.0.2 h1:KRzFb2m7YtdldCEkzs6KqmJw4nqEVZGK7IN2kJkjTuQ=
|
github.com/santhosh-tekuri/jsonschema/v6 v6.0.2 h1:KRzFb2m7YtdldCEkzs6KqmJw4nqEVZGK7IN2kJkjTuQ=
|
||||||
github.com/santhosh-tekuri/jsonschema/v6 v6.0.2/go.mod h1:JXeL+ps8p7/KNMjDQk3TCwPpBy0wYklyWTfbkIzdIFU=
|
github.com/santhosh-tekuri/jsonschema/v6 v6.0.2/go.mod h1:JXeL+ps8p7/KNMjDQk3TCwPpBy0wYklyWTfbkIzdIFU=
|
||||||
|
go.yaml.in/yaml/v4 v4.0.0-rc.6 h1:1h7H1ohdUh93/FyE4YaDa1Zh64K6VVbjF4K6WUxMtH4=
|
||||||
|
go.yaml.in/yaml/v4 v4.0.0-rc.6/go.mod h1:aZqd9kCMsGL7AuUv/m/PvWLdg5sjJsZ4oHDEnfPPfY0=
|
||||||
golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
|
golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
|
||||||
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
|
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
|
||||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
|
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
|
||||||
|
|||||||
71
internal/adapter/cli/application_config.go
Normal file
71
internal/adapter/cli/application_config.go
Normal file
@@ -0,0 +1,71 @@
|
|||||||
|
package cli
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"flag"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
|
||||||
|
configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
||||||
|
appconfig "gitea.maximumdirect.net/eric/scriptorium/internal/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
// applicationOverrides keeps explicit application flags separate from invocation state.
|
||||||
|
func applicationOverrides(fs *flag.FlagSet) []configkit.Override {
|
||||||
|
var overrides []configkit.Override
|
||||||
|
fs.Visit(func(selected *flag.Flag) {
|
||||||
|
var path configkit.Path
|
||||||
|
switch selected.Name {
|
||||||
|
case "prompt-dir":
|
||||||
|
path = configkit.Keys("prompt_dir")
|
||||||
|
case "profile-dir":
|
||||||
|
path = configkit.Keys("profile_dir")
|
||||||
|
case "schema-dir":
|
||||||
|
path = configkit.Keys("schema_dir")
|
||||||
|
case "addr":
|
||||||
|
path = configkit.Keys("server", "addr")
|
||||||
|
case "artifact-root":
|
||||||
|
path = configkit.Keys("server", "artifact_root")
|
||||||
|
case "max-request-bytes":
|
||||||
|
path = configkit.Keys("server", "max_request_bytes")
|
||||||
|
case "max-artifact-bytes":
|
||||||
|
path = configkit.Keys("server", "max_artifact_bytes")
|
||||||
|
case "max-response-bytes":
|
||||||
|
path = configkit.Keys("server", "max_response_bytes")
|
||||||
|
default:
|
||||||
|
return
|
||||||
|
}
|
||||||
|
overrides = append(overrides, configkit.Override{
|
||||||
|
Path: path, Value: selected.Value.(flag.Getter).Get(), Flag: "--" + selected.Name,
|
||||||
|
})
|
||||||
|
})
|
||||||
|
return overrides
|
||||||
|
}
|
||||||
|
|
||||||
|
func loadApplicationSettings(configPath, overlay string, explicit bool, overrides []configkit.Override) (appconfig.AppSettings, []configkit.Diagnostic, error) {
|
||||||
|
result, err := appconfig.Load(appconfig.LoadOptions{
|
||||||
|
Path: configPath, Overlay: overlay, Explicit: explicit, Overrides: overrides,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return appconfig.AppSettings{}, nil, err
|
||||||
|
}
|
||||||
|
return appconfig.Settings(result.Config), result.Diagnostics(), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeApplicationError(output io.Writer, label string, err error) {
|
||||||
|
var loadError *configkit.LoadError
|
||||||
|
if errors.As(err, &loadError) {
|
||||||
|
if writeErr := configkit.WriteDiagnostics(output, loadError.Diagnostics()); writeErr != nil {
|
||||||
|
_, _ = fmt.Fprintf(output, "%s diagnostic write error: %v\n", label, writeErr)
|
||||||
|
}
|
||||||
|
return
|
||||||
|
}
|
||||||
|
_, _ = fmt.Fprintf(output, "%s error: %v\n", label, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeApplicationWarnings(output io.Writer, diagnostics []configkit.Diagnostic) error {
|
||||||
|
if len(diagnostics) == 0 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return configkit.WriteDiagnostics(output, diagnostics)
|
||||||
|
}
|
||||||
104
internal/adapter/cli/config.go
Normal file
104
internal/adapter/cli/config.go
Normal file
@@ -0,0 +1,104 @@
|
|||||||
|
package cli
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"flag"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
|
||||||
|
configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
||||||
|
appconfig "gitea.maximumdirect.net/eric/scriptorium/internal/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
type configurationSource struct {
|
||||||
|
ID string `json:"id"`
|
||||||
|
Label string `json:"label"`
|
||||||
|
Layer configkit.Layer `json:"layer"`
|
||||||
|
Path string `json:"path,omitempty"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func configCommand(args []string, stdout, stderr io.Writer) int {
|
||||||
|
if len(args) == 0 {
|
||||||
|
fmt.Fprintln(stderr, "config parse error: configuration mode is required")
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
mode := args[0]
|
||||||
|
if mode != "validate" && mode != "show" && mode != "sources" && mode != "explain" {
|
||||||
|
fmt.Fprintln(stderr, "config parse error: unknown configuration mode")
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
|
||||||
|
fs := flag.NewFlagSet("config "+mode, flag.ContinueOnError)
|
||||||
|
fs.SetOutput(io.Discard)
|
||||||
|
var path, overlay, pointer string
|
||||||
|
registerConfigSelectionFlags(fs, &path, &overlay)
|
||||||
|
registerConfigurationOverrides(fs)
|
||||||
|
if mode == "explain" {
|
||||||
|
fs.StringVar(&pointer, "path", "", "configuration path as a JSON Pointer")
|
||||||
|
}
|
||||||
|
if err := fs.Parse(args[1:]); err != nil {
|
||||||
|
writeApplicationError(stderr, "config parse", err)
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
if fs.NArg() != 0 {
|
||||||
|
fmt.Fprintln(stderr, "config parse error: positional arguments are not accepted")
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
var explanationPath configkit.Path
|
||||||
|
if mode == "explain" {
|
||||||
|
if !flagWasSet(fs, "path") {
|
||||||
|
fmt.Fprintln(stderr, "config parse error: --path is required")
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
var err error
|
||||||
|
explanationPath, err = configkit.ParsePath(pointer)
|
||||||
|
if err != nil {
|
||||||
|
fmt.Fprintln(stderr, "config parse error: --path must be a JSON Pointer")
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
result, err := appconfig.Load(appconfig.LoadOptions{
|
||||||
|
Path: path, Explicit: flagWasSet(fs, "config"), Overlay: overlay,
|
||||||
|
Overrides: applicationOverrides(fs),
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
writeApplicationError(stderr, "config", err)
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
if err := writeApplicationWarnings(stderr, result.Diagnostics()); err != nil {
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
switch mode {
|
||||||
|
case "validate":
|
||||||
|
return ExitOK
|
||||||
|
case "show":
|
||||||
|
err = result.WriteEffective(stdout)
|
||||||
|
case "sources":
|
||||||
|
sources := make([]configurationSource, 0, len(result.Sources()))
|
||||||
|
for _, source := range result.Sources() {
|
||||||
|
sources = append(sources, configurationSource{
|
||||||
|
ID: source.ID, Label: source.Label, Layer: source.Layer, Path: source.Path,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
err = json.NewEncoder(stdout).Encode(sources)
|
||||||
|
case "explain":
|
||||||
|
err = result.WriteExplanation(stdout, explanationPath)
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
fmt.Fprintf(stderr, "config output error: %v\n", err)
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
return ExitOK
|
||||||
|
}
|
||||||
|
|
||||||
|
func registerConfigurationOverrides(fs *flag.FlagSet) {
|
||||||
|
fs.String("prompt-dir", "", "prompt-definition directory override")
|
||||||
|
fs.String("profile-dir", "", "profile directory override")
|
||||||
|
fs.String("schema-dir", "", "schema directory override")
|
||||||
|
fs.String("addr", "", "HTTP listen address override")
|
||||||
|
fs.String("artifact-root", "", "HTTP artifact root override")
|
||||||
|
fs.Int64("max-request-bytes", 0, "HTTP request byte limit override")
|
||||||
|
fs.Int64("max-artifact-bytes", 0, "HTTP artifact byte limit override")
|
||||||
|
fs.Int64("max-response-bytes", 0, "HTTP response byte limit override")
|
||||||
|
}
|
||||||
207
internal/adapter/cli/config_test.go
Normal file
207
internal/adapter/cli/config_test.go
Normal file
@@ -0,0 +1,207 @@
|
|||||||
|
package cli
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
appconfig "gitea.maximumdirect.net/eric/scriptorium/internal/config"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestConfigCommandsInspectApplicationWithoutEngine(t *testing.T) {
|
||||||
|
path := writeAppConfigFile(t, "{}\n")
|
||||||
|
for _, mode := range []string{"validate", "show", "sources"} {
|
||||||
|
code, stdout, stderr := runCLICommand(t, configCommand, []string{mode, "--config", path})
|
||||||
|
if code != ExitOK || stderr != "" {
|
||||||
|
t.Fatalf("%s failed: code=%d stdout=%q stderr=%q", mode, code, stdout, stderr)
|
||||||
|
}
|
||||||
|
switch mode {
|
||||||
|
case "validate":
|
||||||
|
if stdout != "" {
|
||||||
|
t.Fatalf("validation wrote stdout: %q", stdout)
|
||||||
|
}
|
||||||
|
case "show":
|
||||||
|
if !strings.Contains(stdout, "render_format: text") || !strings.Contains(stdout, "max_request_bytes: 16777216") {
|
||||||
|
t.Fatalf("effective defaults missing: %q", stdout)
|
||||||
|
}
|
||||||
|
case "sources":
|
||||||
|
var sources []configurationSource
|
||||||
|
if err := json.Unmarshal([]byte(stdout), &sources); err != nil || len(sources) != 1 || sources[0].Layer != "base" {
|
||||||
|
t.Fatalf("unexpected source records: %q (%v)", stdout, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestConfigCommandsExposeComposedSourcesAndResolvedValues(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
if err := os.MkdirAll(filepath.Join(dir, "overlays"), 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
base := filepath.Join(dir, "config.yml")
|
||||||
|
for path, body := range map[string]string{
|
||||||
|
base: "configkit:\n imports:\n - path: fragment.yml\nprompt_dir: ' ./before/../prompts '\nprofile_dir: ./profiles\n",
|
||||||
|
filepath.Join(dir, "fragment.yml"): "server:\n addr: :8081\n",
|
||||||
|
filepath.Join(dir, "overlays", "local.yml"): "server:\n addr: :9090\n",
|
||||||
|
} {
|
||||||
|
if err := os.WriteFile(path, []byte(body), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
args := []string{"--config", base, "--config-overlay", "local", "--profile-dir=", "--addr", ":7070"}
|
||||||
|
code, stdout, stderr := runCLICommand(t, configCommand, append([]string{"show"}, args...))
|
||||||
|
if code != ExitOK || stderr != "" || !strings.Contains(stdout, "prompt_dir: prompts") || !strings.Contains(stdout, "profile_dir: ''") || !strings.Contains(stdout, "addr: :7070") {
|
||||||
|
t.Fatalf("resolved effective output changed: code=%d out=%q err=%q", code, stdout, stderr)
|
||||||
|
}
|
||||||
|
code, stdout, stderr = runCLICommand(t, configCommand, append([]string{"sources"}, args...))
|
||||||
|
if code != ExitOK || stderr != "" || !strings.HasSuffix(stdout, "\n") {
|
||||||
|
t.Fatalf("source command failed: code=%d out=%q err=%q", code, stdout, stderr)
|
||||||
|
}
|
||||||
|
var sources []configurationSource
|
||||||
|
if err := json.Unmarshal([]byte(stdout), &sources); err != nil || len(sources) != 5 {
|
||||||
|
t.Fatalf("unexpected composed source records: %+v (%v)", sources, err)
|
||||||
|
}
|
||||||
|
for i, layer := range []string{"base", "base", "overlay", "cli", "cli"} {
|
||||||
|
if string(sources[i].Layer) != layer {
|
||||||
|
t.Fatalf("source %d layer = %q, want %q", i, sources[i].Layer, layer)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestConfigInspectionKeepsReferencesAndOrdinaryParameters(t *testing.T) {
|
||||||
|
const name = "SCRIPTORIUM_CONFIG_TEST_API_KEY"
|
||||||
|
const secret = "synthetic-secret-value-should-not-appear"
|
||||||
|
path := writeAppConfigFile(t, `backends:
|
||||||
|
synthetic:
|
||||||
|
endpoint: http://127.0.0.1:1/v1
|
||||||
|
api_key_env: SCRIPTORIUM_CONFIG_TEST_API_KEY
|
||||||
|
extra_params:
|
||||||
|
visible_parameter: synthetic-ordinary-value
|
||||||
|
`)
|
||||||
|
t.Setenv(name, secret)
|
||||||
|
for _, present := range []bool{true, false} {
|
||||||
|
if !present {
|
||||||
|
if err := os.Unsetenv(name); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
code, stdout, stderr := runCLICommand(t, configCommand, []string{"show", "--config", path})
|
||||||
|
if code != ExitOK || stderr != "" || !strings.Contains(stdout, name) || !strings.Contains(stdout, "synthetic-ordinary-value") || strings.Contains(stdout, secret) {
|
||||||
|
t.Fatalf("credential boundary changed with present=%t: code=%d out=%q err=%q", present, code, stdout, stderr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
result, err := appconfig.Load(appconfig.LoadOptions{Path: path, Explicit: true})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
settings := appconfig.Settings(result.Config)
|
||||||
|
if len(settings.Backends) != 1 || settings.Backends[0].ExtraParams["visible_parameter"] != "synthetic-ordinary-value" {
|
||||||
|
t.Fatalf("runtime backend parameters changed: %+v", settings.Backends)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
type errorOutputWriter struct{}
|
||||||
|
|
||||||
|
func (errorOutputWriter) Write([]byte) (int, error) { return 0, errors.New("output unavailable") }
|
||||||
|
|
||||||
|
func TestConfigCommandFailuresDoNotProduceSuccessfulOutput(t *testing.T) {
|
||||||
|
path := writeAppConfigFile(t, "server:\n max_request_bytes: -1\n")
|
||||||
|
for _, mode := range []string{"validate", "show", "sources"} {
|
||||||
|
code, stdout, stderr := runCLICommand(t, configCommand, []string{mode, "--config", path})
|
||||||
|
if code != ExitRuntimeError || stdout != "" || !strings.Contains(stderr, "validate.error") {
|
||||||
|
t.Fatalf("%s misclassified invalid config: code=%d out=%q err=%q", mode, code, stdout, stderr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
path = writeAppConfigFile(t, "{}\n")
|
||||||
|
var stderr bytes.Buffer
|
||||||
|
if code := configCommand([]string{"show", "--config", path}, errorOutputWriter{}, &stderr); code != ExitRuntimeError || !strings.Contains(stderr.String(), "output error") {
|
||||||
|
t.Fatalf("writer error not reported: code=%d stderr=%q", code, stderr.String())
|
||||||
|
}
|
||||||
|
if code := configCommand([]string{"sources", "--config", path}, errorOutputWriter{}, io.Discard); code != ExitRuntimeError {
|
||||||
|
t.Fatalf("source writer error returned %d", code)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestConfigExplainUsesResolvedHistoryAndKeepsParametersVisible(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
if err := os.MkdirAll(filepath.Join(dir, "overlays"), 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
base := filepath.Join(dir, "config.yml")
|
||||||
|
for path, body := range map[string]string{
|
||||||
|
base: `prompt_dir: " ./prompts/../prompts "
|
||||||
|
server:
|
||||||
|
addr: :8080
|
||||||
|
backends:
|
||||||
|
"team/blue~1":
|
||||||
|
endpoint: http://127.0.0.1:1/v1
|
||||||
|
api_key_env: SCRIPTORIUM_EXPLAIN_KEY
|
||||||
|
extra_params:
|
||||||
|
"0": base-parameter
|
||||||
|
`,
|
||||||
|
filepath.Join(dir, "overlays", "local.yml"): `server:
|
||||||
|
addr: :9090
|
||||||
|
backends:
|
||||||
|
"team/blue~1":
|
||||||
|
extra_params:
|
||||||
|
"0": overlay-parameter
|
||||||
|
`,
|
||||||
|
} {
|
||||||
|
if err := os.WriteFile(path, []byte(body), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
const keyValue = "synthetic-key-bytes-must-not-appear"
|
||||||
|
t.Setenv("SCRIPTORIUM_EXPLAIN_KEY", keyValue)
|
||||||
|
args := []string{"--config", base, "--config-overlay", "local", "--addr", ":9090"}
|
||||||
|
for _, tc := range []struct {
|
||||||
|
pointer string
|
||||||
|
want []string
|
||||||
|
}{
|
||||||
|
{pointer: "/server/addr", want: []string{":8080", ":9090", "--addr"}},
|
||||||
|
{pointer: "/prompt_dir", want: []string{"normalized application path", "prompts"}},
|
||||||
|
{pointer: "/backends/team~1blue~01/extra_params/0", want: []string{"base-parameter", "overlay-parameter"}},
|
||||||
|
{pointer: "/backends/team~1blue~01/api_key_env", want: []string{"SCRIPTORIUM_EXPLAIN_KEY"}},
|
||||||
|
{pointer: "", want: []string{"base-parameter", "overlay-parameter", "SCRIPTORIUM_EXPLAIN_KEY"}},
|
||||||
|
} {
|
||||||
|
code, stdout, stderr := runCLICommand(t, configCommand, append([]string{"explain", "--path", tc.pointer}, args...))
|
||||||
|
if code != ExitOK || stderr != "" || strings.Contains(stdout, keyValue) {
|
||||||
|
t.Fatalf("explain %q failed or disclosed key: code=%d out=%q err=%q", tc.pointer, code, stdout, stderr)
|
||||||
|
}
|
||||||
|
for _, want := range tc.want {
|
||||||
|
if !strings.Contains(stdout, want) {
|
||||||
|
t.Fatalf("explain %q lacks %q: %q", tc.pointer, want, stdout)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if err := os.Unsetenv("SCRIPTORIUM_EXPLAIN_KEY"); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
code, stdout, stderr := runCLICommand(t, configCommand, append([]string{"explain", "--path", "/backends/team~1blue~01/api_key_env"}, args...))
|
||||||
|
if code != ExitOK || stderr != "" || !strings.Contains(stdout, "SCRIPTORIUM_EXPLAIN_KEY") || strings.Contains(stdout, keyValue) {
|
||||||
|
t.Fatalf("absent credential changed reference explanation: code=%d out=%q err=%q", code, stdout, stderr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestConfigExplainRejectsUnknownOrMalformedPaths(t *testing.T) {
|
||||||
|
path := writeAppConfigFile(t, "{}\n")
|
||||||
|
for _, args := range [][]string{
|
||||||
|
{"explain", "--config", path},
|
||||||
|
{"explain", "--config", path, "--path", "not-a-pointer"},
|
||||||
|
{"explain", "--config", path, "--path", "/missing"},
|
||||||
|
} {
|
||||||
|
code, stdout, stderr := runCLICommand(t, configCommand, args)
|
||||||
|
if code != ExitRuntimeError || stdout != "" || stderr == "" {
|
||||||
|
t.Fatalf("invalid explanation path accepted: args=%q code=%d out=%q err=%q", args, code, stdout, stderr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
var stderr bytes.Buffer
|
||||||
|
if code := configCommand([]string{"explain", "--config", path, "--path", ""}, errorOutputWriter{}, &stderr); code != ExitRuntimeError || !strings.Contains(stderr.String(), "output error") {
|
||||||
|
t.Fatalf("explanation writer failure not reported: code=%d err=%q", code, stderr.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
212
internal/adapter/cli/inspect.go
Normal file
212
internal/adapter/cli/inspect.go
Normal file
@@ -0,0 +1,212 @@
|
|||||||
|
package cli
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"flag"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"io/fs"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
||||||
|
"gitea.maximumdirect.net/eric/promptkit"
|
||||||
|
appformat "gitea.maximumdirect.net/eric/scriptorium/internal/format"
|
||||||
|
)
|
||||||
|
|
||||||
|
type promptInspectionConfig struct {
|
||||||
|
configPath, promptDir, promptID, promptVersion, outputPath string
|
||||||
|
configOverlay string
|
||||||
|
configExplicit bool
|
||||||
|
outputFormat appformat.OutputFormat
|
||||||
|
overrides []configkit.Override
|
||||||
|
diagnostics []configkit.Diagnostic
|
||||||
|
}
|
||||||
|
|
||||||
|
type profileInspectionConfig struct {
|
||||||
|
configPath, profileDir, profileID, outputPath string
|
||||||
|
configOverlay string
|
||||||
|
configExplicit bool
|
||||||
|
outputFormat appformat.OutputFormat
|
||||||
|
overrides []configkit.Override
|
||||||
|
diagnostics []configkit.Diagnostic
|
||||||
|
}
|
||||||
|
|
||||||
|
// emptyPromptDefinitionFS satisfies Promptkit's engine-level prompt-source
|
||||||
|
// requirement without exposing the caller's working directory. Profile
|
||||||
|
// inspection never reads this source.
|
||||||
|
type emptyPromptDefinitionFS struct{}
|
||||||
|
|
||||||
|
func (emptyPromptDefinitionFS) Open(name string) (fs.File, error) {
|
||||||
|
return nil, &fs.PathError{Op: "open", Path: name, Err: fs.ErrNotExist}
|
||||||
|
}
|
||||||
|
|
||||||
|
func inspectCommand(args []string, stdout, stderr io.Writer) int {
|
||||||
|
if len(args) == 0 {
|
||||||
|
fmt.Fprintln(stderr, "inspect parse error: inspection mode is required")
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
if args[0] == "profile" {
|
||||||
|
return inspectProfileCommand(args[1:], stdout, stderr)
|
||||||
|
}
|
||||||
|
if args[0] != "prompt" {
|
||||||
|
fmt.Fprintln(stderr, "inspect parse error: unknown inspection mode")
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
cfg, err := parsePromptInspectionArgs(args[1:])
|
||||||
|
if err != nil {
|
||||||
|
writeApplicationError(stderr, "inspect parse", err)
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
settings, err := resolveAppSettingsForPromptInspection(cfg)
|
||||||
|
if err != nil {
|
||||||
|
writeApplicationError(stderr, "inspect", err)
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
if err := writeApplicationWarnings(stderr, cfg.diagnostics); err != nil {
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
engine, err := newEngine(settings)
|
||||||
|
if err != nil {
|
||||||
|
fmt.Fprintf(stderr, "engine error: %v\n", err)
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
inspection, err := engine.InspectPrompt(context.Background(), cfg.promptID, cfg.promptVersion)
|
||||||
|
if err != nil {
|
||||||
|
fmt.Fprintf(stderr, "inspect error: %v\n", err)
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
data, err := appformat.FormatPromptInspection(inspection, cfg.outputFormat)
|
||||||
|
if err != nil {
|
||||||
|
fmt.Fprintf(stderr, "inspect error: %v\n", err)
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
if err := writeOutput(stdout, cfg.outputPath, data); err != nil {
|
||||||
|
fmt.Fprintf(stderr, "output write error: %v\n", err)
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
return ExitOK
|
||||||
|
}
|
||||||
|
|
||||||
|
func inspectProfileCommand(args []string, stdout, stderr io.Writer) int {
|
||||||
|
cfg, err := parseProfileInspectionArgs(args)
|
||||||
|
if err != nil {
|
||||||
|
writeApplicationError(stderr, "inspect parse", err)
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
settings, err := resolveAppSettingsForProfileInspection(cfg)
|
||||||
|
if err != nil {
|
||||||
|
writeApplicationError(stderr, "inspect", err)
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
if err := writeApplicationWarnings(stderr, cfg.diagnostics); err != nil {
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
engine, err := newEngine(settings, promptkit.WithPromptFS(emptyPromptDefinitionFS{}, "."))
|
||||||
|
if err != nil {
|
||||||
|
fmt.Fprintf(stderr, "engine error: %v\n", err)
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
inspection, err := engine.InspectProfile(context.Background(), cfg.profileID)
|
||||||
|
if err != nil {
|
||||||
|
fmt.Fprintf(stderr, "inspect error: %v\n", err)
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
data, err := appformat.FormatProfileInspection(inspection, cfg.outputFormat)
|
||||||
|
if err != nil {
|
||||||
|
fmt.Fprintf(stderr, "inspect error: %v\n", err)
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
if err := writeOutput(stdout, cfg.outputPath, data); err != nil {
|
||||||
|
fmt.Fprintf(stderr, "output write error: %v\n", err)
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
return ExitOK
|
||||||
|
}
|
||||||
|
|
||||||
|
func parseProfileInspectionArgs(args []string) (*profileInspectionConfig, error) {
|
||||||
|
cfg := &profileInspectionConfig{outputFormat: appformat.DefaultOutputFormat}
|
||||||
|
fs := flag.NewFlagSet("inspect profile", flag.ContinueOnError)
|
||||||
|
fs.SetOutput(io.Discard)
|
||||||
|
registerConfigSelectionFlags(fs, &cfg.configPath, &cfg.configOverlay)
|
||||||
|
fs.StringVar(&cfg.profileDir, "profile-dir", "", "directory containing execution profiles")
|
||||||
|
fs.StringVar(&cfg.profileID, "profile", "", "profile ID to inspect")
|
||||||
|
rawFormat := ""
|
||||||
|
fs.StringVar(&rawFormat, "format", "", "output format: text or json")
|
||||||
|
fs.StringVar(&cfg.outputPath, "out", "", "optional output file path")
|
||||||
|
if err := fs.Parse(args); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
cfg.configExplicit = flagWasSet(fs, "config")
|
||||||
|
cfg.overrides = applicationOverrides(fs)
|
||||||
|
if fs.NArg() > 0 {
|
||||||
|
return nil, fmt.Errorf("unexpected positional args: %v", fs.Args())
|
||||||
|
}
|
||||||
|
if strings.TrimSpace(cfg.profileID) == "" {
|
||||||
|
return nil, errors.New("--profile is required")
|
||||||
|
}
|
||||||
|
format, err := appformat.ParseOutputFormat(rawFormat)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
cfg.outputFormat = format
|
||||||
|
if cfg.outputPath != "" {
|
||||||
|
cfg.outputPath = filepath.Clean(cfg.outputPath)
|
||||||
|
}
|
||||||
|
return cfg, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func resolveAppSettingsForProfileInspection(cfg *profileInspectionConfig) (engineSettings, error) {
|
||||||
|
settings, diagnostics, err := loadApplicationSettings(cfg.configPath, cfg.configOverlay, cfg.configExplicit, cfg.overrides)
|
||||||
|
if err != nil {
|
||||||
|
return engineSettings{}, err
|
||||||
|
}
|
||||||
|
cfg.diagnostics = diagnostics
|
||||||
|
return engineSettings{profileDir: settings.ProfileDir, backends: settings.Backends, transientRetries: settings.TransientRetries}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func parsePromptInspectionArgs(args []string) (*promptInspectionConfig, error) {
|
||||||
|
cfg := &promptInspectionConfig{outputFormat: appformat.DefaultOutputFormat}
|
||||||
|
fs := flag.NewFlagSet("inspect prompt", flag.ContinueOnError)
|
||||||
|
fs.SetOutput(io.Discard)
|
||||||
|
registerConfigSelectionFlags(fs, &cfg.configPath, &cfg.configOverlay)
|
||||||
|
fs.StringVar(&cfg.promptDir, "prompt-dir", "", "directory containing prompt definitions")
|
||||||
|
fs.StringVar(&cfg.promptID, "prompt", "", "prompt ID to inspect")
|
||||||
|
fs.StringVar(&cfg.promptVersion, "prompt-version", "", "optional prompt version")
|
||||||
|
rawFormat := ""
|
||||||
|
fs.StringVar(&rawFormat, "format", "", "output format: text or json")
|
||||||
|
fs.StringVar(&cfg.outputPath, "out", "", "optional output file path")
|
||||||
|
if err := fs.Parse(args); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
cfg.configExplicit = flagWasSet(fs, "config")
|
||||||
|
cfg.overrides = applicationOverrides(fs)
|
||||||
|
if fs.NArg() > 0 {
|
||||||
|
return nil, fmt.Errorf("unexpected positional args: %v", fs.Args())
|
||||||
|
}
|
||||||
|
if strings.TrimSpace(cfg.promptID) == "" {
|
||||||
|
return nil, errors.New("--prompt is required")
|
||||||
|
}
|
||||||
|
format, err := appformat.ParseOutputFormat(rawFormat)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
cfg.outputFormat = format
|
||||||
|
if cfg.outputPath != "" {
|
||||||
|
cfg.outputPath = filepath.Clean(cfg.outputPath)
|
||||||
|
}
|
||||||
|
return cfg, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func resolveAppSettingsForPromptInspection(cfg *promptInspectionConfig) (engineSettings, error) {
|
||||||
|
settings, diagnostics, err := loadApplicationSettings(cfg.configPath, cfg.configOverlay, cfg.configExplicit, cfg.overrides)
|
||||||
|
if err != nil {
|
||||||
|
return engineSettings{}, err
|
||||||
|
}
|
||||||
|
cfg.diagnostics = diagnostics
|
||||||
|
if strings.TrimSpace(settings.PromptDir) == "" {
|
||||||
|
return engineSettings{}, errors.New(errPromptDirRequired)
|
||||||
|
}
|
||||||
|
return engineSettings{promptDir: settings.PromptDir, backends: settings.Backends, transientRetries: settings.TransientRetries}, nil
|
||||||
|
}
|
||||||
@@ -2,6 +2,7 @@ package cli
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
"context"
|
||||||
|
"encoding/json"
|
||||||
"errors"
|
"errors"
|
||||||
"flag"
|
"flag"
|
||||||
"fmt"
|
"fmt"
|
||||||
@@ -12,18 +13,13 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
||||||
|
"gitea.maximumdirect.net/eric/promptkit"
|
||||||
httpadapter "gitea.maximumdirect.net/eric/scriptorium/internal/adapter/http"
|
httpadapter "gitea.maximumdirect.net/eric/scriptorium/internal/adapter/http"
|
||||||
artifactadapter "gitea.maximumdirect.net/eric/scriptorium/internal/artifact"
|
|
||||||
appconfig "gitea.maximumdirect.net/eric/scriptorium/internal/config"
|
appconfig "gitea.maximumdirect.net/eric/scriptorium/internal/config"
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/defaults"
|
"gitea.maximumdirect.net/eric/scriptorium/internal/defaults"
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/domain"
|
|
||||||
renderformat "gitea.maximumdirect.net/eric/scriptorium/internal/format"
|
renderformat "gitea.maximumdirect.net/eric/scriptorium/internal/format"
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/llm"
|
executionreport "gitea.maximumdirect.net/eric/scriptorium/internal/report"
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/profile/builtin"
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/prompt"
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/promptdef"
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/usecase"
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/validate"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@@ -39,31 +35,43 @@ const (
|
|||||||
type runConfig struct {
|
type runConfig struct {
|
||||||
configPath string
|
configPath string
|
||||||
|
|
||||||
promptDir string
|
promptDir string
|
||||||
profileDir string
|
profileDir string
|
||||||
promptID string
|
promptID string
|
||||||
profileID string
|
promptVersion string
|
||||||
inputRaw listFlag
|
profileID string
|
||||||
varRaw listFlag
|
sessionID string
|
||||||
outputPath string
|
inputRaw listFlag
|
||||||
llmBaseURL string
|
varRaw listFlag
|
||||||
apiKeyEnv string
|
outputPath string
|
||||||
model string
|
executionReportPath string
|
||||||
temperature float64
|
llmBaseURL string
|
||||||
maxTokens int
|
apiKeyEnv string
|
||||||
topP float64
|
model string
|
||||||
schemaDir string
|
temperature float64
|
||||||
timeout time.Duration
|
maxTokens int
|
||||||
|
topP float64
|
||||||
|
reasoningEffort string
|
||||||
|
schemaDir string
|
||||||
|
backends []appconfig.BackendSettings
|
||||||
|
timeout time.Duration
|
||||||
|
runTimeout time.Duration
|
||||||
|
transientRetries int
|
||||||
|
configuredTransientRetries *int
|
||||||
|
diagnostics []configkit.Diagnostic
|
||||||
|
configOverlay string
|
||||||
|
|
||||||
defaultRenderFormat renderformat.PreparedRunOutputFormat
|
defaultRenderFormat renderformat.PreparedRunOutputFormat
|
||||||
|
|
||||||
llmBaseURLSet bool
|
llmBaseURLSet bool
|
||||||
apiKeyEnvSet bool
|
apiKeyEnvSet bool
|
||||||
modelSet bool
|
modelSet bool
|
||||||
temperatureSet bool
|
temperatureSet bool
|
||||||
maxTokensSet bool
|
maxTokensSet bool
|
||||||
topPSet bool
|
topPSet bool
|
||||||
timeoutSet bool
|
reasoningEffortSet bool
|
||||||
|
timeoutSet bool
|
||||||
|
transientRetriesSet bool
|
||||||
}
|
}
|
||||||
|
|
||||||
type renderConfig struct {
|
type renderConfig struct {
|
||||||
@@ -82,6 +90,10 @@ type serveConfig struct {
|
|||||||
maxRequestBytes int64
|
maxRequestBytes int64
|
||||||
maxArtifactBytes int64
|
maxArtifactBytes int64
|
||||||
maxResponseBytes int64
|
maxResponseBytes int64
|
||||||
|
backends []appconfig.BackendSettings
|
||||||
|
transientRetries *int
|
||||||
|
diagnostics []configkit.Diagnostic
|
||||||
|
configOverlay string
|
||||||
}
|
}
|
||||||
|
|
||||||
type commonCommandSettings struct {
|
type commonCommandSettings struct {
|
||||||
@@ -94,6 +106,9 @@ type commonCommandSettings struct {
|
|||||||
maxArtifactBytes int64
|
maxArtifactBytes int64
|
||||||
maxResponseBytes int64
|
maxResponseBytes int64
|
||||||
defaultRenderFormat renderformat.PreparedRunOutputFormat
|
defaultRenderFormat renderformat.PreparedRunOutputFormat
|
||||||
|
backends []appconfig.BackendSettings
|
||||||
|
transientRetries *int
|
||||||
|
diagnostics []configkit.Diagnostic
|
||||||
}
|
}
|
||||||
|
|
||||||
type listFlag []string
|
type listFlag []string
|
||||||
@@ -120,6 +135,10 @@ func Run(args []string, stdout, stderr io.Writer) int {
|
|||||||
return renderCommand(args[1:], stdout, stderr)
|
return renderCommand(args[1:], stdout, stderr)
|
||||||
case "serve":
|
case "serve":
|
||||||
return serveCommand(args[1:], stderr)
|
return serveCommand(args[1:], stderr)
|
||||||
|
case "inspect":
|
||||||
|
return inspectCommand(args[1:], stdout, stderr)
|
||||||
|
case "config":
|
||||||
|
return configCommand(args[1:], stdout, stderr)
|
||||||
default:
|
default:
|
||||||
fmt.Fprintf(stderr, "unknown command %q\n", args[0])
|
fmt.Fprintf(stderr, "unknown command %q\n", args[0])
|
||||||
printUsage(stderr)
|
printUsage(stderr)
|
||||||
@@ -130,7 +149,10 @@ func Run(args []string, stdout, stderr io.Writer) int {
|
|||||||
func runCommand(args []string, stdout, stderr io.Writer) int {
|
func runCommand(args []string, stdout, stderr io.Writer) int {
|
||||||
cfg, err := parseRunArgs(args)
|
cfg, err := parseRunArgs(args)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
fmt.Fprintf(stderr, "run parse error: %v\n", err)
|
writeApplicationError(stderr, "run parse", err)
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
if err := writeApplicationWarnings(stderr, cfg.diagnostics); err != nil {
|
||||||
return ExitRuntimeError
|
return ExitRuntimeError
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -140,22 +162,53 @@ func runCommand(args []string, stdout, stderr io.Writer) int {
|
|||||||
return ExitRuntimeError
|
return ExitRuntimeError
|
||||||
}
|
}
|
||||||
|
|
||||||
llmClient, err := newOpenAIClient()
|
engine, err := newEngine(cfg.engineSettings())
|
||||||
if err != nil {
|
if err != nil {
|
||||||
fmt.Fprintf(stderr, "llm client error: %v\n", err)
|
fmt.Fprintf(stderr, "engine error: %v\n", err)
|
||||||
return ExitRuntimeError
|
return ExitRuntimeError
|
||||||
}
|
}
|
||||||
|
return executeRun(cfg, req, engine.Run, stdout, stderr)
|
||||||
|
}
|
||||||
|
|
||||||
runner := newRunner(cfg.promptDir, cfg.profileDir, cfg.schemaDir, llmClient)
|
func executeRun(cfg *runConfig, req promptkit.RunRequest, run func(context.Context, promptkit.RunRequest) (*promptkit.RunResult, error), stdout, stderr io.Writer) int {
|
||||||
|
var collector *executionreport.Collector
|
||||||
res, runErr := runner.Run(context.Background(), req)
|
if cfg.executionReportPath != "" {
|
||||||
|
collector = executionreport.NewCollector()
|
||||||
|
req.Observer = collector.Observe
|
||||||
|
}
|
||||||
|
runContext := context.Background()
|
||||||
|
cancel := func() {}
|
||||||
|
if cfg.runTimeout > 0 {
|
||||||
|
runContext, cancel = context.WithTimeout(runContext, cfg.runTimeout)
|
||||||
|
}
|
||||||
|
res, runErr := run(runContext, req)
|
||||||
|
contextErr := runContext.Err()
|
||||||
|
cancel()
|
||||||
if runErr != nil {
|
if runErr != nil {
|
||||||
fmt.Fprintf(stderr, "run error: %v\n", runErr)
|
if errors.Is(contextErr, context.DeadlineExceeded) {
|
||||||
return ExitRuntimeError
|
fmt.Fprintln(stderr, "run error: execution deadline exceeded")
|
||||||
|
} else {
|
||||||
|
fmt.Fprintln(stderr, runErrorMessage(runErr))
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := writeOutput(stdout, cfg.outputPath, res.Artifact.Body); err != nil {
|
outputFailed := false
|
||||||
fmt.Fprintf(stderr, "output write error: %v\n", err)
|
if runErr == nil {
|
||||||
|
if err := writeOutput(stdout, cfg.outputPath, res.Artifact.Body); err != nil {
|
||||||
|
fmt.Fprintf(stderr, "output write error: %v\n", err)
|
||||||
|
outputFailed = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
reportFailed := false
|
||||||
|
if collector != nil {
|
||||||
|
if value := collector.Snapshot(); value == nil {
|
||||||
|
fmt.Fprintln(stderr, "execution report not produced: no terminal observation")
|
||||||
|
} else if err := writeExecutionReport(cfg.executionReportPath, value); err != nil {
|
||||||
|
fmt.Fprintf(stderr, "execution report write error: %v\n", err)
|
||||||
|
reportFailed = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if runErr != nil || outputFailed || reportFailed {
|
||||||
return ExitRuntimeError
|
return ExitRuntimeError
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -163,10 +216,21 @@ func runCommand(args []string, stdout, stderr io.Writer) int {
|
|||||||
return determineExitCode(nil, res)
|
return determineExitCode(nil, res)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func writeExecutionReport(path string, value *executionreport.Execution) error {
|
||||||
|
data, err := json.Marshal(value)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
return os.WriteFile(path, append(data, '\n'), 0644)
|
||||||
|
}
|
||||||
|
|
||||||
func renderCommand(args []string, stdout, stderr io.Writer) int {
|
func renderCommand(args []string, stdout, stderr io.Writer) int {
|
||||||
cfg, err := parseRenderArgs(args)
|
cfg, err := parseRenderArgs(args)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
fmt.Fprintf(stderr, "render parse error: %v\n", err)
|
writeApplicationError(stderr, "render parse", err)
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
if err := writeApplicationWarnings(stderr, cfg.diagnostics); err != nil {
|
||||||
return ExitRuntimeError
|
return ExitRuntimeError
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -176,9 +240,13 @@ func renderCommand(args []string, stdout, stderr io.Writer) int {
|
|||||||
return ExitRuntimeError
|
return ExitRuntimeError
|
||||||
}
|
}
|
||||||
|
|
||||||
runner := newRunner(cfg.promptDir, cfg.profileDir, cfg.schemaDir, nil)
|
engine, err := newEngine(cfg.runConfig.engineSettings())
|
||||||
|
if err != nil {
|
||||||
|
fmt.Fprintf(stderr, "engine error: %v\n", err)
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
|
||||||
prepared, prepErr := runner.Prepare(context.Background(), req)
|
prepared, prepErr := engine.Prepare(context.Background(), req)
|
||||||
if prepErr != nil {
|
if prepErr != nil {
|
||||||
fmt.Fprintf(stderr, "render error: %v\n", prepErr)
|
fmt.Fprintf(stderr, "render error: %v\n", prepErr)
|
||||||
return ExitRuntimeError
|
return ExitRuntimeError
|
||||||
@@ -200,25 +268,26 @@ func renderCommand(args []string, stdout, stderr io.Writer) int {
|
|||||||
func serveCommand(args []string, stderr io.Writer) int {
|
func serveCommand(args []string, stderr io.Writer) int {
|
||||||
cfg, err := parseServeArgs(args)
|
cfg, err := parseServeArgs(args)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
fmt.Fprintf(stderr, "serve parse error: %v\n", err)
|
writeApplicationError(stderr, "serve parse", err)
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
if err := writeApplicationWarnings(stderr, cfg.diagnostics); err != nil {
|
||||||
return ExitRuntimeError
|
return ExitRuntimeError
|
||||||
}
|
}
|
||||||
|
|
||||||
llmClient, err := newOpenAIClient()
|
artifactReader, err := httpadapter.NewRestrictedArtifactReader(cfg.artifactRoot, cfg.maxArtifactBytes)
|
||||||
if err != nil {
|
|
||||||
fmt.Fprintf(stderr, "llm client error: %v\n", err)
|
|
||||||
return ExitRuntimeError
|
|
||||||
}
|
|
||||||
|
|
||||||
artifactReader, err := artifactadapter.NewRestrictedCompositeReaderWithLimit(cfg.artifactRoot, cfg.maxArtifactBytes)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
fmt.Fprintf(stderr, "artifact root error: %v\n", err)
|
fmt.Fprintf(stderr, "artifact root error: %v\n", err)
|
||||||
return ExitRuntimeError
|
return ExitRuntimeError
|
||||||
}
|
}
|
||||||
|
|
||||||
runner := newRunnerWithArtifactReader(cfg.promptDir, cfg.profileDir, cfg.schemaDir, llmClient, artifactReader)
|
engine, err := newEngine(cfg.engineSettings(), promptkit.WithArtifactReader(artifactReader))
|
||||||
|
if err != nil {
|
||||||
|
fmt.Fprintf(stderr, "engine error: %v\n", err)
|
||||||
|
return ExitRuntimeError
|
||||||
|
}
|
||||||
|
|
||||||
h := httpadapter.NewHandlerWithOptions(runner, httpadapter.HandlerOptions{
|
h := httpadapter.NewHandlerWithOptions(engine, httpadapter.HandlerOptions{
|
||||||
MaxRequestBytes: cfg.maxRequestBytes,
|
MaxRequestBytes: cfg.maxRequestBytes,
|
||||||
MaxResponseBytes: cfg.maxResponseBytes,
|
MaxResponseBytes: cfg.maxResponseBytes,
|
||||||
})
|
})
|
||||||
@@ -241,9 +310,11 @@ func parseRunArgs(args []string) (*runConfig, error) {
|
|||||||
fs := flag.NewFlagSet("run", flag.ContinueOnError)
|
fs := flag.NewFlagSet("run", flag.ContinueOnError)
|
||||||
fs.SetOutput(io.Discard)
|
fs.SetOutput(io.Discard)
|
||||||
|
|
||||||
registerConfigPathFlag(fs, &cfg.configPath)
|
registerConfigSelectionFlags(fs, &cfg.configPath, &cfg.configOverlay)
|
||||||
registerExecutionRequestFlags(fs, cfg)
|
registerExecutionRequestFlags(fs, cfg)
|
||||||
fs.StringVar(&cfg.schemaDir, "schema-dir", "", "base directory for validation schemas")
|
fs.StringVar(&cfg.schemaDir, "schema-dir", "", "base directory for validation schemas")
|
||||||
|
fs.DurationVar(&cfg.runTimeout, "run-timeout", 0, "whole-run execution deadline")
|
||||||
|
fs.StringVar(&cfg.executionReportPath, "execution-report", "", "JSON execution report file path")
|
||||||
|
|
||||||
if err := fs.Parse(args); err != nil {
|
if err := fs.Parse(args); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
@@ -251,11 +322,44 @@ func parseRunArgs(args []string) (*runConfig, error) {
|
|||||||
if err := finalizeExecutionRequestConfig(fs, cfg); err != nil {
|
if err := finalizeExecutionRequestConfig(fs, cfg); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
cfg.schemaDir = filepath.Clean(cfg.schemaDir)
|
if cfg.runTimeout < 0 {
|
||||||
|
return nil, errors.New("--run-timeout must be greater than or equal to 0")
|
||||||
|
}
|
||||||
|
if flagWasSet(fs, "execution-report") {
|
||||||
|
if cfg.executionReportPath == "" {
|
||||||
|
return nil, errors.New("--execution-report requires a nonempty path")
|
||||||
|
}
|
||||||
|
cfg.executionReportPath = filepath.Clean(cfg.executionReportPath)
|
||||||
|
if cfg.outputPath != "" {
|
||||||
|
collision, err := outputPathsCollide(cfg.outputPath, cfg.executionReportPath)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if collision {
|
||||||
|
return nil, errors.New("--out and --execution-report select the same file")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
return cfg, nil
|
return cfg, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func outputPathsCollide(first, second string) (bool, error) {
|
||||||
|
firstAbs, err := filepath.Abs(first)
|
||||||
|
if err != nil {
|
||||||
|
return false, err
|
||||||
|
}
|
||||||
|
secondAbs, err := filepath.Abs(second)
|
||||||
|
if err != nil {
|
||||||
|
return false, err
|
||||||
|
}
|
||||||
|
if firstAbs == secondAbs {
|
||||||
|
return true, nil
|
||||||
|
}
|
||||||
|
firstInfo, firstErr := os.Stat(firstAbs)
|
||||||
|
secondInfo, secondErr := os.Stat(secondAbs)
|
||||||
|
return firstErr == nil && secondErr == nil && os.SameFile(firstInfo, secondInfo), nil
|
||||||
|
}
|
||||||
|
|
||||||
func parseRenderArgs(args []string) (*renderConfig, error) {
|
func parseRenderArgs(args []string) (*renderConfig, error) {
|
||||||
cfg := &renderConfig{
|
cfg := &renderConfig{
|
||||||
outputFormat: renderformat.DefaultPreparedRunOutputFormat,
|
outputFormat: renderformat.DefaultPreparedRunOutputFormat,
|
||||||
@@ -263,8 +367,9 @@ func parseRenderArgs(args []string) (*renderConfig, error) {
|
|||||||
fs := flag.NewFlagSet("render", flag.ContinueOnError)
|
fs := flag.NewFlagSet("render", flag.ContinueOnError)
|
||||||
fs.SetOutput(io.Discard)
|
fs.SetOutput(io.Discard)
|
||||||
|
|
||||||
registerConfigPathFlag(fs, &cfg.configPath)
|
registerConfigSelectionFlags(fs, &cfg.configPath, &cfg.configOverlay)
|
||||||
registerExecutionRequestFlags(fs, &cfg.runConfig)
|
registerExecutionRequestFlags(fs, &cfg.runConfig)
|
||||||
|
fs.StringVar(&cfg.schemaDir, "schema-dir", "", "base directory for validation schemas")
|
||||||
|
|
||||||
var rawFormat string
|
var rawFormat string
|
||||||
fs.StringVar(&rawFormat, "format", "", "render output format (text|json)")
|
fs.StringVar(&rawFormat, "format", "", "render output format (text|json)")
|
||||||
@@ -293,7 +398,7 @@ func parseServeArgs(args []string) (*serveConfig, error) {
|
|||||||
fs := flag.NewFlagSet("serve", flag.ContinueOnError)
|
fs := flag.NewFlagSet("serve", flag.ContinueOnError)
|
||||||
fs.SetOutput(io.Discard)
|
fs.SetOutput(io.Discard)
|
||||||
|
|
||||||
registerConfigPathFlag(fs, &cfg.configPath)
|
registerConfigSelectionFlags(fs, &cfg.configPath, &cfg.configOverlay)
|
||||||
fs.StringVar(&cfg.addr, "addr", "", "HTTP listen address")
|
fs.StringVar(&cfg.addr, "addr", "", "HTTP listen address")
|
||||||
fs.StringVar(&cfg.promptDir, "prompt-dir", "", "directory containing prompt definition YAML files")
|
fs.StringVar(&cfg.promptDir, "prompt-dir", "", "directory containing prompt definition YAML files")
|
||||||
fs.StringVar(&cfg.profileDir, "profile-dir", "", "directory containing execution profile YAML files")
|
fs.StringVar(&cfg.profileDir, "profile-dir", "", "directory containing execution profile YAML files")
|
||||||
@@ -310,16 +415,7 @@ func parseServeArgs(args []string) (*serveConfig, error) {
|
|||||||
return nil, fmt.Errorf("unexpected positional args: %v", fs.Args())
|
return nil, fmt.Errorf("unexpected positional args: %v", fs.Args())
|
||||||
}
|
}
|
||||||
|
|
||||||
settings, err := resolveCommonSettings(fs, cfg.configPath, appconfig.CLIOverrides{
|
settings, err := resolveCommonSettings(fs, cfg.configPath, cfg.configOverlay)
|
||||||
PromptDir: cfg.promptDirIfSet(fs),
|
|
||||||
ProfileDir: cfg.profileDirIfSet(fs),
|
|
||||||
SchemaDir: cfg.schemaDirIfSet(fs),
|
|
||||||
ServerAddr: cfg.addrIfSet(fs),
|
|
||||||
ArtifactRoot: cfg.artifactRootIfSet(fs),
|
|
||||||
MaxRequestBytes: cfg.maxRequestBytesIfSet(fs),
|
|
||||||
MaxArtifactBytes: cfg.maxArtifactBytesIfSet(fs),
|
|
||||||
MaxResponseBytes: cfg.maxResponseBytesIfSet(fs),
|
|
||||||
})
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
@@ -332,19 +428,14 @@ func parseServeArgs(args []string) (*serveConfig, error) {
|
|||||||
cfg.maxRequestBytes = settings.maxRequestBytes
|
cfg.maxRequestBytes = settings.maxRequestBytes
|
||||||
cfg.maxArtifactBytes = settings.maxArtifactBytes
|
cfg.maxArtifactBytes = settings.maxArtifactBytes
|
||||||
cfg.maxResponseBytes = settings.maxResponseBytes
|
cfg.maxResponseBytes = settings.maxResponseBytes
|
||||||
|
cfg.backends = settings.backends
|
||||||
|
cfg.transientRetries = settings.transientRetries
|
||||||
|
cfg.diagnostics = settings.diagnostics
|
||||||
|
|
||||||
if err := validateRequiredLibraryDirs(cfg.promptDir); err != nil {
|
if err := validateRequiredLibraryDirs(cfg.promptDir); err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
cfg.promptDir = filepath.Clean(cfg.promptDir)
|
|
||||||
if strings.TrimSpace(cfg.profileDir) != "" {
|
|
||||||
cfg.profileDir = filepath.Clean(cfg.profileDir)
|
|
||||||
}
|
|
||||||
cfg.schemaDir = filepath.Clean(cfg.schemaDir)
|
|
||||||
if strings.TrimSpace(cfg.artifactRoot) != "" {
|
|
||||||
cfg.artifactRoot = filepath.Clean(cfg.artifactRoot)
|
|
||||||
}
|
|
||||||
return cfg, nil
|
return cfg, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -352,7 +443,9 @@ func registerExecutionRequestFlags(fs *flag.FlagSet, cfg *runConfig) {
|
|||||||
fs.StringVar(&cfg.promptDir, "prompt-dir", "", "directory containing prompt definition YAML files")
|
fs.StringVar(&cfg.promptDir, "prompt-dir", "", "directory containing prompt definition YAML files")
|
||||||
fs.StringVar(&cfg.profileDir, "profile-dir", "", "directory containing execution profile YAML files")
|
fs.StringVar(&cfg.profileDir, "profile-dir", "", "directory containing execution profile YAML files")
|
||||||
fs.StringVar(&cfg.promptID, "prompt", "", "prompt ID to run")
|
fs.StringVar(&cfg.promptID, "prompt", "", "prompt ID to run")
|
||||||
|
fs.StringVar(&cfg.promptVersion, "prompt-version", "", "optional prompt definition version")
|
||||||
fs.StringVar(&cfg.profileID, "profile", "", "optional execution profile ID; if omitted, prompt default_profile is used")
|
fs.StringVar(&cfg.profileID, "profile", "", "optional execution profile ID; if omitted, prompt default_profile is used")
|
||||||
|
fs.StringVar(&cfg.sessionID, "session-id", "", "optional session ID")
|
||||||
fs.Var(&cfg.inputRaw, "input", "input mapping(s): name=path (repeatable, comma-separated)")
|
fs.Var(&cfg.inputRaw, "input", "input mapping(s): name=path (repeatable, comma-separated)")
|
||||||
fs.Var(&cfg.varRaw, "var", "variable mapping(s): name=value (repeatable, comma-separated)")
|
fs.Var(&cfg.varRaw, "var", "variable mapping(s): name=value (repeatable, comma-separated)")
|
||||||
fs.StringVar(&cfg.outputPath, "out", "", "optional output file path")
|
fs.StringVar(&cfg.outputPath, "out", "", "optional output file path")
|
||||||
@@ -362,7 +455,9 @@ func registerExecutionRequestFlags(fs *flag.FlagSet, cfg *runConfig) {
|
|||||||
fs.Float64Var(&cfg.temperature, "temperature", 0, "optional temperature override")
|
fs.Float64Var(&cfg.temperature, "temperature", 0, "optional temperature override")
|
||||||
fs.IntVar(&cfg.maxTokens, "max-tokens", 0, "optional max tokens override")
|
fs.IntVar(&cfg.maxTokens, "max-tokens", 0, "optional max tokens override")
|
||||||
fs.Float64Var(&cfg.topP, "top-p", 0, "optional top_p override")
|
fs.Float64Var(&cfg.topP, "top-p", 0, "optional top_p override")
|
||||||
fs.DurationVar(&cfg.timeout, "timeout", defaults.LLMRequestTimeoutDefault, "LLM request timeout")
|
fs.StringVar(&cfg.reasoningEffort, "reasoning-effort", "", "optional reasoning effort override")
|
||||||
|
fs.DurationVar(&cfg.timeout, "timeout", 0, "LLM request timeout")
|
||||||
|
fs.IntVar(&cfg.transientRetries, "transient-retries", 0, "additional transient generation attempts")
|
||||||
fs.StringVar(&cfg.promptID, "prompt-id", "", "deprecated alias for --prompt")
|
fs.StringVar(&cfg.promptID, "prompt-id", "", "deprecated alias for --prompt")
|
||||||
fs.StringVar(&cfg.profileID, "profile-id", "", "deprecated alias for --profile")
|
fs.StringVar(&cfg.profileID, "profile-id", "", "deprecated alias for --profile")
|
||||||
}
|
}
|
||||||
@@ -372,11 +467,7 @@ func finalizeExecutionRequestConfig(fs *flag.FlagSet, cfg *runConfig) error {
|
|||||||
return fmt.Errorf("unexpected positional args: %v", fs.Args())
|
return fmt.Errorf("unexpected positional args: %v", fs.Args())
|
||||||
}
|
}
|
||||||
|
|
||||||
settings, err := resolveCommonSettings(fs, cfg.configPath, appconfig.CLIOverrides{
|
settings, err := resolveCommonSettings(fs, cfg.configPath, cfg.configOverlay)
|
||||||
PromptDir: cfg.promptDirIfSet(fs),
|
|
||||||
ProfileDir: cfg.profileDirIfSet(fs),
|
|
||||||
SchemaDir: cfg.schemaDirIfSet(fs),
|
|
||||||
})
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
@@ -385,6 +476,9 @@ func finalizeExecutionRequestConfig(fs *flag.FlagSet, cfg *runConfig) error {
|
|||||||
cfg.profileDir = settings.profileDir
|
cfg.profileDir = settings.profileDir
|
||||||
cfg.schemaDir = settings.schemaDir
|
cfg.schemaDir = settings.schemaDir
|
||||||
cfg.defaultRenderFormat = settings.defaultRenderFormat
|
cfg.defaultRenderFormat = settings.defaultRenderFormat
|
||||||
|
cfg.backends = settings.backends
|
||||||
|
cfg.configuredTransientRetries = settings.transientRetries
|
||||||
|
cfg.diagnostics = settings.diagnostics
|
||||||
|
|
||||||
if err := validateRequiredLibraryDirs(cfg.promptDir); err != nil {
|
if err := validateRequiredLibraryDirs(cfg.promptDir); err != nil {
|
||||||
return err
|
return err
|
||||||
@@ -392,13 +486,6 @@ func finalizeExecutionRequestConfig(fs *flag.FlagSet, cfg *runConfig) error {
|
|||||||
if strings.TrimSpace(cfg.promptID) == "" {
|
if strings.TrimSpace(cfg.promptID) == "" {
|
||||||
return errors.New("--prompt is required")
|
return errors.New("--prompt is required")
|
||||||
}
|
}
|
||||||
if len(cfg.inputRaw) == 0 {
|
|
||||||
return errors.New("at least one --input is required")
|
|
||||||
}
|
|
||||||
cfg.promptDir = filepath.Clean(cfg.promptDir)
|
|
||||||
if strings.TrimSpace(cfg.profileDir) != "" {
|
|
||||||
cfg.profileDir = filepath.Clean(cfg.profileDir)
|
|
||||||
}
|
|
||||||
if cfg.outputPath != "" {
|
if cfg.outputPath != "" {
|
||||||
cfg.outputPath = filepath.Clean(cfg.outputPath)
|
cfg.outputPath = filepath.Clean(cfg.outputPath)
|
||||||
}
|
}
|
||||||
@@ -408,88 +495,16 @@ func finalizeExecutionRequestConfig(fs *flag.FlagSet, cfg *runConfig) error {
|
|||||||
cfg.temperatureSet = flagWasSet(fs, "temperature")
|
cfg.temperatureSet = flagWasSet(fs, "temperature")
|
||||||
cfg.maxTokensSet = flagWasSet(fs, "max-tokens")
|
cfg.maxTokensSet = flagWasSet(fs, "max-tokens")
|
||||||
cfg.topPSet = flagWasSet(fs, "top-p")
|
cfg.topPSet = flagWasSet(fs, "top-p")
|
||||||
|
cfg.reasoningEffortSet = flagWasSet(fs, "reasoning-effort")
|
||||||
cfg.timeoutSet = flagWasSet(fs, "timeout")
|
cfg.timeoutSet = flagWasSet(fs, "timeout")
|
||||||
return nil
|
cfg.transientRetriesSet = flagWasSet(fs, "transient-retries")
|
||||||
}
|
if cfg.transientRetriesSet && cfg.transientRetries < 0 {
|
||||||
|
return errors.New("--transient-retries must be greater than or equal to 0")
|
||||||
func (c *runConfig) promptDirIfSet(fs *flag.FlagSet) string {
|
|
||||||
if flagWasSet(fs, "prompt-dir") {
|
|
||||||
return c.promptDir
|
|
||||||
}
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *runConfig) profileDirIfSet(fs *flag.FlagSet) string {
|
|
||||||
if flagWasSet(fs, "profile-dir") {
|
|
||||||
return c.profileDir
|
|
||||||
}
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *runConfig) schemaDirIfSet(fs *flag.FlagSet) string {
|
|
||||||
if flagWasSet(fs, "schema-dir") {
|
|
||||||
return c.schemaDir
|
|
||||||
}
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *serveConfig) promptDirIfSet(fs *flag.FlagSet) string {
|
|
||||||
if flagWasSet(fs, "prompt-dir") {
|
|
||||||
return c.promptDir
|
|
||||||
}
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *serveConfig) profileDirIfSet(fs *flag.FlagSet) string {
|
|
||||||
if flagWasSet(fs, "profile-dir") {
|
|
||||||
return c.profileDir
|
|
||||||
}
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *serveConfig) schemaDirIfSet(fs *flag.FlagSet) string {
|
|
||||||
if flagWasSet(fs, "schema-dir") {
|
|
||||||
return c.schemaDir
|
|
||||||
}
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *serveConfig) addrIfSet(fs *flag.FlagSet) string {
|
|
||||||
if flagWasSet(fs, "addr") {
|
|
||||||
return c.addr
|
|
||||||
}
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *serveConfig) artifactRootIfSet(fs *flag.FlagSet) string {
|
|
||||||
if flagWasSet(fs, "artifact-root") {
|
|
||||||
return c.artifactRoot
|
|
||||||
}
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *serveConfig) maxRequestBytesIfSet(fs *flag.FlagSet) *int64 {
|
|
||||||
if flagWasSet(fs, "max-request-bytes") {
|
|
||||||
return &c.maxRequestBytes
|
|
||||||
}
|
}
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (c *serveConfig) maxArtifactBytesIfSet(fs *flag.FlagSet) *int64 {
|
func registerConfigSelectionFlags(fs *flag.FlagSet, target, overlay *string) {
|
||||||
if flagWasSet(fs, "max-artifact-bytes") {
|
|
||||||
return &c.maxArtifactBytes
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *serveConfig) maxResponseBytesIfSet(fs *flag.FlagSet) *int64 {
|
|
||||||
if flagWasSet(fs, "max-response-bytes") {
|
|
||||||
return &c.maxResponseBytes
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func registerConfigPathFlag(fs *flag.FlagSet, target *string) {
|
|
||||||
fs.StringVar(
|
fs.StringVar(
|
||||||
target,
|
target,
|
||||||
"config",
|
"config",
|
||||||
@@ -500,24 +515,11 @@ func registerConfigPathFlag(fs *flag.FlagSet, target *string) {
|
|||||||
appconfig.DefaultConfigPath,
|
appconfig.DefaultConfigPath,
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
|
fs.StringVar(overlay, "config-overlay", "", "selected application configuration overlay")
|
||||||
}
|
}
|
||||||
|
|
||||||
func resolveAppSettings(fs *flag.FlagSet, configPath string, overrides appconfig.CLIOverrides) (appconfig.AppSettings, error) {
|
func resolveCommonSettings(fs *flag.FlagSet, configPath, overlay string) (commonCommandSettings, error) {
|
||||||
settings, err := appconfig.LoadConfig(configPath, flagWasSet(fs, "config"))
|
settings, diagnostics, err := loadApplicationSettings(configPath, overlay, flagWasSet(fs, "config"), applicationOverrides(fs))
|
||||||
if err != nil {
|
|
||||||
return appconfig.AppSettings{}, fmt.Errorf("application config error: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
merged, err := appconfig.ApplyCLIOverrides(settings, overrides)
|
|
||||||
if err != nil {
|
|
||||||
return appconfig.AppSettings{}, fmt.Errorf("application config error: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return merged, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func resolveCommonSettings(fs *flag.FlagSet, configPath string, overrides appconfig.CLIOverrides) (commonCommandSettings, error) {
|
|
||||||
settings, err := resolveAppSettings(fs, configPath, overrides)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return commonCommandSettings{}, err
|
return commonCommandSettings{}, err
|
||||||
}
|
}
|
||||||
@@ -531,6 +533,9 @@ func resolveCommonSettings(fs *flag.FlagSet, configPath string, overrides appcon
|
|||||||
maxArtifactBytes: settings.MaxArtifactBytes,
|
maxArtifactBytes: settings.MaxArtifactBytes,
|
||||||
maxResponseBytes: settings.MaxResponseBytes,
|
maxResponseBytes: settings.MaxResponseBytes,
|
||||||
defaultRenderFormat: settings.DefaultRenderFormat,
|
defaultRenderFormat: settings.DefaultRenderFormat,
|
||||||
|
backends: settings.Backends,
|
||||||
|
transientRetries: settings.TransientRetries,
|
||||||
|
diagnostics: diagnostics,
|
||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -541,52 +546,76 @@ func validateRequiredLibraryDirs(promptDir string) error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func newRunner(promptDir, profileDir, schemaDir string, llmClient llm.Client) *usecase.Runner {
|
type engineSettings struct {
|
||||||
return newRunnerWithArtifactReader(promptDir, profileDir, schemaDir, llmClient, artifactadapter.NewCompositeReader())
|
promptDir string
|
||||||
|
profileDir string
|
||||||
|
schemaDir string
|
||||||
|
backends []appconfig.BackendSettings
|
||||||
|
transientRetries *int
|
||||||
}
|
}
|
||||||
|
|
||||||
func newRunnerWithArtifactReader(promptDir, profileDir, schemaDir string, llmClient llm.Client, artifactReader artifactadapter.Reader) *usecase.Runner {
|
func (c runConfig) engineSettings() engineSettings {
|
||||||
if artifactReader == nil {
|
return engineSettings{promptDir: c.promptDir, profileDir: c.profileDir, schemaDir: c.schemaDir, backends: c.backends, transientRetries: c.configuredTransientRetries}
|
||||||
artifactReader = artifactadapter.NewCompositeReader()
|
}
|
||||||
|
|
||||||
|
func (c serveConfig) engineSettings() engineSettings {
|
||||||
|
return engineSettings{promptDir: c.promptDir, profileDir: c.profileDir, schemaDir: c.schemaDir, backends: c.backends, transientRetries: c.transientRetries}
|
||||||
|
}
|
||||||
|
|
||||||
|
func newEngine(settings engineSettings, options ...promptkit.Option) (*promptkit.Engine, error) {
|
||||||
|
engineOptions := make([]promptkit.Option, 0, len(settings.backends)+len(options))
|
||||||
|
for _, configured := range settings.backends {
|
||||||
|
engineOptions = append(engineOptions, promptkit.WithBackend(promptkit.Backend{
|
||||||
|
ID: configured.ID,
|
||||||
|
Endpoint: configured.Endpoint,
|
||||||
|
APIKeyEnv: configured.APIKeyEnv,
|
||||||
|
ExtraParams: configured.ExtraParams,
|
||||||
|
ConcurrencyLimit: configured.ConcurrencyLimit,
|
||||||
|
QueueCapacity: configured.QueueCapacity,
|
||||||
|
}))
|
||||||
}
|
}
|
||||||
return usecase.NewRunner(
|
engineOptions = append(engineOptions, options...)
|
||||||
promptdef.NewFilesystemRepository(promptDir),
|
engine, err := promptkit.NewEngine(promptkit.Config{
|
||||||
builtin.NewRepositoryWithDirectory(profileDir),
|
PromptDir: settings.promptDir,
|
||||||
artifactReader,
|
ProfileDir: settings.profileDir,
|
||||||
prompt.NewGoRenderer(),
|
SchemaDir: settings.schemaDir,
|
||||||
llmClient,
|
TransientRetries: settings.transientRetries,
|
||||||
validate.NewStandardValidator(schemaDir),
|
}, engineOptions...)
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
func newOpenAIClient() (*llm.OpenAICompatibleClient, error) {
|
|
||||||
return llm.NewOpenAICompatibleClient(llm.OpenAICompatibleConfig{
|
|
||||||
Timeout: defaults.LLMRequestTimeoutDefault,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
func buildRunRequestFromConfig(cfg *runConfig) (domain.RunRequest, error) {
|
|
||||||
inputMappings, err := parseMappings(cfg.inputRaw, false)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return domain.RunRequest{}, fmt.Errorf("input parse error: %w", err)
|
return nil, fmt.Errorf("engine initialization from application configuration: %w", err)
|
||||||
|
}
|
||||||
|
return engine, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func buildRunRequestFromConfig(cfg *runConfig) (promptkit.RunRequest, error) {
|
||||||
|
var inputMappings map[string]string
|
||||||
|
var err error
|
||||||
|
if len(cfg.inputRaw) > 0 {
|
||||||
|
inputMappings, err = parseMappings(cfg.inputRaw, false)
|
||||||
|
if err != nil {
|
||||||
|
return promptkit.RunRequest{}, fmt.Errorf("input parse error: %w", err)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
varMappings := map[string]string{}
|
varMappings := map[string]string{}
|
||||||
if len(cfg.varRaw) > 0 {
|
if len(cfg.varRaw) > 0 {
|
||||||
varMappings, err = parseMappings(cfg.varRaw, false)
|
varMappings, err = parseMappings(cfg.varRaw, false)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return domain.RunRequest{}, fmt.Errorf("var parse error: %w", err)
|
return promptkit.RunRequest{}, fmt.Errorf("var parse error: %w", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
inputs := make(map[string]domain.ArtifactRef, len(inputMappings))
|
var inputs map[string]promptkit.ArtifactRef
|
||||||
for name, path := range inputMappings {
|
if len(inputMappings) > 0 {
|
||||||
inputs[name] = domain.ArtifactRef{Type: domain.ArtifactRefFile, URI: path}
|
inputs = make(map[string]promptkit.ArtifactRef, len(inputMappings))
|
||||||
|
for name, path := range inputMappings {
|
||||||
|
inputs[name] = promptkit.File(path)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
var modelOverride *domain.ExecutionTargetOverride
|
var modelOverride *promptkit.ExecutionTargetOverride
|
||||||
if cfg.llmBaseURLSet || cfg.modelSet || cfg.temperatureSet || cfg.maxTokensSet || cfg.topPSet || cfg.apiKeyEnvSet || cfg.timeoutSet {
|
if cfg.llmBaseURLSet || cfg.modelSet || cfg.temperatureSet || cfg.maxTokensSet || cfg.topPSet || cfg.reasoningEffortSet || cfg.apiKeyEnvSet || cfg.timeoutSet {
|
||||||
modelOverride = &domain.ExecutionTargetOverride{
|
modelOverride = &promptkit.ExecutionTargetOverride{
|
||||||
Endpoint: cfg.llmBaseURL,
|
Endpoint: cfg.llmBaseURL,
|
||||||
Model: cfg.model,
|
Model: cfg.model,
|
||||||
APIKeyEnv: cfg.apiKeyEnv,
|
APIKeyEnv: cfg.apiKeyEnv,
|
||||||
@@ -600,18 +629,28 @@ func buildRunRequestFromConfig(cfg *runConfig) (domain.RunRequest, error) {
|
|||||||
if cfg.topPSet {
|
if cfg.topPSet {
|
||||||
modelOverride.TopP = &cfg.topP
|
modelOverride.TopP = &cfg.topP
|
||||||
}
|
}
|
||||||
|
if cfg.reasoningEffortSet {
|
||||||
|
modelOverride.ReasoningEffort = &cfg.reasoningEffort
|
||||||
|
}
|
||||||
if cfg.timeoutSet {
|
if cfg.timeoutSet {
|
||||||
timeoutSeconds := int(cfg.timeout.Seconds())
|
timeoutSeconds := int(cfg.timeout.Seconds())
|
||||||
modelOverride.TimeoutSeconds = &timeoutSeconds
|
modelOverride.TimeoutSeconds = &timeoutSeconds
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return domain.RunRequest{
|
var transientRetries *int
|
||||||
PromptID: cfg.promptID,
|
if cfg.transientRetriesSet {
|
||||||
ProfileID: cfg.profileID,
|
transientRetries = &cfg.transientRetries
|
||||||
Inputs: inputs,
|
}
|
||||||
Vars: varMappings,
|
return promptkit.RunRequest{
|
||||||
Execution: modelOverride,
|
PromptID: cfg.promptID,
|
||||||
|
PromptVersion: cfg.promptVersion,
|
||||||
|
ProfileID: cfg.profileID,
|
||||||
|
SessionID: cfg.sessionID,
|
||||||
|
Inputs: inputs,
|
||||||
|
Vars: varMappings,
|
||||||
|
Execution: modelOverride,
|
||||||
|
TransientRetries: transientRetries,
|
||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -670,17 +709,17 @@ func writeOutput(stdout io.Writer, outputPath string, body []byte) error {
|
|||||||
return os.WriteFile(outputPath, body, 0644)
|
return os.WriteFile(outputPath, body, 0644)
|
||||||
}
|
}
|
||||||
|
|
||||||
func determineExitCode(runErr error, result *domain.RunResult) int {
|
func determineExitCode(runErr error, result *promptkit.RunResult) int {
|
||||||
if runErr != nil {
|
if runErr != nil {
|
||||||
return ExitRuntimeError
|
return ExitRuntimeError
|
||||||
}
|
}
|
||||||
if result != nil && result.Validation.Status == domain.ValidationFailed {
|
if result != nil && result.Validation.Status == promptkit.ValidationFailed {
|
||||||
return ExitValidationFailed
|
return ExitValidationFailed
|
||||||
}
|
}
|
||||||
return ExitOK
|
return ExitOK
|
||||||
}
|
}
|
||||||
|
|
||||||
func printSummary(stderr io.Writer, res *domain.RunResult) {
|
func printSummary(stderr io.Writer, res *promptkit.RunResult) {
|
||||||
if res == nil {
|
if res == nil {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@@ -701,12 +740,25 @@ func printSummary(stderr io.Writer, res *domain.RunResult) {
|
|||||||
if res.Usage.CachedTokens != 0 || res.Usage.CacheWriteTokens != 0 {
|
if res.Usage.CachedTokens != 0 || res.Usage.CacheWriteTokens != 0 {
|
||||||
fmt.Fprintf(stderr, " cached_tokens=%d cache_write_tokens=%d", res.Usage.CachedTokens, res.Usage.CacheWriteTokens)
|
fmt.Fprintf(stderr, " cached_tokens=%d cache_write_tokens=%d", res.Usage.CachedTokens, res.Usage.CacheWriteTokens)
|
||||||
}
|
}
|
||||||
|
if res.SelectedBackendID != "" {
|
||||||
|
fmt.Fprintf(stderr, " backend=%s", res.SelectedBackendID)
|
||||||
|
}
|
||||||
fmt.Fprintln(stderr)
|
fmt.Fprintln(stderr)
|
||||||
}
|
}
|
||||||
|
|
||||||
func printUsage(w io.Writer) {
|
func runErrorMessage(err error) string {
|
||||||
fmt.Fprintln(w, "usage: scriptorium <run|render|serve> ...")
|
if errors.Is(err, promptkit.ErrCapacityExceeded) {
|
||||||
fmt.Fprintln(w, " run: scriptorium run [--config PATH] [--prompt-dir DIR] [--profile-dir DIR] --prompt ID --input name=path [--input ...] [--profile ID] [--llm-base-url URL] [--model NAME] [--api-key-env ENV] [--temperature N] [--max-tokens N] [--top-p N] [--var k=v] [--out path] [--timeout 10m]")
|
return "run error: model backend capacity is exhausted"
|
||||||
fmt.Fprintln(w, " render: scriptorium render [--config PATH] [--prompt-dir DIR] [--profile-dir DIR] --prompt ID --input name=path [--input ...] [--profile ID] [--llm-base-url URL] [--model NAME] [--api-key-env ENV] [--temperature N] [--max-tokens N] [--top-p N] [--var k=v] [--format text|json] [--out path] [--timeout 10m]")
|
}
|
||||||
fmt.Fprintf(w, " serve: scriptorium serve [--config PATH] [--addr %s] [--prompt-dir DIR] [--profile-dir DIR] [--schema-dir DIR] [--artifact-root DIR] [--max-request-bytes N] [--max-artifact-bytes N] [--max-response-bytes N]\n", defaults.HTTPAddrDefault)
|
return fmt.Sprintf("run error: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
func printUsage(w io.Writer) {
|
||||||
|
fmt.Fprintln(w, "usage: scriptorium <run|render|serve|inspect|config> ...")
|
||||||
|
fmt.Fprintln(w, " run: scriptorium run [--config PATH] [--config-overlay NAME] [--prompt-dir DIR] [--profile-dir DIR] [--schema-dir DIR] --prompt ID [--prompt-version VERSION] [--input name=path] [--profile ID] [--session-id ID] [--llm-base-url URL] [--model NAME] [--api-key-env ENV] [--temperature N] [--max-tokens N] [--top-p N] [--reasoning-effort VALUE] [--var k=v] [--out path] [--execution-report path] [--timeout 10m] [--run-timeout 10m] [--transient-retries N]")
|
||||||
|
fmt.Fprintln(w, " render: scriptorium render [--config PATH] [--config-overlay NAME] [--prompt-dir DIR] [--profile-dir DIR] [--schema-dir DIR] --prompt ID [--prompt-version VERSION] [--input name=path] [--profile ID] [--session-id ID] [--llm-base-url URL] [--model NAME] [--api-key-env ENV] [--temperature N] [--max-tokens N] [--top-p N] [--reasoning-effort VALUE] [--var k=v] [--format text|json] [--out path] [--timeout 10m] [--transient-retries N]")
|
||||||
|
fmt.Fprintf(w, " serve: scriptorium serve [--config PATH] [--config-overlay NAME] [--addr %s] [--prompt-dir DIR] [--profile-dir DIR] [--schema-dir DIR] [--artifact-root DIR] [--max-request-bytes N] [--max-artifact-bytes N] [--max-response-bytes N]\n", defaults.HTTPAddrDefault)
|
||||||
|
fmt.Fprintln(w, " inspect prompt: scriptorium inspect prompt --prompt ID [--prompt-version VERSION] [--config PATH] [--config-overlay NAME] [--prompt-dir DIR] [--format text|json] [--out path]")
|
||||||
|
fmt.Fprintln(w, " inspect profile: scriptorium inspect profile --profile ID [--config PATH] [--config-overlay NAME] [--profile-dir DIR] [--format text|json] [--out path]")
|
||||||
|
fmt.Fprintln(w, " config: scriptorium config <validate|show|sources|explain> [--config PATH] [--config-overlay NAME] [application overrides] [--path /pointer for explain]")
|
||||||
}
|
}
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
322
internal/adapter/dependency_test.go
Normal file
322
internal/adapter/dependency_test.go
Normal file
@@ -0,0 +1,322 @@
|
|||||||
|
package adapter_test
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"go/parser"
|
||||||
|
"go/token"
|
||||||
|
"io/fs"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"runtime"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
const (
|
||||||
|
scriptoriumModulePath = "gitea.maximumdirect.net/eric/scriptorium"
|
||||||
|
promptkitInternalPath = "gitea.maximumdirect.net/eric/promptkit/internal"
|
||||||
|
promptkitOpenRouterCatalogPath = "gitea.maximumdirect.net/eric/promptkit-backend-openrouter"
|
||||||
|
promptkitRakestrawhomeCatalogPath = "gitea.maximumdirect.net/eric/promptkit-backend-rakestrawhome"
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
removedFrameworkPackageRoots = []string{
|
||||||
|
scriptoriumModulePath + "/internal/artifact",
|
||||||
|
scriptoriumModulePath + "/internal/domain",
|
||||||
|
scriptoriumModulePath + "/internal/filecatalog",
|
||||||
|
scriptoriumModulePath + "/internal/llm",
|
||||||
|
scriptoriumModulePath + "/internal/profile",
|
||||||
|
scriptoriumModulePath + "/internal/prompt",
|
||||||
|
scriptoriumModulePath + "/internal/promptdef",
|
||||||
|
scriptoriumModulePath + "/internal/usecase",
|
||||||
|
scriptoriumModulePath + "/internal/validate",
|
||||||
|
}
|
||||||
|
removedFrameworkDirectories = []string{
|
||||||
|
"internal/artifact",
|
||||||
|
"internal/domain",
|
||||||
|
"internal/filecatalog",
|
||||||
|
"internal/llm",
|
||||||
|
"internal/profile",
|
||||||
|
"internal/prompt",
|
||||||
|
"internal/promptdef",
|
||||||
|
"internal/usecase",
|
||||||
|
"internal/validate",
|
||||||
|
}
|
||||||
|
nonSourceDirectories = map[string]struct{}{
|
||||||
|
".cache": {},
|
||||||
|
".codebase-memory": {},
|
||||||
|
".git": {},
|
||||||
|
"build": {},
|
||||||
|
"coverage": {},
|
||||||
|
"dist": {},
|
||||||
|
"node_modules": {},
|
||||||
|
"out": {},
|
||||||
|
"testdata": {},
|
||||||
|
"vendor": {},
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
type forbiddenImport struct {
|
||||||
|
filePath string
|
||||||
|
importPath string
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestApplicationBoundary(t *testing.T) {
|
||||||
|
moduleRoot := moduleRootFromTestFile(t)
|
||||||
|
|
||||||
|
violations, err := findForbiddenProductionImports(moduleRoot)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("scan production imports: %v", err)
|
||||||
|
}
|
||||||
|
for _, violation := range violations {
|
||||||
|
t.Errorf("%s imports forbidden package %s", violation.filePath, violation.importPath)
|
||||||
|
}
|
||||||
|
|
||||||
|
assertFrameworkImplementationAbsent(t, moduleRoot)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestForbiddenImportScannerDetectsFormerRoot(t *testing.T) {
|
||||||
|
root := t.TempDir()
|
||||||
|
sourcePath := writeGoSource(t, root, "nested/consumer/root.go", scriptoriumModulePath)
|
||||||
|
|
||||||
|
violations, err := findForbiddenProductionImports(root)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("scan source fixture: %v", err)
|
||||||
|
}
|
||||||
|
assertSingleViolation(t, violations, sourcePath, scriptoriumModulePath)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestForbiddenImportScannerDetectsFormerFrameworkFamily(t *testing.T) {
|
||||||
|
root := t.TempDir()
|
||||||
|
importPath := scriptoriumModulePath + "/internal/profile/builtin"
|
||||||
|
sourcePath := writeGoSource(t, root, "nested/consumer/profile.go", importPath)
|
||||||
|
|
||||||
|
violations, err := findForbiddenProductionImports(root)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("scan source fixture: %v", err)
|
||||||
|
}
|
||||||
|
assertSingleViolation(t, violations, sourcePath, importPath)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestForbiddenImportScannerDetectsPromptkitInternalPackages(t *testing.T) {
|
||||||
|
tests := []struct {
|
||||||
|
name string
|
||||||
|
importPath string
|
||||||
|
}{
|
||||||
|
{name: "exact internal root", importPath: promptkitInternalPath},
|
||||||
|
{name: "internal descendant", importPath: promptkitInternalPath + "/domain"},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, tc := range tests {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
root := t.TempDir()
|
||||||
|
sourcePath := writeGoSource(t, root, "nested/consumer/promptkit.go", tc.importPath)
|
||||||
|
|
||||||
|
violations, err := findForbiddenProductionImports(root)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("scan source fixture: %v", err)
|
||||||
|
}
|
||||||
|
assertSingleViolation(t, violations, sourcePath, tc.importPath)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestForbiddenImportScannerDetectsPromptkitCatalogPackages(t *testing.T) {
|
||||||
|
for _, importPath := range []string{
|
||||||
|
promptkitOpenRouterCatalogPath,
|
||||||
|
promptkitRakestrawhomeCatalogPath,
|
||||||
|
} {
|
||||||
|
t.Run(importPath, func(t *testing.T) {
|
||||||
|
root := t.TempDir()
|
||||||
|
sourcePath := writeGoSource(t, root, "nested/consumer/catalog.go", importPath)
|
||||||
|
|
||||||
|
violations, err := findForbiddenProductionImports(root)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("scan source fixture: %v", err)
|
||||||
|
}
|
||||||
|
assertSingleViolation(t, violations, sourcePath, importPath)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestForbiddenImportScannerAllowsRetainedApplicationPackages(t *testing.T) {
|
||||||
|
root := t.TempDir()
|
||||||
|
sourcePath := filepath.Join(root, "nested/consumer/application.go")
|
||||||
|
if err := os.MkdirAll(filepath.Dir(sourcePath), 0o755); err != nil {
|
||||||
|
t.Fatalf("create source fixture directory: %v", err)
|
||||||
|
}
|
||||||
|
source := `package consumer
|
||||||
|
|
||||||
|
import (
|
||||||
|
_ "gitea.maximumdirect.net/eric/promptkit"
|
||||||
|
_ "gitea.maximumdirect.net/eric/scriptorium/internal/adapter/http"
|
||||||
|
_ "gitea.maximumdirect.net/eric/scriptorium/internal/config"
|
||||||
|
_ "gitea.maximumdirect.net/eric/scriptorium/internal/defaults"
|
||||||
|
_ "gitea.maximumdirect.net/eric/scriptorium/internal/format"
|
||||||
|
)
|
||||||
|
`
|
||||||
|
if err := os.WriteFile(sourcePath, []byte(source), 0o644); err != nil {
|
||||||
|
t.Fatalf("write source fixture: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
violations, err := findForbiddenProductionImports(root)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("scan source fixture: %v", err)
|
||||||
|
}
|
||||||
|
if len(violations) != 0 {
|
||||||
|
t.Fatalf("expected retained application imports to be allowed, got %#v", violations)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func findForbiddenProductionImports(root string) ([]forbiddenImport, error) {
|
||||||
|
var violations []forbiddenImport
|
||||||
|
err := filepath.WalkDir(root, func(path string, entry fs.DirEntry, err error) error {
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if entry.IsDir() {
|
||||||
|
if path != root && shouldSkipSourceDirectory(entry.Name()) {
|
||||||
|
return filepath.SkipDir
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
if !strings.HasSuffix(entry.Name(), ".go") || strings.HasSuffix(entry.Name(), "_test.go") {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
file, err := parser.ParseFile(token.NewFileSet(), path, nil, parser.ImportsOnly)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("parse imports in %s: %w", path, err)
|
||||||
|
}
|
||||||
|
for _, imported := range file.Imports {
|
||||||
|
importPath, err := strconv.Unquote(imported.Path.Value)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("parse import path in %s: %w", path, err)
|
||||||
|
}
|
||||||
|
if isForbiddenProductionImport(importPath) {
|
||||||
|
violations = append(violations, forbiddenImport{
|
||||||
|
filePath: path,
|
||||||
|
importPath: importPath,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("walk repository root %s: %w", root, err)
|
||||||
|
}
|
||||||
|
return violations, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func shouldSkipSourceDirectory(name string) bool {
|
||||||
|
_, skip := nonSourceDirectories[name]
|
||||||
|
return skip
|
||||||
|
}
|
||||||
|
|
||||||
|
func isForbiddenProductionImport(importPath string) bool {
|
||||||
|
if importPath == scriptoriumModulePath {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
if importPath == promptkitInternalPath || strings.HasPrefix(importPath, promptkitInternalPath+"/") {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
if importPath == promptkitOpenRouterCatalogPath || strings.HasPrefix(importPath, promptkitOpenRouterCatalogPath+"/") {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
if importPath == promptkitRakestrawhomeCatalogPath || strings.HasPrefix(importPath, promptkitRakestrawhomeCatalogPath+"/") {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
for _, root := range removedFrameworkPackageRoots {
|
||||||
|
if importPath == root || strings.HasPrefix(importPath, root+"/") {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
func moduleRootFromTestFile(t *testing.T) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
_, testFile, _, ok := runtime.Caller(0)
|
||||||
|
if !ok {
|
||||||
|
t.Fatal("locate dependency guard source")
|
||||||
|
}
|
||||||
|
root, err := findModuleRoot(filepath.Dir(testFile))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
return root
|
||||||
|
}
|
||||||
|
|
||||||
|
func findModuleRoot(start string) (string, error) {
|
||||||
|
dir, err := filepath.Abs(start)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("resolve module search path: %w", err)
|
||||||
|
}
|
||||||
|
for {
|
||||||
|
goMod := filepath.Join(dir, "go.mod")
|
||||||
|
if info, err := os.Stat(goMod); err == nil && !info.IsDir() {
|
||||||
|
return dir, nil
|
||||||
|
} else if err != nil && !os.IsNotExist(err) {
|
||||||
|
return "", fmt.Errorf("inspect %s: %w", goMod, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
parent := filepath.Dir(dir)
|
||||||
|
if parent == dir {
|
||||||
|
return "", fmt.Errorf("locate go.mod from %s", start)
|
||||||
|
}
|
||||||
|
dir = parent
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func assertFrameworkImplementationAbsent(t *testing.T, moduleRoot string) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
entries, err := os.ReadDir(moduleRoot)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("read module root: %v", err)
|
||||||
|
}
|
||||||
|
for _, entry := range entries {
|
||||||
|
if !entry.IsDir() && strings.HasSuffix(entry.Name(), ".go") && !strings.HasSuffix(entry.Name(), "_test.go") {
|
||||||
|
t.Errorf("module root contains production Go file %s", entry.Name())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, relativePath := range removedFrameworkDirectories {
|
||||||
|
path := filepath.Join(moduleRoot, filepath.FromSlash(relativePath))
|
||||||
|
if _, err := os.Stat(path); err == nil {
|
||||||
|
t.Errorf("removed framework directory still exists: %s", relativePath)
|
||||||
|
} else if !os.IsNotExist(err) {
|
||||||
|
t.Errorf("inspect removed framework directory %s: %v", relativePath, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeGoSource(t *testing.T, root, relativePath, importPath string) string {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
sourcePath := filepath.Join(root, filepath.FromSlash(relativePath))
|
||||||
|
if err := os.MkdirAll(filepath.Dir(sourcePath), 0o755); err != nil {
|
||||||
|
t.Fatalf("create source fixture directory: %v", err)
|
||||||
|
}
|
||||||
|
source := fmt.Sprintf("package consumer\n\nimport _ %q\n", importPath)
|
||||||
|
if err := os.WriteFile(sourcePath, []byte(source), 0o644); err != nil {
|
||||||
|
t.Fatalf("write source fixture: %v", err)
|
||||||
|
}
|
||||||
|
return sourcePath
|
||||||
|
}
|
||||||
|
|
||||||
|
func assertSingleViolation(t *testing.T, violations []forbiddenImport, sourcePath, importPath string) {
|
||||||
|
t.Helper()
|
||||||
|
|
||||||
|
if len(violations) != 1 {
|
||||||
|
t.Fatalf("expected one forbidden import, got %#v", violations)
|
||||||
|
}
|
||||||
|
if violations[0].filePath != sourcePath {
|
||||||
|
t.Fatalf("unexpected importing file: %q", violations[0].filePath)
|
||||||
|
}
|
||||||
|
if violations[0].importPath != importPath {
|
||||||
|
t.Fatalf("unexpected forbidden import: %q", violations[0].importPath)
|
||||||
|
}
|
||||||
|
}
|
||||||
165
internal/adapter/http/artifact_reader.go
Normal file
165
internal/adapter/http/artifact_reader.go
Normal file
@@ -0,0 +1,165 @@
|
|||||||
|
package httpadapter
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"crypto/sha256"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"mime"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/promptkit"
|
||||||
|
)
|
||||||
|
|
||||||
|
var (
|
||||||
|
ErrFileNotAllowed = errors.New("file artifact references are not allowed")
|
||||||
|
ErrFileOutsideRoot = errors.New("file artifact path is outside artifact root")
|
||||||
|
ErrFileTooLarge = errors.New("file artifact exceeds size limit")
|
||||||
|
)
|
||||||
|
|
||||||
|
const fallbackArtifactContentType = "text/plain"
|
||||||
|
|
||||||
|
// NewRestrictedArtifactReader creates the HTTP artifact reader for a rooted
|
||||||
|
// filesystem and optional byte limit. An empty root permits inline artifacts
|
||||||
|
// but denies file references; a zero limit permits artifacts of any size.
|
||||||
|
func NewRestrictedArtifactReader(root string, maxBytes int64) (promptkit.ArtifactReader, error) {
|
||||||
|
if maxBytes < 0 {
|
||||||
|
return nil, fmt.Errorf("artifact size limit must be greater than or equal to 0")
|
||||||
|
}
|
||||||
|
|
||||||
|
cleanRoot := strings.TrimSpace(root)
|
||||||
|
if cleanRoot == "" {
|
||||||
|
return &restrictedArtifactReader{maxBytes: maxBytes}, nil
|
||||||
|
}
|
||||||
|
absRoot, err := filepath.Abs(filepath.Clean(cleanRoot))
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("resolve artifact root: %w", err)
|
||||||
|
}
|
||||||
|
return &restrictedArtifactReader{root: absRoot, maxBytes: maxBytes}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
type restrictedArtifactReader struct {
|
||||||
|
root string
|
||||||
|
maxBytes int64
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ promptkit.ArtifactReader = (*restrictedArtifactReader)(nil)
|
||||||
|
|
||||||
|
func (r *restrictedArtifactReader) Read(ctx context.Context, ref promptkit.ArtifactRef) (*promptkit.Artifact, error) {
|
||||||
|
select {
|
||||||
|
case <-ctx.Done():
|
||||||
|
return nil, ctx.Err()
|
||||||
|
default:
|
||||||
|
}
|
||||||
|
|
||||||
|
switch ref.Type {
|
||||||
|
case promptkit.ArtifactRefInline:
|
||||||
|
return readInlineArtifact(ref)
|
||||||
|
case promptkit.ArtifactRefFile:
|
||||||
|
return r.readFileArtifact(ref)
|
||||||
|
default:
|
||||||
|
return nil, fmt.Errorf("unsupported artifact reference type %q", ref.Type)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func readInlineArtifact(ref promptkit.ArtifactRef) (*promptkit.Artifact, error) {
|
||||||
|
if ref.Body == "" {
|
||||||
|
return nil, errors.New("inline artifact body is required")
|
||||||
|
}
|
||||||
|
|
||||||
|
body := []byte(ref.Body)
|
||||||
|
return &promptkit.Artifact{
|
||||||
|
ContentType: fallbackArtifactContentType,
|
||||||
|
Body: body,
|
||||||
|
Size: int64(len(body)),
|
||||||
|
Hash: artifactHash(body),
|
||||||
|
URI: ref.URI,
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *restrictedArtifactReader) readFileArtifact(ref promptkit.ArtifactRef) (*promptkit.Artifact, error) {
|
||||||
|
if ref.URI == "" {
|
||||||
|
return nil, errors.New("file artifact path is required")
|
||||||
|
}
|
||||||
|
if r.root == "" {
|
||||||
|
return nil, ErrFileNotAllowed
|
||||||
|
}
|
||||||
|
|
||||||
|
path, err := r.resolveLexicalPath(ref.URI)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return readArtifactFile(path, r.maxBytes)
|
||||||
|
}
|
||||||
|
|
||||||
|
// resolveLexicalPath checks cleaned path containment without resolving symlinks.
|
||||||
|
func (r *restrictedArtifactReader) resolveLexicalPath(rawPath string) (string, error) {
|
||||||
|
cleanPath := filepath.Clean(strings.TrimSpace(rawPath))
|
||||||
|
candidate := cleanPath
|
||||||
|
if !filepath.IsAbs(cleanPath) {
|
||||||
|
candidate = filepath.Join(r.root, cleanPath)
|
||||||
|
}
|
||||||
|
|
||||||
|
absCandidate, err := filepath.Abs(candidate)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("resolve artifact path: %w", err)
|
||||||
|
}
|
||||||
|
absCandidate = filepath.Clean(absCandidate)
|
||||||
|
|
||||||
|
rel, err := filepath.Rel(r.root, absCandidate)
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("compare artifact path to root: %w", err)
|
||||||
|
}
|
||||||
|
if rel == ".." || strings.HasPrefix(rel, ".."+string(filepath.Separator)) || filepath.IsAbs(rel) {
|
||||||
|
return "", ErrFileOutsideRoot
|
||||||
|
}
|
||||||
|
return absCandidate, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func readArtifactFile(path string, maxBytes int64) (*promptkit.Artifact, error) {
|
||||||
|
file, err := os.Open(path)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("failed to read file %s: %w", path, err)
|
||||||
|
}
|
||||||
|
defer file.Close()
|
||||||
|
|
||||||
|
info, err := file.Stat()
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("failed to stat file %s: %w", path, err)
|
||||||
|
}
|
||||||
|
if maxBytes > 0 && info.Size() > maxBytes {
|
||||||
|
return nil, ErrFileTooLarge
|
||||||
|
}
|
||||||
|
|
||||||
|
var reader io.Reader = file
|
||||||
|
if maxBytes > 0 {
|
||||||
|
reader = io.LimitReader(file, maxBytes+1)
|
||||||
|
}
|
||||||
|
body, err := io.ReadAll(reader)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("failed to read file %s: %w", path, err)
|
||||||
|
}
|
||||||
|
if maxBytes > 0 && int64(len(body)) > maxBytes {
|
||||||
|
return nil, ErrFileTooLarge
|
||||||
|
}
|
||||||
|
|
||||||
|
contentType := mime.TypeByExtension(filepath.Ext(path))
|
||||||
|
if contentType == "" {
|
||||||
|
contentType = fallbackArtifactContentType
|
||||||
|
}
|
||||||
|
return &promptkit.Artifact{
|
||||||
|
Name: filepath.Base(path),
|
||||||
|
ContentType: contentType,
|
||||||
|
Body: body,
|
||||||
|
URI: path,
|
||||||
|
Size: int64(len(body)),
|
||||||
|
Hash: artifactHash(body),
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func artifactHash(body []byte) string {
|
||||||
|
return fmt.Sprintf("%x", sha256.Sum256(body))
|
||||||
|
}
|
||||||
185
internal/adapter/http/artifact_reader_test.go
Normal file
185
internal/adapter/http/artifact_reader_test.go
Normal file
@@ -0,0 +1,185 @@
|
|||||||
|
package httpadapter
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"mime"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/promptkit"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestRestrictedArtifactReaderReadsContainedFiles(t *testing.T) {
|
||||||
|
root := t.TempDir()
|
||||||
|
outside := t.TempDir()
|
||||||
|
inputPath := filepath.Join(root, "input.html")
|
||||||
|
if err := os.WriteFile(inputPath, []byte("allowed"), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(filepath.Join(root, "input.unknown"), []byte("unknown type"), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.Mkdir(filepath.Join(root, "nested"), 0o755); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(filepath.Join(outside, "secret.txt"), []byte("denied"), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
expectedContentType := mime.TypeByExtension(filepath.Ext(inputPath))
|
||||||
|
if expectedContentType == "" {
|
||||||
|
t.Fatal("expected built-in HTML content type")
|
||||||
|
}
|
||||||
|
|
||||||
|
reader, err := NewRestrictedArtifactReader(root, 0)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("construct restricted reader: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, ref := range []promptkit.ArtifactRef{
|
||||||
|
{Type: promptkit.ArtifactRefFile, URI: "nested/../input.html"},
|
||||||
|
{Type: promptkit.ArtifactRefFile, URI: inputPath},
|
||||||
|
} {
|
||||||
|
artifact, err := reader.Read(context.Background(), ref)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("read contained path %q: %v", ref.URI, err)
|
||||||
|
}
|
||||||
|
if artifact.Name != "input.html" || artifact.URI != inputPath || artifact.Size != int64(len("allowed")) || string(artifact.Body) != "allowed" {
|
||||||
|
t.Fatalf("unexpected artifact metadata: %#v", artifact)
|
||||||
|
}
|
||||||
|
if artifact.ContentType != expectedContentType {
|
||||||
|
t.Fatalf("unexpected artifact content type: got %q, want %q", artifact.ContentType, expectedContentType)
|
||||||
|
}
|
||||||
|
if artifact.Hash != artifactHash([]byte("allowed")) {
|
||||||
|
t.Fatalf("unexpected artifact hash: %q", artifact.Hash)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
artifact, err := reader.Read(context.Background(), promptkit.File("input.unknown"))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("read unknown-extension path: %v", err)
|
||||||
|
}
|
||||||
|
if artifact.ContentType != fallbackArtifactContentType {
|
||||||
|
t.Fatalf("unexpected fallback content type: %q", artifact.ContentType)
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, ref := range []promptkit.ArtifactRef{
|
||||||
|
{Type: promptkit.ArtifactRefFile, URI: filepath.Join("..", filepath.Base(outside), "secret.txt")},
|
||||||
|
{Type: promptkit.ArtifactRefFile, URI: filepath.Join(outside, "secret.txt")},
|
||||||
|
} {
|
||||||
|
_, err := reader.Read(context.Background(), ref)
|
||||||
|
if !errors.Is(err, ErrFileOutsideRoot) {
|
||||||
|
t.Fatalf("expected ErrFileOutsideRoot for %q, got %v", ref.URI, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRestrictedArtifactReaderFollowsSymlinkAfterLexicalCheck(t *testing.T) {
|
||||||
|
root := t.TempDir()
|
||||||
|
outside := t.TempDir()
|
||||||
|
target := filepath.Join(outside, "linked.txt")
|
||||||
|
if err := os.WriteFile(target, []byte("linked outside root"), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.Symlink(target, filepath.Join(root, "linked.txt")); err != nil {
|
||||||
|
t.Skipf("symlink creation unavailable: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
reader, err := NewRestrictedArtifactReader(root, 0)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("construct restricted reader: %v", err)
|
||||||
|
}
|
||||||
|
artifact, err := reader.Read(context.Background(), promptkit.File("linked.txt"))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("read symlink inside root: %v", err)
|
||||||
|
}
|
||||||
|
if string(artifact.Body) != "linked outside root" {
|
||||||
|
t.Fatalf("unexpected symlink artifact body: %q", artifact.Body)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRestrictedArtifactReaderWithoutRootDeniesFiles(t *testing.T) {
|
||||||
|
reader, err := NewRestrictedArtifactReader("", 0)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("construct rootless reader: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
artifact, err := reader.Read(context.Background(), promptkit.Inline("inline"))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("read inline artifact: %v", err)
|
||||||
|
}
|
||||||
|
if artifact.ContentType != fallbackArtifactContentType || string(artifact.Body) != "inline" || artifact.Hash != artifactHash([]byte("inline")) {
|
||||||
|
t.Fatalf("unexpected inline artifact: %#v", artifact)
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err = reader.Read(context.Background(), promptkit.File("input.txt"))
|
||||||
|
if !errors.Is(err, ErrFileNotAllowed) {
|
||||||
|
t.Fatalf("expected ErrFileNotAllowed, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRestrictedArtifactReaderEnforcesLimits(t *testing.T) {
|
||||||
|
root := t.TempDir()
|
||||||
|
if err := os.WriteFile(filepath.Join(root, "exact.txt"), []byte("12345"), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(filepath.Join(root, "large.txt"), []byte("123456"), 0o644); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
reader, err := NewRestrictedArtifactReader(root, 5)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("construct limited reader: %v", err)
|
||||||
|
}
|
||||||
|
artifact, err := reader.Read(context.Background(), promptkit.File("exact.txt"))
|
||||||
|
if err != nil || string(artifact.Body) != "12345" {
|
||||||
|
t.Fatalf("expected exact-limit artifact, got %#v and %v", artifact, err)
|
||||||
|
}
|
||||||
|
_, err = reader.Read(context.Background(), promptkit.File("large.txt"))
|
||||||
|
if !errors.Is(err, ErrFileTooLarge) {
|
||||||
|
t.Fatalf("expected ErrFileTooLarge, got %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
unlimited, err := NewRestrictedArtifactReader(root, 0)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("construct unlimited reader: %v", err)
|
||||||
|
}
|
||||||
|
artifact, err = unlimited.Read(context.Background(), promptkit.File("large.txt"))
|
||||||
|
if err != nil || string(artifact.Body) != "123456" {
|
||||||
|
t.Fatalf("expected unlimited artifact, got %#v and %v", artifact, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if _, err := NewRestrictedArtifactReader(root, -1); err == nil {
|
||||||
|
t.Fatal("expected negative limit to fail")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRestrictedArtifactReaderRejectsCanceledAndMalformedReferences(t *testing.T) {
|
||||||
|
reader, err := NewRestrictedArtifactReader(t.TempDir(), 0)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("construct reader: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
canceledCtx, cancel := context.WithCancel(context.Background())
|
||||||
|
cancel()
|
||||||
|
for _, ref := range []promptkit.ArtifactRef{
|
||||||
|
promptkit.Inline("input"),
|
||||||
|
promptkit.File("input.txt"),
|
||||||
|
} {
|
||||||
|
_, err := reader.Read(canceledCtx, ref)
|
||||||
|
if !errors.Is(err, context.Canceled) {
|
||||||
|
t.Fatalf("expected cancellation for %#v, got %v", ref, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, ref := range []promptkit.ArtifactRef{
|
||||||
|
{Type: promptkit.ArtifactRefType("unsupported")},
|
||||||
|
{Type: promptkit.ArtifactRefInline},
|
||||||
|
{Type: promptkit.ArtifactRefFile},
|
||||||
|
} {
|
||||||
|
if _, err := reader.Read(context.Background(), ref); err == nil {
|
||||||
|
t.Fatalf("expected malformed reference %#v to fail", ref)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -2,16 +2,22 @@ package httpadapter
|
|||||||
|
|
||||||
import (
|
import (
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
|
executionreport "gitea.maximumdirect.net/eric/scriptorium/internal/report"
|
||||||
)
|
)
|
||||||
|
|
||||||
type runRequestDTO struct {
|
type runRequestDTO struct {
|
||||||
PromptID string `json:"prompt_id"`
|
PromptID string `json:"prompt_id"`
|
||||||
PromptVersion string `json:"prompt_version,omitempty"`
|
PromptVersion string `json:"prompt_version,omitempty"`
|
||||||
ProfileID string `json:"profile_id,omitempty"`
|
ProfileID string `json:"profile_id,omitempty"`
|
||||||
Inputs map[string]inputRefDTO `json:"inputs"`
|
SessionID string `json:"session_id,omitempty"`
|
||||||
Vars map[string]string `json:"vars,omitempty"`
|
Inputs map[string]inputRefDTO `json:"inputs"`
|
||||||
Model *modelOverrideRequestDTO `json:"model,omitempty"`
|
Vars map[string]string `json:"vars,omitempty"`
|
||||||
IncludeRawOutput bool `json:"include_raw_output,omitempty"`
|
Model *modelOverrideRequestDTO `json:"model,omitempty"`
|
||||||
|
IncludeRawOutput bool `json:"include_raw_output,omitempty"`
|
||||||
|
TransientRetries *int `json:"transient_retries,omitempty"`
|
||||||
|
RunTimeoutSeconds *int64 `json:"run_timeout_seconds,omitempty"`
|
||||||
|
IncludeExecutionReport bool `json:"include_execution_report,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type inputRefDTO struct {
|
type inputRefDTO struct {
|
||||||
@@ -28,16 +34,17 @@ type modelOverrideRequestDTO struct {
|
|||||||
TopP *float64 `json:"top_p,omitempty"`
|
TopP *float64 `json:"top_p,omitempty"`
|
||||||
TimeoutSeconds *int `json:"timeout_seconds,omitempty"`
|
TimeoutSeconds *int `json:"timeout_seconds,omitempty"`
|
||||||
ServiceTier string `json:"service_tier,omitempty"`
|
ServiceTier string `json:"service_tier,omitempty"`
|
||||||
ReasoningEffort string `json:"reasoning_effort,omitempty"`
|
ReasoningEffort *string `json:"reasoning_effort,omitempty"`
|
||||||
APIKeyEnv string `json:"api_key_env,omitempty"`
|
APIKeyEnv string `json:"api_key_env,omitempty"`
|
||||||
ExtraParams map[string]any `json:"extra_params,omitempty"`
|
ExtraParams map[string]any `json:"extra_params,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type runResponseDTO struct {
|
type runResponseDTO struct {
|
||||||
Artifact artifactDTO `json:"artifact"`
|
Artifact artifactDTO `json:"artifact"`
|
||||||
Validation validationDTO `json:"validation"`
|
Validation validationDTO `json:"validation"`
|
||||||
Metadata metadataDTO `json:"metadata"`
|
Metadata metadataDTO `json:"metadata"`
|
||||||
RawModelOutput *string `json:"raw_model_output,omitempty"`
|
RawModelOutput *string `json:"raw_model_output,omitempty"`
|
||||||
|
Execution *executionreport.Execution `json:"execution,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type artifactDTO struct {
|
type artifactDTO struct {
|
||||||
@@ -56,6 +63,8 @@ type metadataDTO struct {
|
|||||||
PromptHash string `json:"prompt_hash"`
|
PromptHash string `json:"prompt_hash"`
|
||||||
RenderedPromptHash string `json:"rendered_prompt_hash"`
|
RenderedPromptHash string `json:"rendered_prompt_hash"`
|
||||||
SelectedProfileID string `json:"selected_profile_id"`
|
SelectedProfileID string `json:"selected_profile_id"`
|
||||||
|
SelectedBackendID string `json:"selected_backend_id,omitempty"`
|
||||||
|
SessionID string `json:"session_id,omitempty"`
|
||||||
ModelName string `json:"model_name"`
|
ModelName string `json:"model_name"`
|
||||||
Endpoint string `json:"endpoint"`
|
Endpoint string `json:"endpoint"`
|
||||||
ModelParams modelParamsDTO `json:"model_params"`
|
ModelParams modelParamsDTO `json:"model_params"`
|
||||||
@@ -71,6 +80,7 @@ type metadataDTO struct {
|
|||||||
|
|
||||||
type modelParamsDTO struct {
|
type modelParamsDTO struct {
|
||||||
Endpoint string `json:"endpoint"`
|
Endpoint string `json:"endpoint"`
|
||||||
|
BackendID string `json:"backend_id,omitempty"`
|
||||||
Model string `json:"model"`
|
Model string `json:"model"`
|
||||||
Temperature float64 `json:"temperature"`
|
Temperature float64 `json:"temperature"`
|
||||||
MaxTokens int `json:"max_tokens"`
|
MaxTokens int `json:"max_tokens"`
|
||||||
@@ -100,7 +110,8 @@ type validationDTO struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
type errorResponse struct {
|
type errorResponse struct {
|
||||||
Error errorBody `json:"error"`
|
Error errorBody `json:"error"`
|
||||||
|
Execution *executionreport.Execution `json:"execution,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type errorBody struct {
|
type errorBody struct {
|
||||||
|
|||||||
@@ -5,19 +5,18 @@ import (
|
|||||||
"encoding/json"
|
"encoding/json"
|
||||||
"errors"
|
"errors"
|
||||||
"io"
|
"io"
|
||||||
|
"math"
|
||||||
"net/http"
|
"net/http"
|
||||||
"strings"
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/artifact"
|
"gitea.maximumdirect.net/eric/promptkit"
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/defaults"
|
"gitea.maximumdirect.net/eric/scriptorium/internal/defaults"
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/domain"
|
executionreport "gitea.maximumdirect.net/eric/scriptorium/internal/report"
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/profile"
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/promptdef"
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/usecase"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
type Runner interface {
|
type Runner interface {
|
||||||
Run(ctx context.Context, req domain.RunRequest) (*domain.RunResult, error)
|
Run(ctx context.Context, req promptkit.RunRequest) (*promptkit.RunResult, error)
|
||||||
}
|
}
|
||||||
|
|
||||||
type Handler struct {
|
type Handler struct {
|
||||||
@@ -80,36 +79,70 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
|||||||
writeError(w, http.StatusBadRequest, "invalid_request", "prompt_id is required")
|
writeError(w, http.StatusBadRequest, "invalid_request", "prompt_id is required")
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
if len(req.Inputs) == 0 {
|
if req.TransientRetries != nil && *req.TransientRetries < 0 {
|
||||||
writeError(w, http.StatusBadRequest, "invalid_request", "inputs is required")
|
writeError(w, http.StatusBadRequest, "invalid_request", "transient_retries must be greater than or equal to 0")
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
if req.RunTimeoutSeconds != nil {
|
||||||
mappedInputs := make(map[string]domain.ArtifactRef, len(req.Inputs))
|
if *req.RunTimeoutSeconds < 0 || *req.RunTimeoutSeconds > math.MaxInt64/int64(time.Second) {
|
||||||
for name, in := range req.Inputs {
|
writeError(w, http.StatusBadRequest, "invalid_request", "run_timeout_seconds is out of range")
|
||||||
mappedInputs[name] = domain.ArtifactRef{
|
return
|
||||||
Type: domain.ArtifactRefType(in.Type),
|
}
|
||||||
URI: in.URI,
|
}
|
||||||
Body: in.Body,
|
var mappedInputs map[string]promptkit.ArtifactRef
|
||||||
|
if len(req.Inputs) > 0 {
|
||||||
|
mappedInputs = make(map[string]promptkit.ArtifactRef, len(req.Inputs))
|
||||||
|
for name, in := range req.Inputs {
|
||||||
|
mappedInputs[name] = promptkit.ArtifactRef{
|
||||||
|
Type: promptkit.ArtifactRefType(in.Type),
|
||||||
|
URI: in.URI,
|
||||||
|
Body: in.Body,
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
var model *domain.ExecutionTargetOverride
|
var model *promptkit.ExecutionTargetOverride
|
||||||
if req.Model != nil {
|
if req.Model != nil {
|
||||||
model = executionTargetOverrideFromModelOverrideDTO(req.Model)
|
model = executionTargetOverrideFromModelOverrideDTO(req.Model)
|
||||||
}
|
}
|
||||||
|
|
||||||
res, err := h.runner.Run(r.Context(), domain.RunRequest{
|
runContext := r.Context()
|
||||||
PromptID: req.PromptID,
|
if req.RunTimeoutSeconds != nil && *req.RunTimeoutSeconds > 0 {
|
||||||
PromptVersion: req.PromptVersion,
|
var cancel context.CancelFunc
|
||||||
ProfileID: req.ProfileID,
|
runContext, cancel = context.WithTimeout(runContext, time.Duration(*req.RunTimeoutSeconds)*time.Second)
|
||||||
Inputs: mappedInputs,
|
defer cancel()
|
||||||
Vars: req.Vars,
|
}
|
||||||
Execution: model,
|
mappedRequest := promptkit.RunRequest{
|
||||||
})
|
PromptID: req.PromptID,
|
||||||
|
PromptVersion: req.PromptVersion,
|
||||||
|
ProfileID: req.ProfileID,
|
||||||
|
SessionID: req.SessionID,
|
||||||
|
Inputs: mappedInputs,
|
||||||
|
Vars: req.Vars,
|
||||||
|
Execution: model,
|
||||||
|
TransientRetries: req.TransientRetries,
|
||||||
|
}
|
||||||
|
var collector *executionreport.Collector
|
||||||
|
if req.IncludeExecutionReport {
|
||||||
|
collector = executionreport.NewCollector()
|
||||||
|
mappedRequest.Observer = collector.Observe
|
||||||
|
}
|
||||||
|
res, err := h.runner.Run(runContext, mappedRequest)
|
||||||
|
var execution *executionreport.Execution
|
||||||
|
if collector != nil {
|
||||||
|
execution = collector.Snapshot()
|
||||||
|
}
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
switch runContext.Err() {
|
||||||
|
case context.DeadlineExceeded:
|
||||||
|
writeRunFailure(w, http.StatusGatewayTimeout, "deadline_exceeded", "run execution deadline exceeded", execution, h.options.MaxResponseBytes)
|
||||||
|
return
|
||||||
|
case context.Canceled:
|
||||||
|
writeRunFailure(w, http.StatusRequestTimeout, "request_canceled", "run request canceled", execution, h.options.MaxResponseBytes)
|
||||||
|
return
|
||||||
|
}
|
||||||
status, code, message := mapRunError(err)
|
status, code, message := mapRunError(err)
|
||||||
writeError(w, status, code, message)
|
writeRunFailure(w, status, code, message, execution, h.options.MaxResponseBytes)
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -130,6 +163,8 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
|||||||
PromptHash: res.PromptHash,
|
PromptHash: res.PromptHash,
|
||||||
RenderedPromptHash: res.RenderedPromptHash,
|
RenderedPromptHash: res.RenderedPromptHash,
|
||||||
SelectedProfileID: res.SelectedProfileID,
|
SelectedProfileID: res.SelectedProfileID,
|
||||||
|
SelectedBackendID: res.SelectedBackendID,
|
||||||
|
SessionID: res.SessionID,
|
||||||
ModelName: res.ModelName,
|
ModelName: res.ModelName,
|
||||||
Endpoint: res.Endpoint,
|
Endpoint: res.Endpoint,
|
||||||
ModelParams: modelParamsDTOFromExecutionTarget(res.EffectiveModelParams),
|
ModelParams: modelParamsDTOFromExecutionTarget(res.EffectiveModelParams),
|
||||||
@@ -148,6 +183,7 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
|||||||
ValidationStatus: string(res.Validation.Status),
|
ValidationStatus: string(res.Validation.Status),
|
||||||
RepairAttemptsUsed: res.Validation.RepairAttempts,
|
RepairAttemptsUsed: res.Validation.RepairAttempts,
|
||||||
},
|
},
|
||||||
|
Execution: execution,
|
||||||
}
|
}
|
||||||
if req.IncludeRawOutput {
|
if req.IncludeRawOutput {
|
||||||
raw := res.RawOutput
|
raw := res.RawOutput
|
||||||
@@ -156,11 +192,19 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
|||||||
writeLimitedJSON(w, http.StatusOK, resp, h.options.MaxResponseBytes)
|
writeLimitedJSON(w, http.StatusOK, resp, h.options.MaxResponseBytes)
|
||||||
}
|
}
|
||||||
|
|
||||||
func executionTargetOverrideFromModelOverrideDTO(dto *modelOverrideRequestDTO) *domain.ExecutionTargetOverride {
|
func writeRunFailure(w http.ResponseWriter, status int, code, message string, execution *executionreport.Execution, maxBytes int64) {
|
||||||
|
if execution == nil {
|
||||||
|
writeError(w, status, code, message)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
writeLimitedJSON(w, status, errorResponse{Error: errorBody{Code: code, Message: message}, Execution: execution}, maxBytes)
|
||||||
|
}
|
||||||
|
|
||||||
|
func executionTargetOverrideFromModelOverrideDTO(dto *modelOverrideRequestDTO) *promptkit.ExecutionTargetOverride {
|
||||||
if dto == nil {
|
if dto == nil {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
return &domain.ExecutionTargetOverride{
|
return &promptkit.ExecutionTargetOverride{
|
||||||
Endpoint: dto.Endpoint,
|
Endpoint: dto.Endpoint,
|
||||||
Model: dto.Model,
|
Model: dto.Model,
|
||||||
Temperature: dto.Temperature,
|
Temperature: dto.Temperature,
|
||||||
@@ -174,9 +218,10 @@ func executionTargetOverrideFromModelOverrideDTO(dto *modelOverrideRequestDTO) *
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func modelParamsDTOFromExecutionTarget(target domain.ExecutionTarget) modelParamsDTO {
|
func modelParamsDTOFromExecutionTarget(target promptkit.ExecutionTarget) modelParamsDTO {
|
||||||
return modelParamsDTO{
|
return modelParamsDTO{
|
||||||
Endpoint: target.Endpoint,
|
Endpoint: target.Endpoint,
|
||||||
|
BackendID: target.BackendID,
|
||||||
Model: target.Model,
|
Model: target.Model,
|
||||||
Temperature: target.Temperature,
|
Temperature: target.Temperature,
|
||||||
MaxTokens: target.MaxTokens,
|
MaxTokens: target.MaxTokens,
|
||||||
@@ -189,7 +234,7 @@ func modelParamsDTOFromExecutionTarget(target domain.ExecutionTarget) modelParam
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func mapValidation(v domain.ValidationResult) validationDTO {
|
func mapValidation(v promptkit.ValidationResult) validationDTO {
|
||||||
return validationDTO{
|
return validationDTO{
|
||||||
Status: string(v.Status),
|
Status: string(v.Status),
|
||||||
Mode: string(v.Mode),
|
Mode: string(v.Mode),
|
||||||
@@ -202,35 +247,33 @@ func mapValidation(v domain.ValidationResult) validationDTO {
|
|||||||
|
|
||||||
func mapRunError(err error) (int, string, string) {
|
func mapRunError(err error) (int, string, string) {
|
||||||
switch {
|
switch {
|
||||||
case errors.Is(err, promptdef.ErrPromptDefinitionNotFound):
|
case errors.Is(err, promptkit.ErrPromptNotFound):
|
||||||
return http.StatusNotFound, "prompt_not_found", "prompt definition not found"
|
return http.StatusNotFound, "prompt_not_found", "prompt definition not found"
|
||||||
case errors.Is(err, profile.ErrProfileNotFound):
|
case errors.Is(err, promptkit.ErrProfileNotFound):
|
||||||
return http.StatusNotFound, "profile_not_found", "execution profile not found"
|
return http.StatusNotFound, "profile_not_found", "execution profile not found"
|
||||||
case errors.Is(err, promptdef.ErrInvalidYAML), errors.Is(err, promptdef.ErrInvalidPromptDefinition):
|
case errors.Is(err, promptkit.ErrProfileRequired):
|
||||||
return http.StatusBadRequest, "prompt_load_failed", "failed to load prompt definition"
|
|
||||||
case errors.Is(err, profile.ErrInvalidYAML), errors.Is(err, profile.ErrInvalidProfile), errors.Is(err, profile.ErrRawAPIKeyNotAllowed):
|
|
||||||
return http.StatusBadRequest, "profile_load_failed", "failed to load execution profile"
|
|
||||||
case errors.Is(err, usecase.ErrProfileRequired):
|
|
||||||
return http.StatusBadRequest, "profile_required", "profile_id is required when prompt default_profile is not set"
|
return http.StatusBadRequest, "profile_required", "profile_id is required when prompt default_profile is not set"
|
||||||
case errors.Is(err, usecase.ErrAPIKeyEnvMissing):
|
case errors.Is(err, promptkit.ErrAPIKeyEnvMissing):
|
||||||
return http.StatusBadRequest, "api_key_env_missing", "api_key_env is set but the environment variable is missing"
|
return http.StatusBadRequest, "api_key_env_missing", "api_key_env is set but the environment variable is missing"
|
||||||
case errors.Is(err, usecase.ErrInvalidRequest):
|
case errors.Is(err, promptkit.ErrPromptLoad):
|
||||||
return http.StatusBadRequest, "invalid_request", "invalid run request"
|
|
||||||
case errors.Is(err, usecase.ErrPromptLoad):
|
|
||||||
return http.StatusBadRequest, "prompt_load_failed", "failed to load prompt definition"
|
return http.StatusBadRequest, "prompt_load_failed", "failed to load prompt definition"
|
||||||
case errors.Is(err, usecase.ErrProfileLoad):
|
case errors.Is(err, promptkit.ErrProfileLoad):
|
||||||
return http.StatusBadRequest, "profile_load_failed", "failed to load execution profile"
|
return http.StatusBadRequest, "profile_load_failed", "failed to load execution profile"
|
||||||
case errors.Is(err, artifact.ErrFileNotAllowed), errors.Is(err, artifact.ErrFileOutsideRoot):
|
case errors.Is(err, promptkit.ErrInvalidRequest):
|
||||||
|
return http.StatusBadRequest, "invalid_request", "invalid run request"
|
||||||
|
case errors.Is(err, ErrFileNotAllowed), errors.Is(err, ErrFileOutsideRoot):
|
||||||
return http.StatusBadRequest, "artifact_not_allowed", "file input artifact is not allowed"
|
return http.StatusBadRequest, "artifact_not_allowed", "file input artifact is not allowed"
|
||||||
case errors.Is(err, artifact.ErrFileTooLarge):
|
case errors.Is(err, ErrFileTooLarge):
|
||||||
return http.StatusRequestEntityTooLarge, "artifact_too_large", "file input artifact is too large"
|
return http.StatusRequestEntityTooLarge, "artifact_too_large", "file input artifact is too large"
|
||||||
case errors.Is(err, usecase.ErrArtifactLoad):
|
case errors.Is(err, promptkit.ErrArtifactLoad):
|
||||||
return http.StatusBadRequest, "artifact_read_failed", "failed to read input artifact"
|
return http.StatusBadRequest, "artifact_read_failed", "failed to read input artifact"
|
||||||
case errors.Is(err, usecase.ErrPromptRender):
|
case errors.Is(err, promptkit.ErrPromptRender):
|
||||||
return http.StatusBadRequest, "prompt_render_failed", "failed to render prompt"
|
return http.StatusBadRequest, "prompt_render_failed", "failed to render prompt"
|
||||||
case errors.Is(err, usecase.ErrLLMGenerate):
|
case errors.Is(err, promptkit.ErrCapacityExceeded):
|
||||||
|
return http.StatusServiceUnavailable, "capacity_exceeded", "model backend capacity is exhausted"
|
||||||
|
case errors.Is(err, promptkit.ErrLLMGenerate), errors.Is(err, promptkit.ErrTransport), errors.Is(err, promptkit.ErrMalformedResponse), errors.Is(err, promptkit.ErrRetriesExhausted):
|
||||||
return http.StatusBadGateway, "llm_failed", "model generation request failed"
|
return http.StatusBadGateway, "llm_failed", "model generation request failed"
|
||||||
case errors.Is(err, usecase.ErrValidation):
|
case errors.Is(err, promptkit.ErrValidation):
|
||||||
return http.StatusInternalServerError, "validation_runtime_failed", "validation runtime failed"
|
return http.StatusInternalServerError, "validation_runtime_failed", "validation runtime failed"
|
||||||
default:
|
default:
|
||||||
return http.StatusInternalServerError, "internal_error", "internal server error"
|
return http.StatusInternalServerError, "internal_error", "internal server error"
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -1,242 +0,0 @@
|
|||||||
package artifact
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"crypto/sha256"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/defaults"
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/domain"
|
|
||||||
"io"
|
|
||||||
"mime"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
ErrUnsupportedRefType = errors.New("unsupported artifact reference type")
|
|
||||||
ErrMissingInlineBody = errors.New("missing body for inline artifact")
|
|
||||||
ErrMissingFilePath = errors.New("missing file path for file artifact")
|
|
||||||
ErrFileNotAllowed = errors.New("file artifact references are not allowed")
|
|
||||||
ErrFileOutsideRoot = errors.New("file artifact path is outside artifact root")
|
|
||||||
ErrFileTooLarge = errors.New("file artifact exceeds size limit")
|
|
||||||
)
|
|
||||||
|
|
||||||
// Reader resolves artifact references into actual artifacts.
|
|
||||||
type Reader interface {
|
|
||||||
Read(ctx context.Context, ref domain.ArtifactRef) (*domain.Artifact, error)
|
|
||||||
}
|
|
||||||
|
|
||||||
// CompositeReader routes artifact resolution based on the reference type.
|
|
||||||
type CompositeReader struct {
|
|
||||||
inlineReader *inlineReader
|
|
||||||
fileReader Reader
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewCompositeReader() Reader {
|
|
||||||
return &CompositeReader{
|
|
||||||
inlineReader: &inlineReader{},
|
|
||||||
fileReader: &fileReader{},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewRestrictedCompositeReader(root string) (Reader, error) {
|
|
||||||
return NewRestrictedCompositeReaderWithLimit(root, 0)
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewRestrictedCompositeReaderWithLimit(root string, maxBytes int64) (Reader, error) {
|
|
||||||
fileReader, err := newRestrictedFileReader(root, maxBytes)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return &CompositeReader{
|
|
||||||
inlineReader: &inlineReader{},
|
|
||||||
fileReader: fileReader,
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *CompositeReader) Read(ctx context.Context, ref domain.ArtifactRef) (*domain.Artifact, error) {
|
|
||||||
select {
|
|
||||||
case <-ctx.Done():
|
|
||||||
return nil, ctx.Err()
|
|
||||||
default:
|
|
||||||
}
|
|
||||||
|
|
||||||
switch ref.Type {
|
|
||||||
case domain.ArtifactRefInline:
|
|
||||||
return c.inlineReader.Read(ctx, ref)
|
|
||||||
case domain.ArtifactRefFile:
|
|
||||||
return c.fileReader.Read(ctx, ref)
|
|
||||||
default:
|
|
||||||
return nil, fmt.Errorf("%w: %s", ErrUnsupportedRefType, ref.Type)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
type inlineReader struct{}
|
|
||||||
|
|
||||||
func (r *inlineReader) Read(ctx context.Context, ref domain.ArtifactRef) (*domain.Artifact, error) {
|
|
||||||
select {
|
|
||||||
case <-ctx.Done():
|
|
||||||
return nil, ctx.Err()
|
|
||||||
default:
|
|
||||||
}
|
|
||||||
|
|
||||||
if ref.Body == "" {
|
|
||||||
return nil, ErrMissingInlineBody
|
|
||||||
}
|
|
||||||
|
|
||||||
body := []byte(ref.Body)
|
|
||||||
return &domain.Artifact{
|
|
||||||
ContentType: defaults.ContentTypeTextPlain,
|
|
||||||
Body: body,
|
|
||||||
Size: int64(len(body)),
|
|
||||||
Hash: fmt.Sprintf("%x", sha256.Sum256(body)),
|
|
||||||
URI: ref.URI,
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
type fileReader struct{}
|
|
||||||
|
|
||||||
func (r *fileReader) Read(ctx context.Context, ref domain.ArtifactRef) (*domain.Artifact, error) {
|
|
||||||
select {
|
|
||||||
case <-ctx.Done():
|
|
||||||
return nil, ctx.Err()
|
|
||||||
default:
|
|
||||||
}
|
|
||||||
|
|
||||||
if ref.URI == "" {
|
|
||||||
return nil, ErrMissingFilePath
|
|
||||||
}
|
|
||||||
|
|
||||||
return readFileArtifact(ref.URI)
|
|
||||||
}
|
|
||||||
|
|
||||||
type deniedFileReader struct{}
|
|
||||||
|
|
||||||
func (r deniedFileReader) Read(ctx context.Context, ref domain.ArtifactRef) (*domain.Artifact, error) {
|
|
||||||
select {
|
|
||||||
case <-ctx.Done():
|
|
||||||
return nil, ctx.Err()
|
|
||||||
default:
|
|
||||||
}
|
|
||||||
|
|
||||||
if ref.URI == "" {
|
|
||||||
return nil, ErrMissingFilePath
|
|
||||||
}
|
|
||||||
return nil, ErrFileNotAllowed
|
|
||||||
}
|
|
||||||
|
|
||||||
type restrictedFileReader struct {
|
|
||||||
root string
|
|
||||||
maxBytes int64
|
|
||||||
}
|
|
||||||
|
|
||||||
func newRestrictedFileReader(root string, maxBytes int64) (Reader, error) {
|
|
||||||
if maxBytes < 0 {
|
|
||||||
return nil, fmt.Errorf("artifact size limit must be greater than or equal to 0")
|
|
||||||
}
|
|
||||||
cleanRoot := strings.TrimSpace(root)
|
|
||||||
if cleanRoot == "" {
|
|
||||||
return deniedFileReader{}, nil
|
|
||||||
}
|
|
||||||
absRoot, err := filepath.Abs(filepath.Clean(cleanRoot))
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("resolve artifact root: %w", err)
|
|
||||||
}
|
|
||||||
return &restrictedFileReader{root: absRoot, maxBytes: maxBytes}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r *restrictedFileReader) Read(ctx context.Context, ref domain.ArtifactRef) (*domain.Artifact, error) {
|
|
||||||
select {
|
|
||||||
case <-ctx.Done():
|
|
||||||
return nil, ctx.Err()
|
|
||||||
default:
|
|
||||||
}
|
|
||||||
|
|
||||||
if ref.URI == "" {
|
|
||||||
return nil, ErrMissingFilePath
|
|
||||||
}
|
|
||||||
|
|
||||||
path, err := r.resolveLexicalPath(ref.URI)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return readFileArtifactWithLimit(path, r.maxBytes)
|
|
||||||
}
|
|
||||||
|
|
||||||
// resolveLexicalPath checks cleaned path containment without resolving symlinks.
|
|
||||||
func (r *restrictedFileReader) resolveLexicalPath(rawPath string) (string, error) {
|
|
||||||
cleanPath := filepath.Clean(strings.TrimSpace(rawPath))
|
|
||||||
var candidate string
|
|
||||||
if filepath.IsAbs(cleanPath) {
|
|
||||||
candidate = cleanPath
|
|
||||||
} else {
|
|
||||||
candidate = filepath.Join(r.root, cleanPath)
|
|
||||||
}
|
|
||||||
|
|
||||||
absCandidate, err := filepath.Abs(candidate)
|
|
||||||
if err != nil {
|
|
||||||
return "", fmt.Errorf("resolve artifact path: %w", err)
|
|
||||||
}
|
|
||||||
absCandidate = filepath.Clean(absCandidate)
|
|
||||||
|
|
||||||
rel, err := filepath.Rel(r.root, absCandidate)
|
|
||||||
if err != nil {
|
|
||||||
return "", fmt.Errorf("compare artifact path to root: %w", err)
|
|
||||||
}
|
|
||||||
if rel == ".." || strings.HasPrefix(rel, ".."+string(filepath.Separator)) || filepath.IsAbs(rel) {
|
|
||||||
return "", ErrFileOutsideRoot
|
|
||||||
}
|
|
||||||
return absCandidate, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func readFileArtifact(path string) (*domain.Artifact, error) {
|
|
||||||
return readFileArtifactWithLimit(path, 0)
|
|
||||||
}
|
|
||||||
|
|
||||||
func readFileArtifactWithLimit(path string, maxBytes int64) (*domain.Artifact, error) {
|
|
||||||
if maxBytes < 0 {
|
|
||||||
return nil, fmt.Errorf("file size limit must be greater than or equal to 0")
|
|
||||||
}
|
|
||||||
|
|
||||||
file, err := os.Open(path)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("failed to read file %s: %w", path, err)
|
|
||||||
}
|
|
||||||
defer file.Close()
|
|
||||||
|
|
||||||
info, err := file.Stat()
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("failed to stat file %s: %w", path, err)
|
|
||||||
}
|
|
||||||
if maxBytes > 0 && info.Size() > maxBytes {
|
|
||||||
return nil, ErrFileTooLarge
|
|
||||||
}
|
|
||||||
|
|
||||||
var reader io.Reader = file
|
|
||||||
if maxBytes > 0 {
|
|
||||||
reader = io.LimitReader(file, maxBytes+1)
|
|
||||||
}
|
|
||||||
data, err := io.ReadAll(reader)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("failed to read file %s: %w", path, err)
|
|
||||||
}
|
|
||||||
if maxBytes > 0 && int64(len(data)) > maxBytes {
|
|
||||||
return nil, ErrFileTooLarge
|
|
||||||
}
|
|
||||||
|
|
||||||
contentType := mime.TypeByExtension(filepath.Ext(path))
|
|
||||||
if contentType == "" {
|
|
||||||
contentType = defaults.ContentTypeTextPlain
|
|
||||||
}
|
|
||||||
|
|
||||||
return &domain.Artifact{
|
|
||||||
Name: filepath.Base(path),
|
|
||||||
ContentType: contentType,
|
|
||||||
Body: data,
|
|
||||||
URI: path,
|
|
||||||
Size: int64(len(data)),
|
|
||||||
Hash: fmt.Sprintf("%x", sha256.Sum256(data)),
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
@@ -1,257 +0,0 @@
|
|||||||
package artifact
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/domain"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestCompositeReader_Read(t *testing.T) {
|
|
||||||
reader := NewCompositeReader()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
t.Run("inline artifact", func(t *testing.T) {
|
|
||||||
ref := domain.ArtifactRef{
|
|
||||||
Type: domain.ArtifactRefInline,
|
|
||||||
Body: "hello world",
|
|
||||||
}
|
|
||||||
art, err := reader.Read(ctx, ref)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error: %v", err)
|
|
||||||
}
|
|
||||||
if string(art.Body) != "hello world" {
|
|
||||||
t.Errorf("expected 'hello world', got %s", string(art.Body))
|
|
||||||
}
|
|
||||||
if art.ContentType != "text/plain" {
|
|
||||||
t.Errorf("expected text/plain content type, got %q", art.ContentType)
|
|
||||||
}
|
|
||||||
if art.Hash != "b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9" {
|
|
||||||
t.Errorf("unexpected hash: %s", art.Hash)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
t.Run("inline artifact missing body", func(t *testing.T) {
|
|
||||||
ref := domain.ArtifactRef{
|
|
||||||
Type: domain.ArtifactRefInline,
|
|
||||||
Body: "",
|
|
||||||
}
|
|
||||||
_, err := reader.Read(ctx, ref)
|
|
||||||
if !errors.Is(err, ErrMissingInlineBody) {
|
|
||||||
t.Errorf("expected ErrMissingInlineBody, got %v", err)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
t.Run("unsupported ref type", func(t *testing.T) {
|
|
||||||
ref := domain.ArtifactRef{
|
|
||||||
Type: domain.ArtifactRefType("unsupported"),
|
|
||||||
URI: "unsupported://bucket/key",
|
|
||||||
}
|
|
||||||
_, err := reader.Read(ctx, ref)
|
|
||||||
if !errors.Is(err, ErrUnsupportedRefType) {
|
|
||||||
t.Error("expected error for unsupported type")
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRestrictedCompositeReader(t *testing.T) {
|
|
||||||
ctx := context.Background()
|
|
||||||
root := t.TempDir()
|
|
||||||
outside := t.TempDir()
|
|
||||||
|
|
||||||
if err := os.WriteFile(filepath.Join(root, "input.txt"), []byte("allowed"), 0o644); err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
if err := os.Mkdir(filepath.Join(root, "nested"), 0o755); err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
if err := os.WriteFile(filepath.Join(outside, "secret.txt"), []byte("denied"), 0o644); err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
reader, err := NewRestrictedCompositeReader(root)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected restricted reader construction, got %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
t.Run("accepts relative contained path", func(t *testing.T) {
|
|
||||||
art, err := reader.Read(ctx, domain.ArtifactRef{Type: domain.ArtifactRefFile, URI: "nested/../input.txt"})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected contained relative path to succeed, got %v", err)
|
|
||||||
}
|
|
||||||
if string(art.Body) != "allowed" {
|
|
||||||
t.Fatalf("unexpected artifact body: %q", string(art.Body))
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
t.Run("accepts absolute contained path", func(t *testing.T) {
|
|
||||||
art, err := reader.Read(ctx, domain.ArtifactRef{Type: domain.ArtifactRefFile, URI: filepath.Join(root, "input.txt")})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected contained absolute path to succeed, got %v", err)
|
|
||||||
}
|
|
||||||
if art.Name != "input.txt" {
|
|
||||||
t.Fatalf("unexpected artifact name: %q", art.Name)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
t.Run("rejects relative traversal outside root", func(t *testing.T) {
|
|
||||||
_, err := reader.Read(ctx, domain.ArtifactRef{Type: domain.ArtifactRefFile, URI: filepath.Join("..", filepath.Base(outside), "secret.txt")})
|
|
||||||
if !errors.Is(err, ErrFileOutsideRoot) {
|
|
||||||
t.Fatalf("expected ErrFileOutsideRoot, got %v", err)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
t.Run("rejects absolute path outside root", func(t *testing.T) {
|
|
||||||
_, err := reader.Read(ctx, domain.ArtifactRef{Type: domain.ArtifactRefFile, URI: filepath.Join(outside, "secret.txt")})
|
|
||||||
if !errors.Is(err, ErrFileOutsideRoot) {
|
|
||||||
t.Fatalf("expected ErrFileOutsideRoot, got %v", err)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRestrictedCompositeReaderFollowsSymlinkInsideRoot(t *testing.T) {
|
|
||||||
ctx := context.Background()
|
|
||||||
root := t.TempDir()
|
|
||||||
outside := t.TempDir()
|
|
||||||
|
|
||||||
target := filepath.Join(outside, "linked.txt")
|
|
||||||
if err := os.WriteFile(target, []byte("linked outside root"), 0o644); err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
link := filepath.Join(root, "linked.txt")
|
|
||||||
if err := os.Symlink(target, link); err != nil {
|
|
||||||
t.Skipf("symlink creation unavailable: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
reader, err := NewRestrictedCompositeReader(root)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected restricted reader construction, got %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
art, err := reader.Read(ctx, domain.ArtifactRef{Type: domain.ArtifactRefFile, URI: "linked.txt"})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected symlink inside root to be followed, got %v", err)
|
|
||||||
}
|
|
||||||
if string(art.Body) != "linked outside root" {
|
|
||||||
t.Fatalf("unexpected artifact body: %q", string(art.Body))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRestrictedCompositeReaderWithoutRootDeniesFileRefs(t *testing.T) {
|
|
||||||
reader, err := NewRestrictedCompositeReader("")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected restricted reader construction, got %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
art, err := reader.Read(context.Background(), domain.ArtifactRef{Type: domain.ArtifactRefInline, Body: "inline"})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected inline ref to work without artifact root, got %v", err)
|
|
||||||
}
|
|
||||||
if string(art.Body) != "inline" {
|
|
||||||
t.Fatalf("unexpected inline body: %q", string(art.Body))
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = reader.Read(context.Background(), domain.ArtifactRef{Type: domain.ArtifactRefFile, URI: "input.txt"})
|
|
||||||
if !errors.Is(err, ErrFileNotAllowed) {
|
|
||||||
t.Fatalf("expected ErrFileNotAllowed, got %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRestrictedCompositeReaderFileSizeLimit(t *testing.T) {
|
|
||||||
ctx := context.Background()
|
|
||||||
root := t.TempDir()
|
|
||||||
if err := os.WriteFile(filepath.Join(root, "exact.txt"), []byte("12345"), 0o644); err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
if err := os.WriteFile(filepath.Join(root, "large.txt"), []byte("123456"), 0o644); err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
reader, err := NewRestrictedCompositeReaderWithLimit(root, 5)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected restricted reader construction, got %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
art, err := reader.Read(ctx, domain.ArtifactRef{Type: domain.ArtifactRefFile, URI: "exact.txt"})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected file at limit to succeed, got %v", err)
|
|
||||||
}
|
|
||||||
if string(art.Body) != "12345" {
|
|
||||||
t.Fatalf("unexpected artifact body: %q", string(art.Body))
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = reader.Read(ctx, domain.ArtifactRef{Type: domain.ArtifactRefFile, URI: "large.txt"})
|
|
||||||
if !errors.Is(err, ErrFileTooLarge) {
|
|
||||||
t.Fatalf("expected ErrFileTooLarge, got %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRestrictedCompositeReaderFileSizeLimitZeroDisablesLimit(t *testing.T) {
|
|
||||||
root := t.TempDir()
|
|
||||||
if err := os.WriteFile(filepath.Join(root, "large.txt"), []byte("123456"), 0o644); err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
reader, err := NewRestrictedCompositeReaderWithLimit(root, 0)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected restricted reader construction, got %v", err)
|
|
||||||
}
|
|
||||||
art, err := reader.Read(context.Background(), domain.ArtifactRef{Type: domain.ArtifactRefFile, URI: "large.txt"})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected unlimited reader to succeed, got %v", err)
|
|
||||||
}
|
|
||||||
if string(art.Body) != "123456" {
|
|
||||||
t.Fatalf("unexpected artifact body: %q", string(art.Body))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestFileReader_Read(t *testing.T) {
|
|
||||||
content := []byte("test file content")
|
|
||||||
tmpFile, err := os.CreateTemp("", "artifact_test_*.txt")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
defer os.Remove(tmpFile.Name())
|
|
||||||
|
|
||||||
if _, err := tmpFile.Write(content); err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
tmpFile.Close()
|
|
||||||
|
|
||||||
reader := NewCompositeReader()
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
t.Run("file artifact loading", func(t *testing.T) {
|
|
||||||
ref := domain.ArtifactRef{
|
|
||||||
Type: domain.ArtifactRefFile,
|
|
||||||
URI: tmpFile.Name(),
|
|
||||||
}
|
|
||||||
art, err := reader.Read(ctx, ref)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unexpected error: %v", err)
|
|
||||||
}
|
|
||||||
if string(art.Body) != string(content) {
|
|
||||||
t.Errorf("expected %s, got %s", string(content), string(art.Body))
|
|
||||||
}
|
|
||||||
if art.Name == "" {
|
|
||||||
t.Error("expected name to be inferred from filename")
|
|
||||||
}
|
|
||||||
if art.Hash != "60f5237ed4049f0382661ef009d2bc42e48c3ceb3edb6600f7024e7ab3b838f3" {
|
|
||||||
t.Errorf("unexpected hash: %s", art.Hash)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
|
|
||||||
t.Run("missing file path", func(t *testing.T) {
|
|
||||||
ref := domain.ArtifactRef{
|
|
||||||
Type: domain.ArtifactRefFile,
|
|
||||||
URI: "",
|
|
||||||
}
|
|
||||||
_, err := reader.Read(ctx, ref)
|
|
||||||
if !errors.Is(err, ErrMissingFilePath) {
|
|
||||||
t.Errorf("expected ErrMissingFilePath, got %v", err)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
@@ -1,250 +0,0 @@
|
|||||||
package config
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"strings"
|
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/defaults"
|
|
||||||
renderformat "gitea.maximumdirect.net/eric/scriptorium/internal/format"
|
|
||||||
"gopkg.in/yaml.v3"
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
DefaultConfigPath = "/etc/scriptorium/config.yml"
|
|
||||||
DefaultConfigPathLocal = "/usr/local/etc/scriptorium/config.yml"
|
|
||||||
)
|
|
||||||
|
|
||||||
var defaultConfigSearchPaths = []string{
|
|
||||||
DefaultConfigPathLocal,
|
|
||||||
DefaultConfigPath,
|
|
||||||
}
|
|
||||||
|
|
||||||
var (
|
|
||||||
ErrConfigNotFound = errors.New("config file not found")
|
|
||||||
ErrInvalidConfigYAML = errors.New("invalid config YAML")
|
|
||||||
ErrInvalidConfig = errors.New("invalid config")
|
|
||||||
)
|
|
||||||
|
|
||||||
// Config is the on-disk YAML shape for application-level settings.
|
|
||||||
type Config struct {
|
|
||||||
PromptDir string `yaml:"prompt_dir"`
|
|
||||||
ProfileDir string `yaml:"profile_dir"`
|
|
||||||
SchemaDir string `yaml:"schema_dir"`
|
|
||||||
Server ServerConfig `yaml:"server"`
|
|
||||||
Defaults DefaultsConfig `yaml:"defaults"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type ServerConfig struct {
|
|
||||||
Addr string `yaml:"addr"`
|
|
||||||
ArtifactRoot string `yaml:"artifact_root"`
|
|
||||||
MaxRequestBytes *int64 `yaml:"max_request_bytes"`
|
|
||||||
MaxArtifactBytes *int64 `yaml:"max_artifact_bytes"`
|
|
||||||
MaxResponseBytes *int64 `yaml:"max_response_bytes"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type DefaultsConfig struct {
|
|
||||||
RenderFormat string `yaml:"render_format"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// AppSettings is the resolved application settings used by adapters.
|
|
||||||
type AppSettings struct {
|
|
||||||
PromptDir string
|
|
||||||
ProfileDir string
|
|
||||||
SchemaDir string
|
|
||||||
ServerAddr string
|
|
||||||
ArtifactRoot string
|
|
||||||
MaxRequestBytes int64
|
|
||||||
MaxArtifactBytes int64
|
|
||||||
MaxResponseBytes int64
|
|
||||||
DefaultRenderFormat renderformat.PreparedRunOutputFormat
|
|
||||||
}
|
|
||||||
|
|
||||||
// CLIOverrides can be applied after config load to enforce precedence.
|
|
||||||
type CLIOverrides struct {
|
|
||||||
PromptDir string
|
|
||||||
ProfileDir string
|
|
||||||
SchemaDir string
|
|
||||||
ServerAddr string
|
|
||||||
ArtifactRoot string
|
|
||||||
MaxRequestBytes *int64
|
|
||||||
MaxArtifactBytes *int64
|
|
||||||
MaxResponseBytes *int64
|
|
||||||
RenderFormat string
|
|
||||||
}
|
|
||||||
|
|
||||||
// BuiltInDefaults returns compile-time application defaults.
|
|
||||||
func BuiltInDefaults() AppSettings {
|
|
||||||
return AppSettings{
|
|
||||||
SchemaDir: defaults.SchemaDirDefault,
|
|
||||||
ServerAddr: defaults.HTTPAddrDefault,
|
|
||||||
MaxRequestBytes: defaults.HTTPMaxRequestBytesDefault,
|
|
||||||
MaxArtifactBytes: defaults.HTTPMaxArtifactBytesDefault,
|
|
||||||
MaxResponseBytes: defaults.HTTPMaxResponseBytesDefault,
|
|
||||||
DefaultRenderFormat: renderformat.DefaultPreparedRunOutputFormat,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// LoadConfig loads and resolves app settings from YAML.
|
|
||||||
//
|
|
||||||
// If explicit is false and the file does not exist, built-in defaults are returned.
|
|
||||||
// If explicit is true, missing file is an error.
|
|
||||||
func LoadConfig(path string, explicit bool) (AppSettings, error) {
|
|
||||||
resolved := BuiltInDefaults()
|
|
||||||
configPath := strings.TrimSpace(path)
|
|
||||||
if configPath == "" {
|
|
||||||
if explicit {
|
|
||||||
configPath = DefaultConfigPath
|
|
||||||
} else {
|
|
||||||
for _, candidate := range defaultConfigSearchPaths {
|
|
||||||
if _, err := os.Stat(candidate); err == nil {
|
|
||||||
configPath = candidate
|
|
||||||
break
|
|
||||||
} else if !errors.Is(err, os.ErrNotExist) {
|
|
||||||
return AppSettings{}, fmt.Errorf("failed to stat config file %q: %w", candidate, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if configPath == "" {
|
|
||||||
if explicit {
|
|
||||||
return AppSettings{}, fmt.Errorf("%w: %s", ErrConfigNotFound, DefaultConfigPath)
|
|
||||||
}
|
|
||||||
return resolved, nil
|
|
||||||
}
|
|
||||||
configPath = filepath.Clean(configPath)
|
|
||||||
|
|
||||||
raw, err := os.ReadFile(configPath)
|
|
||||||
if err != nil {
|
|
||||||
if errors.Is(err, os.ErrNotExist) {
|
|
||||||
if explicit {
|
|
||||||
return AppSettings{}, fmt.Errorf("%w: %s", ErrConfigNotFound, configPath)
|
|
||||||
}
|
|
||||||
return resolved, nil
|
|
||||||
}
|
|
||||||
return AppSettings{}, fmt.Errorf("failed to read config file %q: %w", configPath, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
cfg, err := decodeConfig(raw)
|
|
||||||
if err != nil {
|
|
||||||
return AppSettings{}, err
|
|
||||||
}
|
|
||||||
|
|
||||||
resolved, err = applyConfig(resolved, cfg)
|
|
||||||
if err != nil {
|
|
||||||
return AppSettings{}, err
|
|
||||||
}
|
|
||||||
return resolved, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ApplyCLIOverrides applies CLI-provided overrides over resolved config settings.
|
|
||||||
func ApplyCLIOverrides(base AppSettings, overrides CLIOverrides) (AppSettings, error) {
|
|
||||||
out := base
|
|
||||||
|
|
||||||
if v := strings.TrimSpace(overrides.PromptDir); v != "" {
|
|
||||||
out.PromptDir = filepath.Clean(v)
|
|
||||||
}
|
|
||||||
if v := strings.TrimSpace(overrides.ProfileDir); v != "" {
|
|
||||||
out.ProfileDir = filepath.Clean(v)
|
|
||||||
}
|
|
||||||
if v := strings.TrimSpace(overrides.SchemaDir); v != "" {
|
|
||||||
out.SchemaDir = filepath.Clean(v)
|
|
||||||
}
|
|
||||||
if v := strings.TrimSpace(overrides.ServerAddr); v != "" {
|
|
||||||
out.ServerAddr = v
|
|
||||||
}
|
|
||||||
if v := strings.TrimSpace(overrides.ArtifactRoot); v != "" {
|
|
||||||
out.ArtifactRoot = filepath.Clean(v)
|
|
||||||
}
|
|
||||||
if overrides.MaxRequestBytes != nil {
|
|
||||||
if *overrides.MaxRequestBytes < 0 {
|
|
||||||
return AppSettings{}, fmt.Errorf("%w: server.max_request_bytes must be greater than or equal to 0", ErrInvalidConfig)
|
|
||||||
}
|
|
||||||
out.MaxRequestBytes = *overrides.MaxRequestBytes
|
|
||||||
}
|
|
||||||
if overrides.MaxArtifactBytes != nil {
|
|
||||||
if *overrides.MaxArtifactBytes < 0 {
|
|
||||||
return AppSettings{}, fmt.Errorf("%w: server.max_artifact_bytes must be greater than or equal to 0", ErrInvalidConfig)
|
|
||||||
}
|
|
||||||
out.MaxArtifactBytes = *overrides.MaxArtifactBytes
|
|
||||||
}
|
|
||||||
if overrides.MaxResponseBytes != nil {
|
|
||||||
if *overrides.MaxResponseBytes < 0 {
|
|
||||||
return AppSettings{}, fmt.Errorf("%w: server.max_response_bytes must be greater than or equal to 0", ErrInvalidConfig)
|
|
||||||
}
|
|
||||||
out.MaxResponseBytes = *overrides.MaxResponseBytes
|
|
||||||
}
|
|
||||||
if rawFormat := strings.TrimSpace(overrides.RenderFormat); rawFormat != "" {
|
|
||||||
parsed, err := renderformat.ParsePreparedRunOutputFormat(rawFormat)
|
|
||||||
if err != nil {
|
|
||||||
return AppSettings{}, fmt.Errorf("%w: defaults.render_format: %v", ErrInvalidConfig, err)
|
|
||||||
}
|
|
||||||
out.DefaultRenderFormat = parsed
|
|
||||||
}
|
|
||||||
|
|
||||||
return out, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func decodeConfig(raw []byte) (Config, error) {
|
|
||||||
var cfg Config
|
|
||||||
decoder := yaml.NewDecoder(bytes.NewReader(raw))
|
|
||||||
decoder.KnownFields(true)
|
|
||||||
if err := decoder.Decode(&cfg); err != nil {
|
|
||||||
if errors.Is(err, io.EOF) {
|
|
||||||
return Config{}, nil
|
|
||||||
}
|
|
||||||
return Config{}, fmt.Errorf("%w: %v", ErrInvalidConfigYAML, err)
|
|
||||||
}
|
|
||||||
return cfg, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func applyConfig(base AppSettings, cfg Config) (AppSettings, error) {
|
|
||||||
out := base
|
|
||||||
|
|
||||||
if v := strings.TrimSpace(cfg.PromptDir); v != "" {
|
|
||||||
out.PromptDir = filepath.Clean(v)
|
|
||||||
}
|
|
||||||
if v := strings.TrimSpace(cfg.ProfileDir); v != "" {
|
|
||||||
out.ProfileDir = filepath.Clean(v)
|
|
||||||
}
|
|
||||||
if v := strings.TrimSpace(cfg.SchemaDir); v != "" {
|
|
||||||
out.SchemaDir = filepath.Clean(v)
|
|
||||||
}
|
|
||||||
if v := strings.TrimSpace(cfg.Server.Addr); v != "" {
|
|
||||||
out.ServerAddr = v
|
|
||||||
}
|
|
||||||
if v := strings.TrimSpace(cfg.Server.ArtifactRoot); v != "" {
|
|
||||||
out.ArtifactRoot = filepath.Clean(v)
|
|
||||||
}
|
|
||||||
if cfg.Server.MaxRequestBytes != nil {
|
|
||||||
if *cfg.Server.MaxRequestBytes < 0 {
|
|
||||||
return AppSettings{}, fmt.Errorf("%w: server.max_request_bytes must be greater than or equal to 0", ErrInvalidConfig)
|
|
||||||
}
|
|
||||||
out.MaxRequestBytes = *cfg.Server.MaxRequestBytes
|
|
||||||
}
|
|
||||||
if cfg.Server.MaxArtifactBytes != nil {
|
|
||||||
if *cfg.Server.MaxArtifactBytes < 0 {
|
|
||||||
return AppSettings{}, fmt.Errorf("%w: server.max_artifact_bytes must be greater than or equal to 0", ErrInvalidConfig)
|
|
||||||
}
|
|
||||||
out.MaxArtifactBytes = *cfg.Server.MaxArtifactBytes
|
|
||||||
}
|
|
||||||
if cfg.Server.MaxResponseBytes != nil {
|
|
||||||
if *cfg.Server.MaxResponseBytes < 0 {
|
|
||||||
return AppSettings{}, fmt.Errorf("%w: server.max_response_bytes must be greater than or equal to 0", ErrInvalidConfig)
|
|
||||||
}
|
|
||||||
out.MaxResponseBytes = *cfg.Server.MaxResponseBytes
|
|
||||||
}
|
|
||||||
if rawFormat := strings.TrimSpace(cfg.Defaults.RenderFormat); rawFormat != "" {
|
|
||||||
parsed, err := renderformat.ParsePreparedRunOutputFormat(rawFormat)
|
|
||||||
if err != nil {
|
|
||||||
return AppSettings{}, fmt.Errorf("%w: defaults.render_format: %v", ErrInvalidConfig, err)
|
|
||||||
}
|
|
||||||
out.DefaultRenderFormat = parsed
|
|
||||||
}
|
|
||||||
|
|
||||||
return out, nil
|
|
||||||
}
|
|
||||||
@@ -1,350 +0,0 @@
|
|||||||
package config
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/defaults"
|
|
||||||
renderformat "gitea.maximumdirect.net/eric/scriptorium/internal/format"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestLoadConfigMissingImplicitPathUsesBuiltInDefaults(t *testing.T) {
|
|
||||||
tmp := t.TempDir()
|
|
||||||
missing := filepath.Join(tmp, "missing.yml")
|
|
||||||
|
|
||||||
got, err := LoadConfig(missing, false)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected no error, got %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
want := BuiltInDefaults()
|
|
||||||
if got != want {
|
|
||||||
t.Fatalf("unexpected settings: got=%+v want=%+v", got, want)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestBuiltInDefaultsIncludeHTTPSizeLimits(t *testing.T) {
|
|
||||||
got := BuiltInDefaults()
|
|
||||||
|
|
||||||
if got.MaxRequestBytes != defaults.HTTPMaxRequestBytesDefault {
|
|
||||||
t.Fatalf("unexpected max request bytes: %d", got.MaxRequestBytes)
|
|
||||||
}
|
|
||||||
if got.MaxArtifactBytes != defaults.HTTPMaxArtifactBytesDefault {
|
|
||||||
t.Fatalf("unexpected max artifact bytes: %d", got.MaxArtifactBytes)
|
|
||||||
}
|
|
||||||
if got.MaxResponseBytes != defaults.HTTPMaxResponseBytesDefault {
|
|
||||||
t.Fatalf("unexpected max response bytes: %d", got.MaxResponseBytes)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLoadConfigMissingExplicitPathReturnsError(t *testing.T) {
|
|
||||||
tmp := t.TempDir()
|
|
||||||
missing := filepath.Join(tmp, "missing.yml")
|
|
||||||
|
|
||||||
_, err := LoadConfig(missing, true)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected error for missing explicit config")
|
|
||||||
}
|
|
||||||
if !errors.Is(err, ErrConfigNotFound) {
|
|
||||||
t.Fatalf("expected ErrConfigNotFound, got %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLoadConfigInvalidYAMLReturnsError(t *testing.T) {
|
|
||||||
path := writeConfigFile(t, "config.yml", "prompt_dir: [")
|
|
||||||
|
|
||||||
_, err := LoadConfig(path, true)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected invalid YAML error")
|
|
||||||
}
|
|
||||||
if !errors.Is(err, ErrInvalidConfigYAML) {
|
|
||||||
t.Fatalf("expected ErrInvalidConfigYAML, got %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLoadConfigInvalidYAMLImplicitPathReturnsError(t *testing.T) {
|
|
||||||
path := writeConfigFile(t, "config.yml", "prompt_dir: [")
|
|
||||||
|
|
||||||
_, err := LoadConfig(path, false)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected invalid YAML error")
|
|
||||||
}
|
|
||||||
if !errors.Is(err, ErrInvalidConfigYAML) {
|
|
||||||
t.Fatalf("expected ErrInvalidConfigYAML, got %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLoadConfigUnknownFieldReturnsError(t *testing.T) {
|
|
||||||
path := writeConfigFile(t, "config.yml", "unknown_field: true\n")
|
|
||||||
|
|
||||||
_, err := LoadConfig(path, true)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected unknown field error")
|
|
||||||
}
|
|
||||||
if !errors.Is(err, ErrInvalidConfigYAML) {
|
|
||||||
t.Fatalf("expected ErrInvalidConfigYAML, got %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLoadConfigAPIKeyFieldIsRejectedAsUnknown(t *testing.T) {
|
|
||||||
path := writeConfigFile(t, "config.yml", "api_key: secret\n")
|
|
||||||
|
|
||||||
_, err := LoadConfig(path, true)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected unknown field error for api_key")
|
|
||||||
}
|
|
||||||
if !errors.Is(err, ErrInvalidConfigYAML) {
|
|
||||||
t.Fatalf("expected ErrInvalidConfigYAML, got %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLoadConfigValidConfigSetsDirectoriesAndServerAddr(t *testing.T) {
|
|
||||||
path := writeConfigFile(t, "config.yml", `
|
|
||||||
prompt_dir: ./prompts
|
|
||||||
profile_dir: ./profiles
|
|
||||||
schema_dir: ./schemas
|
|
||||||
server:
|
|
||||||
addr: 127.0.0.1:9090
|
|
||||||
artifact_root: ./artifacts
|
|
||||||
max_request_bytes: 1024
|
|
||||||
max_artifact_bytes: 2048
|
|
||||||
max_response_bytes: 4096
|
|
||||||
defaults:
|
|
||||||
render_format: json
|
|
||||||
`)
|
|
||||||
|
|
||||||
got, err := LoadConfig(path, true)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected no error, got %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if got.PromptDir != filepath.Clean("./prompts") {
|
|
||||||
t.Fatalf("unexpected prompt_dir: %q", got.PromptDir)
|
|
||||||
}
|
|
||||||
if got.ProfileDir != filepath.Clean("./profiles") {
|
|
||||||
t.Fatalf("unexpected profile_dir: %q", got.ProfileDir)
|
|
||||||
}
|
|
||||||
if got.SchemaDir != filepath.Clean("./schemas") {
|
|
||||||
t.Fatalf("unexpected schema_dir: %q", got.SchemaDir)
|
|
||||||
}
|
|
||||||
if got.ServerAddr != "127.0.0.1:9090" {
|
|
||||||
t.Fatalf("unexpected server.addr: %q", got.ServerAddr)
|
|
||||||
}
|
|
||||||
if got.ArtifactRoot != filepath.Clean("./artifacts") {
|
|
||||||
t.Fatalf("unexpected server.artifact_root: %q", got.ArtifactRoot)
|
|
||||||
}
|
|
||||||
if got.MaxRequestBytes != 1024 {
|
|
||||||
t.Fatalf("unexpected server.max_request_bytes: %d", got.MaxRequestBytes)
|
|
||||||
}
|
|
||||||
if got.MaxArtifactBytes != 2048 {
|
|
||||||
t.Fatalf("unexpected server.max_artifact_bytes: %d", got.MaxArtifactBytes)
|
|
||||||
}
|
|
||||||
if got.MaxResponseBytes != 4096 {
|
|
||||||
t.Fatalf("unexpected server.max_response_bytes: %d", got.MaxResponseBytes)
|
|
||||||
}
|
|
||||||
if got.DefaultRenderFormat != renderformat.PreparedRunFormatJSON {
|
|
||||||
t.Fatalf("unexpected defaults.render_format: %q", got.DefaultRenderFormat)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLoadConfigAcceptsZeroHTTPSizeLimits(t *testing.T) {
|
|
||||||
path := writeConfigFile(t, "config.yml", `
|
|
||||||
server:
|
|
||||||
max_request_bytes: 0
|
|
||||||
max_artifact_bytes: 0
|
|
||||||
max_response_bytes: 0
|
|
||||||
`)
|
|
||||||
|
|
||||||
got, err := LoadConfig(path, true)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected no error, got %v", err)
|
|
||||||
}
|
|
||||||
if got.MaxRequestBytes != 0 || got.MaxArtifactBytes != 0 || got.MaxResponseBytes != 0 {
|
|
||||||
t.Fatalf("expected zero limits to be preserved, got request=%d artifact=%d response=%d", got.MaxRequestBytes, got.MaxArtifactBytes, got.MaxResponseBytes)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLoadConfigRejectsNegativeHTTPSizeLimits(t *testing.T) {
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
body string
|
|
||||||
}{
|
|
||||||
{name: "request", body: "server:\n max_request_bytes: -1\n"},
|
|
||||||
{name: "artifact", body: "server:\n max_artifact_bytes: -1\n"},
|
|
||||||
{name: "response", body: "server:\n max_response_bytes: -1\n"},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range tests {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
path := writeConfigFile(t, "config.yml", tc.body)
|
|
||||||
_, err := LoadConfig(path, true)
|
|
||||||
if !errors.Is(err, ErrInvalidConfig) {
|
|
||||||
t.Fatalf("expected ErrInvalidConfig, got %v", err)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLoadConfigEmptyFileResolvesToBuiltInDefaults(t *testing.T) {
|
|
||||||
path := writeConfigFile(t, "config.yml", "")
|
|
||||||
|
|
||||||
got, err := LoadConfig(path, true)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected no error, got %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
want := BuiltInDefaults()
|
|
||||||
if got != want {
|
|
||||||
t.Fatalf("unexpected settings: got=%+v want=%+v", got, want)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLoadConfigImplicitSearchPrefersUsrLocalEtcOverEtc(t *testing.T) {
|
|
||||||
tmp := t.TempDir()
|
|
||||||
localPath := filepath.Join(tmp, "usr-local.yml")
|
|
||||||
etcPath := filepath.Join(tmp, "etc.yml")
|
|
||||||
|
|
||||||
if err := os.WriteFile(localPath, []byte("prompt_dir: ./from-usr-local\n"), 0o644); err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
if err := os.WriteFile(etcPath, []byte("prompt_dir: ./from-etc\n"), 0o644); err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
orig := defaultConfigSearchPaths
|
|
||||||
defaultConfigSearchPaths = []string{localPath, etcPath}
|
|
||||||
t.Cleanup(func() { defaultConfigSearchPaths = orig })
|
|
||||||
|
|
||||||
got, err := LoadConfig("", false)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected no error, got %v", err)
|
|
||||||
}
|
|
||||||
if got.PromptDir != filepath.Clean("./from-usr-local") {
|
|
||||||
t.Fatalf("expected usr-local config to win, got prompt_dir=%q", got.PromptDir)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestLoadConfigImplicitSearchFallsBackToEtcWhenUsrLocalMissing(t *testing.T) {
|
|
||||||
tmp := t.TempDir()
|
|
||||||
missingLocal := filepath.Join(tmp, "missing-local.yml")
|
|
||||||
etcPath := filepath.Join(tmp, "etc.yml")
|
|
||||||
|
|
||||||
if err := os.WriteFile(etcPath, []byte("prompt_dir: ./from-etc\n"), 0o644); err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
orig := defaultConfigSearchPaths
|
|
||||||
defaultConfigSearchPaths = []string{missingLocal, etcPath}
|
|
||||||
t.Cleanup(func() { defaultConfigSearchPaths = orig })
|
|
||||||
|
|
||||||
got, err := LoadConfig("", false)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected no error, got %v", err)
|
|
||||||
}
|
|
||||||
if got.PromptDir != filepath.Clean("./from-etc") {
|
|
||||||
t.Fatalf("expected etc fallback config, got prompt_dir=%q", got.PromptDir)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestApplyCLIOverridesAppliesPrecedence(t *testing.T) {
|
|
||||||
base := AppSettings{
|
|
||||||
PromptDir: "/from/config/prompts",
|
|
||||||
ProfileDir: "/from/config/profiles",
|
|
||||||
SchemaDir: "/from/config/schemas",
|
|
||||||
ServerAddr: ":1234",
|
|
||||||
ArtifactRoot: "/from/config/artifacts",
|
|
||||||
MaxRequestBytes: 111,
|
|
||||||
MaxArtifactBytes: 222,
|
|
||||||
MaxResponseBytes: 333,
|
|
||||||
DefaultRenderFormat: renderformat.PreparedRunFormatJSON,
|
|
||||||
}
|
|
||||||
maxRequestBytes := int64(0)
|
|
||||||
maxArtifactBytes := int64(444)
|
|
||||||
maxResponseBytes := int64(555)
|
|
||||||
|
|
||||||
got, err := ApplyCLIOverrides(base, CLIOverrides{
|
|
||||||
PromptDir: "./prompts-cli",
|
|
||||||
ProfileDir: "./profiles-cli",
|
|
||||||
SchemaDir: "./schemas-cli",
|
|
||||||
ServerAddr: ":8081",
|
|
||||||
ArtifactRoot: "./artifacts-cli",
|
|
||||||
MaxRequestBytes: &maxRequestBytes,
|
|
||||||
MaxArtifactBytes: &maxArtifactBytes,
|
|
||||||
MaxResponseBytes: &maxResponseBytes,
|
|
||||||
RenderFormat: "text",
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected no error, got %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if got.PromptDir != filepath.Clean("./prompts-cli") {
|
|
||||||
t.Fatalf("unexpected prompt dir: %q", got.PromptDir)
|
|
||||||
}
|
|
||||||
if got.ProfileDir != filepath.Clean("./profiles-cli") {
|
|
||||||
t.Fatalf("unexpected profile dir: %q", got.ProfileDir)
|
|
||||||
}
|
|
||||||
if got.SchemaDir != filepath.Clean("./schemas-cli") {
|
|
||||||
t.Fatalf("unexpected schema dir: %q", got.SchemaDir)
|
|
||||||
}
|
|
||||||
if got.ServerAddr != ":8081" {
|
|
||||||
t.Fatalf("unexpected server addr: %q", got.ServerAddr)
|
|
||||||
}
|
|
||||||
if got.ArtifactRoot != filepath.Clean("./artifacts-cli") {
|
|
||||||
t.Fatalf("unexpected artifact root: %q", got.ArtifactRoot)
|
|
||||||
}
|
|
||||||
if got.MaxRequestBytes != 0 {
|
|
||||||
t.Fatalf("unexpected max request bytes: %d", got.MaxRequestBytes)
|
|
||||||
}
|
|
||||||
if got.MaxArtifactBytes != 444 {
|
|
||||||
t.Fatalf("unexpected max artifact bytes: %d", got.MaxArtifactBytes)
|
|
||||||
}
|
|
||||||
if got.MaxResponseBytes != 555 {
|
|
||||||
t.Fatalf("unexpected max response bytes: %d", got.MaxResponseBytes)
|
|
||||||
}
|
|
||||||
if got.DefaultRenderFormat != renderformat.PreparedRunFormatText {
|
|
||||||
t.Fatalf("unexpected render format: %q", got.DefaultRenderFormat)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestApplyCLIOverridesRejectsNegativeHTTPSizeLimits(t *testing.T) {
|
|
||||||
negative := int64(-1)
|
|
||||||
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
overrides CLIOverrides
|
|
||||||
}{
|
|
||||||
{name: "request", overrides: CLIOverrides{MaxRequestBytes: &negative}},
|
|
||||||
{name: "artifact", overrides: CLIOverrides{MaxArtifactBytes: &negative}},
|
|
||||||
{name: "response", overrides: CLIOverrides{MaxResponseBytes: &negative}},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range tests {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
_, err := ApplyCLIOverrides(BuiltInDefaults(), tc.overrides)
|
|
||||||
if !errors.Is(err, ErrInvalidConfig) {
|
|
||||||
t.Fatalf("expected ErrInvalidConfig, got %v", err)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestApplyCLIOverridesInvalidRenderFormatReturnsError(t *testing.T) {
|
|
||||||
_, err := ApplyCLIOverrides(BuiltInDefaults(), CLIOverrides{RenderFormat: "yaml"})
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("expected invalid render format error")
|
|
||||||
}
|
|
||||||
if !errors.Is(err, ErrInvalidConfig) {
|
|
||||||
t.Fatalf("expected ErrInvalidConfig, got %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func writeConfigFile(t *testing.T, name, content string) string {
|
|
||||||
t.Helper()
|
|
||||||
path := filepath.Join(t.TempDir(), name)
|
|
||||||
if err := os.WriteFile(path, []byte(content), 0o644); err != nil {
|
|
||||||
t.Fatalf("failed to write config file: %v", err)
|
|
||||||
}
|
|
||||||
return path
|
|
||||||
}
|
|
||||||
109
internal/config/document.go
Normal file
109
internal/config/document.go
Normal file
@@ -0,0 +1,109 @@
|
|||||||
|
package config
|
||||||
|
|
||||||
|
import (
|
||||||
|
"path/filepath"
|
||||||
|
"strings"
|
||||||
|
|
||||||
|
configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
||||||
|
"gitea.maximumdirect.net/eric/scriptorium/internal/defaults"
|
||||||
|
renderformat "gitea.maximumdirect.net/eric/scriptorium/internal/format"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Document is Scriptorium's ConfigKit-native application configuration shape.
|
||||||
|
type Document struct {
|
||||||
|
PromptDir string `yaml:"prompt_dir"`
|
||||||
|
ProfileDir string `yaml:"profile_dir"`
|
||||||
|
SchemaDir string `yaml:"schema_dir"`
|
||||||
|
TransientRetries *int `yaml:"transient_retries"`
|
||||||
|
Server ServerDocument `yaml:"server"`
|
||||||
|
Defaults DefaultsDocument `yaml:"defaults"`
|
||||||
|
Backends map[string]BackendDocument `yaml:"backends"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type BackendDocument struct {
|
||||||
|
Endpoint string `yaml:"endpoint"`
|
||||||
|
APIKeyEnv string `yaml:"api_key_env"`
|
||||||
|
ExtraParams map[string]any `yaml:"extra_params"`
|
||||||
|
ConcurrencyLimit int `yaml:"concurrency_limit"`
|
||||||
|
QueueCapacity *int `yaml:"queue_capacity"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type ServerDocument struct {
|
||||||
|
Addr string `yaml:"addr"`
|
||||||
|
ArtifactRoot string `yaml:"artifact_root"`
|
||||||
|
MaxRequestBytes int64 `yaml:"max_request_bytes"`
|
||||||
|
MaxArtifactBytes int64 `yaml:"max_artifact_bytes"`
|
||||||
|
MaxResponseBytes int64 `yaml:"max_response_bytes"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type DefaultsDocument struct {
|
||||||
|
RenderFormat string `yaml:"render_format"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func documentDefinition() configkit.Definition[Document] {
|
||||||
|
return configkit.Definition[Document]{
|
||||||
|
Defaults: documentDefaults,
|
||||||
|
Resolve: resolveDocument,
|
||||||
|
Validate: validateDocument,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func documentDefaults() Document {
|
||||||
|
return Document{
|
||||||
|
SchemaDir: defaults.SchemaDirDefault,
|
||||||
|
Server: ServerDocument{
|
||||||
|
Addr: defaults.HTTPAddrDefault,
|
||||||
|
MaxRequestBytes: defaults.HTTPMaxRequestBytesDefault,
|
||||||
|
MaxArtifactBytes: defaults.HTTPMaxArtifactBytesDefault,
|
||||||
|
MaxResponseBytes: defaults.HTTPMaxResponseBytesDefault,
|
||||||
|
},
|
||||||
|
Defaults: DefaultsDocument{RenderFormat: string(renderformat.DefaultPreparedRunOutputFormat)},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func resolveDocument(document *Document, resolution *configkit.Resolution) error {
|
||||||
|
normalizePath := func(path configkit.Path, value *string) {
|
||||||
|
cleaned := strings.TrimSpace(*value)
|
||||||
|
if cleaned != "" {
|
||||||
|
cleaned = filepath.Clean(cleaned)
|
||||||
|
}
|
||||||
|
if cleaned != *value {
|
||||||
|
configkit.Normalize(resolution, path, value, cleaned, "normalized application path")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
normalizeString := func(path configkit.Path, value *string, normalized, reason string) {
|
||||||
|
if normalized != *value {
|
||||||
|
configkit.Normalize(resolution, path, value, normalized, reason)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
normalizePath(configkit.Keys("prompt_dir"), &document.PromptDir)
|
||||||
|
normalizePath(configkit.Keys("profile_dir"), &document.ProfileDir)
|
||||||
|
normalizePath(configkit.Keys("schema_dir"), &document.SchemaDir)
|
||||||
|
normalizePath(configkit.Keys("server", "artifact_root"), &document.Server.ArtifactRoot)
|
||||||
|
normalizeString(configkit.Keys("server", "addr"), &document.Server.Addr,
|
||||||
|
strings.TrimSpace(document.Server.Addr), "trimmed server address")
|
||||||
|
normalizeString(configkit.Keys("defaults", "render_format"), &document.Defaults.RenderFormat,
|
||||||
|
strings.ToLower(strings.TrimSpace(document.Defaults.RenderFormat)), "normalized render format")
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func validateDocument(document *Document, validation *configkit.Validation) {
|
||||||
|
if document.TransientRetries != nil && *document.TransientRetries < 0 {
|
||||||
|
validation.Error(configkit.Keys("transient_retries"), "must be greater than or equal to zero")
|
||||||
|
}
|
||||||
|
if document.Server.MaxRequestBytes < 0 {
|
||||||
|
validation.Error(configkit.Keys("server", "max_request_bytes"), "must be greater than or equal to zero")
|
||||||
|
}
|
||||||
|
if document.Server.MaxArtifactBytes < 0 {
|
||||||
|
validation.Error(configkit.Keys("server", "max_artifact_bytes"), "must be greater than or equal to zero")
|
||||||
|
}
|
||||||
|
if document.Server.MaxResponseBytes < 0 {
|
||||||
|
validation.Error(configkit.Keys("server", "max_response_bytes"), "must be greater than or equal to zero")
|
||||||
|
}
|
||||||
|
switch document.Defaults.RenderFormat {
|
||||||
|
case string(renderformat.OutputFormatText), string(renderformat.OutputFormatJSON):
|
||||||
|
default:
|
||||||
|
validation.Error(configkit.Keys("defaults", "render_format"), "must be text or json")
|
||||||
|
}
|
||||||
|
}
|
||||||
163
internal/config/document_test.go
Normal file
163
internal/config/document_test.go
Normal file
@@ -0,0 +1,163 @@
|
|||||||
|
package config
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"errors"
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
||||||
|
)
|
||||||
|
|
||||||
|
func loadDocumentBytes(content string) (*configkit.Result[Document], error) {
|
||||||
|
return configkit.Load(configkit.Bytes("application.yml", []byte(content)), configkit.Options[Document]{
|
||||||
|
Definition: documentDefinition(),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDocumentDefaultsAndExplicitValues(t *testing.T) {
|
||||||
|
defaultsOnly, err := configkit.Load(configkit.NoSource(), configkit.Options[Document]{Definition: documentDefinition()})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("defaults-only load: %v", err)
|
||||||
|
}
|
||||||
|
if !reflect.DeepEqual(defaultsOnly.Config, documentDefaults()) || len(defaultsOnly.Sources()) != 0 {
|
||||||
|
t.Fatalf("unexpected defaults-only result: %+v sources=%+v", defaultsOnly.Config, defaultsOnly.Sources())
|
||||||
|
}
|
||||||
|
|
||||||
|
result, err := loadDocumentBytes(`prompt_dir: ""
|
||||||
|
profile_dir: ""
|
||||||
|
schema_dir: ""
|
||||||
|
transient_retries: 0
|
||||||
|
server:
|
||||||
|
addr: ""
|
||||||
|
artifact_root: ""
|
||||||
|
max_request_bytes: 0
|
||||||
|
max_artifact_bytes: 0
|
||||||
|
max_response_bytes: 0
|
||||||
|
defaults:
|
||||||
|
render_format: " JSON "
|
||||||
|
backends:
|
||||||
|
local:
|
||||||
|
endpoint: "http://fixture.invalid/v1"
|
||||||
|
queue_capacity: 0
|
||||||
|
extra_params:
|
||||||
|
sample_count: 23
|
||||||
|
`)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("explicit-value load: %v", err)
|
||||||
|
}
|
||||||
|
config := result.Config
|
||||||
|
if config.SchemaDir != "" || config.Server.Addr != "" || config.Server.MaxRequestBytes != 0 || config.Server.MaxArtifactBytes != 0 || config.Server.MaxResponseBytes != 0 {
|
||||||
|
t.Fatalf("explicit empty and zero values did not replace defaults: %+v", config)
|
||||||
|
}
|
||||||
|
if config.TransientRetries == nil || *config.TransientRetries != 0 {
|
||||||
|
t.Fatalf("explicit zero retry budget lost: %+v", config.TransientRetries)
|
||||||
|
}
|
||||||
|
if backend := config.Backends["local"]; backend.QueueCapacity == nil || *backend.QueueCapacity != 0 || backend.ExtraParams["sample_count"] != int64(23) {
|
||||||
|
t.Fatalf("backend presence or dynamic integer changed: %+v", backend)
|
||||||
|
}
|
||||||
|
if config.Defaults.RenderFormat != "json" {
|
||||||
|
t.Fatalf("render format normalization failed: %q", config.Defaults.RenderFormat)
|
||||||
|
}
|
||||||
|
|
||||||
|
nullable, err := loadDocumentBytes("transient_retries: null\nbackends:\n local:\n queue_capacity: null\n")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("nullable-value load: %v", err)
|
||||||
|
}
|
||||||
|
if nullable.Config.TransientRetries != nil || nullable.Config.Backends["local"].QueueCapacity != nil {
|
||||||
|
t.Fatalf("nullable fields did not remain nil: %+v", nullable.Config)
|
||||||
|
}
|
||||||
|
|
||||||
|
nullBackends, err := loadDocumentBytes("backends: null\n")
|
||||||
|
if err != nil || nullBackends.Config.Backends != nil {
|
||||||
|
t.Fatalf("nullable backend map did not remain nil: %+v error=%v", nullBackends, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDocumentRecordsEffectiveNormalization(t *testing.T) {
|
||||||
|
result, err := loadDocumentBytes(`prompt_dir: " ./one/../two "
|
||||||
|
profile_dir: " "
|
||||||
|
server:
|
||||||
|
artifact_root: " ./data/../artifacts "
|
||||||
|
addr: " :9000 "
|
||||||
|
defaults:
|
||||||
|
render_format: " JSON "
|
||||||
|
`)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("load normalized document: %v", err)
|
||||||
|
}
|
||||||
|
if result.Config.PromptDir != "two" || result.Config.ProfileDir != "" || result.Config.Server.ArtifactRoot != "artifacts" || result.Config.Server.Addr != ":9000" {
|
||||||
|
t.Fatalf("unexpected normalized values: %+v", result.Config)
|
||||||
|
}
|
||||||
|
var effective bytes.Buffer
|
||||||
|
if err := result.WriteEffective(&effective); err != nil {
|
||||||
|
t.Fatalf("write effective configuration: %v", err)
|
||||||
|
}
|
||||||
|
for _, fragment := range []string{"prompt_dir: two", "profile_dir: ''", "artifact_root: artifacts", "addr: :9000", "render_format: json"} {
|
||||||
|
if !strings.Contains(effective.String(), fragment) {
|
||||||
|
t.Fatalf("effective output omitted %q: %s", fragment, effective.String())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
explanation, known := result.Explain(configkit.Keys("prompt_dir"))
|
||||||
|
if !known || explanation.Effective.YAML != "two\n" {
|
||||||
|
t.Fatalf("explanation does not agree with effective value: %+v known=%t", explanation, known)
|
||||||
|
}
|
||||||
|
found := false
|
||||||
|
for _, change := range explanation.History {
|
||||||
|
if change.Origin.Operation == configkit.ChangeNormalization {
|
||||||
|
found = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !found {
|
||||||
|
t.Fatalf("normalization was not recorded: %+v", explanation.History)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDocumentValidationIsSafeAndPathSpecific(t *testing.T) {
|
||||||
|
for _, tc := range []struct{ name, content, path string }{
|
||||||
|
{"negative retry", "transient_retries: -9173\n", "/transient_retries"},
|
||||||
|
{"negative request limit", "server:\n max_request_bytes: -9173\n", "/server/max_request_bytes"},
|
||||||
|
{"negative artifact limit", "server:\n max_artifact_bytes: -9173\n", "/server/max_artifact_bytes"},
|
||||||
|
{"negative response limit", "server:\n max_response_bytes: -9173\n", "/server/max_response_bytes"},
|
||||||
|
{"empty format", "defaults:\n render_format: \"\"\n", "/defaults/render_format"},
|
||||||
|
{"unknown format", "defaults:\n render_format: private-invalid-value\n", "/defaults/render_format"},
|
||||||
|
} {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
_, err := loadDocumentBytes(tc.content)
|
||||||
|
var loadError *configkit.LoadError
|
||||||
|
if !errors.As(err, &loadError) {
|
||||||
|
t.Fatalf("expected typed validation error, got %v", err)
|
||||||
|
}
|
||||||
|
found := false
|
||||||
|
for _, diagnostic := range loadError.Diagnostics() {
|
||||||
|
if diagnostic.Code == configkit.CodeValidateError && diagnostic.Path.String() == tc.path {
|
||||||
|
found = true
|
||||||
|
}
|
||||||
|
if strings.Contains(diagnostic.Message, "9173") || strings.Contains(diagnostic.Message, "private-invalid-value") {
|
||||||
|
t.Fatalf("diagnostic disclosed rejected value: %+v", diagnostic)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if !found {
|
||||||
|
t.Fatalf("expected validation at %s, got %+v", tc.path, loadError.Diagnostics())
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDocumentRejectsNativeShapeErrors(t *testing.T) {
|
||||||
|
for _, content := range []string{
|
||||||
|
"server: null\n",
|
||||||
|
"defaults: null\n",
|
||||||
|
"server:\n addr: null\n",
|
||||||
|
"server:\n max_request_bytes: null\n",
|
||||||
|
"defaults:\n render_format: null\n",
|
||||||
|
"server:\n unknown_field: 1\n",
|
||||||
|
"backends:\n local:\n unknown_field: 1\n",
|
||||||
|
} {
|
||||||
|
_, err := loadDocumentBytes(content)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatalf("unexpected acceptance of %q", content)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
96
internal/config/load.go
Normal file
96
internal/config/load.go
Normal file
@@ -0,0 +1,96 @@
|
|||||||
|
package config
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"sort"
|
||||||
|
|
||||||
|
configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
||||||
|
renderformat "gitea.maximumdirect.net/eric/scriptorium/internal/format"
|
||||||
|
)
|
||||||
|
|
||||||
|
// LoadOptions selects one application source and explicit configuration values.
|
||||||
|
type LoadOptions struct {
|
||||||
|
Path string
|
||||||
|
Explicit bool
|
||||||
|
Overlay string
|
||||||
|
Overrides []configkit.Override
|
||||||
|
}
|
||||||
|
|
||||||
|
// Load resolves one ConfigKit document and retains its inspection snapshot.
|
||||||
|
func Load(options LoadOptions) (*configkit.Result[Document], error) {
|
||||||
|
var source configkit.Source
|
||||||
|
fileBacked := false
|
||||||
|
if options.Explicit {
|
||||||
|
source = configkit.File(options.Path)
|
||||||
|
fileBacked = true
|
||||||
|
} else {
|
||||||
|
selected := ""
|
||||||
|
for _, candidate := range defaultConfigSearchPaths {
|
||||||
|
if _, err := os.Stat(candidate); err == nil {
|
||||||
|
selected = candidate
|
||||||
|
break
|
||||||
|
} else if !errors.Is(err, os.ErrNotExist) {
|
||||||
|
reason := "filesystem error"
|
||||||
|
if errors.Is(err, os.ErrPermission) {
|
||||||
|
reason = "permission denied"
|
||||||
|
}
|
||||||
|
return nil, fmt.Errorf("cannot inspect configuration path %q: %s", candidate, reason)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if selected == "" {
|
||||||
|
source = configkit.NoSource()
|
||||||
|
} else {
|
||||||
|
source = configkit.File(selected)
|
||||||
|
fileBacked = true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
result, err := configkit.Load(source, configkit.Options[Document]{
|
||||||
|
Definition: documentDefinition(),
|
||||||
|
Imports: fileBacked,
|
||||||
|
Overlay: options.Overlay,
|
||||||
|
Overrides: options.Overrides,
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("load application configuration: %w", err)
|
||||||
|
}
|
||||||
|
return result, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Settings converts a validated document without another merge or normalization.
|
||||||
|
func Settings(document Document) AppSettings {
|
||||||
|
settings := AppSettings{
|
||||||
|
PromptDir: document.PromptDir,
|
||||||
|
ProfileDir: document.ProfileDir,
|
||||||
|
SchemaDir: document.SchemaDir,
|
||||||
|
ServerAddr: document.Server.Addr,
|
||||||
|
ArtifactRoot: document.Server.ArtifactRoot,
|
||||||
|
MaxRequestBytes: document.Server.MaxRequestBytes,
|
||||||
|
MaxArtifactBytes: document.Server.MaxArtifactBytes,
|
||||||
|
MaxResponseBytes: document.Server.MaxResponseBytes,
|
||||||
|
DefaultRenderFormat: renderformat.PreparedRunOutputFormat(document.Defaults.RenderFormat),
|
||||||
|
TransientRetries: document.TransientRetries,
|
||||||
|
}
|
||||||
|
if document.Backends != nil {
|
||||||
|
ids := make([]string, 0, len(document.Backends))
|
||||||
|
for id := range document.Backends {
|
||||||
|
ids = append(ids, id)
|
||||||
|
}
|
||||||
|
sort.Strings(ids)
|
||||||
|
settings.Backends = make([]BackendSettings, 0, len(ids))
|
||||||
|
for _, id := range ids {
|
||||||
|
backend := document.Backends[id]
|
||||||
|
settings.Backends = append(settings.Backends, BackendSettings{
|
||||||
|
ID: id,
|
||||||
|
Endpoint: backend.Endpoint,
|
||||||
|
APIKeyEnv: backend.APIKeyEnv,
|
||||||
|
ExtraParams: backend.ExtraParams,
|
||||||
|
ConcurrencyLimit: backend.ConcurrencyLimit,
|
||||||
|
QueueCapacity: backend.QueueCapacity,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return settings
|
||||||
|
}
|
||||||
233
internal/config/load_test.go
Normal file
233
internal/config/load_test.go
Normal file
@@ -0,0 +1,233 @@
|
|||||||
|
package config
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"reflect"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
configkit "gitea.maximumdirect.net/eric/ConfigKit"
|
||||||
|
)
|
||||||
|
|
||||||
|
func useConfigSearchPaths(t *testing.T, paths ...string) {
|
||||||
|
t.Helper()
|
||||||
|
previous := defaultConfigSearchPaths
|
||||||
|
defaultConfigSearchPaths = paths
|
||||||
|
t.Cleanup(func() { defaultConfigSearchPaths = previous })
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeApplicationFile(t *testing.T, path, body string) {
|
||||||
|
t.Helper()
|
||||||
|
if err := os.WriteFile(path, []byte(body), 0o600); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadSelectsOrderedSourceAndKeepsItsSnapshot(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
first := filepath.Join(dir, "first.yml")
|
||||||
|
second := filepath.Join(dir, "second.yml")
|
||||||
|
writeApplicationFile(t, first, "prompt_dir: ./first\n")
|
||||||
|
writeApplicationFile(t, second, "prompt_dir: ./second\n")
|
||||||
|
useConfigSearchPaths(t, first, second)
|
||||||
|
|
||||||
|
result, err := Load(LoadOptions{Path: filepath.Join(dir, "ignored.yml")})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("load first implicit source: %v", err)
|
||||||
|
}
|
||||||
|
if result.Config.PromptDir != "first" || len(result.Sources()) != 1 || result.Sources()[0].Path != first {
|
||||||
|
t.Fatalf("unexpected implicit source: config=%+v sources=%+v", result.Config, result.Sources())
|
||||||
|
}
|
||||||
|
writeApplicationFile(t, first, "prompt_dir: ./changed\n")
|
||||||
|
if result.Config.PromptDir != "first" {
|
||||||
|
t.Fatalf("result did not retain resolved snapshot: %+v", result.Config)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := os.Remove(first); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
result, err = Load(LoadOptions{})
|
||||||
|
if err != nil || result.Config.PromptDir != "second" || result.Sources()[0].Path != second {
|
||||||
|
t.Fatalf("second implicit source not selected: result=%+v err=%v", result, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
result, err = Load(LoadOptions{Path: first, Explicit: true})
|
||||||
|
if result != nil || err == nil {
|
||||||
|
t.Fatalf("missing explicit source was accepted: result=%+v err=%v", result, err)
|
||||||
|
}
|
||||||
|
var loadError *configkit.LoadError
|
||||||
|
if !errors.As(err, &loadError) {
|
||||||
|
t.Fatalf("typed load error was lost: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadRejectsExplicitEmptyAndDistinguishesEmptyFile(t *testing.T) {
|
||||||
|
useConfigSearchPaths(t, filepath.Join(t.TempDir(), "absent.yml"))
|
||||||
|
if _, err := Load(LoadOptions{Explicit: true, Path: ""}); err == nil {
|
||||||
|
t.Fatal("explicit empty path was accepted")
|
||||||
|
} else {
|
||||||
|
var loadError *configkit.LoadError
|
||||||
|
if !errors.As(err, &loadError) {
|
||||||
|
t.Fatalf("expected upstream source diagnostic, got %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
dir := t.TempDir()
|
||||||
|
empty := filepath.Join(dir, "empty.yml")
|
||||||
|
writeApplicationFile(t, empty, "")
|
||||||
|
if _, err := Load(LoadOptions{Path: empty, Explicit: true}); err == nil {
|
||||||
|
t.Fatal("empty file was treated as defaults-only")
|
||||||
|
}
|
||||||
|
writeApplicationFile(t, empty, "{}\n")
|
||||||
|
result, err := Load(LoadOptions{Path: empty, Explicit: true})
|
||||||
|
if err != nil || !reflect.DeepEqual(result.Config, documentDefaults()) {
|
||||||
|
t.Fatalf("empty mapping did not load defaults: result=%+v err=%v", result, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadDefaultsOnlyAndOverridesBeforeValidation(t *testing.T) {
|
||||||
|
useConfigSearchPaths(t, filepath.Join(t.TempDir(), "absent.yml"))
|
||||||
|
result, err := Load(LoadOptions{})
|
||||||
|
if err != nil || !reflect.DeepEqual(result.Config, documentDefaults()) || len(result.Sources()) != 0 {
|
||||||
|
t.Fatalf("defaults-only load: result=%+v err=%v", result, err)
|
||||||
|
}
|
||||||
|
var effective strings.Builder
|
||||||
|
if err := result.WriteEffective(&effective); err != nil || !strings.Contains(effective.String(), "render_format: text") || len(result.Sources()) != 0 {
|
||||||
|
t.Fatalf("defaults-only inspection changed: effective=%q err=%v sources=%+v", effective.String(), err, result.Sources())
|
||||||
|
}
|
||||||
|
|
||||||
|
result, err = Load(LoadOptions{Overrides: []configkit.Override{{
|
||||||
|
Path: configkit.Keys("server", "max_request_bytes"), Value: int64(0), Flag: "--max-request-bytes",
|
||||||
|
}}})
|
||||||
|
if err != nil || result.Config.Server.MaxRequestBytes != 0 || len(result.Sources()) != 1 || result.Sources()[0].Layer != configkit.LayerCLI {
|
||||||
|
t.Fatalf("defaults-only override lost: result=%+v err=%v", result, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
path := filepath.Join(t.TempDir(), "invalid.yml")
|
||||||
|
writeApplicationFile(t, path, "defaults:\n render_format: invalid-choice\n")
|
||||||
|
result, err = Load(LoadOptions{Path: path, Explicit: true, Overrides: []configkit.Override{{
|
||||||
|
Path: configkit.Keys("defaults", "render_format"), Value: "json", Flag: "--render-format",
|
||||||
|
}}})
|
||||||
|
if err != nil || result.Config.Defaults.RenderFormat != "json" {
|
||||||
|
t.Fatalf("override did not precede validation: result=%+v err=%v", result, err)
|
||||||
|
}
|
||||||
|
if len(result.Sources()) != 2 || result.Sources()[0].Layer != configkit.LayerBase || result.Sources()[1].Layer != configkit.LayerCLI {
|
||||||
|
t.Fatalf("source order changed: %+v", result.Sources())
|
||||||
|
}
|
||||||
|
writeApplicationFile(t, path, "defaults: [\n")
|
||||||
|
if _, err := Load(LoadOptions{Path: path, Explicit: true, Overrides: []configkit.Override{{
|
||||||
|
Path: configkit.Keys("defaults", "render_format"), Value: "json", Flag: "--render-format",
|
||||||
|
}}}); err == nil {
|
||||||
|
t.Fatal("override bypassed malformed lower-level YAML")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestSettingsCopiesResolvedValuesAndSortsBackends(t *testing.T) {
|
||||||
|
result, err := loadDocumentBytes(`schema_dir: ""
|
||||||
|
transient_retries: 0
|
||||||
|
server:
|
||||||
|
addr: ""
|
||||||
|
artifact_root: ""
|
||||||
|
max_request_bytes: 0
|
||||||
|
defaults:
|
||||||
|
render_format: json
|
||||||
|
backends:
|
||||||
|
zed:
|
||||||
|
endpoint: http://zed.invalid/v1
|
||||||
|
extra_params:
|
||||||
|
count: 4
|
||||||
|
alpha:
|
||||||
|
queue_capacity: 0
|
||||||
|
`)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
settings := Settings(result.Config)
|
||||||
|
if settings.SchemaDir != "" || settings.ServerAddr != "" || settings.MaxRequestBytes != 0 || settings.DefaultRenderFormat != "json" {
|
||||||
|
t.Fatalf("resolved scalar values changed: %+v", settings)
|
||||||
|
}
|
||||||
|
if settings.TransientRetries == nil || *settings.TransientRetries != 0 {
|
||||||
|
t.Fatalf("retry presence lost: %+v", settings.TransientRetries)
|
||||||
|
}
|
||||||
|
if len(settings.Backends) != 2 || settings.Backends[0].ID != "alpha" || settings.Backends[1].ID != "zed" {
|
||||||
|
t.Fatalf("backend order changed: %+v", settings.Backends)
|
||||||
|
}
|
||||||
|
if settings.Backends[0].QueueCapacity == nil || *settings.Backends[0].QueueCapacity != 0 || settings.Backends[1].QueueCapacity != nil {
|
||||||
|
t.Fatalf("queue presence changed: %+v", settings.Backends)
|
||||||
|
}
|
||||||
|
if value := settings.Backends[1].ExtraParams["count"]; value != int64(4) {
|
||||||
|
t.Fatalf("dynamic number changed shape: %T %v", value, value)
|
||||||
|
}
|
||||||
|
|
||||||
|
if got := Settings(documentDefaults()); got.TransientRetries != nil || got.Backends != nil {
|
||||||
|
t.Fatalf("default nullable values changed: %+v", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadDiscoveryErrorQuotesPath(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
loop := filepath.Join(dir, "loop-\n.yml")
|
||||||
|
if err := os.Symlink(loop, loop); err != nil {
|
||||||
|
t.Skipf("symlink unavailable: %v", err)
|
||||||
|
}
|
||||||
|
useConfigSearchPaths(t, loop)
|
||||||
|
_, err := Load(LoadOptions{})
|
||||||
|
if err == nil || !strings.Contains(err.Error(), `\n`) || strings.Contains(err.Error(), "loop-\n.yml") {
|
||||||
|
t.Fatalf("discovery error did not quote path safely: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadComposesExplicitImportsAndSelectedOverlay(t *testing.T) {
|
||||||
|
dir := t.TempDir()
|
||||||
|
if err := os.MkdirAll(filepath.Join(dir, "fragments"), 0o700); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if err := os.MkdirAll(filepath.Join(dir, "overlays"), 0o700); err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
base := filepath.Join(dir, "config.yml")
|
||||||
|
writeApplicationFile(t, base, "configkit:\n imports:\n - glob: fragments/*.yml\nprompt_dir: ./base-prompts\nserver:\n addr: :8081\n")
|
||||||
|
writeApplicationFile(t, filepath.Join(dir, "fragments", "a.yml"), "backends:\n alpha:\n endpoint: http://alpha.invalid/v1\n")
|
||||||
|
writeApplicationFile(t, filepath.Join(dir, "fragments", "b.yml"), "backends:\n beta:\n endpoint: http://beta.invalid/v1\n")
|
||||||
|
writeApplicationFile(t, filepath.Join(dir, "overlays", "local.yml"), "prompt_dir: ./overlay-prompts\nserver:\n addr: :9090\n")
|
||||||
|
|
||||||
|
result, err := Load(LoadOptions{Path: base, Explicit: true})
|
||||||
|
if err != nil || result.Config.PromptDir != "base-prompts" || len(result.Config.Backends) != 2 || len(result.Sources()) != 3 {
|
||||||
|
t.Fatalf("disjoint imports did not compose: result=%+v err=%v", result, err)
|
||||||
|
}
|
||||||
|
result, err = Load(LoadOptions{Path: base, Explicit: true, Overlay: "local", Overrides: []configkit.Override{{
|
||||||
|
Path: configkit.Keys("server", "addr"), Value: ":7070", Flag: "--addr",
|
||||||
|
}}})
|
||||||
|
if err != nil || result.Config.PromptDir != "overlay-prompts" || result.Config.Server.Addr != ":7070" || len(result.Sources()) != 5 {
|
||||||
|
t.Fatalf("overlay or explicit override changed: result=%+v err=%v", result, err)
|
||||||
|
}
|
||||||
|
if _, err := Load(LoadOptions{Path: base, Explicit: true, Overlay: "missing"}); err == nil {
|
||||||
|
t.Fatal("missing selected overlay accepted")
|
||||||
|
}
|
||||||
|
writeApplicationFile(t, filepath.Join(dir, "fragments", "b.yml"), "backends:\n alpha:\n endpoint: http://conflict.invalid/v1\n")
|
||||||
|
if _, err := Load(LoadOptions{Path: base, Explicit: true}); err == nil {
|
||||||
|
t.Fatal("conflicting import accepted")
|
||||||
|
} else {
|
||||||
|
var loadError *configkit.LoadError
|
||||||
|
if !errors.As(err, &loadError) {
|
||||||
|
t.Fatalf("conflict lost structured diagnostic: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestLoadRejectsOverlayWithoutBase(t *testing.T) {
|
||||||
|
useConfigSearchPaths(t, filepath.Join(t.TempDir(), "absent.yml"))
|
||||||
|
if _, err := Load(LoadOptions{Overlay: "local"}); err == nil {
|
||||||
|
t.Fatal("overlay without base accepted")
|
||||||
|
} else {
|
||||||
|
var loadError *configkit.LoadError
|
||||||
|
if !errors.As(err, &loadError) {
|
||||||
|
t.Fatalf("no-base overlay lost structured diagnostic: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if _, err := Load(LoadOptions{Overlay: "default"}); err != nil {
|
||||||
|
t.Fatalf("default must select no overlay: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
37
internal/config/settings.go
Normal file
37
internal/config/settings.go
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
package config
|
||||||
|
|
||||||
|
import renderformat "gitea.maximumdirect.net/eric/scriptorium/internal/format"
|
||||||
|
|
||||||
|
const (
|
||||||
|
DefaultConfigPath = "/etc/scriptorium/config.yml"
|
||||||
|
DefaultConfigPathLocal = "/usr/local/etc/scriptorium/config.yml"
|
||||||
|
)
|
||||||
|
|
||||||
|
var defaultConfigSearchPaths = []string{
|
||||||
|
DefaultConfigPathLocal,
|
||||||
|
DefaultConfigPath,
|
||||||
|
}
|
||||||
|
|
||||||
|
// AppSettings holds the validated application values used by executable adapters.
|
||||||
|
type AppSettings struct {
|
||||||
|
PromptDir string
|
||||||
|
ProfileDir string
|
||||||
|
SchemaDir string
|
||||||
|
ServerAddr string
|
||||||
|
ArtifactRoot string
|
||||||
|
MaxRequestBytes int64
|
||||||
|
MaxArtifactBytes int64
|
||||||
|
MaxResponseBytes int64
|
||||||
|
DefaultRenderFormat renderformat.PreparedRunOutputFormat
|
||||||
|
Backends []BackendSettings
|
||||||
|
TransientRetries *int
|
||||||
|
}
|
||||||
|
|
||||||
|
type BackendSettings struct {
|
||||||
|
ID string
|
||||||
|
Endpoint string
|
||||||
|
APIKeyEnv string
|
||||||
|
ExtraParams map[string]any
|
||||||
|
ConcurrencyLimit int
|
||||||
|
QueueCapacity *int
|
||||||
|
}
|
||||||
@@ -1,39 +1,13 @@
|
|||||||
package defaults
|
package defaults
|
||||||
|
|
||||||
import (
|
import "time"
|
||||||
"time"
|
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/domain"
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
const (
|
||||||
HTTPAddrDefault = ":8080"
|
HTTPAddrDefault = ":8080"
|
||||||
SchemaDirDefault = "."
|
SchemaDirDefault = "."
|
||||||
OutputArtifactName = "output"
|
|
||||||
ContentTypeTextPlain = "text/plain"
|
|
||||||
ContentTypeTextMarkdown = "text/markdown"
|
|
||||||
ContentTypeApplicationJSON = "application/json"
|
|
||||||
OpenAIChatCompletionsPath = "/chat/completions"
|
|
||||||
HTTPMaxRequestBytesDefault = 16 * 1024 * 1024
|
HTTPMaxRequestBytesDefault = 16 * 1024 * 1024
|
||||||
HTTPMaxArtifactBytesDefault = 16 * 1024 * 1024
|
HTTPMaxArtifactBytesDefault = 16 * 1024 * 1024
|
||||||
HTTPMaxResponseBytesDefault = 16 * 1024 * 1024
|
HTTPMaxResponseBytesDefault = 16 * 1024 * 1024
|
||||||
|
|
||||||
ExecutionDefaultTemperature = 0.0
|
|
||||||
ExecutionDefaultMaxTokens = 0
|
|
||||||
ExecutionDefaultTopP = 1.0
|
|
||||||
ExecutionDefaultTimeoutSeconds = 600
|
|
||||||
)
|
)
|
||||||
|
|
||||||
var (
|
var HTTPReadHeaderTimeoutDefault = 10 * time.Second
|
||||||
LLMRequestTimeoutDefault = 10 * time.Minute
|
|
||||||
HTTPReadHeaderTimeoutDefault = 10 * time.Second
|
|
||||||
)
|
|
||||||
|
|
||||||
func ExecutionTargetDefault() domain.ExecutionTarget {
|
|
||||||
return domain.ExecutionTarget{
|
|
||||||
Temperature: ExecutionDefaultTemperature,
|
|
||||||
MaxTokens: ExecutionDefaultMaxTokens,
|
|
||||||
TopP: ExecutionDefaultTopP,
|
|
||||||
TimeoutSeconds: ExecutionDefaultTimeoutSeconds,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|||||||
@@ -1,288 +0,0 @@
|
|||||||
package domain
|
|
||||||
|
|
||||||
import (
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ArtifactRefType defines how an artifact is referenced.
|
|
||||||
type ArtifactRefType string
|
|
||||||
|
|
||||||
const (
|
|
||||||
ArtifactRefInline ArtifactRefType = "inline"
|
|
||||||
ArtifactRefFile ArtifactRefType = "file"
|
|
||||||
)
|
|
||||||
|
|
||||||
// OutputFormat defines the desired format of the generated artifact.
|
|
||||||
type OutputFormat string
|
|
||||||
|
|
||||||
const (
|
|
||||||
FormatText OutputFormat = "text"
|
|
||||||
FormatMarkdown OutputFormat = "markdown"
|
|
||||||
FormatJSON OutputFormat = "json"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ValidationMode defines how the output should be validated.
|
|
||||||
type ValidationMode string
|
|
||||||
|
|
||||||
const (
|
|
||||||
ValidationNone ValidationMode = "none"
|
|
||||||
ValidationBasic ValidationMode = "basic"
|
|
||||||
ValidationJSON ValidationMode = "json"
|
|
||||||
ValidationJSONSchema ValidationMode = "json_schema"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ValidationStatus defines the result of a validation check.
|
|
||||||
type ValidationStatus string
|
|
||||||
|
|
||||||
const (
|
|
||||||
ValidationPassed ValidationStatus = "passed"
|
|
||||||
ValidationFailed ValidationStatus = "failed"
|
|
||||||
ValidationSkipped ValidationStatus = "skipped"
|
|
||||||
)
|
|
||||||
|
|
||||||
// CacheControlType defines provider cache behavior for prompt content.
|
|
||||||
type CacheControlType string
|
|
||||||
|
|
||||||
const (
|
|
||||||
CacheControlEphemeral CacheControlType = "ephemeral"
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
// SessionIDMaxLength is OpenRouter's documented maximum session_id length.
|
|
||||||
SessionIDMaxLength = 256
|
|
||||||
)
|
|
||||||
|
|
||||||
// CacheControl describes provider cache metadata attached to prompt content.
|
|
||||||
type CacheControl struct {
|
|
||||||
Type CacheControlType `yaml:"type" json:"type"`
|
|
||||||
TTL string `yaml:"ttl,omitempty" json:"ttl,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// RunRequest represents a request to generate a single artifact.
|
|
||||||
type RunRequest struct {
|
|
||||||
PromptID string
|
|
||||||
PromptVersion string
|
|
||||||
ProfileID string
|
|
||||||
APIKey string `json:"-" yaml:"-"`
|
|
||||||
Inputs map[string]ArtifactRef
|
|
||||||
Vars map[string]string
|
|
||||||
Execution *ExecutionTargetOverride
|
|
||||||
Validation *OutputContract
|
|
||||||
Metadata map[string]string
|
|
||||||
}
|
|
||||||
|
|
||||||
// RunResult represents the complete result of a prompt execution run.
|
|
||||||
type RunResult struct {
|
|
||||||
RunID string
|
|
||||||
Artifact Artifact
|
|
||||||
RawOutput string
|
|
||||||
Validation ValidationResult
|
|
||||||
PromptID string
|
|
||||||
PromptVersion string
|
|
||||||
PromptHash string
|
|
||||||
RenderedPromptHash string
|
|
||||||
SelectedProfileID string
|
|
||||||
ModelName string
|
|
||||||
Endpoint string
|
|
||||||
EffectiveModelParams ExecutionTarget
|
|
||||||
InputHashes map[string]string
|
|
||||||
Usage TokenUsage
|
|
||||||
StartTime time.Time
|
|
||||||
EndTime time.Time
|
|
||||||
Duration time.Duration
|
|
||||||
}
|
|
||||||
|
|
||||||
// PreparedRun contains pre-LLM execution state from the prepare/render phase.
|
|
||||||
// It must never include resolved API key values, model output, or validation data.
|
|
||||||
type PreparedRun struct {
|
|
||||||
PromptID string `json:"prompt_id"`
|
|
||||||
PromptVersion string `json:"prompt_version,omitempty"`
|
|
||||||
PromptHash string `json:"prompt_hash,omitempty"`
|
|
||||||
SelectedProfileID string `json:"selected_profile_id"`
|
|
||||||
EffectiveModelParams ExecutionTarget `json:"effective_model_params"`
|
|
||||||
TargetPresence ExecutionTargetPresence `json:"-"`
|
|
||||||
OutputContract OutputContract `json:"output_contract"`
|
|
||||||
StructuredOutput *StructuredOutputSpec `json:"structured_output,omitempty"`
|
|
||||||
InputHashes map[string]string `json:"input_hashes,omitempty"`
|
|
||||||
SessionID string `json:"session_id,omitempty"`
|
|
||||||
RenderedPromptHash string `json:"rendered_prompt_hash"`
|
|
||||||
Messages []RenderedMessage `json:"messages"`
|
|
||||||
StartTime time.Time `json:"start_time,omitempty"`
|
|
||||||
EndTime time.Time `json:"end_time,omitempty"`
|
|
||||||
DurationMS int64 `json:"duration_ms,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// ArtifactRef represents a reference to an input artifact.
|
|
||||||
type ArtifactRef struct {
|
|
||||||
Type ArtifactRefType
|
|
||||||
URI string
|
|
||||||
Body string // Used for inline
|
|
||||||
}
|
|
||||||
|
|
||||||
// Artifact represents the actual loaded content of a reference.
|
|
||||||
type Artifact struct {
|
|
||||||
Name string
|
|
||||||
ContentType string
|
|
||||||
Body []byte
|
|
||||||
URI string
|
|
||||||
Size int64
|
|
||||||
Hash string
|
|
||||||
}
|
|
||||||
|
|
||||||
// PromptDefinition represents a configured prompt execution definition.
|
|
||||||
type PromptDefinition struct {
|
|
||||||
ID string `yaml:"id"`
|
|
||||||
Version string `yaml:"version"`
|
|
||||||
DefaultProfile string `yaml:"default_profile"`
|
|
||||||
Description string `yaml:"description"`
|
|
||||||
SessionID string `yaml:"session_id" json:"session_id,omitempty"`
|
|
||||||
Inputs []PromptInput `yaml:"inputs"`
|
|
||||||
Templates []PromptMessageTemplate `yaml:"templates"`
|
|
||||||
OutputFormat OutputFormat `yaml:"output_format"`
|
|
||||||
Validation OutputContract `yaml:"validation"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// PromptInput describes one named input expected by a prompt definition.
|
|
||||||
type PromptInput struct {
|
|
||||||
Name string `yaml:"name"`
|
|
||||||
Required bool `yaml:"required"`
|
|
||||||
ContentType string `yaml:"content_type"`
|
|
||||||
Description string `yaml:"description"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// PromptMessageTemplate defines a template for a chat message.
|
|
||||||
type PromptMessageTemplate struct {
|
|
||||||
Role string `yaml:"role"`
|
|
||||||
Content string `yaml:"content"`
|
|
||||||
ContentFile string `yaml:"content_file"`
|
|
||||||
CacheControl *CacheControl `yaml:"cache_control,omitempty" json:"cache_control,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// ExecutionProfile describes how and where to execute a model.
|
|
||||||
type ExecutionProfile struct {
|
|
||||||
ID string `yaml:"id"`
|
|
||||||
Endpoint string `yaml:"endpoint"`
|
|
||||||
Model string `yaml:"model"`
|
|
||||||
Temperature float64 `yaml:"temperature"`
|
|
||||||
MaxTokens int `yaml:"max_tokens"`
|
|
||||||
TopP float64 `yaml:"top_p"`
|
|
||||||
TimeoutSeconds int `yaml:"timeout_seconds"`
|
|
||||||
ServiceTier string `yaml:"service_tier"`
|
|
||||||
ReasoningEffort string `yaml:"reasoning_effort"`
|
|
||||||
APIKeyEnv string `yaml:"api_key_env"`
|
|
||||||
APIKeyRequired bool `yaml:"-" json:"-"`
|
|
||||||
ExtraParams map[string]any `yaml:"extra_params"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// ExecutionTargetOverride represents per-request runtime setting overrides.
|
|
||||||
type ExecutionTargetOverride struct {
|
|
||||||
Endpoint string `json:"endpoint,omitempty"`
|
|
||||||
Model string `json:"model,omitempty"`
|
|
||||||
Temperature *float64 `json:"temperature,omitempty"`
|
|
||||||
MaxTokens *int `json:"max_tokens,omitempty"`
|
|
||||||
TopP *float64 `json:"top_p,omitempty"`
|
|
||||||
TimeoutSeconds *int `json:"timeout_seconds,omitempty"`
|
|
||||||
ServiceTier string `json:"service_tier,omitempty"`
|
|
||||||
ReasoningEffort string `json:"reasoning_effort,omitempty"`
|
|
||||||
APIKeyEnv string `json:"api_key_env,omitempty"`
|
|
||||||
ExtraParams map[string]any `json:"extra_params,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// ExecutionTargetPresence tracks which effective runtime fields came from an
|
|
||||||
// explicit request override even when the resolved value is a zero value.
|
|
||||||
type ExecutionTargetPresence struct {
|
|
||||||
Temperature bool
|
|
||||||
MaxTokens bool
|
|
||||||
TopP bool
|
|
||||||
TimeoutSeconds bool
|
|
||||||
}
|
|
||||||
|
|
||||||
// ExecutionTarget represents effective model runtime settings for a run.
|
|
||||||
type ExecutionTarget struct {
|
|
||||||
Endpoint string `yaml:"endpoint" json:"endpoint"`
|
|
||||||
Model string `yaml:"model" json:"model"`
|
|
||||||
Temperature float64 `yaml:"temperature" json:"temperature"`
|
|
||||||
MaxTokens int `yaml:"max_tokens" json:"max_tokens"`
|
|
||||||
TopP float64 `yaml:"top_p" json:"top_p"`
|
|
||||||
TimeoutSeconds int `yaml:"timeout_seconds" json:"timeout_seconds"`
|
|
||||||
ServiceTier string `yaml:"service_tier" json:"service_tier"`
|
|
||||||
ReasoningEffort string `yaml:"reasoning_effort" json:"reasoning_effort"`
|
|
||||||
APIKeyEnv string `yaml:"api_key_env" json:"api_key_env"`
|
|
||||||
APIKey string `yaml:"-" json:"-"`
|
|
||||||
APIKeyRequired bool `yaml:"-" json:"-"`
|
|
||||||
ExtraParams map[string]any `yaml:"extra_params" json:"extra_params"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// OutputContract defines the requirements for the output artifact.
|
|
||||||
type OutputContract struct {
|
|
||||||
Format OutputFormat `yaml:"format"`
|
|
||||||
ValidationMode ValidationMode `yaml:"validation_mode"`
|
|
||||||
SchemaPath string `yaml:"schema_path"`
|
|
||||||
RepairAttempts int `yaml:"repair_attempts"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// RenderedPrompt represents the prompt after template application.
|
|
||||||
type RenderedPrompt struct {
|
|
||||||
SessionID string `json:"session_id,omitempty"`
|
|
||||||
Messages []RenderedMessage `json:"messages"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// RenderedMessage is a single message in a rendered prompt.
|
|
||||||
type RenderedMessage struct {
|
|
||||||
Role string `json:"role"`
|
|
||||||
Content string `json:"content"`
|
|
||||||
CacheControl *CacheControl `json:"cache_control,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// GenerateRequest is the internal request passed to the LLM client.
|
|
||||||
type GenerateRequest struct {
|
|
||||||
Prompt RenderedPrompt
|
|
||||||
Target ExecutionTarget
|
|
||||||
TargetPresence ExecutionTargetPresence
|
|
||||||
StructuredOutput *StructuredOutputSpec
|
|
||||||
}
|
|
||||||
|
|
||||||
// StructuredOutputType indicates which provider-level output mode is requested.
|
|
||||||
type StructuredOutputType string
|
|
||||||
|
|
||||||
const (
|
|
||||||
StructuredOutputJSONSchema StructuredOutputType = "json_schema"
|
|
||||||
)
|
|
||||||
|
|
||||||
// StructuredOutputSpec describes provider-level structured output requirements.
|
|
||||||
type StructuredOutputSpec struct {
|
|
||||||
Type StructuredOutputType `json:"type"`
|
|
||||||
JSONSchema *StructuredOutputJSONSpec `json:"json_schema,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// StructuredOutputJSONSpec contains json_schema output constraints.
|
|
||||||
type StructuredOutputJSONSpec struct {
|
|
||||||
Name string `json:"name"`
|
|
||||||
Strict bool `json:"strict"`
|
|
||||||
Schema any `json:"schema"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// GenerateResponse is the response received from the LLM client.
|
|
||||||
type GenerateResponse struct {
|
|
||||||
Content string
|
|
||||||
Usage TokenUsage
|
|
||||||
}
|
|
||||||
|
|
||||||
// TokenUsage tracks token consumption.
|
|
||||||
type TokenUsage struct {
|
|
||||||
PromptTokens int
|
|
||||||
CompletionTokens int
|
|
||||||
TotalTokens int
|
|
||||||
CachedTokens int
|
|
||||||
CacheWriteTokens int
|
|
||||||
}
|
|
||||||
|
|
||||||
// ValidationResult represents the outcome of an output validation.
|
|
||||||
type ValidationResult struct {
|
|
||||||
Status ValidationStatus
|
|
||||||
Mode ValidationMode
|
|
||||||
Errors []string
|
|
||||||
SchemaPath string
|
|
||||||
RepairAttempts int
|
|
||||||
IsValid bool
|
|
||||||
}
|
|
||||||
@@ -1,141 +0,0 @@
|
|||||||
package domain
|
|
||||||
|
|
||||||
import (
|
|
||||||
"encoding/json"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestPreparedRunJSONDoesNotIncludeSecretValues(t *testing.T) {
|
|
||||||
const envName = "SCRIPTORIUM_TEST_API_KEY"
|
|
||||||
const secret = "super-secret-value"
|
|
||||||
t.Setenv(envName, secret)
|
|
||||||
|
|
||||||
prepared := PreparedRun{
|
|
||||||
PromptID: "prompt.id",
|
|
||||||
PromptVersion: "v1",
|
|
||||||
PromptHash: "prompt-hash",
|
|
||||||
SelectedProfileID: "local-fast",
|
|
||||||
EffectiveModelParams: ExecutionTarget{
|
|
||||||
Endpoint: "http://llm/v1",
|
|
||||||
Model: "gpt-test",
|
|
||||||
APIKeyEnv: envName,
|
|
||||||
APIKey: secret,
|
|
||||||
},
|
|
||||||
InputHashes: map[string]string{"transcript": "hash-1"},
|
|
||||||
RenderedPromptHash: "rendered-hash",
|
|
||||||
Messages: []RenderedMessage{
|
|
||||||
{Role: "system", Content: "You are helpful."},
|
|
||||||
{Role: "user", Content: "Summarize this."},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
b, err := json.Marshal(prepared)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("marshal failed: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
out := string(b)
|
|
||||||
if strings.Contains(out, secret) {
|
|
||||||
t.Fatalf("prepared run JSON unexpectedly contains secret value: %s", out)
|
|
||||||
}
|
|
||||||
if !strings.Contains(out, `"api_key_env":"`+envName+`"`) {
|
|
||||||
t.Fatalf("prepared run JSON should include api_key_env name: %s", out)
|
|
||||||
}
|
|
||||||
|
|
||||||
var top map[string]any
|
|
||||||
if err := json.Unmarshal(b, &top); err != nil {
|
|
||||||
t.Fatalf("unmarshal failed: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, forbidden := range []string{"raw_output", "validation", "artifact"} {
|
|
||||||
if _, ok := top[forbidden]; ok {
|
|
||||||
t.Fatalf("prepared run JSON should not include %q", forbidden)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestPreparedRunJSONIncludesMessageCacheControlOnlyWhenPresent(t *testing.T) {
|
|
||||||
prepared := PreparedRun{
|
|
||||||
PromptID: "prompt.id",
|
|
||||||
SelectedProfileID: "local-fast",
|
|
||||||
EffectiveModelParams: ExecutionTarget{
|
|
||||||
Endpoint: "http://llm/v1",
|
|
||||||
Model: "gpt-test",
|
|
||||||
},
|
|
||||||
RenderedPromptHash: "rendered-hash",
|
|
||||||
Messages: []RenderedMessage{
|
|
||||||
{
|
|
||||||
Role: "system",
|
|
||||||
Content: "You are helpful.",
|
|
||||||
CacheControl: &CacheControl{
|
|
||||||
Type: CacheControlEphemeral,
|
|
||||||
TTL: "1h",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
{Role: "user", Content: "Summarize this."},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
b, err := json.Marshal(prepared)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("marshal failed: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
var decoded struct {
|
|
||||||
Messages []map[string]any `json:"messages"`
|
|
||||||
}
|
|
||||||
if err := json.Unmarshal(b, &decoded); err != nil {
|
|
||||||
t.Fatalf("unmarshal failed: %v", err)
|
|
||||||
}
|
|
||||||
if len(decoded.Messages) != 2 {
|
|
||||||
t.Fatalf("expected 2 messages, got %d", len(decoded.Messages))
|
|
||||||
}
|
|
||||||
|
|
||||||
cacheControl, ok := decoded.Messages[0]["cache_control"].(map[string]any)
|
|
||||||
if !ok {
|
|
||||||
t.Fatalf("expected cache_control on first message, got %#v", decoded.Messages[0])
|
|
||||||
}
|
|
||||||
if cacheControl["type"] != string(CacheControlEphemeral) || cacheControl["ttl"] != "1h" {
|
|
||||||
t.Fatalf("unexpected cache_control payload: %#v", cacheControl)
|
|
||||||
}
|
|
||||||
if _, ok := decoded.Messages[1]["cache_control"]; ok {
|
|
||||||
t.Fatalf("expected second message to omit cache_control, got %#v", decoded.Messages[1])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestPreparedRunJSONIncludesSessionIDOnlyWhenPresent(t *testing.T) {
|
|
||||||
prepared := PreparedRun{
|
|
||||||
PromptID: "prompt.id",
|
|
||||||
SelectedProfileID: "local-fast",
|
|
||||||
EffectiveModelParams: ExecutionTarget{
|
|
||||||
Endpoint: "http://llm/v1",
|
|
||||||
Model: "gpt-test",
|
|
||||||
},
|
|
||||||
SessionID: "session-123",
|
|
||||||
RenderedPromptHash: "rendered-hash",
|
|
||||||
Messages: []RenderedMessage{{Role: "user", Content: "Summarize this."}},
|
|
||||||
}
|
|
||||||
|
|
||||||
b, err := json.Marshal(prepared)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("marshal failed: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
var decoded map[string]any
|
|
||||||
if err := json.Unmarshal(b, &decoded); err != nil {
|
|
||||||
t.Fatalf("unmarshal failed: %v", err)
|
|
||||||
}
|
|
||||||
if decoded["session_id"] != "session-123" {
|
|
||||||
t.Fatalf("expected session_id in prepared run JSON, got %#v", decoded["session_id"])
|
|
||||||
}
|
|
||||||
|
|
||||||
prepared.SessionID = ""
|
|
||||||
b, err = json.Marshal(prepared)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("marshal failed: %v", err)
|
|
||||||
}
|
|
||||||
if strings.Contains(string(b), "session_id") {
|
|
||||||
t.Fatalf("expected empty session_id to be omitted, got %s", b)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,142 +0,0 @@
|
|||||||
package filecatalog
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"io/fs"
|
|
||||||
"os"
|
|
||||||
"path"
|
|
||||||
"path/filepath"
|
|
||||||
"sort"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
// FindYAMLFiles returns sorted full paths for .yaml and .yml files under root.
|
|
||||||
func FindYAMLFiles(ctx context.Context, root string) ([]string, error) {
|
|
||||||
var files []string
|
|
||||||
err := filepath.WalkDir(root, func(path string, d os.DirEntry, err error) error {
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
select {
|
|
||||||
case <-ctx.Done():
|
|
||||||
return ctx.Err()
|
|
||||||
default:
|
|
||||||
}
|
|
||||||
if d.IsDir() {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
if !IsYAMLFile(d.Name()) {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
files = append(files, path)
|
|
||||||
return nil
|
|
||||||
})
|
|
||||||
sort.Strings(files)
|
|
||||||
return files, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// FindFSYAMLFiles returns sorted paths for .yaml and .yml files under root in fsys.
|
|
||||||
func FindFSYAMLFiles(ctx context.Context, fsys fs.FS, root string) ([]string, error) {
|
|
||||||
cleanRoot := CleanFSRoot(root)
|
|
||||||
var files []string
|
|
||||||
err := fs.WalkDir(fsys, cleanRoot, func(name string, d fs.DirEntry, err error) error {
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
select {
|
|
||||||
case <-ctx.Done():
|
|
||||||
return ctx.Err()
|
|
||||||
default:
|
|
||||||
}
|
|
||||||
if d.IsDir() {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
if !IsYAMLFile(d.Name()) {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
files = append(files, name)
|
|
||||||
return nil
|
|
||||||
})
|
|
||||||
sort.Strings(files)
|
|
||||||
return files, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// RelativePath computes a clean relative path from root to path.
|
|
||||||
func RelativePath(root string, filePath string) string {
|
|
||||||
rel, err := filepath.Rel(root, filePath)
|
|
||||||
if err != nil {
|
|
||||||
return filepath.Clean(filePath)
|
|
||||||
}
|
|
||||||
return filepath.Clean(rel)
|
|
||||||
}
|
|
||||||
|
|
||||||
// CleanFSRoot normalizes a root path for use with fs.FS.
|
|
||||||
func CleanFSRoot(root string) string {
|
|
||||||
root = strings.TrimSpace(root)
|
|
||||||
if root == "" || root == "." {
|
|
||||||
return "."
|
|
||||||
}
|
|
||||||
return path.Clean(root)
|
|
||||||
}
|
|
||||||
|
|
||||||
// DisplayPath returns name relative to root for messages about fs.FS paths.
|
|
||||||
func DisplayPath(root string, name string) string {
|
|
||||||
cleanRoot := CleanFSRoot(root)
|
|
||||||
cleanName := path.Clean(name)
|
|
||||||
if cleanRoot == "." {
|
|
||||||
return cleanName
|
|
||||||
}
|
|
||||||
prefix := strings.TrimSuffix(cleanRoot, "/") + "/"
|
|
||||||
if strings.HasPrefix(cleanName, prefix) {
|
|
||||||
return strings.TrimPrefix(cleanName, prefix)
|
|
||||||
}
|
|
||||||
return cleanName
|
|
||||||
}
|
|
||||||
|
|
||||||
// ResolveFSPath resolves userPath from baseDir and keeps it inside root.
|
|
||||||
func ResolveFSPath(root string, baseDir string, userPath string) (string, string, error) {
|
|
||||||
cleanRoot := CleanFSRoot(root)
|
|
||||||
cleanBase := path.Clean(strings.TrimSpace(baseDir))
|
|
||||||
if cleanBase == "" {
|
|
||||||
cleanBase = cleanRoot
|
|
||||||
}
|
|
||||||
if !containsFSPath(cleanRoot, cleanBase) {
|
|
||||||
return "", "", fmt.Errorf("base path %q is outside source root %q", cleanBase, cleanRoot)
|
|
||||||
}
|
|
||||||
|
|
||||||
cleanUserPath := strings.TrimSpace(userPath)
|
|
||||||
if cleanUserPath == "" {
|
|
||||||
return "", "", fmt.Errorf("path is required")
|
|
||||||
}
|
|
||||||
cleanUserPath = path.Clean(cleanUserPath)
|
|
||||||
if path.IsAbs(cleanUserPath) {
|
|
||||||
return "", "", fmt.Errorf("path %q must be relative", userPath)
|
|
||||||
}
|
|
||||||
|
|
||||||
resolved := path.Clean(path.Join(cleanBase, cleanUserPath))
|
|
||||||
if !containsFSPath(cleanRoot, resolved) {
|
|
||||||
return "", "", fmt.Errorf("path %q escapes source root %q", userPath, cleanRoot)
|
|
||||||
}
|
|
||||||
return resolved, DisplayPath(cleanRoot, resolved), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func containsFSPath(root string, name string) bool {
|
|
||||||
root = CleanFSRoot(root)
|
|
||||||
name = path.Clean(name)
|
|
||||||
if root == "." {
|
|
||||||
return name == "." || (name != ".." && !strings.HasPrefix(name, "../"))
|
|
||||||
}
|
|
||||||
return name == root || strings.HasPrefix(name, strings.TrimSuffix(root, "/")+"/")
|
|
||||||
}
|
|
||||||
|
|
||||||
// Stem strips .yaml or .yml from a file name.
|
|
||||||
func Stem(name string) string {
|
|
||||||
name = strings.TrimSuffix(name, ".yaml")
|
|
||||||
name = strings.TrimSuffix(name, ".yml")
|
|
||||||
return name
|
|
||||||
}
|
|
||||||
|
|
||||||
func IsYAMLFile(name string) bool {
|
|
||||||
return strings.HasSuffix(name, ".yaml") || strings.HasSuffix(name, ".yml")
|
|
||||||
}
|
|
||||||
@@ -1,270 +0,0 @@
|
|||||||
package filecatalog
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"reflect"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
"testing/fstest"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestFindYAMLFilesNestedSortedAndFiltered(t *testing.T) {
|
|
||||||
root := t.TempDir()
|
|
||||||
mustWriteFile(t, filepath.Join(root, "z", "prompt.yml"), "id: z")
|
|
||||||
mustWriteFile(t, filepath.Join(root, "a", "profile.yaml"), "id: a")
|
|
||||||
mustWriteFile(t, filepath.Join(root, "a", "ignore.txt"), "not yaml")
|
|
||||||
mustWriteFile(t, filepath.Join(root, "b", "ignore.yaml.bak"), "not yaml")
|
|
||||||
|
|
||||||
got, err := FindYAMLFiles(context.Background(), root)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected no error, got %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
want := []string{
|
|
||||||
filepath.Join(root, "a", "profile.yaml"),
|
|
||||||
filepath.Join(root, "z", "prompt.yml"),
|
|
||||||
}
|
|
||||||
if !reflect.DeepEqual(got, want) {
|
|
||||||
t.Fatalf("expected sorted YAML files %v, got %v", want, got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestFindYAMLFilesHonorsContextCancellation(t *testing.T) {
|
|
||||||
root := t.TempDir()
|
|
||||||
mustWriteFile(t, filepath.Join(root, "one.yaml"), "id: one")
|
|
||||||
|
|
||||||
ctx, cancel := context.WithCancel(context.Background())
|
|
||||||
cancel()
|
|
||||||
|
|
||||||
_, err := FindYAMLFiles(ctx, root)
|
|
||||||
if !errors.Is(err, context.Canceled) {
|
|
||||||
t.Fatalf("expected context.Canceled, got %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestFindFSYAMLFilesNestedSortedAndFiltered(t *testing.T) {
|
|
||||||
fsys := fstest.MapFS{
|
|
||||||
"prompts/z/prompt.yml": &fstest.MapFile{Data: []byte("id: z")},
|
|
||||||
"prompts/a/profile.yaml": &fstest.MapFile{Data: []byte("id: a")},
|
|
||||||
"prompts/a/ignore.txt": &fstest.MapFile{Data: []byte("not yaml")},
|
|
||||||
"prompts/b/ignore.yaml.bak": &fstest.MapFile{Data: []byte("not yaml")},
|
|
||||||
"other/ignored.yaml": &fstest.MapFile{Data: []byte("id: ignored")},
|
|
||||||
}
|
|
||||||
|
|
||||||
got, err := FindFSYAMLFiles(context.Background(), fsys, " prompts ")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected no error, got %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
want := []string{
|
|
||||||
"prompts/a/profile.yaml",
|
|
||||||
"prompts/z/prompt.yml",
|
|
||||||
}
|
|
||||||
if !reflect.DeepEqual(got, want) {
|
|
||||||
t.Fatalf("expected sorted YAML files %v, got %v", want, got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestFindFSYAMLFilesHonorsContextCancellation(t *testing.T) {
|
|
||||||
fsys := fstest.MapFS{
|
|
||||||
"one.yaml": &fstest.MapFile{Data: []byte("id: one")},
|
|
||||||
}
|
|
||||||
ctx, cancel := context.WithCancel(context.Background())
|
|
||||||
cancel()
|
|
||||||
|
|
||||||
_, err := FindFSYAMLFiles(ctx, fsys, ".")
|
|
||||||
if !errors.Is(err, context.Canceled) {
|
|
||||||
t.Fatalf("expected context.Canceled, got %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRelativePathNested(t *testing.T) {
|
|
||||||
root := t.TempDir()
|
|
||||||
path := filepath.Join(root, "nested", "profiles", "local.yaml")
|
|
||||||
got := RelativePath(root, path)
|
|
||||||
want := filepath.Join("nested", "profiles", "local.yaml")
|
|
||||||
if got != want {
|
|
||||||
t.Fatalf("expected relative path %q, got %q", want, got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestCleanFSRoot(t *testing.T) {
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
root string
|
|
||||||
want string
|
|
||||||
}{
|
|
||||||
{name: "empty", root: "", want: "."},
|
|
||||||
{name: "dot", root: ".", want: "."},
|
|
||||||
{name: "trimmed", root: " prompts/../profiles ", want: "profiles"},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range tests {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
if got := CleanFSRoot(tc.root); got != tc.want {
|
|
||||||
t.Fatalf("expected %q, got %q", tc.want, got)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestDisplayPath(t *testing.T) {
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
root string
|
|
||||||
path string
|
|
||||||
want string
|
|
||||||
}{
|
|
||||||
{name: "root dot", root: ".", path: "profiles/local.yaml", want: "profiles/local.yaml"},
|
|
||||||
{name: "nested root", root: "profiles", path: "profiles/local.yaml", want: "local.yaml"},
|
|
||||||
{name: "outside root", root: "profiles", path: "other/local.yaml", want: "other/local.yaml"},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range tests {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
if got := DisplayPath(tc.root, tc.path); got != tc.want {
|
|
||||||
t.Fatalf("expected %q, got %q", tc.want, got)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestResolveFSPath(t *testing.T) {
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
root string
|
|
||||||
baseDir string
|
|
||||||
userPath string
|
|
||||||
wantPath string
|
|
||||||
wantDisplay string
|
|
||||||
wantErr string
|
|
||||||
}{
|
|
||||||
{
|
|
||||||
name: "sibling inside root",
|
|
||||||
root: "prompts",
|
|
||||||
baseDir: "prompts/nested",
|
|
||||||
userPath: "./messages/user.tmpl",
|
|
||||||
wantPath: "prompts/nested/messages/user.tmpl",
|
|
||||||
wantDisplay: "nested/messages/user.tmpl",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "parent inside root",
|
|
||||||
root: "prompts",
|
|
||||||
baseDir: "prompts/nested",
|
|
||||||
userPath: "../shared/user.tmpl",
|
|
||||||
wantPath: "prompts/shared/user.tmpl",
|
|
||||||
wantDisplay: "shared/user.tmpl",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "escape rejected",
|
|
||||||
root: "prompts",
|
|
||||||
baseDir: "prompts/nested",
|
|
||||||
userPath: "../../outside.tmpl",
|
|
||||||
wantErr: "escapes source root",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "absolute path rejected",
|
|
||||||
root: "prompts",
|
|
||||||
baseDir: "prompts/nested",
|
|
||||||
userPath: "/outside.tmpl",
|
|
||||||
wantErr: "must be relative",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "empty path rejected",
|
|
||||||
root: "prompts",
|
|
||||||
baseDir: "prompts/nested",
|
|
||||||
userPath: " ",
|
|
||||||
wantErr: "path is required",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "dot root allows normal relative path",
|
|
||||||
root: ".",
|
|
||||||
baseDir: ".",
|
|
||||||
userPath: "schemas/events.schema.json",
|
|
||||||
wantPath: "schemas/events.schema.json",
|
|
||||||
wantDisplay: "schemas/events.schema.json",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
name: "dot root rejects parent escape",
|
|
||||||
root: ".",
|
|
||||||
baseDir: ".",
|
|
||||||
userPath: "../outside.tmpl",
|
|
||||||
wantErr: "escapes source root",
|
|
||||||
},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range tests {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
gotPath, gotDisplay, err := ResolveFSPath(tc.root, tc.baseDir, tc.userPath)
|
|
||||||
if tc.wantErr != "" {
|
|
||||||
if err == nil {
|
|
||||||
t.Fatalf("expected error containing %q", tc.wantErr)
|
|
||||||
}
|
|
||||||
if !strings.Contains(err.Error(), tc.wantErr) {
|
|
||||||
t.Fatalf("expected error to contain %q, got %v", tc.wantErr, err)
|
|
||||||
}
|
|
||||||
return
|
|
||||||
}
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("expected no error, got %v", err)
|
|
||||||
}
|
|
||||||
if gotPath != tc.wantPath || gotDisplay != tc.wantDisplay {
|
|
||||||
t.Fatalf("expected path/display %q/%q, got %q/%q", tc.wantPath, tc.wantDisplay, gotPath, gotDisplay)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestStemStripsYAMLExtensions(t *testing.T) {
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
in string
|
|
||||||
want string
|
|
||||||
}{
|
|
||||||
{name: "yaml", in: "prompt.yaml", want: "prompt"},
|
|
||||||
{name: "yml", in: "profile.yml", want: "profile"},
|
|
||||||
{name: "other", in: "file.txt", want: "file.txt"},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range tests {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
if got := Stem(tc.in); got != tc.want {
|
|
||||||
t.Fatalf("expected %q, got %q", tc.want, got)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestIsYAMLFile(t *testing.T) {
|
|
||||||
tests := []struct {
|
|
||||||
name string
|
|
||||||
in string
|
|
||||||
want bool
|
|
||||||
}{
|
|
||||||
{name: "yaml", in: "prompt.yaml", want: true},
|
|
||||||
{name: "yml", in: "profile.yml", want: true},
|
|
||||||
{name: "backup", in: "profile.yaml.bak", want: false},
|
|
||||||
{name: "uppercase", in: "profile.YAML", want: false},
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, tc := range tests {
|
|
||||||
t.Run(tc.name, func(t *testing.T) {
|
|
||||||
if got := IsYAMLFile(tc.in); got != tc.want {
|
|
||||||
t.Fatalf("expected %v, got %v", tc.want, got)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func mustWriteFile(t *testing.T, path string, content string) {
|
|
||||||
t.Helper()
|
|
||||||
if err := os.MkdirAll(filepath.Dir(path), 0o755); err != nil {
|
|
||||||
t.Fatalf("failed to create directory: %v", err)
|
|
||||||
}
|
|
||||||
if err := os.WriteFile(path, []byte(content), 0o644); err != nil {
|
|
||||||
t.Fatalf("failed to write file %q: %v", path, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
122
internal/format/inspection.go
Normal file
122
internal/format/inspection.go
Normal file
@@ -0,0 +1,122 @@
|
|||||||
|
package format
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"strconv"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/promptkit"
|
||||||
|
)
|
||||||
|
|
||||||
|
type PromptInspection struct {
|
||||||
|
PromptID string `json:"prompt_id"`
|
||||||
|
PromptVersion string `json:"prompt_version"`
|
||||||
|
PromptHash string `json:"prompt_hash"`
|
||||||
|
DefaultProfileID string `json:"default_profile_id"`
|
||||||
|
Inputs []PromptInspectionInput `json:"inputs"`
|
||||||
|
OutputContract OutputContract `json:"output_contract"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type PromptInspectionInput struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Required bool `json:"required"`
|
||||||
|
ContentType string `json:"content_type"`
|
||||||
|
Description string `json:"description"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type OutputContract struct {
|
||||||
|
Format string `json:"format"`
|
||||||
|
ValidationMode string `json:"validation_mode"`
|
||||||
|
SchemaPath string `json:"schema_path"`
|
||||||
|
RepairAttempts int `json:"repair_attempts"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type ProfileInspection struct {
|
||||||
|
ProfileID string `json:"profile_id"`
|
||||||
|
EffectiveModelParams ProfileModelParams `json:"effective_model_params"`
|
||||||
|
APIKeyRequired bool `json:"api_key_required"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type ProfileModelParams struct {
|
||||||
|
BackendID string `json:"backend_id"`
|
||||||
|
Endpoint string `json:"endpoint"`
|
||||||
|
Model string `json:"model"`
|
||||||
|
Temperature float64 `json:"temperature"`
|
||||||
|
MaxTokens int `json:"max_tokens"`
|
||||||
|
TopP float64 `json:"top_p"`
|
||||||
|
TimeoutSeconds int `json:"timeout_seconds"`
|
||||||
|
ServiceTier string `json:"service_tier"`
|
||||||
|
ReasoningEffort string `json:"reasoning_effort"`
|
||||||
|
APIKeyEnv string `json:"api_key_env"`
|
||||||
|
ExtraParams map[string]any `json:"extra_params"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func FormatPromptInspection(value *promptkit.PromptInspection, outputFormat OutputFormat) ([]byte, error) {
|
||||||
|
if value == nil {
|
||||||
|
return nil, errors.New("prompt inspection is nil")
|
||||||
|
}
|
||||||
|
dto := PromptInspection{
|
||||||
|
PromptID: value.PromptID, PromptVersion: value.PromptVersion, PromptHash: value.PromptHash, DefaultProfileID: value.DefaultProfileID,
|
||||||
|
Inputs: make([]PromptInspectionInput, len(value.Inputs)),
|
||||||
|
OutputContract: OutputContract{Format: string(value.OutputContract.Format), ValidationMode: string(value.OutputContract.ValidationMode), SchemaPath: value.OutputContract.SchemaPath, RepairAttempts: value.OutputContract.RepairAttempts},
|
||||||
|
}
|
||||||
|
for i, input := range value.Inputs {
|
||||||
|
dto.Inputs[i] = PromptInspectionInput{Name: input.Name, Required: input.Required, ContentType: input.ContentType, Description: input.Description}
|
||||||
|
}
|
||||||
|
switch outputFormat {
|
||||||
|
case OutputFormatJSON:
|
||||||
|
data, err := json.MarshalIndent(dto, "", " ")
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return append(data, '\n'), nil
|
||||||
|
case OutputFormatText:
|
||||||
|
var b bytes.Buffer
|
||||||
|
fmt.Fprintf(&b, "prompt_id: %s\nprompt_version: %s\nprompt_hash: %s\ndefault_profile_id: %s\ninputs:", dto.PromptID, dto.PromptVersion, dto.PromptHash, dto.DefaultProfileID)
|
||||||
|
if len(dto.Inputs) == 0 {
|
||||||
|
fmt.Fprintln(&b, " []")
|
||||||
|
} else {
|
||||||
|
fmt.Fprintln(&b)
|
||||||
|
for _, input := range dto.Inputs {
|
||||||
|
fmt.Fprintf(&b, " - name: %s\n required: %t\n content_type: %s\n description: %s\n", input.Name, input.Required, input.ContentType, strconv.Quote(input.Description))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
fmt.Fprintf(&b, "output_contract:\n format: %s\n validation_mode: %s\n schema_path: %s\n repair_attempts: %d\n", dto.OutputContract.Format, dto.OutputContract.ValidationMode, dto.OutputContract.SchemaPath, dto.OutputContract.RepairAttempts)
|
||||||
|
return b.Bytes(), nil
|
||||||
|
default:
|
||||||
|
return nil, fmt.Errorf("%w: %q", ErrUnknownPreparedRunFormat, outputFormat)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func FormatProfileInspection(value *promptkit.ProfileInspection, outputFormat OutputFormat) ([]byte, error) {
|
||||||
|
if value == nil {
|
||||||
|
return nil, errors.New("profile inspection is nil")
|
||||||
|
}
|
||||||
|
target := value.EffectiveModelParams
|
||||||
|
params := map[string]any{}
|
||||||
|
for key, item := range target.ExtraParams {
|
||||||
|
params[key] = item
|
||||||
|
}
|
||||||
|
dto := ProfileInspection{ProfileID: value.ProfileID, APIKeyRequired: value.APIKeyRequired, EffectiveModelParams: ProfileModelParams{BackendID: target.BackendID, Endpoint: target.Endpoint, Model: target.Model, Temperature: target.Temperature, MaxTokens: target.MaxTokens, TopP: target.TopP, TimeoutSeconds: target.TimeoutSeconds, ServiceTier: target.ServiceTier, ReasoningEffort: target.ReasoningEffort, APIKeyEnv: target.APIKeyEnv, ExtraParams: params}}
|
||||||
|
switch outputFormat {
|
||||||
|
case OutputFormatJSON:
|
||||||
|
data, err := json.MarshalIndent(dto, "", " ")
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
return append(data, '\n'), nil
|
||||||
|
case OutputFormatText:
|
||||||
|
var b bytes.Buffer
|
||||||
|
fmt.Fprintf(&b, "profile_id: %s\neffective_model_params:\n backend_id: %s\n endpoint: %s\n model: %s\n temperature: %g\n max_tokens: %d\n top_p: %g\n timeout_seconds: %d\n service_tier: %s\n reasoning_effort: %s\n api_key_env: %s\n extra_params: ", dto.ProfileID, dto.EffectiveModelParams.BackendID, dto.EffectiveModelParams.Endpoint, dto.EffectiveModelParams.Model, dto.EffectiveModelParams.Temperature, dto.EffectiveModelParams.MaxTokens, dto.EffectiveModelParams.TopP, dto.EffectiveModelParams.TimeoutSeconds, dto.EffectiveModelParams.ServiceTier, dto.EffectiveModelParams.ReasoningEffort, dto.EffectiveModelParams.APIKeyEnv)
|
||||||
|
paramsJSON, err := json.Marshal(dto.EffectiveModelParams.ExtraParams)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
fmt.Fprintf(&b, "%s\napi_key_required: %t\n", paramsJSON, dto.APIKeyRequired)
|
||||||
|
return b.Bytes(), nil
|
||||||
|
default:
|
||||||
|
return nil, fmt.Errorf("%w: %q", ErrUnknownPreparedRunFormat, outputFormat)
|
||||||
|
}
|
||||||
|
}
|
||||||
124
internal/format/inspection_test.go
Normal file
124
internal/format/inspection_test.go
Normal file
@@ -0,0 +1,124 @@
|
|||||||
|
package format
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"gitea.maximumdirect.net/eric/promptkit"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestFormatPromptInspectionPreservesDeclaredOrderAndEmptyValues(t *testing.T) {
|
||||||
|
value := &promptkit.PromptInspection{PromptID: "p", PromptVersion: "1", PromptHash: "hash", Inputs: []promptkit.PromptInputDefinition{{Name: "first", Required: true, ContentType: "text/plain", Description: "first input"}, {Name: "second"}}, OutputContract: promptkit.OutputContract{Format: "text", ValidationMode: promptkit.ValidationNone}}
|
||||||
|
text, err := FormatPromptInspection(value, OutputFormatText)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !strings.Contains(string(text), "default_profile_id: \ninputs:\n - name: first") || strings.Index(string(text), "name: first") > strings.Index(string(text), "name: second") {
|
||||||
|
t.Fatalf("unexpected text inspection: %s", text)
|
||||||
|
}
|
||||||
|
jsonOutput, err := FormatPromptInspection(value, OutputFormatJSON)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !strings.HasSuffix(string(jsonOutput), "\n") || !strings.Contains(string(jsonOutput), `"default_profile_id": ""`) {
|
||||||
|
t.Fatalf("unexpected json inspection: %s", jsonOutput)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFormatPromptInspectionRejectsNil(t *testing.T) {
|
||||||
|
if _, err := FormatPromptInspection(nil, OutputFormatText); err == nil {
|
||||||
|
t.Fatal("expected nil inspection error")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFormatProfileInspectionPreservesSafeEffectiveValues(t *testing.T) {
|
||||||
|
const secret = "sentinel-secret-must-not-appear"
|
||||||
|
t.Setenv("FIXTURE_PROFILE_API_KEY", secret)
|
||||||
|
|
||||||
|
value := &promptkit.ProfileInspection{
|
||||||
|
ProfileID: "custom-derived",
|
||||||
|
EffectiveModelParams: promptkit.ExecutionTarget{
|
||||||
|
BackendID: "fixture-custom",
|
||||||
|
Endpoint: "http://127.0.0.1:11434/v1",
|
||||||
|
Model: "fixture-model",
|
||||||
|
Temperature: 0.25,
|
||||||
|
MaxTokens: 640,
|
||||||
|
TopP: 0.9,
|
||||||
|
TimeoutSeconds: 45,
|
||||||
|
ServiceTier: "flex",
|
||||||
|
ReasoningEffort: "high",
|
||||||
|
APIKeyEnv: "FIXTURE_PROFILE_API_KEY",
|
||||||
|
ExtraParams: map[string]any{
|
||||||
|
"zeta": true,
|
||||||
|
"alpha": map[string]any{"nested": []any{"first", 2.0}},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
APIKeyRequired: true,
|
||||||
|
}
|
||||||
|
|
||||||
|
jsonOutput, err := FormatProfileInspection(value, OutputFormatJSON)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
secondJSONOutput, err := FormatProfileInspection(value, OutputFormatJSON)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if string(jsonOutput) != string(secondJSONOutput) || !strings.HasSuffix(string(jsonOutput), "\n") {
|
||||||
|
t.Fatalf("expected deterministic newline-terminated JSON, got %q", jsonOutput)
|
||||||
|
}
|
||||||
|
if strings.Contains(string(jsonOutput), secret) {
|
||||||
|
t.Fatalf("inspection exposed an environment secret: %s", jsonOutput)
|
||||||
|
}
|
||||||
|
|
||||||
|
var decoded ProfileInspection
|
||||||
|
if err := json.Unmarshal(jsonOutput, &decoded); err != nil {
|
||||||
|
t.Fatalf("decode profile inspection: %v", err)
|
||||||
|
}
|
||||||
|
if decoded.ProfileID != "custom-derived" || decoded.EffectiveModelParams.BackendID != "fixture-custom" {
|
||||||
|
t.Fatalf("unexpected profile identity: %+v", decoded)
|
||||||
|
}
|
||||||
|
if decoded.EffectiveModelParams.APIKeyEnv != "FIXTURE_PROFILE_API_KEY" || !decoded.APIKeyRequired {
|
||||||
|
t.Fatalf("unexpected credential metadata: %+v", decoded)
|
||||||
|
}
|
||||||
|
alpha, ok := decoded.EffectiveModelParams.ExtraParams["alpha"].(map[string]any)
|
||||||
|
if !ok || len(alpha["nested"].([]any)) != 2 {
|
||||||
|
t.Fatalf("nested extra parameters were not preserved: %#v", decoded.EffectiveModelParams.ExtraParams)
|
||||||
|
}
|
||||||
|
|
||||||
|
textOutput, err := FormatProfileInspection(value, OutputFormatText)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
textValue := string(textOutput)
|
||||||
|
if !strings.Contains(textValue, "backend_id: fixture-custom") ||
|
||||||
|
!strings.Contains(textValue, "api_key_env: FIXTURE_PROFILE_API_KEY") ||
|
||||||
|
!strings.Contains(textValue, `extra_params: {"alpha":{"nested":["first",2]},"zeta":true}`) ||
|
||||||
|
!strings.Contains(textValue, "api_key_required: true") {
|
||||||
|
t.Fatalf("unexpected text inspection: %s", textValue)
|
||||||
|
}
|
||||||
|
if strings.Contains(textValue, secret) {
|
||||||
|
t.Fatalf("text inspection exposed an environment secret: %s", textValue)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestFormatProfileInspectionPreservesEmptyBackendAndRejectsNil(t *testing.T) {
|
||||||
|
output, err := FormatProfileInspection(&promptkit.ProfileInspection{
|
||||||
|
ProfileID: "endpoint-only",
|
||||||
|
EffectiveModelParams: promptkit.ExecutionTarget{
|
||||||
|
Endpoint: "http://127.0.0.1:8000/v1",
|
||||||
|
Model: "fixture-model",
|
||||||
|
},
|
||||||
|
}, OutputFormatJSON)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatal(err)
|
||||||
|
}
|
||||||
|
if !strings.Contains(string(output), `"backend_id": ""`) ||
|
||||||
|
!strings.Contains(string(output), `"extra_params": {}`) {
|
||||||
|
t.Fatalf("expected explicit empty backend and object extra params, got %s", output)
|
||||||
|
}
|
||||||
|
if _, err := FormatProfileInspection(nil, OutputFormatText); err == nil {
|
||||||
|
t.Fatal("expected nil profile inspection error")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
// Package format formats already-prepared domain data for adapters.
|
// Package format formats already-prepared public data for adapters.
|
||||||
package format
|
package format
|
||||||
|
|
||||||
import (
|
import (
|
||||||
@@ -9,37 +9,52 @@ import (
|
|||||||
"sort"
|
"sort"
|
||||||
"strings"
|
"strings"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/domain"
|
"gitea.maximumdirect.net/eric/promptkit"
|
||||||
)
|
)
|
||||||
|
|
||||||
var ErrUnknownPreparedRunFormat = errors.New("unknown prepared run format")
|
var ErrUnknownPreparedRunFormat = errors.New("unknown prepared run format")
|
||||||
|
|
||||||
// PreparedRunOutputFormat is the output format for prepared render data.
|
// OutputFormat selects an application-owned textual or JSON representation.
|
||||||
type PreparedRunOutputFormat string
|
type OutputFormat string
|
||||||
|
|
||||||
const (
|
const (
|
||||||
PreparedRunFormatText PreparedRunOutputFormat = "text"
|
OutputFormatText OutputFormat = "text"
|
||||||
PreparedRunFormatJSON PreparedRunOutputFormat = "json"
|
OutputFormatJSON OutputFormat = "json"
|
||||||
|
|
||||||
DefaultPreparedRunOutputFormat PreparedRunOutputFormat = PreparedRunFormatText
|
DefaultOutputFormat OutputFormat = OutputFormatText
|
||||||
|
)
|
||||||
|
|
||||||
|
// PreparedRunOutputFormat is the output format for prepared render data.
|
||||||
|
type PreparedRunOutputFormat = OutputFormat
|
||||||
|
|
||||||
|
const (
|
||||||
|
PreparedRunFormatText = OutputFormatText
|
||||||
|
PreparedRunFormatJSON = OutputFormatJSON
|
||||||
|
|
||||||
|
DefaultPreparedRunOutputFormat = DefaultOutputFormat
|
||||||
)
|
)
|
||||||
|
|
||||||
// PreparedRunFormatter serializes a prepared run without performing use case work.
|
// PreparedRunFormatter serializes a prepared run without performing use case work.
|
||||||
type PreparedRunFormatter interface {
|
type PreparedRunFormatter interface {
|
||||||
Format(prepared *domain.PreparedRun) ([]byte, error)
|
Format(prepared *promptkit.PreparedRun) ([]byte, error)
|
||||||
}
|
}
|
||||||
|
|
||||||
// ParsePreparedRunOutputFormat parses a format name.
|
// ParsePreparedRunOutputFormat parses a format name.
|
||||||
func ParsePreparedRunOutputFormat(raw string) (PreparedRunOutputFormat, error) {
|
func ParsePreparedRunOutputFormat(raw string) (PreparedRunOutputFormat, error) {
|
||||||
switch PreparedRunOutputFormat(strings.ToLower(strings.TrimSpace(raw))) {
|
return ParseOutputFormat(raw)
|
||||||
|
}
|
||||||
|
|
||||||
|
// ParseOutputFormat parses the shared inspection and prepared-run format names.
|
||||||
|
func ParseOutputFormat(raw string) (OutputFormat, error) {
|
||||||
|
switch OutputFormat(strings.ToLower(strings.TrimSpace(raw))) {
|
||||||
case "":
|
case "":
|
||||||
return DefaultPreparedRunOutputFormat, nil
|
return DefaultOutputFormat, nil
|
||||||
case PreparedRunFormatText:
|
case OutputFormatText:
|
||||||
return PreparedRunFormatText, nil
|
return OutputFormatText, nil
|
||||||
case PreparedRunFormatJSON:
|
case OutputFormatJSON:
|
||||||
return PreparedRunFormatJSON, nil
|
return OutputFormatJSON, nil
|
||||||
default:
|
default:
|
||||||
return "", fmt.Errorf("%w: %q (supported: %s, %s)", ErrUnknownPreparedRunFormat, raw, PreparedRunFormatText, PreparedRunFormatJSON)
|
return "", fmt.Errorf("%w: %q (supported: %s, %s)", ErrUnknownPreparedRunFormat, raw, OutputFormatText, OutputFormatJSON)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -56,7 +71,7 @@ func FormatterForPreparedRun(outputFormat PreparedRunOutputFormat) (PreparedRunF
|
|||||||
}
|
}
|
||||||
|
|
||||||
// FormatPreparedRun formats a prepared run using the selected format.
|
// FormatPreparedRun formats a prepared run using the selected format.
|
||||||
func FormatPreparedRun(prepared *domain.PreparedRun, outputFormat PreparedRunOutputFormat) ([]byte, error) {
|
func FormatPreparedRun(prepared *promptkit.PreparedRun, outputFormat PreparedRunOutputFormat) ([]byte, error) {
|
||||||
formatter, err := FormatterForPreparedRun(outputFormat)
|
formatter, err := FormatterForPreparedRun(outputFormat)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
@@ -65,7 +80,7 @@ func FormatPreparedRun(prepared *domain.PreparedRun, outputFormat PreparedRunOut
|
|||||||
}
|
}
|
||||||
|
|
||||||
// FormatPreparedRunByName parses a format name and formats a prepared run.
|
// FormatPreparedRunByName parses a format name and formats a prepared run.
|
||||||
func FormatPreparedRunByName(prepared *domain.PreparedRun, rawFormat string) ([]byte, error) {
|
func FormatPreparedRunByName(prepared *promptkit.PreparedRun, rawFormat string) ([]byte, error) {
|
||||||
outputFormat, err := ParsePreparedRunOutputFormat(rawFormat)
|
outputFormat, err := ParsePreparedRunOutputFormat(rawFormat)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, err
|
||||||
@@ -75,7 +90,7 @@ func FormatPreparedRunByName(prepared *domain.PreparedRun, rawFormat string) ([]
|
|||||||
|
|
||||||
type jsonPreparedRunFormatter struct{}
|
type jsonPreparedRunFormatter struct{}
|
||||||
|
|
||||||
func (jsonPreparedRunFormatter) Format(prepared *domain.PreparedRun) ([]byte, error) {
|
func (jsonPreparedRunFormatter) Format(prepared *promptkit.PreparedRun) ([]byte, error) {
|
||||||
if prepared == nil {
|
if prepared == nil {
|
||||||
return nil, errors.New("prepared run is nil")
|
return nil, errors.New("prepared run is nil")
|
||||||
}
|
}
|
||||||
@@ -84,7 +99,7 @@ func (jsonPreparedRunFormatter) Format(prepared *domain.PreparedRun) ([]byte, er
|
|||||||
|
|
||||||
type textPreparedRunFormatter struct{}
|
type textPreparedRunFormatter struct{}
|
||||||
|
|
||||||
func (textPreparedRunFormatter) Format(prepared *domain.PreparedRun) ([]byte, error) {
|
func (textPreparedRunFormatter) Format(prepared *promptkit.PreparedRun) ([]byte, error) {
|
||||||
if prepared == nil {
|
if prepared == nil {
|
||||||
return nil, errors.New("prepared run is nil")
|
return nil, errors.New("prepared run is nil")
|
||||||
}
|
}
|
||||||
@@ -93,6 +108,9 @@ func (textPreparedRunFormatter) Format(prepared *domain.PreparedRun) ([]byte, er
|
|||||||
fmt.Fprintf(&b, "prompt: %s\n", prepared.PromptID)
|
fmt.Fprintf(&b, "prompt: %s\n", prepared.PromptID)
|
||||||
fmt.Fprintf(&b, "prompt_version: %s\n", prepared.PromptVersion)
|
fmt.Fprintf(&b, "prompt_version: %s\n", prepared.PromptVersion)
|
||||||
fmt.Fprintf(&b, "selected_profile_id: %s\n", prepared.SelectedProfileID)
|
fmt.Fprintf(&b, "selected_profile_id: %s\n", prepared.SelectedProfileID)
|
||||||
|
if prepared.SelectedBackendID != "" {
|
||||||
|
fmt.Fprintf(&b, "selected_backend_id: %s\n", prepared.SelectedBackendID)
|
||||||
|
}
|
||||||
if prepared.PromptHash != "" {
|
if prepared.PromptHash != "" {
|
||||||
fmt.Fprintf(&b, "prompt_hash: %s\n", prepared.PromptHash)
|
fmt.Fprintf(&b, "prompt_hash: %s\n", prepared.PromptHash)
|
||||||
}
|
}
|
||||||
@@ -146,7 +164,7 @@ func (textPreparedRunFormatter) Format(prepared *domain.PreparedRun) ([]byte, er
|
|||||||
|
|
||||||
fmt.Fprintln(&b, "messages:")
|
fmt.Fprintln(&b, "messages:")
|
||||||
roleOrder := make([]string, 0)
|
roleOrder := make([]string, 0)
|
||||||
byRole := make(map[string][]domain.RenderedMessage)
|
byRole := make(map[string][]promptkit.RenderedMessage)
|
||||||
for _, msg := range prepared.Messages {
|
for _, msg := range prepared.Messages {
|
||||||
if _, exists := byRole[msg.Role]; !exists {
|
if _, exists := byRole[msg.Role]; !exists {
|
||||||
roleOrder = append(roleOrder, msg.Role)
|
roleOrder = append(roleOrder, msg.Role)
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ import (
|
|||||||
"strings"
|
"strings"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/domain"
|
"gitea.maximumdirect.net/eric/promptkit"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestTextFormatterIncludesPreparedRunDetails(t *testing.T) {
|
func TestTextFormatterIncludesPreparedRunDetails(t *testing.T) {
|
||||||
@@ -22,6 +22,7 @@ func TestTextFormatterIncludesPreparedRunDetails(t *testing.T) {
|
|||||||
"prompt: prompt.id",
|
"prompt: prompt.id",
|
||||||
"prompt_version: v1",
|
"prompt_version: v1",
|
||||||
"selected_profile_id: local-fast",
|
"selected_profile_id: local-fast",
|
||||||
|
"selected_backend_id: local",
|
||||||
"endpoint: http://llm/v1",
|
"endpoint: http://llm/v1",
|
||||||
"model: gpt-test",
|
"model: gpt-test",
|
||||||
"temperature: 0.4",
|
"temperature: 0.4",
|
||||||
@@ -94,9 +95,8 @@ func TestTextFormatterDoesNotIncludeResolvedAPIKeyValue(t *testing.T) {
|
|||||||
|
|
||||||
func TestTextFormatterDoesNotIncludeDirectAPIKeyValue(t *testing.T) {
|
func TestTextFormatterDoesNotIncludeDirectAPIKeyValue(t *testing.T) {
|
||||||
const directKey = "direct-format-key"
|
const directKey = "direct-format-key"
|
||||||
|
// PreparedRun intentionally has no field for direct API keys.
|
||||||
prepared := samplePreparedRun()
|
prepared := samplePreparedRun()
|
||||||
prepared.EffectiveModelParams.APIKey = directKey
|
|
||||||
|
|
||||||
out, err := FormatPreparedRun(prepared, PreparedRunFormatText)
|
out, err := FormatPreparedRun(prepared, PreparedRunFormatText)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("expected no error, got %v", err)
|
t.Fatalf("expected no error, got %v", err)
|
||||||
@@ -108,12 +108,12 @@ func TestTextFormatterDoesNotIncludeDirectAPIKeyValue(t *testing.T) {
|
|||||||
|
|
||||||
func TestTextFormatterIncludesMessageCacheControlBeforeContent(t *testing.T) {
|
func TestTextFormatterIncludesMessageCacheControlBeforeContent(t *testing.T) {
|
||||||
prepared := samplePreparedRun()
|
prepared := samplePreparedRun()
|
||||||
prepared.Messages = []domain.RenderedMessage{
|
prepared.Messages = []promptkit.RenderedMessage{
|
||||||
{
|
{
|
||||||
Role: "system",
|
Role: "system",
|
||||||
Content: "System guidance.",
|
Content: "System guidance.",
|
||||||
CacheControl: &domain.CacheControl{
|
CacheControl: &promptkit.CacheControl{
|
||||||
Type: domain.CacheControlEphemeral,
|
Type: promptkit.CacheControlEphemeral,
|
||||||
TTL: "1h",
|
TTL: "1h",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@@ -148,12 +148,12 @@ func TestTextFormatterIncludesSessionIDWhenPresent(t *testing.T) {
|
|||||||
|
|
||||||
func TestTextFormatterOmitsEmptyCacheControlTTL(t *testing.T) {
|
func TestTextFormatterOmitsEmptyCacheControlTTL(t *testing.T) {
|
||||||
prepared := samplePreparedRun()
|
prepared := samplePreparedRun()
|
||||||
prepared.Messages = []domain.RenderedMessage{
|
prepared.Messages = []promptkit.RenderedMessage{
|
||||||
{
|
{
|
||||||
Role: "system",
|
Role: "system",
|
||||||
Content: "System guidance.",
|
Content: "System guidance.",
|
||||||
CacheControl: &domain.CacheControl{
|
CacheControl: &promptkit.CacheControl{
|
||||||
Type: domain.CacheControlEphemeral,
|
Type: promptkit.CacheControlEphemeral,
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
@@ -231,12 +231,12 @@ func TestJSONFormatterEmitsValidJSONAndIncludesPreparedRunFields(t *testing.T) {
|
|||||||
|
|
||||||
func TestJSONFormatterIncludesMessageCacheControlOnlyWhenPresent(t *testing.T) {
|
func TestJSONFormatterIncludesMessageCacheControlOnlyWhenPresent(t *testing.T) {
|
||||||
prepared := samplePreparedRun()
|
prepared := samplePreparedRun()
|
||||||
prepared.Messages = []domain.RenderedMessage{
|
prepared.Messages = []promptkit.RenderedMessage{
|
||||||
{
|
{
|
||||||
Role: "system",
|
Role: "system",
|
||||||
Content: "System guidance.",
|
Content: "System guidance.",
|
||||||
CacheControl: &domain.CacheControl{
|
CacheControl: &promptkit.CacheControl{
|
||||||
Type: domain.CacheControlEphemeral,
|
Type: promptkit.CacheControlEphemeral,
|
||||||
TTL: "1h",
|
TTL: "1h",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@@ -262,7 +262,7 @@ func TestJSONFormatterIncludesMessageCacheControlOnlyWhenPresent(t *testing.T) {
|
|||||||
if !ok {
|
if !ok {
|
||||||
t.Fatalf("expected first message cache_control, got %#v", decoded.Messages[0])
|
t.Fatalf("expected first message cache_control, got %#v", decoded.Messages[0])
|
||||||
}
|
}
|
||||||
if cacheControl["type"] != string(domain.CacheControlEphemeral) || cacheControl["ttl"] != "1h" {
|
if cacheControl["type"] != string(promptkit.CacheControlEphemeral) || cacheControl["ttl"] != "1h" {
|
||||||
t.Fatalf("unexpected cache_control payload: %#v", cacheControl)
|
t.Fatalf("unexpected cache_control payload: %#v", cacheControl)
|
||||||
}
|
}
|
||||||
if _, ok := decoded.Messages[1]["cache_control"]; ok {
|
if _, ok := decoded.Messages[1]["cache_control"]; ok {
|
||||||
@@ -285,9 +285,8 @@ func TestJSONFormatterDoesNotIncludeResolvedAPIKeyValue(t *testing.T) {
|
|||||||
|
|
||||||
func TestJSONFormatterDoesNotIncludeDirectAPIKeyValue(t *testing.T) {
|
func TestJSONFormatterDoesNotIncludeDirectAPIKeyValue(t *testing.T) {
|
||||||
const directKey = "direct-format-key"
|
const directKey = "direct-format-key"
|
||||||
|
// PreparedRun intentionally has no field for direct API keys.
|
||||||
prepared := samplePreparedRun()
|
prepared := samplePreparedRun()
|
||||||
prepared.EffectiveModelParams.APIKey = directKey
|
|
||||||
|
|
||||||
out, err := FormatPreparedRun(prepared, PreparedRunFormatJSON)
|
out, err := FormatPreparedRun(prepared, PreparedRunFormatJSON)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatalf("expected no error, got %v", err)
|
t.Fatalf("expected no error, got %v", err)
|
||||||
@@ -342,13 +341,15 @@ func TestFormatPreparedRunByNameUnknownFailsClearly(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
func samplePreparedRun() *domain.PreparedRun {
|
func samplePreparedRun() *promptkit.PreparedRun {
|
||||||
return &domain.PreparedRun{
|
return &promptkit.PreparedRun{
|
||||||
PromptID: "prompt.id",
|
PromptID: "prompt.id",
|
||||||
PromptVersion: "v1",
|
PromptVersion: "v1",
|
||||||
PromptHash: "prompt-hash",
|
PromptHash: "prompt-hash",
|
||||||
SelectedProfileID: "local-fast",
|
SelectedProfileID: "local-fast",
|
||||||
EffectiveModelParams: domain.ExecutionTarget{
|
SelectedBackendID: "local",
|
||||||
|
EffectiveModelParams: promptkit.ExecutionTarget{
|
||||||
|
BackendID: "local",
|
||||||
Endpoint: "http://llm/v1",
|
Endpoint: "http://llm/v1",
|
||||||
Model: "gpt-test",
|
Model: "gpt-test",
|
||||||
Temperature: 0.4,
|
Temperature: 0.4,
|
||||||
@@ -364,7 +365,7 @@ func samplePreparedRun() *domain.PreparedRun {
|
|||||||
"glossary": "hash-glossary",
|
"glossary": "hash-glossary",
|
||||||
},
|
},
|
||||||
RenderedPromptHash: "rendered-hash",
|
RenderedPromptHash: "rendered-hash",
|
||||||
Messages: []domain.RenderedMessage{
|
Messages: []promptkit.RenderedMessage{
|
||||||
{Role: "system", Content: "System guidance."},
|
{Role: "system", Content: "System guidance."},
|
||||||
{Role: "user", Content: "Summarize the transcript.\nInclude key entities."},
|
{Role: "user", Content: "Summarize the transcript.\nInclude key entities."},
|
||||||
{Role: "user", Content: "Second user message."},
|
{Role: "user", Content: "Second user message."},
|
||||||
|
|||||||
@@ -1,11 +0,0 @@
|
|||||||
package llm
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/domain"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Client executes a rendered prompt against an LLM endpoint.
|
|
||||||
type Client interface {
|
|
||||||
Generate(ctx context.Context, req domain.GenerateRequest) (*domain.GenerateResponse, error)
|
|
||||||
}
|
|
||||||
@@ -1,388 +0,0 @@
|
|||||||
package llm
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"encoding/json"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"net/http"
|
|
||||||
"net/url"
|
|
||||||
"os"
|
|
||||||
"strings"
|
|
||||||
"time"
|
|
||||||
"unicode/utf8"
|
|
||||||
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/defaults"
|
|
||||||
"gitea.maximumdirect.net/eric/scriptorium/internal/domain"
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
ErrInvalidConfig = errors.New("invalid llm client configuration")
|
|
||||||
ErrInvalidRequest = errors.New("invalid generate request")
|
|
||||||
ErrRequestFailed = errors.New("llm request failed")
|
|
||||||
ErrUnexpectedStatus = errors.New("llm returned non-success status")
|
|
||||||
ErrMalformedResponse = errors.New("malformed llm response")
|
|
||||||
)
|
|
||||||
|
|
||||||
type OpenAICompatibleConfig struct {
|
|
||||||
BaseURL string
|
|
||||||
Model string
|
|
||||||
Timeout time.Duration
|
|
||||||
HTTPClient *http.Client
|
|
||||||
}
|
|
||||||
|
|
||||||
type OpenAICompatibleClient struct {
|
|
||||||
baseURL string
|
|
||||||
defaultModel string
|
|
||||||
timeout time.Duration
|
|
||||||
httpClient *http.Client
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewOpenAICompatibleClient(cfg OpenAICompatibleConfig) (*OpenAICompatibleClient, error) {
|
|
||||||
baseURL := strings.TrimSpace(cfg.BaseURL)
|
|
||||||
if baseURL != "" {
|
|
||||||
if _, err := url.ParseRequestURI(baseURL); err != nil {
|
|
||||||
return nil, fmt.Errorf("%w: invalid base URL: %v", ErrInvalidConfig, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
timeout := cfg.Timeout
|
|
||||||
if timeout <= 0 {
|
|
||||||
timeout = defaults.LLMRequestTimeoutDefault
|
|
||||||
}
|
|
||||||
|
|
||||||
var client *http.Client
|
|
||||||
if cfg.HTTPClient != nil {
|
|
||||||
cloned := *cfg.HTTPClient
|
|
||||||
if cloned.Timeout == 0 {
|
|
||||||
cloned.Timeout = timeout
|
|
||||||
}
|
|
||||||
client = &cloned
|
|
||||||
} else {
|
|
||||||
client = &http.Client{Timeout: timeout}
|
|
||||||
}
|
|
||||||
|
|
||||||
return &OpenAICompatibleClient{
|
|
||||||
baseURL: strings.TrimRight(baseURL, "/"),
|
|
||||||
defaultModel: cfg.Model,
|
|
||||||
timeout: timeout,
|
|
||||||
httpClient: client,
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *OpenAICompatibleClient) Generate(ctx context.Context, req domain.GenerateRequest) (*domain.GenerateResponse, error) {
|
|
||||||
if req.Target.TimeoutSeconds < 0 {
|
|
||||||
return nil, fmt.Errorf("%w: timeout_seconds must be greater than or equal to 0", ErrInvalidRequest)
|
|
||||||
}
|
|
||||||
|
|
||||||
endpoint := strings.TrimSpace(req.Target.Endpoint)
|
|
||||||
if endpoint == "" {
|
|
||||||
endpoint = c.baseURL
|
|
||||||
}
|
|
||||||
if endpoint == "" {
|
|
||||||
return nil, fmt.Errorf("%w: endpoint is required", ErrInvalidRequest)
|
|
||||||
}
|
|
||||||
endpoint = strings.TrimRight(endpoint, "/") + defaults.OpenAIChatCompletionsPath
|
|
||||||
|
|
||||||
wireReq, err := openAIChatRequestFromGenerateRequest(req, c.defaultModel)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("%w: %v", ErrInvalidRequest, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
wirePayload, err := openAIChatRequestPayload(wireReq)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("%w: %v", ErrInvalidRequest, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
payload, err := json.Marshal(wirePayload)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("%w: failed to encode request: %v", ErrRequestFailed, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
httpReq, err := http.NewRequestWithContext(ctx, http.MethodPost, endpoint, bytes.NewReader(payload))
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("%w: failed to create request: %v", ErrRequestFailed, err)
|
|
||||||
}
|
|
||||||
httpReq.Header.Set("Content-Type", "application/json")
|
|
||||||
if apiKey := strings.TrimSpace(req.Target.APIKey); apiKey != "" {
|
|
||||||
httpReq.Header.Set("Authorization", "Bearer "+apiKey)
|
|
||||||
} else if envName := strings.TrimSpace(req.Target.APIKeyEnv); envName != "" {
|
|
||||||
apiKey := strings.TrimSpace(os.Getenv(envName))
|
|
||||||
if apiKey == "" {
|
|
||||||
return nil, fmt.Errorf("%w: api key environment variable %q is not set", ErrInvalidRequest, envName)
|
|
||||||
}
|
|
||||||
httpReq.Header.Set("Authorization", "Bearer "+apiKey)
|
|
||||||
}
|
|
||||||
|
|
||||||
effectiveTimeout := c.timeout
|
|
||||||
if req.Target.TimeoutSeconds > 0 {
|
|
||||||
effectiveTimeout = time.Duration(req.Target.TimeoutSeconds) * time.Second
|
|
||||||
} else if req.TargetPresence.TimeoutSeconds {
|
|
||||||
effectiveTimeout = 0
|
|
||||||
}
|
|
||||||
|
|
||||||
httpClient := c.httpClient
|
|
||||||
if httpClient == nil {
|
|
||||||
httpClient = &http.Client{Timeout: effectiveTimeout}
|
|
||||||
} else if httpClient.Timeout != effectiveTimeout {
|
|
||||||
cloned := *httpClient
|
|
||||||
cloned.Timeout = effectiveTimeout
|
|
||||||
httpClient = &cloned
|
|
||||||
}
|
|
||||||
|
|
||||||
httpResp, err := httpClient.Do(httpReq)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("%w: %v", ErrRequestFailed, err)
|
|
||||||
}
|
|
||||||
defer httpResp.Body.Close()
|
|
||||||
|
|
||||||
if httpResp.StatusCode < 200 || httpResp.StatusCode >= 300 {
|
|
||||||
_, _ = io.Copy(io.Discard, io.LimitReader(httpResp.Body, 4096))
|
|
||||||
return nil, fmt.Errorf("%w: status=%d", ErrUnexpectedStatus, httpResp.StatusCode)
|
|
||||||
}
|
|
||||||
|
|
||||||
var wireResp openAIChatResponse
|
|
||||||
if err := json.NewDecoder(httpResp.Body).Decode(&wireResp); err != nil {
|
|
||||||
return nil, fmt.Errorf("%w: failed to decode response: %v", ErrMalformedResponse, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(wireResp.Choices) == 0 {
|
|
||||||
return nil, fmt.Errorf("%w: no choices returned", ErrMalformedResponse)
|
|
||||||
}
|
|
||||||
content := wireResp.Choices[0].Message.Content
|
|
||||||
if content == "" {
|
|
||||||
return nil, fmt.Errorf("%w: first choice has empty message content", ErrMalformedResponse)
|
|
||||||
}
|
|
||||||
|
|
||||||
return &domain.GenerateResponse{
|
|
||||||
Content: content,
|
|
||||||
Usage: domain.TokenUsage{
|
|
||||||
PromptTokens: wireResp.Usage.PromptTokens,
|
|
||||||
CompletionTokens: wireResp.Usage.CompletionTokens,
|
|
||||||
TotalTokens: wireResp.Usage.TotalTokens,
|
|
||||||
CachedTokens: wireResp.Usage.PromptTokensDetails.CachedTokens,
|
|
||||||
CacheWriteTokens: wireResp.Usage.CacheWriteTokens,
|
|
||||||
},
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func openAIChatRequestFromGenerateRequest(req domain.GenerateRequest, defaultModel string) (openAIChatRequest, error) {
|
|
||||||
model := strings.TrimSpace(req.Target.Model)
|
|
||||||
if model == "" {
|
|
||||||
model = strings.TrimSpace(defaultModel)
|
|
||||||
}
|
|
||||||
if model == "" {
|
|
||||||
return openAIChatRequest{}, errors.New("model is required")
|
|
||||||
}
|
|
||||||
|
|
||||||
wireReq := openAIChatRequest{
|
|
||||||
Model: model,
|
|
||||||
}
|
|
||||||
if sessionID := strings.TrimSpace(req.Prompt.SessionID); sessionID != "" {
|
|
||||||
if n := utf8.RuneCountInString(sessionID); n > domain.SessionIDMaxLength {
|
|
||||||
return openAIChatRequest{}, fmt.Errorf("session_id length %d exceeds maximum %d", n, domain.SessionIDMaxLength)
|
|
||||||
}
|
|
||||||
wireReq.SessionID = sessionID
|
|
||||||
}
|
|
||||||
|
|
||||||
wireReq.Messages = make([]openAIChatRequestMessage, 0, len(req.Prompt.Messages))
|
|
||||||
for _, msg := range req.Prompt.Messages {
|
|
||||||
wireReq.Messages = append(wireReq.Messages, openAIChatRequestMessageFromRenderedMessage(msg))
|
|
||||||
}
|
|
||||||
|
|
||||||
if req.Target.Temperature != 0 || req.TargetPresence.Temperature {
|
|
||||||
wireReq.Temperature = &req.Target.Temperature
|
|
||||||
}
|
|
||||||
if req.Target.MaxTokens != 0 || req.TargetPresence.MaxTokens {
|
|
||||||
wireReq.MaxTokens = &req.Target.MaxTokens
|
|
||||||
}
|
|
||||||
if req.Target.TopP != 0 || req.TargetPresence.TopP {
|
|
||||||
wireReq.TopP = &req.Target.TopP
|
|
||||||
}
|
|
||||||
if strings.TrimSpace(req.Target.ServiceTier) != "" {
|
|
||||||
wireReq.ServiceTier = req.Target.ServiceTier
|
|
||||||
}
|
|
||||||
if strings.TrimSpace(req.Target.ReasoningEffort) != "" {
|
|
||||||
wireReq.ReasoningEffort = req.Target.ReasoningEffort
|
|
||||||
}
|
|
||||||
if len(req.Target.ExtraParams) > 0 {
|
|
||||||
wireReq.ExtraParams = req.Target.ExtraParams
|
|
||||||
}
|
|
||||||
if req.StructuredOutput != nil {
|
|
||||||
responseFormat, err := toOpenAIResponseFormat(req.StructuredOutput)
|
|
||||||
if err != nil {
|
|
||||||
return openAIChatRequest{}, err
|
|
||||||
}
|
|
||||||
wireReq.ResponseFormat = responseFormat
|
|
||||||
}
|
|
||||||
|
|
||||||
return wireReq, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
type openAIChatRequest struct {
|
|
||||||
Model string `json:"model"`
|
|
||||||
SessionID string `json:"session_id,omitempty"`
|
|
||||||
Messages []openAIChatRequestMessage `json:"messages"`
|
|
||||||
Temperature *float64 `json:"temperature,omitempty"`
|
|
||||||
MaxTokens *int `json:"max_tokens,omitempty"`
|
|
||||||
TopP *float64 `json:"top_p,omitempty"`
|
|
||||||
ServiceTier string `json:"service_tier,omitempty"`
|
|
||||||
ReasoningEffort string `json:"reasoning_effort,omitempty"`
|
|
||||||
ResponseFormat *openAIResponseFormat `json:"response_format,omitempty"`
|
|
||||||
ExtraParams map[string]any `json:"-"`
|
|
||||||
}
|
|
||||||
|
|
||||||
func openAIChatRequestPayload(req openAIChatRequest) (map[string]any, error) {
|
|
||||||
out := map[string]any{
|
|
||||||
"model": req.Model,
|
|
||||||
"messages": req.Messages,
|
|
||||||
}
|
|
||||||
if req.SessionID != "" {
|
|
||||||
out["session_id"] = req.SessionID
|
|
||||||
}
|
|
||||||
if req.Temperature != nil {
|
|
||||||
out["temperature"] = *req.Temperature
|
|
||||||
}
|
|
||||||
if req.MaxTokens != nil {
|
|
||||||
out["max_tokens"] = *req.MaxTokens
|
|
||||||
}
|
|
||||||
if req.TopP != nil {
|
|
||||||
out["top_p"] = *req.TopP
|
|
||||||
}
|
|
||||||
if req.ServiceTier != "" {
|
|
||||||
out["service_tier"] = req.ServiceTier
|
|
||||||
}
|
|
||||||
if req.ReasoningEffort != "" {
|
|
||||||
out["reasoning_effort"] = req.ReasoningEffort
|
|
||||||
}
|
|
||||||
if req.ResponseFormat != nil {
|
|
||||||
out["response_format"] = req.ResponseFormat
|
|
||||||
}
|
|
||||||
|
|
||||||
for key, value := range req.ExtraParams {
|
|
||||||
if key == "" {
|
|
||||||
return nil, errors.New("extra_params key must not be empty")
|
|
||||||
}
|
|
||||||
if _, reserved := reservedOpenAIChatRequestFields[key]; reserved {
|
|
||||||
return nil, fmt.Errorf("extra_params key %q collides with reserved request field", key)
|
|
||||||
}
|
|
||||||
if _, err := json.Marshal(value); err != nil {
|
|
||||||
return nil, fmt.Errorf("extra_params.%s must be JSON-serializable: %w", key, err)
|
|
||||||
}
|
|
||||||
out[key] = value
|
|
||||||
}
|
|
||||||
|
|
||||||
return out, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
var reservedOpenAIChatRequestFields = map[string]struct{}{
|
|
||||||
"model": {},
|
|
||||||
"session_id": {},
|
|
||||||
"messages": {},
|
|
||||||
"temperature": {},
|
|
||||||
"max_tokens": {},
|
|
||||||
"top_p": {},
|
|
||||||
"service_tier": {},
|
|
||||||
"reasoning_effort": {},
|
|
||||||
"response_format": {},
|
|
||||||
}
|
|
||||||
|
|
||||||
type openAIChatRequestMessage struct {
|
|
||||||
Role string `json:"role"`
|
|
||||||
Content any `json:"content"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type openAIChatTextContentBlock struct {
|
|
||||||
Type string `json:"type"`
|
|
||||||
Text string `json:"text"`
|
|
||||||
CacheControl *openAICacheControl `json:"cache_control,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type openAICacheControl struct {
|
|
||||||
Type string `json:"type"`
|
|
||||||
TTL string `json:"ttl,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type openAIChatResponseMessage struct {
|
|
||||||
Role string `json:"role"`
|
|
||||||
Content string `json:"content"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type openAIChatResponse struct {
|
|
||||||
Choices []struct {
|
|
||||||
Message openAIChatResponseMessage `json:"message"`
|
|
||||||
} `json:"choices"`
|
|
||||||
Usage struct {
|
|
||||||
PromptTokens int `json:"prompt_tokens"`
|
|
||||||
CompletionTokens int `json:"completion_tokens"`
|
|
||||||
TotalTokens int `json:"total_tokens"`
|
|
||||||
PromptTokensDetails struct {
|
|
||||||
CachedTokens int `json:"cached_tokens"`
|
|
||||||
} `json:"prompt_tokens_details"`
|
|
||||||
CacheWriteTokens int `json:"cache_write_tokens"`
|
|
||||||
} `json:"usage"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type openAIResponseFormat struct {
|
|
||||||
Type string `json:"type"`
|
|
||||||
JSONSchema *openAIJSONSchemaEnvelope `json:"json_schema,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type openAIJSONSchemaEnvelope struct {
|
|
||||||
Name string `json:"name"`
|
|
||||||
Strict bool `json:"strict"`
|
|
||||||
Schema any `json:"schema"`
|
|
||||||
}
|
|
||||||
|
|
||||||
func openAIChatRequestMessageFromRenderedMessage(msg domain.RenderedMessage) openAIChatRequestMessage {
|
|
||||||
wireMsg := openAIChatRequestMessage{
|
|
||||||
Role: msg.Role,
|
|
||||||
Content: msg.Content,
|
|
||||||
}
|
|
||||||
if msg.CacheControl == nil {
|
|
||||||
return wireMsg
|
|
||||||
}
|
|
||||||
|
|
||||||
wireMsg.Content = []openAIChatTextContentBlock{
|
|
||||||
{
|
|
||||||
Type: "text",
|
|
||||||
Text: msg.Content,
|
|
||||||
CacheControl: &openAICacheControl{
|
|
||||||
Type: string(msg.CacheControl.Type),
|
|
||||||
TTL: msg.CacheControl.TTL,
|
|
||||||
},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
return wireMsg
|
|
||||||
}
|
|
||||||
|
|
||||||
func toOpenAIResponseFormat(spec *domain.StructuredOutputSpec) (*openAIResponseFormat, error) {
|
|
||||||
if spec == nil {
|
|
||||||
return nil, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
switch spec.Type {
|
|
||||||
case domain.StructuredOutputJSONSchema:
|
|
||||||
if spec.JSONSchema == nil {
|
|
||||||
return nil, errors.New("json_schema structured output requires schema payload")
|
|
||||||
}
|
|
||||||
if strings.TrimSpace(spec.JSONSchema.Name) == "" {
|
|
||||||
return nil, errors.New("json_schema structured output requires non-empty schema name")
|
|
||||||
}
|
|
||||||
if spec.JSONSchema.Schema == nil {
|
|
||||||
return nil, errors.New("json_schema structured output requires schema document")
|
|
||||||
}
|
|
||||||
return &openAIResponseFormat{
|
|
||||||
Type: "json_schema",
|
|
||||||
JSONSchema: &openAIJSONSchemaEnvelope{
|
|
||||||
Name: spec.JSONSchema.Name,
|
|
||||||
Strict: spec.JSONSchema.Strict,
|
|
||||||
Schema: spec.JSONSchema.Schema,
|
|
||||||
},
|
|
||||||
}, nil
|
|
||||||
default:
|
|
||||||
return nil, fmt.Errorf("unsupported structured output type %q", spec.Type)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
File diff suppressed because it is too large
Load Diff
@@ -1,9 +0,0 @@
|
|||||||
id: aion-2
|
|
||||||
endpoint: https://openrouter.ai/api/v1
|
|
||||||
model: aion-labs/aion-2.0
|
|
||||||
temperature: 0.72
|
|
||||||
reasoning_effort: high
|
|
||||||
top_p: 0.95
|
|
||||||
timeout_seconds: 180
|
|
||||||
api_key_env: OPENROUTER_API_KEY
|
|
||||||
service_tier: flex
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
id: claude-fable-latest
|
|
||||||
endpoint: https://openrouter.ai/api/v1
|
|
||||||
model: "~anthropic/claude-fable-latest"
|
|
||||||
reasoning_effort: high
|
|
||||||
timeout_seconds: 600
|
|
||||||
api_key_env: OPENROUTER_API_KEY
|
|
||||||
service_tier: flex
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
id: claude-haiku-latest
|
|
||||||
endpoint: https://openrouter.ai/api/v1
|
|
||||||
model: "~anthropic/claude-haiku-latest"
|
|
||||||
reasoning_effort: medium
|
|
||||||
timeout_seconds: 240
|
|
||||||
api_key_env: OPENROUTER_API_KEY
|
|
||||||
service_tier: flex
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
id: claude-opus-latest
|
|
||||||
endpoint: https://openrouter.ai/api/v1
|
|
||||||
model: "~anthropic/claude-opus-latest"
|
|
||||||
reasoning_effort: high
|
|
||||||
timeout_seconds: 240
|
|
||||||
api_key_env: OPENROUTER_API_KEY
|
|
||||||
service_tier: flex
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
id: claude-sonnet-latest
|
|
||||||
endpoint: https://openrouter.ai/api/v1
|
|
||||||
model: "~anthropic/claude-sonnet-latest"
|
|
||||||
reasoning_effort: high
|
|
||||||
timeout_seconds: 240
|
|
||||||
api_key_env: OPENROUTER_API_KEY
|
|
||||||
service_tier: flex
|
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
id: deepseek-3-2
|
|
||||||
endpoint: https://openrouter.ai/api/v1
|
|
||||||
model: deepseek/deepseek-v3.2
|
|
||||||
reasoning_effort: high
|
|
||||||
timeout_seconds: 180
|
|
||||||
api_key_env: OPENROUTER_API_KEY
|
|
||||||
service_tier: flex
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user