Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions .changeset/20595-metadata-fs-provenance-anchors.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion packages/metadata-fs/src/repository.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion packages/metadata-fs/src/sync.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
2 changes: 1 addition & 1 deletion packages/metadata-fs/test/close-terminates-watch.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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],
Expand Down
Loading