@sparkvault/sdk-mobile 7.0.0 → 7.0.2

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/tus.js CHANGED
@@ -1,5 +1,7 @@
1
1
  import { FORGE_URL_REFUSAL, readForgeSessionUrl, readForgeTransferUrl, resolveForgeSessionUrl } from './app-sdk/forge-url.js';
2
2
  import { SPARKVAULT_OWNED_HOST_PATTERNS } from './app-sdk/platform-domains.js';
3
+ import { HEAD_AND_RECEIPT_TIMEOUT_MS, TRANSFER_VERDICT, UPLOAD_EXPIRES_HEADER, classifyTransferResponse, createTransferBudget, parseUploadExpires, resumeOffsetProblem, retryDelayMs, transferJitterKey, } from './app-sdk/transfer-retry.js';
4
+ import { UPLOAD_REFUSAL_CODES } from './app-sdk/upload-publication.js';
3
5
  import { BackgroundTransferError, gateErrorFromBody, SparkVaultMobileError, SparkVaultValidationError, TusUploadError, } from './errors.js';
4
6
  const TUS_VERSION = '1.0.0';
5
7
  /** What a refused Forge URL was refused for, in the words this SDK's errors use. */
@@ -64,9 +66,12 @@ export function allowsHost(allowedHostPatterns) {
64
66
  return hostname => allowedHostPatterns.some(pattern => pattern.test(hostname));
65
67
  }
66
68
  /**
67
- * Parse a Forge error response body (JSON text) into the shared ApiErrorBody
68
- * shape so gate mapping can read its `error.code` / `error.details.resource`.
69
- * Returns an empty body on non-JSON text, which simply matches no gate.
69
+ * Parse a Forge error response body (JSON text), whole, into the shared
70
+ * ApiErrorBody shape: the one reader of a failed answer's body, so gate
71
+ * mapping reads its `error.code` / `error.details.resource` and the transfer
72
+ * policy the refusal Core decided (`error.details.coreCode`) from the same
73
+ * parse. Returns an empty body on non-JSON text, which matches no gate and
74
+ * names no refusal.
70
75
  */
