diff --git a/.changeset/20595-metadata-fs-provenance-anchors.md b/.changeset/20595-metadata-fs-provenance-anchors.md new file mode 100644 index 00000000000..780e3a035a5 --- /dev/null +++ b/.changeset/20595-metadata-fs-provenance-anchors.md @@ -0,0 +1,15 @@ +--- +'@objectstack/metadata-fs': patch +--- + +Provenance comments in `@objectstack/metadata-fs` cite the commit that decided them, not a tracker number that no longer resolves + +Clause-②: no + +Comments and docblocks in the package cited an issue-tracker number that now answers 404 on GitHub. +Each one now cites the commit in this repository's history that made the decision it describes. One of +these docblocks sits on a public method (`FileSystemRepository.close()`), so the reworded text appears in +the published `index.d.ts` / `index.d.cts` and, because esbuild keeps that docblock, in the JavaScript +output (`index.js` / `index.cjs`); the sourcemaps do not change. + +Comment only: no export, type, error code, status, message text or runtime behaviour changes. diff --git a/packages/metadata-fs/src/repository.ts b/packages/metadata-fs/src/repository.ts index d551426a754..888f3920343 100644 --- a/packages/metadata-fs/src/repository.ts +++ b/packages/metadata-fs/src/repository.ts @@ -227,7 +227,7 @@ export class FileSystemRepository implements MetadataRepository { * `terminate()`, which is the same routine the consumer's own * `iterator.return()` runs, so no consumer has to tell "the repository shut * down under me" apart from "I broke my own loop". A synthetic drain event - * would be the wrong shape and was measured to be so (#11021): the + * would be the wrong shape and was measured to be so (commit 7d81c889f): the * subscriptions most in need of draining are exactly the ones whose filter * or numeric `since` drops it, and delivering an event has never ended an * iterator. diff --git a/packages/metadata-fs/src/sync.ts b/packages/metadata-fs/src/sync.ts index 48798bcf766..122a45dcb51 100644 --- a/packages/metadata-fs/src/sync.ts +++ b/packages/metadata-fs/src/sync.ts @@ -38,7 +38,7 @@ export class KeyedMutex { * of event sinks can only express shutdown as "send an event", and an event is * precisely what a filtered or numeric-`since` subscriber is entitled to drop * — and delivering one has never ended an iterator anyway. See invariant 8 in - * `@objectstack/metadata-core`'s `repository.ts` (#11021, #11127). + * `@objectstack/metadata-core`'s `repository.ts` (commit 7d81c889f, #11127). */ export interface BrokerSubscriber { filter: WatchFilter; diff --git a/packages/metadata-fs/test/close-terminates-watch.test.ts b/packages/metadata-fs/test/close-terminates-watch.test.ts index dfff1c7dc75..0d266189d60 100644 --- a/packages/metadata-fs/test/close-terminates-watch.test.ts +++ b/packages/metadata-fs/test/close-terminates-watch.test.ts @@ -100,7 +100,7 @@ describe('FileSystemRepository — close() terminates every live watcher (#11127 ['filtered + numeric `since`', { org: 'system' } as WatchFilter, true], // The row that proves the filter half bites on its own. ['filtered, no `since` at all', { org: 'system' } as WatchFilter, false], - // Not filter-dependent here, unlike the sibling defect in #11021: there is + // Not filter-dependent here, unlike the sibling defect commit 7d81c889f fixed: there is // no drain attempt at all, so the empty filter hangs identically. ['empty filter, no `since`', {} as WatchFilter, false], ['ref-exact filter, no `since`', { org: 'system', type: 'view', name: 'sample_view' } as WatchFilter, false],