Backfill offeringId onto offering-contained documents [CLUE-643] - #2980
Conversation
…CLUE-643] Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The scan is ordered by document id, so two documents belonging to the same user essentially never land in the same page and a per-user cache would hit approximately never. Getting the clustering that would make caching pay off means ordering by uid, which needs a new composite collection-group index. Also record that the extracted lookup must avoid import.meta so Jest can load it. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
] A transport error is not evidence that a document has no offering, so it gets its own census bucket rather than joining the two "not found" ones. The extracted lookup throws and each caller decides what to do. Also pin the classification order: class-wide is decided before alreadySet, so a class-wide document that wrongly carries an offeringId is still reported. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
…-643] Adds the paginated collection-group scan that census-tallies every offering-contained document by outcome, type, and space, with RTDB lookups run concurrently per page. Nothing is written yet; dryRun is honored and written stays 0 until a later task drains the resolved lookups into batched writes. Also adds a Jest moduleNameMapper rule stripping a relative import's trailing `.js` extension so ts-jest's default resolver can find the sibling `.ts` file. scripts/ is an ESM package (`"type": "module"`), so its local imports use the `.js` extension per Node's ESM rules, but ts-jest never transpiles that extension away for value imports, and Jest's resolver treats an explicit extension as literal. This is the first script under test that imports another script module as a value rather than only a type, so the gap was previously unexercised.
] Jest resolves only the extensionless specifier to the sibling .ts file, so the tested script uses that form. tsx resolves either, verified against the module. Reverts the moduleNameMapper entry, which rewrote every relative .js import in the repo to fix a scripts-only resolution problem. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
…d report on crash [CLUE-643] Applies the final code review's fix wave to backfill-document-offering-id.ts: derive the Realtime Database URL from the service account instead of hardcoding it, so the script cannot read one environment's offerings and write them onto another's documents; count `written` only after a batch commits so a failed run cannot over-report what landed; print the census in a `finally` and log per-type progress so a crash still leaves a record of how far the run got; and reject a non-string offeringId in the shared RTDB lookup so a legacy numeric value can't silently fail the app's string-typed Firestore query. Adds tests for the new type check, the default dry-run behavior, and per-bucket accounting in the mixed-bucket test. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Corrects three claims that implementation made untrue: per-type queries are not independently resumable, group documents are exempt from the uid derivation rather than from repair, and the order-by uses the "__name__" string so the module needs no runtime firebase-admin import. Adds an "Operating the run" section for the properties that matter to whoever points this at production data: the database URL is derived from the credential rather than named, `written` counts committed writes so a dying run under-reports rather than over-reports, a failed run still prints its census, and there is no resume. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
…E-643] The two Firebase projects do not share an RTDB host pattern: production is collaborative-learning-ec215.firebaseio.com, staging is collaborative-learning-staging-default-rtdb.firebaseio.com. Deriving the URL from the project id produced a wrong host for staging, so the script now looks it up and fails loudly on an unknown project rather than guessing. DATABASE_URL overrides. Also correct the index claim, which a staging run disproved: the collection group index on documents.type is declared in firestore.indexes.json, but that file was reconciled against production, so each environment needs it actually deployed. The first query fails outright without it. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
…nown [CLUE-643] A staging census scanned 209 documents, of which 68 were qa and 46 dev. Those roots are keyed by user id rather than portal, so they matched no space and were labelled "unknown" — while being counted under buckets that say nothing is wrong, because they all short-circuited as alreadySet or skippedClassWide first. A partition document that actually needed repair would have reported as an unrecognized path shape, which reads as an anomaly rather than scratch data. They now get their own bucket, asked before every other question because it is a matter of scope rather than a property of the document. unknownSpace is left meaning what it says. The space label now travels with the classification, so the path is parsed once instead of once per document at each of two sites. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
…LUE-643] TYPES limits the scan to a subset, for a cheap first look before committing to a full sweep; PAGE_SIZE tunes the query page. Both are parsed and validated before anything connects, and an unrecognized type name throws rather than scanning nothing — a typo would otherwise produce a clean empty census that reads exactly like "this type has no problems". The run header now echoes types, page size and mode, so what a run did is recoverable from its log. Also correct the index claim again: the collection group index on documents.type is deployed in neither staging nor production. It was added to the file alongside backfill-group-document-axes.ts, which needs the same index and has not been run. It is a prerequisite for the sweep in every environment. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
CLUE-643] It was created in staging and production on 2026-08-13, and indexes persist, so CLUE-604 inherits a satisfied prerequisite rather than a step to repeat. Kept as a note because the symptom is otherwise baffling: without it the first query fails outright, identically for both sweep scripts. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
CLUE-643] The qa and dev partitions are no longer skipped. Both stores derive their root from the same getRootId, so the Firestore root id is also the RTDB root id; the only missing piece was the portal segment, which sampling production settles as "localhost" for dev and "qa" for qa. `test` takes an arbitrary portal and still cannot be derived, so it reports as an unknown space rather than being guessed at — production has no test documents. A production census also found curriculum supports keyed like "2.2 Initial Challenge Support 1". A "." is illegal in an RTDB path, so those lookups throw and were counted as lookupError, which reads as transient when the failure is permanent. They now get their own bucket, decided before the lookup. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
112,900 documents scanned. Across real data 71,399 need an offeringId and 53 cannot get one — a 99.93% recovery rate from the single source this script uses, which settles the question the spec left open: do not build the offering-tree or fuzzy portal sources. Also records what the per-root split shows and the totals hide: 88% of the unrecoverable residue is qa, whose RTDB side delete-qa-user-data.ts purges while leaving the Firestore metadata behind. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Scanning all 146,105 documents in the collection group confirmed they were the only two with an RTDB-illegal path segment, and both were deleted on 2026-08-20, so keyNotRtdbSafe now reports zero and the real-data residue is 51 rather than 53. Worth recording that neither carried a `unit`, so isInClassUnitContainer could never have misread them — removing them was housekeeping rather than a fix. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The backfill was scoped under CLUE-610 on the theory that shipping the axes work without it would break something for users. It would not: the affected documents never carry `concurrent`, so they cannot reach the container guard that reads `offeringId`'s absence, and every group document -- the only population that can reach it -- already has one. It belongs with the other repairs of the Firestore metadata mirror, which run their own sweeps rather than waiting on CLUE-604's release gate. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
…ffering-id-backfill
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #2980 +/- ##
===========================================
- Coverage 86.82% 72.36% -14.46%
===========================================
Files 1031 1034 +3
Lines 59032 59201 +169
Branches 15733 15775 +42
===========================================
- Hits 51253 42841 -8412
- Misses 7757 16324 +8567
- Partials 22 36 +14
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
collaborative-learning
|
||||||||||||||||||||||||||||
| Project |
collaborative-learning
|
| Branch Review |
CLUE-643-document-offering-id-backfill
|
| Run status |
|
| Run duration | 03m 26s |
| Commit |
|
| Committer | Scott Cytacki |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
|
|
0
|
|
|
0
|
|
|
0
|
|
|
0
|
|
|
4
|
| View all changes introduced in this branch ↗︎ | |
There was a problem hiding this comment.
🟡 Changes recommended
Input deduplication, RTDB key validation, failure reporting, and stale policy documentation need correction before execution.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Adds a repair workflow to recover missing Firestore offeringId values from Realtime Database metadata.
Changes:
- Adds a dry-run-first, paginated backfill script with batched writes.
- Extracts and tests the shared metadata lookup.
- Documents the repair design, census, and sequencing.
File summaries
| File | Description |
|---|---|
scripts/backfill-document-offering-id.ts |
Implements the census and repair. |
scripts/backfill-document-offering-id.test.ts |
Tests classification, pagination, and writes. |
scripts/lib/document-metadata-lookup.ts |
Provides the shared RTDB lookup. |
scripts/lib/document-metadata-lookup.test.ts |
Tests lookup outcomes and failures. |
scripts/find-documents-missing-metadata.ts |
Uses the extracted lookup. |
docs/superpowers/specs/2026-08-13-clue-643-document-offering-id-backfill-design.md |
Documents the repair design and findings. |
Review details
Suppressed comments (1)
docs/superpowers/specs/2026-08-13-clue-643-document-offering-id-backfill-design.md:402
- This final section contradicts the resolved decision at lines 303–307: the production census has already established that additional recovery sources are not worthwhile and that unresolved documents should be reported and left alone. Update this section so readers do not treat the policy as pending.
## Open question, deliberately deferred
What to do about documents whose `offeringId` cannot be recovered. Resolving it needs the
production dry run's numbers — specifically the split between `noMetadataNode` and
`nodeWithoutOfferingId`, and how the residue distributes across spaces and types. The options are
building the offering-tree source, building the fuzzy portal-API match, accepting a documented
residue, or deciding the affected documents are dead and should be deleted. Choosing now would be
guessing.
- Files reviewed: 6/6 changed files
- Comments generated: 4
- Review effort level: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
…UE-643] The realtime database also rejects U+0000-U+001F and U+007F in a path. A key carrying one passed the check, so the lookup threw and the document was counted as a transient lookupError rather than as permanently keyNotRtdbSafe. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
TYPES=problem,problem scanned and counted every problem document twice, and in apply mode could queue the same document again in the second pass. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
After a failed query or commit, the finally block printed only the totals, and main()'s final JSON never ran. So an interrupted apply did not say how many writes had committed, or where. The full result is now logged on failure and attached to the error. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
The write policy and the closing section still called the policy for unrecoverable documents an open question, although the production census settled it: report them and leave them alone. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…-643] Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…t stays deleted [CLUE-643] set with merge writes whether or not the document exists, so a document deleted between the scan and the commit was recreated holding only an offeringId. update refuses a missing document on the server. Because that refusal fails the whole batch, the batch is retried one document at a time, and a deleted document is counted as deletedDuringRun and logged instead of ending the run. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…ffering-id-backfill
…nd share its helpers [CLUE-643] The backfill is the last step of the metadata repair, so it now lives beside the other repair scripts, and their README is its runbook. It imports isRtdbAddressable and resolveDatabaseUrl from the repair's shared modules instead of keeping its own copies, and its duplicate isRtdbAddressable tests are dropped in favor of the ones beside the shared function. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Copilot review overview
🔵 Needs a closer look
A production repair affecting roughly 72,000 metadata records warrants final human validation despite its safeguards and tests.
Review effort: Balanced
Findings: 3
Open (5)
If a Firestore query or batch commit fails,finallyruns butmain()never reaches the final…TYPESis described as a subset, but duplicate valid entries are accepted. For example,… Realtime Database keys also reject ASCII control characters U+0000–U+001F and U+007F. For a segment… Fix backwards description of offering container detection · New Correct reversed isInClassUnitContainer guard semantics · New
Resolved since last review (1)
The script header and design doc said isInClassUnitContainer identifies the offering container by the absence of offeringId. It is the reverse: a missing offeringId marks the class-unit container, and offeringId is the only positive marker of the offering container. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
dougmartin
left a comment
There was a problem hiding this comment.
Looks good 👍
The dry-run default is safe, and nothing I found in the apply path could write a wrong offeringId, write to the wrong document, or recreate a deleted one. The failing codecov checks don't block this: patch is main(), and project comes from missing Cypress uploads on HEAD.
A few non-blocking notes (take or leave). The README one is worth doing before APPLY=1, since the operator relies on that section:
scripts/metadata-repair/backfill-document-offering-id.ts(line 270): the comment says "Firestore's 400-write limit", but the limit is 500, and the sibling scripts say so. Reword to "Batched at 400, well below Firestore's 500-write limit". Optionally, sharekBatchSizefromscripts/metadata-repair/lib/across all three scripts.scripts/metadata-repair/backfill-document-offering-id.ts(lines 35-37): the import comment explains leaving off "the.jsextension that the other scripts here use", but the siblings already import./lib/...without an extension. Delete the comment.scripts/metadata-repair/backfill-document-offering-id.ts(line 291) andscripts/metadata-repair/backfill-document-offering-id.test.ts(lines 445-460): deleting theif (!isNotFound(err)) throw err;guard leaves the suite green, so a non-NOT_FOUND failure could be retried one document at a time with nothing catching it. In the partial-result test, assertdb.batches.length === 2after the failure. Also add a case where the per-document retry hits a non-NOT_FOUND error, to cover line 298.scripts/metadata-repair/backfill-document-offering-id.test.ts(lines 8-20): the type-list test compareskOfferingContainedTypesto a hand-copied literal, so it can't catch drift from the kind registry. Have the test import the constants fromsrc/models/document/document-types.ts. Ideally, also check against the kinds whosecontainerTypeis"offering", plusAxesDocumentfor the rename.scripts/metadata-repair/backfill-document-offering-id.ts(lines 77-95):getSpaceFromFirestorePathre-derives theauthed/demoroot mapping thatresolveSpacealready encodes inscripts/metadata-repair/lib/rtdb-document-index.ts(lines 46-63). Build onresolveSpaceand add only the/classessuffix and theqa/devhandling, or giveresolveSpacean option that acceptsqa/dev.scripts/metadata-repair/backfill-document-offering-id.test.ts(lines 198-212) andscripts/lib/document-metadata-lookup.test.ts(lines 6-23):makeRtdbis identical in both files. Move it into a shared test helper next todocument-metadata-lookup.ts.scripts/metadata-repair/backfill-document-offering-id.test.ts(lines 10-15, 24): these comments restate the JSDoc onkOfferingContainedTypesand the inline comment at script line 80. Delete them.scripts/metadata-repair/backfill-document-offering-id.ts(lines 15-21): "deployed to staging and production on 2026-08-13" is a process record that will go stale. Keep only the requirement: the collection-group index ontype, plus the--forcecaution about deleting undeclared indexes.docs/superpowers/specs/2026-08-13-clue-643-document-offering-id-backfill-design.md(lines 92, 107-111, 135-136, 284-324): several passages are stale or contradicted.- Line 92 still treats the unrecoverable-document policy as open, though lines 339 and 405 settle it.
- Lines 107-111 predict group documents will read as
noMetadataNode/nodeWithoutOfferingId, but the census found them all already set. - Lines 135-136 say "behavior is unchanged", but the lookup now returns a status and treats
""and non-string values as absent. - The 2026-08-20 census tables disagree with the PR's 2026-09-23 numbers. Trim them to a two- or three-line summary of what the census decided.
docs/superpowers/specs/2026-08-13-clue-643-document-offering-id-backfill-design.md(lines 3-6, 115-131): the Branch/Jira process lines and the "Neither existing script is the right host" argument are process history. Drop the Branch line, and compress that section to one sentence.scripts/metadata-repair/README.md(lines 116-119, 127-128): line 128 says "both repairs" print their counts on failure, but the README now covers a third writer that does too. Lines 116-119 promise one line per bucket for each space, but the backfill prints afinished <type>line for each type and puts the per-space counts only in the final or partial-result JSON. Update both lines.- PR description ("What's here") and
scripts/find-documents-missing-metadata.ts: the description calls this file "a small census used while designing this". It's the existing repair for missing unit, investigation and problem fields, and this PR only switches it to the shared lookup. Reword that line.
…LUE-643] All three scripts defined their own kBatchSize of 400, and the backfill's comment called 400 Firestore's limit. It is 500; 400 is the margin the other two scripts already described. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Drops the index's deployment date, which records past events rather than the requirement, and a comment about import extensions that no longer described the sibling scripts. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…-643] Removing either isNotFound guard left the suite green. The partial-result test now asserts no retry batches follow a hard failure, and a new test covers a per-document retry that fails for another reason. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…CLUE-643] The expected list was a hand-copied literal, so it could not catch a type value drifting from the app. It now uses the constants from document-types.ts. Comments that restated the constant's documentation are gone. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…veSpace [CLUE-643] getSpaceFromFirestorePath re-derived the authed and demo root mapping that resolveSpace already encodes. It now calls resolveSpace, appends /classes, and keeps only the qa and dev mapping that resolveSpace deliberately refuses. New tests cover qa, dev and test paths directly. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…E-643] makeRtdb was defined identically in both test files. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…LUE-643] The README said every run prints one line per space and that both repairs attach their counts on failure. The backfill reports per type as it goes and per space only in its final or partial-result JSON, and three scripts now attach their counts. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…CLUE-643] The design still called the unrecoverable-document policy open, predicted group documents would be unrecoverable, and said the shared lookup changed no behavior. The census settled the first two, and the lookup now returns a status and skips an empty or non-string offeringId. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
|
@dougmartin Thanks. I addressed these in the commits since your review:
|


