diff --git a/.agents/skills/purview-architecture-testing/SKILL.md b/.agents/skills/purview-architecture-testing/SKILL.md deleted file mode 100644 index 55d0ca8..0000000 --- a/.agents/skills/purview-architecture-testing/SKILL.md +++ /dev/null @@ -1,184 +0,0 @@ ---- -name: purview-architecture-testing -description: >- - Use when adding, changing or debugging architecture tests in a .NET solution - dependency-direction - rules, forbidden framework references, project naming checks, cycle detection - or when a boundary - keeps being broken in review and should fail the build instead. Adopts Purview.Architecture.Testing - and a single policy file rather than hand-maintained lists. -license: MIT -metadata: - author: Purview-Dev - version: "2.0" - repository: purview-dev/engineering-playbook ---- - -# Purview architecture testing - -A boundary that only review enforces is a boundary that erodes. The job of this skill is to turn a -rule a reviewer keeps repeating into a test that fails the build, **without** producing a wall of -brittle assertions that everyone disables six months later. - -Prerequisite: know what the projects are *for*. See `purview-architecture`. - -## 1. Only test a rule that is real - -Before writing anything, answer: **has this rule been broken, or is it certain to be?** - -A test for a dependency nobody would plausibly add is cost with no benefit. Good candidates: - -- A direction that has already been violated once. -- A boundary that is load-bearing - Core staying free of EF Core, Composition being referenced by - nothing. -- A rule a newcomer cannot infer from the code. - -Bad candidates: anything the compiler already enforces, and style preferences dressed up as -architecture. - -## 2. Adopt the package; define the policy once - -The failure mode of architecture tests is a dependency matrix written twice - once in a wiki table and -once in assertions - which then disagree. The prose is the copy that drifts, because nothing fails -when it is wrong. - -So do not write the rule engine. `Purview.Architecture.Testing` ships it, so the matrix, naming, -sibling-independence, composition, forbidden-package, cycle, test-reference and waiver rules are -defined once and shared. Adoption is two files. - -**A policy** at `.config/architecture-policy.json`, pointing at the published schema so an editor -validates it as you type: - -```json -{ - "$schema": "https://raw.githubusercontent.com/purview-dev/architests/main/architecture-policy.schema.json", - "version": 2, - "sourceRoots": ["src"], - "responsibilities": [ - { - "name": "Core", - "aliases": ["Domain"], - "category": "domain", - "purpose": "The domain model, its invariants and its rules.", - "mayDependOn": ["Shared"], - "mustNotDependOn": ["Application", "Persistence", "Composition"], - "forbiddenPackagePrefixes": ["Microsoft.EntityFrameworkCore", "Microsoft.AspNetCore"] - } - ], - "waivers": [] -} -``` - -**One derived test class:** - -```csharp -[InheritsTests] -public sealed class ArchitectureTests : PurviewArchitectureTests; -``` - -That is the whole of the adoption. Each rule is a separate test, so a failure names the rule rather -than collapsing the set into one assertion, and the package validates the policy against its schema -first - a policy that does not match the schema may be silently missing a rule. - -The build-sdk ships a skill for the package itself, `purview-buildsdk-architecture-tests`, which is -authoritative on its API and rule ids. Read it rather than this page when you are extending or -debugging the package. - -Then add a test that the documentation matches the policy, so the table in the wiki is falsifiable -too. Full worked example: -[Project Responsibilities](https://github.com/purview-dev/engineering-playbook/blob/main/docs/wiki/foundations/Project-Responsibilities.md). - -## 3. Read project files, and assemblies - -Two sources, because they catch different things: - -| Source | Catches | Misses | -| -- | -- | -- | -| `.csproj` `ProjectReference` | The reference a reviewer actually added | A dependency arriving transitively | -| Compiled assembly references | A dependency that arrived indirectly | Intent — it cannot tell direct from transitive | - -The package's rules read the **project files**, because a declared `ProjectReference` is what a -reviewer adds and what the policy governs. Add a small hand-written test that reads the **compiled -assemblies** for the leak a project file cannot show - a namespace from the wrong layer reaching a -public type. - -Classify a project by the **first segment** of its name, so `Persistence.SqlServer` and `Persistence` -are both Persistence - qualification is a naming choice, never a different rule. The package does -this for you; a hand-written assembly test must do it too. - -## 4. The rules worth having - -| Rule | What it catches | -| -- | -- | -| Dependency matrix | Core referencing Persistence; Application referencing a concrete provider | -| Nothing references Composition | A circular implementation choice | -| Sibling independence | `Providers.GitHub` reaching into `Providers.AzureDevOps` | -| Forbidden package prefixes | EF Core in Core; ASP.NET hosting in a domain project | -| Cycle detection | A graph that MSBuild rejects with an unreadable message | -| Catch-all names | `Infrastructure`, `Services`, `Helpers` appearing as project names | -| No production → test reference | A test helper leaking into shipped code | - -The package provides all of these. Do not re-implement one; change the policy instead. - -## 5. Write failures someone can act on - -This is what decides whether the suite survives. A failure must name: - -1. The offending project. -2. The rule violated. -3. The specific reference that broke it. -4. The direction the dependency *should* run. -5. The likely fix. - -```text -'Application' (Application) references 'Persistence.SqlServer' (Persistence), but Application -must not depend on Persistence. Invert it: Persistence may depend on Application, or introduce -an abstraction that Application owns and Persistence implements. -``` - -Not `Expected collection to be empty`. Collect every violation and report them as a numbered list - -one test run should show all of them, not the first. The package already reports this way; keep the -same standard in any rule you add. - -## 6. Waivers, not suppressions - -A repository that predates the policy will violate it. Deleting the test or adding a blanket -`#pragma` makes the policy a lie. Record the departure in the policy instead: - -```json -{ - "project": "Infrastructure", - "mapsTo": "Adapters", - "rules": ["naming"], - "reason": "Holds one adapter, predates the catalogue; renaming churns the wiki and docs for no gain.", - "reviewedOn": "2026-10-15" -} -``` - -The package tests the waivers themselves: each must name a project that still exists, a rule, and a -substantive reason. A waiver for a deleted project is dead weight that hides the next one. - -Critically, a waiver excuses **the narrowest thing possible** - usually the name. `mapsTo` keeps the -project classified so every dependency rule still applies to it. Prefer a waiver to -`SkipRule`, which removes a rule for the whole repository with no record. - -## 7. Conventions - -- TUnit, matching the repository's other tests, adopted through `PurviewArchitectureTests` with - `[InheritsTests]`. -- Arrange/Act/Assert, one behaviour per test. -- Let the package find the repository root - it probes upward for the policy and stops at the `.git` - boundary. Override `RepositoryRoot` only when the policy does not sit above the test binary. -- Keep the policy file free of anything a rule cannot read; a field no rule consults is a rule that - looks enforced and is not. - -## Checks before you answer - -- Is every rule you added one that has been, or will be, broken? -- Is the matrix defined once, in the policy, with the documentation checked against it? -- Does each failure name the fix, not just the fact? -- Did you record a waiver rather than weaken a rule for existing code? - -## See also - -- `purview-architecture` — what the projects are for, and how they are named -- `purview-buildsdk-architecture-tests` — the package's own skill, authoritative on its API -- [Architecture as Tests](https://github.com/purview-dev/engineering-playbook/blob/main/docs/wiki/foundations/Architecture-As-Tests.md) diff --git a/.agents/skills/purview-architecture/SKILL.md b/.agents/skills/purview-architecture/SKILL.md deleted file mode 100644 index 0c43596..0000000 --- a/.agents/skills/purview-architecture/SKILL.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -name: purview-architecture -description: >- - Use when deciding the shape of a .NET solution that uses Purview libraries — how many projects, - whether to add a repository or CQRS layer, where validation lives, how an API and its clients share - a contract (Contracts, OpenAPI or Hybrid) and when a BFF is earned — or before generating - substantial implementation code. Establishes project context first, then applies DRY, KISS and - architecture proportional to the actual requirements rather than to an enterprise reference diagram. -license: MIT -metadata: - author: Purview-Dev - version: "1.0" - repository: purview-dev/engineering-playbook ---- - -# Purview architecture - -The job of this skill is to stop two failures that cost far more than they look: - -- **Architecture bought in advance.** Four projects, a repository interface and a mapping layer for an - application that has one table and one caller. -- **A recommendation made without context.** Advice about database-side GUID generation given to a - stateless CLI, or a Clean Architecture split proposed for a 300-line utility. - -So: establish context, then choose proportionally. Both steps are mandatory, and the first one is the -one that gets skipped. - -## 1. Establish context before deciding - -Before recommending a structure, adding a project, or generating substantial code, you must know four -things. **Read them out of the repository first** — asking a user a question the code already answers -is the most common way this skill is applied badly. - -| Dimension | Read it from | Ask only if | -| -- | -- | -- | -| Complexity (small / medium / large) | Number of functional areas, integrations and external consumers — not file count | The requirements are genuinely not written down anywhere | -| Project type | SDK attribute, `OutputType`, `Microsoft.NET.Sdk.Web`, an AppHost project, a `Main` | The repository is empty | -| Persistence | `PackageReference` to an EF Core provider, `DbContext`, a connection string, a `Purview.Containers` resource | Persistence is being introduced now | -| Telemetry | `Purview.Telemetry.SourceGenerator`, `ILogger` injection, `ActivitySource`, an OTLP exporter | Nothing is configured and you are about to add it | - -Identifier generation is a **conditional** dimension: resolve it only when persistence exists *and* -GUID keys are in play. See `purview-persistence`. - -Judge complexity on requirements, not size. A 2,000-line CLI with one output format is small. A -900-line service that reconciles three upstream systems and owns money movement is not. - -**Do not re-ask.** A dimension answered by repository configuration, existing source, a project file, -an earlier turn in the conversation, or a recorded architectural decision is answered. Ask concise, -targeted questions only for the unknowns that change your recommendation — and if nothing changes, -ask nothing. - -Full decision procedure: `references/project-context-discovery.md`. - -## 2. Choose proportionally - -| Scale | Shape | What you still do not add | -| -- | -- | -- | -| Small | One project, or two when a test project needs a non-trivial subject. Direct implementations. | Repository over `DbContext`, CQRS, a mapping layer, speculative interfaces | -| Medium | Explicit boundaries where complexity already hurts — usually a domain project and a host | Event sourcing, a generic infrastructure framework, a second infrastructure implementation nobody asked for | -| Large | Modularity, independent infrastructure implementations, enforceable boundaries (see the playbook's Architecture-As-Tests page) | Patterns adopted for symmetry rather than for a named problem | - -Architecture is allowed to arrive late. A boundary added when the second caller appears is cheap; a -boundary added in anticipation of a second caller that never appears is permanent. - -**Never add a project for symmetry.** "Domain, Application, Infrastructure, API" is a response to a -problem, not a starting position. If you cannot name the failure a layer prevents in this codebase, -do not add the layer. - -Full guidance and the per-pattern justification tests: `references/proportional-architecture.md`. - -## 3. Name what you do create - -A project name states a **responsibility**, optionally qualified by an implementation: - -```text -[.] -``` - -The responsibility decides the rules; the qualifier never changes them. Three rules people usually -get wrong: - -- **Do not qualify a single implementation.** `Persistence` is correct even when it uses SQL Server. - Rename when a second provider arrives, not in anticipation. -- **Do not create an empty parent.** `Persistence.SqlServer` + `Persistence.PostgreSql` with nothing - shared need no `Persistence` project. -- **Multiple implementations do not require multiple assemblies.** Two small adapters with the same - dependencies belong in one project. - -Never use a *category* as a project name — `Infrastructure`, `Services`, `Managers`, `Models`, -`Helpers`, `Common`. Nothing can be excluded from a category, so it grows without limit. And never -rename an established project just to match canonical terminology; `Domain`, `UseCases` and -`Integrations` are recognised aliases. - -Responsibility catalogue, dependency matrix and the naming decision tree: -`references/project-responsibilities.md`. - -## 4. Check the direction - -`A → B` means **A depends on B at compile time** — not a runtime call, a DI registration, an HTTP -request or an Aspire orchestration edge. Confusing those is the most common source of a wrong answer -about whether a dependency is allowed. - -The rules that matter most: - -- Core depends on nothing but `Shared`. -- Application never references a concrete `Persistence`, `Providers` or `Adapters` project. -- Composition references implementations; **nothing references Composition** except a host. -- Sibling implementations (`Providers.GitHub`, `Providers.AzureDevOps`) stay independent. -- Persistence owns migration *definitions*; `Migrator` owns their *execution*. Production API startup - does not apply schema migrations. - -When a boundary is worth having, make it fail the build rather than the review — see -`purview-architecture-testing`. - -## 5. Choose how an API and its clients share a contract - -When there is an HTTP API and at least one client, choose **Contracts**, **OpenAPI** or **Hybrid** -from the clients that **exist today**. A planned client is noted; it does not count. - -| Clients today | Strategy | Failure it prevents | -| -- | -- | -- | -| All .NET, same solution, shipped in lockstep | **Contracts** — a library of request/response types on the domain's value objects, referenced by the server and every .NET client | Rules drifting, and a weaker second copy of them in the UI | -| At least one non-.NET client, or one that ships independently | **Hybrid** — Contracts is the source; the OpenAPI document and its schemas are generated from it | Non-.NET clients hand-writing shapes, and .NET clients losing their value objects to a generated client | -| No .NET client — partners or the public only | **OpenAPI**, generated from the server's types; no Contracts project | A project with no consumer but the server | - -The rules that do not bend: - -- **OpenAPI is an output, never an input**, while Contracts exists. Never regenerate a C# client from - your own API's document when that client is in the same solution. -- **Never hand-maintain a parallel set of models**, and **the server always validates** — a shared - validator is for user experience, not trust. -- **Contracts is browser-safe** when a WebAssembly client references it: architecture-policy bans, - the trim and AOT analyzers and the browser platform analyzer check it, not a reviewer. -- **A BFF is earned by keeping tokens out of the browser.** It holds the tokens, gives the browser an - `HttpOnly` cookie, forwards with the user's token, and requires an anti-forgery header on every - forwarded call. In Blazor it is the host that serves the WebAssembly client, and a BFF that only - forwards does not reference Contracts. The policy does not define a BFF yet, so these are review - obligations until a future Build SDK release adds Blazor and BFF support. - -Full procedure, version-skew rules, BFF guidance and worked examples: `references/contract-strategy.md`. - -## 6. DRY, applied where it pays - -Reuse the Purview libraries when they remove a real source of truth, not for coverage: - -| Concern | Library | Use it when | -| -- | -- | -- | -| Operation outcomes without exceptions for control flow | `Purview.Results` | Failures are expected and the caller must handle them | -| Primitive obsession, validated identity types | `Purview.ValueObjects` | A value has rules that would otherwise be re-checked at each boundary | -| Schema shared with a TypeScript client | `Purview.ZodSharp` | A contract is duplicated between C# and TypeScript today | -| Local dependencies for dev and integration tests | `Purview.Containers` | Tests need a real database, queue or emulator | -| Logging, tracing and metrics from one declaration | `Purview.Telemetry.SourceGenerator` | Always — see `purview-telemetry` | - -Duplication that matters: validation repeated per entry point, a domain rule restated in the UI, -configuration bound in two places, two types that both claim to be the truth. Duplication that does -not: two similar-looking methods that answer to different owners. - -## 7. Telemetry is not an advanced topic - -Recommend instrumentation from the first commit, at every project size. A small application gets -small telemetry — it does not get none. See `purview-telemetry`. - -## Checks before you answer - -- Did you read the four context dimensions rather than ask for them? -- Can you name, for each project and each abstraction you are proposing, the failure it prevents here? -- Is anything in your proposal there only because a reference architecture has it? -- If there is an API with clients, did you choose its contract strategy from the clients that exist - today? -- Did you include telemetry? - -## See also - -- `purview-telemetry` — instrumentation at every scale -- `purview-persistence` — storage and GUID-key guidance, only when persistence is real -- [Engineering Principles](https://github.com/purview-dev/engineering-playbook/blob/main/docs/wiki/Engineering-Principles.md) -- [Adopting This At Your Scale](https://github.com/purview-dev/engineering-playbook/blob/main/docs/wiki/governance/Adopting-This-At-Your-Scale.md) diff --git a/.agents/skills/purview-architecture/references/contract-strategy.md b/.agents/skills/purview-architecture/references/contract-strategy.md deleted file mode 100644 index 62b5a17..0000000 --- a/.agents/skills/purview-architecture/references/contract-strategy.md +++ /dev/null @@ -1,236 +0,0 @@ -# Contract strategy: Contracts, OpenAPI or Hybrid - -When a solution has an HTTP API and one or more clients, something has to define the shapes that cross -between them. There are three ways to do it, and the wrong one fails in one of two directions: - -- **Rules drift.** The client holds a second, weaker copy of the domain rules, and a request the UI - accepted is rejected by the server — or a break only surfaces at runtime. -- **Decoupling bought in advance.** A .NET client in the same solution regenerates its models from - the API's own OpenAPI document, and throws away every value object and rule to buy an independence - the solution does not have. - -The strategy is chosen from the clients that **exist today**. A planned client is noted; it does not -count. "Later" and "in case" do not justify a strategy any more than they justify a project — see -`proportional-architecture.md`. - -## The three strategies - -### Contracts - -A .NET class library holding the request and response types, built on the domain's value objects and -carrying `[ZodSchema]`. The server references it, and so does every .NET client — including a Blazor -WebAssembly client. - -There is one copy of every rule, error code and normalisation, and both sides run the same generated -validators. - -### OpenAPI - -The server publishes an OpenAPI document, and clients generate their models and calls from it. It is -language-neutral and versions independently. - -Generated models are primitives. Value objects, custom ZodSharp rules, error codes, and trimming and -casing are lost; only what JSON Schema can express survives. - -### Hybrid - -Contracts is the **single source of truth**. The OpenAPI document is **generated from it**, with its -component schemas taken from ZodSharp's export — the generated `{T}Schema.BuildJsonSchema()` is built -from the same metadata as the validator, so the document and the validators cannot drift. - -.NET clients reference Contracts. Non-.NET clients generate from the document and take their -validation rules from the exported JSON Schema — for TypeScript, `z.fromJSONSchema` (Zod 4) reads it -back as Zod schemas. The `purview-zodsharp-json` and `purview-zodsharp-source-generator` skills are -authoritative on the export. - -Three facts about the export that a Hybrid design has to plan for: - -- **ZodSharp ships no OpenAPI integration.** It produces JSON Schema; putting that into the OpenAPI - document — for example with a schema transformer in `Microsoft.AspNetCore.OpenApi` — is the API - host's job. Without it, ASP.NET Core describes a value object from its CLR shape, not from its rules, - and the document and the validators drift after all. -- **A non-.NET client still gets only what JSON Schema can express.** A value object exports as its - underlying value, and a rule the exporter cannot represent is listed under `x-zodsharp-unsupported` - rather than dropped. The contract test should fail when that list grows. -- **Exported objects set `additionalProperties: false`.** A client that validates a *response* against - that schema rejects a field the server has added — so "additive changes only" is not safe until - clients tolerate unknown response fields. Validate requests strictly and responses leniently, or the - versioning rule below protects nobody. (The reverse also holds: System.Text.Json ignores unknown - members, so the server accepts a request with an extra key that the schema rejects.) - -## Decision procedure - -1. **List the clients that exist today.** For each, record: - - its language and runtime; - - who owns it; - - whether it lives in the same repository and solution; - - whether it ships **in lockstep** with the server or on its own cadence. - - A planned client is noted, but it does not count yet. -2. **Every client is .NET, in the same solution, and ships in lockstep → Contracts.** This prevents: - - rules drifting between client and server; - - a second, weaker copy of the domain rules in the UI; - - contract breaks that only surface at runtime. - - Publish OpenAPI anyway if documentation or tooling wants it, but generate it from Contracts. It is - an output, never an input. -3. **At least one client is not .NET, or ships independently → Hybrid.** This prevents: - - non-.NET clients hand-writing shapes and rules; - - the .NET clients losing their value objects and rules to a generated client. - - It requires the independent-versioning rules under [Version skew](#version-skew). -4. **No .NET client exists, or the API is a surface whose clients the team does not own (public or - partner) → OpenAPI**, still generated from the server's types. A separate Contracts project is not - earned when the server is its only consumer. -5. **A .NET client in another repository with its own release cadence** prefers Contracts shipped as - a package, if that team accepts the dependency. Otherwise treat it as step 3. - -```text -flowchart TD - A["List the clients that exist today"] --> C{"Every client .NET,
same solution, lockstep?"} - C -- yes --> K["Contracts
OpenAPI only as an output"] - C -- no --> B{"Any .NET client
at all?"} - B -- no --> O["OpenAPI
generated from the server's types"] - B -- yes --> D{"The only other clients are .NET
in another repository,
and they accept a package?"} - D -- yes --> P["Contracts, shipped as a package"] - D -- no --> H["Hybrid
Contracts is the source, OpenAPI generated from it"] -``` - -Steps 3 and 4 do not overlap: a .NET client in the solution alongside a partner or non-.NET client is -step 3, because the .NET client still has value objects and rules to lose. - -## Rules that follow - -- **Never regenerate a C# client from your own API's OpenAPI document when that client is in the same - solution.** It throws away value objects and rules to buy decoupling the solution does not have. -- **Never hand-maintain a parallel set of models** on either side. Two definitions of one wire shape - disagree eventually, and nothing fails when they start to. -- **The server always validates.** Sharing validators with a client is for user experience and - consistency. It is never a substitute for validating on the server, because the client is untrusted. -- **Moving from Contracts to Hybrid must be additive.** Because Contracts is already the source, adding - a non-.NET client means turning on generation of the OpenAPI document and a contract test. Nothing in - Contracts changes. Design for that, but do not build it until the client exists. - -## Contracts project constraints - -- **References only the domain library (value objects) and the runtime Purview packages** — - `Purview.ValueObjects`, `Purview.ZodSharp`, `Purview.Results`. Never the server, persistence, HTTP - clients or hosting, and never an ASP.NET Core bridge such as `Purview.ZodSharp.AspNetCore`; those - belong to the API host. A Contracts project that references the server is a server that every client - now ships. -- **Browser-safe when a WebAssembly client references it.** No file, network or process I/O, safe to - trim, and no reflection-dependent behaviour. The same applies transitively to the domain library, - because the client downloads it too. Make the build enforce it, not a reviewer — three mechanisms, - each catching what the others cannot: - - **Your repository's architecture policy** forbids `Microsoft.AspNetCore` packages - (`forbiddenPackagePrefixes`) and the `Microsoft.AspNetCore.App` framework reference - (`forbiddenFrameworkReferences`) in `Contracts` and `Core`. The playbook's own policy forbids the - packages in `Core` only; the rest arrives with the Build SDK's planned Blazor support, so add it - yourself until then. See `purview-architecture-testing`. - - **`true`** on both projects turns on the trim and AOT analyzers, - so reflection a trimmed client would break on is a warning at build time. `Purview.ValueObjects` - and `Purview.ZodSharp` already set it. - - **``** makes the platform-compatibility analyzer (`CA1416`) - flag an API that is unsupported in the browser, such as starting a process. - - The policy rules fail a test run. The two analyzers produce warnings, and the SDK does not turn on - `TreatWarningsAsErrors` for an ordinary project — set it on `Contracts` and `Core`, or the "clean - build has no warnings" rule is the only thing standing behind them. No analyzer proves the absence of - every kind of I/O; what they miss is a review obligation, and the client's own tests running in the - browser are the last check. -- **Deserialisation mode is a deliberate choice per direction.** The server reads requests through - `Create` (strict), because the client is untrusted. Record what the client uses for responses, and - why — strict catches a server that has drifted, and `Hydrate` trusts a server the client cannot - verify. - -## Version skew - -| Shipping | Strategy | Failure it prevents | What to do | -| -- | -- | -- | -- | -| Lockstep | Contracts, internal apps | A silent failure that looks like a bug, when an old cached client talks to a new server | The server stamps its build on responses; the client prompts the user to reload when the stamps differ | -| Independent | Hybrid, OpenAPI | A deployed client breaking without warning | Additive changes only; a breaking change gets a new route version; a contract test compares the generated document against the last published one and fails on a breaking difference | - -## Backend-for-Frontend - -A BFF is a host, not a layer, and it is held to the same justification test as anything else. -Microsoft's [Blazor Web App with OIDC and the BFF pattern](https://learn.microsoft.com/aspnet/core/blazor/security/blazor-web-app-with-oidc?pivots=with-bff-pattern) -is the authority on the mechanics; what follows is the rules and the failures behind them. - -### What earns it - -- **Keeping tokens out of the browser.** The BFF signs the user in (OpenID Connect), holds the access - and refresh tokens, and gives the browser only an authentication cookie. Script in the page — a - compromised dependency, an XSS hole — cannot read a token that never reached it. This prevents tokens - being stolen from browser storage. -- **It forwards with the user's access token, never its own identity.** The API validates that token - exactly as it would any other, so authorisation and the audit trail stay per-user. A BFF calling with - a client-credentials token turns every action into the BFF's and moves authorisation into the BFF. - -### In a Blazor solution, the BFF is the host - -The project that serves the WebAssembly client is the natural BFF: it already runs on the server, at -the client's origin. Do not add a separate BFF in front of it. - -- **It references the client project** (`Bff → WebApp`) because it serves the client's assets. The - client never references it; they talk over HTTP with the cookie. -- **Same origin is the point.** The client calls the BFF's own routes, the BFF forwards them to the API - (with YARP's `MapForwarder`, for example), and there is no CORS configuration and no third-party - cookie. -- **The client shares Contracts with the API directly.** The WebAssembly client references Contracts, - sends Contracts types, and runs the generated validators. The BFF in the middle passes the bytes - through untouched. - -### Rules that come with a cookie - -Moving the credential into a cookie trades token theft for a different attack, and the BFF has to -close it: - -- **Every forwarded call requires an anti-forgery signal.** The browser attaches the cookie to any - request to the BFF's origin, including one a hostile page triggers. Require a custom header the - client always sends, which a cross-site form cannot set, and reject calls without it — Duende.BFF's - `X-CSRF: 1` is the established form. `SameSite` narrows the attack; it does not replace the check. - This prevents cross-site request forgery. -- **The cookie is `HttpOnly`, `Secure` and `SameSite=Strict` or `Lax`.** `HttpOnly` is what keeps - script from reading it; without it the BFF protects nothing. -- **Data Protection keys are persisted and shared** when the BFF runs on more than one instance or - survives a restart. The cookie is encrypted with them, so per-instance keys sign users out at random. -- **Refresh happens on the server.** The BFF refreshes the access token before it expires and signs - the user out when refresh fails. The client never sees either token. -- **A large session moves to a server-side store.** Tokens kept inside the cookie make it large enough - to be split across several cookies, and the session cannot be revoked server-side. Use a ticket store - when either matters. - -### What it may reference - -- **A BFF that only forwards does not reference Contracts** and never reads payloads. Reading a payload - it does not own makes it a second consumer that has to change in lockstep for no benefit. -- **Prerendering is the common exception.** If the BFF prerenders client components that load data, - it must run those data calls on the server, and it references Contracts to do so. That is a real - reason; turning prerendering off for those components is the alternative, and the choice should be - written down. -- **A BFF that combines several API calls into one response owns its own contract** for those - responses, chosen with this same procedure. That is a separate justification. The forwarding-only - test — "a service layer that forwards" is not earned — still applies to everything else it does. -- **One BFF per client kind, not one per screen.** Web and mobile may each get one when their sign-in - or response needs differ. - -**None of this is enforced yet.** The architecture policy has no BFF responsibility; Blazor and BFF -support is planned for a future Build SDK release. Until then every rule in this section is a review -obligation, and a repository that adds a BFF project records it in its own policy — see -`project-responsibilities.md`. Even once it is in the policy, "Contracts only when it prerenders or -combines" stays a review obligation, because a dependency matrix cannot express a condition. - -## Worked examples - -| Clients today | Strategy | -| -- | -- | -| Blazor WebAssembly app, same solution, lockstep, signed in through a BFF | Contracts, referenced by the API and the WebAssembly client. The BFF is the host that serves the client, holds the tokens and forwards with the user's token; it references Contracts only if it prerenders data. OpenAPI generated for documentation. | -| Blazor WebAssembly app plus a React Native mobile app on its own release cadence | Hybrid. Mobile generates from the document and takes Zod rules from the exported schema. Additive-only versioning. A mobile BFF if sign-in differs. | -| Partner integrations only | OpenAPI, generated from the server's types. No Contracts project. | - -## See also - -- [Contracts and Data Exchange](https://github.com/purview-dev/engineering-playbook/blob/main/docs/wiki/data/Contracts-And-Data-Exchange.md) - — `Create` and `Hydrate`, and the schema as the source of truth for a wire shape -- [zodsharp](https://github.com/purview-dev/zodsharp) — authoritative on `[ZodSchema]` and JSON Schema - export diff --git a/.agents/skills/purview-architecture/references/project-context-discovery.md b/.agents/skills/purview-architecture/references/project-context-discovery.md deleted file mode 100644 index d40569a..0000000 --- a/.agents/skills/purview-architecture/references/project-context-discovery.md +++ /dev/null @@ -1,115 +0,0 @@ -# Project context discovery - -The procedure for establishing enough context to make an architectural recommendation, and — just as -importantly — for knowing when to stop asking. - -## The principle - -Every question you ask a user is a question they have usually already answered in the repository. -Reading is free and silent; asking is slow and, when the answer was already in a project file, it -reads as not having looked. So the order is fixed: - -1. Read the repository. -2. Read the conversation so far. -3. Ask only about what remains *and* changes your answer. - -A dimension whose answer would not change your recommendation is not worth a question. If a project -is a stateless CLI, the database GUID strategy is not an unknown — it is irrelevant, and raising it -is noise. - -## Dimension 1 — complexity - -Assess from requirements, never from line or project count. - -| Signal | Suggests | -| -- | -- | -| One functional area, one consumer, no integrations | Small | -| A handful of features, one or two integrations, a single team | Medium | -| Several bounded areas, multiple services or teams, operational obligations (SLOs, auditability, money) | Large | - -Where to look: `README.md`, the wiki, issue or ticket references, the solution file's project list, -`PackageReference` entries naming external systems, the number of distinct hosts. - -Traps: - -- **A big repository is not a complex one.** A monorepo of ten tiny tools is ten small projects. -- **A small repository can be complex.** Few files, hard invariants. -- **Generated code inflates everything.** Discount it. - -## Dimension 2 — project type - -Read it; do not ask it. - -| Evidence | Type | -| -- | -- | -| `Microsoft.NET.Sdk.Web` | Web application or HTTP API — distinguish by whether views/pages or endpoints dominate | -| `OutputType` of `Exe` plus an argument parser | CLI | -| `IsPackable`, no entry point | Reusable library | -| `IHostedService` / `BackgroundService`, `Worker` SDK | Background worker | -| An AppHost project, `Aspire.Hosting` | Distributed application | -| WPF/WinForms/Avalonia/MAUI SDK or `UseWPF` | Desktop application | - -A reusable library carries the strongest constraint on the rest of your advice: it must not configure -global telemetry providers, must not read configuration from the ambient environment, and must not -decide a persistence technology for its consumer. - -## Dimension 3 — persistence - -| Question | Read it from | -| -- | -- | -| Is persistence required at all? | Any data-access `PackageReference`, a `DbContext`, a connection string, a repository type, an Aspire resource | -| Which technology? | The EF Core provider package (`Microsoft.EntityFrameworkCore.SqlServer`, `Npgsql.EntityFrameworkCore.PostgreSQL`), the client package, or the `Purview.Containers` resource in the AppHost | -| Is more than one implementation required? | Two providers referenced, a provider abstraction already present, or an explicitly stated requirement | -| EF Core or something else? | Presence of `Microsoft.EntityFrameworkCore` versus Dapper, a raw client, or a document store SDK | - -"No persistence" is a complete and common answer. When it is the answer, every storage-shaped -recommendation — repositories, migrations, GUID strategies, connection resilience — is out of scope. - -## Dimension 4 — telemetry - -| Question | Read it from | -| -- | -- | -| Is telemetry configured? | `ILogger` injection, `ActivitySource`/`Meter` construction, `AddOpenTelemetry`, a `ServiceDefaults` project | -| Is Purview Telemetry available? | A `Purview.Telemetry.SourceGenerator` `PackageReference`, or interfaces attributed `[Logger]`, `[ActivitySource]`, `[Meter]` | -| Which signals are relevant? | Logs always; traces once a call crosses a process or a dependency; metrics once someone would alert on a rate or a duration | -| Is there an exporter? | An OTLP endpoint in configuration, a console exporter, an Aspire dashboard, an APM package | - -Existing instrumentation is a constraint, not a starting point to replace. Preserve it, extend it, -and never register the same source twice. - -## Conditional dimension — identifier generation - -Resolve **only** when persistence exists and GUIDs are, or are about to be, primary keys. - -- Are GUIDs primary keys, or just surface identifiers? -- Is the value generated in the application or by the database? -- Which provider and version? (This changes the answer — see `purview-persistence`.) -- Does index locality matter at the expected write volume? -- Must the identifier exist before the entity is persisted (outbox, correlation, client-side graph)? - -The last question usually decides it: if the application needs the value before `SaveChanges`, the -database cannot be the generator. - -## Asking well - -When you must ask, ask few and ask concretely. Batch the unknowns into one short set, offer the -likely answers, and state what you will do if the user does not care. - -Good: - -> Two things I can't tell from the repository: is this service expected to own its own database, or -> read from the existing one? And should failures be returned to the caller or thrown? I'll assume -> its own database and `Purview.Results` for expected failures unless you say otherwise. - -Bad: - -> What is the project complexity? What is the project type? Is persistence required? Which database? -> Is telemetry configured? Do you use GUID primary keys? - -The second asks six questions, five of which the repository answers, and one of which is irrelevant. - -## Recording the answer - -When a dimension is resolved by conversation rather than by the repository, that is a decision the -next agent will not be able to read. Write it down — in `AGENTS.md`, a wiki page, or an ADR — so the -question is asked once and never again. diff --git a/.agents/skills/purview-architecture/references/project-responsibilities.md b/.agents/skills/purview-architecture/references/project-responsibilities.md deleted file mode 100644 index dc4e67c..0000000 --- a/.agents/skills/purview-architecture/references/project-responsibilities.md +++ /dev/null @@ -1,119 +0,0 @@ -# Project responsibilities, naming and dependency direction - -The catalogue in brief. The authoritative definition is -[`.config/architecture-policy.json`](https://github.com/purview-dev/engineering-playbook/blob/main/.config/architecture-policy.json), -and the full page — with diagrams — is -[Project Responsibilities](https://github.com/purview-dev/engineering-playbook/blob/main/docs/wiki/foundations/Project-Responsibilities.md). -Do not restate either here or in another skill; link to them. - -## The catalogue - -`A → B` means A depends on B **at compile time**. - -| Responsibility | Also known as | Owns | May depend on | -| -- | -- | -- | -- | -| `Core` | `Domain` | Entities, value objects, invariants, domain events and errors | Shared | -| `Abstractions` | — | Cross-boundary capability contracts | Core, Shared | -| `Application` | `UseCases` | Use cases, workflows, orchestration | Core, Abstractions, Contracts, Shared | -| `Contracts` | — | Externally exposed request/response types; browser-safe when a WebAssembly client references it | Core, Shared | -| `Persistence` | — | DbContext, mappings, migration *definitions* | Core, Abstractions, Application, Shared | -| `Providers` | `Integrations` | Integration with a *named external platform* | Core, Abstractions, Application, Shared | -| `Adapters` | — | An *application-defined capability* via one technology | Core, Abstractions, Application, Shared | -| `Composition` | — | DI registration and implementation selection | Everything above | -| `API` | — | HTTP host | Composition, Contracts, ServiceDefaults, … | -| `Worker` | — | Background-processing host | Composition, ServiceDefaults, … | -| `Migrator` | — | *Executes* migrations and controlled seeding | Persistence, Composition, ServiceDefaults | -| `AppHost` | — | Aspire orchestration | The hosts it orchestrates | -| `ServiceDefaults` | — | Telemetry, health, resilience, discovery defaults | Shared | -| `WebApp` | — | Frontend, including a Blazor WebAssembly client that references Contracts | Contracts, ServiceDefaults, Shared | -| `Shared` | — | Small domain-independent primitives | *nothing* | - -**None of these is mandatory.** A small application with `Core` and one host has a complete and -correct architecture. The catalogue names responsibilities so you can tell when splitting one out -buys something — it is not a list of projects to create. - -### Backend-for-Frontend: guidance, not yet policy - -A BFF is a host responsibility that the policy does **not** define yet; Blazor and BFF support is -planned for a future Build SDK release. Until then it is guidance, and every rule below is a review -obligation: - -| Owns | May depend on | Split it out when | Leave it combined when | -| -- | -- | -- | -- | -| Sign-in and token custody for a browser or mobile client; forwards with the user's token. In Blazor, the host that serves the WebAssembly client | The WebAssembly client project, ServiceDefaults, Shared — and Contracts only when it prerenders data or combines responses | Tokens must be kept out of the browser, or several API calls must become one response | It would only forward calls that the client could make with a token it already holds safely | - -A repository that adds a BFF project today needs its own responsibility entry or a waiver in its -policy, or the architecture tests reject the project as unclassified. See `contract-strategy.md`. - -## When to split - -| Responsibility | Split it out when | Leave it combined when | -| -- | -- | -- | -| `Core` | A domain model exists | The app is a thin utility | -| `Abstractions` | Two implementations, or the consumer must not see the implementation | One implementation — keep the interface beside it | -| `Application` | Workflows are reused by more than one host | It would only forward CRUD | -| `Contracts` | The contract strategy is Contracts or Hybrid — see `contract-strategy.md` | The API host is the only consumer, which is the OpenAPI strategy || `Persistence` | Persistence exists at all | A single-project utility writing a file | -| `Providers` | Two platforms with different SDKs or lifecycles | One platform | -| `Adapters` | One capability, several technologies | One capability, one technology | -| `Composition` | Two hosts compose the same implementations | One host — compose in the host | -| `Migrator` | Schema changes are a deliberate deployment step | Development-only startup migration | -| `Shared` | A primitive is used by two or more responsibilities | Almost always | - -## Naming - -```text -[.] -``` - -| Situation | Name | -| -- | -- | -| One implementation | `Persistence` — do **not** qualify it just because it is SQL Server | -| Several, same dependencies and lifecycle | `Persistence` — one project, several classes | -| Several, genuinely different | `Persistence.SqlServer`, `Persistence.PostgreSql` | -| Several, with shared code | Add `Persistence` alongside the qualified projects | -| Several, nothing shared | Qualified projects only — no empty parent | - -Discouraged as project names, because each names a category rather than a responsibility: -`Infrastructure`, `Services`, `Managers`, `Models`, `Helpers`, `Common`, `Utils`, `Utilities`. - -`Infrastructure` is the common case. It is a useful *category* — covering Persistence, Providers and -Adapters — and a poor *project*, because every technical class qualifies for it. - -**Do not rename an established project** merely to match canonical terminology. A rename costs more -than the consistency is worth, and `Domain`/`UseCases`/`Integrations` are recognised aliases. - -## Providers versus Adapters - -Not a vendor distinction: - -- **Provider** — the requirement names the platform: "sync issues from GitHub". Swapping it changes - the product. -- **Adapter** — the requirement names the capability: "send an email". Swapping the technology - changes nothing the user sees. - -Azure Blob behind `IFileStore` is an Adapter. The Azure DevOps work-item API in a product that -integrates Azure DevOps is a Provider. - -## Dependency rules that catch people out - -1. **Composition is referenced by nothing** except a host. It selects implementations, so it depends - on them; the reverse would make the choice circular. -2. **Application never references a concrete infrastructure project.** It depends on an abstraction - and receives an implementation it cannot name. -3. **Sibling implementations stay independent.** If `Providers.GitHub` needs something from - `Providers.AzureDevOps`, that shared thing belongs in the unqualified project or an abstraction. -4. **Persistence owns migration definitions; Migrator executes them.** Production API startup does - not mutate a schema. -5. **Runtime is not compile time.** DI registration, an HTTP call and Aspire orchestration are not - assembly references. A Worker and an API can share Application without referencing each other. - -## Recommending this to a repository that predates it - -Do not propose a mass rename. Suggest, in order: - -1. Fix dependency *directions* that are actually wrong — those are bugs. -2. Split a project only where a named problem justifies it. -3. Record a waiver for an established name rather than renaming it, so the rule stays enforceable - without churn. - -A waiver excuses the name only; the project still classifies, so every dependency rule still applies. diff --git a/.agents/skills/purview-architecture/references/proportional-architecture.md b/.agents/skills/purview-architecture/references/proportional-architecture.md deleted file mode 100644 index 3ed7f55..0000000 --- a/.agents/skills/purview-architecture/references/proportional-architecture.md +++ /dev/null @@ -1,92 +0,0 @@ -# Proportional architecture - -Structure is a cost paid now against a failure expected later. Proportional architecture is the -practice of only paying when the failure is named, present, and more expensive than the structure. - -## The justification test - -Before adding a project, an interface, a layer or a pattern, answer in one sentence: - -> **What failure does this prevent in *this* codebase, and has it happened or is it certain to?** - -If the sentence needs the words "in case", "later", "when we scale", or "it's good practice", the -structure is not yet justified. Write the simpler thing. The simpler thing is also the thing that is -cheapest to change when the failure finally does arrive. - -This is not an argument against structure. It is an argument against *unfalsifiable* structure. - -## By scale - -### Small — a utility, CLI, prototype, simple API, limited-scope application - -- One project. A second only when there is a test project, or when a genuinely reusable library - falls out. -- Call the database, the API or the file system directly from the code that needs it. -- Validate at the edge, once. -- Logging from the first commit; traces and metrics when there is something to correlate. - -Do not add: a repository interface over `DbContext`, a service layer that forwards, a mapping layer -between two near-identical shapes, an interface with one implementation and no test double need -(`Purview.Containers` and TUnit.Mocks remove most of that need), a `Domain`/`Application`/ -`Infrastructure` split. - -### Medium — several functional areas, some integrations, moderate domain complexity - -- Introduce a boundary where you can name what it separates. Usually that is domain rules from the - host, so a domain project and an application host. -- An abstraction over an external dependency earns its place when the dependency is genuinely - swappable, or when testing against it is otherwise painful. "Swappable in principle" is not - swappable. -- Dependency instrumentation, trace propagation across the integrations, metrics on the operations - someone would be paged about. - -Do not add: CQRS unless reads and writes have actually diverged in shape, lifetime or scaling; -event sourcing unless the history *is* the product; a second infrastructure implementation that has -no second consumer. - -### Large — complex domain, multiple services or teams, substantial operational requirements - -- Modularity along ownership lines, because the real constraint is people, not code. -- Independent infrastructure implementations where they are genuinely independent. -- Boundaries made enforceable rather than documented — a dependency-direction rule that a wrong - `ProjectReference` fails the build. See the playbook's Architecture-As-Tests page. -- End-to-end tracing, standardised resource attributes, SLIs, retention and sampling policy. - -Even here, the justification test holds per decision. "Large" licenses the *option* to add -structure, not the obligation to add all of it on day one. - -## Patterns and the conditions that earn them - -| Pattern | Earned when | Not earned by | -| -- | -- | -- | -| Repository over EF Core | You must swap the store, or the `DbContext` API genuinely leaks into domain decisions | Testability — EF Core's in-memory and container-backed testing already covers it | -| CQRS | Read and write models have diverged in shape or scaling needs | A desire for symmetry with a reference architecture | -| Event sourcing | The sequence of changes is the product, or audit is a hard requirement | "We might want history" | -| Mediator / in-process bus | Many handlers, genuinely decoupled registration | Three call sites that could be method calls | -| Mapping layer | Two shapes that must diverge and are owned separately | Two shapes that are identical today | -| Extra DI indirection | A real second implementation, or a composition root that must vary | Inversion for its own sake | -| Generic infrastructure framework | Three or more concrete uses exist now | One use and an expectation of more | - -## Evolving incrementally - -The honest sequence is: write the direct implementation; let the second caller arrive; extract the -boundary the second caller revealed. Each step is small, reversible and informed. - -The dishonest sequence is: predict the second caller; build the boundary; never get the second -caller; maintain the boundary forever. The cost is invisible because it is spread across every -future change. - -When you do extract, extract along the seam the code showed you — not the seam the diagram -predicted. - -## What this does not license - -Proportional is not an excuse for: - -- Skipping tests, or skipping telemetry. -- Leaving validation duplicated across entry points. -- Letting domain rules live in the UI or in the database. -- Two sources of truth for the same fact. - -Those are not structure bought in advance; they are defects. Simplicity means fewer moving parts, -not fewer guarantees. diff --git a/.agents/skills/purview-buildsdk-adoption/SKILL.md b/.agents/skills/purview-buildsdk-adoption/SKILL.md deleted file mode 100644 index b1f222c..0000000 --- a/.agents/skills/purview-buildsdk-adoption/SKILL.md +++ /dev/null @@ -1,114 +0,0 @@ ---- -name: purview-buildsdk-adoption -description: Adopt Purview.BuildSdk in a repository, or troubleshoot an adoption that is not behaving. Use when wiring the SDK into Directory.Build.props for the first time, when a property seems to have no effect, when the resolved version or namespace is wrong, or when a consuming repository builds but the SDK's automatic behaviour is not appearing. Covers the import chain, pre-import property ordering, and version detection from package.json. -license: MIT -metadata: - package: Purview.BuildSdk - repository: purview-dev/build-sdk ---- - -# Adopting Purview.BuildSdk - -The goal is a working adoption that does not break existing build behaviour. Prefer minimal, -targeted property changes over rewriting a repository's `Directory.Build.props`. - -For the full property list use `purview-buildsdk-configuration`; for auditing an existing -repository's shape, `purview-buildsdk-repository-review`. - -## 1. The import chain - -```xml - - - - - Acme.Sales - - - - -``` - -```xml - - - - -``` - -Both halves are required. A repository with only `Sdk.props` imported gets the evaluation-time -defaults — naming, identity, framework selection — but none of the targets, so validation, -packaging behaviour and the generated files never run. That combination usually presents as "the -properties look right but nothing happens". - -The SDK version comes from `global.json`, which the SDK itself bootstraps. - -## 2. Pre-import ordering is the first thing to check - -**A property that must affect `Sdk.props` evaluation has to be set before the import.** Setting it -in a `.csproj`, or below the import, is too late and silently does nothing — no error, no warning. -This is the single most common adoption failure. - -Set before the import: - -- `NamespacePrefix` -- `UsePackageJsonVersion`, `RootPackageJson` -- `EnableAssemblyNameGeneration` -- `AutoIncludeUsings` -- `PurviewSharedTestingOutputType`, `PurviewTestContextNoWarn` -- any repo-wide testing-framework selection you want every project to inherit - -Everything else is read in `Sdk.targets` and can be set in a project file. - -When a property appears to have no effect, confirm what MSBuild actually resolved before changing -anything else: - -```bash -dotnet msbuild -getProperty:NamespacePrefix -getProperty:RootNamespace -``` - -## 3. Version detection - -Versions come from `package.json`. Resolution order: - -1. An explicit `RootPackageJson`. -2. CI workspace variables. -3. The `.git` root. -4. A nearby `package.json`. - -On success both `Version` and `PackageVersion` are set from the `version` field. - -If the version looks wrong, do not guess at the discovery — make it fail loudly instead: - -```xml -Strict -``` - -`Strict` fails the build when discovery or resolution cannot succeed, rather than silently skipping -it and leaving the default `1.0.0`. Set `VersionDetectionLogEnabled=true` to see what it found. - -## 4. Naming and placement - -Most of the SDK's value is inferred from project names and locations, so an adoption that keeps a -bespoke structure gets correspondingly little. Confirm the repository follows the conventions rather -than introducing new structure to work around them — see `purview-buildsdk-project-layout`, and -`purview-buildsdk-repository-review` for auditing an existing layout. - -The highest-value single check: every test project is named `.Tests`. **The dot is -required.** A project named plainly `UnitTests` is not detected as a test project at all, and -silently gets no runner, no coverage, no `InternalsVisibleTo` and no category. - -## 5. Agent skills are a separate, explicit step - -The SDK does not install agent skills, and nothing it does during a build writes to an agent -directory. It reads which skills each referenced package ships and recommends the command that -installs them; the skills CLI does the installing. See `purview-buildsdk-skill-installation`. - -## Constraints - -- Prefer minimal, targeted property changes over broad `Directory.Build.props` rewrites. -- Do not disable `PurviewAutoSdkPack` unless the consumer explicitly asks to opt out. -- Do not restate an SDK default in a project file. Hand-configuration that merely repeats a default - is pure maintenance cost, and it hides the fact that the default later changed. -- Re-run the build — or the repository's canonical build command — after each change, and confirm - the fix before moving to the next one. diff --git a/.agents/skills/purview-buildsdk-configuration/SKILL.md b/.agents/skills/purview-buildsdk-configuration/SKILL.md deleted file mode 100644 index f0ee715..0000000 --- a/.agents/skills/purview-buildsdk-configuration/SKILL.md +++ /dev/null @@ -1,110 +0,0 @@ ---- -name: purview-buildsdk-configuration -description: Configure Purview.BuildSdk from Directory.Build.props or a .csproj. Use when setting NamespacePrefix, choosing a testing or mocking framework, turning telemetry or SourceLink off, controlling version detection from package.json, tuning the repository bootstrap, or working out whether a property must be set before the SDK import. Also use when the SDK "did something automatically" and you need the property that controls it. -license: MIT -metadata: - package: Purview.BuildSdk - repository: purview-dev/build-sdk ---- - -# Purview.BuildSdk configuration - -Use this skill when the question is "what property controls this, and where do I set it?" - -For *why* the SDK classified a project a particular way, use `purview-buildsdk-project-detection` -instead. For where projects and tests should live, use `purview-buildsdk-project-layout`. - -## First rule: know where a property must be set - -A property that changes `Sdk.props` evaluation must be set **before** the SDK import — in -`Directory.Build.props`, above the import. Setting it in a `.csproj` is too late and silently has no -effect. - -Pre-import properties include: - -- `NamespacePrefix` -- `UsePackageJsonVersion`, `RootPackageJson` -- `EnableAssemblyNameGeneration` -- `PurviewSharedTestingOutputType`, `PurviewTestContextNoWarn` -- `AutoIncludeUsings` -- repo-wide testing-framework selection you want every project to inherit - -Everything else is read in `Sdk.targets` and can be set in a project file. Prefer repo-wide defaults -in `Directory.Build.props` unless the setting is deliberately project-specific. - -## The properties you will reach for most - -| Property | Default | What it does | -| -- | -- | -- | -| `NamespacePrefix` | *(required)* | The root identity. Required unless `DisableNamespacePrefixCheck=true` | -| `TestingFramework` | `TUnit` | `TUnit`, `Xunit` or `None` | -| `SubstituteFramework` | `TUnitMocks` | `TUnitMocks`, `NSubstitute` or `None` | -| `TestDataFramework` | `Bogus` | `Bogus` or `None` | -| `TargetFramework` | `net10.0` | `netstandard2.0` when `IsRoslynComponent=true` | -| `IsPackable` | `false` | Opts a project into the packable defaults | -| `UsePackageJsonVersion` | `true` | `true`, `false` or `Strict` — version from `package.json` | -| `ExcludePurviewTelemetry` | `false` | Drops the telemetry source generator | -| `DisableSourceLink` | `false` | Drops SourceLink from packable projects | -| `EnableAssemblyNameGeneration` | `true` | `AssemblyName`/`PackageId` follow the resolved `RootNamespace` | - -The full set, grouped by area and with the behaviour each one changes, is in -[references/properties.md](references/properties.md). Read it rather than guessing a property name — -several of these have near-miss names that do nothing. - -## Derived properties to inspect, not re-derive - -When explaining what the SDK did, read the value it computed rather than reasoning from the folder -name: - -`PurviewLogicalProjectName`, `PurviewNamespacePrefix`, `PurviewProjectShortName`, `PurviewTestType`, -`RootNamespace`, `AssemblyName`, `PackageVersion`, `TestingType`, `TargetProjectName`, `RepoRoot`, -`RootPackageJson`. - -Ask MSBuild for one directly: - -```bash -dotnet msbuild -getProperty:RootNamespace -dotnet msbuild -getProperty:TestingType -getProperty:TargetProjectName -``` - -## Compiler-visible properties - -The SDK exports its properties to analyzers and generators as `build_property.`. When -authoring an analyzer, read the exported property instead of re-deriving SDK behaviour — the export -is the SDK's answer, and it stays correct when the rules change. The exported set is listed in -[references/properties.md](references/properties.md). - -## Version detection - -1. If `RootPackageJson` is set, that file is used. -2. Otherwise the repo root is discovered from CI variables, `.git`, or a nearby `package.json`. -3. On success, both `Version` and `PackageVersion` come from the `version` field. -4. `UsePackageJsonVersion=Strict` turns a failed discovery into a build failure instead of a silent - fallback. - -## Repository bootstrap - -The SDK bootstraps two repository-wide files from the package: `.editorconfig` and `global.json`. - -- `PurviewRepoBootstrapMode` — `IfMissing` (default), `Always`, `WarnOnDrift`, `Never` -- `DisableAutoCopySdkFiles` — the master off switch -- `PurviewRepoBootstrapCopyRetries` / `...RetryDelayMilliseconds` / `...FailureAsError` - -Every project in a solution writes those same destinations, so the write is race-tolerant by -design: an existing file is never overwritten unless asked, each write is staged into a temporary -file and renamed into place, retries are quiet, and only a failure that survives every retry is -reported. - -**The SDK writes nothing into an agent directory.** It used to mirror a package's `.agents/**` into -the repository; that is gone, along with `EnableAgentFolderInPackage`, `AgentPackDestinationFolder` -and the `PurviewAgentFolder*` properties. Skills have exactly one installer, the skills CLI — see -`purview-buildsdk-skill-installation`. - -## Guidance when changing SDK configuration - -1. Preserve existing defaults unless the task explicitly changes product behaviour. -2. Keep `README.md`, the property declaration, its validation and the shipped skills aligned — a - property documented in one place and absent from another is the failure mode this repository - keeps hitting. -3. A new property that affects import-time behaviour must say so in its documentation. -4. Add the property to the `CompilerVisibleProperty` list if an analyzer would benefit from it. diff --git a/.agents/skills/purview-buildsdk-configuration/references/properties.md b/.agents/skills/purview-buildsdk-configuration/references/properties.md deleted file mode 100644 index 93a0d9b..0000000 --- a/.agents/skills/purview-buildsdk-configuration/references/properties.md +++ /dev/null @@ -1,146 +0,0 @@ -# Purview.BuildSdk property reference - -Every user-facing property, grouped by what it changes. Defaults are what the SDK applies when the -consuming project supplies nothing. - -## Identity and naming - -| Property | Default | Behaviour | -| -- | -- | -- | -| `NamespacePrefix` | *(required)* | The root identity source. Required unless the check is disabled. Set before the SDK import | -| `DisableNamespacePrefixCheck` | `false` | Stops the build failing when `NamespacePrefix` is unset | -| `EnableAssemblyNameGeneration` | `true` | `AssemblyName` and the default `PackageId` follow the fully evaluated `RootNamespace`, or the full logical project name when suffix-stripping removed a segment (`Shared`, `ServiceDefaults`). Set `false` before the SDK import for standard project-name behaviour | -| `AssemblyIdentifierClassName` | *(derived)* | Renames the generated marker class | -| `DisableGenerateAssemblyIdentifierClass` | `false` (forced `true` for test and shared-testing projects) | Drops the empty marker class (`Assembly`, global namespace) that architecture tests use to pin an assembly by `typeof` rather than by name | -| `DisableGenerateAssemblyInfoClass` | `false` | Drops the generated `AssemblyInfo` | -| `DisableAutoInternalsVisibleTo` | `false` | Drops automatic friend-assembly generation | -| `DisableProjectFileNamingConventionCheck` | `false` | Stops validating that the `.csproj` filename matches its directory | -| `AutoIncludeUsings` | `true` | Controls the SDK-added global usings. Set before the SDK import | - -## Target framework and language - -| Property | Default | Behaviour | -| -- | -- | -- | -| `TargetFramework` | `net10.0` | Applied when neither `TargetFramework` nor `TargetFrameworks` is set. A project that explicitly declares `IsRoslynComponent=true` defaults to `netstandard2.0` | -| `IsRoslynComponent` | *(unset)* | When explicitly `true`: a single `netstandard2.0` target, `LangVersion=latest`, `Nullable=enable`, `TreatWarningsAsErrors=true`, `Deterministic=true`, extended analyzer rules, SourceLink with `EmbedUntrackedSources=true`, no dependency file, telemetry exclusion, and `PrivateAssets=all` on `Microsoft.CodeAnalysis.*` references | -| `IsRoslynComponentOnly` | `true` for Roslyn components | Analyzer-only package: `IncludeBuildOutput=false`, `IncludeSymbols=false`, portable PDB packed beside the analyzer under `analyzers/dotnet/cs/`. Set `false` for a dual-role component using normal library symbol packaging | -| `DisableRoslynCompilerDefaultsValidation` | `false` | Opts out of `ValidateRoslynComponentCompilerSettings`, which fails the pack of a packable Roslyn component missing `LangVersion`, `Nullable`, `TreatWarningsAsErrors` or `EnforceExtendedAnalyzerRules` | -| `PackProjectReferencedSourceGenerators` | `true` | Packable projects include analyzer `ProjectReference` outputs under `analyzers/dotnet/cs/`. Use `Pack="false"` on one reference to opt that one out | - -## Style policy - -| Property | Default | Behaviour | -| -- | -- | -- | -| `DisablePurviewStylePolicyValidation` | `false` | Stops the build failing (`PRSGD0006`–`PRSGD0009`) when the repository `.editorconfig` overrides the modifier policy — `dotnet_style_require_accessibility_modifiers` other than `omit_if_default`, hiding `IDE0040`/`IDE1006`, disabling the Style category in bulk, weakening the `_camelCase` private-instance-field rule, or adding the accessibility rules to `NoWarn`. Entries the SDK injects itself are ignored | -| `PurviewTestContextNoWarn` | `CA1002;CA1012;CA1034;CA1047;CA1050;CA1051;CA1062;CA1064;CA1515;CA1707` | The production API-surface rules exempted in test and shared-testing projects. Test projects keep the strict style contract (`IDE0040`, field naming, formatting, `IDE1006`) but are context aware: public test classes, `Method_Scenario_Expectation` names, exposed fields and unvalidated helper parameters are allowed. Set before the SDK import | -| `DisablePurviewTestContextRuleSet` | `false` | Makes test and shared-testing projects enforce the production API-surface rules too | -| `PurviewPolicyExemptNoWarn` | *(derived)* | The SDK-injected `NoWarn` entries `ValidatePurviewStylePolicy` accepts | - -## Testing - -| Property | Default | Behaviour | -| -- | -- | -- | -| `TestingFramework` | `TUnit` | `TUnit`, `Xunit`, `None` | -| `SubstituteFramework` | `TUnitMocks` | `TUnitMocks`, `NSubstitute`, `None` | -| `TestDataFramework` | `Bogus` | `Bogus`, `None` | -| `CollectCoverage` | `true` for detected test projects | | -| `EnableStaticNativeInstrumentation` | `false` for test projects | | -| `EnableDynamicNativeInstrumentation` | `false` for test projects | | -| `TestingPlatformDotnetTestSupport`, `UseMicrosoftTestingPlatformRunner`, `EnableMicrosoftTestingPlatform` | enabled for TUnit test projects | Microsoft.Testing.Platform wiring | -| `PurviewSharedTestingOutputType` | `Library` | Forced onto `IsSharedTestingProject` projects, with `IsTestProject`/`IsTestingPlatformApplication` cleared, because the test packages otherwise flip them into an executable test host. Set `Exe` before the SDK import to keep the package-driven shape | - -## Packaging - -| Property | Default | Behaviour | -| -- | -- | -- | -| `IsPackable` | `false` | | -| `PurviewAutoSdkPack` | `true` | Packs `Sdk/**/*` into the package at the right root-level paths | -| `PurviewSkillsSourceFolder` | `/skills` | Where authored skills live | - -Packable-project defaults, applied only when the project supplied nothing: -`GenerateDocumentationFile=true`, `IncludeSymbols=true`, `SymbolPackageFormat=snupkg`, -`PublishRepositoryUrl=true`, `EmbedUntrackedSources=true`, `DebugType=portable`. Portable PDBs ship -in the `.snupkg`; the `.nupkg` gets none unless the project opts in. Roslyn-component-only packages -instead default `IncludeSymbols=false` and ship their PDB inside `analyzers/dotnet/cs/`. - -When the repository root is discoverable, the root `README.md` is packed automatically and -registered as `PackageReadmeFile`, unless one is configured already. - -Non-packable projects, including web apps, default `WarnOnPackingNonPackableProject=false` so a -solution-wide pack skips them silently. - -`ContinuousIntegrationBuild` is set only by real CI environment variables. Packability alone never -forces SourceLink's CI-mode dirty-repository checks. - -## Telemetry and SourceLink - -| Property | Default | Behaviour | -| -- | -- | -- | -| `ExcludePurviewTelemetry` | `false` | Removes `Purview.Telemetry.SourceGenerator` | -| `ExcludeMSTelemetryExtension` | `false` | Removes `Microsoft.Extensions.Telemetry.Abstractions`. Only relevant when `ExcludePurviewTelemetry` is also `false` — the whole group is skipped otherwise | -| `SourceLinkPackageName` | `Microsoft.SourceLink.GitHub` | | -| `DisableSourceLink` | `false` | | - -## Version detection - -| Property | Default | Behaviour | -| -- | -- | -- | -| `UsePackageJsonVersion` | `true` | `true`, `false`, `Strict` | -| `RootPackageJson` | *(discovered)* | Explicit path to the `package.json` to read | -| `EnableVersionDetectionCache` | `true` | | -| `VersionDetectionCacheFile` | *(derived)* | | -| `VersionDetectionLogEnabled` | `false` | Logs the detected version | - -## Repository bootstrap - -| Property | Default | Behaviour | -| -- | -- | -- | -| `DisableAutoCopySdkFiles` | `false` | Master switch for SDK-managed repository file writes | -| `PurviewRepoBootstrapMode` | `IfMissing` | Also `Always`, `WarnOnDrift`, `Never` | -| `BootstrapEditorConfigToRepoRoot` | `true` | | -| `RepositoryEditorConfigFilePath` | *(derived)* | Overrides the destination `.editorconfig` | -| `BootstrapGlobalJsonToRepoRoot` | `true` | | -| `RepositoryGlobalJsonFilePath` | *(derived)* | Overrides the destination `global.json` | -| `PurviewBuildSdkVersionForGlobalJson` | detected SDK version, else `1.0.0` | | -| `PurviewRepoBootstrapCopyRetries` | `3` | | -| `PurviewRepoBootstrapCopyRetryDelayMilliseconds` | `500` | | -| `PurviewRepoBootstrapCopyFailureAsError` | `true` | `false` downgrades a persistent write failure to a warning | -| `PurviewSuppressCopyRetryWarnings` | `true` | Demotes the built-in copy task's `MSB3026` retry notice to a message | -| `PurviewRepositoryRootMarkers` | `.git/;.github/;.gitattributes;LICENSE.md;AGENTS.md;.agents/;CLAUDE.md;.claude/;package.json` | Ordered markers identifying a repository root, most authoritative first | - -There is no agent-folder mirror. `EnableAgentFolderInPackage`, `AgentPackDestinationFolder`, -`PurviewAgentFolderSourcePath`, `PurviewAgentFolderCopy*`, `PurviewAgentSyncManifestPath` and -`DisableMirroredFileTrackingCheck` were removed: skills are installed by the skills CLI, and -nothing else was left for the mirror to deliver. - -## Skills - -Covered in full by `purview-buildsdk-skill-installation`: `PurviewSkillsRunner`, -`PurviewSkillsRunnerCandidates`, `PurviewSkillsCommand`, `PurviewSkillsPackage`, -`PurviewSkillsAgents`, `PurviewSkillsSource`, `PurviewSkillsInstallRoot`, `PurviewSkillsRepoRoot`, -`EnablePurviewSkillRecommendations`, `PurviewSkillRecommendationsInCI`. - -## Compiler-visible properties - -Exported to analyzers and generators as `build_property.`: - -- `UsePackageJsonVersion`, `RootPackageJson`, `RepoRoot`, `Version`, `PackageVersion` -- `NamespacePrefix`, `DisableNamespacePrefixCheck` -- `TestingFramework`, `SubstituteFramework`, `TestDataFramework` -- `ExcludePurviewTelemetry`, `ExcludeMSTelemetryExtension` -- `EnableAssemblyNameGeneration`, `DisableAutoInternalsVisibleTo`, `DisableGenerateAssemblyInfoClass`, - `DisableGenerateAssemblyIdentifierClass`, `AssemblyIdentifierClassName` -- `IsCSharpProject`, `IsTestProject`, `IsSharedTestingProject`, `IsSharedProject` -- `TestingType`, `TargetProjectName` -- `IsContainerProject`, `IsSdkProject`, `SdkProjectName`, `IsWebProject`, `IsWebSdkProject`, - `IsWorkerSdkProject`, `IsAspireHostProject`, `IsCLIProject` -- `EditorConfigFilePath`, `RepositoryEditorConfigFilePath`, `BootstrapEditorConfigToRepoRoot` -- `RepositoryGlobalJsonFilePath`, `BootstrapGlobalJsonToRepoRoot`, `DisableAutoCopySdkFiles` -- `PurviewRepoBootstrapMode`, `PurviewRepoBootstrapCopyRetries`, - `PurviewRepoBootstrapCopyRetryDelayMilliseconds`, `PurviewRepoBootstrapCopyFailureAsError` -- `PurviewSuppressCopyRetryWarnings` -- `PurviewSkillsSourceFolder`, - `PurviewSkillsAgents`, `PurviewSkillsInstallRoot`, `PurviewRepositoryRootMarkers`, - `PurviewSkillsRunner` -- `PurviewBuildSdkVersionForGlobalJson`, `CurrentYear`, `AutoGeneratedAssemblyInfoFile`, - `AutoGeneratedAssemblyIdentifierFile` diff --git a/.agents/skills/purview-buildsdk-project-detection/SKILL.md b/.agents/skills/purview-buildsdk-project-detection/SKILL.md deleted file mode 100644 index 2d0d986..0000000 --- a/.agents/skills/purview-buildsdk-project-detection/SKILL.md +++ /dev/null @@ -1,134 +0,0 @@ ---- -name: purview-buildsdk-project-detection -description: Explain why Purview.BuildSdk classified a project as test, shared, shared-testing, CLI, web, worker, Aspire host, container or Roslyn component, and why it added a package, a project reference, a namespace or an analyzer automatically. Use when SDK behaviour looks surprising, when a test project gets no runner or no InternalsVisibleTo, or when reasoning about RootNamespace, AssemblyName and TargetProjectName. -license: MIT -metadata: - package: Purview.BuildSdk - repository: purview-dev/build-sdk ---- - -# Why Purview.BuildSdk did that - -Use this skill when the question is **why** the SDK applied something automatically. - -For where a project should live, use `purview-buildsdk-project-layout`. For the property that turns -a behaviour off, use `purview-buildsdk-configuration`. - -## Diagnose from computed properties, never from the folder name - -Read what the SDK actually computed: - -```bash -dotnet msbuild -getProperty:PurviewLogicalProjectName -getProperty:RootNamespace \ - -getProperty:TestingType -getProperty:TargetProjectName -getProperty:IsTestProject -``` - -The values worth inspecting first: `MSBuildProjectName`, `NamespacePrefix`, -`PurviewLogicalProjectName`, `RootNamespace`, `TestingType`, `TargetProjectName`, `SdkProjectName`, -`IsTestProject`, `IsSharedProject`, `IsSharedTestingProject`, `IsContainerProject`, `IsCLIProject`, -`IsWebSdkProject`, `IsAspireHostProject`. - -## Detection rules - -### Test projects - -Name matches `^.*\.([\w|_]\w*)Tests?$` — a target name, a dot, then any word before `Test`/`Tests`. -The captured word becomes `TestingType`. - -This is a pattern, **not** a lookup. `MyProject.GoldenTests` is detected exactly as readily as -`MyProject.UnitTests`, with `TestingType=Golden` and `Category=Golden`, even though `Golden` is not a -name the SDK ships. - -**The dot is required.** A project named plainly `UnitTests` does not match, and silently gets no -runner, no coverage, no `InternalsVisibleTo` and no category. This is the single most common -surprise. - -Derived: `IsTestProject=true`, `TestingType=`, `PurviewTestType=Tests`, -`TargetProjectName=`. - -The SDK's explicit `TestType` item group governs **`InternalsVisibleTo` generation**, not detection: -a non-test project grants access to `{AssemblyName}.{TestType}Tests` for each name in the group. A -suffix outside it still builds, runs and gets a category — it just cannot see `internal` members. -The 53 names are in [references/test-types.md](references/test-types.md). - -### Shared and shared-testing projects - -Recognised by **exact name**, never by substring. The two lists are in -[references/detection.md](references/detection.md). Derived: `IsSharedProject`, -`IsSharedTestingProject`. - -### SDK and content based - -| Signal | Result | -| -- | -- | -| the project's `Sdk="..."` declaration | `IsSdkProject`, `SdkProjectName` | -| `Microsoft.NET.Sdk.Web` | `IsWebSdkProject=true` | -| `Microsoft.NET.Sdk.Worker` | `IsWorkerSdkProject=true` | -| SDK starts with `Aspire.Sdk.Host` or `Aspire.AppHost.Sdk` | `IsAspireHostProject=true` | -| `Dockerfile`, `dockerfile` or `Dockerfile.dev` in the project directory | `IsContainerProject=true` | -| name ends with `CLI`, `Console`, `CommandLine`, `QuickStart`, `QuickStarts` | `IsCLIProject=true` | - -## Namespace and identity - -1. `PurviewLogicalProjectName` is `NamespacePrefix` plus the project name, de-duplicated when the - project name already starts with the prefix's tail. -2. `RootNamespace` defaults to `PurviewLogicalProjectName`. -3. Known suffixes are stripped from `RootNamespace` — shared and shared-testing names, and segments - such as `Core`, `EF`, `Shared`, `ClientShared`, `ServiceDefaults`. -4. Test suffixes are stripped too, so `Acme.Api.UnitTests` maps back to `Acme.Api`. -5. `AssemblyName` and `PackageId` default to the fully evaluated `RootNamespace` — except where - stripping removed a segment, where they use the full `PurviewLogicalProjectName` so the artifact - stays distinct from its parent. Test and shared-testing projects keep their detected suffix. - Explicit `AssemblyName`/`PackageId`/`RootNamespace` always win. -6. The naming defaults are applied during `Sdk.props`, before the Microsoft SDK computes - `TargetName`, so the compiled output name always matches `AssemblyName`. - -## Automatic packages and references - -- **Non-test C# projects**: SourceLink (unless `DisableSourceLink`), the Purview telemetry packages - (unless `ExcludePurviewTelemetry`), `GenerateDocumentationFile=true`, and `InternalsVisibleTo` - generation (unless `DisableAutoInternalsVisibleTo`). -- **Test and shared-testing projects**: test-friendly `NoWarn` defaults, not packable or - publishable, and the packages selected by `TestingFramework`, `SubstituteFramework` and - `TestDataFramework`. TUnit test projects get Microsoft.Testing.Platform wiring automatically. - Shared-testing projects skip the runnable test package. -- **Packable projects**, **Roslyn components** and **special project types** (CLI, container, web, - Aspire host): see [references/detection.md](references/detection.md). - -Project-reference probing is layout-driven and covered by `purview-buildsdk-project-layout`. - -## The shipped analyzers - -The SDK adds `Purview.BuildSdk.Analyzers` as an `` item to every C# project, so its rules -surface in command-line builds and in Visual Studio. The code-fix assembly ships beside it. - -| Rule | What it enforces | -| -- | -- | -| `PDS0002` | Extensions classes live under `Extensions//` | -| `PDS0003` | Explicit types with target-typed `new()` | -| `PDS0004` | Correct acronym capitalisation | - -`PDS0004` follows .NET naming guidance: well-known framework spellings (`Sql`, `Guid`, `Uuid`, -`Url`, `Dns`, `Tcp`, `Http`, `Xml`, `Db`, …) are exempt — `Db` among them, so `DbContext`, -`DbConnection` and `DbSet` are never flagged. A small set is still uppercased: `Api`, `Ai`, `Ui`, -`Io`, `Os`, `Cpu`, `Gpu`, `Cli`, `Gui`, `Ram`, `Ssh`. Members mandated by a contract — interface -implementations and base-class overrides — are never renamed. - -Customise through `dotnet_analyzer_configuration.pds0004.allowed_words` (exempt segments), -`.acronym_map` (segment renames, e.g. `Sql:SQL`, or `Db:DB` to re-enable it) and -`.allowed_identifiers` (brand names, exact or word-boundary prefix, first match wins — `CosmosDb` -covers `CosmosDbServer`). All three merge with and override the shipped defaults. - -The shipped `.editorconfig` marks generated content (`Migrations/`, `*.g.cs`, `Generated/`, -`*.Designer.cs`, `obj/`, `bin/`) as `generated_code = true`, and suppresses namespace-conflict -diagnostics under `Extensions/`, so no `#pragma` suppressions are needed there. - -Two Visual Studio refactorings ship with them, both described in -[references/detection.md](references/detection.md). - -## When changing a detection rule - -1. Keep the `.csproj` filename equal to its directory name. -2. Update `README.md` and the shipped skills in the same change — a rule true in code and false in - prose is this repository's recurring failure. -3. Add or update the integration test in `src/tests/BuildSdk.IntegrationTests/` that pins it. diff --git a/.agents/skills/purview-buildsdk-project-detection/references/detection.md b/.agents/skills/purview-buildsdk-project-detection/references/detection.md deleted file mode 100644 index bf75823..0000000 --- a/.agents/skills/purview-buildsdk-project-detection/references/detection.md +++ /dev/null @@ -1,79 +0,0 @@ -# Detection detail - -## Shared project names (exact) - -`Shared`, `SharedFramework`, `SharedInfrastructure`, `SharedInfra`, `SharedUtilities`, -`SharedUtils`, `SharedLibrary`, `SharedLib`, `SharedHelpers` - -## Shared testing project names (exact) - -`SharedTestingFramework`, `SharedTestingInfrastructure`, `SharedTestingInfra`, -`SharedTestingUtilities`, `SharedTestingUtils`, `SharedTestingLibrary`, `SharedTestingLib`, -`SharedTestingHelpers` - -These are matched whole, not as substrings. `SharedModels` is not a shared project. - -A shared-testing project is forced to `PurviewSharedTestingOutputType` (default `Library`), with -`IsTestProject` and `IsTestingPlatformApplication` cleared, because the test packages otherwise flip -it into an executable test host. Set `PurviewSharedTestingOutputType=Exe` before the SDK import to -keep that package-driven shape. - -## Packable projects - -Defaults applied only where the project supplied nothing: `GenerateDocumentationFile`, -`IncludeSymbols`, `SymbolPackageFormat=snupkg`, `PublishRepositoryUrl`, `EmbedUntrackedSources`, -`IncludeSource`, `DebugType=portable`. - -- Portable PDBs ship in the `.snupkg`. The `.nupkg` receives none unless the project opts in. -- The repository-root `README.md` is packed and registered as `PackageReadmeFile` when it exists and - nothing else is already being packed as one. -- Non-packable projects, web apps included, default `WarnOnPackingNonPackableProject=false`, so a - solution-wide `dotnet pack` skips them silently. -- `ContinuousIntegrationBuild` is set only by real CI environment variables. Packability alone never - forces SourceLink's CI-mode dirty-repository checks. - -## Roslyn components - -A project that explicitly declares `IsRoslynComponent=true` gets: - -- a single `netstandard2.0` target, `LangVersion=latest`, `Nullable=enable`, - `TreatWarningsAsErrors=true`, `Deterministic=true`, extended analyzer rules -- SourceLink with `EmbedUntrackedSources=true`, no dependency file, telemetry excluded -- compiler-generated output under the framework-specific intermediate directory -- `PrivateAssets=all` on `Microsoft.CodeAnalysis.*` and `Microsoft.CodeAnalysis.Analyzers`, so they - never leak into the packed nuspec - -`IsRoslynComponentOnly` defaults to `true`: `IncludeBuildOutput=false`, `IncludeSymbols=false`, no -`.symbols.nupkg` or `.snupkg`, and the analyzer PDB shipped inside the main `.nupkg` under -`analyzers/dotnet/cs/` beside the assembly (`PurviewPackAnalyzerPdb=true`). Set it to `false` for a -dual-role component that wants normal library symbol packaging. - -`ValidateRoslynComponentCompilerSettings` fails the pack of a packable Roslyn component missing -`LangVersion`, `Nullable`, `TreatWarningsAsErrors` or `EnforceExtendedAnalyzerRules`. Opt out with -`DisableRoslynCompilerDefaultsValidation=true`. - -`PackProjectReferencedSourceGenerators` (default `true`) makes a packable project include analyzer -`ProjectReference` outputs and their runtime dependencies under `analyzers/dotnet/cs/`. Set it -`false` globally, or `Pack="false"` on one analyzer reference. - -## Special project types - -| Type | Applied | -| -- | -- | -| CLI | `OutputType=Exe`, `appsettings*.json` included as content | -| Container | `InvariantGlobalization`, `PublishAot`, Linux Docker defaults, container tooling packages | -| Web SDK | `Microsoft.AspNetCore.OpenApi.Generated` added to `InterceptorsNamespaces`, unless marked as a separate web-project mode | -| Aspire host | `OutputType=Exe` | - -## The Visual Studio refactorings - -Two ship with the code-fix assembly, both serving the `PDS0002` convention: - -- **Split extensions class into one class per receiver type** — offered on a static extensions class - targeting several receiver types. It produces one `Extensions` class per receiver - (a generic `this TBuilder where TBuilder : IHostApplicationBuilder` receiver becomes - `HostApplicationBuilderExtensions`) and places each under `Extensions//`. -- **Move extensions class to conventional location** — offered on a misplaced single-receiver - extensions class. It re-paths the file to `Extensions//`, fixes the namespace - to the receiver's, and updates `using` directives in other referencing documents so the move - compiles. diff --git a/.agents/skills/purview-buildsdk-project-detection/references/test-types.md b/.agents/skills/purview-buildsdk-project-detection/references/test-types.md deleted file mode 100644 index dace44f..0000000 --- a/.agents/skills/purview-buildsdk-project-detection/references/test-types.md +++ /dev/null @@ -1,35 +0,0 @@ -# The shipped `TestType` group - -These 53 names drive **`InternalsVisibleTo` generation**, not test detection. A non-test project -grants friend access to `{AssemblyName}.{TestType}Tests` for each name here. - -Detection is the pattern `^.*\.([\w|_]\w*)Tests?$`, so a suffix outside this group is still detected, -still runs and still gets its category — it simply cannot reach the target project's `internal` -members. Prefer a name from this group unless the test type genuinely needs its own word. - -```text -Unit Integration E2E EndToEnd Acceptance -Functional Performance Load Smoke Stress -Regression Security Chaos Scenario System -Threat BlackBox WhiteBox GrayBox GreyBox -Accessibility Usability Visual Interactive Localization -Globalization Environment Configuration Deployment Architecture -Contract Component Sanity Property Fuzz -Mutation Snapshot Approval Benchmark Capacity -Concurrency Endurance Soak Spike Failover -Recovery Resilience Compatibility Interoperability Migration -Upgrade Penetration Compliance -``` - -## The five to reach for first - -`Unit`, `Integration`, `E2E`, `Functional`, `Contract`. Everything else is available, but a reader -has to ask what it means — use one only when the test type itself carries operational weight. - -## What a suffix buys you - -| | detected as a test project | gets a category | gets a runner and coverage | sees `internal` members | -| -- | -- | -- | -- | -- | -| `Api.UnitTests` | yes | `Unit` | yes | yes | -| `Api.GoldenTests` | yes | `Golden` | yes | **no** | -| `UnitTests` *(no dot)* | **no** | no | **no** | no | diff --git a/.agents/skills/purview-buildsdk-project-layout/SKILL.md b/.agents/skills/purview-buildsdk-project-layout/SKILL.md deleted file mode 100644 index 55a019c..0000000 --- a/.agents/skills/purview-buildsdk-project-layout/SKILL.md +++ /dev/null @@ -1,136 +0,0 @@ ---- -name: purview-buildsdk-project-layout -description: Decide where a project goes and what to call it in a repository that uses Purview.BuildSdk. Use when creating, moving, splitting or renaming a project or test project, choosing a test suffix, aligning namespaces and assembly identity with NamespacePrefix, or relying on the SDK's automatic project references. Also use when rationalising a repository's shape so the SDK's conventions work without overrides. -license: MIT -metadata: - package: Purview.BuildSdk - repository: purview-dev/build-sdk ---- - -# Project layout and naming for Purview.BuildSdk - -Use this skill when physically adding, moving, splitting or renaming a project. - -For *why* the SDK classified an existing project a particular way, use -`purview-buildsdk-project-detection`. For the property that changes a behaviour, use -`purview-buildsdk-configuration`. - -## First principle - -**Treat naming and placement as configuration, not decoration.** - -The SDK infers namespaces, assembly identity, test categories, package wiring and project references -from a small set of conventions. The closer a repository sits to them, the fewer overrides it needs. - -The corollary matters just as much: **preserve the host repository's existing layout first.** Only -introduce new structure when no established pattern exists. - -## Canonical layout - -```text -/ - package.json version source - .editorconfig bootstrapped by the SDK - skills/ authored agent skills, if any - src/ - .slnx - src//.csproj - tests/.Tests/.Tests.csproj -``` - -- The `.csproj` filename must equal its containing directory name, unless - `DisableProjectFileNamingConventionCheck=true`. -- Source projects under `src/`, test projects under `tests/`. -- Place a new project beside similar ones — same language, layer and test type. -- One test type per project by default. - -A repository that already uses a different shape keeps it; add to it rather than converting it. - -## Naming and identity - -`NamespacePrefix` is the root identity source. Keep project names short and let the SDK apply the -prefix: - -| `NamespacePrefix` | Project | `RootNamespace` | -| -- | -- | -- | -| `Aspire` | `Hosting` | `Aspire.Hosting` | -| `Acme.Sales.RegionalPipeline` | `Identity.API` | `Acme.Sales.RegionalPipeline.Identity.API` | -| `Acme.Sales.RegionalPipeline` | `Identity.Core` | `Acme.Sales.RegionalPipeline.Identity` | - -`AssemblyName` and `PackageId` follow the resolved `RootNamespace` — except where suffix-stripping -removed a segment (`Core`, `Shared`, `ServiceDefaults`), in which case they keep the fuller logical -name so the artifacts stay distinct from their parent. Explicit values always win, and -`EnableAssemblyNameGeneration=false` (before the SDK import) restores standard behaviour. - -Do not hand-author an alternate namespace scheme when one is already in use. - -## Test project naming - -Test detection is a **pattern**, not a list: `^.*\.([\w|_]\w*)Tests?$`. A target name, a dot, then -any word before `Test` or `Tests`. The captured word becomes `TestingType` and the baseline category. - -**The dot is required.** A project named plainly `UnitTests`, with no target in front of it, is not -detected as a test project at all — no runner, no coverage, no `InternalsVisibleTo`, no category. -Always name a test project `.Tests`. - -Prefer these by default: `UnitTests`, `IntegrationTests`, `E2ETests`, `FunctionalTests`, -`ContractTests`. Use another suffix only when the test type itself carries operational meaning. - -A suffix outside the SDK's shipped `TestType` group still builds, runs and gets its category — it -just cannot reach the target project's `internal` members, because that group drives -`InternalsVisibleTo` generation. The full list is in `purview-buildsdk-project-detection`. - -## Shared projects: exact names only - -The SDK recognises these names exactly — a near miss gets none of the behaviour. - -Shared: `Shared`, `SharedFramework`, `SharedInfrastructure`, `SharedInfra`, `SharedUtilities`, -`SharedUtils`, `SharedLibrary`, `SharedLib`, `SharedHelpers`. - -Shared testing: `SharedTestingFramework`, `SharedTestingInfrastructure`, `SharedTestingInfra`, -`SharedTestingUtilities`, `SharedTestingUtils`, `SharedTestingLibrary`, `SharedTestingLib`, -`SharedTestingHelpers`. - -## Automatic project references to preserve - -Layout is what makes these work. Move a project off the convention and you own the reference. - -Test projects probe for their target, in order: - -- `../$(TargetProjectName)/$(TargetProjectName).csproj` -- `../../$(TargetProjectName)/$(TargetProjectName).csproj` -- `../src/$(TargetProjectName)/$(TargetProjectName).csproj` -- `../../src/$(TargetProjectName)/$(TargetProjectName).csproj` - -Non-test projects pick up sibling shared projects via `../Shared*/Shared*.csproj`; test projects -pick up `../SharedTesting*/SharedTesting*.csproj`. - -## Creating a new project - -1. Match the SDK and style of sibling projects. -2. Use Central Package Management if the repository has it. -3. Add only the dependencies the project's scope needs — the SDK supplies the testing stack, - SourceLink and telemetry by default. -4. Add the project to the solution. -5. Keep target frameworks, nullability, analyzers and warning settings consistent with neighbours. - -## Moving or splitting - -1. Create the destination using the established layout. -2. Move the files. -3. Update namespaces, usings and references for the destination. -4. Verify the destination still produces the intended `TestingType`, `TargetProjectName` and - `RootNamespace` — ask MSBuild rather than assuming: - `dotnet msbuild -getProperty:RootNamespace -getProperty:TargetProjectName`. -5. Remove dependencies the source no longer needs. -6. Update solution membership and project references. -7. Build, then run the affected tests. - -## Guardrails - -- Prefer minimal, targeted diffs; avoid cross-cutting renames unrelated to the move. -- Keep test intent unchanged while relocating. -- When the structure is ambiguous, infer from the nearest sibling projects and say which assumption - you made. -- When in doubt, preserve compatibility with the SDK's automatic naming, namespace and - project-reference behaviour. diff --git a/.agents/skills/purview-buildsdk-repository-review/SKILL.md b/.agents/skills/purview-buildsdk-repository-review/SKILL.md deleted file mode 100644 index ce1fd29..0000000 --- a/.agents/skills/purview-buildsdk-repository-review/SKILL.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -name: purview-buildsdk-repository-review -description: Review a repository that uses Purview.BuildSdk for naming, placement and test-structure alignment, and report what the SDK can and cannot do automatically as a result. Use when asked to audit, rationalise or health-check a repo against the SDK's conventions, when onboarding an existing codebase onto Purview.BuildSdk, or when deciding whether a layout quirk is worth changing. -license: MIT -metadata: - package: Purview.BuildSdk - repository: purview-dev/build-sdk ---- - -# Reviewing a repository against the SDK's conventions - -This is an audit, not a refactor. The deliverable is a prioritised list of findings and the cost of -each, so somebody else can decide what to change. - -For the conventions themselves use `purview-buildsdk-project-layout`; for why one project was -classified as it was, `purview-buildsdk-project-detection`. - -## The governing judgement - -**Deviation is only a finding when it costs the repository something.** The SDK infers behaviour -from naming and placement, so a deviation is interesting precisely to the extent that it turns an -automatic behaviour off. A layout that differs from the canonical one but still gets every automatic -behaviour is not debt, and reporting it as such wastes the reader's attention. - -Sort every finding into one of three buckets, and say which: - -| Bucket | Meaning | -| -- | -- | -| **Acceptable variance** | Differs from the canonical layout, costs nothing. Preserve it. | -| **Structural debt** | Blocks an automatic behaviour the repository would benefit from. | -| **Incremental opportunity** | Low-risk tidying worth doing when the area is touched anyway. | - -## 1. Read before concluding - -Inspect, in this order, before forming any opinion: - -- `Directory.Build.props` and `Directory.Build.targets` — where the SDK is imported, and what is set - before the import -- the solution entry point, for what is actually in the build -- `Directory.Packages.props`, for Central Package Management -- the project layout on disk - -## 2. Check the structural signals - -- Source projects under `src/`, test projects under `tests/`. -- `.csproj` filename equals its containing directory name — unless - `DisableProjectFileNamingConventionCheck=true`, which is itself a finding worth surfacing. -- Short project names, with `NamespacePrefix` carrying the repository identity. -- Test project names match `^.*\.([\w|_]\w*)Tests?$`. **The dot is required**; a project named - plainly `UnitTests` is not detected at all and silently gets no runner, no coverage, no - `InternalsVisibleTo` and no category. This is the single highest-value thing to check. -- Test suffixes come from the SDK's shipped `TestType` group where `internal` access is wanted — a - suffix outside it still runs, it just cannot see `internal` members. -- Shared and shared-testing projects use the **exact** recognised names. A near miss gets none of - the behaviour. - -## 3. Verify with MSBuild, do not infer from folder names - -A review that reasons from directory names will be wrong about at least one project. Ask: - -```bash -dotnet msbuild -getProperty:RootNamespace -getProperty:AssemblyName \ - -getProperty:IsTestProject -getProperty:TestingType -getProperty:TargetProjectName -``` - -Quote the computed values in the findings. "`Api.Tests` resolves `TestingType=` empty, so it has no -runner" is actionable; "`Api.Tests` looks like it might not be detected" is not. - -## 4. Review test readability - -- Subject-based suites: `{SubjectName}Tests`, with - `{SubjectOrMemberUnderTest}_{Scenario}_{Expectation}` methods. -- Non-subject-based suites — build, generator, workflow, package, full-system — named clearly for - their broader role. A forced `{Subject}Tests` on one of these is worse, not better. -- TUnit categories and display names used where a suite is large enough to need navigating. - -See `purview-buildsdk-testing`. - -## 5. Check the test dependencies are earned - -The SDK already supplies `TUnit`, `TUnit.Mocks`, `Bogus` and the Microsoft.Testing.Platform wiring -to every detected test project. Anything beyond that was a deliberate choice, and deliberate choices -go stale: - -- `TUnit.Aspire` and `Purview.Containers` are **not** universal defaults. Confirm each reference is - genuinely needed by that project rather than copied from a sibling. -- Where a project references `Testcontainers` directly, check whether a `Purview.Containers` typed - module now covers it — the module set grows, and a direct reference that was once necessary often - is not any more. -- A package the SDK already adds, restated in a project file, is maintenance cost with no effect. - -## 6. Explain consequences, not just mismatches - -For each finding, name the specific automatic behaviour that is lost: `RootNamespace`, -`AssemblyName`, `PackageId`, `TargetProjectName`, the automatic target-project reference, the -sibling `Shared*` reference, `InternalsVisibleTo` generation, the test runner and coverage wiring. - -"Project is not under `src/`" is not a finding. "Project is not under `src/`, so the test project's -four probe paths all miss and the `ProjectReference` has to be maintained by hand" is. - -## Reporting the result - -1. One sentence on whether the repository broadly fits the SDK's conventions. -2. The findings, ordered by impact, each with its bucket and the behaviour it costs. -3. The low-risk rationalisation steps, as concrete renames or moves. -4. An explicit split of what is **already automatic** versus what this repository has configured by - hand — that list is usually the most useful part of the review, because hand-configuration that - merely restates a default is pure maintenance cost. - -Do not propose a cross-cutting rename as a first step. Name the one change with the best -cost-to-benefit ratio and say what it unlocks. diff --git a/.agents/skills/purview-buildsdk-skill-installation/SKILL.md b/.agents/skills/purview-buildsdk-skill-installation/SKILL.md deleted file mode 100644 index 66c20a3..0000000 --- a/.agents/skills/purview-buildsdk-skill-installation/SKILL.md +++ /dev/null @@ -1,166 +0,0 @@ ---- -name: purview-buildsdk-skill-installation -description: Install, list and diagnose the agent skills a Purview.BuildSdk package ships. Use for the InstallPurviewSkills, ListPurviewSkills and RecommendPurviewSkills MSBuild targets, for any PRSKL0001-PRSKL0014 diagnostic, for choosing a package runner (npx, pnpm dlx, bunx, yarn dlx, deno), for skills-lock.json, or when a package ships skills but no agent can see them. -license: MIT -metadata: - package: Purview.BuildSdk - repository: purview-dev/build-sdk ---- - -# Installing the skills a package ships - -For *authoring* skills, use `purview-buildsdk-skill-tests`. - -## The one thing to understand first - -**The SDK writes nothing into an agent directory.** A package *ships* `.agents/skills//`, but -as metadata — it is what tells the SDK which skills the package offers and at which commit. Nothing -copies it out. - -Skills are installed by the skills CLI and by nothing else. That is a deliberate single-writer rule. -Earlier versions of this SDK mirrored a package's whole `.agents/**` folder into the consuming -repository, and the CLI's own universal install location is `.agents/skills/` — the same paths. The -mirror would silently overwrite a pinned install on the next build, while `PRSKL0011` compared a -lockfile ref against content the mirror had already replaced. The mirror was removed outright rather -than fenced off, because the CLI covers the whole job. - -Installing is therefore a separate, deliberately **explicit** step. It is never a side effect of a -restore, a build, a design-time build or a test run. - -```bash -dotnet msbuild -t:ListPurviewSkills # diagnostics only, installs nothing -dotnet msbuild -t:InstallPurviewSkills # delegates to the skills CLI -``` - -Neither target has `BeforeTargets` or `AfterTargets`. If skills are appearing or changing on their -own, something has been wired up that should not be. - -## How a skill is resolved, and why the version is always right - -There is deliberately **no custom manifest**. A package that ships skills already carries both -halves of the mapping, and `ResolvePurviewSkillSources` reads them: - -- `.agents/skills//` in the restored package says *which* skills it ships. -- The nuspec's ``, written by SourceLink for every package this - SDK builds, says which git repository and which **exact commit** produced them. - -So the resolved ref is the commit the *restored package version* was built from. An older -`PackageReference` gets that version's skills, not whatever is on the default branch. Compatibility -is exact by construction rather than by convention. - -## Installing from an explicit source - -For a skill you want but have no `PackageReference` for: - -```bash -dotnet msbuild -t:InstallPurviewSkills -p:PurviewSkillsSource=purview-dev/build-sdk -``` - -The caller owns the ref here — append `#` to pin it. This path needs no restore, so -`PRSKL0001` does not apply. - -## Diagnostics - -| Code | Meaning | Fix | -| -- | -- | -- | -| `PRSKL0001` | `project.assets.json` is missing | Restore. Resolution reads the restore graph and deliberately does not trigger a restore of its own | -| `PRSKL0002` | The package's nuspec has no GitHub repository URL, or no commit | The package cannot be pinned. It is reported rather than installed from a guessed branch | -| `PRSKL0003` | No repository root resolved | Pass `-p:PurviewSkillsInstallRoot=` | -| `PRSKL0004` | No skills CLI and no package runner found | Install Node, or set `PurviewSkillsCommand` | -| `PRSKL0005` | An authored skill is malformed | See `purview-buildsdk-skill-tests` | -| `PRSKL0010` | A skill a referenced package ships is missing | Warning. `npx skills add ...` | -| `PRSKL0011` | An installed skill is pinned to a different ref than the referenced package | Warning. Install the package's own commit | -| `PRSKL0012` | A skill cannot be verified | Message | -| `PRSKL0013` | An orphaned lockfile entry | Message | -| `PRSKL0014` | Recorded in the lockfile but never restored | Message | - -## Recommendations run during an ordinary build - -This is the **one** skill feature that does. `RecommendPurviewSkillsOnBuild` runs after `Build` and -delegates to `RecommendPurviewSkills`, which can also be invoked by name: - -```bash -dotnet msbuild -t:RecommendPurviewSkills -``` - -`EvaluatePurviewSkillState` joins the skills each restored package ships against the CLI's own -`skills-lock.json`. Both inputs are local files, so it stays offline and spawns no process. - -Four things keep it quiet, and all of them are load-bearing: - -- Design-time builds, CI builds, non-default TFM passes and - `EnablePurviewSkillRecommendations=false` are skipped outright. - `PurviewSkillRecommendationsInCI=true` re-enables CI. -- A fingerprint stamp at `/.purview/skill-recommendations.cache` means a given state is - reported once per repository, not once per project and again on every rebuild. The explicit target - ignores the stamp. -- Missing and drifted are **warnings** (fixable in one command); unverifiable and orphaned are - **messages**. No amount of skill advice can break a build using `TreatWarningsAsErrors`. -- A correctly installed set produces no output at all. - -Orphan detection is **owner-scoped on purpose**: a lockfile cannot record who asked for an entry, so -only an entry under an owner the project references — but from a repository it no longer references -— is reported. A skill from any other owner is the developer's own, and is never mentioned. - -### Drift never recommends `npx skills update` - -`update` installs the *newest* published skill, which is only correct when the newest skill happens -to describe the referenced package version. `PRSKL0011` names the referenced package's own commit in -a pinned `npx skills add` instead. - -## Package runners - -The CLI is published to npm, and every runner spells "run this npm package" differently. -`PurviewSkillsRunner` selects one, defaulting to `npx` because npx ships with Node itself. - -| Runner | Invocation | -| -- | -- | -| `npx` | `npx -y skills@1` | -| `bunx` | `bunx skills@1` | -| `bun` | `bun x skills@1` | -| `pnpm` | `pnpm dlx skills@1` | -| `yarn` | `yarn dlx skills@1` — Yarn 2+ only | -| `deno` | `deno run -A npm:skills@1` | - -An unknown runner falls through to ` $(PurviewSkillsPackage)`, so it still works. - -`DetectPurviewSkillsCli` probes `PATH` for `skills` first, then `$(PurviewSkillsRunner)`, then -`$(PurviewSkillsRunnerCandidates)`, honouring `PATHEXT` on Windows where these are `.cmd` shims. -`PATH` is read directly rather than by spawning a version check: deterministic, no process, and it -cannot hang on a cold download. **The runner actually found wins over the configured preference.** -`PurviewSkillsCommand` overrides the launcher entirely and skips detection. - -`ListPurviewSkills` reports runner availability but **never** errors on its absence — resolving and -reporting needs no Node tooling at all. - -## Always the repository root - -`skills-lock.json` and the agent directories belong to the repository, not to a project, so every -skill target runs from one resolved root: - -1. `PurviewSkillsInstallRoot` — an explicit override -2. `PurviewSkillsRepoRoot` — only when the **user** set it -3. the `PurviewRepositoryRootMarkers` walk -4. `PurviewSkillsRepoRoot` / `RepoRoot` as the SDK guessed them -5. CI workspace variables -6. SourceLink's git `SourceRoot` - -There is deliberately **no project-directory fallback**. That would scatter a lockfile and an agent -directory through the tree, one per project. An unresolved root is `PRSKL0003` on install, and -silence for recommendations — a build never fails over advice. - -The marker walk is described in [references/repository-root.md](references/repository-root.md); its -two-pass behaviour and its home-directory bound are both load-bearing. - -## Why the CLI rather than a reimplementation - -The CLI owns the agent-specific destinations and their discovery conventions, which differ per agent -and change independently of this SDK. It also owns `skills-lock.json`, so a repository can restore -the same set later with `npx skills experimental_install`. - -`PurviewSkillsAgents` (default `*`) narrows the target agents. - -The lockfile is read **directly** rather than by parsing `npx skills list --json`, because that -listing omits the `ref` — and the ref is the whole compatibility question. Reading a file also needs -no Node tooling, which is what keeps recommendations working on a machine that can build .NET but -has no Node. There is deliberately no competing lockfile. diff --git a/.agents/skills/purview-buildsdk-skill-installation/references/repository-root.md b/.agents/skills/purview-buildsdk-skill-installation/references/repository-root.md deleted file mode 100644 index e90b695..0000000 --- a/.agents/skills/purview-buildsdk-skill-installation/references/repository-root.md +++ /dev/null @@ -1,55 +0,0 @@ -# The repository-root marker walk - -`FindPurviewRepositoryRoot` is an inline MSBuild task driven by `PurviewRepositoryRootMarkers`: - -```text -.git/;.github/;.gitattributes;LICENSE.md;AGENTS.md;.agents/;CLAUDE.md;.claude/;package.json -``` - -A trailing slash marks a directory. A directory marker still matches a **file** of that name, -because `.git` is a directory in a clone but a file in a worktree or a submodule, and both identify -a repository root. - -## Three things that are load-bearing - -### It cannot be an MSBuild intrinsic - -`GetDirectoryNameOfFileAbove` matches **files only** and returns nothing for `.git/`, `.github/`, -`.agents/` or `.claude/` — four of the nine markers. Verified, not assumed. - -### Two passes - -- **Pass 1** — the first marker in the list is *definitive* and is searched all the way up. `.git/` - *is* the repository root, so a monorepo sub-package with its own `package.json` does not win. -- **Pass 2** — every other marker resolves nearest-ancestor-first, with list order breaking ties - inside a single directory. Searching them all to the top would let a stray `.claude/` in a - developer's home directory outrank the real root. - -### The home directory is never a candidate - -The home directory and everything above it are excluded. Without that bound, a project outside any -repository resolves to `~` and installs into it — and a `.claude/` or a `.github/` very commonly -sits there. A repository *below* the home directory is unaffected, because it is below it. - -## Why the marker walk outranks the evaluation-time guess - -`PurviewSkillsRepoRoot` is computed during evaluation from `RepoRoot` and an `AGENTS.md` walk-up. -An `AGENTS.md` can legitimately sit in a subdirectory, and resolving to it would put a lockfile and -an agent directory somewhere that is not the repository. - -`_PurviewSkillsRepoRootWasSpecified` is captured in `Sdk.props` *before* defaulting, so a value the -**user** set still outranks the walk while a value the SDK guessed does not. - -## A target's Condition is evaluated before its DependsOnTargets - -A property a dependency computes is still empty in the depending target's `Condition`. That is why -the unresolved-root guard sits on the `EvaluatePurviewSkillState` task rather than on -`RecommendPurviewSkills` — and equally why the build hook's CI and design-time gating works at all. - -## The managed port - -`Purview.Skills.Testing` ships `SkillRepositoryRoot`, a managed port of the same walk with the same -default markers, so a test that validates a repository's skills resolves the same root the build -installs them into. The two are kept in step by `SkillRepositoryRootTests`, including an assertion -on the default marker list itself — both are defaults nobody sets, so nothing else would notice them -drifting apart. diff --git a/.agents/skills/purview-buildsdk-skill-tests/SKILL.md b/.agents/skills/purview-buildsdk-skill-tests/SKILL.md deleted file mode 100644 index 4043ac4..0000000 --- a/.agents/skills/purview-buildsdk-skill-tests/SKILL.md +++ /dev/null @@ -1,131 +0,0 @@ ---- -name: purview-buildsdk-skill-tests -description: Author agent skills in a repository that uses Purview.BuildSdk, and validate them with Purview.Skills.Testing or the SDK's pack-time ValidatePurviewSkills target. Use when adding or renaming a skill, writing SKILL.md frontmatter, splitting content into references/ or scripts/, fixing a PRSKL0005 pack failure or a skill-name, skill-description or skill-bundled-resources test failure, or deciding where skills belong in a repository. -license: MIT -metadata: - package: Purview.Skills.Testing - repository: purview-dev/build-sdk ---- - -# Authoring and validating agent skills - -For installing skills a package ships, use `purview-buildsdk-skill-installation`. - -## Where skills live - -**At the repository root, in `skills//SKILL.md`.** Always. - -The skills CLI only discovers skills at a root `skills/` folder, and it reaches a repository by -The skills CLI only discovers skills at a root `skills/` folder, and it reaches a repository by -cloning it, so nothing else is visible to it. Nothing is packed into a NuGet package — a package -carries .NET artifacts, and skills are delivered by the CLI from git. - -```text -skills/ - my-skill/ - SKILL.md required - references/ loaded on demand - scripts/ executable, run on demand - assets/ templates and static resources -``` - -Link to a skill by its **authored** path, `./skills//SKILL.md`. A link into `.agents/skills/` -points at a gitignored file that does not exist in a fresh clone. - -## `SKILL.md` format - -```markdown ---- -name: my-skill -description: What it does, and when to use it. Include the words a task would contain. -license: MIT -metadata: - package: My.Package ---- - -# My skill - -Instructions. -``` - -| Field | Required | Constraint | -| -- | -- | -- | -| `name` | yes | 1–64 chars, lowercase `a-z0-9` and single hyphens, no leading, trailing or consecutive hyphen, **must equal the folder name** | -| `description` | yes | 1–1024 chars, non-empty | -| `license` | no | A licence name, or the name of a bundled licence file | -| `compatibility` | no | ≤500 chars, only when the skill has real environment requirements | -| `metadata` | no | A map of string to string. Anything not defined above belongs here | -| `allowed-tools` | no | Space-separated pre-approved tools. Experimental | - -**There are no other top-level fields.** `category`, `roles` and `tags` are common inventions and a -strict client rejects them; put them under `metadata`. - -The full specification is at . -[references/authoring.md](references/authoring.md) covers description writing, naming for a shared -namespace, and progressive disclosure. - -## Progressive disclosure - -An agent loads a skill in three stages: the `name` and `description` at startup, the whole -`SKILL.md` body once the skill activates, and `references/`, `scripts/` or `assets/` only when the -task reaches them. - -So: keep `SKILL.md` **under 500 lines**, and move detail into `references/`. The body is a cost paid -on every activation; a reference file is paid only when it is needed. - -Keep file references one level deep from `SKILL.md`, and relative to the skill root. A path that -climbs out of the skill folder is broken everywhere except the authoring repository, because only -the skill's own folder is installed. - -## Validating - -### In tests — `Purview.Skills.Testing` - -```csharp -[InheritsTests] -public sealed class SkillTests : PurviewSkillTests; -``` - -**`[InheritsTests]` is load-bearing.** TUnit does not walk base types during discovery, so without -it the class compiles, the run is green and nothing is validated. TUnit reports `TUnit0030`; treat -it as an error. - -| Rule id | What it checks | -| -- | -- | -| `skills-discovery` | The folder, when present, holds at least one skill | -| `skill-structure` | Every folder has a `SKILL.md` whose frontmatter parses | -| `skill-name` | Spec-legal, unique, and equal to the folder name | -| `skill-description` | Present, non-empty, within 1024 characters | -| `skill-optional-fields` | Only spec-defined fields, each within its limit | -| `skill-bundled-resources` | Every linked file exists, inside the skill folder | -| `skill-body-size` | `SKILL.md` stays under the recommended 500 lines | - -A repository with **no** `skills/` folder passes every rule — authoring skills is optional. An -**empty** folder fails `skills-discovery`, because every other rule is vacuous against an empty -catalogue. - -Overrides: `RepositoryRoot` (default: the SDK's repository-root marker walk), -`SkillsFolderName` (default `skills`), and `SkipRule(string)`. - -The evaluator takes a `SkillCatalogue`, so a rule can be exercised against a fixture folder rather -than a real repository — the same three-layer shape this repository uses throughout: a reader, an -evaluator over an in-memory model, and a thin test base class. - -### At pack time — `ValidatePurviewSkills` - -It runs `BeforeTargets="Pack"`, so a malformed skill fails in the repository that owns it rather -than reaching the CLI, which would silently skip it. - -```bash -dotnet msbuild -t:ValidatePurviewSkills -``` - -Failures are reported as `PRSKL0005`, one per problem. Every authored skill is checked. - -The two checks overlap deliberately: the pack-time one runs without a test host, the test one -covers more of the specification. - -## What is deliberately not checked - -Prose quality, and whether an agent actually obeys the skill. A build can only check that a skill is -well formed. Treat a green run as "installable", not "good". diff --git a/.agents/skills/purview-buildsdk-skill-tests/references/authoring.md b/.agents/skills/purview-buildsdk-skill-tests/references/authoring.md deleted file mode 100644 index 69d4ee4..0000000 --- a/.agents/skills/purview-buildsdk-skill-tests/references/authoring.md +++ /dev/null @@ -1,79 +0,0 @@ -# Authoring a skill that fires, and keeps firing - -## The description is the whole activation decision - -`name` and `description` are the only things loaded at startup. Everything else — the body, the -references, the scripts — is invisible until an agent has already decided to activate the skill on -the strength of those two fields. - -So write the description for a *matcher*, not for a reader: - -- Say **what it does** and **when to use it**, in that order. -- Include the words a real task would contain: the tool names, the file names, the error codes, the - property names, the phrases a person would type. -- Name the thing the skill is *not*, when a neighbouring skill could be confused with it. - -| | | -| -- | -- | -| Poor | `Helps with the build SDK.` | -| Better | `Configure Purview.BuildSdk from Directory.Build.props or a .csproj. Use when setting NamespacePrefix, choosing a testing framework, or working out whether a property must be set before the SDK import.` | - -The limit is 1024 characters. Most of that budget is better spent on trigger words than on prose. - -## Naming for a shared namespace - -Skills install into one flat directory per agent, shared with every other skill a developer has -installed from anywhere. A generic name is a collision waiting to happen, and the loser is whichever -one installed second. - -- Prefix with the vendor and the product: `purview-buildsdk-configuration`, not `sdk-configuration`. -- `sdk-*`, `project-*`, `test-*`, `build-*` are all too common to use unprefixed. -- The name must be 1–64 characters, lowercase `a-z0-9` with single hyphens, no leading, trailing or - consecutive hyphen — and it must equal the folder name, because the CLI installs by the - frontmatter name while a human reads the folder. - -Renaming a skill means renaming the folder and the frontmatter together, and re-running the install. - -## Progressive disclosure in practice - -| Stage | Loaded | Budget | -| -- | -- | -- | -| Metadata | `name`, `description` | ~100 tokens, always | -| Instructions | the whole `SKILL.md` body | under 5000 tokens recommended; keep the file under 500 lines | -| Resources | `references/`, `scripts/`, `assets/` | only when the task reaches them | - -What belongs where: - -- **`SKILL.md`** — the decisions, the rules, the things that are wrong by default, and a pointer to - everything else. If a reader needs it to make the *first* correct move, it goes here. -- **`references/`** — long tables, full option lists, grammars, enumerations. Keep each file - focused; an agent loads the whole file. -- **`scripts/`** — executable code. Self-contained, or documenting its dependencies clearly, with - helpful error messages. -- **`assets/`** — templates, schemas, images, lookup data. - -Keep references one level deep. Avoid a chain where one reference sends an agent to another. - -## Links - -Use relative paths from the skill root: - -```markdown -See [the reference](references/REFERENCE.md) for detail. -Run `scripts/extract.py`. -``` - -Only the skill's own folder is installed, so a link that climbs out of it (`../other-skill/...`) is -broken on every machine except the one that authored it. To point at another skill, name it in prose -and let the agent find it by name. - -## Keeping a skill true - -A skill that describes a product goes stale the moment the product changes, and nothing about a -stale skill looks broken — it just gives confidently wrong advice. - -- Change the skill in the **same commit** as the behaviour it documents. -- Prefer stating the property name, the diagnostic code or the target name over paraphrasing the - behaviour; those are greppable when the code changes. -- Where a number or a list is authoritative somewhere else — a default, an enumeration — say where - it comes from, so a reader can check it. diff --git a/.agents/skills/purview-buildsdk-testing/SKILL.md b/.agents/skills/purview-buildsdk-testing/SKILL.md deleted file mode 100644 index 5a5a7d5..0000000 --- a/.agents/skills/purview-buildsdk-testing/SKILL.md +++ /dev/null @@ -1,121 +0,0 @@ ---- -name: purview-buildsdk-testing -description: Write and run tests in a repository that uses Purview.BuildSdk. Use when authoring or refactoring TUnit tests (AAA structure, Subject_Scenario_Expectation naming, awaited assertions, CancellationToken), when choosing a test project's framework packages, and when running or filtering tests - the SDK wires Microsoft.Testing.Platform, so `dotnet test --filter` reports "Zero tests ran" and `--treenode-filter` is the one that works. -license: MIT -metadata: - package: Purview.BuildSdk - repository: purview-dev/build-sdk ---- - -# Testing in a Purview.BuildSdk repository - -Two things to know before anything else: - -1. A test project is detected by **name**, and detection is what wires the runner. See - `purview-buildsdk-project-layout` if the project is new or being moved. -2. The runner is **Microsoft.Testing.Platform (MTP)**, not VSTest. `--filter` does nothing useful. - -## What a test project gets automatically - -With the defaults (`TestingFramework=TUnit`, `SubstituteFramework=TUnitMocks`, -`TestDataFramework=Bogus`), a detected test project receives: - -- `TUnit`, `TUnit.Mocks`, `Bogus` -- Microsoft.Testing.Platform integration -- `CollectCoverage=true` -- test-friendly `NoWarn` defaults (`PurviewTestContextNoWarn`), while keeping the strict style - contract — `IDE0040`, field naming, formatting, `IDE1006` -- `IsPackable=false`, `IsPublishable=false` - -Add nothing else unless the project's purpose demands it. Two that stay explicit: - -- `TUnit.Aspire` — Aspire lifecycle and AppHost-backed integration tests -- `Purview.Containers` — container-backed integration tests. One API over Microsoft WSL Containers - (no Docker install needed on Windows) or Docker, with typed modules for SQL Server, PostgreSQL, - Redis, MySQL, RabbitMQ, Azurite and NATS. Experimental and prerelease, so pin the version. - Reference `Testcontainers` directly only where no typed module exists yet. - -## Authoring rules - -- Use TUnit (`TUnit.Core`, `TUnit.Assertions`). Do not introduce xUnit, NUnit, MSTest or - FluentAssertions unless explicitly asked. -- Every test method carries `[Test]`. -- **Every assertion is awaited**: `await Assert.That(actual).IsEqualTo(expected);`. An un-awaited - assertion silently passes. -- Arrange / Act / Assert, with the `// Arrange`, `// Act`, `// Assert` comments present. -- Test classes are `{SubjectName}Tests`, in the **same namespace** as the subject. -- Test methods are `{SubjectOrMemberUnderTest}_{Scenario}_{Expectation}`. Use `ctor` as the subject - for constructor tests. Methods, constructors, properties, operators, conversions and validation - hooks are all valid subjects. -- When any method called in the test body accepts a `CancellationToken`, take - `CancellationToken cancellationToken` as the **last parameter** and pass it through. - -```csharp -[Test] -public async Task ProcessAsync_GivenAnEmptyBatch_ReturnsZero(CancellationToken cancellationToken) -{ - // Arrange - var sut = new BatchProcessor(); - - // Act - var result = await sut.ProcessAsync([], cancellationToken); - - // Assert - await Assert.That(result).IsEqualTo(0); -} -``` - -For a suite that is not subject-based — a build, generator, workflow, package or full-system suite — -a broader, more truthful class name is better than a forced `{Subject}Tests`. Use TUnit display -names and categories to keep it navigable. - -When refactoring existing tests, bring them into compliance with all of the above while preserving -test intent. - -## Categories - -The detected test type becomes the baseline category automatically — `Api.IntegrationTests` yields -`Category=Integration`. Add further categories when they make a large suite easier to navigate; -they are what `--treenode-filter` property predicates select on. - -## Running tests - -```bash -dotnet test # the whole suite -dotnet test --treenode-filter "/*/*/LoginTests/*" # one class -dotnet test --treenode-filter "/*/*/*/*[Category=Unit]" -``` - -Prefer the repository's own task (`just test`, or equivalent) for a full run. - -The filter path is `////`, with `*` wildcards, `=`/`!=` property -predicates, `&`/`|` inside a single bracket group, and `**` only at the end. The full grammar, the -`--` separator rules across SDK versions, and the zero-tests checklist are in -[references/treenode-filter.md](references/treenode-filter.md). - -### "Zero tests ran" - -In order: - -1. Are you using `--treenode-filter` and not `--filter`? This is the cause most of the time. -2. Try `dotnet test --treenode-filter "..."`; on an older SDK use `dotnet test -- --treenode-filter "..."`. -3. Broaden to `/*/*/*/*`, then narrow one segment at a time. -4. Does the project actually contain `[Test]` methods? -5. Is the project **detected** as a test project? A name without the dot — `UnitTests` rather than - `Api.UnitTests` — gets no runner at all. Check with - `dotnet msbuild -getProperty:IsTestProject`. -6. Are all property predicates inside one bracket group, `[(A=1)&(B=2)]`? - -## Cross-platform requirement - -CI runs the full suite on Linux, so a test that only passes on Windows is a failing change. - -- Never hardcode a platform-specific path — no `C:\...`, no backslash-only separators, no - case-insensitive path assumptions. -- Build paths with `Path.Combine`, `Path.GetTempPath()`, `Path.DirectorySeparatorChar`, - `Path.GetFullPath()`. -- Feed production path-math code only native-format paths. Normalise a fixed Windows-style literal - to the current platform before passing it in. -- Do not rely on a case-insensitive filesystem, a `C:` drive, or trailing-separator behaviour. -- Keep `SyntaxTree` file paths and `build_property.*` values consistent and native when writing - analyzer tests. diff --git a/.agents/skills/purview-buildsdk-testing/references/treenode-filter.md b/.agents/skills/purview-buildsdk-testing/references/treenode-filter.md deleted file mode 100644 index 35d032b..0000000 --- a/.agents/skills/purview-buildsdk-testing/references/treenode-filter.md +++ /dev/null @@ -1,107 +0,0 @@ -# `--treenode-filter` reference - -TUnit runs on Microsoft.Testing.Platform, not VSTest, so the VSTest `--filter` syntax does not -apply. Narrowing is done with `--treenode-filter`. - -## The path - -```text -//// -``` - -Each segment maps to one level of the tree: - -| Position | Matches | -| -- | -- | -| 1 | Assembly | -| 2 | Namespace | -| 3 | Class | -| 4 | Test name | - -```text -/*/*/LoginTests/* every test in LoginTests -/*/*/*/AcceptCookiesTest one test by name -/*/MyProject.Tests.Integration/*/* every test in a namespace -/*/*/*/* everything -``` - -## Operators - -### `*` — wildcard - -Matches a whole segment or part of one. - -```text -/*/*/LoginTests*/* -/*/*/MyProject.Tests.Api*/* -``` - -### `=` and `!=` — property predicates - -In the last segment, inside `[...]`. - -```text -/*/*/*/*[Category=Unit] -/*/*/*/*[Category!=Slow] -/*/*/*/*[Owner=*Team-Backend*] -``` - -### `&` and `|` — combining - -Inside a **single** bracket group, or a single parenthesised segment. - -```text -/*/*/*/*[(Category=Unit)&(Priority=High)] -/**[(Category=Unit)|(Priority=High)] -/*/*/(LoginTests)|(SignupTests)/* -``` - -### `**` — match all - -Any depth, but **only at the end** of the path. - -```text -/** -/MyAssembly/** -``` - -`/**/Path` is not valid. - -## Rules that catch people out - -- Only **one** property group `[...]` per path segment. `[Category=Smoke]|[Priority=High]` is not - valid; write `[(Category=Smoke)|(Priority=High)]`. -- `**` must be last. -- A segment left empty is not a wildcard — write `*`. - -## The `--` separator - -```bash -dotnet test --treenode-filter "/*/*/*/*[Category=Unit]" # preferred -dotnet test -- --treenode-filter "/*/*/*/*[Category=Unit]" # older SDKs -``` - -Newer .NET SDKs forward unrecognised arguments to the MTP runner directly. On an older SDK the `--` -separator is required, and omitting it produces an argument error rather than a filter. - -## Common selections - -| Intent | Filter | -| -- | -- | -| Everything | `/*/*/*/*` | -| All unit tests | `/*/*/*/*[Category=Unit]` | -| High-priority unit tests | `/*/*/*/*[(Category=Unit)&(Priority=High)]` | -| One class | `/*/*/MyFeatureTests/*` | -| A name pattern | `/*/*/*/MyScenario*` | -| Critical integration tests | `/*/MyProject.Tests.Integration/*/*[Priority=Critical]` | - -## Zero tests ran - -1. `--treenode-filter`, not `--filter`. -2. Try without the `--` separator first, then with it. -3. Broaden to `/*/*/*/*`, then narrow one segment at a time. -4. Confirm the project has `[Test]` methods. -5. Confirm the project is **detected** as a test project — - `dotnet msbuild -getProperty:IsTestProject`. A name without the dot, such as - `UnitTests` rather than `Api.UnitTests`, is not detected and gets no runner. -6. Confirm every property predicate sits in one bracket group. diff --git a/.agents/skills/purview-component-compatibility/SKILL.md b/.agents/skills/purview-component-compatibility/SKILL.md deleted file mode 100644 index b017681..0000000 --- a/.agents/skills/purview-component-compatibility/SKILL.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -name: purview-component-compatibility -description: >- - Use when developing, reviewing or releasing a published component - a NuGet package, or an npm - package - and choosing which dependency version to declare, when a consumer reports a version - conflict or an unexpected upgrade, or when a component's supported target frameworks change. Applies - the golden rule that a published component declares the LOWEST compatible version rather than the - latest, walks the Purview component hierarchy to find each floor, and verifies it by building - against it. Not for applications: they take the latest compatible version instead. -license: MIT -metadata: - author: Purview-Dev - version: "1.0" - repository: purview-dev/engineering-playbook ---- - -# Purview component compatibility - -A published component makes a promise with every version it declares: *this is the least I require of -you*. Raise that number and every consumer is pulled up with you, whether or not they wanted it. - -**The golden rule: declare the lowest version that compiles, passes your tests, and is supported on -every target framework you claim.** The version you happen to have installed is never the answer, and -neither is the latest. - -## Which direction? - -| What you are publishing | Declare | Why | -| -- | -- | -- | -| an application, a test suite, a tool — it runs, and nobody installs it | the **latest** compatible version | you own the runtime, and a version you skip is a fix you did not take | -| a component — a NuGet or npm package somebody else installs | the **lowest** compatible version | dependency resolution takes the highest minimum in the graph, so your floor becomes theirs | - -This skill is about the second row. If the repository only ever runs, stop here and take the latest. - -## Why a floor matters - -NuGet and npm resolve a graph to the **highest** minimum among all constraints. If a package declares -`Testcontainers` 4.16 because 4.16 is what its author had installed, every consumer is forced onto 4.16, -including the one whose own constraint is 4.0 and whose runtime is pinned to it. The consumer cannot -refuse an upgrade the package never needed to ask for, and the symptom appears in *their* build, not -yours. - -## The workflow - -### 1. Name the component and its frameworks - -The floor is per target framework, not per package. Write down every `TargetFramework` the component -publishes; a multi-targeting component has a different floor on each, and the one that matters is the -oldest framework still supported, not the newest one you build against. - -### 2. Read the hierarchy, do not remember it - -The dependencies — and their minimums — are in the published `.nuspec`, not in anyone's memory: - -```bash -node scripts/dependencies.mjs Purview.Containers -node scripts/dependencies.mjs Purview.Architecture.Testing --tfm net11.0 -node scripts/dependencies.mjs Purview.Containers --walk -``` - -A bare version is a **minimum**; a bracketed one (`[1.2.3]`, `[1.0,2.0)`) is a range. The script prints -the distinction, because it is the whole rule: a minimum you raise is a minimum every consumer inherits. - -`references/purview-components.md` records which Purview package depends on which, and which target -frameworks each family supports. Where the two disagree the registry wins — that file is the map, the -`.nuspec` is the territory. - -### 3. Fix the floor, per framework - -For each dependency, find the oldest version that: - -- exposes every API the component calls (the compiler decides this, not the changelog); -- passes the component's own tests and its consumer-verification suite; -- is supported on every framework in that dependency group. - -Then declare that version. Not `latest`, not floating (`1.*`), and never the version that resolved on -your machine by accident. - -### 4. Prove the floor - -A floor nobody builds against is a guess. Add a CI leg that restores the component with every dependency -held at its declared floor and runs the suite — the ordinary leg keeps resolving the latest, which is -what a consumer will actually get. `references/lowest-compatible.md` has the mechanics. - -### 5. Keep the ceiling visible, and the floor written down - -A component's README carries a badge for the current release and a sentence naming the floor it -supports. Badges are generated from the registry, so they cannot go stale; a version written into prose -is wrong within one release. - -## Pitfalls that produce a floor nobody meant - -| Pitfall | What it looks like | The fix | -| -- | -- | -- | -| Declaring what is installed | `dotnet add package X` writes the latest; right for an application, wrong for a component | edit the version down, then prove it in step 4 | -| Transitive uplift | a dependency pulls in a newer transient package than your floor allows | override it deliberately — the persistence sample does this for a security-patched package — and comment why | -| One framework's floor | a `net10.0-windows` group needs a higher floor than `net10.0` | read each group; never average them | -| Prerelease in the graph | a family that ships prereleases depends on them at the same version | pin the family to one property so the floor moves together | -| Analyzer and source-generator packages | compile-time only, so they rarely constrain a consumer | still declare a real floor; they appear in the graph and in transitive audits | -| Floating versions | `1.*` resolves differently on every restore | banned: a floor is a number | - -## Checks before you answer - -- Is each declared version the lowest that passes, or the one that happened to be installed? -- Does every declared target framework have a floor that compiles on that framework? -- Was the floor proved by a build, or only by your machine? -- Does any page state a version number? It should be a badge or a link to the registry. -- If a floor was raised, is that a breaking change the version number admits to? - -## See also - -`references/lowest-compatible.md` for the CI mechanics and the override patterns, and -`references/purview-components.md` for the Purview hierarchy. The rule itself, and the application-side -half of it, is stated in the Engineering Playbook's Dependency Versions page; the -`purview-engineering-principles` skill summarises it as one of the eleven conventions. - diff --git a/.agents/skills/purview-component-compatibility/references/lowest-compatible.md b/.agents/skills/purview-component-compatibility/references/lowest-compatible.md deleted file mode 100644 index ccdb3b6..0000000 --- a/.agents/skills/purview-component-compatibility/references/lowest-compatible.md +++ /dev/null @@ -1,93 +0,0 @@ -# Proving the floor - -The rule is "declare the lowest compatible version". This file is the mechanics: how to find the floor, -how to prove it in a build, and the patterns that keep it from silently rising. - -## What "compatible" means, precisely - -A version is a valid floor when all three hold: - -1. **It compiles against every API the component uses.** The compiler decides this, not a changelog. If - you cannot say which member forced the version up, you have not found the floor. -2. **The component's own tests pass against it**, including the consumer-verification suite, which - builds a throwaway consumer rather than the component's own test project. -3. **It is supported on every target framework in that dependency group.** A floor is per group, and a - multi-targeting component can have several. - -## Finding it - -```bash -dotnet list package --outdated # what you declared against what exists -dotnet list package --include-transitive # what actually resolved -dotnet nuget why # which path pulled a version in -``` - -Then work downward: lower the declared version, build, and read the compiler. The first version that -compiles *and* passes is the floor. Do not stop at the first failure and pick the version above it — -that is how a floor ends up one minor above what the code needs. - -## Making the floor a build leg - -Keep one property per family (so a family cannot be bumped halfway) and make each conditional on a floor -switch. Nothing here is NuGet-specific magic: it is MSBuild, and central package management already -gives you the single place to put it. - -```xml - - LATEST - FLOOR - -``` - -```bash -dotnet restore -p:DependencyFloor=true -dotnet build -p:DependencyFloor=true --no-restore -dotnet test -p:DependencyFloor=true --no-build -``` - -`LATEST` and `FLOOR` are literals in the file; the point is that they are two properties, not two files. -Run the ordinary leg at `LATEST` and a second, slower leg at `FLOOR`, and give the floor leg its own CI -job so a failure names the floor rather than the build. - -Where a component multi-targets, add the framework dimension and run the pair per framework: - -```bash -for tfm in net8.0 net9.0 net10.0; do - dotnet build -p:DependencyFloor=true -f "$tfm" -done -``` - -## Transitive pins - -A floor can be raised by something you never declared. Transitive pinning puts those versions where you -can see them: - -```xml - - true - -``` - -Then an override is a deliberate line with a reason beside it — the persistence sample in this -repository does exactly that for a security-patched package the SQL client drags in. An override without -a comment is indistinguishable from an accident, and the next person deletes it. - -## The ceiling, and the API surface - -- The floor leg proves the **bottom**; the ordinary leg proves the **top**. Both, or you know neither. -- An API-compatibility check against the previous release catches the other direction of the same - mistake: a floor can stay put while the public surface grows a member that only the newest dependency - provides. `Microsoft.DotNet.ApiCompat.Task` wires that into the build; `Microsoft.DotNet.ApiCompat.Tool` - runs it from a pipeline. -- A prerelease dependency is a floor with an expiry: it cannot be consumed by anyone who has not opted - into prereleases. Say so in the package's README rather than letting the error message explain it. - -## What not to do - -| Temptation | Why it is wrong | -| -- | -- | -| `dotnet add package X` and commit | it writes the latest; correct for an application, wrong for a component | -| floating versions (`1.*`) | resolves differently on every restore, so the floor is nobody's decision | -| "it restores on my machine" | that proves one graph, on one date, with one SDK | -| raising a floor in a patch release | the consumer's build changes without their version changing | -| one floor leg for all frameworks | the framework with the lowest floor is the one nobody tested | diff --git a/.agents/skills/purview-component-compatibility/references/purview-components.md b/.agents/skills/purview-component-compatibility/references/purview-components.md deleted file mode 100644 index 6e13b65..0000000 --- a/.agents/skills/purview-component-compatibility/references/purview-components.md +++ /dev/null @@ -1,60 +0,0 @@ -# The Purview component hierarchy - -Which Purview package depends on which, and which target frameworks each family supports, so a harvest -or a floor decision starts from the shape rather than from a memory of it. - -Every row was read from the registry with `scripts/dependencies.mjs`, which reads the published -`.nuspec`. **The registry is the authority; this file is the map.** Re-run the script before acting on -any row — a family that multi-targets changes its floors on every release. - -## The families - -| Family | Packages | Target frameworks | Depends on | -| -- | -- | -- | -- | -| Build SDK | `Purview.BuildSdk` | `netstandard2.0` (an MSBuild SDK) | nothing | -| Test-support rule sets | `Purview.Skills.Testing`, `Purview.Architecture.Testing`, `Purview.Architecture.Testing.Cli` | `net10.0`; `Architecture.Testing` also `net11.0` | `TUnit.Core`, `TUnit.Assertions`, `JsonSchema.Net` | -| Telemetry | `Purview.Telemetry.SourceGenerator` | `netstandard2.0` (an analyzer) | nothing | -| Containers | `Purview.Containers` + `.Core`, `.Docker`, `.Wsl`, `.MsSql`, `.PostgreSql` | `net10.0`; `.Wsl` adds `net10.0-windows10.0.19041` | its own family at the same version, `Microsoft.Extensions.Telemetry.Abstractions`, `Testcontainers` | -| Results | `Purview.Results`, `.AspNetCore`, `.ZodSharp`, `.ZodSharp.AspNetCore` | `net10.0`, `net11.0` | nothing; the adapters depend on the core and on ZodSharp | -| ZodSharp | `Purview.ZodSharp`, `.AspNetCore`, `.SystemTextJson`, `.NewtonsoftJson` | `net9.0`, `net10.0`, `net11.0` | `Microsoft.Extensions.Options`, `Microsoft.Extensions.DependencyInjection.Abstractions` | -| Value Objects | `Purview.ValueObjects` | `net8.0`, `net9.0`, `net10.0`, `net11.0` | nothing | -| Source Generator Framework | `Purview.SourceGeneratorFramework`, `.Testing`, `.Testing.TUnit` | `netstandard2.0` | Roslyn (`Microsoft.CodeAnalysis.CSharp`), `System.Collections.Immutable`, `System.Reflection.Metadata` | -| Aspire ResourceKit | `Purview.Aspire.ResourceKit` | `net8.0`, `net9.0`, `net10.0` | `Aspire.Hosting`, OpenTelemetry exporter and hosting, `Microsoft.Extensions.*` | -| Astroc4 | `@purview-dev/astroc4` (npm, not NuGet) | an Astro/Starlight plugin | `likec4`, `@astrojs/starlight`, `astro` as peers | - -## Reading the shape - -Three patterns are worth internalising, because each one changes what "the floor" means: - -- **A family ships at one version.** `Purview.Containers.Core` is required at the umbrella's own version, - and `Purview.Results.ZodSharp` requires `Purview.Results` and `Purview.ZodSharp` at their current ones. - Declare the family with one property, so its floor moves as a unit. -- **An analyzer has no consumer-side floor worth arguing about.** `Purview.BuildSdk`, - `Purview.Telemetry.SourceGenerator` and `Purview.SourceGeneratorFramework` target `netstandard2.0` and do - their work at compile time. They still appear in a transitive audit, so they still get a real version. -- **A multi-targeting component has a different floor per framework**, and ZodSharp shows it most - clearly: the `net11.0` group declares older `Microsoft.Extensions.*` minimums than the `net10.0` group, - because the lower framework carries the newer requirements. Reading one group and applying it to - another is how a floor is set wrong in the direction that breaks consumers. - -## What the script prints - -```text -Purview.Containers 1.0.0-prerelease.11 - net10.0: Purview.Containers.Core >= 1.0.0-prerelease.11 - net10.0: Purview.Containers.Docker >= 1.0.0-prerelease.11 - net10.0: Purview.Containers.Wsl >= 1.0.0-prerelease.11 - net10.0: Microsoft.Extensions.Telemetry.Abstractions >= 10.11.0 - net10.0: Testcontainers >= 4.16.0 - Purview.Containers.Core 1.0.0-prerelease.11 - net10.0: Microsoft.Extensions.Telemetry.Abstractions >= 10.11.0 -``` - -A bare version is a minimum; brackets would mean a range. The numbers above are what the registry said -when this page was written — the shape is the part that lasts, which is why the command is here and the -versions are not presented as targets. - -## Related components that are not Purview packages - -`AspireC4.Hosting` is published under its own name and versions on its own schedule, so it is not part of -a Purview family floor. Read it the same way, with the same script. diff --git a/.agents/skills/purview-component-compatibility/scripts/dependencies.mjs b/.agents/skills/purview-component-compatibility/scripts/dependencies.mjs deleted file mode 100644 index 3069ef6..0000000 --- a/.agents/skills/purview-component-compatibility/scripts/dependencies.mjs +++ /dev/null @@ -1,239 +0,0 @@ -#!/usr/bin/env node -/** - * Prints a package's dependency groups exactly as NuGet declares them, so the floor a component - * inherits can be read rather than guessed. - * - * The golden rule of package development is to declare the LOWEST compatible version, and that decision - * needs the real graph: which dependency, at what minimum, on which target framework. This script reads - * it from the registry - the `.nuspec` the published package carries - instead of from a table that - * would be stale by the next release. - * - * Zero dependencies: it uses the platform `fetch`, so it runs anywhere Node 18 or later does. - * - * node dependencies.mjs Purview.Containers - * node dependencies.mjs Purview.Architecture.Testing --tfm net11.0 - * node dependencies.mjs Purview.Containers --walk # recurse into Purview.* dependencies - * node dependencies.mjs Purview.Results --json - * - * An npm package is not a NuGet id; read it with `npm view versions --json`. - * - * Exit codes: 0 on success, 1 when the package, version or network is not available. - */ - -/** The NuGet flat-container root: the same host that serves the package's own `.nuspec`. */ -const REGISTRY = "https://api.nuget.org/v3-flatcontainer"; - -/** How deep `--walk` follows dependencies before it stops. */ -const MAX_DEPTH = 3; - -/** True when a version string carries a prerelease label. */ -function isPrerelease(version) { - return version.includes("-"); -} - -/** Every published version of a package, oldest first. */ -async function versionsOf(id) { - const response = await fetch(`${REGISTRY}/${id.toLowerCase()}/index.json`); - if (!response.ok) { - throw new Error(`${id} is not on nuget.org (HTTP ${response.status}).`); - } - - const body = await response.json(); - return body.versions; -} - -/** The version to describe: the one asked for, else the newest stable, else the newest anything. */ -function chooseVersion(available, requested) { - if (requested) { - const match = available.find((version) => version.toLowerCase() === requested.toLowerCase()); - if (!match) { - throw new Error(`'${requested}' is not a published version. Newest is ${available.at(-1)}.`); - } - - return match; - } - - const stable = available.filter((version) => !isPrerelease(version)); - return stable.at(-1) ?? available.at(-1); -} - -/** The package's `.nuspec`, which is what a consumer's restore actually reads. */ -async function readNuspec(id, version) { - const name = id.toLowerCase(); - const response = await fetch(`${REGISTRY}/${name}/${version.toLowerCase()}/${name}.nuspec`); - if (!response.ok) { - throw new Error(`No .nuspec for ${id} ${version} (HTTP ${response.status}).`); - } - - return response.text(); -} - -/** The value of one XML attribute on a tag, or null. */ -function attribute(tag, name) { - const match = new RegExp(`${name}\\s*=\\s*"([^"]*)"`).exec(tag); - return match ? match[1] : null; -} - -/** - * How a nuspec version string constrains a consumer: a bare version is a MINIMUM, and a bracketed one is - * a range. This is the distinction the whole rule turns on, because a minimum you raise is a minimum - * every consumer inherits. - */ -function classify(range) { - if (!range) { - return "any"; - } - - return range.startsWith("[") || range.startsWith("(") ? "range" : "minimum"; -} - -/** The dependency elements inside a fragment, normalized. */ -function dependenciesIn(fragment) { - const dependencies = []; - const pattern = /]*)\/?>/g; - let match; - - while ((match = pattern.exec(fragment)) !== null) { - const tag = match[1]; - const version = attribute(tag, "version"); - dependencies.push({ id: attribute(tag, "id"), version, constraint: classify(version) }); - } - - return dependencies; -} - -/** The dependency groups a nuspec declares, one per target framework. */ -function dependencyGroups(nuspec) { - const groups = []; - const pattern = /]*)>([\s\S]*?)<\/group>/g; - let match; - - while ((match = pattern.exec(nuspec)) !== null) { - groups.push({ - framework: attribute(match[1], "targetFramework") ?? "(any)", - dependencies: dependenciesIn(match[2]), - }); - } - - if (groups.length === 0) { - const flat = dependenciesIn(nuspec); - if (flat.length > 0) { - groups.push({ framework: "(any)", dependencies: flat }); - } - } - - return groups; -} - -/** A printable name for a target framework, spelled the way the ecosystem usually writes it. */ -function shortFramework(framework) { - return framework - .replace(/^\.NETStandard/i, "netstandard") - .replace(/^\.NETCoreApp/i, "net") - .replace(/^\.NETFramework/i, "netframework") - .toLowerCase(); -} - -/** Prints one package's groups, recursing into Purview components when asked. */ -async function describe(id, requestedVersion, options, depth, seen) { - const version = chooseVersion(await versionsOf(id), requestedVersion); - const groups = dependencyGroups(await readNuspec(id, version)); - const indent = " ".repeat(depth); - - console.log(`${indent}${id} ${version}`); - - for (const group of groups) { - const framework = shortFramework(group.framework); - if (options.tfm && framework !== options.tfm.toLowerCase()) { - continue; - } - - if (group.dependencies.length === 0) { - console.log(`${indent} ${framework}: no dependencies`); - continue; - } - - for (const dependency of group.dependencies) { - const relation = dependency.constraint === "minimum" ? ">=" : dependency.constraint; - console.log( - `${indent} ${framework}: ${dependency.id} ${relation} ${dependency.version ?? "any"}`, - ); - } - - if (options.walk && depth < MAX_DEPTH) { - for (const dependency of group.dependencies) { - const isPurview = /^purview\./i.test(dependency.id ?? ""); - if (!(options.all || isPurview) || seen.has(dependency.id.toLowerCase())) { - continue; - } - - seen.add(dependency.id.toLowerCase()); - await describe(dependency.id, null, options, depth + 1, seen); - } - } - } - - return { id, version, groups }; -} - -/** Parses the command line. An unknown argument is a mistake worth failing on. */ -function parseArguments(argv) { - const options = { packages: [], tfm: null, walk: false, all: false, json: false }; - - for (let index = 0; index < argv.length; index += 1) { - const argument = argv[index]; - - if (argument === "--walk" || argument === "-w") { - options.walk = true; - } else if (argument === "--all") { - options.all = true; - } else if (argument === "--json") { - options.json = true; - } else if (argument === "--tfm") { - options.tfm = argv[(index += 1)]; - if (!options.tfm) { - throw new Error("--tfm needs a value, e.g. --tfm net10.0."); - } - } else if (argument.startsWith("-")) { - throw new Error(`Unknown argument '${argument}'.`); - } else { - options.packages.push(argument); - } - } - - if (options.packages.length === 0) { - throw new Error( - "Name at least one package, e.g. `node dependencies.mjs Purview.Containers`.\n" + - "A package may carry a version: `Purview.Containers@1.0.0-prerelease.11`.", - ); - } - - return options; -} - -/** The command. */ -async function main() { - const options = parseArguments(process.argv.slice(2)); - const results = []; - - for (const entry of options.packages) { - const separator = entry.indexOf("@", 1); - const id = separator === -1 ? entry : entry.slice(0, separator); - const version = separator === -1 ? null : entry.slice(separator + 1); - - results.push(await describe(id, version, options, 0, new Set([id.toLowerCase()]))); - - if (!options.walk && !options.json) { - console.log(""); - } - } - - if (options.json) { - console.log(JSON.stringify(results, null, "\t")); - } -} - -main().catch((error) => { - console.error(`error: ${error.message}`); - process.exitCode = 1; -}); diff --git a/.agents/skills/purview-engineering-principles/SKILL.md b/.agents/skills/purview-engineering-principles/SKILL.md deleted file mode 100644 index 24fe707..0000000 --- a/.agents/skills/purview-engineering-principles/SKILL.md +++ /dev/null @@ -1,198 +0,0 @@ ---- -name: purview-engineering-principles -description: >- - Use when setting up, reviewing or rationalising a .NET repository against the Purview engineering - conventions - convention over configuration, derived identity, architecture as tests, warnings as - errors, proving consumer-facing claims, documentation ownership, test data builders, agent - legibility, tiering verification by risk, the version policy for applications and for published - components, and the conditional persistence rules. Each rule names the failure it prevents and - whether a build or a reviewer enforces it. -metadata: - product: Purview engineering playbook - repository: purview-dev/engineering-playbook ---- - -# Purview engineering principles - -Eleven rules, each with the failure it prevents and the mechanism that makes it true. The distinction -that matters throughout: **a convention a build can check is checked by the build; a convention only -a reviewer can check is labelled a review obligation and never described as enforced.** A rule that -claims enforcement it does not have is worse than no rule, because people stop looking. - -## 1. Convention over configuration - -A repository declares as little as possible. One MSBuild SDK supplies the defaults, and a project -file is short because the SDK already knows what a project of that shape needs. - -Configuration copied between repositories diverges. When the rule lives in one package, fixing it -once fixes it everywhere; when it lives in eleven project files, it is fixed eleven times — or, more -often, once. - -*Enforced by:* `` in a single -`Directory.Build.props`. The SDK detects project type from the filename and the `Sdk` attribute. - -*At your scale:* a single-project repository still benefits. The import is two lines and removes the -target framework, language version, nullable context, analyzer set and package metadata. - -## 2. Identity is derived, never repeated - -`RootNamespace` comes from `$(NamespacePrefix).$(ProjectName)`, and `AssemblyName` follows the -resolved `RootNamespace`. A name appears once — in the folder and file name — and everything else is -computed. - -A hand-typed namespace drifts from the assembly it lives in, and the drift is invisible until -something reflects over types: an architecture test, a serializer, a DI scan. - -*Enforced by:* the SDK during `.props` evaluation, plus a build-time check -(`PurviewProjectFileNameMismatch`) when a `.csproj` filename does not match its parent directory. - -*At your scale:* always. It costs nothing and removes a class of bug. - -## 3. Architecture is a test, not a diagram - -The dependencies a layer may have are asserted by tests that read the compiled assemblies. A -`ProjectReference` pointing the wrong way fails the build. - -A diagram is a claim about the past. Dependency direction erodes one convenient reference at a time, -and every such reference looks reasonable in isolation. - -*Enforced by:* a test project that references every layer and inspects their metadata references. - -*At your scale:* small repositories can skip it. Adopt it the moment a **second layer** exists — -that is when the wrong direction first becomes possible. - -## 4. The build is the only authority - -Style is enforced by analyzers and `EnforceCodeStyleInBuild`, and the SDK's own style policy is -re-validated on every compile, so a repository cannot quietly downgrade a rule. - -*At your scale:* always. If a rule matters and cannot be checked, say so plainly. - -## 5. Warnings are not acceptable output - -A clean build has no warnings. One that will never be fixed is either fixed, suppressed *where it -occurs* with a stated justification, or turned off deliberately. - -Warnings are a budget. A build that emits twenty is a build where the twenty-first is invisible — and -the twenty-first is the one that mattered. - -*Enforced by:* severity, partly. The SDK's shipped `.editorconfig` sets many rules to `error`. The -rest is review, backed by the pipeline running `dotnet build` with the repository's configuration. - -*At your scale:* a small repository can tolerate `warning`; a large one cannot. Decide deliberately -rather than by accumulation. - -## 6. Every claim about a consumer is proved by a consumer - -When a package documents how it must be used — a target framework, an asset, a guard, a workaround — -something in the repository builds that documented consumer and asserts the documented outcome. - -Consumer-facing documentation is the part of a library least likely to be exercised by its own tests, -because **the library's own build is not a consumer**. It drifts silently and fails in somebody -else's repository. - -*Enforced by:* a verification script that packs, then builds throwaway consumer projects against the -produced packages, asserting the happy path *and* the documented guard errors. `purview-dev/containers` -is the worked example (`just verify-consumers`), deliberately excluded from the default unit filter -because it restores from nuget.org. - -*At your scale:* only once a package is consumed outside its own repository. Before that, the -repository's own tests already are the consumer. - -## 7. Documentation is a build artefact of the repository - -The wiki lives in the repository it describes, in `docs/wiki`, as plain Markdown. The repository owns no -site configuration at all: `_Sidebar.md` is the navigation, `Home.md` is the hub, and the site that -publishes them lives in one place outside the repository. - -Documentation that lives elsewhere is updated elsewhere. A page with no owner and no review path is -wrong within one release. - -*Enforced by:* review, plus the navigation file — a page absent from `_Sidebar.md` is not published. - -*At your scale:* always. Even a repository with one page should own that page. - -## 8. Everything a test needs is built by one builder - -Domain content in a test comes from `TestBuilder`. A test never constructs a domain object inline, -and it overrides **only** the value it is proving. - -Inline construction encodes a type's shape into every test that touches it, so one constructor change -becomes a repository-wide edit. It also hides which values the test actually depends on, because -every value looks deliberate. - -*Enforced by:* review. - -*At your scale:* adopt from the first test. Retrofitting is a mechanical edit across every test file, -and exactly the kind of edit that is postponed forever. - -## 9. An agent is a reader with no memory - -A repository states its purpose, its layout and its conventions in `AGENTS.md`. **Nothing important -is discoverable only by reading the code.** - -A coding agent has the repository and nothing else — no colleague to ask, no institutional memory, no -intuition about which of two plausible patterns is intended. It will confidently generalise from -whatever it finds first. That is also every new-joiner failure mode; the agent just makes the cost -visible sooner, because an agent does not ask. - -*Enforced by:* review, plus publishing skills so agent-facing guidance tracks the library version -rather than a repository's memory of it. - -*At your scale:* always. `AGENTS.md` is cheaper than the questions it prevents. - -## 10. A change is verified in proportion to its risk - -Checks are tiered, and a repository declares which tiers its pipeline runs. A pull request runs the -fast tier; the slow tier runs deliberately, locally or on a dedicated runner. - -A pipeline that runs everything on every pull request gets made optional. One that runs too little -gets ignored. Tiering is what keeps the gate credible. - -*Enforced by:* the pipeline's `TestFilter` and the test project's own **name** — the SDK categorises -a `*UnitTests` project as `Unit`, so the tier is a property of the project rather than of a -hand-written attribute. - -*At your scale:* one tier is fine until the slow tests exist. Then split by project name, not by -attribute. - -## 11. A version is a range, not a number - -An application takes the latest version its runtime supports. A published component declares the -**lowest** version that compiles, passes its tests and satisfies the contract it documents, on each -target framework it claims — because dependency resolution is a set of lower bounds, so the floor a -component declares becomes the floor every consumer inherits. - -A page states no release number. It shows a badge generated from the registry, or links to the -registry, so a version cannot be wrong within a release. - -*Enforced by:* a lowest-compatible CI leg that restores against the declared floor, and an -API-compatibility check per target framework. Nothing enforces the floor of a package that has no -consumer yet — that tier arrives with the first release. - -*At your scale:* with one application there is nothing to earn yet; take the latest and let -`dotnet list package --outdated` report the rest. The golden rule starts at the first published package. - -## Applying these in review - -Three questions catch most of it: - -1. **Is this configuration, or is it a default the SDK should own?** If two repositories would copy - it, it belongs in the SDK. -2. **Is this rule enforced, or merely stated?** If stated, say so where it is stated. -3. **Could an agent — or a new joiner — find this without being told?** If not, it goes in - `AGENTS.md` or the wiki. - -## The conditional persistence rules - -Three further rules apply only when a repository actually stores data: a value known before storage is -derived with UUIDv5, every other GUID key uses one strategy per store, and EF Core is the persistence -boundary. They are not part of the eleven because a stateless CLI or a pure library must not inherit them. -`purview-persistence` owns them and stays silent when persistence is not real. - -## Related skills - -`purview-architecture` for project-shape decisions, `purview-architecture-testing` for turning a -boundary into a failing build, `purview-telemetry` and `purview-persistence` for the per-concern -guidance, and `purview-component-compatibility` for deciding and verifying a published component's -lowest compatible dependency versions. diff --git a/.agents/skills/purview-org-harvest/SKILL.md b/.agents/skills/purview-org-harvest/SKILL.md deleted file mode 100644 index 2c05ea1..0000000 --- a/.agents/skills/purview-org-harvest/SKILL.md +++ /dev/null @@ -1,197 +0,0 @@ ---- -name: purview-org-harvest -description: >- - Use when a Purview repository's conventions may have fallen behind the organisation - - inventorying every public purview-dev repository at main, deciding which repository is - best-in-class for each concern before adopting anything, and recording the result in a dated - snapshot. Always reads the remote: a local clone is a cache, and it may be stale, renamed or - missing entirely. -license: MIT -metadata: - author: Purview-Dev - version: "1.0" - repository: purview-dev/engineering-playbook ---- - -# Purview organisation harvest - -Seventeen public repositories, each with its own wiki, its own `skills/` folder and its own `AGENTS.md`. -They are not equally up to date, and the one you have cloned is not necessarily the one that has the -answer. Two failures follow, and this skill exists to prevent both. - -**Copying from a stale clone.** A clone is a cache with no expiry. The convention you read there may -be two months behind the one the owner now documents, and nothing about the local file says so. - -**Copying from the wrong owner.** "How do we ship?" is answered by `build`. "How do we keep a boundary -honest?" is answered by `architests`. Asking a library that does neither produces a confident answer -with no evidence, which is worse than no answer. - -So: establish membership, read at `main`, name one owner per concern, write down what you found. - -## 1. Scope - -Name two things before reading anything: - -| Input | Example | -| -- | -- | -| The repository being changed | `containers` | -| The concern in question | "how a test reaches a real database" | - -A harvest without a named concern becomes a tour, and a tour produces a list of differences nobody -acted on. The concern is what makes "best-in-class" a decision rather than a preference. - -## 2. Discover membership - -`gh repo list` is the membership authority. A catalogue, a README table, an `llms.txt` and a local -folder listing are all convenience indexes: they are maintained by hand, so they under-count, and the -omission is silent. - -```bash -gh auth status -gh repo list purview-dev --limit 200 \ - --json name,visibility,isArchived,pushedAt,defaultBranchRef -``` - -Drop `isArchived` and anything that is not `PUBLIC`. **If `gh auth status` fails, stop.** Degrading to -the local clone is the exact failure this skill prevents, and it degrades silently. - -The filter denies by default: a repository must be exactly `PUBLIC` and exactly not archived to be -recorded, so a visibility you have never seen fails closed. `gh repo list` also only lists what your -token can see, which is why the token's visibility and the file's contents are two separate questions: -the section below is about the second one. - -A local clone is admissible only when its `HEAD` equals the SHA the snapshot recorded: - -```bash -git -C ../containers rev-parse HEAD -``` - -That is a speed optimisation, never a substitute. - -## 3. Read it at `main` - -Every repository is read at `main`, and the commit is recorded. The snapshot is what makes the claim -checkable a month later, when nobody remembers which commit the analysis saw. - -```bash -node scripts/inventory.mjs # drift between the organisation and the snapshot -node scripts/inventory.mjs --write # regenerate .config/org-inventory.json -node scripts/inventory.mjs --repo containers -``` - -The script is deterministic and dependency-free: it shells out to `gh`, so it reuses the CLI's own -authentication, and it runs the same on Windows and on a Linux agent — it is Node, not a shell script, -so there is no PowerShell edition and no Bash edition to keep in step. It writes -`.config/org-inventory.json` in the repository you run it from — generated, never hand-edited. - -To inspect a decision without a network call, replay a recorded harvest with `--from` and `--details`. -That is the same script, not a variant, so what you review is what runs. - -## 4. Harvest in two tiers - -Seventeen repositories is not a reading list; it is a budget. Two tiers keep it affordable. - -| Tier | Call | Answers | -| -- | -- | -- | -| 1 — shape | `gh api repos/purview-dev//git/trees/main?recursive=1`, for all seventeen | Which folders exist, how many pages the wiki has, whether `skills/` is authored, whether `AGENTS.md` exists. Cheap enough for everything. | -| 2 — content | `gh api -H 'Accept: application/vnd.github.raw' repos/purview-dev//contents/`, **only for the owner of the concern** | What the convention actually says. | - -Tier 1 tells you where the evidence is. Tier 2 reads it, in the one repository that wrote it down. - -```bash -gh api repos/purview-dev/architests/git/trees/main?recursive=1 --jq '.tree[].path' -gh api -H 'Accept: application/vnd.github.raw' \ - repos/purview-dev/architests/contents/docs/wiki/Architecture-As-Tests.md -``` - -More invocations, and what each one is for: `references/harvest-commands.md`. - -## 5. Classify: one owner per concern - -Pick exactly one owner per concern, from `references/best-in-class.md`. Two signs the classification -is wrong: - -- **Two owners for one concern.** `build-sdk` and this playbook's `purview-engineering-principles` - both answer "review this repository". That overlap is a finding to resolve, not a tie to break by - preferring whichever you read first. -- **An owner that has never run the thing it documents.** Check the tree before trusting the page. - -## 6. Divergence register - -Write the differences down before changing anything, with an adopt-or-reject for each. A divergence -with no decision recorded is the same divergence next quarter. - -| Column | Answers | -| -- | -- | -| Concern | What is being compared | -| Owner | The repository the convention comes from, and the path it is stated at | -| Here | What this repository does now | -| Decision | Adopt, or reject with the reason | -| Mechanism | The build rule, test or review obligation that keeps it true | - -Rejecting is a legitimate outcome and is usually the right one at a smaller scale. What is not -legitimate is adopting a convention whose failure the repository cannot have. - -## 7. Adopt - -A convention arrives as a set of changes that land together, or it is a claim with no mechanism: - -```text -the page states the rule, why, how it is enforced, and what a smaller repository does instead -src/ demonstrates it, or says why it does not -the snapshot records the commit it was read at -the skill points at the owner, and never paraphrases it -``` - -**Link to the owner; do not restate it.** A paraphrase is a second source of truth, and the copy with -no owner is the one that loses. - -## 8. Verify - -```bash -just build # zero warnings -just test # architecture, skill and documentation rules -just lint-check -node scripts/inventory.mjs --print -``` - -If the harvest changed what the snapshot should record, regenerate it and commit the diff. The -snapshot being current is a review obligation rather than a build failure — a build that goes red on -a Tuesday because a clock passed is a build people disable. - -## Private repositories - -A private repository may inform a maintainer's judgement. It is never evidence, and it is never -written down. This is not a preference, and it is not a heuristic an agent gets to weigh against a -good argument. Five statements, in order of how often they are broken: - -1. A committed snapshot contains public, non-archived repositories only. The writer denies by default - and refuses to persist anything else, and a test asserts it. -2. A private repository may be read when `gh` is authenticated for it, and what it teaches may shape - a rule. -3. Nothing published names it: not the snapshot, not the page, not the skill, not a workflow, not a - config, not a commit message. Attribute the rule to "a Purview application repository", or to - nothing. -4. **If a rule cannot be justified without the private source, it is not published.** -5. **If you cannot say where a name came from, do not write the name.** A repository the snapshot - does not list is either private or gone, and both fail the same test. - -The fourth is the one an agent rationalises around, because the evidence is often excellent. A rule -whose only justification is out of reach of the people it is published to cannot be reviewed by them, -which makes it folklore with a citation they cannot follow. - -## Checks before you answer - -- Did you read membership from the organisation rather than from a catalogue or a folder? -- Is every claim about a repository true at the SHA the snapshot recorded, not at your clone? -- Did you name exactly one owner per concern, and resolve any overlap rather than duplicating it? -- Did you reject anything? A harvest with no rejections usually means nothing was understood. -- Does every change you propose have a mechanism, or is it labelled a review obligation? -- Is every repository you named public? - -## See also - -- `references/best-in-class.md` — which repository owns which concern, and where to read it -- `references/harvest-commands.md` — the `gh` invocations, and the trap in each one -- `purview-engineering-principles` — the conventions themselves, once you know which owner to read -- `purview-architecture` — the project-shape decisions a harvest most often touches diff --git a/.agents/skills/purview-org-harvest/references/best-in-class.md b/.agents/skills/purview-org-harvest/references/best-in-class.md deleted file mode 100644 index 9ab69cc..0000000 --- a/.agents/skills/purview-org-harvest/references/best-in-class.md +++ /dev/null @@ -1,77 +0,0 @@ -# Best-in-class, by concern - -One owner per concern. Read the owner, not the nearest repository that happens to have a wiki. - -Every row was read from the organisation with `gh repo list purview-dev` and -`gh api repos//git/trees/main?recursive=1`. The page counts and skill counts are the shape at -the time of writing, not a promise: they are what the snapshot records, and the snapshot is -regenerated rather than trusted. - -## The matrix - -| Concern | Owner | Read it at | -| -- | -- | -- | -| Repository shape, MSBuild defaults, analyzers, skill authoring | `build-sdk` | `docs/wiki`, `templates/`, `skills/purview-buildsdk-*` | -| Pipeline, release, pack validation | `build` | `docs/wiki`, `skills/purview-build-*` | -| Architecture policy: dependency direction, naming rules | `architests` | `docs` (nine pages; `Policy-Reference.md` is the reference, `Extending.md` the how-to), `skills/purview-architests-*` | -| Local dependencies in tests | `containers` | `docs/wiki`, `skills/purview-containers-*` | -| TypeScript contracts generated from C# | `zodsharp` | `docs/wiki`, `skills/purview-zodsharp-*` | -| Logging, tracing, metrics | `telemetry-sourcegenerator` | `docs/wiki`, `skills/purview-telemetry-*` | -| Event streams and event storage | `event-sourcing` | `docs/wiki` — **no skills folder** | -| Operation outcomes without exceptions | `results` | `docs/wiki`, `skills/purview-results-*` | -| Validated identity types | `value-objects` | `docs` — **no `docs/wiki`** | -| Aspire hosting resources | `aspire-resourcekit` | `docs/wiki`, `skills/purview-resourcekit-*` | -| Architecture diagrams generated from source | `aspirec4` | `docs/wiki`, `skills/purview-aspirec4-*` | -| LikeC4 diagrams inside an Astro or Starlight site | `astroc4` | `docs/wiki`, `skills/purview-astroc4-*` — an npm package, not .NET | -| Source generator authoring | `sourcegenerator-framework` | `docs/wiki`, `skills/purview-sourcegenerator-*` | -| Skill-set design, and the dated-snapshot pattern | `pm-skills` | `skills/pm-*` — **no documentation folder at all** | -| OpenAPI generated from XML comments | `openapi-xmlcomments` | `docs/wiki`, `skills/purview-openapi-xmlcomments-*` | -| The reusable conventions themselves | `engineering-playbook` | `docs/wiki`, `skills/purview-*` | -| The public project catalogue | `purview-dev.github.io` | `src/src/data/projects/*.yml` | - -`purview-dev.github.io` is the catalogue, and a catalogue is an index rather than a membership list: -an entry is added by hand, so a repository missing from it is silent. `gh repo list` is the authority. - -## The overlaps worth knowing about - -**`build-sdk` and `engineering-playbook` both answer "review this repository".** They are not -duplicates, and the split is worth stating because a harvest will hit it immediately: - -- `build-sdk` owns *what the tooling does* — project detection, the props and targets, the analyzer - set, the packaged test-support rule sets. -- `engineering-playbook` owns *why a repository is shaped that way, and what it costs* — the rule, - the failure it prevents, and what a smaller repository does instead. - -A question about a property name goes to `build-sdk`. A question about whether a project should exist -goes here. - -**`containers` and `aspire-resourcekit` both look like "local dependencies".** `containers` owns the -test-time resource — a real SQL Server, PostgreSQL or queue — and `aspire-resourcekit` owns the -development-time orchestration. A test that needs a database is `containers`; an AppHost that needs -one is `aspire-resourcekit`. - -**`aspirec4` and `astroc4` both draw LikeC4 diagrams.** `aspirec4` owns the diagram generated from a -running Aspire resource graph; `astroc4` owns putting a `.c4` model inside an Astro or Starlight site — -the fence transform and the LikeC4 syntax highlighting. A question about the .NET host is `aspirec4`; a -question about the documentation site is `astroc4`, which is the one owner here that is not a .NET -package, so it is read for its TypeScript conventions rather than for its MSBuild ones. - -## Reading a repository you have not cloned - -Tier 1 first — the shape, for everything: - -```bash -gh api repos/purview-dev//git/trees/main?recursive=1 --jq '.tree[].path' -``` - -Then Tier 2 — the content, for the one owner: - -```bash -gh api -H 'Accept: application/vnd.github.raw' \ - repos/purview-dev//contents/docs/wiki/_Sidebar.md -``` - -`_Sidebar.md` is the fastest index of a wiki, because the repository's own documentation rule says a -page that is not in it does not exist. Where a repository publishes no wiki, its `AGENTS.md` is the -next best entry point, and where it has neither, read `skills/*/SKILL.md` — the trigger in each -`description` says what the repository thinks it is for. diff --git a/.agents/skills/purview-org-harvest/references/harvest-commands.md b/.agents/skills/purview-org-harvest/references/harvest-commands.md deleted file mode 100644 index f4b4653..0000000 --- a/.agents/skills/purview-org-harvest/references/harvest-commands.md +++ /dev/null @@ -1,121 +0,0 @@ -# Harvest commands - -Every invocation here is safe to run read-only, and each one is followed by the trap that cost -somebody time. Both shells are shown because the harvest runs on a developer's Windows machine and on -a Linux agent, and the quoting rules are not the same. - -## Membership - -```bash -gh auth status -gh repo list purview-dev --limit 200 --json name,visibility,isArchived,pushedAt,defaultBranchRef -``` - -```powershell -gh auth status -gh repo list purview-dev --limit 200 --json name,visibility,isArchived,pushedAt,defaultBranchRef | - ConvertFrom-Json | Sort-Object name | - Format-Table name, visibility, isArchived, pushedAt -``` - -**Trap: the default limit is 30.** Without `--limit` the list is silently short, and a short list is -worse than a failed one because the omission never announces itself. - -**Trap: `gh repo list` shows what your token can see.** An organisation member sees private -repositories too; filter to `visibility -eq 'PUBLIC'` and `-not isArchived` before recording anything. - -## The SHA a convention was read at - -```bash -gh api repos/purview-dev//git/ref/heads/main --jq .object.sha -``` - -**Trap: a renamed repository resolves by redirect.** Asking for a repository under its former name -answers `purview-dev/purview-dev.github.io` and exits 0, so a stale name never fails. Compare the -returned `full_name` with the name you asked for. - -## Tier 1: the shape - -```bash -gh api repos/purview-dev//git/trees/main?recursive=1 --jq '.tree[].path' -``` - -**Trap: `truncated`.** GitHub caps a recursive tree, and the response says so with `"truncated": true` -rather than erroring. A truncated tree under-counts skills and pages, so check the flag before -believing a zero. - -**Trap: the tree lists blobs and trees.** Filter to `type == "blob"` when counting files, or a folder -whose name matches your pattern is counted as its contents. - -## Tier 2: the content - -```bash -gh api -H 'Accept: application/vnd.github.raw' \ - repos/purview-dev//contents/docs/wiki/_Sidebar.md -``` - -**Trap: `contents` returns JSON unless you ask for raw.** Without the `Accept` header the response is -a base64 `content` field, and the analysis quietly proceeds on a JSON document. - -**Trap: `contents` caps at 1000 files for a directory listing.** Use the tree API for enumerating and -`contents` for reading one file. - -## Windows PowerShell, specifically - -**Embedded double quotes are stripped from a native command's arguments.** This looks correct and is -not: - -```powershell -gh repo list purview-dev --jq '.[] | [.name, (.pushedAt // "-")] | @tsv' -``` - -`gh` receives `// -` and answers `failed to parse jq expression ... unexpected token`. Either keep the -jq program free of string literals, or do the shaping in PowerShell: - -```powershell -$repos = gh repo list purview-dev --limit 200 --json name,visibility | ConvertFrom-Json -$repos | Sort-Object name | ForEach-Object { '{0}|{1}' -f $_.name, $_.visibility } -``` - -**A filtered result is a scalar when it is one item.** `(... | Where-Object { ... }).Count` returns -nothing rather than `1`, so `.Count` in a summary line reads as empty. Wrap it: `@(...).Count`. - -## The snapshot - -```bash -node skills/purview-org-harvest/scripts/inventory.mjs -node skills/purview-org-harvest/scripts/inventory.mjs --write -node skills/purview-org-harvest/scripts/inventory.mjs --repo containers --write -``` - -It resolves the snapshot path from `git rev-parse --show-toplevel`, so it writes into the repository -you are standing in rather than into the one the script was installed from. That is what lets another -repository adopt it unchanged. - -`--repo` merges on write, so reading one repository does not erase the other sixteen. - -## Replaying a harvest, with no network - -Two flags replace the two `gh` calls. This is how the repository's own tests exercise the script on -every platform without touching GitHub, and how a reviewer reproduces what a harvest decided: - -```bash -node skills/purview-org-harvest/scripts/inventory.mjs \ - --from recorded-membership.json \ - --details recorded-details.json \ - --print -``` - -`--from` takes exactly what `gh repo list --json name,visibility,isArchived,pushedAt,defaultBranchRef` -printed. `--details` takes an object keyed by repository name, each with the `commitSha` a tier-1 -harvest found and the `paths` the tree contained. A repository that is in the membership and missing -from the details is an error, not a silent omission — a replay that quietly skipped a repository would -look like a clean run. - -Two behaviours worth knowing before you trust a run: - -- **A snapshot carrying a byte-order mark is accepted.** It is the one file in this workflow a person - is likely to open and re-save, and a BOM is not a corruption. -- **A snapshot containing anything that is not public and unarchived is refused**, and nothing is - written. This includes an entry a hand edit left behind, which the merge would otherwise carry - forward: delete it and re-run `--write`. diff --git a/.agents/skills/purview-org-harvest/scripts/inventory.mjs b/.agents/skills/purview-org-harvest/scripts/inventory.mjs deleted file mode 100644 index affc46f..0000000 --- a/.agents/skills/purview-org-harvest/scripts/inventory.mjs +++ /dev/null @@ -1,466 +0,0 @@ -#!/usr/bin/env node -/** - * Snapshots every public, non-archived `purview-dev` repository at `main` into - * `.config/org-inventory.json`, and reports the drift between that snapshot and the organisation. - * - * The snapshot is what makes the harvest rule checkable offline: `OrgInventoryTests` reads the file - * the pipeline has, never the network. This script is the only thing that writes it, so a repository - * cannot appear in the snapshot by being remembered. - * - * Zero dependencies: it shells out to `gh` and so reuses the CLI's own authentication rather than - * asking for a token. - * - * node inventory.mjs # print the drift against the snapshot (default) - * node inventory.mjs --write # rewrite the snapshot from the organisation - * node inventory.mjs --repo containers # narrow to one repository; merges on --write - * node inventory.mjs --out # write somewhere else, e.g. while adopting the skill - * node inventory.mjs --help - * - * Exit codes: 0 on success, including when drift is found - a stale snapshot is a review obligation, - * not a red pull request for whoever happened to push next. 1 when `gh` is missing, unauthenticated, - * or the organisation cannot be read. - */ -import { execFileSync } from "node:child_process"; -import { existsSync, mkdirSync, readFileSync, writeFileSync } from "node:fs"; -import { dirname, join } from "node:path"; - -/** The organisation this playbook describes. */ -const ORG = "purview-dev"; - -/** The branch a convention is read at. A local clone is a cache; this is the authority. */ -const BRANCH = "main"; - -/** Bumped when a field is added or its meaning changes. */ -const SCHEMA_VERSION = 1; - -/** Past this age the snapshot is reported as stale. Advisory: nothing fails on a clock. */ -const STALE_AFTER_DAYS = 30; - -/** Files a repository may put at its root to guide an agent. Recorded in this order. */ -const AGENT_GUIDANCE_FILES = ["AGENTS.md", "CLAUDE.md", ".github/copilot-instructions.md", "llms.txt"]; - -/** Directories a published documentation site is read from, most specific first. */ -const DOCS_DIRECTORIES = ["docs/wiki", "docs"]; - -/** - * The concern each repository is best-in-class for, so a harvest reads one owner instead of sixteen - * repositories. `references/best-in-class.md` is the long form of this table and is the file to edit - * first; this map only records the answer in the snapshot. - */ -const CONCERNS = new Map([ - ["architests", ["architecture policy", "dependency and naming rules"]], - ["aspire-resourcekit", ["Aspire hosting resources"]], - ["aspirec4", ["architecture diagrams from source"]], - ["astroc4", ["architecture diagrams in an Astro site"]], - ["build", ["pipeline", "release"]], - ["build-sdk", ["repository shape", "analyzers and style", "MSBuild defaults", "skill authoring"]], - ["containers", ["local dependencies in tests"]], - ["engineering-playbook", ["the conventions themselves"]], - ["event-sourcing", ["event streams", "event storage"]], - ["openapi-xmlcomments", ["OpenAPI from XML comments"]], - ["pm-skills", ["skill-set design"]], - ["purview-dev.github.io", ["the public project catalogue"]], - ["results", ["operation outcomes"]], - ["sourcegenerator-framework", ["source generator authoring"]], - ["telemetry-sourcegenerator", ["logging", "tracing", "metrics"]], - ["value-objects", ["validated identity types"]], - ["zodsharp", ["TypeScript contracts from C#"]], -]); - -/** Runs `gh` and returns stdout, turning a CLI failure into an actionable message. */ -function gh(args) { - try { - return execFileSync("gh", args, { - encoding: "utf8", - maxBuffer: 256 * 1024 * 1024, - stdio: ["ignore", "pipe", "pipe"], - }); - } catch (error) { - const detail = (error.stderr ?? "").toString().trim() || error.message; - throw new Error( - `gh ${args.join(" ")} failed.\n${detail}\n\n` + - "This script reads the organisation, not a local clone. Run `gh auth status`, then retry.", - ); - } -} - -/** Calls one GitHub REST endpoint and parses the JSON response. */ -function api(endpoint) { - return JSON.parse(gh(["api", endpoint])); -} - -/** The root of the repository the command was run in, so the skill works from any repository. */ -function repositoryRoot() { - try { - return execFileSync("git", ["rev-parse", "--show-toplevel"], { - encoding: "utf8", - stdio: ["ignore", "pipe", "pipe"], - }).trim(); - } catch { - throw new Error("Not inside a git repository. Run this from a clone, or pass --out ."); - } -} - -/** Membership, as the organisation reports it. The catalogue is a convenience index, not the list. */ -function readMembership(source) { - const listed = source - ? JSON.parse(readFileSync(source, "utf8")) - : JSON.parse( - gh([ - "repo", - "list", - ORG, - "--limit", - "200", - "--json", - "name,visibility,isArchived,pushedAt,defaultBranchRef", - ]), - ); - - return ( - listed - // Deny by default. The filter is "exactly public and not archived" rather than "not - // private", so a visibility value this script has never seen fails closed instead of - // falling through into a file that is committed to a public repository. - .filter((repository) => repository.visibility === "PUBLIC" && repository.isArchived === false) - .sort((left, right) => left.name.localeCompare(right.name, "en")) - ); -} - -/** The recorded commit and file list for each repository, when a run replays a previous harvest. */ -function readDetails(source) { - return new Map(Object.entries(JSON.parse(readFileSync(source, "utf8")))); -} - -/** The Markdown pages directly inside a docs directory. */ -function countPages(paths, directory) { - const prefix = `${directory}/`; - return paths.filter((path) => { - if (!path.startsWith(prefix)) { - return false; - } - - const remainder = path.slice(prefix.length); - return remainder.endsWith(".md") && !remainder.includes("/"); - }).length; -} - -/** A skill is a folder under `skills/` that carries a `SKILL.md`. */ -function authoredSkills(paths) { - const names = paths - .filter((path) => /^skills\/[^/]+\/SKILL\.md$/.test(path)) - .map((path) => path.split("/")[1]); - - return [...new Set(names)].sort((left, right) => left.localeCompare(right, "en")); -} - -/** Everything the snapshot records about one repository, read at `BRANCH`. */ -function describeRepository(repository, details) { - // The filter above already excluded these, and this is the second lock on the same door: a - // private repository must never reach the snapshot, so the guard is here as well as there. - if (repository.visibility !== "PUBLIC" || repository.isArchived !== false) { - throw new Error( - `${ORG}/${repository.name} is ${repository.visibility} and archived ${repository.isArchived}. ` + - "The snapshot records public, unarchived repositories only, so nothing was written.", - ); - } - - const defaultBranch = repository.defaultBranchRef?.name ?? BRANCH; - if (defaultBranch !== BRANCH) { - throw new Error( - `${ORG}/${repository.name} has default branch '${defaultBranch}', not '${BRANCH}'. ` + - "The snapshot pins one branch, so either the rule or the repository has to change.", - ); - } - - const recorded = details?.get(repository.name); - if (details && !recorded) { - throw new Error( - `${repository.name} has no recorded detail, so --details cannot describe it. ` + - "Replay a membership the details file was captured with, or run without --details.", - ); - } - - const commitSha = recorded?.commitSha ?? api(`repos/${ORG}/${repository.name}/git/ref/heads/${BRANCH}`).object.sha; - const paths = recorded?.paths ?? readTree(repository.name); - const docsDir = DOCS_DIRECTORIES.find((candidate) => - paths.some((path) => path.startsWith(`${candidate}/`)), - ); - - return { - name: repository.name, - visibility: repository.visibility.toLowerCase(), - archived: repository.isArchived, - commitSha, - pushedAt: repository.pushedAt, - docsDir: docsDir ?? null, - docsPages: docsDir ? countPages(paths, docsDir) : 0, - skills: authoredSkills(paths), - agentGuidance: AGENT_GUIDANCE_FILES.filter((file) => paths.includes(file)), - concerns: CONCERNS.get(repository.name) ?? [], - }; -} - -/** The blob paths of one repository at `BRANCH`. */ -function readTree(name) { - const tree = api(`repos/${ORG}/${name}/git/trees/${BRANCH}?recursive=1`); - - if (tree.truncated) { - process.stderr.write( - `warning: ${name}'s tree is truncated, so its skills and docs are undercounted\n`, - ); - } - - return tree.tree.filter((entry) => entry.type === "blob").map((entry) => entry.path); -} - -/** The snapshot document. */ -function snapshotOf(repositories) { - return { - schemaVersion: SCHEMA_VERSION, - org: ORG, - branch: BRANCH, - fetchedAt: new Date().toISOString().replace(/\.\d{3}Z$/, "Z"), - repositories, - }; -} - -/** The snapshot on disk, or null when the repository has not committed one yet. */ -function readSnapshot(path) { - if (!existsSync(path)) { - return null; - } - - // The snapshot is the one file in this workflow a person is likely to open and save by hand, and - // an editor that writes a byte-order mark produces a file JSON.parse rejects with a message that - // names neither the file nor the cause. - return JSON.parse(readFileSync(path, "utf8").replace(/^\uFEFF/, "")); -} - -/** A field's value in the form the drift report prints. */ -function render(value) { - if (value === null || value === undefined) { - return "none"; - } - - if (Array.isArray(value)) { - return value.length === 0 ? "none" : value.join(", "); - } - - return String(value); -} - -/** A field's value in the form the drift report compares: structured values compare as one string. */ -function fingerprint(value) { - return JSON.stringify(value ?? null); -} - -/** The fields whose change is worth reporting, in the order a reader cares about them. */ -const COMPARED_FIELDS = [ - "commitSha", - "docsDir", - "docsPages", - "skills", - "agentGuidance", - "concerns", - "visibility", - "archived", -]; - -/** The differences between the organisation and the snapshot. */ -function drift(existing, observed) { - const findings = []; - const before = new Map((existing?.repositories ?? []).map((entry) => [entry.name, entry])); - const after = new Map(observed.map((entry) => [entry.name, entry])); - - for (const [name, entry] of after) { - if (!before.has(name)) { - findings.push(`${name}: not in the snapshot`); - continue; - } - - const previous = before.get(name); - for (const field of COMPARED_FIELDS) { - if (fingerprint(previous[field]) === fingerprint(entry[field])) { - continue; - } - - findings.push(`${name}: ${field} ${render(previous[field])} -> ${render(entry[field])}`); - } - } - - for (const name of before.keys()) { - if (!after.has(name)) { - findings.push(`${name}: in the snapshot but no longer a public repository`); - } - } - - return findings; -} - -/** How long ago the snapshot was taken, in whole days, or null when it carries no usable date. */ -function ageInDays(fetchedAt) { - const fetched = Date.parse(fetchedAt ?? ""); - return Number.isNaN(fetched) ? null : Math.floor((Date.now() - fetched) / 86_400_000); -} - -/** Parses the command line. Unknown arguments are a mistake worth failing on. */ -function parseArguments(argv) { - const options = { write: false, repos: [], out: null, from: null, details: null, help: false }; - - for (let index = 0; index < argv.length; index++) { - const argument = argv[index]; - if (argument === "--write") { - options.write = true; - } else if (argument === "--print") { - options.write = false; - } else if (argument === "--help" || argument === "-h") { - options.help = true; - } else if (argument === "--repo") { - const value = argv[++index]; - if (!value) { - throw new Error("--repo needs a repository name."); - } - - options.repos.push(value); - } else if (argument === "--out") { - const value = argv[++index]; - if (!value) { - throw new Error("--out needs a path."); - } - - options.out = value; - } else if (argument === "--from") { - const value = argv[++index]; - if (!value) { - throw new Error("--from needs a path to a recorded `gh repo list` response."); - } - - options.from = value; - } else if (argument === "--details") { - const value = argv[++index]; - if (!value) { - throw new Error("--details needs a path to a recorded detail file."); - } - - options.details = value; - } else { - throw new Error(`Unknown argument '${argument}'. Run with --help.`); - } - } - - return options; -} - -/** The documented usage. */ -const HELP = `Snapshot every public, non-archived ${ORG} repository at ${BRANCH}. - - node inventory.mjs print the drift between the organisation and the snapshot - node inventory.mjs --write rewrite the snapshot from the organisation - node inventory.mjs --repo narrow to one repository; merges when writing - node inventory.mjs --out write somewhere other than .config/org-inventory.json - node inventory.mjs --from replay a recorded "gh repo list --json" response instead of - asking the organisation - node inventory.mjs --details replay recorded commits and file lists, so a run touches no - network at all; pair it with --from - node inventory.mjs --help this text - -The snapshot is generated, never hand-edited. A stale snapshot is a review obligation rather than a -build failure, so drift prints and the exit code stays 0.`; - -/** Runs the command. */ -function main() { - const options = parseArguments(process.argv.slice(2)); - if (options.help) { - console.log(HELP); - return; - } - - const snapshotPath = options.out ?? join(repositoryRoot(), ".config", "org-inventory.json"); - const existing = readSnapshot(snapshotPath); - - let observed = readMembership(options.from); - if (options.repos.length > 0) { - const known = new Set(observed.map((repository) => repository.name)); - for (const name of options.repos) { - if (!known.has(name)) { - throw new Error( - `'${name}' is not a public, non-archived ${ORG} repository. ` + - `Run without --repo to include all ${observed.length}.`, - ); - } - } - - observed = observed.filter((repository) => options.repos.includes(repository.name)); - } - - const details = options.details ? readDetails(options.details) : null; - const described = observed.map((repository) => describeRepository(repository, details)); - - if (options.write) { - const merged = new Map((existing?.repositories ?? []).map((entry) => [entry.name, entry])); - for (const entry of described) { - merged.set(entry.name, entry); - } - - const written = snapshotOf( - [...merged.values()].sort((left, right) => left.name.localeCompare(right.name, "en")), - ); - - // The merge carries forward whatever the file already held, which is how a hand-edited entry - // would survive a regeneration. Refuse to write a snapshot that records anything else. - const notPublic = written.repositories.filter( - (entry) => entry.visibility !== "public" || entry.archived !== false, - ); - if (notPublic.length > 0) { - throw new Error( - "Refusing to write a snapshot that records a repository which is not public and " + - `unarchived: ${notPublic.map((entry) => entry.name).join(", ")}. ` + - "Delete the entries and re-run --write.", - ); - } - - mkdirSync(dirname(snapshotPath), { recursive: true }); - writeFileSync(snapshotPath, `${JSON.stringify(written, null, "\t")}\n`, "utf8"); - console.log( - `wrote ${written.repositories.length} repositories to ${snapshotPath} at ${written.fetchedAt}`, - ); - return; - } - - const findings = drift(existing, described); - const age = ageInDays(existing?.fetchedAt); - - console.log(`${ORG}: ${observed.length} public, non-archived repositories at ${BRANCH}`); - if (existing) { - console.log( - `snapshot: ${existing.repositories?.length ?? 0} repositories, fetched ${existing.fetchedAt}` + - (age === null ? "" : ` (${age} day${age === 1 ? "" : "s"} old)`), - ); - } else { - console.log(`no snapshot at ${snapshotPath} - run with --write to create one`); - } - - if (findings.length === 0) { - console.log("no drift"); - } else { - console.log(`${findings.length} difference${findings.length === 1 ? "" : "s"}:`); - for (const finding of findings) { - console.log(` ${finding}`); - } - } - - if (age !== null && age > STALE_AFTER_DAYS) { - console.log( - `warning: the snapshot is older than ${STALE_AFTER_DAYS} days. ` + - "Re-run with --write and review the diff.", - ); - } -} - -try { - main(); -} catch (error) { - console.error(`error: ${error.message}`); - process.exitCode = 1; -} diff --git a/.agents/skills/purview-persistence/SKILL.md b/.agents/skills/purview-persistence/SKILL.md deleted file mode 100644 index 7d6ad91..0000000 --- a/.agents/skills/purview-persistence/SKILL.md +++ /dev/null @@ -1,149 +0,0 @@ ---- -name: purview-persistence -description: >- - Use when a .NET project actually persists data and you are choosing a storage approach, integrating - or abstracting EF Core, deriving a well-known identifier, or selecting a GUID primary-key strategy. - Gives provider-specific guidance — SQL Server and PostgreSQL differ and must not be treated alike — - and stays silent for projects that do not persist anything. -license: MIT -metadata: - author: Purview-Dev - version: "1.2" - repository: purview-dev/engineering-playbook ---- - -# Purview persistence - -**Activation condition:** this skill applies only when persistence is real. If the project is a -stateless CLI, a pure library, or a service that calls an API and stores nothing, stop here — none of -this is relevant, and raising a database GUID strategy with that project is noise. - -Confirm persistence from the repository before proceeding (see `purview-architecture`): a data-access -`PackageReference`, a `DbContext`, a connection string, or an explicit requirement to store state. - -## 1. Shape the data access proportionally - -| Scale | Shape | -| -- | -- | -| Small | `DbContext` used directly from the code that needs it. No repository, no unit-of-work wrapper — `DbContext` already is both. | -| Medium | A boundary when domain rules must not know about EF Core, or when a query is complex enough to deserve a name. Often that is a few focused query types, not a generic `IRepository`. | -| Large | Independent infrastructure implementations where there genuinely are several, with the dependency direction enforced by a test. | - -**Do not wrap EF Core in a repository for testability.** `Purview.Containers` gives you a real -database in tests, which is both more faithful and less code than an abstraction built to be mocked. -A repository earns its place when you must swap the store or when `DbContext` is genuinely leaking -into domain decisions — not before. - -## 2. Local dependencies - -`Purview.Containers` provides Aspire resource integrations for the dependencies you need in -development and integration tests — including `MsSql`, `PostgreSql`, `MySql`, `Redis`, `Nats`, -`RabbitMq`, `Azurite` and an Azure Key Vault emulator. Prefer a real container over an in-memory -provider: the in-memory provider does not enforce the constraints that break you in production. - -## 3. EF Core integration - -When EF Core is the store, keep the integration in four places: - -- **`DbContext` is the boundary.** Use it directly; do not add `IRepository` or a unit-of-work wrapper - for testability. `Purview.Containers` gives you a real database in tests. -- **Choose the provider where the context is registered.** Carry the choice as context-options data, not - a `Database.ProviderName` branch at model-build time. -- **Map value objects once.** Configure converters and comparers in the model, not per property. A - value-object key needs a converter-aware value generator. -- **Keep design time and runtime in step.** Both paths make the same provider, strategy and - `ReplaceService` choices, or the migration snapshot describes a different model. - -Migrations are code, reviewed and applied by a deliberate step; the API does not migrate at startup in -production. The full rule, composition sample and checks are in `references/ef-core-integration.md`. - -## 4. Identifiers — derived or generated - -Two decisions live here, and they are independent. Ask them in this order. - -### The deterministic-identifier gate - -Derive an identifier only when its **value must be known before storage** — a system tenant, a seeded -reference row, an installation's service principal, or an ingested object whose provider key is stable -and never recycled. Then derive it with UUIDv5 over an installation-scoped namespace and configure -`ValueGeneratedNever()`, so the sequential convention below leaves it alone. A project with random keys -and no seeding has no use for UUIDv5. An outbox row that merely needs an id before `SaveChanges` takes -the generated strategy below, not a derived one. - -The full rule, catalogue, naming rules, migration caveat and tests are in -`references/well-known-identifiers.md`. - -### The generated-key decision - -Resolve these before recommending anything; most are answered by the repository: - -1. Are GUIDs primary keys, or merely external identifiers over an integer key? -2. Is the value generated by the application or by the database? -3. Which provider, and which version? -4. Does index locality matter at the expected write volume? -5. Must the identifier exist before the row is persisted? - -Question 5 usually decides it. If the application needs the identifier before `SaveChanges` — for an -outbox row, a correlation value, or to build an object graph client-side — the database cannot be the -generator, and the remaining questions are about *which* client-side strategy. - -### The rule that matters most - -**SQL Server and PostgreSQL do not benefit from the same sequential GUID implementation.** Their -index structures and their GUID comparison semantics differ, and a "sequential GUID" that helps one -can be no better than random on the other. Never carry a strategy from one to the other without -re-deriving it. - -- SQL Server specifics: `references/sqlserver.md` -- PostgreSQL specifics: `references/postgresql.md` -- Choosing between them, and when a custom generator is justified: `references/guid-generation.md` - -### Prefer built-in capability - -Use the framework or database capability when it is sufficient — `Guid.CreateVersion7()` on .NET 9+, -`NEWSEQUENTIALID()`, EF Core's own value generators, a provider's native UUIDv7 function. A custom -generator is a maintenance obligation and a correctness risk; introduce one only against a measured -requirement. - -**No NuGet package provides this pattern.** A reviewed generator such as `FastGuid` supplies a -store-ordered implementation, but the strategy witness, options extension, value generator with -value-converter support, and model-finalising convention are repository-local: copy them, do not depend -on a package that claims to own the wiring. Introduce it only for a measured requirement: a second -provider, or an identifier needed before `SaveChanges`. Until the second provider exists, a built-in -capability is the answer. - -## 5. Value objects as keys - -`Purview.ValueObjects` gives strongly-typed identifiers that stop an `OrderId` being passed where a -`CustomerId` belongs. They need an EF Core value converter; configure it once in the model rather -than per property. - -This is about type safety at the boundary, not about the generation strategy — the two decisions are -independent. - -## 6. Migrations and schema - -- Migrations are code: reviewed, tested against a real container, and applied by a deliberate step — - not by the application at startup in production. -- Expect the schema to be ahead of or behind the code during a deployment; design changes to be - compatible in both directions. -- Keep the connection string out of source. Keep it out of telemetry too. - -## Checks before you answer - -- Have you confirmed persistence is actually required? -- If the project uses EF Core, are you recommending the `DbContext` directly rather than a repository - wrapper added for testability? -- Does the design-time path make the same provider and strategy choices as the runtime path? -- Does every generated value have one owner — application, store or derivation — and no second writer? -- If you are deriving an identifier, is its value genuinely known before storage, and is it keyed - `ValueGeneratedNever()`? -- If you are recommending a GUID strategy, do you know the provider *and* its version? -- If you are proposing the strategy/convention, is there a second provider or a pre-save identifier? -- Are you proposing an abstraction you can justify by something other than testability? -- Have you preferred a built-in capability over a custom generator? - -## See also - -- `purview-architecture` — context discovery and proportional structure -- `purview-telemetry` — instrument the data access too; it is where the latency is diff --git a/.agents/skills/purview-persistence/references/ef-core-integration.md b/.agents/skills/purview-persistence/references/ef-core-integration.md deleted file mode 100644 index 77c7573..0000000 --- a/.agents/skills/purview-persistence/references/ef-core-integration.md +++ /dev/null @@ -1,83 +0,0 @@ -# EF Core integration - -Read this when the project actually uses EF Core. The identifier decisions are in `guid-generation.md` -and `well-known-identifiers.md`; this page is the rest of the integration. - -## The rule - -1. **`DbContext` is the boundary.** Read and write through it directly, or through a narrow query type - when a query deserves a name. Do not add `IRepository` or a unit-of-work wrapper for testability. - `DbContext` already is both, and a real container is a more faithful test than a substitute. -2. **The provider is chosen where the context is registered.** Carry the choice as context-options data; - never branch on `Database.ProviderName` while the model is being built. The model is built once and - cached, so that branch serves one provider's model to the other. -3. **Map a value object once.** Configure the converter and comparer in the model, not on each property. - The `Purview.ValueObjects` generator emits the converters when EF Core is referenced. A value-object - key also needs a converter-aware value generator, or the property receives a raw `Guid`. -4. **One owner per generated value.** The application supplies it, the store generates it, or it is - derived — never two. A derived identifier is `ValueGeneratedNever()`; a store default or computed - column is left to the store. -5. **Design time and runtime agree.** The design-time factory or host registration makes the same - provider, strategy and `ReplaceService` choices as the application. Otherwise the migration snapshot - describes a model the application does not run. -6. **The model cache key covers every input that varies the model.** Provider, strategy, tenant and - design time. EF's service-provider cache and model cache are separate; both need a key that matches - the decision. -7. **Migrations are code.** Persistence owns the definitions; a deliberate step applies them. The API - does not migrate at startup in production. -8. **Integration tests use a real store.** The in-memory provider does not enforce foreign keys, unique - indexes, computed columns or SQL semantics. Use `Purview.Containers` and a `.IntegrationTests` - project. -9. **The connection string is configuration.** Keep it out of source, out of `appsettings.json` in the - repository, and out of telemetry. A redaction test is worth more than a convention. - -## The composition - -The provider, the strategy and the service replacements belong together, where the context is -registered: - -```csharp -services.AddDbContext>((serviceProvider, options) => -{ - ConfigureStore(options, connectionString); - - options - .UseSequentialGuids() - .ReplaceService() - .ReplaceService>(); -}); - -services.AddSingleton>(); -``` - -- `ConfigureStore` is the only place that names `UseSqlServer` or `UseNpgsql`. -- `UseSequentialGuids` adds an options extension; the model reads it instead of asking about the provider. -- `IModelCacheKeyFactory` is replaced because the service-provider hash alone does not key the model - cache. -- The application-facing factory is registered separately, because EF's internal registration is not - reachable from an outbox writer or a correlation-id generator. - -## Migrations - -- Generation and application are separate: `dotnet ef migrations add` in development, a controlled - `Migrator` step in a deployment. -- A migration and `HasData` are compiled and replayed, so they need a literal GUID. A derived identifier - cannot be computed there; print the constant from the derivation and guard it with a test. -- Expect the schema to be ahead of or behind the code during a rollout, and design the change to be - compatible in both directions. -- Never let the API apply migrations at startup in production: a deploy then mutates the schema without - review and without a clean rollback. - -## Checks to write - -| Check | Shape | -| -- | -- | -| Model covers every GUID key | Each non-foreign-key GUID key is generated on add with the expected factory | -| Foreign keys are not generated | A foreign-key GUID keeps the value copied from its principal | -| Explicit configuration wins | A `ValueGeneratedNever()` key keeps its supplied value through `SaveChanges` | -| Two strategies, one context type | Different strategies produce different service providers and models | -| Design time matches runtime | Both models produce the same migration snapshot | -| Real store semantics | A unique index, a foreign key and a computed column behave as the model says in a container | - -The Engineering Playbook's *EF Core Integration* page states the same rules with the sample as evidence; -the runnable implementation is `samples/Acme.Persistence` in that repository, run with `just samples`. diff --git a/.agents/skills/purview-persistence/references/guid-generation.md b/.agents/skills/purview-persistence/references/guid-generation.md deleted file mode 100644 index fb644bb..0000000 --- a/.agents/skills/purview-persistence/references/guid-generation.md +++ /dev/null @@ -1,103 +0,0 @@ -# Choosing a GUID generation strategy - -The cross-provider decision procedure. Provider detail lives in `sqlserver.md` and `postgresql.md`. - -## Step 0 — is this question in scope? - -Ask nothing and recommend nothing unless **both** are true: - -- The project persists data, and -- GUIDs are (or are about to be) primary keys. - -A stateless CLI, a pure library, a service with an integer key, or a project using GUIDs only as -external correlation identifiers does not need this decision. Raising it anyway is the failure this -page is written to prevent. - -## Step 1 — must the identifier exist before persistence? - -This question decides more than any other. - -**Yes** — the application needs the value before `SaveChanges` for an outbox row, a correlation -identifier, an object graph built client-side, or an identifier returned before commit. The database -cannot be the generator. Go to step 2 with client-side options only. - -**No** — the database may generate it, and database generation is available to you. - -## Step 2 — which provider, and which version? - -Do not skip the version. It changes the available options materially: - -| Provider | Version matters because | -| -- | -- | -| SQL Server | `NEWSEQUENTIALID()` is long-standing; the comparison semantics that make byte-ordered UUIDs useless have never changed | -| PostgreSQL | Native `uuidv7()` exists only from 18; `gen_random_uuid()` is built in from 13 | -| .NET | `Guid.CreateVersion7()` exists from .NET 9 | - -**The two databases do not share an answer.** SQL Server compares `uniqueidentifier` with the last -six bytes most significant, so a byte-ordered UUIDv7 is effectively random to its clustered index. -PostgreSQL compares `uuid` in byte order, so UUIDv7 is genuinely sequential there. A strategy that is -optimal on one is unremarkable or wrong on the other. - -## Step 3 — does locality actually matter? - -Sequential keys exist to reduce index fragmentation and page splits under write pressure. If the -table takes tens of inserts a minute, this is not your problem and a random GUID is the simpler, -more private choice. - -Reach for a sequential strategy when you can point at write volume, measured fragmentation, page -splits, or buffer-pool pressure. "It's best practice" is not a measurement. - -Note also that on SQL Server the problem is often better solved by making the clustered index -something other than the GUID key — see `sqlserver.md`. - -## Step 4 — is unpredictability required? - -Sequential and time-ordered identifiers are guessable, and UUIDv7 discloses creation time to the -millisecond. Where an identifier appears in a URL, is handed to a third party, or acts as a -capability, use a random UUID — or keep the ordered value internal and expose a random surrogate. - -Never use `NEWSEQUENTIALID()` output as a secret. - -## Decision summary - -| Provider | Needs value before insert | Locality matters | Recommendation | -| -- | -- | -- | -- | -| SQL Server | No | Yes | `NEWSEQUENTIALID()` as a store default, or EF Core's client-side `SequentialGuidValueGenerator` | -| SQL Server | Yes | Yes | EF Core `SequentialGuidValueGenerator`, or a store-ordered `FastGuid` strategy when both providers share a model | -| SQL Server | Either | No | `Guid.NewGuid()` | -| PostgreSQL | Yes | Yes | `Guid.CreateVersion7()` with `ValueGeneratedNever()` | -| PostgreSQL | No | Yes | `uuidv7()` on 18+, otherwise generate v7 in the application | -| PostgreSQL | Either | No | `Guid.NewGuid()` or `gen_random_uuid()` | -| SQL Server **and** PostgreSQL, one context type | Either | Yes | A store-specific strategy carried as context-options data. One strategy per provider; see below. | -| Any | Either | Either, but must be unpredictable | Random v4 | - -The two-provider row is the one that needs code: an `ISequentialGuidProvider` witness, an options -extension and a model-finalising convention. Copy them from the Engineering Playbook's *GUID Key -Strategy* page. Never expect one byte-ordered generator to order for both stores. - -A value whose identity is known before storage does not belong in this table. Derive it with UUIDv5 and -key it `ValueGeneratedNever()`; see `well-known-identifiers.md`. - -## Prefer built-in capability - -In order of preference: - -1. A framework capability — `Guid.CreateVersion7()`, EF Core's value generators. -2. A database capability — `NEWSEQUENTIALID()`, `uuidv7()`, `gen_random_uuid()`. -3. A reviewed, tested implementation of a published standard, when neither of the above is available - on your target versions — `FastGuid` is the one the sample uses for store-ordered values. -4. A bespoke generator — only against a measured requirement the first three cannot meet. - -A hand-written sequential GUID generator is easy to get subtly wrong — endianness, clock regression, -counter rollover within a millisecond, and thread safety are all live hazards, and the failure mode -is duplicate or badly-ordered keys found in production. - -## No NuGet package provides this - -No NuGet package provides the strategy/convention pattern. It is repository-local: copy the strategy -witness, options extension, value generator and model-finalising convention from the Engineering -Playbook's *GUID Key Strategy* page. Do not depend on a package that claims to own it, and do not -create one without a measured requirement the built-in options cannot meet. - -The abstraction is earned by a second provider, or by an identifier needed before `SaveChanges` on -both — not by anticipation. Until then a built-in capability is the answer. diff --git a/.agents/skills/purview-persistence/references/postgresql.md b/.agents/skills/purview-persistence/references/postgresql.md deleted file mode 100644 index 603987d..0000000 --- a/.agents/skills/purview-persistence/references/postgresql.md +++ /dev/null @@ -1,142 +0,0 @@ -# PostgreSQL UUID keys - -Read this only when the provider is PostgreSQL and UUIDs are primary keys. The SQL Server answer is -different — see `sqlserver.md`. - -## Why PostgreSQL differs from SQL Server - -Two differences drive everything on this page: - -1. **PostgreSQL has no clustered index.** Tables are heaps; the primary key is a separate B-tree. A - random UUID therefore does not cause row-level page splits the way it does on a clustered SQL - Server table. The cost is in the index: random inserts touch scattered index pages, which hurts - cache locality and WAL volume, but it is a smaller and differently-shaped problem. -2. **`uuid` compares in byte order.** Unlike SQL Server, PostgreSQL orders UUIDs by their bytes. A - UUID that is sequential in byte layout *is* sequential to the index. - -The consequence: **UUIDv7 works here.** It is the natural answer on PostgreSQL and the wrong answer -on SQL Server. Never carry a sequential-GUID choice across the two. - -## The options - -### `Guid.CreateVersion7()` — .NET 9+, application-generated - -The default recommendation for new PostgreSQL schemas with UUID keys. - -```csharp -public sealed class Order -{ - public Guid Id { get; init; } = Guid.CreateVersion7(); -} -``` - -- Time-ordered in byte layout, so index locality is good. -- The value exists before persistence, so outbox rows, correlation and client-side graphs all work. -- Standard (RFC 9562), so it is portable and readable by other systems. -- Embeds a millisecond timestamp — which is also its disclosure caveat. - -Tell EF Core the application supplies it: - -```csharp -builder.Property(o => o.Id).ValueGeneratedNever(); -``` - -Without that, EF Core may treat the key as store-generated and skip your value. - -### Application-generated, store-ordered strategy - -When one context type serves both PostgreSQL and SQL Server, or the identifier must exist before -`SaveChanges` on both, use a store-specific strategy carried as context-options data. The PostgreSQL -implementation returns `FastGuid.NewPostgreSqlGuid()`; a model-finalising convention applies it to -every GUID key and leaves explicitly keyed derived identifiers alone. - -```csharp -public sealed class PostgreSqlSequentialGuidProvider : ISequentialGuidProvider -{ - public static string Name => "PostgreSql"; - - public static Guid NewGuid() => FastGuid.NewPostgreSqlGuid(); - - public static Guid NewGuid(DateTime timestampUtc) => - FastGuid.NewPostgreSqlGuid(UtcTimestamp.EnsureUtc(timestampUtc)); - - public static DateTime GetTimestamp(Guid value) => FastGuid.PostgreSql.GetTimestamp(value); - - public static Guid MinValueFor(DateTime timestampUtc) => - FastGuid.PostgreSql.MinGuidForTimestamp(UtcTimestamp.EnsureUtc(timestampUtc)); - - public static Guid MaxValueFor(DateTime timestampUtc) => - FastGuid.PostgreSql.MaxGuidForTimestamp(UtcTimestamp.EnsureUtc(timestampUtc)); -} -``` - -- PostgreSQL compares `uuid` in plain big-endian byte order, so both `FastGuid.NewPostgreSqlGuid()` - and `Guid.CreateVersion7()` are genuinely sequential here. `FastGuid` is also correct for SQL Server, - which is the point of the strategy abstraction. -- Set `ValueGeneratedNever()` through the convention; never let EF fetch a store-generated value that - does not exist. - -#### RFC caveat - -`FastGuid.NewPostgreSqlGuid()` values are **not** RFC 9562 UUIDs. They are ordinary GUIDs with a -PostgreSQL-ordered layout, so PostgreSQL's `uuid_extract_timestamp()` will not read them even though -they are valid `uuid` values. Use the provider's `GetTimestamp` (above) instead. If another system -needs a standard timestamp, generate `Guid.CreateVersion7()` there and accept that the layout differs. - -The full sample is the Engineering Playbook's *GUID Key Strategy* page. The abstraction is earned by -the second provider, not by anticipation. - -### Database-generated UUIDv7 — PostgreSQL 18+ - -PostgreSQL 18 added a native `uuidv7()` function. Earlier versions do not have it; on 13–17 you have -`gen_random_uuid()` (v4, from the built-in pgcrypto-derived function) and nothing native for v7. - -**Check the server version before recommending `uuidv7()`.** It is the single most common way this -guidance goes wrong — the function simply does not exist on the version most deployments are running. - -```sql --- PostgreSQL 18 and later only -ALTER TABLE orders ALTER COLUMN id SET DEFAULT uuidv7(); -``` - -Prefer application-side generation anyway unless rows are inserted by paths that bypass the -application, because the value-before-persistence property is worth more than the marginal -difference. - -### `gen_random_uuid()` — database-generated v4 - -Available without an extension from PostgreSQL 13. Random, so index locality is poor, but -unpredictable and simple. - -### `Guid.NewGuid()` — application-generated v4 - -Random and unpredictable. Fine at low to moderate write volume, which covers most applications. - -## Npgsql and EF Core notes - -- `Guid` maps to `uuid` natively. Do not store UUIDs as `text` or `varchar` — it costs space, loses - index efficiency and defeats comparison. -- Npgsql's `uuid` mapping is byte-order faithful, so a v7 value sorts in the index as you expect. -- If the application generates the key, set `ValueGeneratedNever()` so EF Core does not fetch a - store-generated value that does not exist. -- A legacy database may have UUIDs in `text` columns. Migrating to `uuid` is usually worth it, but it - is a data migration, not a model change. - -## Choosing - -| Situation | Use | -| -- | -- | -| New schema, .NET 9+, UUID keys | `Guid.CreateVersion7()`, `ValueGeneratedNever()` | -| .NET 8 or earlier, high write volume | A reviewed UUIDv7 implementation, or accept v4 after measuring | -| Rows inserted outside the application, PostgreSQL 18+ | `uuidv7()` as a column default | -| Rows inserted outside the application, PostgreSQL 13–17 | `gen_random_uuid()` | -| One model serving PostgreSQL and SQL Server | A store-specific `FastGuid` strategy carried as context-options data — never one byte-ordered generator for both | -| Key must be unpredictable | `Guid.NewGuid()` or `gen_random_uuid()` — v7 leaks creation time | -| Low or moderate volume | v4 — the locality difference will not be your bottleneck | - -## The timestamp caveat - -A UUIDv7 exposes when the row was created, to the millisecond. Where identifiers are public, that can -leak signup times, order rates or activity patterns — and it makes identifiers partially guessable by -time window. Where that matters, use a random UUID for the public identifier and keep the v7 value -internal, or use a surrogate. diff --git a/.agents/skills/purview-persistence/references/sqlserver.md b/.agents/skills/purview-persistence/references/sqlserver.md deleted file mode 100644 index 2262972..0000000 --- a/.agents/skills/purview-persistence/references/sqlserver.md +++ /dev/null @@ -1,144 +0,0 @@ -# SQL Server GUID keys - -Read this only when the provider is SQL Server and GUIDs are primary keys. The PostgreSQL answer is -different — see `postgresql.md`. - -## Why SQL Server is a special case - -A clustered index determines physical row order. A `uniqueidentifier` primary key is clustered by -default, so random GUIDs insert into the middle of the index, causing page splits, fragmentation and -a larger buffer-pool working set. On a write-heavy table this is measurable. - -The complication is that **SQL Server does not compare `uniqueidentifier` values the way the bytes -are laid out.** Its ordering weights the last six bytes (node field) most significantly, then earlier -groups. So a GUID that is sequential in big-endian byte order — including a standard UUIDv7 — is -**not** sequential under SQL Server's comparison. This is precisely why the SQL Server and PostgreSQL -answers diverge. - -## The options - -### `NEWSEQUENTIALID()` — database-generated - -A column default that produces values ascending in SQL Server's own ordering. Best index locality -available. - -```sql -ALTER TABLE [Orders] ADD CONSTRAINT [DF_Orders_Id] - DEFAULT NEWSEQUENTIALID() FOR [Id]; -``` - -EF Core does **not** map `ValueGeneratedOnAdd` to `NEWSEQUENTIALID()` by default. For a `Guid` key on -SQL Server the provider generates the value client-side with `SequentialGuidValueGenerator` (below). -Configure a store default explicitly when the database must own the value: - -```csharp -builder.Property(o => o.Id).HasDefaultValueSql("NEWSEQUENTIALID()"); -``` - -Trade-offs: - -- The value does not exist until the row is inserted. EF Core retrieves it, but you cannot build an - object graph around the key beforehand. -- Values are **not** unpredictable: the sequence restarts on service restart but is otherwise - guessable. Never use one as a security token or capability URL. -- It reveals rough insert ordering, which can be an information-disclosure concern on a public - surface. - -### EF Core's `SequentialGuidValueGenerator` — client-generated - -EF Core ships a value generator that produces GUIDs ordered for SQL Server's comparison semantics, -generated in the application. - -```csharp -builder.Property(o => o.Id) - .HasValueGenerator() - .ValueGeneratedOnAdd(); -``` - -Use this when the identifier must exist before `SaveChanges`. It keeps most of the index locality -while letting the application own the value. - -### Application-generated, store-ordered strategy - -When one context type serves both SQL Server and PostgreSQL, or the identifier must exist before -`SaveChanges` on both, a single built-in generator is not enough: the two stores order GUIDs -differently. The answer is a store-specific strategy carried as context-options data — a -`static abstract` witness whose SQL Server implementation returns `FastGuid.NewSqlServerGuid()`, plus a -value generator and a model-finalising convention that applies it to every GUID key. - -```csharp -public sealed class SqlServerSequentialGuidProvider : ISequentialGuidProvider -{ - public static string Name => "SqlServer"; - - public static Guid NewGuid() => FastGuid.NewSqlServerGuid(); - - public static Guid NewGuid(DateTime timestampUtc) => - FastGuid.NewSqlServerGuid(UtcTimestamp.EnsureUtc(timestampUtc)); - - public static DateTime GetTimestamp(Guid value) => FastGuid.SqlServer.GetTimestamp(value); - - public static Guid MinValueFor(DateTime timestampUtc) => - FastGuid.SqlServer.MinGuidForTimestamp(UtcTimestamp.EnsureUtc(timestampUtc)); - - public static Guid MaxValueFor(DateTime timestampUtc) => - FastGuid.SqlServer.MaxGuidForTimestamp(UtcTimestamp.EnsureUtc(timestampUtc)); -} -``` - -- The increasing part must sit where SQL Server sorts it. The trailing six bytes dominate - `uniqueidentifier`; a byte-ordered UUIDv7 does not. -- The generator must hand the value through the property's value converter, or a `readonly record - struct OrderId` key receives a raw `Guid`. -- Apply it at convention precedence, so explicit `ValueGeneratedNever()`, a store default and a - computed column all win. - -The full sample is the Engineering Playbook's *GUID Key Strategy* page. The abstraction is earned by -the second provider; on one SQL Server provider `NEWSEQUENTIALID()` or EF Core's generator is enough. - -### `Guid.NewGuid()` — random - -Correct, portable and unpredictable; poor index locality. - -Appropriate when write volume is low (the fragmentation never matters), when the key is -non-clustered, or when unpredictability is a requirement. Do not dismiss it by default — for most -applications it is fine, and "most applications" includes more than people expect. - -### `Guid.CreateVersion7()` — .NET 9+ - -Ordered in byte layout, but **not** ordered under SQL Server's comparison. On SQL Server it behaves -roughly like a random GUID for clustered-index purposes. It is the right answer on PostgreSQL and the -wrong answer here, which is the trap this page exists to prevent. - -Use it on SQL Server only when you want the embedded timestamp for application reasons and accept -random-like insert locality. - -## Decoupling the key from the index - -Often the best answer is not a different GUID but a different index. Keep the GUID as the primary key -and make the clustered index something naturally ascending: - -```csharp -builder.HasKey(o => o.Id).IsClustered(false); -builder.HasIndex(o => o.CreatedAt).IsClustered(); -``` - -This removes the page-split problem entirely and leaves the key unpredictable. Consider it before -reaching for a sequential generator. - -## Choosing - -| Situation | Use | -| -- | -- | -| High insert volume, key may be database-generated | `NEWSEQUENTIALID()` | -| High insert volume, identifier needed before persisting | EF Core `SequentialGuidValueGenerator`, or a store-ordered `FastGuid` strategy when both providers share a model | -| Key must be unpredictable (public surface, security boundary) | `Guid.NewGuid()`, with a non-clustered PK | -| Low or moderate volume | `Guid.NewGuid()` — do not optimise what does not hurt | -| You want a sortable timestamp in the key and accept the locality cost | `Guid.CreateVersion7()` | - -## Measure before optimising - -Index fragmentation from random GUIDs is real but frequently irrelevant. Before changing a key -strategy, confirm it matters: check page splits, fragmentation and buffer-pool pressure on the actual -table at the actual volume. Changing a primary key strategy on a live table is expensive; do it -against evidence. diff --git a/.agents/skills/purview-persistence/references/well-known-identifiers.md b/.agents/skills/purview-persistence/references/well-known-identifiers.md deleted file mode 100644 index 372d585..0000000 --- a/.agents/skills/purview-persistence/references/well-known-identifiers.md +++ /dev/null @@ -1,93 +0,0 @@ -# Deriving well-known identifiers with UUIDv5 - -Read this only when an identifier's **value must be known before storage**: a system tenant, a seeded -reference row, an installation's service principal, or an ingested object whose provider key is stable -and never recycled. A project with random keys and no seeding has no use for UUIDv5 — say nothing and -move on. An outbox row that merely needs an id before `SaveChanges` takes a generated strategy instead. - -## The rule - -1. Derive the value: `Uuid5.Create(namespace, name)` is RFC 4122 version 5 (SHA-1), byte-identical for - the same namespace and name in every process, language and restart. -2. Scope the namespace to the isolation boundary — one installation or one deployment. Never a global - constant shared by every deployment. -3. Fix the name as a canonical constant of the identity kind. Not a display name, not user data, not a - secret. -4. Once persisted, the value is authoritative. Never recompute it and update the row. -5. Key it explicitly with `ValueGeneratedNever()`, so a sequential-GUID convention never generates over - a value the application already knows. - -## The catalogue - -Write the known identities down in one place. - -| Identity | Namespace | Name | Derived when | Immutable | -| -- | -- | -- | -- | -- | -| System tenant of an installation | installation id | `system-tenant` | first bootstrap | yes | -| System principal of an installation | installation id | `system-service-principal` | first bootstrap | yes | -| Seeded reference row | installation id | `:` | seed step | yes | -| Ingested external object (optional) | installation id | `:` | first ingest | yes | - -Derive the ingested row only when the provider guarantees the external key is stable and never -recycled. If it can be recycled, keep the local key sequential and make the external key a unique -column. - -## Naming rules - -- Lowercase ASCII, hyphen-separated, no whitespace, no locale-dependent casing. -- Never from a display name, email, URL, title, or anything a user can edit. -- Never from a secret, and never as a capability token. A name is guessable. -- Renaming a name creates a new identity. Renaming a persisted one is a data migration. - -## Bootstrap sequence - -Read the persisted identity; if present it wins, and a configured value must match or the operation -fails. If absent, insert it. Derive dependants from the persisted id. Save once. A second run changes -nothing. - -The guard matters as much as the insert: - -```csharp -if (persisted is not null && persisted.Id != configured) -{ - throw new InvalidOperationException( - $"Configured installation id '{configured.Value}' does not match the persisted id '{persisted.Id.Value}'."); -} -``` - -## Migrations cannot call the helper - -`HasData` and migration SQL need a literal GUID. A small script prints ready-to-paste constants from -the same derivation, and a test asserts every printed constant equals `Uuid5.Create(...)`. Changing the -namespace or a name after a migration has shipped is a data migration, not an edit. - -## Checks to write - -| Check | Shape | -| -- | -- | -| RFC 4122 conformance | Fixed vectors for DNS/URL/OID/X500 and the empty name; exact GUIDs | -| Determinism | Same pair twice equal; different names differ | -| Version and variant bits | Byte 6 high nibble `0x5`; byte 8 high bits `10` | -| Cross-language equality | Python `uuid.uuid5` or Node `crypto` reproduces the vectors | -| Catalogue uniqueness | The catalogue's constants are distinct | -| Bootstrap idempotency | Seeding twice changes zero rows; a mismatched configured id throws | -| Explicit keying | The key is `ValueGenerated.Never`, and the sequential convention leaves it alone | - -```text -uuid5(6ba7b810-9dad-11d1-80b4-00c04fd430c8, "example.com") = cfbff0d1-9375-5685-968c-48ce8b15ae17 -uuid5(6ba7b811-9dad-11d1-80b4-00c04fd430c8, "www.example.com") = b63cdfa4-3df9-568e-97ae-006c5b8fd652 -uuid5(6ba7b812-9dad-11d1-80b4-00c04fd430c8, "1.2.3.4") = 67448b45-6d15-536b-bef7-8a78c3d10ac6 -uuid5(6ba7b814-9dad-11d1-80b4-00c04fd430c8, "CN=Bob") = 0840e90d-9ca0-5f14-970e-26294d44cb1d -``` - -The hash path is big-endian. `Guid.ToByteArray()` and `new Guid(byte[])` use a mixed-endian layout and -produce a different hash; that is the most common way a "UUIDv5" implementation is wrong. - -**UUIDv5 is not sequential.** Never use it for a high-write table's primary key. It is for a small, -known set of identities; everything else takes `guid-generation.md`. - -RFC 4122 is the version-5 specification; RFC 9562 is the current UUID specification and retains the -algorithm. The .NET BCL has no UUIDv5 API, so the helper is a small hand-written function. - -The Engineering Playbook's *Well-Known Identifiers* page carries the full helper, catalogue and -bootstrap samples, and their test shapes. diff --git a/.agents/skills/purview-telemetry-design/SKILL.md b/.agents/skills/purview-telemetry-design/SKILL.md deleted file mode 100644 index c8df5f8..0000000 --- a/.agents/skills/purview-telemetry-design/SKILL.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -name: purview-telemetry-design -description: Design best practices for Purview.Telemetry.SourceGenerator interfaces. Use when deciding between a single telemetry interface and per-area interfaces, choosing telemetry names, designing multi-target methods, or reviewing telemetry structure in a C# project. -license: MIT -compatibility: C# projects using Purview.Telemetry.SourceGenerator. -metadata: - author: Purview-Dev - version: "1.0" ---- - -# Design best practices for Purview Telemetry - -This skill guides the design of generated telemetry interfaces. - -## Single combined interface vs. per-area interfaces - -The generator lets you put all telemetry types on one interface, or split them by concern. - -### Combined interface - -Use one interface when: - -- A single service owns all telemetry and the operations naturally overlap. -- You want a single injection point and fewer constructor parameters. -- Multi-target methods emit Activity + Log + Metric from one call. - -Naming convention: - -```csharp -[ActivitySource] -[Logger] -[Meter] -public interface IOrderServiceTelemetry -``` - -### Per-area interfaces - -Split into separate interfaces when: - -- Different consumers need only one telemetry type (e.g., tests mock only logs). -- The team prefers clear separation between tracing, logging, and metrics. -- The service is large and each telemetry type has many operations. - -Naming convention: - -```csharp -[ActivitySource] public interface IOrderServiceTracing { ... } -[Logger] public interface IOrderServiceLogs { ... } -[Meter] public interface IOrderServiceMetrics { ... } -``` - -Default recommendation: start with one combined interface per service. Split only when a clear boundary emerges. - -## Naming conventions - -Default to the OpenTelemetry naming convention (`NamingConvention.OpenTelemetry`). - -- ActivitySource names: preserve assembly casing (e.g., `MyApp`). -- Activity names: descriptive, sentence-case-ish, no spaces: `placing-order`. -- Log message templates: human-readable, with `{PascalCase}` placeholders. -- Metric instrument names: hierarchical, dot-separated, lowercase: `myapp.orders.placed`. -- Tag/baggage keys: `snake_case`. - -Only use `NamingConvention.Legacy` for exact v3 backward compatibility. - -## Multi-target method design - -Combine attributes on one method when a single operation emits multiple telemetry types: - -```csharp -[Activity] -[Info] -[AutoCounter] -Activity? PlacingOrder(int orderId); -``` - -Rules: - -- Methods that return `Activity?` create an Activity. -- Methods that return `void` typically add events, log, or record metrics. -- Pass the `Activity?` from the starting method to event/context methods. - -## Parameter attributes - -| Attribute | Use | -|---|---| -| `[Baggage]` | Adds the parameter to Activity baggage; also included in logs. | -| `[Tag]` | Adds the parameter as an Activity tag. | -| `[ExcludeTargets(Targets.Activities)]` | Excludes the parameter from Activity generation only. | -| `[ExpandEnumerable(maximumValueCount: N)]` | Expands an array/IEnumerable into indexed log properties. | - -## Testing - -Inject the interface in your service and mock it in tests. The generated interface has no implementation code in the interface itself, so standard mocking frameworks (NSubstitute, Moq, TUnitMocks) work directly. - -See [references/REFERENCE.md](references/REFERENCE.md) for a decision matrix and naming examples. diff --git a/.agents/skills/purview-telemetry-design/references/REFERENCE.md b/.agents/skills/purview-telemetry-design/references/REFERENCE.md deleted file mode 100644 index b15cfcf..0000000 --- a/.agents/skills/purview-telemetry-design/references/REFERENCE.md +++ /dev/null @@ -1,101 +0,0 @@ -# Design reference - -## Interface shape decision matrix - -| Situation | Recommendation | -|---|---| -| Small service with < 10 telemetry operations | One combined `ITelemetry` | -| Service only logs | `ILogs` | -| Service only traces | `ITracing` | -| Service only emits metrics | `IMetrics` | -| Large service with distinct teams owning logs vs. metrics | Split into per-area interfaces | -| Need to mock only one telemetry type in many tests | Split into per-area interfaces | - -## Naming examples - -### OpenTelemetry mode (default) - -```csharp -[ActivitySource] // name = "MyApp" -[Logger] -[Meter] -public interface IOrderServiceTelemetry -{ - [Activity] - Activity? PlacingOrder(int orderId); // activity name = "placing-order" - - [Info("Placing order {OrderId}")] - void PlacingOrderInfo(int orderId); // log - - [AutoCounter] - void OrderPlaced(); // instrument = "myapp.orders.order-placed" -} -``` - -### Legacy mode - -```csharp -[assembly: TelemetryGeneration(NamingConvention = NamingConvention.Legacy)] -``` - -Use only when exact v3 names must be preserved. - -## Multi-target example - -```csharp -[ActivitySource] -[Logger] -[Meter] -public interface IOrderServiceTelemetry -{ - // Starts Activity, logs Info, increments Counter - [Activity(ActivityKind.Internal)] - [Info("Placing order {OrderId} for {CustomerName}")] - [AutoCounter] - Activity? PlacingOrder(int orderId, string customerName, [Baggage] string region); - - // Adds event to the Activity and logs Trace - [Event] - [Trace] - void OrderValidated(Activity? activity, int orderId); - - // Records histogram - [Histogram] - void OrderProcessingTime(double latencyMs); -} -``` - -## Parameter attribute examples - -```csharp -[Activity] -[Info] -Activity? FetchingOrder( - int orderId, - [Baggage] string region, // carried in Activity baggage - [Tag] string tenantId); // Activity tag only - -[Event] -void OrderLoaded( - Activity? activity, - int orderId, - [ExcludeTargets(Targets.Activities)] string[] rawLines); // not in Activity -``` - -## Testing example - -```csharp -public class OrderServiceTests -{ - [Test] - public void PlaceOrder_EmitsTelemetry() - { - var telemetry = Substitute.For(); - var service = new OrderService(telemetry); - - service.PlaceOrder(42, "Alice", "EMEA"); - - telemetry.Received().PlacingOrder(42, "Alice", "EMEA"); - } -} -``` diff --git a/.agents/skills/purview-telemetry-diagnostics/SKILL.md b/.agents/skills/purview-telemetry-diagnostics/SKILL.md deleted file mode 100644 index fec24d2..0000000 --- a/.agents/skills/purview-telemetry-diagnostics/SKILL.md +++ /dev/null @@ -1,168 +0,0 @@ ---- -name: purview-telemetry-diagnostics -description: >- - Use when a Purview.Telemetry.SourceGenerator build reports a TSG diagnostic - TSG1xxx general, - TSG2xxx logging, TSG3xxx activities, TSG4xxx metrics - to find what triggered it and how to fix it, - or when deciding whether a rule can be suppressed. -license: MIT -compatibility: C# projects using Purview.Telemetry.SourceGenerator. -metadata: - author: Purview-Dev - product: Purview.Telemetry.SourceGenerator - repository: purview-dev/telemetry-sourcegenerator ---- - -# Purview.Telemetry.SourceGenerator diagnostics - -One Roslyn analyzer, `TelemetryDiagnosticAnalyzer`, validates telemetry interfaces and raises `TSG` -diagnostics in four families: - -| Family | Covers | -| --- | --- | -| `TSG1xxx` | general — interface and method shape, targets, framework support | -| `TSG2xxx` | logging | -| `TSG3xxx` | activities | -| `TSG4xxx` | metrics | - -Every rule is tracked in `AnalyzerReleases.Shipped.md` / `AnalyzerReleases.Unshipped.md` with its ID, -category and severity, validated by the Roslyn release-tracking analyzers on every build. A new or -changed diagnostic must be recorded there in the same change. - -## General — `TSG1xxx` - -| ID | Severity | Reported when | -| --- | --- | --- | -| `TSG1000` | Error | An unexpected exception escaped the generation pipeline. | -| `TSG1001` | Error | A method on a multi-target interface has no explicit generation attribute — inference is not supported there. | -| `TSG1002` | Error | Two attributes from the same target family on one method. Only one Activity, Logging or Metrics attribute per method. | -| `TSG1003` | Error | Two methods on the interface share a name. | -| `TSG1004` | Error | Generic interfaces are not supported. | -| `TSG1005` | Error | Generic methods are not supported. | -| `TSG1006` | Warning | `ExcludeTargets` names a target not present on the method. | -| `TSG1007` | Warning | `ExcludeTargets` leaves a target with an empty or invalid parameter set. | -| `TSG1008` | Warning | An `Activity`-typed parameter on a method with no `[Activity]`/`[Event]`/`[Context]`. | -| `TSG1010` | Error | A method carries an attribute for a target family the interface does not register. | -| `TSG1011` | Error | The compilation targets neither .NET 8+ nor .NET Framework 4.8+. Define `PURVIEW_TELEMETRY_NON_NULLABLE` to opt out. | - -## Logging — `TSG2xxx` - -| ID | Severity | Reported when | -| --- | --- | --- | -| `TSG2000` | Error | A non-scoped log method has more than one `Exception` parameter. | -| `TSG2001` | Error | A v1-mode log method has more than 6 non-exception parameters. | -| `TSG2002` | Info | v1 generation inferred `Error` from a lone `Exception` parameter with no explicit level. | -| `TSG2003` | Warning | No reference to `Microsoft.Extensions.Logging.ILogger`; log generation is skipped. | -| `TSG2004` | Error | Ordinal and named placeholders mixed in one message template. | -| `TSG2005` | Error | The maximum ordinal placeholder exceeds the parameter count. | -| `TSG2006` | Error | `[LogProperties]` and `[ExpandEnumerable]` on the same parameter. | -| `TSG2007` | Warning | A scoped log declares a `LogLevel`; it is ignored. | -| `TSG2008` | Warning | `[ExpandEnumerable]` has a `MaximumValueCount` above the recommended default of 5. | -| `TSG2021` | Error | A log method returns something other than `void` or `IDisposable`. (`Activity` is allowed when the method is also an Activity method.) | - -## Activities — `TSG3xxx` - -| ID | Severity | Reported when | -| --- | --- | --- | -| `TSG3000` | Warning | A baggage parameter is not a string; `ToString()` will be called. | -| `TSG3001` | Warning | No activity source name available anywhere; generation defaults to `purview`. | -| `TSG3002` | Error | An Activity/Event method returns something other than `void` or `Activity`. | -| `TSG3003` | Error | More than one parameter maps to the same reserved destination. | -| `TSG3004` | Error | An `Activity`-destination parameter on an Activity method — only valid on `[Event]`. | -| `TSG3005` | Error | A `timestamp` parameter on a method that is not `[Event]`. | -| `TSG3006` | Error | A start-time parameter on a Create-activity or Event method. | -| `TSG3007` | Error | A parent-context or parent-id parameter on an event. | -| `TSG3008` | Error | Activity-links parameters on an event or context method. | -| `TSG3009` | Error | An activity-tags parameter on a context method. | -| `TSG3010` | Error | An escaped parameter is not a boolean. | -| `TSG3011` | Error | Escaped parameters on an Activity or Context method — Events only. | -| `TSG3012` | Info | No Activity methods defined; `Activity.Current` is assumed. | -| `TSG3013` | Warning | An Activity method does not return the created `Activity`. | -| `TSG3014` | Warning | An Event/Context method has no `Activity` parameter. Controlled by `ActivitySourceGeneration.GenerateDiagnosticsForMissingActivity` (default `true`). | -| `TSG3015` | Info | `Activity` should be the first parameter. Same opt-in as `TSG3014`. | -| `TSG3016` | Error | A status-description parameter is not a string. | -| `TSG3017` | Error | Status-description parameters on an Activity or Context method — Events only. | -| `TSG3021` | Info | An `[Event]` records an exception under the OpenTelemetry rules but is not named `"exception"`. | -| `TSG3022` | Warning | An Activity method returns non-nullable `Activity`. | - -## Metrics — `TSG4xxx` - -| ID | Severity | Reported when | -| --- | --- | --- | -| `TSG4000` | Error | A method on a Metrics interface has no instrument attribute and is not excluded. | -| `TSG4001` | Error | A metrics-owned method returns something other than `void` or `bool`. | -| `TSG4002` | Error | An auto-increment instrument also declares a measurement parameter. | -| `TSG4003` | Error | More than one measurement value. | -| `TSG4004` | Error | A non-auto-increment instrument method has no measurement parameter. | -| `TSG4005` | Error | An observable instrument is not declared as `Func`. | -| `TSG4006` | Error | The measurement type is not `byte`, `short`, `int`, `long`, `double`, `float`, `decimal`, `Measurement` or `IEnumerable>`. | -| `TSG4007` | Error | An observable metric returns `bool`. | -| `TSG4008` | Error | An `AutoCounter` does not return `void`. | -| `TSG4009` | Warning | The instrument name matches the instrument type name. Name what is measured, not the instrument. | - -## The ones people actually hit - -### `TSG1001` — inference is off on a multi-target interface - -A method on an interface carrying `[ActivitySource]` + `[Logger]` + `[Meter]` has no explicit -attribute. Add one per target the method should emit, or mark it `[Exclude]`: - -```csharp -[ActivitySource("MyApp")] -[Logger] -[Meter] -interface IMyTelemetry -{ - [Info] // explicit target - void ProcessItem(int id); -} -``` - -### `TSG3013` / `TSG3014` — the Activity went missing - -Return the created `Activity` (as `Activity?`, per `TSG3022` — it is null when no listeners are -active) and pass it into the Event and Context methods that should attach to it. Both are -best-practice rules controlled by `ActivitySourceGeneration.GenerateDiagnosticsForMissingActivity`. - -### `TSG3021` — exception event name - -Name the event `exception` so the OpenTelemetry exception tags (`exception.type`, -`exception.message`, `exception.stacktrace`, `exception.escaped`) attach to *that* event rather than -a separate one: - -```csharp -[Event(Name = "exception")] // the event carries the exception tags -void FailedToRetrieve(Activity? activity, Exception exception); -``` - -A `Name` on a **logging** attribute does not name the event — it renames the log entry: - -```csharp -[Event] // event name is still the method name -[Error(Name = "exception")] // this renames the log entry -void FailedToRetrieve(Activity? activity, Exception exception); -``` - -The rule is not raised when the exception is not recorded under the OpenTelemetry rules: -`[Event(UseRecordExceptionRules = false)]`, a `[Baggage]` exception parameter, or an exception -parameter excluded from the Activities target (`[ExcludeTargets(Targets.Activities)]`). - -### `TSG2008` — unbounded enumeration - -`[ExpandEnumerable]` with `MaximumValueCount` above 5. Bring it back to the default unless you have -measured the cost. - -### `TSG4002` — auto-increment counter with a measurement - -`[AutoCounter]` — equivalently `[Counter(AutoIncrement = true)]` — must declare no measurement -parameter. The measurement is fixed at 1. - -### `TSG1003` — duplicate method names - -The method name becomes a member on the generated implementation class, so two methods cannot share -one. Rename. - -## Related skills - -`purview-telemetry-quickstart` to get an interface wired up, `purview-telemetry-design` for -structuring interfaces, and `purview-telemetry-migration` for converting existing `ILogger`, -`ActivitySource` or instrument code. diff --git a/.agents/skills/purview-telemetry-migration/SKILL.md b/.agents/skills/purview-telemetry-migration/SKILL.md deleted file mode 100644 index b9a01fa..0000000 --- a/.agents/skills/purview-telemetry-migration/SKILL.md +++ /dev/null @@ -1,81 +0,0 @@ ---- -name: purview-telemetry-migration -description: Migrate existing ILogger, ActivitySource, or System.Diagnostics.Metrics instrument code to Purview.Telemetry.SourceGenerator interfaces. Use when converting hand-written telemetry to generated telemetry interfaces, or when a user wants to replace ILogger, ActivitySource, or Counter/Histogram/UpDownCounter usage with Purview telemetry. -license: MIT -compatibility: C# projects using Purview.Telemetry.SourceGenerator. -metadata: - author: Purview-Dev - version: "1.0" ---- - -# Migrate to Purview Telemetry Source Generator - -Convert existing telemetry code to generated Purview telemetry interfaces. - -## Primary path: use the IDE refactorings - -The source generator ships with Roslyn code refactorings. Right-click a class containing hand-written telemetry and choose: - -- **Convert ILogger to ILogs** — replaces `ILogger` fields and constructor parameters with a generated logging interface. -- **Convert ActivitySource to ITracing** — replaces `ActivitySource` fields and `StartActivity` calls with a generated tracing interface. -- **Convert Metrics to IMetrics** — replaces `Counter`, `Histogram`, and `UpDownCounter` fields and calls with a generated metrics interface. -- **Convert all telemetry to ITelemetry** — combines all three into one interface when the class uses multiple telemetry types. - -Each refactoring offers scopes: **class**, **document**, **project**, and **solution**. - -## What the refactorings produce - -The generated interface uses attributes from the `Purview.Telemetry` namespace: - -```csharp -using Purview.Telemetry; - -[Logger] -public interface IOrderServiceLogs -{ - [Info] - void OrderPlaced(int orderId, string customerName); -} -``` - -The original class is rewritten to use the interface: - -```csharp -public class OrderService(IOrderServiceLogs logger) -{ - public void PlaceOrder(int orderId, string customerName) - { - logger.OrderPlaced(orderId, customerName); - } -} -``` - -## Manual fallback - -If the refactoring does not cover a call pattern, convert it manually: - -1. Identify the telemetry type (Logging, Activity, Metric). -2. Create a new interface with the matching class-level attribute (`[Logger]`, `[ActivitySource]`, `[Meter]`). -3. Add a method for each distinct operation, using the method-level attribute from the mapping below. -4. Replace the hand-written call with the interface method. -5. Register the interface in DI with `services.Add{InterfaceNameWithoutI}()`. - -## Attribute mapping - -| Hand-written telemetry | Generated attribute | -|---|---| -| `ILogger.LogInformation(...)` | `[Info]` | -| `ILogger.LogDebug(...)` | `[Debug]` | -| `ILogger.LogTrace(...)` | `[Trace]` | -| `ILogger.LogWarning(...)` | `[Warning]` | -| `ILogger.LogError(...)` | `[Error]` | -| `ILogger.LogCritical(...)` | `[Critical]` | -| `ActivitySource.StartActivity(...)` | `[Activity]` | -| `activity.AddEvent(...)` | `[Event]` | -| `activity.AddBaggage(...)` / `SetBaggage(...)` | `[Context]` with `[Baggage]` parameter | -| `activity.SetTag(...)` | `[Context]` with `[Tag]` parameter | -| `Counter.Add(...)` | `[Counter]` or `[AutoCounter]` for `Add(1)` | -| `Histogram.Record(...)` | `[Histogram]` | -| `UpDownCounter.Add(...)` | `[UpDownCounter]` | - -See [references/REFERENCE.md](references/REFERENCE.md) for detailed before/after examples and common conversions. diff --git a/.agents/skills/purview-telemetry-migration/references/REFERENCE.md b/.agents/skills/purview-telemetry-migration/references/REFERENCE.md deleted file mode 100644 index d85eb73..0000000 --- a/.agents/skills/purview-telemetry-migration/references/REFERENCE.md +++ /dev/null @@ -1,181 +0,0 @@ -# Migration reference - -Detailed before/after examples for migrating hand-written telemetry to Purview telemetry interfaces. - -## ILogger to generated logging interface - -### Before - -```csharp -using Microsoft.Extensions.Logging; - -public class OrderService(ILogger logger) -{ - public void PlaceOrder(int orderId, string customerName) - { - logger.LogInformation("Placing order {OrderId} for {CustomerName}", orderId, customerName); - } - - public void CancelOrder(int orderId, Exception ex) - { - logger.LogError(ex, "Order {OrderId} cancelled", orderId); - } -} -``` - -### After - -```csharp -using Purview.Telemetry; - -[Logger] -public interface IOrderServiceLogs -{ - [Info("Placing order {OrderId} for {CustomerName}")] - void OrderPlaced(int orderId, string customerName); - - [Error("Order {OrderId} cancelled")] - void OrderCancelled(Exception ex, int orderId); -} - -public class OrderService(IOrderServiceLogs logger) -{ - public void PlaceOrder(int orderId, string customerName) - { - logger.OrderPlaced(orderId, customerName); - } - - public void CancelOrder(int orderId, Exception ex) - { - logger.OrderCancelled(ex, orderId); - } -} -``` - -## ActivitySource to generated tracing interface - -### Before - -```csharp -using System.Diagnostics; - -public class OrderService -{ - static readonly ActivitySource _source = new("OrderService"); - - public void PlaceOrder(int orderId) - { - using var activity = _source.StartActivity("PlaceOrder", ActivityKind.Internal); - activity?.AddEvent(new ActivityEvent("Validated")); - } -} -``` - -### After - -```csharp -using System.Diagnostics; -using Purview.Telemetry; - -[ActivitySource] -public interface IOrderServiceTracing -{ - [Activity] - Activity? PlaceOrder(int orderId); - - [Event] - void Validated(Activity? activity); -} - -public class OrderService(IOrderServiceTracing tracing) -{ - public void PlaceOrder(int orderId) - { - using var activity = tracing.PlaceOrder(orderId); - tracing.Validated(activity); - } -} -``` - -## Metrics to generated metrics interface - -### Before - -```csharp -using System.Diagnostics.Metrics; - -public class OrderService(IMeterFactory meterFactory) -{ - readonly Counter _orders = meterFactory.Create("OrderService").CreateCounter("orders-placed"); - readonly Histogram _latency = meterFactory.Create("OrderService").CreateHistogram("processing-latency-ms"); - - public void PlaceOrder(int orderId, double latencyMs) - { - _orders.Add(1); - _latency.Record(latencyMs); - } -} -``` - -### After - -```csharp -using Purview.Telemetry; - -[Meter] -public interface IOrderServiceMetrics -{ - [AutoCounter] - void OrderPlaced(); - - [Histogram] - void OrderProcessingTime(double latencyMs); -} - -public class OrderService(IOrderServiceMetrics metrics) -{ - public void PlaceOrder(int orderId, double latencyMs) - { - metrics.OrderPlaced(); - metrics.OrderProcessingTime(latencyMs); - } -} -``` - -## Combined telemetry interface - -When a class uses multiple telemetry types, prefer the combined refactoring: - -```csharp -using System.Diagnostics; -using Purview.Telemetry; - -[ActivitySource] -[Logger] -[Meter] -public interface IOrderServiceTelemetry -{ - [Activity] - [Info] - [AutoCounter] - Activity? PlacingOrder(int orderId); - - [Event] - void OrderShipped(Activity? activity, int orderId); - - [Histogram] - void OrderProcessingTime(double latencyMs); -} -``` - -## Common conversions - -| Original code | Generated method signature | -|---|---| -| `logger.LogError(ex, "Failed {OrderId}", orderId)` | `[Error("Failed {OrderId}")] void Failed(Exception exception, int orderId);` | -| `activity.AddEvent(new ActivityEvent("Loaded"))` | `[Event] void Loaded(Activity? activity);` | -| `activity.SetBaggage("tenant", tenantId)` | `[Context] void SetTenant(Activity? activity, [Baggage] string tenantId);` | -| `activity.SetTag("tenant", tenantId)` | `[Context] void SetTenant(Activity? activity, [Tag] string tenantId);` | -| `counter.Add(1, new KeyValuePair("region", region))` | `[AutoCounter] void RequestCompleted([Tag] string region);` | -| `histogram.Record(value, new KeyValuePair("region", region))` | `[Histogram] void RequestDuration(long value, [Tag] string region);` | -| `upDownCounter.Add(1)` | `[UpDownCounter] void Increment();` | diff --git a/.agents/skills/purview-telemetry-multi-targeting/SKILL.md b/.agents/skills/purview-telemetry-multi-targeting/SKILL.md deleted file mode 100644 index d9654ab..0000000 --- a/.agents/skills/purview-telemetry-multi-targeting/SKILL.md +++ /dev/null @@ -1,224 +0,0 @@ ---- -name: purview-telemetry-multi-targeting -description: >- - Use when one Purview.Telemetry.SourceGenerator method should emit several kinds of telemetry at - once - an Activity, a log entry and a metric from a single call. Covers combining [ActivitySource], - [Logger] and [Meter] on an interface, the supported per-method attribute combinations, excluding a - parameter from one target with [ExcludeTargets], return types, and why inference turns off. -license: MIT -compatibility: C# projects using Purview.Telemetry.SourceGenerator. -metadata: - author: Purview-Dev - product: Purview.Telemetry.SourceGenerator - repository: purview-dev/telemetry-sourcegenerator ---- - -# Multi-targeting - -One interface — and one *method* — can generate Activities, logs and metrics together. A single call -then emits all of them, from one set of parameters. - -```csharp -using Purview.Telemetry; - -[ActivitySource("OrderService")] -[Logger] -[Meter] -interface IOrderTelemetry -{ - // Activity + Info log + counter increment, from one call. - [Activity] - [Info] - [AutoCounter] - Activity? ProcessingOrder([Baggage] int orderId, [Tag] string customerName); - - // ActivityEvent + Debug log. - [Event] - [Debug] - void OrderValidated(Activity? activity, decimal amount); - - // Log only. - [Warning] - void OrderRejected(int orderId, string reason); - - // Metric only. - [Histogram] - void OrderProcessingDuration([InstrumentMeasurement] int milliseconds); -} -``` - -```csharp -using var activity = telemetry.ProcessingOrder(123, "Acme Corp"); -// Activity created and started, Info log written, counter incremented by 1. -``` - -## What you may combine - -| Combination | Example | -| --- | --- | -| Activity + Log | `[Activity]` + `[Info]` | -| Activity + Metric | `[Activity]` + `[AutoCounter]` | -| Log + Metric | `[Info]` + `[Histogram]` | -| Activity + Log + Metric | `[Activity]` + `[Info]` + `[AutoCounter]` | -| Event + Log | `[Event]` + `[Debug]` | -| Context + Log | `[Context]` + `[Trace]` | - -**One attribute per family, per method** — more is `TSG1002`: - -- Activities: one of `[Activity]`, `[Event]`, `[Context]`. -- Logging: one of `[Log]`, `[Trace]`, `[Debug]`, `[Info]`, `[Warning]`, `[Error]`, `[Critical]`. -- Metrics: one of `[Counter]`, `[AutoCounter]`, `[Histogram]`, `[UpDownCounter]`, or an observable - variant. - -```csharp -[Activity] -[Event] // TSG1002 -void InvalidMethod(Activity? activity); - -[Counter] -[Histogram] // TSG1002 -void InvalidMethod([InstrumentMeasurement] int value); -``` - -## Inference turns off — and that is the point - -An interface with **more than one** class-level attribute (`[ActivitySource]`, `[Logger]`, `[Meter]`) -disables inference. Every method must then declare its targets explicitly, or be `[Exclude]`d: - -```csharp -[ActivitySource("MyApp")] -[Logger] -[Meter] -interface IMyTelemetry -{ - void ProcessItem(int id); // TSG1001 - no explicit attribute - - [Info] - void ProcessItemLogged(int id); // fine - - [Exclude] - void NotTelemetry(int id); // fine -} -``` - -A single-target interface keeps inference. The alternative — guessing which of three families an -unannotated method meant — would silently emit the wrong telemetry, so the generator refuses. - -## Excluding a parameter from one target - -`[ExcludeTargets(Targets.X)]` on a parameter keeps it out of specific families. Use it when a value -is useful in one place and harmful in another — a verbose message is wasted as a metric tag, and an -internal reference may not belong in Activity baggage: - -```csharp -[ActivitySource("PaymentService")] -[Logger] -[Meter] -interface IPaymentTelemetry -{ - [Activity] - [Info] - [Counter] - Activity? ProcessingPayment( - [Baggage] Guid paymentId, - - [ExcludeTargets(Targets.Metrics)] - string processingMessage, - - [InstrumentMeasurement] - decimal amount, - - [ExcludeTargets(Targets.Activities)] - [Tag] // still in logs and metrics - string internalReference - ); -} -``` - -```csharp -[Flags] -public enum Targets -{ - None = 0, - Activities = 1, - Logging = 2, - Metrics = 4, - All = Activities | Logging | Metrics -} -``` - -Flags combine, so `[ExcludeTargets(Targets.Activities | Targets.Metrics)]` leaves a parameter to -logging alone. - -## Return types - -| Shape | Return | -| --- | --- | -| Activity + anything else | `Activity?` — so the caller can dispose it and pass it to Event/Context methods | -| Log + Metric, no Activity | `void`, or `IDisposable?` for a scoped log | -| Event/Context + Log | `void` | - -```csharp -[Activity] -[Info] -[AutoCounter] -Activity? ProcessingOrder(int orderId); - -[Info] -[AutoCounter] -IDisposable? ProcessingBatch(int batchId); // scoped log + counter - -[Event] -[Debug] -void OrderCompleted(Activity? activity, decimal total); -``` - -Return `Activity?`, not `Activity`: it is null when no listeners are active (`TSG3022`). - -## Patterns worth copying - -Full observability on one call: - -```csharp -[Activity] -[Info] -[AutoCounter] -Activity? ProcessingRequest( - [Baggage] string requestId, - [Tag] string endpoint, - [Tag] string method -); -``` - -Selective parameter routing: - -```csharp -[Activity] -[Info] -[Counter] -Activity? ApiCall( - [Baggage] string traceId, // Activity baggage only - [ExcludeTargets(Targets.Metrics)] string verboseMessage, // Activity + log - [InstrumentMeasurement] - [ExcludeTargets(Targets.Activities | Targets.Logging)] - int callCount, // metrics only - [Tag] string endpoint // all three -); -``` - -## Why bother - -One method definition instead of three call sites; the same parameters feed every family, so they -cannot drift; everything is emitted together; a change lands once; and it is one call rather than -several. - -## Diagnostics you will meet here - -| Diagnostic | Fix | -| --- | --- | -| `TSG1001` | Add an explicit target attribute, or `[Exclude]`. | -| `TSG1002` | One Activity, Logging and Metrics attribute per method. | -| `TSG1006` | `[ExcludeTargets]` names a target the method does not have — remove it, or add the target attribute. | -| `TSG1007` | Exclusions left a target with no valid parameters — adjust them. | - -The `purview-telemetry-diagnostics` skill carries the full `TSG` catalogue. diff --git a/.agents/skills/purview-telemetry-quickstart/SKILL.md b/.agents/skills/purview-telemetry-quickstart/SKILL.md deleted file mode 100644 index 1743ffe..0000000 --- a/.agents/skills/purview-telemetry-quickstart/SKILL.md +++ /dev/null @@ -1,140 +0,0 @@ ---- -name: purview-telemetry-quickstart -description: Get started with Purview.Telemetry.SourceGenerator in a C# project. Use when adding the package, creating a first telemetry interface, registering it in DI, or asking how to begin with Purview telemetry. -license: MIT -compatibility: C# projects using Purview.Telemetry.SourceGenerator. -metadata: - author: Purview-Dev - version: "1.0" ---- - -# Quickstart: Purview Telemetry Source Generator - -This skill helps you bootstrap telemetry generation in a C# project using `Purview.Telemetry.SourceGenerator`. - -## Installation - -Add the analyzer package to your project: - -```xml - - all - analyzers - -``` - -Also add runtime dependencies for the telemetry types you use: - -- `System.Diagnostics.DiagnosticSource` for Activities -- `Microsoft.Extensions.Logging.Abstractions` for ILogger -- `System.Diagnostics.Metrics` for metrics (built-in on .NET 6+) - -## Define a telemetry interface - -Create a `public interface` and decorate it with class-level attributes. The generator creates the implementation and a DI registration extension. - -### Single-target examples - -```csharp -using Purview.Telemetry; - -[Logger] -public interface IOrderServiceLogs -{ - [Info] - void OrderPlaced(int orderId, string customerName); - - [Warning] - void OrderNotFound(int orderId); -} -``` - -```csharp -[ActivitySource] -public interface IOrderServiceTracing -{ - [Activity] - Activity? PlacingOrder(int orderId); - - [Event] - void OrderValidated(Activity? activity, int orderId); -} -``` - -```csharp -[Meter] -public interface IOrderServiceMetrics -{ - [Counter] - void OrderPlaced(int itemsInOrder); - - [Histogram] - void OrderProcessingTime(long milliseconds); -} -``` - -### Multi-target example - -One interface can generate Activities, Logging, and Metrics from the same methods: - -```csharp -[ActivitySource] -[Logger] -[Meter] -public interface IOrderServiceTelemetry -{ - [Activity] - [Info] - [AutoCounter] - Activity? PlacingOrder(int orderId, [Baggage] string region); - - [Event] - [Trace] - void OrderProcessed(Activity? activity, long durationMs); - - [Warning] - void OrderFailed(int orderId, Exception exception); -} -``` - -## Register with DI - -The generator creates an extension method named `Add{InterfaceNameWithoutI}()`: - -```csharp -services.AddOrderServiceTelemetry(); -``` - -Inject the interface into your service: - -```csharp -public class OrderService(IOrderServiceTelemetry telemetry) -{ - public void PlaceOrder(int orderId) - { - using var activity = telemetry.PlacingOrder(orderId, "EMEA"); - // ... - telemetry.OrderProcessed(activity, stopwatch.ElapsedMilliseconds); - } -} -``` - -## Register names with OpenTelemetry - -The generator records the generated meter and activity source names in every assembly's metadata via `[assembly: GeneratedTelemetryNames]`. In the project that registers them with OpenTelemetry, opt into the `TelemetryNames` class — it aggregates that project's names with the names recorded by every assembly it references: - -```csharp -// Program.cs or Properties/AssemblyInfo.cs of the host project -[assembly: TelemetryGeneration(GenerateTelemetryNamesClass = true)] -``` - -```csharp -builder.AddServiceDefaults(TelemetryNames.MeterNames, TelemetryNames.ActivitySourceNames); -``` - -Libraries need no configuration: they publish their names through the attribute, and the host picks them up. A project referenced *by* the telemetry owners (an Aspire-style `ServiceDefaults`) cannot aggregate them — generate the class in the host and pass the arrays down. - -## Next steps - -- To migrate existing `ILogger`, `ActivitySource`, or metrics code, use `telemetry-sourcegenerator-migration`. -- For design guidance and best practices, use `telemetry-sourcegenerator-design`. diff --git a/.agents/skills/purview-telemetry/SKILL.md b/.agents/skills/purview-telemetry/SKILL.md deleted file mode 100644 index d2f42d7..0000000 --- a/.agents/skills/purview-telemetry/SKILL.md +++ /dev/null @@ -1,124 +0,0 @@ ---- -name: purview-telemetry -description: >- - Use when adding, reviewing or scaling observability in a .NET project — logging, tracing, metrics, - OpenTelemetry wiring — or when deciding whether a project is "too small for telemetry". Recommends - Purview.Telemetry.SourceGenerator at every project size, keeps libraries free of global provider - configuration, and scales the export infrastructure rather than the instrumentation. -license: MIT -metadata: - author: Purview-Dev - version: "1.0" - repository: purview-dev/engineering-playbook ---- - -# Purview telemetry - -**Telemetry is a baseline, not an advanced topic.** Instrument from the first commit at every project -size. What changes with scale is the *export and operations* story — collectors, dashboards, sampling -— not whether the code emits anything. - -A project that defers telemetry until it becomes distributed acquires its observability at exactly -the moment it can least afford the refactor. - -## Instrumentation versus export - -Keep these separate; conflating them is what produces "we're too small for telemetry". - -| | What it is | Who owns it | -| -- | -- | -- | -| **Instrumentation** | The log, span and measurement the code emits | Every project, every size, from day one | -| **Export** | Where signals go: console, OTLP, a backend, a dashboard | The application host, sized to the operation | - -A small CLI is fully instrumented and exports to the console. That is not a reduced form of -telemetry; it is the correctly sized export for a CLI. - -## Use the generator - -`Purview.Telemetry.SourceGenerator` turns an attributed interface into logging, tracing and metrics -implementations plus a DI registration extension. One declaration, three signals, no hand-written -`ILogger` message templates or `ActivitySource` plumbing. - -Do **not** reinvent its API here. The three shipped skills are authoritative and travel with the -package: - -- `telemetry-sourcegenerator-quickstart` — adding the package, the first interface, DI registration, - and publishing meter/activity-source names to the host via `TelemetryNames` -- `telemetry-sourcegenerator-design` — designing telemetry interfaces well -- `telemetry-sourcegenerator-migration` — moving existing `ILogger`/`ActivitySource`/metrics code onto - the generator - -Recommend the generator whenever the project targets a compatible TFM and the team is willing to take -an analyzer-only package reference. Where it is not compatible, fall back to the standard .NET -abstractions below — never to a bespoke logging wrapper. - -## Libraries versus hosts - -This is the rule most often broken, and it is not negotiable. - -**A reusable library:** - -- Emits through `ILogger`, `ActivitySource` and `Meter` — or through generated telemetry - interfaces, which produce exactly those. -- Publishes its activity-source and meter names so a host can subscribe. The generator does this for - you through assembly metadata. -- **Never** calls `AddOpenTelemetry`, configures an exporter, sets a sampler, or requires a specific - backend. -- Never reads an OTLP endpoint from configuration itself. - -**The application host:** - -- Owns provider configuration, exporters, sampling and resource attributes. -- Subscribes to the sources its libraries publish — with the generator, by opting into the - `TelemetryNames` class and passing its arrays to the OpenTelemetry builder. - -A library that configures a global provider breaks every consumer that already configured one, and -silently wins or loses depending on initialisation order. - -## Sizing the export - -| Scale | Export and operations | -| -- | -- | -| **Small** | Console or a single OTLP endpoint. Structured logs, exceptions recorded on the span. No collector, no dashboards, no custom exporter, no distributed tracing infrastructure. | -| **Medium** | OTLP export, dependency instrumentation (HTTP, EF Core), trace propagation across the integrations, application metrics, health checks, a sampling decision made deliberately. | -| **Large** | End-to-end distributed tracing, standardised resource attributes, operational metrics, dashboards, alerting, SLIs, documented retention and sampling policy. | - -Full detail per level: `references/observability-levels.md`. - -Instrumentation is identical across all three rows. Only the right-hand column grows. - -## Baseline for any application - -- Structured logging — parameters as fields, never interpolated into the message. -- Errors and exceptions recorded as telemetry, with the exception attached to the span. -- Operation correlation, so one unit of work is one trace. -- OpenTelemetry-compatible instrumentation, so the backend stays a choice. -- Log level configurable at runtime. -- Export behaviour configurable per environment. -- Sensitive values — credentials, tokens, connection strings, personal data — never logged or placed - on span attributes or baggage. - -## Before you change anything - -1. **Inspect what exists.** Find current `ILogger` use, `ActivitySource`/`Meter` instances, any - `AddOpenTelemetry` call, a `ServiceDefaults` project. -2. **Preserve it.** Extend existing instrumentation; do not replace working telemetry to adopt a - library. -3. **Do not duplicate registrations.** One registration per source; adding a second is a silent - double-count on every metric. -4. **Size the configuration to the project**, using the table above. -5. **Check for leaking secrets** in anything you add. -6. **Keep instrumentation and export distinct** in what you recommend. - -## Do not - -- Omit telemetry because the application is small. -- Invent Purview telemetry APIs — read the three shipped skills instead. -- Configure a global provider from a library. -- Recommend a collector, dashboard stack or custom exporter for a small project. -- Put a user identifier, token or connection string into a log field, span attribute or baggage item. - -## See also - -- `purview-architecture` — establishing project context and scale before deciding -- [Purview.Telemetry.SourceGenerator](https://github.com/purview-dev/telemetry-sourcegenerator) diff --git a/.agents/skills/purview-telemetry/references/observability-levels.md b/.agents/skills/purview-telemetry/references/observability-levels.md deleted file mode 100644 index df97d78..0000000 --- a/.agents/skills/purview-telemetry/references/observability-levels.md +++ /dev/null @@ -1,93 +0,0 @@ -# Observability levels - -Instrumentation is constant across these levels. Export, infrastructure and operational practice are -what scale. Read this after establishing project complexity — see `purview-architecture`. - -## Small - -*A utility, CLI, prototype, simple API or limited-scope application.* - -**Do:** - -- Structured logging with parameters as fields. -- Exceptions recorded with enough context to reproduce. -- An `ActivitySource` around the unit of work, so a failure has a shape and a duration. -- Console export, or a single OTLP endpoint when one already exists. -- Log level from configuration, so a user can raise it without a rebuild. - -**Do not:** - -- Stand up a collector. -- Adopt a centralised monitoring platform. -- Build distributed tracing infrastructure for a single process. -- Create dashboards nobody reads. -- Write a custom exporter. - -The test: a user reports a failure and you can ask for one log output that tells you what happened. - -## Medium - -*Several functional areas, integrations, moderate domain complexity.* - -Everything above, plus: - -- **Dependency instrumentation** — HTTP clients, EF Core, messaging. These are where latency and - failure actually live, and the instrumentation is a package reference, not code. -- **Trace propagation** across every integration boundary, so a trace survives the process hop. W3C - `traceparent` by default; do not invent a correlation header. -- **Application metrics** for the operations someone would notice: request rate, error rate, duration, - queue depth. Prefer histograms over averages. -- **OTLP export** to a real backend. -- **Health checks**, distinguishing liveness from readiness. -- **A deliberate sampling decision.** Head sampling at a fixed ratio is fine; the point is that it was - chosen rather than defaulted into. - -Common mistake at this level: adding metrics for everything measurable instead of the few that drive -a decision. A metric nobody alerts or decides on is cost without signal. - -## Large - -*Complex domain, multiple services or teams, substantial operational requirements.* - -Everything above, plus: - -- **End-to-end distributed tracing**, including asynchronous hops — message producers and consumers - linked, not orphaned. -- **Standardised resource attributes** — `service.name`, `service.version`, `deployment.environment` - — applied uniformly so cross-service queries work at all. Follow OpenTelemetry semantic conventions - rather than inventing names. -- **Operational metrics** beyond application ones: saturation, dependency health, cost drivers. -- **Dashboards** owned by the team that gets paged. -- **Alerting** on symptoms users feel, not on causes. Alert on error rate and latency; investigate - with CPU and queue depth. -- **Service-level indicators** derived from the telemetry, with objectives agreed with whoever cares. -- **Retention and sampling policy**, documented and costed. Tail sampling if error traces must always - survive. - -## Signal selection - -| Signal | Add when | Warning | -| -- | -- | -- | -| Logs | Always | Unstructured logs are not telemetry; they are strings | -| Traces | Work crosses a process, a dependency or an async boundary | A span per method produces noise, not insight | -| Metrics | Someone would alert on, or decide from, a rate or duration | High-cardinality attributes (user id, request id) are a cost incident | - -Put high-cardinality context on spans and logs, never on metric dimensions. - -## Sensitive information - -At every level, and without exception: - -- No credentials, tokens, keys or connection strings in messages, attributes or baggage. -- No personal data beyond what the system is entitled to process — and where an identifier is - necessary, prefer a pseudonymous one. -- Remember that **baggage propagates across service boundaries**; treat it as the most public place - in your telemetry. -- Redact at the point of emission. A redaction step in the pipeline is a backstop, not a control. - -## Export configuration - -The host owns this. Keep the endpoint, protocol, sampling ratio and resource attributes in -configuration, not in code, so the same build runs in every environment. - -Libraries contribute names and signals; they never contribute configuration. diff --git a/.agents/skills/purview-testing-conventions/SKILL.md b/.agents/skills/purview-testing-conventions/SKILL.md deleted file mode 100644 index 1fe3232..0000000 --- a/.agents/skills/purview-testing-conventions/SKILL.md +++ /dev/null @@ -1,357 +0,0 @@ ---- -name: purview-testing-conventions -description: >- - Use when writing or reviewing tests in a .NET repository following the Purview conventions - TUnit - and TUnit.Mocks, the AAA structure and naming, placing a test in the namespace of the class under - test, CreateXXX construction helpers, building domain content through TestBuilder with Bogus, the - assertion surface, parameterised tests, which tier a test project belongs to, BDTest for - acceptance tests, and Purview.Containers for a suite that needs a real database or queue. -metadata: - product: Purview engineering playbook - repository: purview-dev/engineering-playbook ---- - -# Testing conventions - -| Concern | The rule | -| --- | --- | -| Framework | **TUnit**. Not xUnit, NUnit or MSTest. | -| Substitutes | **TUnit.Mocks**. Not NSubstitute or Moq. | -| Test data | **Bogus**, reached through `TestBuilder`. | -| Acceptance tests | **BDTest** over TUnit, via `BDTest.TUnit`. Not Gherkin, SpecFlow or Reqnroll. | -| A real dependency | **`Purview.Containers`**. Not Testcontainers directly, never a shared instance. | -| Structure | Explicit `// Arrange`, `// Act`, `// Assert` — Given/When/Then in an acceptance test. | -| Naming | `{SubjectUnderTest}_{Scenario}_{Expectation}`, and `async Task`. | -| Placement | One `{Class}Tests` class per class under test, **in the namespace of the class under test**. | -| Construction | Dependencies and the system under test come from `CreateXXX` helpers with optional parameters. | -| Async | The async overload wherever the API offers one — in the test **and in every helper it calls**. Convert a sync helper, or state why it cannot be. | -| Cancellation | If any method the test calls accepts a `CancellationToken`, the test's **last parameter** is one, forwarded to every call that accepts one. | -| Domain content | Built through `TestBuilder`. Never inline. | - -## Why these, specifically - -**One framework.** The SDK wires TUnit into any project whose name ends in a test suffix — that -wiring is why a test project file is empty. A second framework means every project file grows a -conditional and the pipeline grows a second discovery path. That is a rule about the **runner**, not -the style of a test — `BDTest.TUnit` is an adapter *over* TUnit, so an acceptance suite does not break -it. - -**Same namespace as the subject.** The test reads as part of the thing it describes, needs no `using` -to reach the type, and **cannot silently test a different type with the same name**. - -**`CreateXXX` helpers.** A test body that constructs its own dependencies buries the assertion under -setup. A helper with optional parameters says what the test changed and defaults everything else: - -```csharp -static ConventionCatalogue CreateCatalogue(IConventionRepository? repository = null) => - new(repository ?? CreateRepository().Object); -``` - -**`TestBuilder`.** Inline construction encodes a domain type's shape into every test that touches it, -so one constructor change becomes a repository-wide edit. It also destroys the reader's signal about -which values the test depends on, because every literal looks deliberate. - -## A test - -```csharp -using Acme.Builders; - -namespace Acme.Domain; - -public sealed class CustomerIdTests -{ - [Test] - public async Task Create_GivenLowercaseSlug_ReturnsTheValue() - { - // Arrange - var id = TestBuilder.CustomerId("build-enforced"); - - // Act - var value = id.Value; - - // Assert - await Assert.That(value).IsEqualTo("build-enforced"); - } -} -``` - -Two deliberate details: - -- **The empty `// Arrange` block stays.** The comments are what makes a three-line test readable next - to a thirty-line one, and a convention applied "when needed" is applied inconsistently. -- **Assertions are awaited.** `Assert.That(...)` is terminal and returns a value, so - `await Assert.That(result).IsEqualTo(expected)` is the form. **An un-awaited assertion is a test - that cannot fail.** - -## Assertions - -| Form | Use | -| --- | --- | -| `await Assert.That(x).IsEqualTo(y)` / `.IsNotEqualTo(y)` | value equality | -| `await Assert.That(x).IsTrue()` / `.IsFalse()` | booleans | -| `await Assert.That(x).IsEmpty()` | collections — the workhorse of architecture rules | -| `await Assert.That(x).Count().IsEqualTo(2)` | collection size | -| `await Assert.That(x).Contains(y)` / `.DoesNotContain(y)` | membership | -| `await Assert.That(act).Throws()` | a synchronous delegate that should throw | -| `await Assert.That(async () => await f()).Throws()` | an async one | -| `await Assert.That(x).IsTypeOf()` | exact runtime type | -| `await Assert.That(x).IsEquivalentTo(sequence)` | order-independent sequence equality | - -For an exception test the two shapes are `Action` and `Func`. The compiler will not infer -either, so the explicit type is required and is **not** a style violation: - -```csharp -Action act = () => CustomerId.Create(""); - -await Assert.That(act).Throws(); -``` - -## Parameterised tests - -`[Arguments]` puts the interesting values in the attribute rather than a loop, so a failure names the -case: - -```csharp -[Test] -[Arguments("")] -[Arguments(" ")] -[Arguments("Has Spaces")] -[Arguments("has_underscore")] -public async Task Create_GivenSlugThatIsNotALowercaseSlug_Throws(string value) -{ - // Arrange - // Act - Action act = () => CustomerId.Create(value); - - // Assert - await Assert.That(act).Throws(); -} -``` - -## Async all the way down - -**Where an API offers an async overload, use it** — `File.ReadAllTextAsync`, not `File.ReadAllText`. -**And the rule reaches through test helpers:** a helper calling such an API is itself converted. Being -a helper is not an exemption. - -The build enforces the first half and cannot enforce the second, which is why the second needs saying: - -- `VSTHRD103` is an **`error`** and flags a sync call with an `Async`-suffixed equivalent **when the - call sits inside a `Task`-returning method**. In an `async Task` test, `File.ReadAllText` fails the - build. -- A **sync helper is not `Task`-returning**, so the identical call inside it is invisible to the - analyzer. Pushing the call one level down turns a build error into nothing. - -It also compounds with the cancellation rule, which keys off whether anything in the chain accepts a -`CancellationToken`: a sync helper accepts none, so it **silently removes the trigger** and the test is -uncancellable while looking compliant. (TUnit also runs tests in parallel, so a blocking read holds a -thread-pool thread an async read would release.) - -Converting — three things change together, and the first two are not optional: - -```csharp -// Before — invisible to VSTHRD103, and the chain accepts no token -static string Documentation => File.ReadAllText(DocumentationPath); - -// After -static async Task ReadDocumentationAsync(CancellationToken cancellationToken) => - await File.ReadAllTextAsync(DocumentationPath, cancellationToken); -``` - -- It returns a `Task`, bringing every call inside it back under `VSTHRD103`. -- It gains the **`Async` suffix** — `VSTHRD200` is an `error`, so the rename is enforced. -- It takes a trailing `CancellationToken`, because the chain now accepts one; its callers declare and - forward one. - -**A property cannot be `async`, so it becomes a method** — that is the conversion, not an exemption. -A read-only property hiding IO is the most common form of this violation. - -It genuinely cannot be converted when **no async overload exists** (`File.Exists`, `File.Delete`, -`Directory.EnumerateFiles`; likewise `ArchitecturePolicy.Load()` and `PolicySchemaValidator.Validate()`, -which `Purview.Architecture.Testing` ships synchronous-only) or when **a base type or interface fixes -the signature**. State the reason at the call. Never fake it: `Task.Run` around a blocking call, -`Task.FromResult` around a sync result, or `.Result` / `.GetAwaiter().GetResult()` to flatten a task — -the last two are `VSTHRD002`, an `error`. - -## Cancellation - -Three parts, triggered by the **call chain** rather than by the test: - -1. **If any method the test calls accepts a `CancellationToken`, the test declares one.** Not only the - method under test — anything in the chain, including a `File.ReadAllTextAsync` or the delegate handed - to `Assert.That`. -2. **It is the last parameter**, and TUnit supplies the value. With `[Arguments]`, the data binds to the - leading parameters and the token is supplied on top, so the attribute's positional order still matches - the signature: - - ```csharp - [Test] - [Arguments("build-enforced", true)] - public async Task ListEnforcedByBuildAsync_GivenAConvention_FiltersIt( - string id, - bool enforcedByBuild, - CancellationToken cancellationToken - ) - ``` - -3. **It is forwarded to every call that accepts one.** Never `CancellationToken.None`, never `default`, - never a token the test creates. TUnit's token is the *test's* token — cancelled on timeout or on an - aborted run — so a call given `None` cannot be stopped, and **one hop that drops it makes the whole - chain uncancellable**, which is why partial forwarding is a failure and not a lesser version of the - rule. It is also the only place that proves the production code threads the token through at all. - -A test whose chain accepts no token takes no parameter; an unused token is noise, not compliance. - -## Substitutes - -TUnit.Mocks is globally imported by the SDK, so no `using` is needed: - -```csharp -[Test] -public async Task RegisterAsync_GivenAnAlreadyRegisteredConvention_DoesNotStoreIt(CancellationToken cancellationToken) -{ - // Arrange - var repository = CreateRepository(); - repository.ExistsAsync(Any(), Any()).Returns(true); - var catalogue = CreateCatalogue(repository.Object); - - // Act - await Assert - .That(async () => await catalogue.RegisterAsync(TestBuilder.EnforcedConvention(), cancellationToken)) - .Throws(); - - // Assert - repository.AddAsync(Any(), Any()).WasNeverCalled(); -} -``` - -- `Mock.Of()` produces a `Mock`; `.Object` is the instance you pass in. -- `Any()` matches any argument, `Is(value)` a specific one, `AnyArgs()` the whole call. -- `.Returns(value)` sets the result. For a `Task`-returning method, return the `T` — the task is - unwrapped for you. -- `.WasCalled(Times.Once)` and `.WasNeverCalled()` are the assertions. - -The `// Assert` after a `Throws` is not a mistake: that test's point is that the exception was thrown -**and** that nothing was written, and both are assertions about the same act. - -## `TestBuilder` - -It lives in the shared testing project and is the single means by which a test creates domain -content: - -```csharp -public static class TestBuilder -{ - public const int DefaultCount = 3; - - internal static Faker Faker { get; } = new(); - - public static Domain.ConventionId ConventionId(string? value = null) => - Domain.ConventionId.Create(value ?? $"{Slug()}-{Faker.Random.String2(6, LowercaseAlphabet)}"); - - public static Domain.Convention Convention( - Domain.ConventionId? id = null, - string? title = null, - VerificationTier? tier = null, - bool? enforcedByBuild = null) => - Domain.Convention.Create( - id ?? ConventionId(), - title ?? Faker.Lorem.Sentence(4), - tier ?? Faker.Random.Enum(), - enforcedByBuild ?? Faker.Random.Bool()); -} -``` - -Four rules make it work: - -- **Omitted arguments are generated; supplied arguments are used exactly.** A test overrides only the - value it is proving, and everything else is realistic without the test saying so. -- **A collection factory comes with a companion.** `Conventions(int count = DefaultCount)` generates a - distinct set, so a test needing "some" gets "some" without its own loop. -- **Bogus is a global `using`.** `Faker` is available with no import — which is also why an explicit - `using Bogus;` in a shared testing project is reported as unnecessary. -- **A value-object test is the one exception.** A test proving what `Create` and `Hydrate` accept and - reject has to name the rejected input itself, so it constructs the invalid value directly. - Everything valid still goes through the builder. - -## Two constraints that shaped the builder - -Both are consequences of SDK rules, not preferences, and both were found by building it. - -**The factories are flat, not grouped.** The natural shape is a nested class per feature area -(`TestBuilder.Catalogue.Convention(...)`), and it cannot compile: the SDK ships -`dotnet_diagnostic.CA1034.severity = error`, so a publicly visible nested type fails the build, and -`PRSGD0008` refuses to let a repository add `CA1034` to `NoWarn`. Making the group `internal` does -not help either — the SDK's `InternalsVisibleTo` target runs on non-test projects and grants access -*to* test and shared-testing projects rather than *from* them, so a shared testing project's -internals are not visible to the tests beside it. An area that outgrows a flat builder gets its own -top-level builder class. - -**`var` is the house style, with one carve-out.** `csharp_style_var_elsewhere = true:warning` makes -an explicit type on a declaration initialised from a method call a warning (`IDE0007`). The carve-out -is object creation: the `PDS0003` analyzer prefers an explicit type with target-typed `new()`: - -```csharp -var id = TestBuilder.ConventionId("build-enforced"); // method call -> var -string title = new('a', Convention.MaxTitleLength); // new() -> explicit type -``` - -## What is enforced, and what is review - -| Rule | Enforced by | -| --- | --- | -| TUnit is the only framework | the build — the SDK adds it; a second has to be added by hand | -| Test projects are discovered and categorised | the build (name-suffix detection) | -| A shared testing project is referenced, not executed | the build (`IsSharedTestingProject`) | -| Style, including the `var` carve-out | the build (analyzers, `warning` or above) | -| An acceptance suite is categorised `Acceptance` and kept out of the fast tier | the build (name-suffix detection) and the pipeline's `TestFilter` | -| A container-backed suite fails rather than passes when its backend is missing in CI | the pipeline, when the backend is pinned with `PURVIEW_CONTAINERS_BACKEND` | -| AAA structure, naming, `CreateXXX` helpers, `TestBuilder` usage | **review** | -| Given/When/Then chains end in `.BDTestAsync()` | **review** | -| A real dependency comes from `Purview.Containers`, not a shared instance | **review** | -| An async overload is used inside an `async Task` test | the build — `VSTHRD103` is `error` | -| A converted helper carries the `Async` suffix | the build — `VSTHRD200` is `error` | -| A **sync helper** calling an API with an async overload is converted | **review** — a non-`Task`-returning method is outside `VSTHRD103`'s scope | -| A declared `CancellationToken` is the last parameter | the build — `CA1068` is `warning`, and a clean build has no warnings | -| A test whose chain accepts a token declares one and forwards it everywhere | **review** | - -## Acceptance tests and container-backed tests - -An acceptance test — a behaviour somebody outside the team asked for, in their words — is written with -**BDTest over TUnit** (`BDTest.TUnit`) in a `.AcceptanceTests` project, where Given/When/Then -replaces the AAA comments. A suite that needs a real database, queue or emulator gets a throwaway -container from **`Purview.Containers`** in its own `.IntegrationTests` project, skipping -locally when no backend is usable and failing in CI. - -Read `references/acceptance-and-container-tests.md` before writing either: it carries the scenario and -container shapes, and the two traps — a chain that never calls `.BDTestAsync()` runs no steps and still -passes, and a suite that skips in CI turns a missing runtime into a green job. - -## Tiers - -A test project's **name** carries its tier — the SDK categorises `*UnitTests` as `Unit`, and takes the -word before `Tests` as a pattern, so `*AcceptanceTests` gives `Acceptance` with nothing added to the -pipeline. The `TestFilter` then selects a tier without a hand-written attribute. Split a slow suite -into its own project rather than tagging individual tests. - -Filtering uses TUnit's `--treenode-filter`, not `--filter`: these repositories run on -Microsoft.Testing.Platform, where `dotnet test --filter` reports "Zero tests ran". - -## At your scale - -- **One test project.** TUnit, AAA, the naming convention, `TestBuilder`. That is the whole of it. -- **A shared fixture.** Move it into `SharedTestingInfra` and make the class public — a shared - testing project is a library, so its fixtures are legitimately public API and `CA1515` does not - apply. -- **A database or a container.** One `.IntegrationTests` project and one `Purview.Containers` - module. Do not build a fixture framework around it until a second suite needs the same container. -- **A behaviour somebody outside the team asked for.** That, and not before, is when BDTest earns its - place: one `.AcceptanceTests` project with one story. Reach for the HTML report only once - somebody will read it. -- **A package with a documented contract.** Add a consumer-verification script; see - `purview-engineering-principles`. - -## Related skills - -`purview-engineering-principles` for the rules this implements, and `purview-architecture-testing` -for turning an architectural boundary into a failing build. diff --git a/.agents/skills/purview-testing-conventions/references/acceptance-and-container-tests.md b/.agents/skills/purview-testing-conventions/references/acceptance-and-container-tests.md deleted file mode 100644 index e8b9110..0000000 --- a/.agents/skills/purview-testing-conventions/references/acceptance-and-container-tests.md +++ /dev/null @@ -1,117 +0,0 @@ -# Acceptance tests and container-backed tests - -Two shapes that sit outside the unit tier. Both keep TUnit as the runner, and both live in their own -test project so the tier comes from the project name rather than an attribute. - -## Acceptance tests: BDTest - -An acceptance test states a behaviour somebody outside the team asked for, in their words. Use -**BDTest over TUnit through the `BDTest.TUnit` adapter**, in a `.AcceptanceTests` project -(the SDK emits `Category=Acceptance` for it). - -Not Gherkin, SpecFlow or Reqnroll, for two reasons: - -- **BDTest is code-only.** No `.feature` file and no generated test body, so there is no second - artefact that can drift from the step implementing it. That drift is the failure that makes a BDD - suite stop being trusted. -- **One runner stays one runner.** `BDTest.TUnit` is an adapter over TUnit, so the SDK's wiring, the - emitted category and `--treenode-filter` are all unchanged. A BDD framework with its own runner is - exactly what the one-framework rule refuses. - -```csharp -[Story(AsA = "account holder", IWant = "to withdraw money", SoThat = "I can use my savings")] -public class WithdrawalTests : TUnitBDTestBase -{ - AccountSteps Account => new(Context); - - [Test] - [ScenarioText("Withdrawing money reduces the balance")] - public async Task WithdrawMoney() => - await Given(() => Account.CreateAnAccount(100m)) - .When(() => Account.Withdraw(25m)) - .Then(() => Account.TheBalanceIs(75m)) - .BDTestAsync(); -} - -public class AccountSteps(AccountContext context) -{ - [StepText("I have an account with a balance of {0}")] - public void CreateAnAccount(decimal balance) => context.Balance = balance; - - [StepText("I withdraw {0}")] - public void Withdraw(decimal amount) => context.Balance -= amount; - - [StepText("the account balance is {0}")] - public async Task TheBalanceIs(decimal expected) => await Assert.That(context.Balance).IsEqualTo(expected); -} -``` - -Five rules, and the first is the one that bites: - -- **`.BDTestAsync()` runs the scenario.** A chain stopping at `.Then(...)` compiles, passes, and - executes none of its steps — the same failure mode as an un-awaited `Assert.That`. -- **Given/When/Then replaces Arrange/Act/Assert, and only here.** The chain already names the three - phases. Everywhere else the AAA comments stay. -- **`Context` is the only state.** Steps take it through the constructor and hold no fields of their - own; BDTest gives each test its own context, which is what keeps parallel and repeated runs honest. -- **`[StepText]` is written for the report's reader.** `{0}` is replaced with the argument's actual - value at run time, so the report states what the scenario did, not what it was called. -- **Domain content still comes from `TestBuilder`.** The vocabulary changes at the step; the test-data - rule does not. - -Assertions inside a step are ordinary awaited TUnit assertions. `BDTest.Reporting` produces the -single-file HTML report — publish it as a build artifact from the job that ran the suite. - -## A test that needs a real dependency: `Purview.Containers` - -A database, queue, blob store or emulator comes from `Purview.Containers`: a throwaway Linux container -behind one API over Microsoft WSL Containers or Docker, with typed modules for SQL Server, PostgreSQL, -Redis, MySQL, RabbitMQ, Azurite and NATS. - -The two refused alternatives: - -- **A shared instance** (a local SQL Server, a team database) makes tests order-dependent and failures - unreproducible — the state a test found was left by whatever ran before it, on whatever machine. -- **Testcontainers directly** ties the suite to a Docker installation, which on Windows is an install - and a licensing question per developer and per runner. The WSL backend removes it, and the same test - code runs on either. - -```csharp -await using var postgres = new PostgreSqlBuilder() - .WithDatabase("tests") - .WithUsername("postgres") - .WithPassword("postgres") - .Build(); - -await postgres.StartAsync(); - -await using var connection = new NpgsqlConnection(postgres.GetConnectionString()); -await connection.OpenAsync(); -``` - -`Build()` validates the configuration, `StartAsync()` returns only once every wait strategy is -satisfied — there is no sleep to tune — and `await using` disposes the container at end of scope. - -Three rules: - -- **Its own `.IntegrationTests` project**, so the tier is in the name and the suite stays out - of the pull-request filter without anybody remembering an attribute. -- **Skip locally when no backend is usable; fail in CI.** Two different situations, so never one - outcome. Locally, probe and skip. In CI, pin the backend with `PURVIEW_CONTAINERS_BACKEND` — a named - backend never falls back, so a missing runtime fails loudly instead of letting a green job mean - nothing ran: - - ```csharp - [Before(Class)] - public static async Task EnsureABackendIsAvailable() - { - var backends = await ContainerBackends.ProbeAllAsync(); - - Skip.Unless(backends.Any(backend => backend.IsUsable), "No container backend is available."); - } - ``` - - Left unpinned, automatic selection probes in priority order and prefers WSL Containers over Docker. -- **Pin the version exactly.** `Purview.Containers` is **experimental and prerelease** — API, defaults - and packaging rules can change between releases. The packages are a family, so one property in - `Directory.Packages.props` governs all of them and a bump cannot be applied to half. diff --git a/.gitignore b/.gitignore index 35511eb..ebeeb74 100644 --- a/.gitignore +++ b/.gitignore @@ -658,3 +658,10 @@ sketch !scripts/* .tools/purview-build/ + +# Agent skills are installed into the universal .agents/skills/ folder, which is a local install: +# gitignored, and reproducible from the committed skills-lock.json with `just skills-install`. The +# skills this repository authors live in skills/ and are the only ones another repository installs. +# Per-agent folders (including .claude/) are local too - never commit a copy. +.agents/skills/ +.claude/