71
76
  function parseErrorBody(text) {
72
77
  if (!text)
@@ -85,9 +90,13 @@ function getErrorName(err) {
85
90
  function getErrorMessage(err) {
86
91
  return err instanceof Error ? err.message : String(err);
87
92
  }
93
+ /** What every path the caller's abort stops reports: the one cancellation the outer catch terminates or keeps by. */
94
+ function cancelledError() {
95
+ return new TusUploadError('Upload cancelled', { phase: 'cancelled' });
96
+ }
88
97
  function ensureNotAborted(signal) {
89
98
  if (signal?.aborted) {
90
- throw new TusUploadError('Upload cancelled', { phase: 'cancelled' });
99
+ throw cancelledError();
91
100
  }
92
101
  }
93
102
  /**
@@ -101,28 +110,231 @@ function parseIntegerHeader(raw, minimum) {
101
110
  const value = Number(raw);
102
111
  return Number.isSafeInteger(value) && value >= minimum ? value : null;
103
112
  }
104
- /**
105
- * Forge's answers that mean the tus session no longer exists: it expired,
106
- * or a DELETE terminated it. One list, so every request that can meet a
107
- * dead session (HEAD, the finalization PATCH, the OS engine's PATCHes,
108
- * DELETE) and the app's own session bookkeeping agree on what "gone" is.
109
- */
110
- const SESSION_GONE_STATUSES = new Set([404, 410]);
111
113
  /**
112
114
  * True when a Forge status says the tus session is gone (expired or
113
115
  * terminated): the persisted session is worthless, and a caller starts a
114
- * fresh upload instead of retrying it.
116
+ * fresh upload instead of retrying it. It is the transfer policy's GONE
117
+ * verdict, so every request that can meet a dead session (HEAD, a PATCH, the
118
+ * OS engine's PATCHes, DELETE) and the app's own session bookkeeping agree on
119
+ * what "gone" is.
115
120
  */
116
121
  export function isSessionGone(status) {
117
- return SESSION_GONE_STATUSES.has(status);
122
+ return Number.isSafeInteger(status) && status > 0 && classifyTransferResponse({ status }).verdict === TRANSFER_VERDICT.GONE;
118
123
  }
119
- function sessionLostError(status, context, phase, cause = null) {
124
+ /**
125
+ * Forge no longer has the session: `coreCode` names the code Core ended it
126
+ * with when the answer named one (`NOT_FOUND`, `UPLOAD_PROTOCOL_RETIRED`, a
127
+ * 412's), none of them a refusal a new upload cannot remedy.
128
+ */
129
+ function sessionLostError(status, context, phase, cause = null, coreCode = null) {
120
130
  return new TusUploadError(`TUS session no longer exists on the server (${status})`, {
121
131
  cause,
122
132
  httpStatus: status,
123
133
  ...context,
124
134
  phase,
125
135
  sessionLost: true,
136
+ coreCode,
137
+ });
138
+ }
139
+ /**
140
+ * How far past the expiry Forge named a session still counts as live: the
141
+ * allowance for a device clock running ahead of Forge's. `Upload-Expires` is
142
+ * read off Forge's clock and compared with the device's; a phone on automatic
143
+ * time is within seconds of Forge, one set by hand is typically minutes fast.
144
+ * The two mistakes cost very differently: a live session judged expired is
145
+ * dropped and its file sent again from byte 0, an expired one judged live
146
+ * costs a single HEAD (Forge answers 410, `sessionLost`). So the margin errs
147
+ * long, and stays small against the 72 h idle window a session lives from its
148
+ * last commit (`@sparkvault/app-sdk/upload-expiry`): a session the clock says
149
+ * lapsed hours ago is still dropped without a request.
150
+ */
151
+ export const SESSION_EXPIRY_CLOCK_MARGIN_MS = 5 * 60 * 1000;
152
+ /**
153
+ * True when the expiry Forge named for a session (`TusSessionInfo.expiresAt`,
154
+ * kept current through `onSessionExpiry`) is past by more than the clock
155
+ * margin: Forge refuses every request to a session past its expiry, so a
156
+ * caller drops it without asking. Within the margin the session is live for
157
+ * all the device clock can tell, and Forge's HEAD decides. An unknown expiry
158
+ * (null) never has passed: only Forge's HEAD can say.
159
+ */
160
+ export function isSessionExpired(expiresAt, now = Date.now()) {
161
+ return typeof expiresAt === 'number' && now > expiresAt + SESSION_EXPIRY_CLOCK_MARGIN_MS;
162
+ }
163
+ /** An answer that arrived: its status, its headers and the body of one that is not a 2xx. */
164
+ function answerOf(status, header, body) {
165
+ return { status, header, body, envelope: parseErrorBody(body), unanswered: null };
166
+ }
167
+ function noAnswer(error) {
168
+ return { status: 0, header: () => null, body: '', envelope: {}, unanswered: error };
169
+ }
170
+ /**
171
+ * The transfer policy's reading of an answer to `request`: what to do next,
172
+ * its `Retry-After`, its `Upload-Offset`, and the refusal Core decided when
173
+ * the answer is one.
174
+ */
175
+ function readOutcome(answer, request) {
176
+ return classifyTransferResponse({
177
+ status: answer.status,
178
+ headers: answer.header,
179
+ details: answer.envelope.error?.details ?? null,
180
+ receipt: request.receipt,
181
+ });
182
+ }
183
+ const CREATE_REQUEST = { label: 'TUS create', phase: 'create', gonePhase: null, receipt: false };
184
+ const RESUME_HEAD_REQUEST = { label: 'TUS HEAD', phase: 'create', gonePhase: 'create', receipt: false };
185
+ const OFFSET_HEAD_REQUEST = { label: 'TUS HEAD', phase: 'upload', gonePhase: 'create', receipt: false };
186
+ const CHUNK_REQUEST = { label: 'Chunk upload', phase: 'upload', gonePhase: 'upload', receipt: false };
187
+ const RECEIPT_REQUEST = { label: 'TUS finalization', phase: 'upload', gonePhase: 'create', receipt: true };
188
+ /** What a caller hears once Forge kept deferring the publication until the upload's idle limit. */
189
+ const RECEIVED_PUBLISHING_MESSAGE = 'Upload received: Forge holds every byte and is still saving the file; it finishes without this device';
190
+ /**
191
+ * What a caller reads for a final refusal whose answer carried no sentence of
192
+ * Core's (a HEAD's, which has no body, naming Core's code in
193
+ * `X-Upload-Refusal` alone): this SDK's own words for each code.
194
+ */
195
+ const REFUSAL_WORDING = new Map([
196
+ [UPLOAD_REFUSAL_CODES.UPLOAD_POOL_FULL, 'This upload could not be saved: the owner\'s storage cannot take the file'],
197
+ [UPLOAD_REFUSAL_CODES.UPLOAD_SUPERSEDED, 'This upload was not saved: a newer upload of this file replaced it'],
198
+ ]);
199
+ /**
200
+ * Core refused the upload for good, in its own words (the answer's body,
201
+ * `details.coreCode` naming Core's code) or, for an answer with no body (a
202
+ * HEAD's, naming the code in `X-Upload-Refusal`), in this SDK's: the
203
+ * account's storage pool cannot take it, or a later upload replaced it. Not
204
+ * `sessionLost`: a new upload of the same file is no remedy.
205
+ */
206
+ function refusedError(status, envelope, coreCode, context, phase, cause = null) {
207
+ const coreMessage = envelope.error?.message;
208
+ const message = typeof coreMessage === 'string' && coreMessage
209
+ ? coreMessage
210
+ : REFUSAL_WORDING.get(coreCode) ?? `Forge did not save this upload: Core refused it for good (${coreCode})`;
211
+ return new TusUploadError(message, { cause, httpStatus: status, code: 'upload_refused', coreCode, ...context, phase });
212
+ }
213
+ /**
214
+ * The failure a request's answer amounts to: the no-answer error as it was
215
+ * classified, a gone session as `sessionLost`, the refusal Core decided in
216
+ * Core's words (`upload_refused`), the receipt's deferral as the
217
+ * received-publishing outcome a caller resumes later (`retryLater`; thrown
218
+ * only once the idle limit ends the asking), a 402 as the typed gate error
219
+ * the JSON HTTP path throws (so callers run their subscribe / add-on UX off
220
+ * one set of types), and every other status as a `TusUploadError` carrying
221
+ * it and its `Retry-After`.
222
+ */
223
+ function failureOf(answer, outcome, request, context) {
224
+ return { error: errorOf(answer, outcome, request, context), outcome, unanswered: answer.unanswered !== null };
225
+ }
226
+ function errorOf(answer, outcome, request, context) {
227
+ if (answer.unanswered)
228
+ return answer.unanswered;
229
+ if (outcome.verdict === TRANSFER_VERDICT.REFUSED && outcome.coreCode !== null) {
230
+ return refusedError(answer.status, answer.envelope, outcome.coreCode, context, request.phase);
231
+ }
232
+ if (outcome.verdict === TRANSFER_VERDICT.GONE && request.gonePhase !== null) {
233
+ return sessionLostError(answer.status, context, request.gonePhase, null, outcome.coreCode);
234
+ }
235
+ if (outcome.verdict === TRANSFER_VERDICT.DEFERRED) {
236
+ return new TusUploadError(RECEIVED_PUBLISHING_MESSAGE, {
237
+ httpStatus: answer.status,
238
+ code: 'upload_received_publishing',
239
+ retryAfterMs: outcome.retryAfterMs,
240
+ ...context,
241
+ phase: 'finalize',
242
+ retryLater: true,
243
+ });
244
+ }
245
+ const gateError = gateErrorFromBody(answer.status, answer.envelope);
246
+ if (gateError)
247
+ return gateError;
248
+ return new TusUploadError(`${request.label} failed: ${answer.status} - ${answer.body.substring(0, 200)}`, {
249
+ httpStatus: answer.status,
250
+ retryAfterMs: outcome.retryAfterMs,
251
+ ...context,
252
+ phase: request.phase,
253
+ });
254
+ }
255
+ /**
256
+ * The session's expiry as its latest answer named it, reported to the
257
+ * caller (`onSessionExpiry`) each time it changes. An answer that names none
258
+ * leaves it unknown: the request may have moved it unread (a commit whose
259
+ * answer was lost, a deferred finalization), and a caller that dropped a
260
+ * session on an expiry Forge has since moved on would re-send a whole file.
261
+ * A request cut short by the caller's abort keeps the last named value: it
262
+ * can only have slid the expiry by that one request's duration.
263
+ */
264
+ class SessionExpiry {
265
+ constructor(known, report) {
266
+ this.known = known;
267
+ this.report = report;
268
+ }
269
+ /** Forge answered (or did not): the expiry is what the answer names. */
270
+ read(answer) {
271
+ this.become(parseUploadExpires(answer.header(UPLOAD_EXPIRES_HEADER)));
272
+ }
273
+ /**
274
+ * A request the OS carries on without JS is about to leave: it may commit
275
+ * chunks, each sliding the expiry, whose answers this upload never reads,
276
+ * possibly while the app is not running.
277
+ */
278
+ forget() {
279
+ this.become(null);
280
+ }
281
+ become(expiresAt) {
282
+ if (expiresAt === this.known)
283
+ return;
284
+ this.known = expiresAt;
285
+ this.report?.(expiresAt);
286
+ }
287
+ }
288
+ /** A backoff the caller's abort cuts short: resolves after `ms`, rejects as cancelled the moment the signal fires. */
289
+ function abortableDelay(ms, signal) {
290
+ return new Promise((resolve, reject) => {
291
+ if (signal?.aborted) {
292
+ reject(cancelledError());
293
+ return;
294
+ }
295
+ const onAbort = () => {
296
+ clearTimeout(timer);
297
+ reject(cancelledError());
298
+ };
299
+ const timer = setTimeout(() => {
300
+ signal?.removeEventListener('abort', onAbort);
301
+ resolve();
302
+ }, ms);
303
+ signal?.addEventListener('abort', onAbort, { once: true });
304
+ });
305
+ }
306
+ /**
307
+ * Resolve once the device is back online; reject as cancelled the moment the
308
+ * caller aborts, the wait's only other end.
309
+ */
310
+ function waitUntilOnline(connectivity, signal) {
311
+ return new Promise((resolve, reject) => {
312
+ let settled = false;
313
+ let unsubscribe = null;
314
+ const settle = (outcome) => {
315
+ if (settled)
316
+ return;
317
+ settled = true;
318
+ unsubscribe?.();
319
+ signal?.removeEventListener('abort', onAbort);
320
+ outcome();
321
+ };
322
+ const onAbort = () => settle(() => reject(cancelledError()));
323
+ if (signal?.aborted) {
324
+ onAbort();
325
+ return;
326
+ }
327
+ signal?.addEventListener('abort', onAbort, { once: true });
328
+ unsubscribe = connectivity.onOnline(() => settle(resolve));
329
+ if (settled) {
330
+ // The listener fired inside the subscribe, before its unsubscribe existed.
331
+ unsubscribe();
332
+ }
333
+ else if (connectivity.isOnline()) {
334
+ // The network came back between the caller's check and the subscribe,
335
+ // so its event would never arrive.
336
+ settle(resolve);
337
+ }
126
338
  });
127
339
  }
128
340
  /**
@@ -156,6 +368,28 @@ async function tusRequest(config, url, init, label, context = {}) {
156
368
  throw new TusUploadError(`${label} failed: ${getErrorMessage(err)}`, { cause, ...context, phase: 'network' });
157
369
  }
158
370
  }
371
+ /**
372
+ * Send a tus request through `tusRequest` and resolve with its answer: a
373
+ * response of any status, or no answer (a network failure or a timeout, as
374
+ * `tusRequest` classified it). The caller's abort and an SDK error still
375
+ * throw, because no retry follows either.
376
+ */
377
+ async function fetchAnswer(config, url, init, label, context) {
378
+ let response;
379
+ try {
380
+ response = await tusRequest(config, url, init, label, context);
381
+ }
382
+ catch (err) {
383
+ if (err instanceof TusUploadError && (err.phase === 'network' || err.phase === 'timeout')) {
384
+ return noAnswer(err);
385
+ }
386
+ throw err;
387
+ }
388
+ if (response.status === 0) {
389
+ return noAnswer(new TusUploadError(`${label} got no answer`, { ...context, phase: 'network' }));
390
+ }
391
+ return answerOf(response.status, name => response.headers.get(name), response.ok ? '' : await response.text().catch(() => ''));
392
+ }
159
393
  /**
160
394
  * Case-insensitive header lookup for adapter results. Native HTTP stacks
161
395
  * hand headers back in whatever case they please (iOS lower-cases them),
@@ -179,50 +413,27 @@ function resolveSessionSource(options, allowedHostPatterns) {
179
413
  if (!istk) {
180
414
  throw new SparkVaultValidationError('resume.istk or forgeUrl is required to resume a TUS upload session');
181
415
  }
182
- return { mode: 'resume', uploadUrl, istk };
416
+ const expiresAt = options.resume.expiresAt ?? null;
417
+ if (expiresAt !== null && !Number.isFinite(expiresAt)) {
418
+ throw new SparkVaultValidationError('resume.expiresAt is an epoch-ms expiry or null', { received: expiresAt });
419
+ }
420
+ return { mode: 'resume', uploadUrl, istk, expiresAt };
183
421
  }
184
422
  if (!options.forgeUrl) {
185
423
  throw new SparkVaultValidationError('forgeUrl is required to create a TUS upload session');
186
424
  }
187
425
  return { mode: 'create', parsed: parseForgeUrl(options.forgeUrl, allowedHostPatterns) };
188
426
  }
189
- async function createTusUpload(config, parsed, fileSize, filename, signal) {
190
- ensureNotAborted(signal);
191
- // Forge's create contract is these three headers: the ingot's name and type
192
- // were set by Core when the ingot was created, and Forge publishes Core's.
193
- const response = await tusRequest(config, parsed.tusEndpoint, {
194
- method: 'POST',
195
- headers: {
196
- 'Tus-Resumable': TUS_VERSION,
197
- 'Upload-Length': String(fileSize),
198
- 'X-ISTK': parsed.istk,
199
- },
200
- signal,
201
- timeoutMs: config.tusPostTimeoutMs,
202
- }, 'TUS POST request', { filename, fileSize });
203
- if (!response.ok) {
204
- const errorText = await response.text().catch(() => '');
205
- // A 402 here is a billable gate hit mid-create (e.g. storage/bandwidth pool
206
- // exhausted). Route it through the same typed-gate mapping as the JSON HTTP
207
- // path so callers handle subscribe / add-on UX off one set of error types.
208
- const gateError = gateErrorFromBody(response.status, parseErrorBody(errorText));
209
- if (gateError) {
210
- throw gateError;
211
- }
212
- throw new TusUploadError(`TUS create failed: ${response.status} - ${errorText}`, {
213
- httpStatus: response.status,
214
- filename,
215
- fileSize,
216
- phase: 'create',
217
- });
218
- }
219
- // Every chunk carries the file's bytes, so the session must live under the
220
- // endpoint it was created at.
221
- const uploadUrl = resolveForgeSessionUrl(response.headers.get('Location'), parsed.tusEndpoint);
427
+ /**
428
+ * The session a create's 2xx opened: where it lives, its chunk geometry and
429
+ * its expiry. Every chunk carries the file's bytes, so the session must live
430
+ * under the endpoint it was created at.
431
+ */
432
+ function readCreatedSession(answer, endpoint, context) {
433
+ const uploadUrl = resolveForgeSessionUrl(answer.header('Location'), endpoint);
222
434
  if (!uploadUrl) {
223
435
  throw new TusUploadError('TUS create response Location header is missing or outside the upload endpoint', {
224
- filename,
225
- fileSize,
436
+ ...context,
226
437
  phase: 'create',
227
438
  });
228
439
  }
@@ -230,111 +441,46 @@ async function createTusUpload(config, parsed, fileSize, filename, signal) {
230
441
  // that is not exactly the negotiated size, so the chunk size is the server's
231
442
  // to dictate via `X-Chunk-Size` (mirrors sdk-js). A client-side guess could
232
443
  // only ever be rejected, so a missing header is a contract violation.
233
- const chunkSizeHeader = response.headers.get('X-Chunk-Size');
444
+ const chunkSizeHeader = answer.header('X-Chunk-Size');
234
445
  const chunkSize = parseIntegerHeader(chunkSizeHeader, 1);
235
446
  if (chunkSize === null) {
236
447
  throw new TusUploadError(`TUS create response missing or invalid X-Chunk-Size header (received ${JSON.stringify(chunkSizeHeader)})`, {
237
- filename,
238
- fileSize,
448
+ ...context,
239
449
  phase: 'create',
240
450
  });
241
451
  }
242
- return { uploadUrl, chunkSize };
452
+ return { uploadUrl, chunkSize, expiresAt: parseUploadExpires(answer.header(UPLOAD_EXPIRES_HEADER)) };
243
453
  }
244
454
  /**
245
- * Ask Forge where a session stands (tus HEAD). This is the only way to learn
246
- * what a background URLSession delivered after the process was killed, and
247
- * what a failed attempt left behind — so resume never re-sends bytes the
248
- * server holds. A status `isSessionGone` recognises means the session
249
- * expired or was terminated: the error carries `sessionLost` so the caller
250
- * drops its persisted session and creates a fresh one rather than retrying
251
- * a dead URL. Any other failure (a 5xx, an auth rejection, a timeout)
252
- * leaves `sessionLost` false: the
253
- * session may well be intact, and treating it as dead would re-upload a
254
- * whole file over a blip.
455
+ * Where a HEAD's 2xx says the session stands: offset, length and chunk
456
+ * geometry, all required (a 2xx without them is not Forge, a captive
457
+ * portal's page being the classic case), and the expiry when named. An
458
+ * offset past the length can only be a corrupt session.
255
459
  */
256
- async function headTusSession(config, uploadUrl, istk, signal, context = {}) {
257
- ensureNotAborted(signal);
258
- const response = await tusRequest(config, uploadUrl, {
259
- method: 'HEAD',
260
- headers: {
261
- 'Tus-Resumable': TUS_VERSION,
262
- 'X-ISTK': istk,
263
- },
264
- signal,
265
- timeoutMs: config.tusPostTimeoutMs,
266
- }, 'TUS HEAD request', context);
267
- if (isSessionGone(response.status)) {
268
- throw sessionLostError(response.status, context, 'create');
269
- }
270
- if (!response.ok) {
271
- const errorText = await response.text().catch(() => '');
272
- const gateError = gateErrorFromBody(response.status, parseErrorBody(errorText));
273
- if (gateError) {
274
- throw gateError;
275
- }
276
- throw new TusUploadError(`TUS HEAD failed: ${response.status} - ${errorText}`, {
277
- httpStatus: response.status,
278
- ...context,
279
- phase: 'create',
280
- });
281
- }
282
- const offset = parseIntegerHeader(response.headers.get('Upload-Offset'), 0);
283
- const length = parseIntegerHeader(response.headers.get('Upload-Length'), 0);
284
- const chunkSize = parseIntegerHeader(response.headers.get('X-Chunk-Size'), 1);
460
+ function readSessionProbe(answer, phase, context) {
461
+ const offset = parseIntegerHeader(answer.header('Upload-Offset'), 0);
462
+ const length = parseIntegerHeader(answer.header('Upload-Length'), 0);
463
+ const chunkSize = parseIntegerHeader(answer.header('X-Chunk-Size'), 1);
285
464
  if (offset === null || length === null || chunkSize === null || offset > length) {
286
- throw new TusUploadError('TUS HEAD response missing or invalid Upload-Offset / Upload-Length / X-Chunk-Size headers', { ...context, phase: 'create' });
465
+ throw new TusUploadError('TUS HEAD response missing or invalid Upload-Offset / Upload-Length / X-Chunk-Size headers', { ...context, phase });
287
466
  }
288
- return { offset, length, chunkSize };
467
+ return { offset, length, chunkSize, expiresAt: parseUploadExpires(answer.header(UPLOAD_EXPIRES_HEADER)) };
289
468
  }
290
469
  /**
291
- * Confirm finalization of a session Forge already holds every byte of: a
292
- * zero-length PATCH at `Upload-Offset: fileSize`. Forge treats any PATCH at
293
- * or past the declared size as "finalize (again) and acknowledge" - it
294
- * re-runs a finalization that failed transiently after the last chunk
295
- * (Core/DynamoDB/billing), and answers 204 for one that already completed.
296
- * Without this a resume that finds the transfer complete would skip straight
297
- * to the status poll and could report a never-activated ingot as done.
298
- *
299
- * 409 means another finalizer holds the lease right now: retry later, the
300
- * session is intact. A status `isSessionGone` recognises means the session
301
- * is gone (`sessionLost`).
470
+ * A session offset the server named (a HEAD's, or a 409's `Upload-Offset`),
471
+ * checked before anything is sent from it: Forge commits whole chunks, so a
472
+ * session stands at a chunk boundary or at the total, never past it, and an
473
+ * answer that says otherwise is not one to resume from.
302
474
  */
303
- async function confirmTusFinalization(config, uploadUrl, istk, fileSize, signal, context = {}) {
304
- ensureNotAborted(signal);
305
- const response = await tusRequest(config, uploadUrl, {
306
- method: 'PATCH',
307
- headers: {
308
- 'Tus-Resumable': TUS_VERSION,
309
- 'Upload-Offset': String(fileSize),
310
- 'Content-Type': 'application/offset+octet-stream',
311
- 'X-ISTK': istk,
312
- },
313
- signal,
314
- timeoutMs: config.tusChunkTimeoutMs,
315
- }, 'TUS finalization request', context);
316
- if (isSessionGone(response.status)) {
317
- throw sessionLostError(response.status, context, 'create');
318
- }
319
- if (response.status === 409) {
320
- throw new TusUploadError('TUS finalization is already in progress on the server; retry shortly', {
321
- httpStatus: 409,
475
+ function checkedServerOffset(offset, geometry, phase, context) {
476
+ const problem = resumeOffsetProblem(offset, { totalSize: geometry.fileSize, chunkSize: geometry.chunkSize });
477
+ if (offset === null || problem !== null) {
478
+ throw new TusUploadError(`Forge named an upload offset this upload cannot continue from (${offset}: ${problem})`, {
322
479
  ...context,
323
- phase: 'upload',
324
- });
325
- }
326
- if (!response.ok) {
327
- const errorText = await response.text().catch(() => '');
328
- const gateError = gateErrorFromBody(response.status, parseErrorBody(errorText));
329
- if (gateError) {
330
- throw gateError;
331
- }
332
- throw new TusUploadError(`TUS finalization failed: ${response.status} - ${errorText.substring(0, 200)}`, {
333
- httpStatus: response.status,
334
- ...context,
335
- phase: 'upload',
480
+ phase,
336
481
  });
337
482
  }
483
+ return offset;
338
484
  }
339
485
  /**
340
486
  * Hard ceiling on a single chunk PATCH regardless of progress. The stall
@@ -343,18 +489,23 @@ async function confirmTusFinalization(config, uploadUrl, istk, fileSize, signal,
343
489
  */
344
490
  const CHUNK_ABSOLUTE_CAP_MS = 60 * 60000;
345
491
  /**
346
- * PATCH one chunk. `stallTimeoutMs` is a STALL watchdog, not a deadline: it
347
- * fires only when no upload progress (and no response) arrives for that long.
348
- * Forge fixes non-final chunks at 50 MB and the client cannot shrink them, so
349
- * an absolute per-request timeout would kill every legitimately slow uplink
350
- * (a 50 MB chunk needs ~3.5 Mbps sustained to beat 120 s) and restart the
351
- * file from byte 0. The final PATCH also waits for Forge to finalize after the
352
- * last byte is sent; a progress-based watchdog gives that the same patience.
492
+ * PATCH one chunk over XHR and resolve with Forge's answer, or with no answer
493
+ * when the connection drops, the request times out or the chunk stalls. Only
494
+ * the caller's abort rejects. `stallTimeoutMs` is a STALL watchdog, not a
495
+ * deadline: it fires only when no upload progress (and no response) arrives
496
+ * for that long. Forge fixes non-final chunks at 50 MB and the client cannot
497
+ * shrink them, so an absolute per-request timeout would kill every
498
+ * legitimately slow uplink (a 50 MB chunk needs ~3.5 Mbps sustained to beat
499
+ * 120 s). The final PATCH also waits for Forge to finalize after the last
500
+ * byte is sent; a progress-based watchdog gives that the same patience.
501
+ * Bytes leaving are a sign of life: they restart the transfer's idle clock
502
+ * (never its failure count, which only the server's confirmation resets).
353
503
  */
354
- function uploadChunk(uploadUrl, istk, chunk, offset, stallTimeoutMs, signal, onChunkProgress) {
504
+ function sendChunkOverXhr(transfer, chunk, offset, stallTimeoutMs, onChunkProgress) {
355
505
  if (typeof XMLHttpRequest === 'undefined') {
356
506
  throw new SparkVaultValidationError('XMLHttpRequest is required for mobile TUS uploads');
357
507
  }
508
+ const { uploadUrl, istk, signal, context } = transfer;
358
509
  return new Promise((resolve, reject) => {
359
510
  const xhr = new XMLHttpRequest();
360
511
  let settled = false;
@@ -376,17 +527,18 @@ function uploadChunk(uploadUrl, istk, chunk, offset, stallTimeoutMs, signal, onC
376
527
  };
377
528
  const abort = () => {
378
529
  xhr.abort();
379
- finish(() => reject(new TusUploadError('Upload cancelled', { phase: 'cancelled' })));
530
+ finish(() => reject(cancelledError()));
380
531
  };
381
532
  if (signal?.aborted) {
382
533
  abort();
383
534
  return;
384
535
  }
385
536
  signal?.addEventListener('abort', abort, { once: true });
537
+ const unanswered = (message, phase) => finish(() => resolve(noAnswer(new TusUploadError(message, { ...context, phase }))));
386
538
  // Settle BEFORE aborting: the abort handler below would otherwise report
387
539
  // the stall as a user cancellation.
388
540
  const stall = (message) => {
389
- finish(() => reject(new TusUploadError(message, { phase: 'timeout' })));
541
+ unanswered(message, 'timeout');
390
542
  xhr.abort();
391
543
  };
392
544
  const armWatchdog = () => {
@@ -396,37 +548,22 @@ function uploadChunk(uploadUrl, istk, chunk, offset, stallTimeoutMs, signal, onC
396
548
  };
397
549
  xhr.upload.onprogress = event => {
398
550
  armWatchdog();
551
+ transfer.budget.alive();
399
552
  if (event.lengthComputable) {
400
553
  onChunkProgress?.(event.loaded);
401
554
  }
402
555
  };
403
556
  xhr.onload = () => {
404
- if (xhr.status >= 200 && xhr.status < 300) {
405
- // Forge answers every PATCH with Upload-Offset, so a 2xx without a
406
- // readable one is not Forge (a captive portal's 200 page is the
407
- // classic case): report no advance and let the stall guard fail the
408
- // attempt, rather than crediting bytes that may never have arrived.
409
- // parseInt would also turn a garbage header into NaN, which slips
410
- // through that guard (every comparison with NaN is false) and ends
411
- // the upload loop as a success.
412
- const newOffset = parseIntegerHeader(xhr.getResponseHeader('Upload-Offset'), 0) ?? offset;
413
- finish(() => resolve(newOffset));
414
- }
415
- else {
416
- const gateError = gateErrorFromBody(xhr.status, parseErrorBody(xhr.responseText));
417
- if (gateError) {
418
- finish(() => reject(gateError));
419
- return;
420
- }
421
- finish(() => reject(new TusUploadError(`Chunk upload failed: ${xhr.status} - ${xhr.responseText.substring(0, 200)}`, {
422
- httpStatus: xhr.status,
423
- phase: 'upload',
424
- })));
557
+ if (xhr.status === 0) {
558
+ unanswered('Chunk upload got no answer', 'network');
559
+ return;
425
560
  }
561
+ const answered = xhr.status >= 200 && xhr.status < 300;
562
+ finish(() => resolve(answerOf(xhr.status, name => xhr.getResponseHeader(name), answered ? '' : xhr.responseText)));
426
563
  };
427
- xhr.onerror = () => finish(() => reject(new TusUploadError('Chunk upload network error', { phase: 'network' })));
428
- xhr.onabort = () => finish(() => reject(new TusUploadError('Chunk upload aborted', { phase: 'cancelled' })));
429
- xhr.ontimeout = () => finish(() => reject(new TusUploadError('Chunk upload timed out', { phase: 'timeout' })));
564
+ xhr.onerror = () => unanswered('Chunk upload network error', 'network');
565
+ xhr.onabort = () => finish(() => reject(new TusUploadError('Chunk upload aborted', { ...context, phase: 'cancelled' })));
566
+ xhr.ontimeout = () => unanswered('Chunk upload timed out', 'timeout');
430
567
  xhr.open('PATCH', uploadUrl);
431
568
  xhr.setRequestHeader('Tus-Resumable', TUS_VERSION);
432
569
  xhr.setRequestHeader('Upload-Offset', String(offset));
@@ -443,56 +580,50 @@ function uploadChunk(uploadUrl, istk, chunk, offset, stallTimeoutMs, signal, onC
443
580
  }
444
581
  /**
445
582
  * PATCH a whole file as the session's only chunk on the app's background
446
- * URLSession. The OS owns the transfer, so it finishes even if iOS suspends
447
- * the app; the trade is no progress events and no abort. The result is mapped
448
- * exactly like the XHR path so callers see one error taxonomy.
583
+ * URLSession and resolve with Forge's answer, or with no answer when the
584
+ * adapter got none. The OS owns the transfer, so it finishes even if iOS
585
+ * suspends the app; the trade is no progress events and no abort. Its answer
586
+ * is read exactly like the XHR path's, so callers see one error taxonomy.
449
587
  */
450
- async function uploadWholeFileInBackground(uploader, uploadUrl, istk, fileUri, offset) {
588
+ async function sendWholeFileInBackground(uploader, transfer, fileUri, offset) {
451
589
  let result;
452
590
  try {
453
- result = await uploader.uploadFile(uploadUrl, fileUri, {
591
+ result = await uploader.uploadFile(transfer.uploadUrl, fileUri, {
454
592
  method: 'PATCH',
455
593
  headers: {
456
594
  'Tus-Resumable': TUS_VERSION,
457
595
  'Upload-Offset': String(offset),
458
596
  'Content-Type': 'application/offset+octet-stream',
459
- 'X-ISTK': istk,
597
+ 'X-ISTK': transfer.istk,
460
598
  },
461
599
  });
462
600
  }
463
601
  catch (err) {
464
602
  // The adapter only throws when no HTTP response came back (offline, DNS,
465
603
  // the OS cancelled the task); an HTTP failure is a status below.
466
- throw new TusUploadError(`Background chunk upload failed: ${getErrorMessage(err)}`, {
604
+ return noAnswer(new TusUploadError(`Background chunk upload failed: ${getErrorMessage(err)}`, {
467
605
  cause: err instanceof Error ? err : null,
606
+ ...transfer.context,
468
607
  phase: 'network',
469
- });
608
+ }));
470
609
  }
471
- const body = typeof result.body === 'string' ? result.body : '';
472
- if (result.status >= 200 && result.status < 300) {
473
- // Forge always answers a PATCH with a readable Upload-Offset. A 2xx
474
- // without one is not Forge (a captive portal's 200 page is the classic
475
- // case), so report no advance: the stall guard fails the attempt and the
476
- // next one asks Forge (HEAD) instead of marking bytes uploaded that may
477
- // never have arrived. Same strict parse as the XHR path (uploadChunk).
478
- return parseIntegerHeader(getHeaderIgnoreCase(result.headers, 'Upload-Offset'), 0) ?? offset;
479
- }
480
- const gateError = gateErrorFromBody(result.status, parseErrorBody(body));
481
- if (gateError) {
482
- throw gateError;
483
- }
484
- throw new TusUploadError(`Chunk upload failed: ${result.status} - ${body.substring(0, 200)}`, {
485
- httpStatus: result.status,
486
- phase: 'upload',
487
- });
610
+ if (!Number.isSafeInteger(result.status) || result.status <= 0) {
611
+ return noAnswer(new TusUploadError(`Background chunk upload got no answer (status ${String(result.status)})`, {
612
+ ...transfer.context,
613
+ phase: 'network',
614
+ }));
615
+ }
616
+ const answered = result.status >= 200 && result.status < 300;
617
+ return answerOf(result.status, name => getHeaderIgnoreCase(result.headers, name), !answered && typeof result.body === 'string' ? result.body : '');
488
618
  }
489
619
  /**
490
620
  * Translate what the OS transfer adapter reports into the SDK's one error
491
621
  * taxonomy, so a caller sees the same `TusUploadError` phases and typed gate
492
622
  * errors whichever engine carried the bytes. Forge's status and body ride
493
- * through untouched: a 402 becomes the gate error the XHR path throws, a
494
- * status `isSessionGone` recognises marks the session lost exactly as HEAD
495
- * would, and any other status keeps its number for the caller's own policy
623
+ * through untouched: the refusal Core decided is `upload_refused` in Core's
624
+ * words as on the XHR path, a 402 becomes the gate error the XHR path
625
+ * throws, a status `isSessionGone` recognises marks the session lost exactly
626
+ * as HEAD would, and any other status keeps its number for the caller's own policy
496
627
  * (a 409 during finalize is a retry-later, not a lost session). The
497
628
  * remaining kinds are transport
498
629
  * outcomes: the caller's own abort is `cancelled`; an OS-ended task
@@ -514,11 +645,19 @@ export function mapBackgroundTransferError(err, context = {}) {
514
645
  const status = err.httpStatus;
515
646
  const body = err.body ?? '';
516
647
  if (status !== undefined) {
517
- const gateError = gateErrorFromBody(status, parseErrorBody(body));
648
+ const envelope = parseErrorBody(body);
649
+ const outcome = Number.isSafeInteger(status) && status > 0
650
+ ? classifyTransferResponse({ status, details: envelope.error?.details ?? null })
651
+ : null;
652
+ if (outcome?.verdict === TRANSFER_VERDICT.REFUSED && outcome.coreCode !== null) {
653
+ return refusedError(status, envelope, outcome.coreCode, context, 'upload', err);
654
+ }
655
+ const gateError = gateErrorFromBody(status, envelope);
518
656
  if (gateError)
519
657
  return gateError;
520
- if (isSessionGone(status))
521
- return sessionLostError(status, context, 'upload', err);
658
+ if (outcome?.verdict === TRANSFER_VERDICT.GONE) {
659
+ return sessionLostError(status, context, 'upload', err, outcome.coreCode);
660
+ }
522
661
  }
523
662
  return new TusUploadError(`Background chunk upload failed: ${status ?? 'unknown status'} - ${body.substring(0, 200)}`, { cause: err, httpStatus: status ?? null, ...context, phase: 'upload' });
524
663
  }
@@ -571,6 +710,29 @@ export class MobileTusUploader {
571
710
  constructor(config) {
572
711
  this.config = config;
573
712
  }
713
+ /**
714
+ * Upload a file over tus: create the session (or resume a kept one), send
715
+ * the bytes Forge does not hold, and resolve once Forge has confirmed the
716
+ * ingot published.
717
+ *
718
+ * Every answer is read through the platform's transfer policy
719
+ * (`@sparkvault/app-sdk/transfer-retry`), and one budget per call bounds
720
+ * every retry, the create's included: a request that got no answer, 408,
721
+ * 425, 429, a 5xx or a lease-held 409 waits its backoff (never shorter than
722
+ * `Retry-After`), then asks Forge where the session stands (HEAD) and sends
723
+ * from there; a 409 carrying `Upload-Offset` continues from that offset at
724
+ * once; a receipt Forge defers (503 with `Retry-After`) is asked again,
725
+ * each time after a longer backoff, without spending a failure until the
726
+ * idle limit ends the upload as `upload_received_publishing`
727
+ * (`retryLater`); a gone session is `sessionLost` (`coreCode` naming the
728
+ * code Core ended it with, when the answer named one); a final refusal of
729
+ * Core's (`UPLOAD_POOL_FULL`, `UPLOAD_SUPERSEDED`) is `upload_refused` in
730
+ * Core's words (`coreCode`); any other 4xx ends the upload with the
731
+ * server's answer. No chunk is ever sent at an offset the server did not just name. While the device is offline (`isOnline`), a request that got
732
+ * no answer spends nothing: the upload waits for the network. The OS
733
+ * transfer engine's range is the exception: the engine chains its own
734
+ * requests, and its failure ends the call for the caller's own retry.
735
+ */
574
736
  async uploadFromUri(options) {
575
737
  const fileReader = this.config.fileReader;
576
738
  if (!fileReader) {
@@ -580,52 +742,65 @@ export class MobileTusUploader {
580
742
  const istk = source.mode === 'create' ? source.parsed.istk : source.istk;
581
743
  const debug = options.debug;
582
744
  const cleanUri = options.fileUri.split('#')[0];
583
- let bytesUploaded = 0;
745
+ const signal = options.abortSignal;
746
+ const fileSize = options.fileSize;
747
+ const context = { filename: options.filename, fileSize };
748
+ const budget = createTransferBudget();
584
749
  // Known up front on resume so a cancel during the HEAD still terminates
585
750
  // the (existing) session.
586
751
  let uploadUrl = source.mode === 'resume' ? source.uploadUrl : null;
752
+ // The last offset the caller heard, so the end of the upload reports 100%
753
+ // exactly once however the last byte was confirmed.
754
+ let reported = null;
755
+ const report = (uploaded) => {
756
+ reported = uploaded;
757
+ options.onProgress?.(uploaded, fileSize);
758
+ };
587
759
  try {
588
- let chunkSize;
589
- let sessionUrl;
760
+ let transfer;
761
+ let position;
590
762
  if (source.mode === 'resume') {
591
- sessionUrl = source.uploadUrl;
592
763
  debug?.log(`Resuming TUS upload for ${options.filename}`);
593
- const probe = await headTusSession(this.config, source.uploadUrl, istk, options.abortSignal, {
594
- filename: options.filename,
595
- fileSize: options.fileSize,
596
- });
597
- // A session is bound to one file: a different length means the
598
- // persisted session belongs to another file (or this file changed),
599
- // and PATCHing into it would corrupt the ingot. That makes the
600
- // session worthless for this file, which is exactly what
601
- // `sessionLost` means: the caller drops it and starts fresh, the same
602
- // as for a 404/410, instead of retrying a resume that can never work.
603
- if (probe.length !== options.fileSize) {
604
- throw new TusUploadError(`TUS session Upload-Length (${probe.length}) does not match the file size (${options.fileSize}); the session belongs to a different file`, { filename: options.filename, fileSize: options.fileSize, phase: 'create', sessionLost: true });
605
- }
606
- chunkSize = probe.chunkSize;
607
- bytesUploaded = probe.offset;
608
- debug?.log(`TUS session for ${options.filename} is at offset ${bytesUploaded}/${options.fileSize}`);
609
- if (bytesUploaded >= options.fileSize) {
610
- // Every byte is there, but the finalization the last chunk should
611
- // have triggered may not have happened (that is often why the
612
- // previous attempt failed): ask Forge to finalize and acknowledge.
613
- await confirmTusFinalization(this.config, sessionUrl, istk, options.fileSize, options.abortSignal, {
614
- filename: options.filename,
615
- fileSize: options.fileSize,
764
+ // A session past the expiry Forge named for it is gone: Forge refuses
765
+ // every request to it, so asking would only spend one to learn that.
766
+ const heldExpiry = source.expiresAt;
767
+ if (heldExpiry !== null && isSessionExpired(heldExpiry)) {
768
+ throw new TusUploadError(`TUS session expired at ${new Date(heldExpiry).toISOString()}`, {
769
+ ...context,
770
+ phase: 'create',
771
+ sessionLost: true,
616
772
  });
617
- options.onProgress?.(bytesUploaded, options.fileSize);
618
773
  }
774
+ const expiry = new SessionExpiry(source.expiresAt, options.onSessionExpiry);
775
+ const link = { uploadUrl: source.uploadUrl, istk, context, expiry, signal };
776
+ const probe = await this.readResumePoint(link, budget, fileSize);
777
+ transfer = { ...link, expiry, fileSize, chunkSize: probe.chunkSize, budget };
778
+ position = { offset: checkedServerOffset(probe.offset, transfer, 'create', context), published: false };
779
+ debug?.log(`TUS session for ${options.filename} is at offset ${position.offset}/${fileSize}`);
619
780
  }
620
781
  else {
621
782
  debug?.log(`Starting TUS upload for ${options.filename}`);
622
- const created = await createTusUpload(this.config, source.parsed, options.fileSize, options.filename, options.abortSignal);
623
- sessionUrl = created.uploadUrl;
624
- uploadUrl = sessionUrl;
625
- chunkSize = created.chunkSize;
783
+ const created = await this.createSession(source.parsed, fileSize, budget, context, signal);
784
+ uploadUrl = created.uploadUrl;
785
+ transfer = {
786
+ uploadUrl: created.uploadUrl,
787
+ istk,
788
+ context,
789
+ expiry: new SessionExpiry(created.expiresAt, options.onSessionExpiry),
790
+ signal,
791
+ fileSize,
792
+ chunkSize: created.chunkSize,
793
+ budget,
794
+ };
795
+ position = { offset: 0, published: false };
626
796
  // Before the first PATCH: once bytes are in flight the session is
627
797
  // worth resuming, so the caller must already hold it.
628
- options.onSessionCreated?.({ uploadUrl: sessionUrl, istk, chunkSize });
798
+ options.onSessionCreated?.({
799
+ uploadUrl: created.uploadUrl,
800
+ istk,
801
+ chunkSize: created.chunkSize,
802
+ expiresAt: created.expiresAt,
803
+ });
629
804
  }
630
805
  // The OS transfer engine, when the app provides one, takes the whole
631
806
  // remaining range in a single hand-off: it chains the chunks itself and
@@ -636,65 +811,53 @@ export class MobileTusUploader {
636
811
  // that resumes the same session re-joins the job the OS is still
637
812
  // running instead of PATCHing over it.
638
813
  const backgroundTransfer = options.transport === 'background' ? this.config.backgroundTransfer : undefined;
639
- if (backgroundTransfer && bytesUploaded < options.fileSize) {
640
- ensureNotAborted(options.abortSignal);
814
+ if (backgroundTransfer && position.offset < fileSize) {
815
+ ensureNotAborted(signal);
816
+ transfer.expiry.forget();
641
817
  const policy = options.transferPolicy ?? {};
642
818
  const finalOffset = await transferRemainderInBackground(backgroundTransfer, {
643
- uploadUrl: sessionUrl,
819
+ uploadUrl: transfer.uploadUrl,
644
820
  istk,
645
821
  fileUri: cleanUri,
646
- fileSize: options.fileSize,
647
- chunkSize,
648
- offset: bytesUploaded,
822
+ fileSize,
823
+ chunkSize: transfer.chunkSize,
824
+ offset: position.offset,
649
825
  allowsCellularAccess: policy.allowsCellularAccess ?? true,
650
826
  allowsConstrainedNetworkAccess: policy.allowsConstrainedNetworkAccess ?? true,
651
- }, { filename: options.filename, abortSignal: options.abortSignal, onProgress: options.onProgress });
827
+ }, { filename: options.filename, abortSignal: signal, onProgress: offset => report(offset) });
652
828
  // The engine only resolves at the end of the file; anything else is
653
829
  // an engine that gave up quietly, and an offset past the file is as
654
830
  // untrustworthy as one short of it. Same treatment as a non-advancing
655
831
  // PATCH: fail, and let the next attempt ask Forge (HEAD) where the
656
832
  // session really stands.
657
- if (finalOffset !== options.fileSize) {
658
- throw new TusUploadError(`Upload stalled: background transfer ended at offset ${finalOffset} of ${options.fileSize}`, { phase: 'stalled', filename: options.filename, fileSize: options.fileSize });
833
+ if (finalOffset !== fileSize) {
834
+ throw new TusUploadError(`Upload stalled: background transfer ended at offset ${finalOffset} of ${fileSize}`, { ...context, phase: 'stalled' });
659
835
  }
660
- // An abort that lands after the OS delivered the last byte changes
661
- // nothing: the transfer is complete, and the loop below (with its
662
- // abort check) has nothing left to do. Same rule as the single-chunk
663
- // adapter: a finished upload is never reported as cancelled.
664
- bytesUploaded = finalOffset;
665
- options.onProgress?.(bytesUploaded, options.fileSize);
836
+ // The engine's last PATCH was answered 2xx at the final offset, which
837
+ // Forge answers only once the ingot is published. An abort that lands
838
+ // after the OS delivered the last byte changes nothing: the transfer
839
+ // is complete, and the loop below (with its abort check) has nothing
840
+ // left to do. Same rule as the single-chunk adapter: a finished
841
+ // upload is never reported as cancelled.
842
+ position = { offset: fileSize, published: true };
666
843
  }
667
- while (bytesUploaded < options.fileSize) {
668
- ensureNotAborted(options.abortSignal);
669
- const chunkStart = bytesUploaded;
670
- const chunkLength = Math.min(chunkSize, options.fileSize - chunkStart);
671
- let newOffset;
672
- const backgroundUploader = options.transport === 'background' ? this.config.backgroundUploader : undefined;
673
- if (backgroundUploader && this.fitsOneBackgroundRequest(chunkStart, options.fileSize, chunkSize)) {
674
- // The OS owns this request, so an abort that fires while it is in
675
- // flight cannot stop it. It only ever carries a whole single-chunk
676
- // file, so a 2xx here means the transfer is complete: the loop
677
- // ends and the upload finishes normally (the caller verifies the
678
- // ingot), because a finished upload must never be reported as
679
- // cancelled, and a DELETE now would drop bytes Forge has already
680
- // finalized. Only a response that leaves bytes missing reaches
681
- // the `ensureNotAborted` at the top of the next iteration.
682
- newOffset = await uploadWholeFileInBackground(backgroundUploader, sessionUrl, istk, cleanUri, chunkStart);
683
- }
684
- else {
685
- const chunk = await this.readChunk(fileReader, cleanUri, chunkStart, chunkLength);
686
- newOffset = await uploadChunk(sessionUrl, istk, chunk, chunkStart, this.config.tusChunkTimeoutMs, options.abortSignal, chunkUploaded => options.onProgress?.(chunkStart + chunkUploaded, options.fileSize));
687
- }
688
- if (newOffset <= chunkStart || newOffset > options.fileSize) {
689
- throw new TusUploadError('Upload stalled: server offset did not advance', {
690
- phase: 'stalled',
691
- filename: options.filename,
692
- fileSize: options.fileSize,
693
- });
694
- }
695
- bytesUploaded = newOffset;
696
- options.onProgress?.(bytesUploaded, options.fileSize);
844
+ const chunks = {
845
+ reader: fileReader,
846
+ uri: cleanUri,
847
+ transport: options.transport,
848
+ onChunkProgress: (offset, chunkBytesUploaded) => report(offset + chunkBytesUploaded),
849
+ };
850
+ while (!position.published) {
851
+ ensureNotAborted(signal);
852
+ const before = position.offset;
853
+ position = position.offset < fileSize
854
+ ? await this.sendChunkAt(transfer, position.offset, chunks)
855
+ : await this.confirmReceipt(transfer);
856
+ if (position.offset > before)
857
+ report(position.offset);
697
858
  }
859
+ if (reported !== fileSize)
860
+ report(fileSize);
698
861
  debug?.success(`TUS upload completed for ${options.filename}`);
699
862
  }
700
863
  catch (err) {
@@ -723,39 +886,314 @@ export class MobileTusUploader {
723
886
  // in a generic TusUploadError.
724
887
  if (err instanceof SparkVaultMobileError)
725
888
  throw err;
726
- // Only a fileReader read or an onSessionCreated hook can throw anything
727
- // else here: every request classifies its own failure (tusRequest,
728
- // uploadChunk, the adapters). Those are the caller's errors, wrapped
729
- // with the file context and nothing inferred about them.
889
+ // Only a fileReader read or a caller's hook (onSessionCreated,
890
+ // onSessionExpiry, onProgress) can throw anything else here: every
891
+ // request classifies its own failure (tusRequest, the chunk senders,
892
+ // the adapters). Those are the caller's errors, wrapped with the file
893
+ // context and nothing inferred about them.
730
894
  throw TusUploadError.fromError(error, {
731
895
  filename: options.filename,
732
896
  fileSize: options.fileSize,
733
897
  });
734
898
  }
735
899
  }
900
+ /**
901
+ * Open the upload's session. A create the transfer policy calls RETRY (no
902
+ * answer, 408, 425, 429, a 5xx) is sent again under the upload's budget,
903
+ * its backoff never shorter than `Retry-After`: Forge refuses such a create
904
+ * before it claims the token, or hands the claim back on a transient
905
+ * key-service failure (503), so the same ISTK opens the session on a later
906
+ * attempt. Every other answer is final and never a lost session, a 401
907
+ * included: the token was already used, by an earlier create whose answer
908
+ * was lost, and no Location survives to continue that session from. No
909
+ * session URL exists yet to spread the retries by, and the ISTK never feeds
910
+ * one, so they spread by a key of the endpoint (`transferJitterKey`).
911
+ */
912
+ async createSession(parsed, fileSize, budget, context, signal) {
913
+ const jitterKey = transferJitterKey(parsed.tusEndpoint);
914
+ for (;;) {
915
+ ensureNotAborted(signal);
916
+ // Forge's create contract is these three headers: the ingot's name and
917
+ // type were set by Core when the ingot was created, and Forge publishes
918
+ // Core's.
919
+ const answer = await fetchAnswer(this.config, parsed.tusEndpoint, {
920
+ method: 'POST',
921
+ headers: {
922
+ 'Tus-Resumable': TUS_VERSION,
923
+ 'Upload-Length': String(fileSize),
924
+ 'X-ISTK': parsed.istk,
925
+ },
926
+ signal,
927
+ timeoutMs: this.config.tusPostTimeoutMs,
928
+ }, 'TUS POST request', context);
929
+ const outcome = readOutcome(answer, CREATE_REQUEST);
930
+ if (outcome.verdict === TRANSFER_VERDICT.OK) {
931
+ const created = readCreatedSession(answer, parsed.tusEndpoint, context);
932
+ // The session exists: the server confirmed progress.
933
+ budget.progressed();
934
+ return created;
935
+ }
936
+ const failure = failureOf(answer, outcome, CREATE_REQUEST, context);
937
+ if (outcome.verdict !== TRANSFER_VERDICT.RETRY)
938
+ throw failure.error;
939
+ await this.waitToRetry(budget, failure, jitterKey, signal);
940
+ }
941
+ }
942
+ /**
943
+ * Where a kept session stands, asked of Forge (HEAD) under the upload's
944
+ * budget, so resume never re-sends bytes the server holds: it is the only
945
+ * way to learn what a background transfer delivered after the process was
946
+ * killed, and what a failed attempt left behind. A HEAD that gets no
947
+ * answer or a transient one is asked again after its backoff; a gone
948
+ * session is `sessionLost`, so the caller drops it and creates a fresh one
949
+ * rather than retrying a dead URL. A session is bound to one file: a length that
950
+ * is not this file's means the persisted session belongs to another file
951
+ * (or this file changed), and PATCHing into it would corrupt the ingot.
952
+ * That makes it as worthless as a gone one: `sessionLost` too.
953
+ */
954
+ async readResumePoint(link, budget, fileSize) {
955
+ for (;;) {
956
+ const head = await this.headSession(link, RESUME_HEAD_REQUEST);
957
+ if ('failure' in head) {
958
+ await this.waitToRetry(budget, head.failure, link.uploadUrl, link.signal);
959
+ continue;
960
+ }
961
+ if (head.probe.length !== fileSize) {
962
+ throw new TusUploadError(`TUS session Upload-Length (${head.probe.length}) does not match the file size (${fileSize}); the session belongs to a different file`, { ...link.context, phase: 'create', sessionLost: true });
963
+ }
964
+ return head.probe;
965
+ }
966
+ }
967
+ /**
968
+ * Ask Forge once where the session stands (tus HEAD): the probe on a 2xx,
969
+ * or the failure its answer amounts to. Forge re-drives a received
970
+ * upload's publication on its HEAD and answers the full offset whatever the
971
+ * re-drive came to, so an offset at the total proves receipt only: the
972
+ * receipt PATCH (`confirmReceipt`) is what says published.
973
+ */
974
+ async headSession(link, request) {
975
+ ensureNotAborted(link.signal);
976
+ const answer = await fetchAnswer(this.config, link.uploadUrl, {
977
+ method: 'HEAD',
978
+ headers: {
979
+ 'Tus-Resumable': TUS_VERSION,
980
+ 'X-ISTK': link.istk,
981
+ },
982
+ signal: link.signal,
983
+ timeoutMs: HEAD_AND_RECEIPT_TIMEOUT_MS,
984
+ }, 'TUS HEAD request', link.context);
985
+ link.expiry?.read(answer);
986
+ const outcome = readOutcome(answer, request);
987
+ if (outcome.verdict === TRANSFER_VERDICT.OK) {
988
+ return { probe: readSessionProbe(answer, request.phase, link.context) };
989
+ }
990
+ return { failure: failureOf(answer, outcome, request, link.context) };
991
+ }
992
+ /**
993
+ * Send the chunk that starts at `offset`. Answers where the upload stands
994
+ * next: past the chunk on its 2xx, which for the last chunk is also the
995
+ * publication receipt (Forge answers it only once the ingot is published),
996
+ * or wherever the server says after a failure.
997
+ */
998
+ async sendChunkAt(transfer, offset, chunks) {
999
+ const answer = await this.sendChunk(transfer, offset, chunks);
1000
+ transfer.expiry.read(answer);
1001
+ const outcome = readOutcome(answer, CHUNK_REQUEST);
1002
+ if (outcome.verdict !== TRANSFER_VERDICT.OK) {
1003
+ return this.positionAfterFailure(transfer, failureOf(answer, outcome, CHUNK_REQUEST, transfer.context), offset);
1004
+ }
1005
+ // Forge answers every PATCH with Upload-Offset, so a 2xx without a
1006
+ // readable one is not Forge (a captive portal's 200 page is the classic
1007
+ // case): it reports no advance, and the stall guard fails the attempt
1008
+ // rather than crediting bytes that may never have arrived. The parse is
1009
+ // strict because parseInt would turn a garbage header into NaN, which
1010
+ // slips through the guard (every comparison with NaN is false) and would
1011
+ // end the upload as a success; an offset past the file is as
1012
+ // untrustworthy as one short of it.
1013
+ const confirmed = parseIntegerHeader(answer.header('Upload-Offset'), 0) ?? offset;
1014
+ if (confirmed <= offset || confirmed > transfer.fileSize) {
1015
+ throw new TusUploadError('Upload stalled: server offset did not advance', {
1016
+ ...transfer.context,
1017
+ phase: 'stalled',
1018
+ });
1019
+ }
1020
+ transfer.budget.progressed();
1021
+ return { offset: confirmed, published: confirmed === transfer.fileSize };
1022
+ }
1023
+ /** PATCH the chunk at `offset` on the transport the upload rides, resolving with Forge's answer. */
1024
+ async sendChunk(transfer, offset, chunks) {
1025
+ const backgroundUploader = chunks.transport === 'background' ? this.config.backgroundUploader : undefined;
1026
+ if (backgroundUploader && this.fitsOneBackgroundRequest(offset, transfer.fileSize, transfer.chunkSize)) {
1027
+ // The OS owns this request, so an abort that fires while it is in
1028
+ // flight cannot stop it, and it may finish while the app is away. It
1029
+ // only ever carries a whole single-chunk file, so a 2xx here means the
1030
+ // transfer is complete: the loop ends and the upload finishes normally
1031
+ // (the caller verifies the ingot), because a finished upload must never
1032
+ // be reported as cancelled, and a DELETE now would drop bytes Forge has
1033
+ // already finalized. Only an answer that leaves bytes missing reaches
1034
+ // the abort check before the next request.
1035
+ transfer.expiry.forget();
1036
+ return sendWholeFileInBackground(backgroundUploader, transfer, chunks.uri, offset);
1037
+ }
1038
+ const chunkLength = Math.min(transfer.chunkSize, transfer.fileSize - offset);
1039
+ const chunk = await this.readChunk(chunks.reader, chunks.uri, offset, chunkLength);
1040
+ return sendChunkOverXhr(transfer, chunk, offset, this.config.tusChunkTimeoutMs, chunkBytesUploaded => chunks.onChunkProgress(offset, chunkBytesUploaded));
1041
+ }
1042
+ /**
1043
+ * Where the upload stands after a failed chunk PATCH, in the server's
1044
+ * words: a 409's own `Upload-Offset` at once, otherwise the session's HEAD
1045
+ * after the backoff, the HEAD itself retried the same way out of the same
1046
+ * budget. A PATCH whose answer was lost may have landed, and one sent at a
1047
+ * stale offset is refused, so no chunk is ever sent again at an offset the
1048
+ * server did not just name.
1049
+ */
1050
+ async positionAfterFailure(transfer, failure, sentOffset) {
1051
+ let current = failure;
1052
+ for (;;) {
1053
+ if (current.outcome.verdict === TRANSFER_VERDICT.RESYNC) {
1054
+ return this.resyncedPosition(transfer, current, sentOffset);
1055
+ }
1056
+ await this.waitToRetry(transfer.budget, current, transfer.uploadUrl, transfer.signal);
1057
+ const head = await this.headSession(transfer, OFFSET_HEAD_REQUEST);
1058
+ if ('failure' in head) {
1059
+ current = head.failure;
1060
+ continue;
1061
+ }
1062
+ if (head.probe.length !== transfer.fileSize) {
1063
+ throw new TusUploadError(`TUS session Upload-Length (${head.probe.length}) does not match the file size (${transfer.fileSize}); the session belongs to a different file`, { ...transfer.context, phase: 'upload', sessionLost: true });
1064
+ }
1065
+ const offset = checkedServerOffset(head.probe.offset, transfer, 'upload', transfer.context);
1066
+ // Bytes reached the server despite the failure, so the transfer is
1067
+ // alive: the budget starts over rather than being spent down across
1068
+ // the many chunks of a large file.
1069
+ if (offset > sentOffset)
1070
+ transfer.budget.progressed();
1071
+ return { offset, published: false };
1072
+ }
1073
+ }
1074
+ /**
1075
+ * Continue from the offset a 409 named, at once and without a HEAD: the
1076
+ * server just said where the session stands. Past what this upload sent,
1077
+ * the server holds more than it knew, which is progress; anywhere else the
1078
+ * answer contradicts the request, so it spends the budget like any failure
1079
+ * and repeating it ends the upload.
1080
+ */
1081
+ resyncedPosition(transfer, failure, sentOffset) {
1082
+ const offset = checkedServerOffset(failure.outcome.offset, transfer, 'upload', transfer.context);
1083
+ if (offset > sentOffset) {
1084
+ transfer.budget.progressed();
1085
+ }
1086
+ else if (!transfer.budget.failed(TRANSFER_VERDICT.RESYNC)) {
1087
+ throw failure.error;
1088
+ }
1089
+ return { offset, published: false };
1090
+ }
1091
+ /**
1092
+ * Every byte is on the server but publication is unconfirmed: the final
1093
+ * chunk's answer was lost or deferred, or a HEAD's offset proved receipt
1094
+ * only. A zero-length PATCH at the final offset re-drives publication if it
1095
+ * did not finish (a transient Core or billing failure after the last chunk)
1096
+ * and answers 204 once the ingot is published, which is the receipt every
1097
+ * upload resolves on. While another request finalizes it answers 409 with
1098
+ * `Retry-After`, asked again as a failure; while the publication is
1099
+ * deferred, 503 with `Retry-After`, asked again, each time after a longer
1100
+ * backoff, without spending a failure until the idle limit ends the upload
1101
+ * as `upload_received_publishing` (`retryLater`); a 503 naming no
1102
+ * `Retry-After` is no deferral of Forge's, asked again as a failure. A 409
1103
+ * naming an earlier offset means bytes are missing, and the upload
1104
+ * continues from there. Forge answers it only after its own call to Core,
1105
+ * so it waits `HEAD_AND_RECEIPT_TIMEOUT_MS`, as a HEAD does.
1106
+ */
1107
+ async confirmReceipt(transfer) {
1108
+ ensureNotAborted(transfer.signal);
1109
+ const answer = await fetchAnswer(this.config, transfer.uploadUrl, {
1110
+ method: 'PATCH',
1111
+ headers: {
1112
+ 'Tus-Resumable': TUS_VERSION,
1113
+ 'Upload-Offset': String(transfer.fileSize),
1114
+ 'Content-Type': 'application/offset+octet-stream',
1115
+ 'X-ISTK': transfer.istk,
1116
+ },
1117
+ signal: transfer.signal,
1118
+ timeoutMs: HEAD_AND_RECEIPT_TIMEOUT_MS,
1119
+ }, 'TUS finalization request', transfer.context);
1120
+ transfer.expiry.read(answer);
1121
+ const outcome = readOutcome(answer, RECEIPT_REQUEST);
1122
+ if (outcome.verdict === TRANSFER_VERDICT.OK) {
1123
+ return { offset: transfer.fileSize, published: true };
1124
+ }
1125
+ const failure = failureOf(answer, outcome, RECEIPT_REQUEST, transfer.context);
1126
+ if (outcome.verdict === TRANSFER_VERDICT.RESYNC) {
1127
+ return this.resyncedPosition(transfer, failure, transfer.fileSize);
1128
+ }
1129
+ await this.waitToRetry(transfer.budget, failure, transfer.uploadUrl, transfer.signal);
1130
+ return { offset: transfer.fileSize, published: false };
1131
+ }
1132
+ /**
1133
+ * Wait out the backoff of a failed request, spending a retry of the
1134
+ * upload's budget, or of a deferred receipt, spending none for as long as
1135
+ * the idle limit allows; never shorter than the answer's `Retry-After`.
1136
+ * Throws the failure no retry follows (a gone session, the server's
1137
+ * verdict), and the last one, or the deferral, once the budget is spent. A
1138
+ * request that got no answer while the device is offline spends nothing:
1139
+ * the upload waits for the network (or the caller's abort), the idle clock
1140
+ * starts over when it is back, and the next request asks again at once.
1141
+ */
1142
+ async waitToRetry(budget, failure, jitterKey, signal) {
1143
+ const { verdict, retryAfterMs } = failure.outcome;
1144
+ if (verdict === TRANSFER_VERDICT.DEFERRED) {
1145
+ if (!budget.deferred(retryAfterMs))
1146
+ throw failure.error;
1147
+ await abortableDelay(retryDelayMs({ attempt: budget.attempt, retryAfterMs, jitterKey }), signal);
1148
+ return;
1149
+ }
1150
+ if (verdict !== TRANSFER_VERDICT.RETRY) {
1151
+ throw failure.error;
1152
+ }
1153
+ const connectivity = this.config.connectivity;
1154
+ if (failure.unanswered && connectivity && !connectivity.isOnline()) {
1155
+ await waitUntilOnline(connectivity, signal);
1156
+ budget.alive();
1157
+ return;
1158
+ }
1159
+ if (!budget.failed(verdict, retryAfterMs)) {
1160
+ throw failure.error;
1161
+ }
1162
+ const delayMs = retryDelayMs({
1163
+ attempt: budget.attempt,
1164
+ retryAfterMs,
1165
+ jitterKey,
1166
+ });
1167
+ await abortableDelay(delayMs, signal);
1168
+ }
736
1169
  /**
737
1170
  * Where a persisted session stands, or `null` when Forge no longer has it
738
- * (404/410 — expired or terminated). Any other failure throws with
739
- * `sessionLost` false (a 5xx or timeout says nothing about the session).
740
- * The probe reports the session's own length; whether that length is the
741
- * caller's file is for the caller (or `uploadFromUri`'s resume, which
742
- * throws `sessionLost` on a mismatch) to judge. Lets a caller reconcile
743
- * sessions on relaunch (a completed one just needs its ingot verified; a
744
- * lost one needs a fresh create) before spending an upload slot on it.
1171
+ * (404/410 — expired or terminated), from one HEAD and no retry. Any other
1172
+ * failure throws with `sessionLost` false (a 5xx or a timeout says nothing
1173
+ * against the session), carrying the answer's `retryAfterMs`; a final
1174
+ * refusal Core decided on the HEAD's re-drive (`UPLOAD_POOL_FULL` or
1175
+ * `UPLOAD_SUPERSEDED` in `X-Upload-Refusal`) throws as `upload_refused`,
1176
+ * which no fresh create remedies, and any other code Core ended the session
1177
+ * with reads as gone (null). An offset at
1178
+ * the session's length proves every byte received, not published: a
1179
+ * resume of it sends the receipt. The probe reports the session's own length;
1180
+ * whether that length is the caller's file is for the caller (or
1181
+ * `uploadFromUri`'s resume, which throws `sessionLost` on a mismatch) to
1182
+ * judge. Lets a caller reconcile sessions on relaunch (a completed one just
1183
+ * needs its ingot verified; a lost one needs a fresh create) before
1184
+ * spending an upload slot on it.
745
1185
  *
746
1186
  * @throws SparkVaultValidationError, before any request, when `uploadUrl`
747
1187
  * is not an upload session on an allowed transfer host.
748
1188
  */
749
1189
  async probeSession(session) {
750
1190
  const uploadUrl = readKeptSessionUrl(session.uploadUrl, this.config.allowedDownloadHostPatterns);
751
- try {
752
- return await headTusSession(this.config, uploadUrl, session.istk);
753
- }
754
- catch (err) {
755
- if (err instanceof TusUploadError && err.sessionLost)
756
- return null;
757
- throw err;
758
- }
1191
+ const head = await this.headSession({ uploadUrl, istk: session.istk, context: {}, expiry: null }, RESUME_HEAD_REQUEST);
1192
+ if ('probe' in head)
1193
+ return head.probe;
1194
+ if (head.failure.outcome.verdict === TRANSFER_VERDICT.GONE)
1195
+ return null;
1196
+ throw head.failure.error;
759
1197
  }
760
1198
  /**
761
1199
  * Whether the remaining transfer is ONE PATCH the background adapter can