samples: fix wording for preconditions to use correct operation inste… (#2130)

ddelgrosso1 · web-flow · commit 68cd68475193 · 2023-01-24T10:23:30.000-08:00
* samples: fix wording for preconditions to use correct operation instead of upload

* correct file.setmetadata related samples to reference ifMetagenerationMatch instead of ifGenerationMatch

* fix samples tests
diff --git a/samples/changeFileCSEKToCMEK.js b/samples/changeFileCSEKToCMEK.js
@@ -53,7 +53,7 @@ function main(
     const rotateEncryptionKeyOptions = {
       kmsKeyName,
       // Optional: set a generation-match precondition to avoid potential race
-      // conditions and data corruptions. The request to upload is aborted if the
+      // conditions and data corruptions. The request to copy is aborted if the
       // object's generation number does not match your precondition.
       preconditionOpts: {
         ifGenerationMatch: generationMatchPrecondition,
diff --git a/samples/composeFile.js b/samples/composeFile.js
@@ -54,7 +54,7 @@ function main(
 
     // Optional:
     // Set a generation-match precondition to avoid potential race conditions
-    // and data corruptions. The request to upload is aborted if the object's
+    // and data corruptions. The request to compose is aborted if the object's
     // generation number does not match your precondition. For a destination
     // object that does not yet exist, set the ifGenerationMatch precondition to 0
     // If the destination object already exists in your bucket, set instead a
diff --git a/samples/copyFile.js b/samples/copyFile.js
@@ -54,7 +54,7 @@ function main(
 
     // Optional:
     // Set a generation-match precondition to avoid potential race conditions
-    // and data corruptions. The request to upload is aborted if the object's
+    // and data corruptions. The request to copy is aborted if the object's
     // generation number does not match your precondition. For a destination
     // object that does not yet exist, set the ifGenerationMatch precondition to 0
     // If the destination object already exists in your bucket, set instead a
diff --git a/samples/copyOldVersionOfFile.js b/samples/copyOldVersionOfFile.js
@@ -57,7 +57,7 @@ function main(
 
     // Optional:
     // Set a generation-match precondition to avoid potential race conditions
-    // and data corruptions. The request to upload is aborted if the object's
+    // and data corruptions. The request to copy is aborted if the object's
     // generation number does not match your precondition. For a destination
     // object that does not yet exist, set the ifGenerationMatch precondition to 0
     // If the destination object already exists in your bucket, set instead a
diff --git a/samples/deleteFile.js b/samples/deleteFile.js
@@ -43,7 +43,7 @@ function main(
 
   // Optional:
   // Set a generation-match precondition to avoid potential race conditions
-  // and data corruptions. The request to upload is aborted if the object's
+  // and data corruptions. The request to delete is aborted if the object's
   // generation number does not match your precondition. For a destination
   // object that does not yet exist, set the ifGenerationMatch precondition to 0
   // If the destination object already exists in your bucket, set instead a
diff --git a/samples/fileChangeStorageClass.js b/samples/fileChangeStorageClass.js
@@ -49,7 +49,7 @@ function main(
   async function fileChangeStorageClass() {
     // Optional:
     // Set a generation-match precondition to avoid potential race conditions
-    // and data corruptions. The request to upload is aborted if the object's
+    // and data corruptions. The request to copy is aborted if the object's
     // generation number does not match your precondition. For a destination
     // object that does not yet exist, set the ifGenerationMatch precondition to 0
     // If the destination object already exists in your bucket, set instead a
diff --git a/samples/fileSetMetadata.js b/samples/fileSetMetadata.js
@@ -22,7 +22,7 @@
 function main(
   bucketName = 'my-bucket',
   fileName = 'file.txt',
-  generationMatchPrecondition = 0
+  metagenerationMatchPrecondition = 0
 ) {
   // [START storage_set_metadata]
   // Imports the Google Cloud client library
@@ -41,11 +41,11 @@ function main(
   // const fileName = 'your-file-name';
 
   async function setFileMetadata() {
-    // Optional: set a generation-match precondition to avoid potential race
-    // conditions and data corruptions. The request to upload is aborted if the
-    // object's generation number does not match your precondition.
+    // Optional: set a meta-generation-match precondition to avoid potential race
+    // conditions and data corruptions. The request to set metadata is aborted if the
+    // object's metageneration number does not match your precondition.
     const options = {
-      ifGenerationMatch: generationMatchPrecondition,
+      ifMetagenerationMatch: metagenerationMatchPrecondition,
     };
 
     // Set file metadata.
diff --git a/samples/moveFile.js b/samples/moveFile.js
@@ -48,7 +48,7 @@ function main(
   async function moveFile() {
     // Optional:
     // Set a generation-match precondition to avoid potential race conditions
-    // and data corruptions. The request to upload is aborted if the object's
+    // and data corruptions. The request to copy is aborted if the object's
     // generation number does not match your precondition. For a destination
     // object that does not yet exist, set the ifGenerationMatch precondition to 0
     // If the destination object already exists in your bucket, set instead a
diff --git a/samples/releaseEventBasedHold.js b/samples/releaseEventBasedHold.js
@@ -23,7 +23,7 @@
 function main(
   bucketName = 'my-bucket',
   fileName = 'test.txt',
-  generationMatchPrecondition = 0
+  metagenerationMatchPrecondition = 0
 ) {
   // [START storage_release_event_based_hold]
   /**
@@ -42,11 +42,11 @@ function main(
   const storage = new Storage();
 
   async function releaseEventBasedHold() {
-    // Optional: set a generation-match precondition to avoid potential race
-    // conditions and data corruptions. The request to upload is aborted if the
-    // object's generation number does not match your precondition.
+    // Optional: set a meta-generation-match precondition to avoid potential race
+    // conditions and data corruptions. The request to set metadata is aborted if the
+    // object's metageneration number does not match your precondition.
     const options = {
-      ifGenerationMatch: generationMatchPrecondition,
+      ifMetagenerationMatch: metagenerationMatchPrecondition,
     };
 
     await storage.bucket(bucketName).file(fileName).setMetadata(
diff --git a/samples/releaseTemporaryHold.js b/samples/releaseTemporaryHold.js
@@ -23,7 +23,7 @@
 function main(
   bucketName = 'my-bucket',
   fileName = 'test.txt',
-  generationMatchPrecondition = 0
+  metagenerationMatchPrecondition = 0
 ) {
   // [START storage_release_temporary_hold]
   /**
@@ -42,11 +42,11 @@ function main(
   const storage = new Storage();
 
   async function releaseTemporaryHold() {
-    // Optional: set a generation-match precondition to avoid potential race
-    // conditions and data corruptions. The request to upload is aborted if the
-    // object's generation number does not match your precondition.
+    // Optional: set a meta-generation-match precondition to avoid potential race
+    // conditions and data corruptions. The request to set metadata is aborted if the
+    // object's metageneration number does not match your precondition.
     const options = {
-      ifGenerationMatch: generationMatchPrecondition,
+      ifMetagenerationMatch: metagenerationMatchPrecondition,
     };
 
     await storage.bucket(bucketName).file(fileName).setMetadata(
diff --git a/samples/rotateEncryptionKey.js b/samples/rotateEncryptionKey.js
@@ -58,7 +58,7 @@ function main(
       encryptionKey: Buffer.from(newKey, 'base64'),
 
       // Optional: set a generation-match precondition to avoid potential race
-      // conditions and data corruptions. The request to upload is aborted if the
+      // conditions and data corruptions. The request to copy is aborted if the
       // object's generation number does not match your precondition.
       preconditionOpts: {
         ifGenerationMatch: generationMatchPrecondition,
diff --git a/samples/setEventBasedHold.js b/samples/setEventBasedHold.js
@@ -23,7 +23,7 @@
 function main(
   bucketName = 'my-bucket',
   fileName = 'test.txt',
-  generationMatchPrecondition = 0
+  metagenerationMatchPrecondition = 0
 ) {
   // [START storage_set_event_based_hold]
   /**
@@ -42,11 +42,11 @@ function main(
   const storage = new Storage();
 
   async function setEventBasedHold() {
-    // Optional: set a generation-match precondition to avoid potential race
-    // conditions and data corruptions. The request to upload is aborted if the
-    // object's generation number does not match your precondition.
+    // Optional: set a meta-generation-match precondition to avoid potential race
+    // conditions and data corruptions. The request to set metadata is aborted if the
+    // object's metageneration number does not match your precondition.
     const options = {
-      ifGenerationMatch: generationMatchPrecondition,
+      ifMetagenerationMatch: metagenerationMatchPrecondition,
     };
 
     // Set event-based hold
diff --git a/samples/setTemporaryHold.js b/samples/setTemporaryHold.js
@@ -23,7 +23,7 @@
 function main(
   bucketName = 'my-bucket',
   fileName = 'test.txt',
-  generationMatchPrecondition = 0
+  metagenerationMatchPrecondition = 0
 ) {
   // [START storage_set_temporary_hold]
   /**
@@ -42,11 +42,11 @@ function main(
   const storage = new Storage();
 
   async function setTemporaryHold() {
-    // Optional: set a generation-match precondition to avoid potential race
-    // conditions and data corruptions. The request to upload is aborted if the
-    // object's generation number does not match your precondition.
+    // Optional: set a meta-generation-match precondition to avoid potential race
+    // conditions and data corruptions. The request to set metadata is aborted if the
+    // object's metageneration number does not match your precondition.
     const options = {
-      ifGenerationMatch: generationMatchPrecondition,
+      ifMetagenerationMatch: metagenerationMatchPrecondition,
     };
 
     await storage.bucket(bucketName).file(fileName).setMetadata(
diff --git a/samples/system-test/bucketLock.test.js b/samples/system-test/bucketLock.test.js
@@ -91,15 +91,15 @@ it('should disable default event-based hold on a bucket', () => {
 it('should set an event-based hold on a file', async () => {
   const [metadata] = await bucket.file(fileName).getMetadata();
   const output = execSync(
-    `node setEventBasedHold.js ${bucketName} ${fileName} ${metadata.generation}`
+    `node setEventBasedHold.js ${bucketName} ${fileName} ${metadata.metageneration}`
   );
   assert.match(output, new RegExp(`Event-based hold was set for ${fileName}`));
 });
 
 it('should release an event-based hold on a file', async () => {
   const [metadata] = await bucket.file(fileName).getMetadata();
   const output = execSync(
-    `node releaseEventBasedHold.js ${bucketName} ${fileName} ${metadata.generation}`
+    `node releaseEventBasedHold.js ${bucketName} ${fileName} ${metadata.metageneration}`
   );
   assert.match(
     output,
@@ -118,15 +118,15 @@ it('should remove a retention policy on a bucket', () => {
 it('should set an temporary hold on a file', async () => {
   const [metadata] = await bucket.file(fileName).getMetadata();
   const output = execSync(
-    `node setTemporaryHold.js ${bucketName} ${fileName} ${metadata.generation}`
+    `node setTemporaryHold.js ${bucketName} ${fileName} ${metadata.metageneration}`
   );
   assert.match(output, new RegExp(`Temporary hold was set for ${fileName}.`));
 });
 
 it('should release an temporary hold on a file', async () => {
   const [metadata] = await bucket.file(fileName).getMetadata();
   const output = execSync(
-    `node releaseTemporaryHold.js ${bucketName} ${fileName} ${metadata.generation}`
+    `node releaseTemporaryHold.js ${bucketName} ${fileName} ${metadata.metageneration}`
   );
   assert.match(
     output,
diff --git a/samples/system-test/files.test.js b/samples/system-test/files.test.js
@@ -432,7 +432,7 @@ describe('file', () => {
       modified: '1900-01-01',
     };
     const output = execSync(
-      `node fileSetMetadata.js ${bucketName} ${copiedFileName} ${metadata.generation} `
+      `node fileSetMetadata.js ${bucketName} ${copiedFileName} ${metadata.metageneration} `
     );
 
     assert.match(
