@milaboratories/pl-drivers 1.12.3 → 1.12.4

package/dist/clients/upload.cjs

@@ -189,8 +189,22 @@ async function checkExpectedMTime(path, expectedMTimeUnix) {
 	const mTime = BigInt(Math.floor((await node_fs_promises.stat(path)).mtimeMs / 1e3));
 	if (mTime > expectedMTimeUnix) throw new MTimeError(`file was modified, expected mtime: ${expectedMTimeUnix}, got: ${mTime}.`);
 }
+/** S3 error codes that indicate expired/invalid temporary credentials.
+* These are transient: a retry with a fresh presigned URL will succeed
+* once the backend refreshes its STS credentials. */
+const TRANSIENT_S3_ERROR_CODES = [
+	"ExpiredToken",
+	"RequestExpired",
+	"TokenRefreshRequired"
+];
+function isTransientS3Error(body) {
+	return TRANSIENT_S3_ERROR_CODES.some((code) => body.includes(`<Code>${code}</Code>`));
+}
 function checkStatusCodeOk(statusCode, body, headers, info) {
-	if (statusCode == 400) throw new BadRequestError(`response is not ok, status code: ${statusCode}, body: ${body}, headers: ${JSON.stringify(headers)}, url: ${info.uploadUrl}`);
+	if (statusCode == 400) {
+		if (isTransientS3Error(body)) throw new NetworkError(`transient S3 credential error, status code: ${statusCode}, body: ${body}, headers: ${JSON.stringify(headers)}, url: ${info.uploadUrl}`);
+		throw new BadRequestError(`response is not ok, status code: ${statusCode}, body: ${body}, headers: ${JSON.stringify(headers)}, url: ${info.uploadUrl}`);
+	}
 	if (statusCode != 200) throw new NetworkError(`response is not ok, status code: ${statusCode}, body: ${body}, headers: ${JSON.stringify(headers)}, url: ${info.uploadUrl}`);
 }
 /** Calculate CRC32C checksum of a buffer and return as base64 string */

