refactor!: mark bucket.setLabels and associated interfaces as depreca…

…ted (#2214) * refactor!: mark bucket.setLabels and associated interfaces as deprecated * update addBucketLabel to use setMetadata * mark getLabels / deleteLabels deprecated, update samples
googleapis · Jul 24, 2023 · 17ec0ad · 17ec0ad
1 parent 2aaa945
commit 17ec0ad
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 18 deletions.
diff --git a/samples/addBucketLabel.js b/samples/addBucketLabel.js
@@ -48,7 +48,7 @@ function main(
   };
 
   async function addBucketLabel() {
-    await storage.bucket(bucketName).setLabels(labels);
+    await storage.bucket(bucketName).setMetadata({labels});
     console.log(`Added label to bucket ${bucketName}`);
   }
 

diff --git a/samples/removeBucketLabel.js b/samples/removeBucketLabel.js
@@ -37,7 +37,12 @@ function main(bucketName = 'my-bucket', labelKey = ['label1', 'label2']) {
   const storage = new Storage();
 
   async function removeBucketLabel() {
-    await storage.bucket(bucketName).deleteLabels(labelKey);
+    const labels = {};
+    // To remove a label set the value of the key to null.
+    for (const curLabel of labelKey) {
+      labels[curLabel] = null;
+    }
+    await storage.bucket(bucketName).setMetadata({labels});
     console.log(`Removed labels from bucket ${bucketName}`);
   }
 

diff --git a/src/bucket.ts b/src/bucket.ts
@@ -2075,15 +2075,18 @@ class Bucket extends ServiceObject {
     callback: DeleteLabelsCallback
   ): void;
   /**
+   * @deprecated
    * @typedef {array} DeleteLabelsResponse
    * @property {object} 0 The full API response.
    */
   /**
+   * @deprecated
    * @callback DeleteLabelsCallback
    * @param {?Error} err Request error, if any.
    * @param {object} metadata Bucket's metadata.
    */
   /**
+   * @deprecated Use setMetadata directly
    * Delete one or more labels from this bucket.
    *
    * @param {string|string[]} [labels] The labels to delete. If no labels are
@@ -2734,20 +2737,24 @@ class Bucket extends ServiceObject {
   getLabels(callback: GetLabelsCallback): void;
   getLabels(options: GetLabelsOptions, callback: GetLabelsCallback): void;
   /**
+   * @deprecated
    * @typedef {object} GetLabelsOptions Configuration options for Bucket#getLabels().
    * @param {string} [userProject] The ID of the project which will be
    *     billed for the request.
    */
   /**
+   * @deprecated
    * @typedef {array} GetLabelsResponse
    * @property {object} 0 Object of labels currently set on this bucket.
    */
   /**
+   * @deprecated
    * @callback GetLabelsCallback
    * @param {?Error} err Request error, if any.
    * @param {object} labels Object of labels currently set on this bucket.
    */
   /**
+   * @deprecated Use getMetadata directly.
    * Get the labels currently set on this bucket.
    *
    * @param {object} [options] Configuration options.
@@ -3519,20 +3526,24 @@ class Bucket extends ServiceObject {
     callback: SetLabelsCallback
   ): void;
   /**
+   * @deprecated
    * @typedef {array} SetLabelsResponse
    * @property {object} 0 The bucket metadata.
    */
   /**
+   * @deprecated
    * @callback SetLabelsCallback
    * @param {?Error} err Request error, if any.
    * @param {object} metadata The bucket metadata.
    */
   /**
+   * @deprecated
    * @typedef {object} SetLabelsOptions Configuration options for Bucket#setLabels().
    * @property {string} [userProject] The ID of the project which will be
    *     billed for the request.
    */
   /**
+   * @deprecated Use setMetadata directly.
    * Set labels on the bucket.
    *
    * This makes an underlying call to {@link Bucket#setMetadata}, which

diff --git a/system-test/storage.ts b/system-test/storage.ts
@@ -1109,7 +1109,7 @@ describe('storage', () => {
       });
 
       it('should be available from updating a bucket', async () => {
-        await bucket.setLabels({a: 'b'});
+        await bucket.setMetadata({labels: {a: 'b'}});
         assert(types.includes(bucket.metadata.locationType));
       });
     });
@@ -1121,23 +1121,33 @@ describe('storage', () => {
       };
 
       beforeEach(async () => {
-        await bucket.deleteLabels();
+        const [metadata] = await bucket.getMetadata();
+        const labels: {[index: string]: string | null} = {};
+        if (metadata.labels) {
+          for (const curLabel of Object.keys(metadata.labels)) {
+            labels[curLabel] = null;
+          }
+          await bucket.setMetadata({labels});
+        }
       });
 
       it('should set labels', async () => {
-        await bucket.setLabels(LABELS);
-        const [labels] = await bucket.getLabels();
-        assert.deepStrictEqual(labels, LABELS);
+        await bucket.setMetadata({labels: LABELS});
+        const [metadata] = await bucket.getMetadata();
+        assert.deepStrictEqual(metadata.labels, LABELS);
       });
 
       it('should update labels', async () => {
         const newLabels = {
           siblinglabel: 'labelvalue',
         };
-        await bucket.setLabels(LABELS);
-        await bucket.setLabels(newLabels);
-        const [labels] = await bucket.getLabels();
-        assert.deepStrictEqual(labels, Object.assign({}, LABELS, newLabels));
+        await bucket.setMetadata({labels: LABELS});
+        await bucket.setMetadata({labels: newLabels});
+        const [metadata] = await bucket.getMetadata();
+        assert.deepStrictEqual(
+          metadata.labels,
+          Object.assign({}, LABELS, newLabels)
+        );
       });
 
       it('should delete a single label', async () => {
@@ -1146,19 +1156,29 @@ describe('storage', () => {
         }
 
         const labelKeyToDelete = Object.keys(LABELS)[0];
-        await bucket.setLabels(LABELS);
-        await bucket.deleteLabels(labelKeyToDelete);
-        const [labels] = await bucket.getLabels();
+        await bucket.setMetadata({labels: LABELS});
+        const labelsToDelete = {
+          [labelKeyToDelete]: null,
+        };
+        await bucket.setMetadata({labels: labelsToDelete});
+        const [metadata] = await bucket.getMetadata();
         const expectedLabels = Object.assign({}, LABELS);
         delete (expectedLabels as {[index: string]: {}})[labelKeyToDelete];
 
-        assert.deepStrictEqual(labels, expectedLabels);
+        assert.deepStrictEqual(metadata.labels, expectedLabels);
       });
 
       it('should delete all labels', async () => {
-        await bucket.deleteLabels();
-        const [labels] = await bucket.getLabels();
-        assert.deepStrictEqual(labels, {});
+        let [metadata] = await bucket.getMetadata();
+        if (metadata.labels) {
+          const labels: {[index: string]: string | null} = {};
+          for (const curLabel of Object.keys(metadata.labels)) {
+            labels[curLabel] = null;
+          }
+          await bucket.setMetadata({labels});
+        }
+        [metadata] = await bucket.getMetadata();
+        assert.deepStrictEqual(metadata.labels, undefined);
       });
     });
   });