fix: add scenario 3 conformance tests (#1702)

test: disable retries when creating write stream as part of upload. test: add scenario 3 tests update nodejs-common to 3.8.1 test: disable autoRetry when calling createWriteStream from save linter fixes fix test fix unit tests by adding new string and additional guard case add delay to ensure docker container is started
googleapis · Nov 5, 2021 · e16a3a5 · e16a3a5
1 parent d265f8c
commit e16a3a5
Show file tree

Hide file tree

Showing 7 changed files with 49 additions and 10 deletions.
diff --git a/conformance-test/retryStrategy.ts b/conformance-test/retryStrategy.ts
@@ -127,6 +127,13 @@ function excecuteScenario(testCase: RetryTestCase) {
             apiEndpoint: TESTBENCH_HOST,
             projectId: CONF_TEST_PROJECT_ID,
           });
+          creationResult = await createTestBenchRetryTest(
+            instructionSet.instructions,
+            jsonMethod?.name.toString()
+          );
+        });
+
+        beforeEach(async () => {
           bucket = await createBucketForTest(
             storage,
             testCase.preconditionProvided,
@@ -137,13 +144,10 @@ function excecuteScenario(testCase: RetryTestCase) {
             storageMethodString,
             bucket
           );
+
           notification = bucket.notification(`${TESTS_PREFIX}`);
           await notification.create();
 
-          creationResult = await createTestBenchRetryTest(
-            instructionSet.instructions,
-            jsonMethod?.name.toString()
-          );
           storage.interceptors.push({
             request: requestConfig => {
               requestConfig.headers = requestConfig.headers || {};
@@ -155,6 +159,10 @@ function excecuteScenario(testCase: RetryTestCase) {
           });
         });
 
+        afterEach(() => {
+          storage.interceptors.pop();
+        });
+
         it(`${storageMethodString}${instructionNumber}`, async () => {
           if (testCase.expectSuccess) {
             assert.ifError(

diff --git a/conformance-test/test-bench-util.ts b/conformance-test/test-bench-util.ts
@@ -24,7 +24,7 @@ const DEFAULT_IMAGE_NAME =
 const DEFAULT_IMAGE_TAG = 'latest';
 const DOCKER_IMAGE = `${DEFAULT_IMAGE_NAME}:${DEFAULT_IMAGE_TAG}`;
 const PULL_CMD = `docker pull ${DOCKER_IMAGE}`;
-const RUN_CMD = `docker run --rm -d -p ${PORT}:${PORT} --name ${CONTAINER_NAME} ${DOCKER_IMAGE}`;
+const RUN_CMD = `docker run --rm -d -p ${PORT}:${PORT} --name ${CONTAINER_NAME} ${DOCKER_IMAGE} && sleep 1`;
 const STOP_CMD = `docker stop ${CONTAINER_NAME};`;
 
 export async function getTestBenchDockerImage(): Promise<Buffer> {

diff --git a/conformance-test/test-data/retryStrategyTestData.json b/conformance-test/test-data/retryStrategyTestData.json
@@ -236,13 +236,28 @@
       },
       {
         "id": 3,
-        "description": "conditionally idempotent no retries when precondition is absent",
+        "description": "conditionally_idempotent_no_retries_when_precondition_is_absent",
         "cases": [
           {
-            "instructions": []
+            "instructions": ["return-503"]
+          },
+          {
+            "instructions": ["return-reset-connection"]
           }
         ],
-        "methods": [],
+        "methods": [
+          {"name": "storage.buckets.patch",         "resources": ["BUCKET"]},
+          {"name": "storage.buckets.setIamPolicy",  "resources": ["BUCKET"]},
+          {"name": "storage.buckets.update",        "resources": ["BUCKET"]},
+          {"name": "storage.hmacKey.update",        "resources": ["HMAC_KEY"]},
+          {"name": "storage.objects.compose",       "resources": ["BUCKET", "OBJECT"]},
+          {"name": "storage.objects.copy",          "resources": ["BUCKET", "OBJECT"]},
+          {"name": "storage.objects.delete",        "resources": ["BUCKET", "OBJECT"]},
+          {"name": "storage.objects.insert",        "resources": ["BUCKET"]},
+          {"name": "storage.objects.patch",         "resources": ["BUCKET", "OBJECT"]},
+          {"name": "storage.objects.rewrite",       "resources": ["BUCKET", "OBJECT"]},
+          {"name": "storage.objects.update",        "resources": ["BUCKET", "OBJECT"]}
+        ],
         "preconditionProvided": false,
         "expectSuccess": false
       },

diff --git a/package.json b/package.json
@@ -50,7 +50,7 @@
     "precompile": "gts clean"
   },
   "dependencies": {
-    "@google-cloud/common": "^3.7.4",
+    "@google-cloud/common": "^3.8.1",
     "@google-cloud/paginator": "^3.0.0",
     "@google-cloud/promisify": "^2.0.0",
     "arrify": "^2.0.0",

diff --git a/src/bucket.ts b/src/bucket.ts
@@ -3922,6 +3922,12 @@ class Bucket extends ServiceObject {
       const returnValue = retry(
         async (bail: (err: Error) => void) => {
           await new Promise<void>((resolve, reject) => {
+            if (
+              numberOfRetries === 0 &&
+              newFile?.storage?.retryOptions?.autoRetry
+            ) {
+              newFile.storage.retryOptions.autoRetry = false;
+            }
             const writable = newFile.createWriteStream(options);
             if (options.onUploadProgress) {
               writable.on('progress', options.onUploadProgress);

diff --git a/src/file.ts b/src/file.ts
@@ -3760,6 +3760,9 @@ class File extends ServiceObject<File> {
     const returnValue = retry(
       async (bail: (err: Error) => void) => {
         await new Promise<void>((resolve, reject) => {
+          if (maxRetries === 0) {
+            this.storage.retryOptions.autoRetry = false;
+          }
           const writable = this.createWriteStream(options)
             .on('error', err => {
               if (
@@ -4085,7 +4088,13 @@ class File extends ServiceObject<File> {
  * that a callback is omitted.
  */
 promisifyAll(File, {
-  exclude: ['publicUrl', 'request', 'save', 'setEncryptionKey'],
+  exclude: [
+    'publicUrl',
+    'request',
+    'save',
+    'setEncryptionKey',
+    'shouldRetryBasedOnPreconditionAndIdempotencyStrat',
+  ],
 });
 
 /**

diff --git a/test/file.ts b/test/file.ts
@@ -97,6 +97,7 @@ const fakePromisify = {
       'request',
       'save',
       'setEncryptionKey',
+      'shouldRetryBasedOnPreconditionAndIdempotencyStrat',
     ]);
   },
 };