package/dist/clients/upload.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"upload.cjs","names":["UploadClient","RestAPI","UploadAPI_ChecksumAlgorithm","fs","crc32c"],"sources":["../../src/clients/upload.ts"],"sourcesContent":["import type {\n  WireClientProvider,\n  WireClientProviderFactory,\n  PlClient,\n} from \"@milaboratories/pl-client\";\nimport { addRTypeToMetadata, createRTypeRoutingHeader, RestAPI } from \"@milaboratories/pl-client\";\nimport type { ResourceInfo } from \"@milaboratories/pl-tree\";\nimport type { MiLogger } from \"@milaboratories/ts-helpers\";\nimport type { RpcOptions } from \"@protobuf-ts/runtime-rpc\";\nimport * as fs from \"node:fs/promises\";\nimport type { Dispatcher } from \"undici\";\nimport { request } from \"undici\";\nimport {\n  UploadAPI_ChecksumAlgorithm,\n  type UploadAPI_GetPartURL_Response,\n} from \"../proto-grpc/github.com/milaboratory/pl/controllers/shared/grpc/uploadapi/protocol\";\nimport { UploadClient } from \"../proto-grpc/github.com/milaboratory/pl/controllers/shared/grpc/uploadapi/protocol.client\";\nimport type { UploadApiPaths, UploadRestClientType } from \"../proto-rest\";\nimport { crc32c } from \"./crc32c\";\n\nimport type { IncomingHttpHeaders } from \"undici/types/header\";\n\nexport class MTimeError extends Error {\n  name = \"MTimeError\";\n}\n\nexport class UnexpectedEOF extends Error {\n  name = \"UnexpectedEOF\";\n}\n\nexport class NetworkError extends Error {\n  name = \"NetworkError\";\n}\n\n/** Happens when the file doesn't exist */\nexport class NoFileForUploading extends Error {\n  name = \"NoFileForUploading\";\n}\n\nexport class BadRequestError extends Error {\n  name = \"BadRequestError\";\n}\n\n/** Low-level client for grpc uploadapi.\n * The user should pass here a concrete BlobUpload/<storageId> resource,\n * it can be got from handle field of BlobUpload. */\nexport class ClientUpload {\n  private readonly wire: WireClientProvider<UploadRestClientType | UploadClient>;\n\n  constructor(\n    wireClientProviderFactory: WireClientProviderFactory,\n    public readonly httpClient: Dispatcher,\n    _: PlClient,\n    public readonly logger: MiLogger,\n  ) {\n    this.wire = wireClientProviderFactory.createWireClientProvider((wire) => {\n      if (wire.type === \"grpc\") {\n        return new UploadClient(wire.Transport);\n      }\n\n      return RestAPI.createClient<UploadApiPaths>({\n        hostAndPort: wire.Config.hostAndPort,\n        ssl: wire.Config.ssl,\n        dispatcher: wire.Dispatcher,\n        middlewares: wire.Middlewares,\n      });\n    });\n  }\n\n  close() {}\n\n  public async initUpload(\n    { id, type }: ResourceInfo,\n    options?: RpcOptions,\n  ): Promise<{\n    overall: bigint;\n    toUpload: bigint[];\n    checksumAlgorithm: UploadAPI_ChecksumAlgorithm;\n    checksumHeader: string;\n  }> {\n    const client = this.wire.get();\n\n    if (client instanceof UploadClient) {\n      const init = (await client.init({ resourceId: id }, addRTypeToMetadata(type, options)))\n        .response;\n\n      return {\n        overall: init.partsCount,\n        toUpload: this.partsToUpload(init.partsCount, init.uploadedParts),\n        checksumAlgorithm: init.checksumAlgorithm,\n        checksumHeader: init.checksumHeader,\n      };\n    }\n\n    const init = (\n      await client.POST(\"/v1/upload/init\", {\n        body: {\n          resourceId: id.toString(),\n        },\n        headers: { ...createRTypeRoutingHeader(type) },\n      })\n    ).data!;\n\n    return {\n      overall: BigInt(init.partsCount),\n      toUpload: this.partsToUpload(BigInt(init.partsCount), init.uploadedParts.map(BigInt)),\n      checksumAlgorithm: init.checksumAlgorithm,\n      checksumHeader: init.checksumHeader,\n    };\n  }\n\n  public async partUpload(\n    { id, type }: ResourceInfo,\n    path: string,\n    expectedMTimeUnix: bigint,\n    partNumber: bigint,\n    checksumAlgorithm: UploadAPI_ChecksumAlgorithm,\n    checksumHeader: string,\n    options?: RpcOptions,\n  ) {\n    const client = this.wire.get();\n\n    let info: UploadAPI_GetPartURL_Response;\n    if (client instanceof UploadClient) {\n      // partChecksum isn't used for now but protoc requires it to be set\n      info = (\n        await client.getPartURL(\n          {\n            resourceId: id,\n            partNumber,\n            uploadedPartSize: 0n,\n            isInternalUse: false,\n            partChecksum: \"\",\n          },\n          addRTypeToMetadata(type, options),\n        )\n      ).response;\n    } else {\n      const resp = (\n        await client.POST(\"/v1/upload/get-part-url\", {\n          body: {\n            resourceId: id.toString(),\n            partNumber: partNumber.toString(),\n            uploadedPartSize: \"0\",\n            isInternalUse: false,\n            partChecksum: \"\",\n          },\n          headers: { ...createRTypeRoutingHeader(type) },\n        })\n      ).data!;\n      info = {\n        uploadUrl: resp.uploadUrl,\n        method: resp.method,\n        headers: resp.headers,\n        chunkStart: BigInt(resp.chunkStart),\n        chunkEnd: BigInt(resp.chunkEnd),\n      };\n    }\n\n    const chunk = await readFileChunk(path, info.chunkStart, info.chunkEnd);\n    await checkExpectedMTime(path, expectedMTimeUnix);\n\n    if (checksumHeader && checksumAlgorithm === UploadAPI_ChecksumAlgorithm.CRC32C) {\n      info.headers.push({ name: checksumHeader, value: calculateCrc32cChecksum(chunk) });\n    }\n\n    const contentLength = Number(info.chunkEnd - info.chunkStart);\n    if (chunk.length !== contentLength) {\n      throw new Error(\n        `Chunk size mismatch: expected ${contentLength} bytes, but read ${chunk.length} bytes from file`,\n      );\n    }\n\n    const headers = Object.fromEntries(\n      info.headers.map(({ name, value }) => [name.toLowerCase(), value]),\n    );\n\n    try {\n      const {\n        body: rawBody,\n        statusCode,\n        headers: responseHeaders,\n      } = await request(info.uploadUrl, {\n        dispatcher: this.httpClient,\n        body: chunk,\n        // We got headers only after we send\n        // the whole body (in case of S3 PUT requests it's 5 MB).\n        // It might be slow with a slow connection (or with SSH),\n        // that's why we got big timeout here.\n        headersTimeout: 60000,\n        bodyTimeout: 60000,\n        // Prevent connection reuse by setting \"Connection: close\" header.\n        // This works around an issue with the backend's built-in S3 implementation\n        // that caused HTTP/1.1 protocol lines to be included in the uploaded file content.\n        reset: true,\n        headers,\n        method: info.method.toUpperCase() as Dispatcher.HttpMethod,\n      });\n\n      // always read the body for resources to be garbage collected.\n      const body = await rawBody.text();\n      checkStatusCodeOk(statusCode, body, responseHeaders, info);\n    } catch (e: unknown) {\n      if (e instanceof NetworkError) throw e;\n\n      if (e instanceof BadRequestError) throw e;\n\n      throw new Error(\n        `partUpload: error ${JSON.stringify(e)} happened while trying to do part upload to the url ${info.uploadUrl}, headers: ${JSON.stringify(info.headers)}`,\n      );\n    }\n\n    await this.updateProgress({ id, type }, BigInt(info.chunkEnd - info.chunkStart), options);\n  }\n\n  public async finalize(info: ResourceInfo, options?: RpcOptions) {\n    const client = this.wire.get();\n\n    if (client instanceof UploadClient) {\n      await client.finalize({ resourceId: info.id }, addRTypeToMetadata(info.type, options));\n    } else {\n      await client.POST(\"/v1/upload/finalize\", {\n        body: {\n          resourceId: info.id.toString(),\n        },\n        headers: { ...createRTypeRoutingHeader(info.type) },\n      });\n    }\n  }\n\n  /** Calculates parts that need to be uploaded from the parts that were\n   * already uploaded. */\n  private partsToUpload(partsCount: bigint, uploadedParts: bigint[]): bigint[] {\n    const toUpload: bigint[] = [];\n    const uploaded = new Set(uploadedParts);\n\n    for (let i = 1n; i <= partsCount; i++) {\n      if (!uploaded.has(i)) toUpload.push(i);\n    }\n\n    return toUpload;\n  }\n\n  private async updateProgress(\n    { id, type }: ResourceInfo,\n    bytesProcessed: bigint,\n    options?: RpcOptions,\n  ): Promise<void> {\n    const client = this.wire.get();\n\n    if (client instanceof UploadClient) {\n      await client.updateProgress(\n        {\n          resourceId: id,\n          bytesProcessed,\n        },\n        addRTypeToMetadata(type, options),\n      ).response;\n      return;\n    }\n\n    await client.POST(\"/v1/upload/update-progress\", {\n      body: {\n        resourceId: id.toString(),\n        bytesProcessed: bytesProcessed.toString(),\n      },\n      headers: { ...createRTypeRoutingHeader(type) },\n    });\n    return;\n  }\n}\n\nasync function readFileChunk(path: string, chunkStart: bigint, chunkEnd: bigint): Promise<Buffer> {\n  let f: fs.FileHandle | undefined;\n  try {\n    f = await fs.open(path);\n    const len = Number(chunkEnd - chunkStart);\n    const pos = Number(chunkStart);\n    const b = Buffer.alloc(len);\n    const bytesRead = await readBytesFromPosition(f, b, len, pos);\n\n    return b.subarray(0, bytesRead);\n  } catch (e: unknown) {\n    if (e && typeof e === \"object\" && \"code\" in e && e.code == \"ENOENT\")\n      throw new NoFileForUploading(`there is no file ${path} for uploading`);\n    throw e;\n  } finally {\n    await f?.close();\n  }\n}\n\n/** Read len bytes from a given position.\n * Without this, `FileHandle.read` can read less bytes than needed. */\nasync function readBytesFromPosition(f: fs.FileHandle, b: Buffer, len: number, position: number) {\n  let bytesReadTotal = 0;\n  while (bytesReadTotal < len) {\n    const { bytesRead } = await f.read(\n      b,\n      bytesReadTotal,\n      len - bytesReadTotal,\n      position + bytesReadTotal,\n    );\n    if (bytesRead === 0) {\n      throw new UnexpectedEOF(\"file ended earlier than expected.\");\n    }\n    bytesReadTotal += bytesRead;\n  }\n\n  return bytesReadTotal;\n}\n\nasync function checkExpectedMTime(path: string, expectedMTimeUnix: bigint) {\n  const mTime = BigInt(Math.floor((await fs.stat(path)).mtimeMs / 1000));\n  if (mTime > expectedMTimeUnix) {\n    throw new MTimeError(`file was modified, expected mtime: ${expectedMTimeUnix}, got: ${mTime}.`);\n  }\n}\n\nfunction checkStatusCodeOk(\n  statusCode: number,\n  body: string,\n  headers: IncomingHttpHeaders,\n  info: UploadAPI_GetPartURL_Response,\n) {\n  if (statusCode == 400) {\n    throw new BadRequestError(\n      `response is not ok, status code: ${statusCode},` +\n        ` body: ${body}, headers: ${JSON.stringify(headers)}, url: ${info.uploadUrl}`,\n    );\n  }\n\n  if (statusCode != 200) {\n    throw new NetworkError(\n      `response is not ok, status code: ${statusCode},` +\n        ` body: ${body}, headers: ${JSON.stringify(headers)}, url: ${info.uploadUrl}`,\n    );\n  }\n}\n\n/** Calculate CRC32C checksum of a buffer and return as base64 string */\nfunction calculateCrc32cChecksum(data: Buffer): string {\n  const checksum = crc32c(data);\n  // Convert to unsigned 32-bit integer and then to base64\n  const buffer = Buffer.alloc(4);\n\n  buffer.writeUInt32BE(checksum, 0);\n  return buffer.toString(\"base64\");\n}\n"],"mappings":";;;;;;;;;;AAsBA,IAAa,aAAb,cAAgC,MAAM;CACpC,OAAO;;AAGT,IAAa,gBAAb,cAAmC,MAAM;CACvC,OAAO;;AAGT,IAAa,eAAb,cAAkC,MAAM;CACtC,OAAO;;;AAIT,IAAa,qBAAb,cAAwC,MAAM;CAC5C,OAAO;;AAGT,IAAa,kBAAb,cAAqC,MAAM;CACzC,OAAO;;;;;AAMT,IAAa,eAAb,MAA0B;CACxB,AAAiB;CAEjB,YACE,2BACA,AAAgB,YAChB,GACA,AAAgB,QAChB;EAHgB;EAEA;AAEhB,OAAK,OAAO,0BAA0B,0BAA0B,SAAS;AACvE,OAAI,KAAK,SAAS,OAChB,QAAO,IAAIA,qCAAa,KAAK,UAAU;AAGzC,UAAOC,kCAAQ,aAA6B;IAC1C,aAAa,KAAK,OAAO;IACzB,KAAK,KAAK,OAAO;IACjB,YAAY,KAAK;IACjB,aAAa,KAAK;IACnB,CAAC;IACF;;CAGJ,QAAQ;CAER,MAAa,WACX,EAAE,IAAI,QACN,SAMC;EACD,MAAM,SAAS,KAAK,KAAK,KAAK;AAE9B,MAAI,kBAAkBD,sCAAc;GAClC,MAAM,QAAQ,MAAM,OAAO,KAAK,EAAE,YAAY,IAAI,oDAAqB,MAAM,QAAQ,CAAC,EACnF;AAEH,UAAO;IACL,SAAS,KAAK;IACd,UAAU,KAAK,cAAc,KAAK,YAAY,KAAK,cAAc;IACjE,mBAAmB,KAAK;IACxB,gBAAgB,KAAK;IACtB;;EAGH,MAAM,QACJ,MAAM,OAAO,KAAK,mBAAmB;GACnC,MAAM,EACJ,YAAY,GAAG,UAAU,EAC1B;GACD,SAAS,EAAE,2DAA4B,KAAK,EAAE;GAC/C,CAAC,EACF;AAEF,SAAO;GACL,SAAS,OAAO,KAAK,WAAW;GAChC,UAAU,KAAK,cAAc,OAAO,KAAK,WAAW,EAAE,KAAK,cAAc,IAAI,OAAO,CAAC;GACrF,mBAAmB,KAAK;GACxB,gBAAgB,KAAK;GACtB;;CAGH,MAAa,WACX,EAAE,IAAI,QACN,MACA,mBACA,YACA,mBACA,gBACA,SACA;EACA,MAAM,SAAS,KAAK,KAAK,KAAK;EAE9B,IAAI;AACJ,MAAI,kBAAkBA,qCAEpB,SACE,MAAM,OAAO,WACX;GACE,YAAY;GACZ;GACA,kBAAkB;GAClB,eAAe;GACf,cAAc;GACf,oDACkB,MAAM,QAAQ,CAClC,EACD;OACG;GACL,MAAM,QACJ,MAAM,OAAO,KAAK,2BAA2B;IAC3C,MAAM;KACJ,YAAY,GAAG,UAAU;KACzB,YAAY,WAAW,UAAU;KACjC,kBAAkB;KAClB,eAAe;KACf,cAAc;KACf;IACD,SAAS,EAAE,2DAA4B,KAAK,EAAE;IAC/C,CAAC,EACF;AACF,UAAO;IACL,WAAW,KAAK;IAChB,QAAQ,KAAK;IACb,SAAS,KAAK;IACd,YAAY,OAAO,KAAK,WAAW;IACnC,UAAU,OAAO,KAAK,SAAS;IAChC;;EAGH,MAAM,QAAQ,MAAM,cAAc,MAAM,KAAK,YAAY,KAAK,SAAS;AACvE,QAAM,mBAAmB,MAAM,kBAAkB;AAEjD,MAAI,kBAAkB,sBAAsBE,6CAA4B,OACtE,MAAK,QAAQ,KAAK;GAAE,MAAM;GAAgB,OAAO,wBAAwB,MAAM;GAAE,CAAC;EAGpF,MAAM,gBAAgB,OAAO,KAAK,WAAW,KAAK,WAAW;AAC7D,MAAI,MAAM,WAAW,cACnB,OAAM,IAAI,MACR,iCAAiC,cAAc,mBAAmB,MAAM,OAAO,kBAChF;EAGH,MAAM,UAAU,OAAO,YACrB,KAAK,QAAQ,KAAK,EAAE,MAAM,YAAY,CAAC,KAAK,aAAa,EAAE,MAAM,CAAC,CACnE;AAED,MAAI;GACF,MAAM,EACJ,MAAM,SACN,YACA,SAAS,oBACP,0BAAc,KAAK,WAAW;IAChC,YAAY,KAAK;IACjB,MAAM;IAKN,gBAAgB;IAChB,aAAa;IAIb,OAAO;IACP;IACA,QAAQ,KAAK,OAAO,aAAa;IAClC,CAAC;AAIF,qBAAkB,YADL,MAAM,QAAQ,MAAM,EACG,iBAAiB,KAAK;WACnD,GAAY;AACnB,OAAI,aAAa,aAAc,OAAM;AAErC,OAAI,aAAa,gBAAiB,OAAM;AAExC,SAAM,IAAI,MACR,qBAAqB,KAAK,UAAU,EAAE,CAAC,sDAAsD,KAAK,UAAU,aAAa,KAAK,UAAU,KAAK,QAAQ,GACtJ;;AAGH,QAAM,KAAK,eAAe;GAAE;GAAI;GAAM,EAAE,OAAO,KAAK,WAAW,KAAK,WAAW,EAAE,QAAQ;;CAG3F,MAAa,SAAS,MAAoB,SAAsB;EAC9D,MAAM,SAAS,KAAK,KAAK,KAAK;AAE9B,MAAI,kBAAkBF,qCACpB,OAAM,OAAO,SAAS,EAAE,YAAY,KAAK,IAAI,oDAAqB,KAAK,MAAM,QAAQ,CAAC;MAEtF,OAAM,OAAO,KAAK,uBAAuB;GACvC,MAAM,EACJ,YAAY,KAAK,GAAG,UAAU,EAC/B;GACD,SAAS,EAAE,2DAA4B,KAAK,KAAK,EAAE;GACpD,CAAC;;;;CAMN,AAAQ,cAAc,YAAoB,eAAmC;EAC3E,MAAM,WAAqB,EAAE;EAC7B,MAAM,WAAW,IAAI,IAAI,cAAc;AAEvC,OAAK,IAAI,IAAI,IAAI,KAAK,YAAY,IAChC,KAAI,CAAC,SAAS,IAAI,EAAE,CAAE,UAAS,KAAK,EAAE;AAGxC,SAAO;;CAGT,MAAc,eACZ,EAAE,IAAI,QACN,gBACA,SACe;EACf,MAAM,SAAS,KAAK,KAAK,KAAK;AAE9B,MAAI,kBAAkBA,sCAAc;AAClC,SAAM,OAAO,eACX;IACE,YAAY;IACZ;IACD,oDACkB,MAAM,QAAQ,CAClC,CAAC;AACF;;AAGF,QAAM,OAAO,KAAK,8BAA8B;GAC9C,MAAM;IACJ,YAAY,GAAG,UAAU;IACzB,gBAAgB,eAAe,UAAU;IAC1C;GACD,SAAS,EAAE,2DAA4B,KAAK,EAAE;GAC/C,CAAC;;;AAKN,eAAe,cAAc,MAAc,YAAoB,UAAmC;CAChG,IAAI;AACJ,KAAI;AACF,MAAI,MAAMG,iBAAG,KAAK,KAAK;EACvB,MAAM,MAAM,OAAO,WAAW,WAAW;EACzC,MAAM,MAAM,OAAO,WAAW;EAC9B,MAAM,IAAI,OAAO,MAAM,IAAI;EAC3B,MAAM,YAAY,MAAM,sBAAsB,GAAG,GAAG,KAAK,IAAI;AAE7D,SAAO,EAAE,SAAS,GAAG,UAAU;UACxB,GAAY;AACnB,MAAI,KAAK,OAAO,MAAM,YAAY,UAAU,KAAK,EAAE,QAAQ,SACzD,OAAM,IAAI,mBAAmB,oBAAoB,KAAK,gBAAgB;AACxE,QAAM;WACE;AACR,QAAM,GAAG,OAAO;;;;;AAMpB,eAAe,sBAAsB,GAAkB,GAAW,KAAa,UAAkB;CAC/F,IAAI,iBAAiB;AACrB,QAAO,iBAAiB,KAAK;EAC3B,MAAM,EAAE,cAAc,MAAM,EAAE,KAC5B,GACA,gBACA,MAAM,gBACN,WAAW,eACZ;AACD,MAAI,cAAc,EAChB,OAAM,IAAI,cAAc,oCAAoC;AAE9D,oBAAkB;;AAGpB,QAAO;;AAGT,eAAe,mBAAmB,MAAc,mBAA2B;CACzE,MAAM,QAAQ,OAAO,KAAK,OAAO,MAAMA,iBAAG,KAAK,KAAK,EAAE,UAAU,IAAK,CAAC;AACtE,KAAI,QAAQ,kBACV,OAAM,IAAI,WAAW,sCAAsC,kBAAkB,SAAS,MAAM,GAAG;;AAInG,SAAS,kBACP,YACA,MACA,SACA,MACA;AACA,KAAI,cAAc,IAChB,OAAM,IAAI,gBACR,oCAAoC,WAAW,UACnC,KAAK,aAAa,KAAK,UAAU,QAAQ,CAAC,SAAS,KAAK,YACrE;AAGH,KAAI,cAAc,IAChB,OAAM,IAAI,aACR,oCAAoC,WAAW,UACnC,KAAK,aAAa,KAAK,UAAU,QAAQ,CAAC,SAAS,KAAK,YACrE;;;AAKL,SAAS,wBAAwB,MAAsB;CACrD,MAAM,WAAWC,sBAAO,KAAK;CAE7B,MAAM,SAAS,OAAO,MAAM,EAAE;AAE9B,QAAO,cAAc,UAAU,EAAE;AACjC,QAAO,OAAO,SAAS,SAAS"}
+{"version":3,"file":"upload.cjs","names":["UploadClient","RestAPI","UploadAPI_ChecksumAlgorithm","fs","crc32c"],"sources":["../../src/clients/upload.ts"],"sourcesContent":["import type {\n  WireClientProvider,\n  WireClientProviderFactory,\n  PlClient,\n} from \"@milaboratories/pl-client\";\nimport { addRTypeToMetadata, createRTypeRoutingHeader, RestAPI } from \"@milaboratories/pl-client\";\nimport type { ResourceInfo } from \"@milaboratories/pl-tree\";\nimport type { MiLogger } from \"@milaboratories/ts-helpers\";\nimport type { RpcOptions } from \"@protobuf-ts/runtime-rpc\";\nimport * as fs from \"node:fs/promises\";\nimport type { Dispatcher } from \"undici\";\nimport { request } from \"undici\";\nimport {\n  UploadAPI_ChecksumAlgorithm,\n  type UploadAPI_GetPartURL_Response,\n} from \"../proto-grpc/github.com/milaboratory/pl/controllers/shared/grpc/uploadapi/protocol\";\nimport { UploadClient } from \"../proto-grpc/github.com/milaboratory/pl/controllers/shared/grpc/uploadapi/protocol.client\";\nimport type { UploadApiPaths, UploadRestClientType } from \"../proto-rest\";\nimport { crc32c } from \"./crc32c\";\n\nimport type { IncomingHttpHeaders } from \"undici/types/header\";\n\nexport class MTimeError extends Error {\n  name = \"MTimeError\";\n}\n\nexport class UnexpectedEOF extends Error {\n  name = \"UnexpectedEOF\";\n}\n\nexport class NetworkError extends Error {\n  name = \"NetworkError\";\n}\n\n/** Happens when the file doesn't exist */\nexport class NoFileForUploading extends Error {\n  name = \"NoFileForUploading\";\n}\n\nexport class BadRequestError extends Error {\n  name = \"BadRequestError\";\n}\n\n/** Low-level client for grpc uploadapi.\n * The user should pass here a concrete BlobUpload/<storageId> resource,\n * it can be got from handle field of BlobUpload. */\nexport class ClientUpload {\n  private readonly wire: WireClientProvider<UploadRestClientType | UploadClient>;\n\n  constructor(\n    wireClientProviderFactory: WireClientProviderFactory,\n    public readonly httpClient: Dispatcher,\n    _: PlClient,\n    public readonly logger: MiLogger,\n  ) {\n    this.wire = wireClientProviderFactory.createWireClientProvider((wire) => {\n      if (wire.type === \"grpc\") {\n        return new UploadClient(wire.Transport);\n      }\n\n      return RestAPI.createClient<UploadApiPaths>({\n        hostAndPort: wire.Config.hostAndPort,\n        ssl: wire.Config.ssl,\n        dispatcher: wire.Dispatcher,\n        middlewares: wire.Middlewares,\n      });\n    });\n  }\n\n  close() {}\n\n  public async initUpload(\n    { id, type }: ResourceInfo,\n    options?: RpcOptions,\n  ): Promise<{\n    overall: bigint;\n    toUpload: bigint[];\n    checksumAlgorithm: UploadAPI_ChecksumAlgorithm;\n    checksumHeader: string;\n  }> {\n    const client = this.wire.get();\n\n    if (client instanceof UploadClient) {\n      const init = (await client.init({ resourceId: id }, addRTypeToMetadata(type, options)))\n        .response;\n\n      return {\n        overall: init.partsCount,\n        toUpload: this.partsToUpload(init.partsCount, init.uploadedParts),\n        checksumAlgorithm: init.checksumAlgorithm,\n        checksumHeader: init.checksumHeader,\n      };\n    }\n\n    const init = (\n      await client.POST(\"/v1/upload/init\", {\n        body: {\n          resourceId: id.toString(),\n        },\n        headers: { ...createRTypeRoutingHeader(type) },\n      })\n    ).data!;\n\n    return {\n      overall: BigInt(init.partsCount),\n      toUpload: this.partsToUpload(BigInt(init.partsCount), init.uploadedParts.map(BigInt)),\n      checksumAlgorithm: init.checksumAlgorithm,\n      checksumHeader: init.checksumHeader,\n    };\n  }\n\n  public async partUpload(\n    { id, type }: ResourceInfo,\n    path: string,\n    expectedMTimeUnix: bigint,\n    partNumber: bigint,\n    checksumAlgorithm: UploadAPI_ChecksumAlgorithm,\n    checksumHeader: string,\n    options?: RpcOptions,\n  ) {\n    const client = this.wire.get();\n\n    let info: UploadAPI_GetPartURL_Response;\n    if (client instanceof UploadClient) {\n      // partChecksum isn't used for now but protoc requires it to be set\n      info = (\n        await client.getPartURL(\n          {\n            resourceId: id,\n            partNumber,\n            uploadedPartSize: 0n,\n            isInternalUse: false,\n            partChecksum: \"\",\n          },\n          addRTypeToMetadata(type, options),\n        )\n      ).response;\n    } else {\n      const resp = (\n        await client.POST(\"/v1/upload/get-part-url\", {\n          body: {\n            resourceId: id.toString(),\n            partNumber: partNumber.toString(),\n            uploadedPartSize: \"0\",\n            isInternalUse: false,\n            partChecksum: \"\",\n          },\n          headers: { ...createRTypeRoutingHeader(type) },\n        })\n      ).data!;\n      info = {\n        uploadUrl: resp.uploadUrl,\n        method: resp.method,\n        headers: resp.headers,\n        chunkStart: BigInt(resp.chunkStart),\n        chunkEnd: BigInt(resp.chunkEnd),\n      };\n    }\n\n    const chunk = await readFileChunk(path, info.chunkStart, info.chunkEnd);\n    await checkExpectedMTime(path, expectedMTimeUnix);\n\n    if (checksumHeader && checksumAlgorithm === UploadAPI_ChecksumAlgorithm.CRC32C) {\n      info.headers.push({ name: checksumHeader, value: calculateCrc32cChecksum(chunk) });\n    }\n\n    const contentLength = Number(info.chunkEnd - info.chunkStart);\n    if (chunk.length !== contentLength) {\n      throw new Error(\n        `Chunk size mismatch: expected ${contentLength} bytes, but read ${chunk.length} bytes from file`,\n      );\n    }\n\n    const headers = Object.fromEntries(\n      info.headers.map(({ name, value }) => [name.toLowerCase(), value]),\n    );\n\n    try {\n      const {\n        body: rawBody,\n        statusCode,\n        headers: responseHeaders,\n      } = await request(info.uploadUrl, {\n        dispatcher: this.httpClient,\n        body: chunk,\n        // We got headers only after we send\n        // the whole body (in case of S3 PUT requests it's 5 MB).\n        // It might be slow with a slow connection (or with SSH),\n        // that's why we got big timeout here.\n        headersTimeout: 60000,\n        bodyTimeout: 60000,\n        // Prevent connection reuse by setting \"Connection: close\" header.\n        // This works around an issue with the backend's built-in S3 implementation\n        // that caused HTTP/1.1 protocol lines to be included in the uploaded file content.\n        reset: true,\n        headers,\n        method: info.method.toUpperCase() as Dispatcher.HttpMethod,\n      });\n\n      // always read the body for resources to be garbage collected.\n      const body = await rawBody.text();\n      checkStatusCodeOk(statusCode, body, responseHeaders, info);\n    } catch (e: unknown) {\n      if (e instanceof NetworkError) throw e;\n\n      if (e instanceof BadRequestError) throw e;\n\n      throw new Error(\n        `partUpload: error ${JSON.stringify(e)} happened while trying to do part upload to the url ${info.uploadUrl}, headers: ${JSON.stringify(info.headers)}`,\n      );\n    }\n\n    await this.updateProgress({ id, type }, BigInt(info.chunkEnd - info.chunkStart), options);\n  }\n\n  public async finalize(info: ResourceInfo, options?: RpcOptions) {\n    const client = this.wire.get();\n\n    if (client instanceof UploadClient) {\n      await client.finalize({ resourceId: info.id }, addRTypeToMetadata(info.type, options));\n    } else {\n      await client.POST(\"/v1/upload/finalize\", {\n        body: {\n          resourceId: info.id.toString(),\n        },\n        headers: { ...createRTypeRoutingHeader(info.type) },\n      });\n    }\n  }\n\n  /** Calculates parts that need to be uploaded from the parts that were\n   * already uploaded. */\n  private partsToUpload(partsCount: bigint, uploadedParts: bigint[]): bigint[] {\n    const toUpload: bigint[] = [];\n    const uploaded = new Set(uploadedParts);\n\n    for (let i = 1n; i <= partsCount; i++) {\n      if (!uploaded.has(i)) toUpload.push(i);\n    }\n\n    return toUpload;\n  }\n\n  private async updateProgress(\n    { id, type }: ResourceInfo,\n    bytesProcessed: bigint,\n    options?: RpcOptions,\n  ): Promise<void> {\n    const client = this.wire.get();\n\n    if (client instanceof UploadClient) {\n      await client.updateProgress(\n        {\n          resourceId: id,\n          bytesProcessed,\n        },\n        addRTypeToMetadata(type, options),\n      ).response;\n      return;\n    }\n\n    await client.POST(\"/v1/upload/update-progress\", {\n      body: {\n        resourceId: id.toString(),\n        bytesProcessed: bytesProcessed.toString(),\n      },\n      headers: { ...createRTypeRoutingHeader(type) },\n    });\n    return;\n  }\n}\n\nasync function readFileChunk(path: string, chunkStart: bigint, chunkEnd: bigint): Promise<Buffer> {\n  let f: fs.FileHandle | undefined;\n  try {\n    f = await fs.open(path);\n    const len = Number(chunkEnd - chunkStart);\n    const pos = Number(chunkStart);\n    const b = Buffer.alloc(len);\n    const bytesRead = await readBytesFromPosition(f, b, len, pos);\n\n    return b.subarray(0, bytesRead);\n  } catch (e: unknown) {\n    if (e && typeof e === \"object\" && \"code\" in e && e.code == \"ENOENT\")\n      throw new NoFileForUploading(`there is no file ${path} for uploading`);\n    throw e;\n  } finally {\n    await f?.close();\n  }\n}\n\n/** Read len bytes from a given position.\n * Without this, `FileHandle.read` can read less bytes than needed. */\nasync function readBytesFromPosition(f: fs.FileHandle, b: Buffer, len: number, position: number) {\n  let bytesReadTotal = 0;\n  while (bytesReadTotal < len) {\n    const { bytesRead } = await f.read(\n      b,\n      bytesReadTotal,\n      len - bytesReadTotal,\n      position + bytesReadTotal,\n    );\n    if (bytesRead === 0) {\n      throw new UnexpectedEOF(\"file ended earlier than expected.\");\n    }\n    bytesReadTotal += bytesRead;\n  }\n\n  return bytesReadTotal;\n}\n\nasync function checkExpectedMTime(path: string, expectedMTimeUnix: bigint) {\n  const mTime = BigInt(Math.floor((await fs.stat(path)).mtimeMs / 1000));\n  if (mTime > expectedMTimeUnix) {\n    throw new MTimeError(`file was modified, expected mtime: ${expectedMTimeUnix}, got: ${mTime}.`);\n  }\n}\n\n/** S3 error codes that indicate expired/invalid temporary credentials.\n * These are transient: a retry with a fresh presigned URL will succeed\n * once the backend refreshes its STS credentials. */\nconst TRANSIENT_S3_ERROR_CODES = [\"ExpiredToken\", \"RequestExpired\", \"TokenRefreshRequired\"];\n\nfunction isTransientS3Error(body: string): boolean {\n  return TRANSIENT_S3_ERROR_CODES.some((code) => body.includes(`<Code>${code}</Code>`));\n}\n\nfunction checkStatusCodeOk(\n  statusCode: number,\n  body: string,\n  headers: IncomingHttpHeaders,\n  info: UploadAPI_GetPartURL_Response,\n) {\n  if (statusCode == 400) {\n    if (isTransientS3Error(body)) {\n      throw new NetworkError(\n        `transient S3 credential error, status code: ${statusCode},` +\n          ` body: ${body}, headers: ${JSON.stringify(headers)}, url: ${info.uploadUrl}`,\n      );\n    }\n    throw new BadRequestError(\n      `response is not ok, status code: ${statusCode},` +\n        ` body: ${body}, headers: ${JSON.stringify(headers)}, url: ${info.uploadUrl}`,\n    );\n  }\n\n  if (statusCode != 200) {\n    throw new NetworkError(\n      `response is not ok, status code: ${statusCode},` +\n        ` body: ${body}, headers: ${JSON.stringify(headers)}, url: ${info.uploadUrl}`,\n    );\n  }\n}\n\n/** Calculate CRC32C checksum of a buffer and return as base64 string */\nfunction calculateCrc32cChecksum(data: Buffer): string {\n  const checksum = crc32c(data);\n  // Convert to unsigned 32-bit integer and then to base64\n  const buffer = Buffer.alloc(4);\n\n  buffer.writeUInt32BE(checksum, 0);\n  return buffer.toString(\"base64\");\n}\n"],"mappings":";;;;;;;;;;AAsBA,IAAa,aAAb,cAAgC,MAAM;CACpC,OAAO;;AAGT,IAAa,gBAAb,cAAmC,MAAM;CACvC,OAAO;;AAGT,IAAa,eAAb,cAAkC,MAAM;CACtC,OAAO;;;AAIT,IAAa,qBAAb,cAAwC,MAAM;CAC5C,OAAO;;AAGT,IAAa,kBAAb,cAAqC,MAAM;CACzC,OAAO;;;;;AAMT,IAAa,eAAb,MAA0B;CACxB,AAAiB;CAEjB,YACE,2BACA,AAAgB,YAChB,GACA,AAAgB,QAChB;EAHgB;EAEA;AAEhB,OAAK,OAAO,0BAA0B,0BAA0B,SAAS;AACvE,OAAI,KAAK,SAAS,OAChB,QAAO,IAAIA,qCAAa,KAAK,UAAU;AAGzC,UAAOC,kCAAQ,aAA6B;IAC1C,aAAa,KAAK,OAAO;IACzB,KAAK,KAAK,OAAO;IACjB,YAAY,KAAK;IACjB,aAAa,KAAK;IACnB,CAAC;IACF;;CAGJ,QAAQ;CAER,MAAa,WACX,EAAE,IAAI,QACN,SAMC;EACD,MAAM,SAAS,KAAK,KAAK,KAAK;AAE9B,MAAI,kBAAkBD,sCAAc;GAClC,MAAM,QAAQ,MAAM,OAAO,KAAK,EAAE,YAAY,IAAI,oDAAqB,MAAM,QAAQ,CAAC,EACnF;AAEH,UAAO;IACL,SAAS,KAAK;IACd,UAAU,KAAK,cAAc,KAAK,YAAY,KAAK,cAAc;IACjE,mBAAmB,KAAK;IACxB,gBAAgB,KAAK;IACtB;;EAGH,MAAM,QACJ,MAAM,OAAO,KAAK,mBAAmB;GACnC,MAAM,EACJ,YAAY,GAAG,UAAU,EAC1B;GACD,SAAS,EAAE,2DAA4B,KAAK,EAAE;GAC/C,CAAC,EACF;AAEF,SAAO;GACL,SAAS,OAAO,KAAK,WAAW;GAChC,UAAU,KAAK,cAAc,OAAO,KAAK,WAAW,EAAE,KAAK,cAAc,IAAI,OAAO,CAAC;GACrF,mBAAmB,KAAK;GACxB,gBAAgB,KAAK;GACtB;;CAGH,MAAa,WACX,EAAE,IAAI,QACN,MACA,mBACA,YACA,mBACA,gBACA,SACA;EACA,MAAM,SAAS,KAAK,KAAK,KAAK;EAE9B,IAAI;AACJ,MAAI,kBAAkBA,qCAEpB,SACE,MAAM,OAAO,WACX;GACE,YAAY;GACZ;GACA,kBAAkB;GAClB,eAAe;GACf,cAAc;GACf,oDACkB,MAAM,QAAQ,CAClC,EACD;OACG;GACL,MAAM,QACJ,MAAM,OAAO,KAAK,2BAA2B;IAC3C,MAAM;KACJ,YAAY,GAAG,UAAU;KACzB,YAAY,WAAW,UAAU;KACjC,kBAAkB;KAClB,eAAe;KACf,cAAc;KACf;IACD,SAAS,EAAE,2DAA4B,KAAK,EAAE;IAC/C,CAAC,EACF;AACF,UAAO;IACL,WAAW,KAAK;IAChB,QAAQ,KAAK;IACb,SAAS,KAAK;IACd,YAAY,OAAO,KAAK,WAAW;IACnC,UAAU,OAAO,KAAK,SAAS;IAChC;;EAGH,MAAM,QAAQ,MAAM,cAAc,MAAM,KAAK,YAAY,KAAK,SAAS;AACvE,QAAM,mBAAmB,MAAM,kBAAkB;AAEjD,MAAI,kBAAkB,sBAAsBE,6CAA4B,OACtE,MAAK,QAAQ,KAAK;GAAE,MAAM;GAAgB,OAAO,wBAAwB,MAAM;GAAE,CAAC;EAGpF,MAAM,gBAAgB,OAAO,KAAK,WAAW,KAAK,WAAW;AAC7D,MAAI,MAAM,WAAW,cACnB,OAAM,IAAI,MACR,iCAAiC,cAAc,mBAAmB,MAAM,OAAO,kBAChF;EAGH,MAAM,UAAU,OAAO,YACrB,KAAK,QAAQ,KAAK,EAAE,MAAM,YAAY,CAAC,KAAK,aAAa,EAAE,MAAM,CAAC,CACnE;AAED,MAAI;GACF,MAAM,EACJ,MAAM,SACN,YACA,SAAS,oBACP,0BAAc,KAAK,WAAW;IAChC,YAAY,KAAK;IACjB,MAAM;IAKN,gBAAgB;IAChB,aAAa;IAIb,OAAO;IACP;IACA,QAAQ,KAAK,OAAO,aAAa;IAClC,CAAC;AAIF,qBAAkB,YADL,MAAM,QAAQ,MAAM,EACG,iBAAiB,KAAK;WACnD,GAAY;AACnB,OAAI,aAAa,aAAc,OAAM;AAErC,OAAI,aAAa,gBAAiB,OAAM;AAExC,SAAM,IAAI,MACR,qBAAqB,KAAK,UAAU,EAAE,CAAC,sDAAsD,KAAK,UAAU,aAAa,KAAK,UAAU,KAAK,QAAQ,GACtJ;;AAGH,QAAM,KAAK,eAAe;GAAE;GAAI;GAAM,EAAE,OAAO,KAAK,WAAW,KAAK,WAAW,EAAE,QAAQ;;CAG3F,MAAa,SAAS,MAAoB,SAAsB;EAC9D,MAAM,SAAS,KAAK,KAAK,KAAK;AAE9B,MAAI,kBAAkBF,qCACpB,OAAM,OAAO,SAAS,EAAE,YAAY,KAAK,IAAI,oDAAqB,KAAK,MAAM,QAAQ,CAAC;MAEtF,OAAM,OAAO,KAAK,uBAAuB;GACvC,MAAM,EACJ,YAAY,KAAK,GAAG,UAAU,EAC/B;GACD,SAAS,EAAE,2DAA4B,KAAK,KAAK,EAAE;GACpD,CAAC;;;;CAMN,AAAQ,cAAc,YAAoB,eAAmC;EAC3E,MAAM,WAAqB,EAAE;EAC7B,MAAM,WAAW,IAAI,IAAI,cAAc;AAEvC,OAAK,IAAI,IAAI,IAAI,KAAK,YAAY,IAChC,KAAI,CAAC,SAAS,IAAI,EAAE,CAAE,UAAS,KAAK,EAAE;AAGxC,SAAO;;CAGT,MAAc,eACZ,EAAE,IAAI,QACN,gBACA,SACe;EACf,MAAM,SAAS,KAAK,KAAK,KAAK;AAE9B,MAAI,kBAAkBA,sCAAc;AAClC,SAAM,OAAO,eACX;IACE,YAAY;IACZ;IACD,oDACkB,MAAM,QAAQ,CAClC,CAAC;AACF;;AAGF,QAAM,OAAO,KAAK,8BAA8B;GAC9C,MAAM;IACJ,YAAY,GAAG,UAAU;IACzB,gBAAgB,eAAe,UAAU;IAC1C;GACD,SAAS,EAAE,2DAA4B,KAAK,EAAE;GAC/C,CAAC;;;AAKN,eAAe,cAAc,MAAc,YAAoB,UAAmC;CAChG,IAAI;AACJ,KAAI;AACF,MAAI,MAAMG,iBAAG,KAAK,KAAK;EACvB,MAAM,MAAM,OAAO,WAAW,WAAW;EACzC,MAAM,MAAM,OAAO,WAAW;EAC9B,MAAM,IAAI,OAAO,MAAM,IAAI;EAC3B,MAAM,YAAY,MAAM,sBAAsB,GAAG,GAAG,KAAK,IAAI;AAE7D,SAAO,EAAE,SAAS,GAAG,UAAU;UACxB,GAAY;AACnB,MAAI,KAAK,OAAO,MAAM,YAAY,UAAU,KAAK,EAAE,QAAQ,SACzD,OAAM,IAAI,mBAAmB,oBAAoB,KAAK,gBAAgB;AACxE,QAAM;WACE;AACR,QAAM,GAAG,OAAO;;;;;AAMpB,eAAe,sBAAsB,GAAkB,GAAW,KAAa,UAAkB;CAC/F,IAAI,iBAAiB;AACrB,QAAO,iBAAiB,KAAK;EAC3B,MAAM,EAAE,cAAc,MAAM,EAAE,KAC5B,GACA,gBACA,MAAM,gBACN,WAAW,eACZ;AACD,MAAI,cAAc,EAChB,OAAM,IAAI,cAAc,oCAAoC;AAE9D,oBAAkB;;AAGpB,QAAO;;AAGT,eAAe,mBAAmB,MAAc,mBAA2B;CACzE,MAAM,QAAQ,OAAO,KAAK,OAAO,MAAMA,iBAAG,KAAK,KAAK,EAAE,UAAU,IAAK,CAAC;AACtE,KAAI,QAAQ,kBACV,OAAM,IAAI,WAAW,sCAAsC,kBAAkB,SAAS,MAAM,GAAG;;;;;AAOnG,MAAM,2BAA2B;CAAC;CAAgB;CAAkB;CAAuB;AAE3F,SAAS,mBAAmB,MAAuB;AACjD,QAAO,yBAAyB,MAAM,SAAS,KAAK,SAAS,SAAS,KAAK,SAAS,CAAC;;AAGvF,SAAS,kBACP,YACA,MACA,SACA,MACA;AACA,KAAI,cAAc,KAAK;AACrB,MAAI,mBAAmB,KAAK,CAC1B,OAAM,IAAI,aACR,+CAA+C,WAAW,UAC9C,KAAK,aAAa,KAAK,UAAU,QAAQ,CAAC,SAAS,KAAK,YACrE;AAEH,QAAM,IAAI,gBACR,oCAAoC,WAAW,UACnC,KAAK,aAAa,KAAK,UAAU,QAAQ,CAAC,SAAS,KAAK,YACrE;;AAGH,KAAI,cAAc,IAChB,OAAM,IAAI,aACR,oCAAoC,WAAW,UACnC,KAAK,aAAa,KAAK,UAAU,QAAQ,CAAC,SAAS,KAAK,YACrE;;;AAKL,SAAS,wBAAwB,MAAsB;CACrD,MAAM,WAAWC,sBAAO,KAAK;CAE7B,MAAM,SAAS,OAAO,MAAM,EAAE;AAE9B,QAAO,cAAc,UAAU,EAAE;AACjC,QAAO,OAAO,SAAS,SAAS"}