A repair script only — no product code changes, and nothing here has been run against a database in
apply mode.
The problem
isInClassUnitContainer(src/models/document/document-axes.ts) identifies a document's container bythe absence of
offeringId. So an offering-contained document that has noofferingIdon itsFirestore metadata reads as belonging to the class's copy of the unit — the wrong container axis.
71,399 documents across
authedanddemoare in that state. This script recovers the value fromthe realtime database, where the document's own metadata node has carried it all along, and writes
it back.
What's here
find-documents-missing-metadata.tsis the existing repair for metadata documents missing theirunit,investigationandproblem. This PR only switches it to the shared lookup. The one changein what it does: a numeric
offeringIdin the realtime database, which it used to pass on, is nowtreated as absent.
The sweep sits beside the other CLUE-643 repair scripts, and
scripts/metadata-repair/README.mdnow covers it as step 5 of the runbook. It uses those scripts'
isRtdbAddressableandresolveDatabaseUrlrather than its own copies.Documents are scanned by collection group, one
typeat a time, using thecontainerType: "offering"types from document-kinds.ts. Each candidate is classified into exactly one bucket, and only the
resolvedbucket is written —update({ offeringId }), batched, with the written countincremented only after a commit resolves.
updaterather thansetwith merge, so a documentdeleted between the scan and the commit is not recreated holding only an
offeringId. A batch thatfails with NOT_FOUND is retried one document at a time, and the deleted document is counted as
deletedDuringRun. A failed run prints its whole partial result, includingwrittenand theper-type and per-space counts.
"publication"appears in the type list because that is the problem publication's stored value;ProblemPublicationin document-types.ts is the constant's name, not its value. Both"group"and"axes"appear because the generic axes type is mid-rename, and accepting both is what lets thissweep and
backfill-group-document-axes.tsrun in either order.What the production census found (2026-09-23)
A full dry run of this branch against production scanned 112,528 documents. It wrote nothing, and
every document landed in exactly one bucket.
autheddemodevqaBuckets not shown were 0 everywhere:
nodeWithoutOfferingId,unusableDocument,unknownSpace,keyNotRtdbSafeandlookupError.By type:
problemplanningpublicationsupportPublicationaxesgroupA 99.93% recovery rate across real data (
authedanddemo): 71,399 documents to write, and 51that cannot be recovered. Two further recovery sources were considered (walking the offering tree, and
a fuzzy match against the portal API), and neither is worth building for fifty-odd documents. "Report
and leave alone" is the policy, and it is what the script does.
nodeWithoutOfferingIdis 0. No realtime-database node was written without an offering; the onlyfailure mode is the node being absent entirely.
These numbers match the August 20 census for everything that needs a write. The differences are
elsewhere:
axes, and none asgroup.qahas fewer spaces and documents, since its data is periodically purged.keyNotRtdbSafeis 0. The two documents it found in August were deleted by hand. They were 2021supports whose curriculum-authored keys contain a
..Safety
Dry run by default,
APPLY=1to write, mode printed at startup.TYPES=limits the scan to a subsetof types and
PAGE_SIZE=tunes the query page, so a large environment can be sampled before a fullsweep is committed to. A run that dies prints its whole partial result and attaches it to the error,
so it still says what it found and which writes landed.
Idempotency works differently here than in a create-only script: a second run reclassifies the
documents the first one wrote as
alreadySetrather than rewriting them.Requires a deployed index
The collection-group queries need the single-field
COLLECTION_GROUPindex ontype, declared infirestore.indexes.json. It was deployed to staging and production on 2026-08-13, so neither
environment needs anything done. A new environment would need it created before this script runs at
all — the first query fails outright without it. Diff against the deployed indexes before deploying:
an environment may carry indexes absent from the file, which a
--forcedeploy would delete.Sequencing
No app code, no rules change, no client behavior change, so this needs no drain, no deploy window and
no place in the release chain.
It does need to run after the two repairs in #2977. This script finds a document's
realtime-database node through its
context_id, so a wrong one makes the document look unrecoverable;and rows that do not exist yet cannot be scanned at all.
That predicts something worth checking when the repairs run: the 43
authednoMetadataNodedocuments should shrink, because some of them are likely the documents whose
context_idnames thewrong class. If the count does not move, the two populations are disjoint and that is worth knowing
too.
Against CLUE-604's axes backfill it is order-independent, because this script accepts either side of
that rename.
Testing
50 unit tests across 2 suites, against a mock Firestore and a mock realtime database. Worth a look
in review: the bucket classification table, the pagination boundary, the deleted-during-run retry
(only NOT_FOUND is retried one document at a time; any other failure stops the run),
and the
keyNotRtdbSafebucket — a key containing.,#,$,[,],/or an ASCII controlcharacter cannot appear in a realtime-database path, and a lookup on one throws rather than returning
empty.
Not in this PR
Running it.
APPLY=1needs a separate go-ahead, after the repairs in #2977 have been applied.🤖 Generated with Claude Code