@gmod/tabix 3.5.4 → 3.5.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/indexFile.d.ts +35 -2
- package/dist/indexFile.js +79 -7
- package/dist/indexFile.js.map +1 -1
- package/dist/tabix-bundle.js +1 -1
- package/dist/util.d.ts +18 -0
- package/dist/util.js +71 -1
- package/dist/util.js.map +1 -1
- package/esm/indexFile.d.ts +35 -2
- package/esm/indexFile.js +80 -8
- package/esm/indexFile.js.map +1 -1
- package/esm/util.d.ts +18 -0
- package/esm/util.js +70 -1
- package/esm/util.js.map +1 -1
- package/package.json +1 -2
- package/src/indexFile.ts +80 -8
- package/src/util.ts +74 -1
package/dist/indexFile.d.ts
CHANGED
|
@@ -50,6 +50,13 @@ export interface IndexData {
|
|
|
50
50
|
export default abstract class IndexFile {
|
|
51
51
|
filehandle: GenericFilehandle;
|
|
52
52
|
private parseP?;
|
|
53
|
+
/**
|
|
54
|
+
* The signal `parseP` was started under, while it is still in flight. The
|
|
55
|
+
* index is parsed once and shared by every query against the file, so without
|
|
56
|
+
* this the first query to arrive would own a read all the others depend on —
|
|
57
|
+
* see {@link parse}.
|
|
58
|
+
*/
|
|
59
|
+
private parseSignal?;
|
|
53
60
|
constructor({ filehandle }: {
|
|
54
61
|
filehandle: GenericFilehandle;
|
|
55
62
|
});
|
|
@@ -111,8 +118,34 @@ export default abstract class IndexFile {
|
|
|
111
118
|
* @internal
|
|
112
119
|
*/
|
|
113
120
|
blocksForRange(refName: string, min: number, max: number, opts?: Options): Promise<Chunk[]>;
|
|
114
|
-
/**
|
|
115
|
-
|
|
121
|
+
/**
|
|
122
|
+
* Parse the index, or join the parse already running.
|
|
123
|
+
*
|
|
124
|
+
* The index is downloaded and parsed once for the life of this object, so it
|
|
125
|
+
* is the one read here that is shared between queries — and therefore the one
|
|
126
|
+
* place a cancellation can leak from the query that asked for it to a query
|
|
127
|
+
* that did not. `_parse` hands `opts` straight to `readIndexBytes`, so
|
|
128
|
+
* without this the first query to arrive owns a read every other query
|
|
129
|
+
* depends on: when it pans away, every concurrent query fails with its abort.
|
|
130
|
+
*
|
|
131
|
+
* A caller that joined someone else's parse and saw it fail because *they*
|
|
132
|
+
* aborted starts over rather than inheriting the failure — once, then
|
|
133
|
+
* propagates. Bounding it at one attempt is what jbrowse's
|
|
134
|
+
* `RemoteFileWithRangeCache.joinChunk` does with the same retry one layer
|
|
135
|
+
* down, and for the reason it gives: the pathological case becomes one
|
|
136
|
+
* duplicate parse rather than a recursion whose depth depends on how the
|
|
137
|
+
* aborts interleave.
|
|
138
|
+
*
|
|
139
|
+
* A retry rather than the reference count `chunkCache` gets from
|
|
140
|
+
* `@gmod/abortable-promise-cache`, because the index is parsed once for the
|
|
141
|
+
* life of the object: there is no repeated waste to recover, and this is a
|
|
142
|
+
* dozen lines against restructuring the memo. `@gmod/bam`'s `IndexFile` and
|
|
143
|
+
* `@gmod/cram`'s `CraiIndex` make the same split for the same reason.
|
|
144
|
+
*
|
|
145
|
+
* @internal
|
|
146
|
+
*/
|
|
147
|
+
parse(opts?: Options, retried?: boolean): Promise<IndexData>;
|
|
148
|
+
private startParse;
|
|
116
149
|
/** @internal */
|
|
117
150
|
hasRefSeq(seqId: number, opts?: Options): Promise<boolean>;
|
|
118
151
|
}
|
package/dist/indexFile.js
CHANGED
|
@@ -5,6 +5,13 @@ const util_ts_1 = require("./util.js");
|
|
|
5
5
|
class IndexFile {
|
|
6
6
|
filehandle;
|
|
7
7
|
parseP;
|
|
8
|
+
/**
|
|
9
|
+
* The signal `parseP` was started under, while it is still in flight. The
|
|
10
|
+
* index is parsed once and shared by every query against the file, so without
|
|
11
|
+
* this the first query to arrive would own a read all the others depend on —
|
|
12
|
+
* see {@link parse}.
|
|
13
|
+
*/
|
|
14
|
+
parseSignal;
|
|
8
15
|
constructor({ filehandle }) {
|
|
9
16
|
this.filehandle = filehandle;
|
|
10
17
|
}
|
|
@@ -68,13 +75,78 @@ class IndexFile {
|
|
|
68
75
|
}
|
|
69
76
|
return (0, util_ts_1.optimizeChunks)(chunks, this.lowestOffset(ba, min, indexData));
|
|
70
77
|
}
|
|
71
|
-
/**
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
+
/**
|
|
79
|
+
* Parse the index, or join the parse already running.
|
|
80
|
+
*
|
|
81
|
+
* The index is downloaded and parsed once for the life of this object, so it
|
|
82
|
+
* is the one read here that is shared between queries — and therefore the one
|
|
83
|
+
* place a cancellation can leak from the query that asked for it to a query
|
|
84
|
+
* that did not. `_parse` hands `opts` straight to `readIndexBytes`, so
|
|
85
|
+
* without this the first query to arrive owns a read every other query
|
|
86
|
+
* depends on: when it pans away, every concurrent query fails with its abort.
|
|
87
|
+
*
|
|
88
|
+
* A caller that joined someone else's parse and saw it fail because *they*
|
|
89
|
+
* aborted starts over rather than inheriting the failure — once, then
|
|
90
|
+
* propagates. Bounding it at one attempt is what jbrowse's
|
|
91
|
+
* `RemoteFileWithRangeCache.joinChunk` does with the same retry one layer
|
|
92
|
+
* down, and for the reason it gives: the pathological case becomes one
|
|
93
|
+
* duplicate parse rather than a recursion whose depth depends on how the
|
|
94
|
+
* aborts interleave.
|
|
95
|
+
*
|
|
96
|
+
* A retry rather than the reference count `chunkCache` gets from
|
|
97
|
+
* `@gmod/abortable-promise-cache`, because the index is parsed once for the
|
|
98
|
+
* life of the object: there is no repeated waste to recover, and this is a
|
|
99
|
+
* dozen lines against restructuring the memo. `@gmod/bam`'s `IndexFile` and
|
|
100
|
+
* `@gmod/cram`'s `CraiIndex` make the same split for the same reason.
|
|
101
|
+
*
|
|
102
|
+
* @internal
|
|
103
|
+
*/
|
|
104
|
+
async parse(opts = {}, retried = false) {
|
|
105
|
+
(0, util_ts_1.throwIfAborted)(opts.signal);
|
|
106
|
+
const pending = this.parseP;
|
|
107
|
+
if (!pending) {
|
|
108
|
+
return this.startParse(opts);
|
|
109
|
+
}
|
|
110
|
+
// read before awaiting: the owner is forgotten as soon as the parse settles
|
|
111
|
+
const ownerSignal = this.parseSignal;
|
|
112
|
+
try {
|
|
113
|
+
return await pending;
|
|
114
|
+
}
|
|
115
|
+
catch (e) {
|
|
116
|
+
if (retried || !ownerSignal?.aborted || opts.signal?.aborted) {
|
|
117
|
+
throw e;
|
|
118
|
+
}
|
|
119
|
+
return this.parse(opts, true);
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
startParse(opts) {
|
|
123
|
+
const pending = this._parse(opts);
|
|
124
|
+
this.parseP = pending;
|
|
125
|
+
this.parseSignal = opts.signal;
|
|
126
|
+
// Drop a rejection rather than keeping it, so one transient failure does not
|
|
127
|
+
// poison the index for the lifetime of the file. Identity-checked so a retry
|
|
128
|
+
// started after this settles is not cleared by the attempt it replaced.
|
|
129
|
+
//
|
|
130
|
+
// Written as one try/catch rather than `.then(onFulfilled, onRejected)`
|
|
131
|
+
// because `unicorn/prefer-then-catch` rewrites the two-argument form to
|
|
132
|
+
// `.then(...).catch(...)`, which is not the same thing — that catch would
|
|
133
|
+
// also swallow anything the fulfilment handler threw.
|
|
134
|
+
void (async () => {
|
|
135
|
+
let failed = false;
|
|
136
|
+
try {
|
|
137
|
+
await pending;
|
|
138
|
+
}
|
|
139
|
+
catch {
|
|
140
|
+
failed = true;
|
|
141
|
+
}
|
|
142
|
+
if (this.parseP === pending) {
|
|
143
|
+
if (failed) {
|
|
144
|
+
this.parseP = undefined;
|
|
145
|
+
}
|
|
146
|
+
this.parseSignal = undefined;
|
|
147
|
+
}
|
|
148
|
+
})();
|
|
149
|
+
return pending;
|
|
78
150
|
}
|
|
79
151
|
/** @internal */
|
|
80
152
|
async hasRefSeq(seqId, opts = {}) {
|
package/dist/indexFile.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"indexFile.js","sourceRoot":"","sources":["../src/indexFile.ts"],"names":[],"mappings":";;AAAA,2DAA6C;AAE7C,
|
|
1
|
+
{"version":3,"file":"indexFile.js","sourceRoot":"","sources":["../src/indexFile.ts"],"names":[],"mappings":";;AAAA,2DAA6C;AAE7C,uCAA0D;AAiD1D,MAA8B,SAAS;IAC9B,UAAU,CAAmB;IAC5B,MAAM,CAAqB;IACnC;;;;;OAKG;IACK,WAAW,CAAc;IAEjC,YAAY,EAAE,UAAU,EAAqC;QAC3D,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;IAC9B,CAAC;IAyBD;;;OAGG;IACO,KAAK,CAAC,cAAc,CAAC,IAAa;QAC1C,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;YACzC,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,UAAU,EAAE,IAAI,CAAC,UAAU;SAC5B,CAAC,CAAA;QACF,MAAM,KAAK,GAAG,MAAM,IAAA,uBAAK,EAAC,GAAG,CAAC,CAAA;QAC9B,OAAO;YACL,KAAK;YACL,QAAQ,EAAE,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC;SACzE,CAAA;IACH,CAAC;IAED,gBAAgB;IACT,KAAK,CAAC,SAAS,CAAC,OAAe,EAAE,OAAgB,EAAE;QACxD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACxC,MAAM,KAAK,GAAG,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QAC5C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,CAAC,CAAC,CAAA;QACX,CAAC;QACD,OAAO,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,SAAS,IAAI,CAAC,CAAC,CAAA;IACzD,CAAC;IAED,gBAAgB;IACT,KAAK,CAAC,WAAW,CAAC,OAAgB,EAAE;QACzC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAC7D,OAAO,IAAI,CAAA;IACb,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,cAAc,CACzB,OAAe,EACf,GAAW,EACX,GAAW,EACX,OAAgB,EAAE;QAElB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACxC,MAAM,KAAK,GAAG,SAAS,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QAC5C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,EAAE,CAAA;QACX,CAAC;QACD,MAAM,EAAE,GAAG,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;QACnC,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,OAAO,EAAE,CAAA;QACX,CAAC;QAED,6DAA6D;QAC7D,MAAM,MAAM,GAAY,EAAE,CAAA;QAC1B,KAAK,MAAM,CAAC,KAAK,EAAE,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,EAAE,SAAS,CAAC,EAAE,CAAC;YAC9D,KAAK,IAAI,GAAG,GAAG,KAAK,EAAE,GAAG,IAAI,GAAG,EAAE,GAAG,EAAE,EAAE,CAAC;gBACxC,MAAM,SAAS,GAAG,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;gBAClC,IAAI,SAAS,EAAE,CAAC;oBACd,KAAK,MAAM,CAAC,IAAI,SAAS,EAAE,CAAC;wBAC1B,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;oBAChB,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,IAAA,wBAAc,EAAC,MAAM,EAAE,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE,GAAG,EAAE,SAAS,CAAC,CAAC,CAAA;IACtE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,KAAK,CAAC,KAAK,CAAC,OAAgB,EAAE,EAAE,OAAO,GAAG,KAAK;QAC7C,IAAA,wBAAc,EAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAC3B,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAA;QAC3B,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;QAC9B,CAAC;QAED,4EAA4E;QAC5E,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAA;QACpC,IAAI,CAAC;YACH,OAAO,MAAM,OAAO,CAAA;QACtB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,IAAI,OAAO,IAAI,CAAC,WAAW,EAAE,OAAO,IAAI,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC;gBAC7D,MAAM,CAAC,CAAA;YACT,CAAC;YACD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QAC/B,CAAC;IACH,CAAC;IAEO,UAAU,CAAC,IAAa;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;QACjC,IAAI,CAAC,MAAM,GAAG,OAAO,CAAA;QACrB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,MAAM,CAAA;QAC9B,6EAA6E;QAC7E,6EAA6E;QAC7E,wEAAwE;QACxE,EAAE;QACF,wEAAwE;QACxE,wEAAwE;QACxE,0EAA0E;QAC1E,sDAAsD;QACtD,KAAK,CAAC,KAAK,IAAI,EAAE;YACf,IAAI,MAAM,GAAG,KAAK,CAAA;YAClB,IAAI,CAAC;gBACH,MAAM,OAAO,CAAA;YACf,CAAC;YAAC,MAAM,CAAC;gBACP,MAAM,GAAG,IAAI,CAAA;YACf,CAAC;YACD,IAAI,IAAI,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;gBAC5B,IAAI,MAAM,EAAE,CAAC;oBACX,IAAI,CAAC,MAAM,GAAG,SAAS,CAAA;gBACzB,CAAC;gBACD,IAAI,CAAC,WAAW,GAAG,SAAS,CAAA;YAC9B,CAAC;QACH,CAAC,CAAC,EAAE,CAAA;QACJ,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,gBAAgB;IAChB,KAAK,CAAC,SAAS,CAAC,KAAa,EAAE,OAAgB,EAAE;QAC/C,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAClC,OAAO,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAA;IACvC,CAAC;CACF;AA5LD,4BA4LC"}
|