package/dist/clients/upload.js

@@ -187,8 +187,22 @@ async function checkExpectedMTime(path, expectedMTimeUnix) {
 	const mTime = BigInt(Math.floor((await fs.stat(path)).mtimeMs / 1e3));
 	if (mTime > expectedMTimeUnix) throw new MTimeError(`file was modified, expected mtime: ${expectedMTimeUnix}, got: ${mTime}.`);
 }
+/** S3 error codes that indicate expired/invalid temporary credentials.
+* These are transient: a retry with a fresh presigned URL will succeed
+* once the backend refreshes its STS credentials. */
+const TRANSIENT_S3_ERROR_CODES = [
+	"ExpiredToken",
+	"RequestExpired",
+	"TokenRefreshRequired"
+];
+function isTransientS3Error(body) {
+	return TRANSIENT_S3_ERROR_CODES.some((code) => body.includes(`<Code>${code}</Code>`));
+}
 function checkStatusCodeOk(statusCode, body, headers, info) {
-	if (statusCode == 400) throw new BadRequestError(`response is not ok, status code: ${statusCode}, body: ${body}, headers: ${JSON.stringify(headers)}, url: ${info.uploadUrl}`);
+	if (statusCode == 400) {
+		if (isTransientS3Error(body)) throw new NetworkError(`transient S3 credential error, status code: ${statusCode}, body: ${body}, headers: ${JSON.stringify(headers)}, url: ${info.uploadUrl}`);
+		throw new BadRequestError(`response is not ok, status code: ${statusCode}, body: ${body}, headers: ${JSON.stringify(headers)}, url: ${info.uploadUrl}`);
+	}
 	if (statusCode != 200) throw new NetworkError(`response is not ok, status code: ${statusCode}, body: ${body}, headers: ${JSON.stringify(headers)}, url: ${info.uploadUrl}`);
 }
 /** Calculate CRC32C checksum of a buffer and return as base64 string */

