decentraland / squid-management-server / 24801025979

54%

main: 48%

Build Type

Pull #75

github

Committed by LautaroPetaccio

Commit Message

docs: document purge API and log every drop, would-drop, and skip

Address two gaps reviewers flagged:

1. Public types and methods for the schema purge were thinly or
   inconsistently documented while the extracted queries in
   queries.ts already had JSDoc. Bring them up to the same level:
   - src/ports/squids/types.ts: JSDoc on DatabaseName, PurgedSchema,
     PurgeSkipReason (with a short description of each variant),
     PurgeResult, and ISquidComponent.purgeOldSchemas (contract +
     safety rails + logging summary).
   - src/ports/squids/component.ts: JSDoc on SAFE_SCHEMA_NAME,
     purgeSchemasInDatabase (the classification flow),
     getRunningSquidServiceNames (why it's separate from list()),
     and purgeOldSchemas (entry-point contract).

2. Only the final summary line mentioned schema names; there was no
   per-schema trace and a failed DROP was attributed to the whole
   database rather than to the specific schema. Now every candidate
   produces exactly one log line:
   - info: `Dropped schema` (or `(dry-run) Would drop schema`) with
     { database, schema, ageMs }.
   - debug: `Skipped schema` with { database, schema, reason, ageMs }.
   - error: `Failed to drop schema` with { database, schema, ageMs,
     error } when `withTransaction` throws.

   A per-schema try/catch replaces the coarse outer one: a single
   broken DROP is logged and the run continues with the next
   schema instead of aborting the whole database.

Test-side changes: the mock loggers now include `debug: jest.fn()`
so the new skip log doesn't crash against undefined. No assertion
changes — existing tests cover behaviour, not log call counts.

Pull Request Pull Request #75: Purge old, unused squid schemas on a daily schedule

Coverage Stats

72 of 162 branches covered (44.44%)

Branch coverage included in aggregate %.

72 of 93 new or added lines in 3 files covered. (77.42%)

1 existing line in 1 file now uncovered.

223 of 410 relevant lines covered (54.39%)

5.08 hits per line