fix(middleware-flexible-checksums): skip checksum validation if CRC64NVME dependency is absent

[trivikr]

Issue

Fixes: #6822

Description

Skips checksum validation if CRC64NVME dependency is absent

Testing

Unit testing

Perform putObject with CRC64NVME dependency

// putObject.mjs
import { S3, ChecksumAlgorithm } from "@aws-sdk/client-s3";
import "@aws-sdk/crc64-nvme-crt";

const client = new S3();

const Bucket = "test-flexible-checksums-v2"; // Change to your bucket name.
const Key = "foo";
const Body = "bar";

await client.putObject({ Bucket, Key, Body, ChecksumAlgorithm: ChecksumAlgorithm.CRC64NVME });

getObject without CRC64NVME dependency

// getObject.mjs
import { S3 } from "../aws-sdk-js-v3/clients/client-s3/dist-cjs/index.js";

const client = new S3({ logger: console });

const Bucket = "test-flexible-checksums-v2";
const Key = "foo";

await client.getObject({ Bucket, Key });

Before

Error is thrown

node:internal/modules/run_main:122
    triggerUncaughtException(
    ^

Error: Please check whether you have installed the "@aws-sdk/crc64-nvme-crt" package explicitly. 
You must also register the package by calling [require("@aws-sdk/crc64-nvme-crt");] or an ESM equivalent such as [import "@aws-sdk/crc64-nvme-crt";]. 
For more information please go to https://github.com/aws/aws-sdk-js-v3#functionality-requiring-aws-common-runtime-crt
    at selectChecksumAlgorithmFunction (/Users/trivikr/workspace/test/node_modules/@aws-sdk/middleware-flexible-checksums/dist-cjs/index.js:209:15)
    at validateChecksumFromResponse (/Users/trivikr/workspace/test/node_modules/@aws-sdk/middleware-flexible-checksums/dist-cjs/index.js:411:35)
    at /Users/trivikr/workspace/test/node_modules/@aws-sdk/middleware-flexible-checksums/dist-cjs/index.js:466:11
    at process.processTicksAndRejections (node:internal/process/task_queues:105:5)
    at async /Users/trivikr/workspace/test/node_modules/@aws-sdk/middleware-sdk-s3/dist-cjs/index.js:174:20
    at async /Users/trivikr/workspace/test/node_modules/@smithy/middleware-serde/dist-cjs/index.js:33:24
    at async /Users/trivikr/workspace/test/node_modules/@aws-sdk/middleware-sdk-s3/dist-cjs/index.js:483:18
    at async /Users/trivikr/workspace/test/node_modules/@smithy/middleware-retry/dist-cjs/index.js:321:38
    at async /Users/trivikr/workspace/test/node_modules/@aws-sdk/middleware-sdk-s3/dist-cjs/index.js:109:22
    at async /Users/trivikr/workspace/test/node_modules/@aws-sdk/middleware-sdk-s3/dist-cjs/index.js:136:14 {
  '$metadata': { attempts: 1, totalRetryDelay: 0 }
}

After

No error is thrown, but a warning is emitted and validation is skipped.

...
Skipping CRC64NVME checksum validation: Please check whether you have installed the "@aws-sdk/crc64-nvme-crt" package explicitly. 
You must also register the package by calling [require("@aws-sdk/crc64-nvme-crt");] or an ESM equivalent such as [import "@aws-sdk/crc64-nvme-crt";]. 
For more information please go to https://github.com/aws/aws-sdk-js-v3#functionality-requiring-aws-common-runtime-crt
...

getObject with CRC64NVME dependency

// getObject.mjs
import { S3 } from "../aws-sdk-js-v3/clients/client-s3/dist-cjs/index.js";
import "../aws-sdk-js-v3/packages/crc64-nvme-crt/dist-cjs/index.js";

const client = new S3({ logger: console });

const Bucket = "test-flexible-checksums-v2";
const Key = "foo";

await client.getObject({ Bucket, Key });

No warning is emitted, and validation is performed.

---

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

[kuhe]

currently, the only possible way to enter this branch is due to the thrown missing dependency error, but should this perhaps be more explicit?

method 1:

if (String(e).includes("@aws-sdk/crc64-nvme-crt")) {
  ...
  continue;
}

method 2:

// throw site
const error = new Error("...");
error.missingOptionalDependency = true;
throw error;

// catch site
if (error.missingOptionalDependency) {
  ...
  continue;
}