package/dist/clients/upload.js.map

@@ -1 +1 @@
-{"version":3,"file":"upload.js","names":[],"sources":["../../src/clients/upload.ts"],"sourcesContent":["import type {\n  WireClientProvider,\n  WireClientProviderFactory,\n  PlClient,\n} from \"@milaboratories/pl-client\";\nimport { addRTypeToMetadata, createRTypeRoutingHeader, RestAPI } from \"@milaboratories/pl-client\";\nimport type { ResourceInfo } from \"@milaboratories/pl-tree\";\nimport type { MiLogger } from \"@milaboratories/ts-helpers\";\nimport type { RpcOptions } from \"@protobuf-ts/runtime-rpc\";\nimport * as fs from \"node:fs/promises\";\nimport type { Dispatcher } from \"undici\";\nimport { request } from \"undici\";\nimport {\n  UploadAPI_ChecksumAlgorithm,\n  type UploadAPI_GetPartURL_Response,\n} from \"../proto-grpc/github.com/milaboratory/pl/controllers/shared/grpc/uploadapi/protocol\";\nimport { UploadClient } from \"../proto-grpc/github.com/milaboratory/pl/controllers/shared/grpc/uploadapi/protocol.client\";\nimport type { UploadApiPaths, UploadRestClientType } from \"../proto-rest\";\nimport { crc32c } from \"./crc32c\";\n\nimport type { IncomingHttpHeaders } from \"undici/types/header\";\n\nexport class MTimeError extends Error {\n  name = \"MTimeError\";\n}\n\nexport class UnexpectedEOF extends Error {\n  name = \"UnexpectedEOF\";\n}\n\nexport class NetworkError extends Error {\n  name = \"NetworkError\";\n}\n\n/** Happens when the file doesn't exist */\nexport class NoFileForUploading extends Error {\n  name = \"NoFileForUploading\";\n}\n\nexport class BadRequestError extends Error {\n  name = \"BadRequestError\";\n}\n\n/** Low-level client for grpc uploadapi.\n * The user should pass here a concrete BlobUpload/<storageId> resource,\n * it can be got from handle field of BlobUpload. */\nexport class ClientUpload {\n  private readonly wire: WireClientProvider<UploadRestClientType | UploadClient>;\n\n  constructor(\n    wireClientProviderFactory: WireClientProviderFactory,\n    public readonly httpClient: Dispatcher,\n    _: PlClient,\n    public readonly logger: MiLogger,\n  ) {\n    this.wire = wireClientProviderFactory.createWireClientProvider((wire) => {\n      if (wire.type === \"grpc\") {\n        return new UploadClient(wire.Transport);\n      }\n\n      return RestAPI.createClient<UploadApiPaths>({\n        hostAndPort: wire.Config.hostAndPort,\n        ssl: wire.Config.ssl,\n        dispatcher: wire.Dispatcher,\n        middlewares: wire.Middlewares,\n      });\n    });\n  }\n\n  close() {}\n\n  public async initUpload(\n    { id, type }: ResourceInfo,\n    options?: RpcOptions,\n  ): Promise<{\n    overall: bigint;\n    toUpload: bigint[];\n    checksumAlgorithm: UploadAPI_ChecksumAlgorithm;\n    checksumHeader: string;\n  }> {\n    const client = this.wire.get();\n\n    if (client instanceof UploadClient) {\n      const init = (await client.init({ resourceId: id }, addRTypeToMetadata(type, options)))\n        .response;\n\n      return {\n        overall: init.partsCount,\n        toUpload: this.partsToUpload(init.partsCount, init.uploadedParts),\n        checksumAlgorithm: init.checksumAlgorithm,\n        checksumHeader: init.checksumHeader,\n      };\n    }\n\n    const init = (\n      await client.POST(\"/v1/upload/init\", {\n        body: {\n          resourceId: id.toString(),\n        },\n        headers: { ...createRTypeRoutingHeader(type) },\n      })\n    ).data!;\n\n    return {\n      overall: BigInt(init.partsCount),\n      toUpload: this.partsToUpload(BigInt(init.partsCount), init.uploadedParts.map(BigInt)),\n      checksumAlgorithm: init.checksumAlgorithm,\n      checksumHeader: init.checksumHeader,\n    };\n  }\n\n  public async partUpload(\n    { id, type }: ResourceInfo,\n    path: string,\n    expectedMTimeUnix: bigint,\n    partNumber: bigint,\n    checksumAlgorithm: UploadAPI_ChecksumAlgorithm,\n    checksumHeader: string,\n    options?: RpcOptions,\n  ) {\n    const client = this.wire.get();\n\n    let info: UploadAPI_GetPartURL_Response;\n    if (client instanceof UploadClient) {\n      // partChecksum isn't used for now but protoc requires it to be set\n      info = (\n        await client.getPartURL(\n          {\n            resourceId: id,\n            partNumber,\n            uploadedPartSize: 0n,\n            isInternalUse: false,\n            partChecksum: \"\",\n          },\n          addRTypeToMetadata(type, options),\n        )\n      ).response;\n    } else {\n      const resp = (\n        await client.POST(\"/v1/upload/get-part-url\", {\n          body: {\n            resourceId: id.toString(),\n            partNumber: partNumber.toString(),\n            uploadedPartSize: \"0\",\n            isInternalUse: false,\n            partChecksum: \"\",\n          },\n          headers: { ...createRTypeRoutingHeader(type) },\n        })\n      ).data!;\n      info = {\n        uploadUrl: resp.uploadUrl,\n        method: resp.method,\n        headers: resp.headers,\n        chunkStart: BigInt(resp.chunkStart),\n        chunkEnd: BigInt(resp.chunkEnd),\n      };\n    }\n\n    const chunk = await readFileChunk(path, info.chunkStart, info.chunkEnd);\n    await checkExpectedMTime(path, expectedMTimeUnix);\n\n    if (checksumHeader && checksumAlgorithm === UploadAPI_ChecksumAlgorithm.CRC32C) {\n      info.headers.push({ name: checksumHeader, value: calculateCrc32cChecksum(chunk) });\n    }\n\n    const contentLength = Number(info.chunkEnd - info.chunkStart);\n    if (chunk.length !== contentLength) {\n      throw new Error(\n        `Chunk size mismatch: expected ${contentLength} bytes, but read ${chunk.length} bytes from file`,\n      );\n    }\n\n    const headers = Object.fromEntries(\n      info.headers.map(({ name, value }) => [name.toLowerCase(), value]),\n    );\n\n    try {\n      const {\n        body: rawBody,\n        statusCode,\n        headers: responseHeaders,\n      } = await request(info.uploadUrl, {\n        dispatcher: this.httpClient,\n        body: chunk,\n        // We got headers only after we send\n        // the whole body (in case of S3 PUT requests it's 5 MB).\n        // It might be slow with a slow connection (or with SSH),\n        // that's why we got big timeout here.\n        headersTimeout: 60000,\n        bodyTimeout: 60000,\n        // Prevent connection reuse by setting \"Connection: close\" header.\n        // This works around an issue with the backend's built-in S3 implementation\n        // that caused HTTP/1.1 protocol lines to be included in the uploaded file content.\n        reset: true,\n        headers,\n        method: info.method.toUpperCase() as Dispatcher.HttpMethod,\n      });\n\n      // always read the body for resources to be garbage collected.\n      const body = await rawBody.text();\n      checkStatusCodeOk(statusCode, body, responseHeaders, info);\n    } catch (e: unknown) {\n      if (e instanceof NetworkError) throw e;\n\n      if (e instanceof BadRequestError) throw e;\n\n      throw new Error(\n        `partUpload: error ${JSON.stringify(e)} happened while trying to do part upload to the url ${info.uploadUrl}, headers: ${JSON.stringify(info.headers)}`,\n      );\n    }\n\n    await this.updateProgress({ id, type }, BigInt(info.chunkEnd - info.chunkStart), options);\n  }\n\n  public async finalize(info: ResourceInfo, options?: RpcOptions) {\n    const client = this.wire.get();\n\n    if (client instanceof UploadClient) {\n      await client.finalize({ resourceId: info.id }, addRTypeToMetadata(info.type, options));\n    } else {\n      await client.POST(\"/v1/upload/finalize\", {\n        body: {\n          resourceId: info.id.toString(),\n        },\n        headers: { ...createRTypeRoutingHeader(info.type) },\n      });\n    }\n  }\n\n  /** Calculates parts that need to be uploaded from the parts that were\n   * already uploaded. */\n  private partsToUpload(partsCount: bigint, uploadedParts: bigint[]): bigint[] {\n    const toUpload: bigint[] = [];\n    const uploaded = new Set(uploadedParts);\n\n    for (let i = 1n; i <= partsCount; i++) {\n      if (!uploaded.has(i)) toUpload.push(i);\n    }\n\n    return toUpload;\n  }\n\n  private async updateProgress(\n    { id, type }: ResourceInfo,\n    bytesProcessed: bigint,\n    options?: RpcOptions,\n  ): Promise<void> {\n    const client = this.wire.get();\n\n    if (client instanceof UploadClient) {\n      await client.updateProgress(\n        {\n          resourceId: id,\n          bytesProcessed,\n        },\n        addRTypeToMetadata(type, options),\n      ).response;\n      return;\n    }\n\n    await client.POST(\"/v1/upload/update-progress\", {\n      body: {\n        resourceId: id.toString(),\n        bytesProcessed: bytesProcessed.toString(),\n      },\n      headers: { ...createRTypeRoutingHeader(type) },\n    });\n    return;\n  }\n}\n\nasync function readFileChunk(path: string, chunkStart: bigint, chunkEnd: bigint): Promise<Buffer> {\n  let f: fs.FileHandle | undefined;\n  try {\n    f = await fs.open(path);\n    const len = Number(chunkEnd - chunkStart);\n    const pos = Number(chunkStart);\n    const b = Buffer.alloc(len);\n    const bytesRead = await readBytesFromPosition(f, b, len, pos);\n\n    return b.subarray(0, bytesRead);\n  } catch (e: unknown) {\n    if (e && typeof e === \"object\" && \"code\" in e && e.code == \"ENOENT\")\n      throw new NoFileForUploading(`there is no file ${path} for uploading`);\n    throw e;\n  } finally {\n    await f?.close();\n  }\n}\n\n/** Read len bytes from a given position.\n * Without this, `FileHandle.read` can read less bytes than needed. */\nasync function readBytesFromPosition(f: fs.FileHandle, b: Buffer, len: number, position: number) {\n  let bytesReadTotal = 0;\n  while (bytesReadTotal < len) {\n    const { bytesRead } = await f.read(\n      b,\n      bytesReadTotal,\n      len - bytesReadTotal,\n      position + bytesReadTotal,\n    );\n    if (bytesRead === 0) {\n      throw new UnexpectedEOF(\"file ended earlier than expected.\");\n    }\n    bytesReadTotal += bytesRead;\n  }\n\n  return bytesReadTotal;\n}\n\nasync function checkExpectedMTime(path: string, expectedMTimeUnix: bigint) {\n  const mTime = BigInt(Math.floor((await fs.stat(path)).mtimeMs / 1000));\n  if (mTime > expectedMTimeUnix) {\n    throw new MTimeError(`file was modified, expected mtime: ${expectedMTimeUnix}, got: ${mTime}.`);\n  }\n}\n\nfunction checkStatusCodeOk(\n  statusCode: number,\n  body: string,\n  headers: IncomingHttpHeaders,\n  info: UploadAPI_GetPartURL_Response,\n) {\n  if (statusCode == 400) {\n    throw new BadRequestError(\n      `response is not ok, status code: ${statusCode},` +\n        ` body: ${body}, headers: ${JSON.stringify(headers)}, url: ${info.uploadUrl}`,\n    );\n  }\n\n  if (statusCode != 200) {\n    throw new NetworkError(\n      `response is not ok, status code: ${statusCode},` +\n        ` body: ${body}, headers: ${JSON.stringify(headers)}, url: ${info.uploadUrl}`,\n    );\n  }\n}\n\n/** Calculate CRC32C checksum of a buffer and return as base64 string */\nfunction calculateCrc32cChecksum(data: Buffer): string {\n  const checksum = crc32c(data);\n  // Convert to unsigned 32-bit integer and then to base64\n  const buffer = Buffer.alloc(4);\n\n  buffer.writeUInt32BE(checksum, 0);\n  return buffer.toString(\"base64\");\n}\n"],"mappings":";;;;;;;;AAsBA,IAAa,aAAb,cAAgC,MAAM;CACpC,OAAO;;AAGT,IAAa,gBAAb,cAAmC,MAAM;CACvC,OAAO;;AAGT,IAAa,eAAb,cAAkC,MAAM;CACtC,OAAO;;;AAIT,IAAa,qBAAb,cAAwC,MAAM;CAC5C,OAAO;;AAGT,IAAa,kBAAb,cAAqC,MAAM;CACzC,OAAO;;;;;AAMT,IAAa,eAAb,MAA0B;CACxB,AAAiB;CAEjB,YACE,2BACA,AAAgB,YAChB,GACA,AAAgB,QAChB;EAHgB;EAEA;AAEhB,OAAK,OAAO,0BAA0B,0BAA0B,SAAS;AACvE,OAAI,KAAK,SAAS,OAChB,QAAO,IAAI,aAAa,KAAK,UAAU;AAGzC,UAAO,QAAQ,aAA6B;IAC1C,aAAa,KAAK,OAAO;IACzB,KAAK,KAAK,OAAO;IACjB,YAAY,KAAK;IACjB,aAAa,KAAK;IACnB,CAAC;IACF;;CAGJ,QAAQ;CAER,MAAa,WACX,EAAE,IAAI,QACN,SAMC;EACD,MAAM,SAAS,KAAK,KAAK,KAAK;AAE9B,MAAI,kBAAkB,cAAc;GAClC,MAAM,QAAQ,MAAM,OAAO,KAAK,EAAE,YAAY,IAAI,EAAE,mBAAmB,MAAM,QAAQ,CAAC,EACnF;AAEH,UAAO;IACL,SAAS,KAAK;IACd,UAAU,KAAK,cAAc,KAAK,YAAY,KAAK,cAAc;IACjE,mBAAmB,KAAK;IACxB,gBAAgB,KAAK;IACtB;;EAGH,MAAM,QACJ,MAAM,OAAO,KAAK,mBAAmB;GACnC,MAAM,EACJ,YAAY,GAAG,UAAU,EAC1B;GACD,SAAS,EAAE,GAAG,yBAAyB,KAAK,EAAE;GAC/C,CAAC,EACF;AAEF,SAAO;GACL,SAAS,OAAO,KAAK,WAAW;GAChC,UAAU,KAAK,cAAc,OAAO,KAAK,WAAW,EAAE,KAAK,cAAc,IAAI,OAAO,CAAC;GACrF,mBAAmB,KAAK;GACxB,gBAAgB,KAAK;GACtB;;CAGH,MAAa,WACX,EAAE,IAAI,QACN,MACA,mBACA,YACA,mBACA,gBACA,SACA;EACA,MAAM,SAAS,KAAK,KAAK,KAAK;EAE9B,IAAI;AACJ,MAAI,kBAAkB,aAEpB,SACE,MAAM,OAAO,WACX;GACE,YAAY;GACZ;GACA,kBAAkB;GAClB,eAAe;GACf,cAAc;GACf,EACD,mBAAmB,MAAM,QAAQ,CAClC,EACD;OACG;GACL,MAAM,QACJ,MAAM,OAAO,KAAK,2BAA2B;IAC3C,MAAM;KACJ,YAAY,GAAG,UAAU;KACzB,YAAY,WAAW,UAAU;KACjC,kBAAkB;KAClB,eAAe;KACf,cAAc;KACf;IACD,SAAS,EAAE,GAAG,yBAAyB,KAAK,EAAE;IAC/C,CAAC,EACF;AACF,UAAO;IACL,WAAW,KAAK;IAChB,QAAQ,KAAK;IACb,SAAS,KAAK;IACd,YAAY,OAAO,KAAK,WAAW;IACnC,UAAU,OAAO,KAAK,SAAS;IAChC;;EAGH,MAAM,QAAQ,MAAM,cAAc,MAAM,KAAK,YAAY,KAAK,SAAS;AACvE,QAAM,mBAAmB,MAAM,kBAAkB;AAEjD,MAAI,kBAAkB,sBAAsB,4BAA4B,OACtE,MAAK,QAAQ,KAAK;GAAE,MAAM;GAAgB,OAAO,wBAAwB,MAAM;GAAE,CAAC;EAGpF,MAAM,gBAAgB,OAAO,KAAK,WAAW,KAAK,WAAW;AAC7D,MAAI,MAAM,WAAW,cACnB,OAAM,IAAI,MACR,iCAAiC,cAAc,mBAAmB,MAAM,OAAO,kBAChF;EAGH,MAAM,UAAU,OAAO,YACrB,KAAK,QAAQ,KAAK,EAAE,MAAM,YAAY,CAAC,KAAK,aAAa,EAAE,MAAM,CAAC,CACnE;AAED,MAAI;GACF,MAAM,EACJ,MAAM,SACN,YACA,SAAS,oBACP,MAAM,QAAQ,KAAK,WAAW;IAChC,YAAY,KAAK;IACjB,MAAM;IAKN,gBAAgB;IAChB,aAAa;IAIb,OAAO;IACP;IACA,QAAQ,KAAK,OAAO,aAAa;IAClC,CAAC;AAIF,qBAAkB,YADL,MAAM,QAAQ,MAAM,EACG,iBAAiB,KAAK;WACnD,GAAY;AACnB,OAAI,aAAa,aAAc,OAAM;AAErC,OAAI,aAAa,gBAAiB,OAAM;AAExC,SAAM,IAAI,MACR,qBAAqB,KAAK,UAAU,EAAE,CAAC,sDAAsD,KAAK,UAAU,aAAa,KAAK,UAAU,KAAK,QAAQ,GACtJ;;AAGH,QAAM,KAAK,eAAe;GAAE;GAAI;GAAM,EAAE,OAAO,KAAK,WAAW,KAAK,WAAW,EAAE,QAAQ;;CAG3F,MAAa,SAAS,MAAoB,SAAsB;EAC9D,MAAM,SAAS,KAAK,KAAK,KAAK;AAE9B,MAAI,kBAAkB,aACpB,OAAM,OAAO,SAAS,EAAE,YAAY,KAAK,IAAI,EAAE,mBAAmB,KAAK,MAAM,QAAQ,CAAC;MAEtF,OAAM,OAAO,KAAK,uBAAuB;GACvC,MAAM,EACJ,YAAY,KAAK,GAAG,UAAU,EAC/B;GACD,SAAS,EAAE,GAAG,yBAAyB,KAAK,KAAK,EAAE;GACpD,CAAC;;;;CAMN,AAAQ,cAAc,YAAoB,eAAmC;EAC3E,MAAM,WAAqB,EAAE;EAC7B,MAAM,WAAW,IAAI,IAAI,cAAc;AAEvC,OAAK,IAAI,IAAI,IAAI,KAAK,YAAY,IAChC,KAAI,CAAC,SAAS,IAAI,EAAE,CAAE,UAAS,KAAK,EAAE;AAGxC,SAAO;;CAGT,MAAc,eACZ,EAAE,IAAI,QACN,gBACA,SACe;EACf,MAAM,SAAS,KAAK,KAAK,KAAK;AAE9B,MAAI,kBAAkB,cAAc;AAClC,SAAM,OAAO,eACX;IACE,YAAY;IACZ;IACD,EACD,mBAAmB,MAAM,QAAQ,CAClC,CAAC;AACF;;AAGF,QAAM,OAAO,KAAK,8BAA8B;GAC9C,MAAM;IACJ,YAAY,GAAG,UAAU;IACzB,gBAAgB,eAAe,UAAU;IAC1C;GACD,SAAS,EAAE,GAAG,yBAAyB,KAAK,EAAE;GAC/C,CAAC;;;AAKN,eAAe,cAAc,MAAc,YAAoB,UAAmC;CAChG,IAAI;AACJ,KAAI;AACF,MAAI,MAAM,GAAG,KAAK,KAAK;EACvB,MAAM,MAAM,OAAO,WAAW,WAAW;EACzC,MAAM,MAAM,OAAO,WAAW;EAC9B,MAAM,IAAI,OAAO,MAAM,IAAI;EAC3B,MAAM,YAAY,MAAM,sBAAsB,GAAG,GAAG,KAAK,IAAI;AAE7D,SAAO,EAAE,SAAS,GAAG,UAAU;UACxB,GAAY;AACnB,MAAI,KAAK,OAAO,MAAM,YAAY,UAAU,KAAK,EAAE,QAAQ,SACzD,OAAM,IAAI,mBAAmB,oBAAoB,KAAK,gBAAgB;AACxE,QAAM;WACE;AACR,QAAM,GAAG,OAAO;;;;;AAMpB,eAAe,sBAAsB,GAAkB,GAAW,KAAa,UAAkB;CAC/F,IAAI,iBAAiB;AACrB,QAAO,iBAAiB,KAAK;EAC3B,MAAM,EAAE,cAAc,MAAM,EAAE,KAC5B,GACA,gBACA,MAAM,gBACN,WAAW,eACZ;AACD,MAAI,cAAc,EAChB,OAAM,IAAI,cAAc,oCAAoC;AAE9D,oBAAkB;;AAGpB,QAAO;;AAGT,eAAe,mBAAmB,MAAc,mBAA2B;CACzE,MAAM,QAAQ,OAAO,KAAK,OAAO,MAAM,GAAG,KAAK,KAAK,EAAE,UAAU,IAAK,CAAC;AACtE,KAAI,QAAQ,kBACV,OAAM,IAAI,WAAW,sCAAsC,kBAAkB,SAAS,MAAM,GAAG;;AAInG,SAAS,kBACP,YACA,MACA,SACA,MACA;AACA,KAAI,cAAc,IAChB,OAAM,IAAI,gBACR,oCAAoC,WAAW,UACnC,KAAK,aAAa,KAAK,UAAU,QAAQ,CAAC,SAAS,KAAK,YACrE;AAGH,KAAI,cAAc,IAChB,OAAM,IAAI,aACR,oCAAoC,WAAW,UACnC,KAAK,aAAa,KAAK,UAAU,QAAQ,CAAC,SAAS,KAAK,YACrE;;;AAKL,SAAS,wBAAwB,MAAsB;CACrD,MAAM,WAAW,OAAO,KAAK;CAE7B,MAAM,SAAS,OAAO,MAAM,EAAE;AAE9B,QAAO,cAAc,UAAU,EAAE;AACjC,QAAO,OAAO,SAAS,SAAS"}
+{"version":3,"file":"upload.js","names":[],"sources":["../../src/clients/upload.ts"],"sourcesContent":["import type {\n  WireClientProvider,\n  WireClientProviderFactory,\n  PlClient,\n} from \"@milaboratories/pl-client\";\nimport { addRTypeToMetadata, createRTypeRoutingHeader, RestAPI } from \"@milaboratories/pl-client\";\nimport type { ResourceInfo } from \"@milaboratories/pl-tree\";\nimport type { MiLogger } from \"@milaboratories/ts-helpers\";\nimport type { RpcOptions } from \"@protobuf-ts/runtime-rpc\";\nimport * as fs from \"node:fs/promises\";\nimport type { Dispatcher } from \"undici\";\nimport { request } from \"undici\";\nimport {\n  UploadAPI_ChecksumAlgorithm,\n  type UploadAPI_GetPartURL_Response,\n} from \"../proto-grpc/github.com/milaboratory/pl/controllers/shared/grpc/uploadapi/protocol\";\nimport { UploadClient } from \"../proto-grpc/github.com/milaboratory/pl/controllers/shared/grpc/uploadapi/protocol.client\";\nimport type { UploadApiPaths, UploadRestClientType } from \"../proto-rest\";\nimport { crc32c } from \"./crc32c\";\n\nimport type { IncomingHttpHeaders } from \"undici/types/header\";\n\nexport class MTimeError extends Error {\n  name = \"MTimeError\";\n}\n\nexport class UnexpectedEOF extends Error {\n  name = \"UnexpectedEOF\";\n}\n\nexport class NetworkError extends Error {\n  name = \"NetworkError\";\n}\n\n/** Happens when the file doesn't exist */\nexport class NoFileForUploading extends Error {\n  name = \"NoFileForUploading\";\n}\n\nexport class BadRequestError extends Error {\n  name = \"BadRequestError\";\n}\n\n/** Low-level client for grpc uploadapi.\n * The user should pass here a concrete BlobUpload/<storageId> resource,\n * it can be got from handle field of BlobUpload. */\nexport class ClientUpload {\n  private readonly wire: WireClientProvider<UploadRestClientType | UploadClient>;\n\n  constructor(\n    wireClientProviderFactory: WireClientProviderFactory,\n    public readonly httpClient: Dispatcher,\n    _: PlClient,\n    public readonly logger: MiLogger,\n  ) {\n    this.wire = wireClientProviderFactory.createWireClientProvider((wire) => {\n      if (wire.type === \"grpc\") {\n        return new UploadClient(wire.Transport);\n      }\n\n      return RestAPI.createClient<UploadApiPaths>({\n        hostAndPort: wire.Config.hostAndPort,\n        ssl: wire.Config.ssl,\n        dispatcher: wire.Dispatcher,\n        middlewares: wire.Middlewares,\n      });\n    });\n  }\n\n  close() {}\n\n  public async initUpload(\n    { id, type }: ResourceInfo,\n    options?: RpcOptions,\n  ): Promise<{\n    overall: bigint;\n    toUpload: bigint[];\n    checksumAlgorithm: UploadAPI_ChecksumAlgorithm;\n    checksumHeader: string;\n  }> {\n    const client = this.wire.get();\n\n    if (client instanceof UploadClient) {\n      const init = (await client.init({ resourceId: id }, addRTypeToMetadata(type, options)))\n        .response;\n\n      return {\n        overall: init.partsCount,\n        toUpload: this.partsToUpload(init.partsCount, init.uploadedParts),\n        checksumAlgorithm: init.checksumAlgorithm,\n        checksumHeader: init.checksumHeader,\n      };\n    }\n\n    const init = (\n      await client.POST(\"/v1/upload/init\", {\n        body: {\n          resourceId: id.toString(),\n        },\n        headers: { ...createRTypeRoutingHeader(type) },\n      })\n    ).data!;\n\n    return {\n      overall: BigInt(init.partsCount),\n      toUpload: this.partsToUpload(BigInt(init.partsCount), init.uploadedParts.map(BigInt)),\n      checksumAlgorithm: init.checksumAlgorithm,\n      checksumHeader: init.checksumHeader,\n    };\n  }\n\n  public async partUpload(\n    { id, type }: ResourceInfo,\n    path: string,\n    expectedMTimeUnix: bigint,\n    partNumber: bigint,\n    checksumAlgorithm: UploadAPI_ChecksumAlgorithm,\n    checksumHeader: string,\n    options?: RpcOptions,\n  ) {\n    const client = this.wire.get();\n\n    let info: UploadAPI_GetPartURL_Response;\n    if (client instanceof UploadClient) {\n      // partChecksum isn't used for now but protoc requires it to be set\n      info = (\n        await client.getPartURL(\n          {\n            resourceId: id,\n            partNumber,\n            uploadedPartSize: 0n,\n            isInternalUse: false,\n            partChecksum: \"\",\n          },\n          addRTypeToMetadata(type, options),\n        )\n      ).response;\n    } else {\n      const resp = (\n        await client.POST(\"/v1/upload/get-part-url\", {\n          body: {\n            resourceId: id.toString(),\n            partNumber: partNumber.toString(),\n            uploadedPartSize: \"0\",\n            isInternalUse: false,\n            partChecksum: \"\",\n          },\n          headers: { ...createRTypeRoutingHeader(type) },\n        })\n      ).data!;\n      info = {\n        uploadUrl: resp.uploadUrl,\n        method: resp.method,\n        headers: resp.headers,\n        chunkStart: BigInt(resp.chunkStart),\n        chunkEnd: BigInt(resp.chunkEnd),\n      };\n    }\n\n    const chunk = await readFileChunk(path, info.chunkStart, info.chunkEnd);\n    await checkExpectedMTime(path, expectedMTimeUnix);\n\n    if (checksumHeader && checksumAlgorithm === UploadAPI_ChecksumAlgorithm.CRC32C) {\n      info.headers.push({ name: checksumHeader, value: calculateCrc32cChecksum(chunk) });\n    }\n\n    const contentLength = Number(info.chunkEnd - info.chunkStart);\n    if (chunk.length !== contentLength) {\n      throw new Error(\n        `Chunk size mismatch: expected ${contentLength} bytes, but read ${chunk.length} bytes from file`,\n      );\n    }\n\n    const headers = Object.fromEntries(\n      info.headers.map(({ name, value }) => [name.toLowerCase(), value]),\n    );\n\n    try {\n      const {\n        body: rawBody,\n        statusCode,\n        headers: responseHeaders,\n      } = await request(info.uploadUrl, {\n        dispatcher: this.httpClient,\n        body: chunk,\n        // We got headers only after we send\n        // the whole body (in case of S3 PUT requests it's 5 MB).\n        // It might be slow with a slow connection (or with SSH),\n        // that's why we got big timeout here.\n        headersTimeout: 60000,\n        bodyTimeout: 60000,\n        // Prevent connection reuse by setting \"Connection: close\" header.\n        // This works around an issue with the backend's built-in S3 implementation\n        // that caused HTTP/1.1 protocol lines to be included in the uploaded file content.\n        reset: true,\n        headers,\n        method: info.method.toUpperCase() as Dispatcher.HttpMethod,\n      });\n\n      // always read the body for resources to be garbage collected.\n      const body = await rawBody.text();\n      checkStatusCodeOk(statusCode, body, responseHeaders, info);\n    } catch (e: unknown) {\n      if (e instanceof NetworkError) throw e;\n\n      if (e instanceof BadRequestError) throw e;\n\n      throw new Error(\n        `partUpload: error ${JSON.stringify(e)} happened while trying to do part upload to the url ${info.uploadUrl}, headers: ${JSON.stringify(info.headers)}`,\n      );\n    }\n\n    await this.updateProgress({ id, type }, BigInt(info.chunkEnd - info.chunkStart), options);\n  }\n\n  public async finalize(info: ResourceInfo, options?: RpcOptions) {\n    const client = this.wire.get();\n\n    if (client instanceof UploadClient) {\n      await client.finalize({ resourceId: info.id }, addRTypeToMetadata(info.type, options));\n    } else {\n      await client.POST(\"/v1/upload/finalize\", {\n        body: {\n          resourceId: info.id.toString(),\n        },\n        headers: { ...createRTypeRoutingHeader(info.type) },\n      });\n    }\n  }\n\n  /** Calculates parts that need to be uploaded from the parts that were\n   * already uploaded. */\n  private partsToUpload(partsCount: bigint, uploadedParts: bigint[]): bigint[] {\n    const toUpload: bigint[] = [];\n    const uploaded = new Set(uploadedParts);\n\n    for (let i = 1n; i <= partsCount; i++) {\n      if (!uploaded.has(i)) toUpload.push(i);\n    }\n\n    return toUpload;\n  }\n\n  private async updateProgress(\n    { id, type }: ResourceInfo,\n    bytesProcessed: bigint,\n    options?: RpcOptions,\n  ): Promise<void> {\n    const client = this.wire.get();\n\n    if (client instanceof UploadClient) {\n      await client.updateProgress(\n        {\n          resourceId: id,\n          bytesProcessed,\n        },\n        addRTypeToMetadata(type, options),\n      ).response;\n      return;\n    }\n\n    await client.POST(\"/v1/upload/update-progress\", {\n      body: {\n        resourceId: id.toString(),\n        bytesProcessed: bytesProcessed.toString(),\n      },\n      headers: { ...createRTypeRoutingHeader(type) },\n    });\n    return;\n  }\n}\n\nasync function readFileChunk(path: string, chunkStart: bigint, chunkEnd: bigint): Promise<Buffer> {\n  let f: fs.FileHandle | undefined;\n  try {\n    f = await fs.open(path);\n    const len = Number(chunkEnd - chunkStart);\n    const pos = Number(chunkStart);\n    const b = Buffer.alloc(len);\n    const bytesRead = await readBytesFromPosition(f, b, len, pos);\n\n    return b.subarray(0, bytesRead);\n  } catch (e: unknown) {\n    if (e && typeof e === \"object\" && \"code\" in e && e.code == \"ENOENT\")\n      throw new NoFileForUploading(`there is no file ${path} for uploading`);\n    throw e;\n  } finally {\n    await f?.close();\n  }\n}\n\n/** Read len bytes from a given position.\n * Without this, `FileHandle.read` can read less bytes than needed. */\nasync function readBytesFromPosition(f: fs.FileHandle, b: Buffer, len: number, position: number) {\n  let bytesReadTotal = 0;\n  while (bytesReadTotal < len) {\n    const { bytesRead } = await f.read(\n      b,\n      bytesReadTotal,\n      len - bytesReadTotal,\n      position + bytesReadTotal,\n    );\n    if (bytesRead === 0) {\n      throw new UnexpectedEOF(\"file ended earlier than expected.\");\n    }\n    bytesReadTotal += bytesRead;\n  }\n\n  return bytesReadTotal;\n}\n\nasync function checkExpectedMTime(path: string, expectedMTimeUnix: bigint) {\n  const mTime = BigInt(Math.floor((await fs.stat(path)).mtimeMs / 1000));\n  if (mTime > expectedMTimeUnix) {\n    throw new MTimeError(`file was modified, expected mtime: ${expectedMTimeUnix}, got: ${mTime}.`);\n  }\n}\n\n/** S3 error codes that indicate expired/invalid temporary credentials.\n * These are transient: a retry with a fresh presigned URL will succeed\n * once the backend refreshes its STS credentials. */\nconst TRANSIENT_S3_ERROR_CODES = [\"ExpiredToken\", \"RequestExpired\", \"TokenRefreshRequired\"];\n\nfunction isTransientS3Error(body: string): boolean {\n  return TRANSIENT_S3_ERROR_CODES.some((code) => body.includes(`<Code>${code}</Code>`));\n}\n\nfunction checkStatusCodeOk(\n  statusCode: number,\n  body: string,\n  headers: IncomingHttpHeaders,\n  info: UploadAPI_GetPartURL_Response,\n) {\n  if (statusCode == 400) {\n    if (isTransientS3Error(body)) {\n      throw new NetworkError(\n        `transient S3 credential error, status code: ${statusCode},` +\n          ` body: ${body}, headers: ${JSON.stringify(headers)}, url: ${info.uploadUrl}`,\n      );\n    }\n    throw new BadRequestError(\n      `response is not ok, status code: ${statusCode},` +\n        ` body: ${body}, headers: ${JSON.stringify(headers)}, url: ${info.uploadUrl}`,\n    );\n  }\n\n  if (statusCode != 200) {\n    throw new NetworkError(\n      `response is not ok, status code: ${statusCode},` +\n        ` body: ${body}, headers: ${JSON.stringify(headers)}, url: ${info.uploadUrl}`,\n    );\n  }\n}\n\n/** Calculate CRC32C checksum of a buffer and return as base64 string */\nfunction calculateCrc32cChecksum(data: Buffer): string {\n  const checksum = crc32c(data);\n  // Convert to unsigned 32-bit integer and then to base64\n  const buffer = Buffer.alloc(4);\n\n  buffer.writeUInt32BE(checksum, 0);\n  return buffer.toString(\"base64\");\n}\n"],"mappings":";;;;;;;;AAsBA,IAAa,aAAb,cAAgC,MAAM;CACpC,OAAO;;AAGT,IAAa,gBAAb,cAAmC,MAAM;CACvC,OAAO;;AAGT,IAAa,eAAb,cAAkC,MAAM;CACtC,OAAO;;;AAIT,IAAa,qBAAb,cAAwC,MAAM;CAC5C,OAAO;;AAGT,IAAa,kBAAb,cAAqC,MAAM;CACzC,OAAO;;;;;AAMT,IAAa,eAAb,MAA0B;CACxB,AAAiB;CAEjB,YACE,2BACA,AAAgB,YAChB,GACA,AAAgB,QAChB;EAHgB;EAEA;AAEhB,OAAK,OAAO,0BAA0B,0BAA0B,SAAS;AACvE,OAAI,KAAK,SAAS,OAChB,QAAO,IAAI,aAAa,KAAK,UAAU;AAGzC,UAAO,QAAQ,aAA6B;IAC1C,aAAa,KAAK,OAAO;IACzB,KAAK,KAAK,OAAO;IACjB,YAAY,KAAK;IACjB,aAAa,KAAK;IACnB,CAAC;IACF;;CAGJ,QAAQ;CAER,MAAa,WACX,EAAE,IAAI,QACN,SAMC;EACD,MAAM,SAAS,KAAK,KAAK,KAAK;AAE9B,MAAI,kBAAkB,cAAc;GAClC,MAAM,QAAQ,MAAM,OAAO,KAAK,EAAE,YAAY,IAAI,EAAE,mBAAmB,MAAM,QAAQ,CAAC,EACnF;AAEH,UAAO;IACL,SAAS,KAAK;IACd,UAAU,KAAK,cAAc,KAAK,YAAY,KAAK,cAAc;IACjE,mBAAmB,KAAK;IACxB,gBAAgB,KAAK;IACtB;;EAGH,MAAM,QACJ,MAAM,OAAO,KAAK,mBAAmB;GACnC,MAAM,EACJ,YAAY,GAAG,UAAU,EAC1B;GACD,SAAS,EAAE,GAAG,yBAAyB,KAAK,EAAE;GAC/C,CAAC,EACF;AAEF,SAAO;GACL,SAAS,OAAO,KAAK,WAAW;GAChC,UAAU,KAAK,cAAc,OAAO,KAAK,WAAW,EAAE,KAAK,cAAc,IAAI,OAAO,CAAC;GACrF,mBAAmB,KAAK;GACxB,gBAAgB,KAAK;GACtB;;CAGH,MAAa,WACX,EAAE,IAAI,QACN,MACA,mBACA,YACA,mBACA,gBACA,SACA;EACA,MAAM,SAAS,KAAK,KAAK,KAAK;EAE9B,IAAI;AACJ,MAAI,kBAAkB,aAEpB,SACE,MAAM,OAAO,WACX;GACE,YAAY;GACZ;GACA,kBAAkB;GAClB,eAAe;GACf,cAAc;GACf,EACD,mBAAmB,MAAM,QAAQ,CAClC,EACD;OACG;GACL,MAAM,QACJ,MAAM,OAAO,KAAK,2BAA2B;IAC3C,MAAM;KACJ,YAAY,GAAG,UAAU;KACzB,YAAY,WAAW,UAAU;KACjC,kBAAkB;KAClB,eAAe;KACf,cAAc;KACf;IACD,SAAS,EAAE,GAAG,yBAAyB,KAAK,EAAE;IAC/C,CAAC,EACF;AACF,UAAO;IACL,WAAW,KAAK;IAChB,QAAQ,KAAK;IACb,SAAS,KAAK;IACd,YAAY,OAAO,KAAK,WAAW;IACnC,UAAU,OAAO,KAAK,SAAS;IAChC;;EAGH,MAAM,QAAQ,MAAM,cAAc,MAAM,KAAK,YAAY,KAAK,SAAS;AACvE,QAAM,mBAAmB,MAAM,kBAAkB;AAEjD,MAAI,kBAAkB,sBAAsB,4BAA4B,OACtE,MAAK,QAAQ,KAAK;GAAE,MAAM;GAAgB,OAAO,wBAAwB,MAAM;GAAE,CAAC;EAGpF,MAAM,gBAAgB,OAAO,KAAK,WAAW,KAAK,WAAW;AAC7D,MAAI,MAAM,WAAW,cACnB,OAAM,IAAI,MACR,iCAAiC,cAAc,mBAAmB,MAAM,OAAO,kBAChF;EAGH,MAAM,UAAU,OAAO,YACrB,KAAK,QAAQ,KAAK,EAAE,MAAM,YAAY,CAAC,KAAK,aAAa,EAAE,MAAM,CAAC,CACnE;AAED,MAAI;GACF,MAAM,EACJ,MAAM,SACN,YACA,SAAS,oBACP,MAAM,QAAQ,KAAK,WAAW;IAChC,YAAY,KAAK;IACjB,MAAM;IAKN,gBAAgB;IAChB,aAAa;IAIb,OAAO;IACP;IACA,QAAQ,KAAK,OAAO,aAAa;IAClC,CAAC;AAIF,qBAAkB,YADL,MAAM,QAAQ,MAAM,EACG,iBAAiB,KAAK;WACnD,GAAY;AACnB,OAAI,aAAa,aAAc,OAAM;AAErC,OAAI,aAAa,gBAAiB,OAAM;AAExC,SAAM,IAAI,MACR,qBAAqB,KAAK,UAAU,EAAE,CAAC,sDAAsD,KAAK,UAAU,aAAa,KAAK,UAAU,KAAK,QAAQ,GACtJ;;AAGH,QAAM,KAAK,eAAe;GAAE;GAAI;GAAM,EAAE,OAAO,KAAK,WAAW,KAAK,WAAW,EAAE,QAAQ;;CAG3F,MAAa,SAAS,MAAoB,SAAsB;EAC9D,MAAM,SAAS,KAAK,KAAK,KAAK;AAE9B,MAAI,kBAAkB,aACpB,OAAM,OAAO,SAAS,EAAE,YAAY,KAAK,IAAI,EAAE,mBAAmB,KAAK,MAAM,QAAQ,CAAC;MAEtF,OAAM,OAAO,KAAK,uBAAuB;GACvC,MAAM,EACJ,YAAY,KAAK,GAAG,UAAU,EAC/B;GACD,SAAS,EAAE,GAAG,yBAAyB,KAAK,KAAK,EAAE;GACpD,CAAC;;;;CAMN,AAAQ,cAAc,YAAoB,eAAmC;EAC3E,MAAM,WAAqB,EAAE;EAC7B,MAAM,WAAW,IAAI,IAAI,cAAc;AAEvC,OAAK,IAAI,IAAI,IAAI,KAAK,YAAY,IAChC,KAAI,CAAC,SAAS,IAAI,EAAE,CAAE,UAAS,KAAK,EAAE;AAGxC,SAAO;;CAGT,MAAc,eACZ,EAAE,IAAI,QACN,gBACA,SACe;EACf,MAAM,SAAS,KAAK,KAAK,KAAK;AAE9B,MAAI,kBAAkB,cAAc;AAClC,SAAM,OAAO,eACX;IACE,YAAY;IACZ;IACD,EACD,mBAAmB,MAAM,QAAQ,CAClC,CAAC;AACF;;AAGF,QAAM,OAAO,KAAK,8BAA8B;GAC9C,MAAM;IACJ,YAAY,GAAG,UAAU;IACzB,gBAAgB,eAAe,UAAU;IAC1C;GACD,SAAS,EAAE,GAAG,yBAAyB,KAAK,EAAE;GAC/C,CAAC;;;AAKN,eAAe,cAAc,MAAc,YAAoB,UAAmC;CAChG,IAAI;AACJ,KAAI;AACF,MAAI,MAAM,GAAG,KAAK,KAAK;EACvB,MAAM,MAAM,OAAO,WAAW,WAAW;EACzC,MAAM,MAAM,OAAO,WAAW;EAC9B,MAAM,IAAI,OAAO,MAAM,IAAI;EAC3B,MAAM,YAAY,MAAM,sBAAsB,GAAG,GAAG,KAAK,IAAI;AAE7D,SAAO,EAAE,SAAS,GAAG,UAAU;UACxB,GAAY;AACnB,MAAI,KAAK,OAAO,MAAM,YAAY,UAAU,KAAK,EAAE,QAAQ,SACzD,OAAM,IAAI,mBAAmB,oBAAoB,KAAK,gBAAgB;AACxE,QAAM;WACE;AACR,QAAM,GAAG,OAAO;;;;;AAMpB,eAAe,sBAAsB,GAAkB,GAAW,KAAa,UAAkB;CAC/F,IAAI,iBAAiB;AACrB,QAAO,iBAAiB,KAAK;EAC3B,MAAM,EAAE,cAAc,MAAM,EAAE,KAC5B,GACA,gBACA,MAAM,gBACN,WAAW,eACZ;AACD,MAAI,cAAc,EAChB,OAAM,IAAI,cAAc,oCAAoC;AAE9D,oBAAkB;;AAGpB,QAAO;;AAGT,eAAe,mBAAmB,MAAc,mBAA2B;CACzE,MAAM,QAAQ,OAAO,KAAK,OAAO,MAAM,GAAG,KAAK,KAAK,EAAE,UAAU,IAAK,CAAC;AACtE,KAAI,QAAQ,kBACV,OAAM,IAAI,WAAW,sCAAsC,kBAAkB,SAAS,MAAM,GAAG;;;;;AAOnG,MAAM,2BAA2B;CAAC;CAAgB;CAAkB;CAAuB;AAE3F,SAAS,mBAAmB,MAAuB;AACjD,QAAO,yBAAyB,MAAM,SAAS,KAAK,SAAS,SAAS,KAAK,SAAS,CAAC;;AAGvF,SAAS,kBACP,YACA,MACA,SACA,MACA;AACA,KAAI,cAAc,KAAK;AACrB,MAAI,mBAAmB,KAAK,CAC1B,OAAM,IAAI,aACR,+CAA+C,WAAW,UAC9C,KAAK,aAAa,KAAK,UAAU,QAAQ,CAAC,SAAS,KAAK,YACrE;AAEH,QAAM,IAAI,gBACR,oCAAoC,WAAW,UACnC,KAAK,aAAa,KAAK,UAAU,QAAQ,CAAC,SAAS,KAAK,YACrE;;AAGH,KAAI,cAAc,IAChB,OAAM,IAAI,aACR,oCAAoC,WAAW,UACnC,KAAK,aAAa,KAAK,UAAU,QAAQ,CAAC,SAAS,KAAK,YACrE;;;AAKL,SAAS,wBAAwB,MAAsB;CACrD,MAAM,WAAW,OAAO,KAAK;CAE7B,MAAM,SAAS,OAAO,MAAM,EAAE;AAE9B,QAAO,cAAc,UAAU,EAAE;AACjC,QAAO,OAAO,SAAS,SAAS"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@milaboratories/pl-drivers",
-  "version": "1.12.3",
+  "version": "1.12.4",
   "description": "Drivers and a low-level clients for log streaming, downloading and uploading files from and to pl",
   "files": [
     "dist/**/*",
@@ -28,12 +28,12 @@
     "tar-fs": "^3.0.9",
     "undici": "~7.16.0",
     "zod": "~3.23.8",
-    "@milaboratories/computable": "2.9.0",
-    "@milaboratories/pl-model-common": "1.29.0",
     "@milaboratories/pl-tree": "1.9.3",
-    "@milaboratories/helpers": "1.14.0",
+    "@milaboratories/pl-model-common": "1.29.0",
+    "@milaboratories/computable": "2.9.0",
+    "@milaboratories/ts-helpers": "1.7.3",
     "@milaboratories/pl-client": "2.18.2",
-    "@milaboratories/ts-helpers": "1.7.3"
+    "@milaboratories/helpers": "1.14.0"
   },
   "devDependencies": {
     "@types/decompress": "^4.2.7",
@@ -44,9 +44,9 @@
     "typescript": "~5.9.3",
     "vitest": "^4.0.18",
     "@milaboratories/build-configs": "1.5.2",
+    "@milaboratories/ts-configs": "1.2.2",
     "@milaboratories/test-helpers": "1.2.0",
-    "@milaboratories/ts-builder": "1.3.0",
-    "@milaboratories/ts-configs": "1.2.2"
+    "@milaboratories/ts-builder": "1.3.0"
   },
   "engines": {
     "node": ">=22"

package/src/clients/upload.ts

@@ -316,6 +316,15 @@ async function checkExpectedMTime(path: string, expectedMTimeUnix: bigint) {
   }
 }
 
+/** S3 error codes that indicate expired/invalid temporary credentials.
+ * These are transient: a retry with a fresh presigned URL will succeed
+ * once the backend refreshes its STS credentials. */
+const TRANSIENT_S3_ERROR_CODES = ["ExpiredToken", "RequestExpired", "TokenRefreshRequired"];
+
+function isTransientS3Error(body: string): boolean {
+  return TRANSIENT_S3_ERROR_CODES.some((code) => body.includes(`<Code>${code}</Code>`));
+}
+
 function checkStatusCodeOk(
   statusCode: number,
   body: string,
@@ -323,6 +332,12 @@ function checkStatusCodeOk(
   info: UploadAPI_GetPartURL_Response,
 ) {
   if (statusCode == 400) {
+    if (isTransientS3Error(body)) {
+      throw new NetworkError(
+        `transient S3 credential error, status code: ${statusCode},` +
+          ` body: ${body}, headers: ${JSON.stringify(headers)}, url: ${info.uploadUrl}`,
+      );
+    }
     throw new BadRequestError(
       `response is not ok, status code: ${statusCode},` +
         ` body: ${body}, headers: ${JSON.stringify(headers)}, url: ${info.uploadUrl}`,