Fixed issue of list container contains metadata even request doesn't …

…have include=metadata (issue #2382) (#2389)

* Fixed issue of list container contains metadata even request doesn't have include=metadata (issue #2382)

* Fix a test issue

ChangeLog.md

@@ -9,6 +9,7 @@ Blob:
 - Fixed issue of setting blob tag should not update Blob Etag and LastModified. (issue #2327)
 - Fix HTTP header parsing of `SubmitBatch()`. If a HTTP header has HTTP header delimiter (`:`) in its value, `SubmitBatch()` returns "400 One of the request inputs is not valid". For example, if `user-agent` header is `azsdk-cpp-storage-blobs/12.10.0-beta.1 (Darwin 23.1.0 arm64 Darwin Kernel Version 23.1.0: Mon Oct  9 21:28:12 PDT 2023; root:xnu-10002.41.9~6/RELEASE_ARM64_T8103)`, all `SubmitBatch()` requests are failed.
 - Fixed issue of blob copying succeed without 'r' permission in source blob's SAS token credential.
+- Fixed issue of list container contains metadata even request doesn't have include=metadata (issue #2382)
 
 Table:
 

src/blob/handlers/ServiceHandler.ts

@@ -319,6 +319,21 @@ export default class ServiceHandler extends BaseHandler
       marker
     );
 
+    // Only the query parameter "include" contains the value "metadata" can the result present the metadata.
+    let includeMetadata = false;
+    if (options.include) {
+      for (const item of options.include) {
+        if (item.toLowerCase() === "metadata") {
+          includeMetadata = true;
+          break;
+        }
+      }
+    }
+    if (!includeMetadata) {
+      for (const container of containers[0]) {
+        container.metadata = undefined;
+      }
+    }
     // TODO: Need update list out container lease properties with ContainerHandler.updateLeaseAttributes()
     const serviceEndpoint = `${request.getEndpoint()}/${accountName}`;
     const res: Models.ServiceListContainersSegmentResponse = {

src/queue/handlers/ServiceHandler.ts

@@ -235,7 +235,7 @@ export default class ServiceHandler extends BaseHandler
     let includeMetadata = false;
     if (options.include) {
       for (const item of options.include) {
-        if (item === "metadata") {
+        if (item.toLowerCase() === "metadata") {
           includeMetadata = true;
           break;
         }

tests/blob/apis/service.test.ts

@@ -411,6 +411,32 @@ describe("ServiceAPIs", () => {
     await containerClient1.delete();
     await containerClient2.delete();
   });
+
+  // fix issue 2382
+  it("ListContainers without include metadata should not return contaienr metadata. @loki @sql", async () => {
+    const containerNamePrefix = getUniqueName("container");
+    const containerName1 = `${containerNamePrefix}x1`;
+    const containerName2 = `${containerNamePrefix}x2`;
+    const containerClient1 = serviceClient.getContainerClient(containerName1);
+    const containerClient2 = serviceClient.getContainerClient(containerName2);
+    await containerClient1.create({ metadata: { key: "val" } });
+    await containerClient2.create({ metadata: { key: "val" } });
+
+    const result1 = (
+      await serviceClient
+        .listContainers({
+          prefix: containerNamePrefix
+        })
+        .byPage()
+        .next()
+    ).value;
+
+    assert.equal(result1.containerItems!.length, 2);
+    assert.ok(result1.containerItems![0].name.startsWith(containerNamePrefix));
+    assert.ok(result1.containerItems![1].name.startsWith(containerNamePrefix));
+    assert.equal(result1.containerItems![0].metadata, undefined);
+    assert.equal(result1.containerItems![1].metadata, undefined);
+  });
 
   it("get Account info @loki @sql", async () => {
     const result = await serviceClient.getAccountInfo();