Skip to content

feat(reporting): freeze reporting-subscription names before beta.3 - #3546

Open
bokelley wants to merge 153 commits into
mainfrom
bokelley/reporting-subscription-dx-naming
Open

bokelley wants to merge 153 commits into
mainfrom
bokelley/reporting-subscription-dx-naming

Conversation

@bokelley

Copy link
Copy Markdown
Contributor

Naming slice for #3504 (T4 in the approved DX plan, section 3.1): the naming freeze before beta.3. It stacks on #3545 (vectors) → #3544 → #3543 → #3542 → #3534 and the rest of the #3504 stack. Review only feat(reporting): freeze reporting-subscription names before beta.3. It targets main because CI runs only for PRs into main.

Old → new

Every old name stays as a @deprecated alias for one beta.

Old New Where
PrincipalStoreScope, ReportingLedgerSubscriptionPrincipalV1 PrincipalRef { tenantId, principalId } root, /server, /reporting/advanced, /reporting/ledger; used by every reporting-subscription signature (engine, engine store, service hooks, ledger admission, principal runtime)
expectedSubscriptionPeriods owedSubscriptionPeriodsV1 /reporting/advanced (also fixes the module's one V1 outlier)
groupExpectedSubscriptionPeriodsV1 groupOwedSubscriptionPeriodsV1 /reporting/advanced
ExpectedSubscriptionPeriodV1 / …ObligationV1 / …PeriodsInputV1 OwedSubscriptionPeriodV1 / OwedSubscriptionObligationV1 / OwedSubscriptionPeriodsInputV1 /reporting/advanced
subscriptionExpectedReportingPeriodsV1 toExpectedReportingPeriodsV1 (keeps "expected": it feeds the consumer's ExpectedReportingPeriod) /reporting/advanced
lifecycle.recordReportingSubscriptionCoverage recordSubscriptionReadback (it writes readback lists, not subscription_coverage) principal runtime
engine.listPrincipals engine.listSubscriptionPrincipals (one name with the service hook it feeds) engine
createReliableReportingService({ reportingSubscriptions }), createPostgresReliableReportingProductionService({ reportingSubscriptions }) { subscriptions }. Passing both is a PlatformConfigError service, @adcp/reporting-storage/service

After this PR, every function and type on /reporting/advanced carries V1, apart from the deprecated alias, the error classes, a constant and PrincipalRef, which is the facade identity type.

Deviations from the plan

  • Only one of the three option keys collapses here. The service and production-service blocks become subscriptions. createPrincipalLifecycle({ reportingSubscriptions }) doesn't fold into that block yet. That would make the service build and install the lifecycle's subscription section, which is the T5 managed path ("the server installs the lifecycle section and capabilities"). Today the lifecycle must exist before the engine and the service can be built. So the lifecycle key stays as rung-3 wiring, and accountConfigurations is still set on both. T5 removes that duplication.
  • The block keeps today's fields. subscriptions still carries engine, resolvePrincipal, listSubscriptionPrincipals and resolveSubscriptionConfiguration, with the type ReliableReportingSubscriptionsOptionsV1 from /reporting/advanced. The rung-1 shape (maxAccounts, backfillOnRegrant, override hooks) and its suffix-free type are T5. Python calls that type SubscriptionOptions, so T5 should use the same name.
  • The Owed* types are renamed too, not only the three functions the plan lists, so the vocabulary stays consistent. The engine store port keeps listPrincipals, as section 2.4 specifies.

Names checked against Python

The Python SDK hasn't done its naming pass yet. These names follow the section 3.1 table: Python owed_subscription_periods (no suffix) and PrincipalRef(tenant_id, principal_id).

Checks

npm run typecheck, lint:boundaries, check:package-size, Prettier, and 1,277 tests across reporting, principal, server-decisioning and packages/reporting-storage (PostgreSQL suites run in CI). Tests cover each deprecated alias and the both-keys refusal.

Refs #3504

🤖 Generated with Claude Code

bokelley and others added 30 commits October 29, 2026 09:30
Add the pure expectedSubscriptionPeriods rule for AdCP 3.3 principal-level
reporting subscriptions (experimental media_buy.reporting_subscriptions),
the normative period_generation calendar it uses, selector resolution
(exact, finest, all with byte-order ties), scope membership, and a builder
for the 3.3 registration capabilities (configuration_tasks, the deprecated
configuration_task, and the subscriptions block).

createAdcpServerFromPlatform adds media_buy.reporting_subscriptions to
experimental_features only beside a subscriptions block.

installConfiguration now throws a typed ReportingConfigurationImmutableError
with the unchanged message.

The cross-SDK parity table is
test/fixtures/reporting-subscriptions/coverage-cases.json.

Refs #3504

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…al ships

Advertising media_buy.reporting_subscriptions also requires
adcp.principal.supported_sections to list reporting_subscriptions, which the
SDK does not emit yet. Keep the capability builder pure in this slice and add
the feature id together with the principal block in the runtime slice, so an
adopter can never produce a 3.3-invalid capabilities response.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Adopt the rules adcontextprotocol/adcp#8585 settled:

- Selection reads each offering's published standard_dimensions and
  unmapped_dimensions, and fails closed on an offering without them.
- period_timezone: a utc offering matches only UTC or Etc/UTC; a
  source_timezone offering only its own published zone (never an
  account-resolved one).
- The coverage function takes the readback's inactive_intervals in wire
  shape, per-offering timezone_cutovers with previous_timezone
  (account.timezone is now the current zone), and per-offering gaps.
- The parity table fixes the billing-cycle case's scope (both keys, which
  maxProperties 1 forbids), adds cases for the settled rules, and its
  subscriptions are now schema-validated.

The new wire fields are hand-modeled in subscriptions/wire.ts until
3.3.0-beta.2 ships.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
- An empty flight (stop at or before start) overlaps nothing.
- A cutover carries the outgoing stretch's own owing start into E, so two
  cutovers inside one period never owe a period twice.
- Sub-daily periods under a local alignment restart at each local midnight
  on wall-clock multiples (adcp#8588); calendars gain next() and the walk
  iterates by instant with an iteration budget and skip-ahead.
- A billing anchor in a DST fold is interval zero itself.
- A wire authorized_at equal to the chain start continues the chain.
- The start rule lives in one function for the pending owner decision.
- Schema validation accepts unknown reporting-dimension values.
- The parity table grows to 79 cases with obligations on every case and
  non-wire inputs labelled.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
The start bound is the first boundary at or after the later of the
version's accepted_at and the account's authorized_at; a buy is owed every
period that ends after its confirmed_at and overlaps its flight, so the
period in which the buy is confirmed is owed in full. The rule stays in
firstOwedBoundary. Parity table: the mid-period confirmed_at and hourly
cases change, plus every case whose first period contains confirmed_at;
new cases for an ASAP buy confirmed mid-day and a monthly billing buy
confirmed on the 12th.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…time

Opt-in support for the AdCP 3.3 sync_principal reporting_subscriptions
section (experimental media_buy.reporting_subscriptions):

- createPrincipalLifecycle({ reportingSubscriptions }) validates, versions
  and reads back subscriptions (core/reporting-subscription-state.json),
  honours dry_run and expected_configuration_version, applies
  replace_account_configs once per version through a host hook, derives
  action_required from the destination, and emits principal.changed with
  reason reporting_subscription_changed. It also exposes the adcp.principal
  capability block.
- createReportingSubscriptionEngineV1 turns three host hooks into grant
  history, max_accounts slots, precedence, exceptions at cutover instants,
  timezone cutovers, re-grant gaps, accounts_unauthorized, the receipt
  roster and the post-loss receipt window, and computes owed periods with
  the same expectedSubscriptionPeriods rule buyers run.
- createReliableReportingService({ reportingSubscriptions }) advertises
  configuration_tasks and the subscriptions block and adds
  subscription_coverage to summary and periods views.
- createAdcpServerFromPlatform passes capabilities.principal and
  capability_changes through, adds protocol.principal and
  media_buy.reporting_subscriptions to experimental_features, refuses
  subscriptions without the reporting_subscriptions section, and strips
  3.3-only fields for callers pinned below 3.3.

Without the options every response is byte-for-byte unchanged; a golden
transcript captured from the pre-change runtime proves it.

Refs #3504

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
… by release

- readFacts refuses a roster that does not finish within the page cap, as it
  already did for a repeating cursor: a partial roster would read as
  revocations and fabricate accounts_unauthorized entries.
- Callers pinned below 3.2 no longer see protocol.principal once the
  adcp.principal block is removed for them.
- subscription_coverage is added only for callers served 3.3 or later;
  earlier get_reporting_status response shapes are closed.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
The placeholder regex backtracked polynomially on runs of '{' (CodeQL).
Tokenize braces in a single pass instead, which also rejects nested and
unbalanced braces explicitly.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
… test

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
- The principal readback lists inactive_intervals; the engine feeds them
  to the coverage function in wire shape.
- Timezone cutovers carry previous_timezone and gaps are recorded per
  offering_id when covered offerings' boundaries differ.
- authorized_at is the start of the authorization chain: a re-grant inside
  retention keeps it, so the engine stamps the re-grant when authority is
  observed again.
- The service requires standard_dimensions on every offering when
  subscriptions are advertised.
- Responses served at 3.3.0-beta.1 omit the fields its closed schemas do
  not define; they reach callers served 3.3.0-beta.2 or later.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…ts, sharded engine state

Addresses the expert review of the subscription runtime:

- Owed periods are frozen as they elapse and never recomputed; pruning past
  status_retention_days never re-owes or drops an elapsed period. A product,
  package or offering change applies from the E of its observation, and
  periods of that buy starting earlier keep resolving from the buy as it was.
- Change instants come from source data (granted_at, timezone_changed_at,
  resolveRevocationInstant, the overriding configuration's active_until).
- The engine store is sharded per principal and per account; the receipt
  roster is tenant-scoped; an unobserved revocation followed by a new chain
  opens a gap.
- replace_account_configs runs after commit and is retried on failure; a
  destination transport change needs a version; inactive_intervals over 64
  is rejected; shared path_templates that can expand to the same path are
  rejected; the delivery-config clash check is required unless opted out;
  coverage recording rejects oversized lists and no longer bumps
  configuration_version.
- Post-beta.1 fields are gated on the served bundle's schema, and an unknown
  served version emits none of them. prior_versions[] carries configuration
  (adcp#8588).

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…counts

A small max_accounts against a large roster gives every account past the
cap a capacity exception, which can exceed the readback's 1000-entry
limit. The reconcile used to throw for the whole principal on every pass.
Now that subscription keeps its last published lists, every other
subscription still updates, and the pass reports it in readback_overflow
and through onReadbackOverflow.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…criptions

- syncReportingSubscriptionsV1 writes and reads back the
  reporting_subscriptions section through the guarded sync_principal
  lifecycle.
- reportingSubscriptionVersionRecordsV1 rebuilds coverage version records
  from the readback plus the buyer's own per-version configurations, and
  subscriptionExpectedReportingPeriodsV1 maps owed obligations onto the
  consumer runtime's ExpectedReportingPeriod.
- The consumer runtime takes a per-account subscriptionExpectations hook
  fed with the summary view's subscription_coverage, and refreshes on an
  authenticated principal.changed through handleAuthenticatedPrincipalChanged.
- createReportingSubscriptionEngineStateStoreV1 persists engine state as one
  CAS document per principal on any AdcpStateStore; PostgresStateStore makes
  it durable with no further migration. A PostgreSQL restart test joins the
  CI backend-contracts step.

Refs #3504

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…ords

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…he buyer side

reportingSubscriptionVersionRecordsV1 no longer takes buyer-recorded
inactive intervals: the readback's inactive_intervals (adcp#8585) pass to
expectedSubscriptionPeriods unchanged. Test offerings publish
standard_dimensions.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
listPrincipals feeds the receipt roster, so a list cut short at the page
cap, or a repeating cursor, now throws instead of returning a partial list,
matching the authorized-account walk.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
- The engine state store follows the engine's sharded interface: one CAS
  document per principal and per (principal, account), with listKeys and a
  tenant-scoped listPrincipals.
- Subscription expectations get the summary's ledger_as_of (minus an
  optional grace) as now, and the hook is documented as requiring a seller
  that materializes subscription obligations.
- Expectation templates must supply coverage; the old default could never
  match an obligation reporting packages or partial coverage.
- principal.changed redeliveries are dropped by idempotency_key, and a
  burst during a run joins one trailing run.
- syncReportingSubscriptionsV1 refuses a deactivation by omission unless
  allowDeactivation, checked against every configuration read it
  replaces, and verifies the stored configuration field by field.
- reportingSubscriptionVersionRecordsV1 falls back to the readback's
  configuration and prior_versions[].configuration (adcp#8588).

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Owed-set generations for AdCP 3.3 principal-level reporting subscriptions
(#3504): one generation per (account, owning principal, subscription_id,
subscription_version, resolved offering), with an immutable `subscription`
block and a mutable `owedSet` horizon outside the fingerprint.

- producer.planSubscriptionObligations installs each generation once,
  writes every frozen owed obligation with its own period, media buys and
  constituents (periodOrdinal = start second), and then advances
  owedSet.through on every generation the subscription owns.
- Coverage treats an owed set as complete by construction: gaps are not
  owed, so there is no continuity error, and the scope stays open until
  owedSet.through reaches its end.
- get_reporting_status, get_media_buy_delivery and sync_reporting_status
  scope subscription generations to the caller's principal
  (resolveSubscriptionPrincipal, snapshot `subscription_principal`).
- Status ingest accepts a status without reporting_obligation_id against an
  owed set only for an existing owed obligation.
- PostgreSQL: additive `subscription_key` column and a unique index on
  (account_id, delivery_config_id, delivery_config_version,
  subscription_key) replacing the three-column constraint, found and
  dropped by its columns. Mirrored in the memory test store.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…vice

createReliableReportingService({ reportingSubscriptions }) now writes the
engine's frozen owed sets into the ledger every cycle, before account
configurations, and the worker executes them (#3504).

- engine.frozenOwedSets(principal, { accountId? }) returns each
  subscription's frozen obligations, horizon and version configurations;
  engine.listPrincipals(tenantId) lists principals from the engine store.
- Generations go through the same trusted path as installConfiguration
  (resolveSource, resolveCurrency, resolveCoverage), with seller policy from
  the new resolveSubscriptionConfiguration hook. Each obligation freezes the
  authorized constituents of exactly the media buys it owes.
- New options: listSubscriptionPrincipals (required),
  resolveSubscriptionConfiguration (required), resolveSubscriptionAccount and
  onPlanningError. Planning failures are isolated per subscription.
- resolvePrincipal now also scopes get_reporting_status,
  get_media_buy_delivery and sync_reporting_status to the caller's own
  subscription generations.
- Without reportingSubscriptions the service is byte-for-byte unchanged,
  proven by a golden transcript captured from the service before the change.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…ntime timezone data

A source-calendar P1D generation freezes the runtime's tzdb and ICU versions
and the install day into its identity, so the golden differed on CI runners.
The transcript now uses a UTC-aligned offering; the golden is recaptured from
#3509's head (800adfc) and still matches byte for byte.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Deliver principal-level reporting subscription obligations (#3504) to the
owner's destination through managed delivery.

- Destination resolution: the Core service calls a new
  reportingSubscriptions.bindManagedGeneration hook (through the planner's
  bindGeneration) before a managed generation's first obligation. The
  production service supplies createReportingSubscriptionManagedBindingV1:
  version destination_id -> the owner's current destination generation
  (delivery-eligible, pattern and transport matching the frozen
  destination_method) -> a per-account authorization of that
  destination_ref (ensureDestinationAuthorization) -> an immutable binding
  that freezes path_template.
- Bindings are keyed by their Core configuration: the managed migration drops
  the published (account, delivery_config_id, delivery_config_version) key,
  found by its columns.
- path_template is expanded per obligation and passed to adapters as
  delivery_path; object-store names place it inside the collision-free
  generation prefix. Subscription revision rows carry account_id inside the
  committed digest.
- The managed worker re-checks the owner's account authority before
  delivering and before settling; a lost grant holds the materialization
  without spending an attempt, so the obligation stays owed.
- Status subscribers and notification activity reach only the owner of a
  subscription obligation. Production reads are scoped to the caller's
  principal and carry subscription_coverage.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
# Conflicts:
#	scripts/check-package-size.mjs
…bscription-coverage

# Conflicts:
#	scripts/check-package-size.mjs
…dules after merging main

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…/reporting-subscription-runtime

# Conflicts:
#	scripts/check-package-size.mjs
…er merging main

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…ley/reporting-subscription-dx-advanced

# Conflicts:
#	scripts/check-package-size.mjs

@aao-secretariat aao-secretariat Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ladon verdict: Approve

Approve — no changes to review.

This is a subsequent pass. The head commit (147c5fa) and the prior-review commit (e27f6ed) share an identical tree (334891da...); the stack was rebased forward 23 commits but the PR content is byte-for-byte unchanged. The diff delta is empty (0 files changed), and the prior pass was clean with no Critical/High/Medium findings. Nothing new to re-surface.

Decision table walkthrough:

  • Row 1 (critical/high): no findings — skip.
  • Row 2 (gated_paths + not approved): gated_paths is false — skip.
  • Row 3 (deleted high-risk): high_risk false — skip.
  • Rows 4–5 (medium + category/high-risk): no findings — skip.
  • Row 6 (sticky escalate): prior decision was approve, not escalate — skip.
  • Row 7 (no-auto-approve team): no team match — skip.
  • Row 8 (≥3 medium): zero medium findings — skip.
  • Row 9: approve.

No author-team gate and no gated-path gate apply. Clean carry-forward of the prior clean approval.

aao-secretariat[bot]
aao-secretariat Bot previously approved these changes Oct 30, 2026

@aao-secretariat aao-secretariat Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ladon verdict: Approve

Approve — subsequent pass, clean diff with no findings.

The delta since the prior approve is a single documentation comment in scripts/check-package-size.mjs recording #3504's measured packed size (26,370,041 bytes) against the unchanged MAX_PACKED_TARBALL_BYTES cap of 26,420,000 (~40 KB headroom). The budget number is correctly left untouched — no behavior change, no changeset impact.

No critical/high/medium findings. Checked: no author no-auto-approve team match, high_risk false, gated_paths false, no deletions. Although review_decision is REVIEW_REQUIRED, gated_paths is false so row 2 does not apply. No escalation trigger fires; falls through to row 9.

bokelley and others added 15 commits October 30, 2026 22:24
A sub-daily billing_cycle was routed to the local sub-daily calendar,
which aligns to local midnight and ignores period_anchor, so every
boundary was off by the anchor's time of day. adcontextprotocol/adcp#8622
makes a sub-daily billing_cycle invalid; refuse it.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…nt_configs

A later write that merely omitted replace_account_configs cleared both the
applied marker and a committed-but-unconfirmed replacement, so a failed host
hook was silently abandoned. An omitted flag now leaves both untouched; an
explicit false clears them, so a later true applies again.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…t owed period end

- An open action_required exception now takes the host's current
  pending_action (url, message, reason) when it changes, keeps its from, and
  notifies principal.changed. It used to keep the first action forever.
- accounts_unauthorized last_owed_period_end takes the latest frozen
  period_end. Frozen periods are not stored in end order, so the last entry
  could under-state the window.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…eporting-subscription-ledger-service

# Conflicts:
#	src/lib/reporting/subscriptions/engine.ts
…elley/reporting-subscription-dx-errors

# Conflicts:
#	src/lib/reporting/subscriptions/engine.ts

@aao-secretariat aao-secretariat Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ladon verdict: Approve

Approve — clean pass on the 6-file delta (3 source, 3 test), no blocking or medium findings.

Checked:

  • calendar.ts:272 — refuses sub-daily billing_cycle alignment per adcp#8622 (fail-closed, correct).
  • engine.ts:808-815 — refreshes open action_required exclusion on host pending-action change (JCS-canonical compare, from preserved, mutates live target.exclusions via open, sets changed); latestPeriodEnd uses a max-scan instead of withheld.at(-1) since frozen periods aren't end-ordered — non-empty guaranteed by the withheld.length guard. Correct.
  • reporting-subscriptions.ts:357 — narrows one-shot reset from !== true to === false, fixing a durable-state bug where an omitted flag wiped a committed-but-failed replace retry; covered by new regression test.

Witness-not-translator, version-pathway, official-transport, and changeset coverage all satisfied (changeset present in the stack). No new I/O. No no-auto-approve team match; gated_paths false; high_risk false. Prior decision was also approve with no findings. None of decision rows 1–8 fire → row 9 approve.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant