[Storage] Name properties on clients - Emulator support

sdk/storage/storage-blob/src/BlobClient.ts

@@ -25,12 +25,14 @@ import { newPipeline, StoragePipelineOptions, Pipeline } from "./Pipeline";
 import {
   DEFAULT_MAX_DOWNLOAD_RETRY_REQUESTS,
   URLConstants,
-  DEFAULT_BLOB_DOWNLOAD_BLOCK_BYTES
+  DEFAULT_BLOB_DOWNLOAD_BLOCK_BYTES,
+  DevelopmentConnectionString
 } from "./utils/constants";
 import {
   setURLParameter,
   extractConnectionStringParts,
-  appendToURLPath
+  appendToURLPath,
+  getValueInConnString
 } from "./utils/utils.common";
 import { readStreamToLocalFile } from "./utils/utils.node";
 import { AppendBlobClient, StorageClient, CommonOptions } from "./internal";
@@ -1595,21 +1597,39 @@ export class BlobClient extends StorageClient {
   }
 
   private getBlobAndContainerNamesFromUrl(): { blobName: string; containerName: string } {
-    //  URL may look like the following
-    // "https://myaccount.blob.core.windows.net/mycontainer/blob?sasString";
-    // "https://myaccount.blob.core.windows.net/mycontainer/blob";
-    // "https://myaccount.blob.core.windows.net/mycontainer/blob/a.txt?sasString";
-    // "https://myaccount.blob.core.windows.net/mycontainer/blob/a.txt";
-
+    let containerName;
+    let blobName;
     try {
+      //  URL may look like the following
+      // "https://myaccount.blob.core.windows.net/mycontainer/blob?sasString";
+      // "https://myaccount.blob.core.windows.net/mycontainer/blob";
+      // "https://myaccount.blob.core.windows.net/mycontainer/blob/a.txt?sasString";
+      // "https://myaccount.blob.core.windows.net/mycontainer/blob/a.txt";
+      // or an emulator URL that starts with the endpoint `http://127.0.0.1:10000/devstoreaccount1`
+
       let urlWithoutSAS = this.url.split("?")[0]; // removing the sas part of url if present
       urlWithoutSAS = urlWithoutSAS.endsWith("/") ? urlWithoutSAS.slice(0, -1) : urlWithoutSAS; // Slicing off '/' at the end if exists
 
-      const partsOfUrl = urlWithoutSAS.match("([^/]*)://([^/]*)/([^/]*)(/(.*))?");
+      // http://127.0.0.1:10000/devstoreaccount1
+      const emulatorBlobEndpoint = getValueInConnString(
+        DevelopmentConnectionString,
+        "BlobEndpoint"
+      );
+
+      if (this.url.startsWith(emulatorBlobEndpoint)) {
+        // Emulator URL starts with `http://127.0.0.1:10000/devstoreaccount1`
+        const partsOfUrl = urlWithoutSAS.match(emulatorBlobEndpoint + "/([^/]*)(/(.*))?");
+        containerName = partsOfUrl![1];
+        blobName = partsOfUrl![3];
+      } else {
+        const partsOfUrl = urlWithoutSAS.match("([^/]*)://([^/]*)/([^/]*)(/(.*))?");
+        containerName = partsOfUrl![3];
+        blobName = partsOfUrl![5];
+      }
 
       // decode the encoded blobName, containerName - to get all the special characters that might be present in them
-      const containerName = decodeURIComponent(partsOfUrl![3]);
-      let blobName = decodeURIComponent(partsOfUrl![5]);
+      containerName = decodeURIComponent(containerName);
+      blobName = decodeURIComponent(blobName);
 
       // Azure Storage Server will replace "\" with "/" in the blob names
       //   doing the same in the SDK side so that the user doesn't have to replace "\" instances in the blobName

sdk/storage/storage-blob/src/ContainerClient.ts

@@ -13,12 +13,14 @@ import { AbortSignalLike } from "@azure/abort-controller";
 import * as Models from "./generated/src/models";
 import { Container } from "./generated/src/operations";
 import { ContainerAccessConditions, Metadata } from "./models";
+import { DevelopmentConnectionString } from "./utils/constants";
 import { newPipeline, StoragePipelineOptions, Pipeline } from "./Pipeline";
 import { ETagNone } from "./utils/constants";
 import {
   appendToURLPath,
   truncatedISO8061Date,
-  extractConnectionStringParts
+  extractConnectionStringParts,
+  getValueInConnString
 } from "./utils/utils.common";
 import {
   AppendBlobClient,
@@ -1554,17 +1556,34 @@ export class ContainerClient extends StorageClient {
   }
 
   private getContainerNameFromUrl(): string {
-    //  URL may look like the following
-    // "https://myaccount.blob.core.windows.net/mycontainer?sasString";
-    // "https://myaccount.blob.core.windows.net/mycontainer";
+    let containerName;
     try {
+      //  URL may look like the following
+      // "https://myaccount.blob.core.windows.net/mycontainer?sasString";
+      // "https://myaccount.blob.core.windows.net/mycontainer";
+      // or an emulator URL that starts with the endpoint `http://127.0.0.1:10000/devstoreaccount1`
+
       let urlWithoutSAS = this.url.split("?")[0]; // removing the sas part of url if present
       urlWithoutSAS = urlWithoutSAS.endsWith("/") ? urlWithoutSAS.slice(0, -1) : urlWithoutSAS; // Slicing off '/' at the end if exists
 
-      const partsOfUrl = urlWithoutSAS.match("([^/]*)://([^/]*)/([^/]*)");
+      // http://127.0.0.1:10000/devstoreaccount1
+      const emulatorBlobEndpoint = getValueInConnString(
+        DevelopmentConnectionString,
+        "BlobEndpoint"
+      );
+
+      if (this.url.startsWith(emulatorBlobEndpoint)) {
+        // Emulator URL starts with `http://127.0.0.1:10000/devstoreaccount1`
 
-      // decode the encoded containerName - to get all the special characters that might be present in it
-      const containerName = decodeURIComponent(partsOfUrl![3]);
+        const partsOfUrl = urlWithoutSAS.match(emulatorBlobEndpoint + "/([^/]*)");
+        containerName = partsOfUrl![1];
+      } else {
+        const partsOfUrl = urlWithoutSAS.match("([^/]*)://([^/]*)/([^/]*)");
+
+        // decode the encoded containerName - to get all the special characters that might be present in it
+        containerName = partsOfUrl![3];
+      }
+      containerName = decodeURIComponent(containerName);
 
       if (!containerName) {
         throw new Error("Provided containerName is invalid.");

sdk/storage/storage-blob/src/utils/utils.common.ts

@@ -96,7 +96,7 @@ function getProxyUriFromDevConnString(connectionString: string): string {
   return proxyUri;
 }
 
-function getValueInConnString(
+export function getValueInConnString(
   connectionString: string,
   argument:
     | "BlobEndpoint"

sdk/storage/storage-blob/test/node/emulator-tests.spec.ts

@@ -51,6 +51,12 @@ describe("Emulator Tests", () => {
       b: "b"
     };
     await newClient.setMetadata(metadata);
+    assert.equal(
+      containerName,
+      newClient.containerName,
+      "Container name didn't match with the provided one."
+    );
+    assert.equal(newClient.blobName, blobName, "Blob name didn't match with the provided one.");
     const result = await newClient.getProperties();
     assert.deepStrictEqual(result.metadata, metadata);
   });
@@ -71,6 +77,12 @@ describe("Emulator Tests", () => {
       blobName
     );
 
+    assert.equal(
+      newClient.containerName,
+      containerName,
+      "Container name didn't match with the provided one."
+    );
+    assert.equal(newClient.blobName, blobName, "Blob name didn't match with the provided one.");
     const body: string = "randomstring";
     await newClient.upload(body, body.length);
     const result = await newClient.download(0);
@@ -86,6 +98,11 @@ describe("Emulator Tests", () => {
 
     const result = await newClient.getProperties();
 
+    assert.equal(
+      newClient.containerName,
+      containerName,
+      "Container name didn't match with the provided one."
+    );
     assert.ok(result.eTag!.length > 0);
     assert.ok(result.lastModified);
     assert.ok(!result.leaseDuration);
@@ -102,6 +119,11 @@ describe("Emulator Tests", () => {
 
     const result = await newClient.getProperties();
 
+    assert.equal(
+      newClient.containerName,
+      containerName,
+      "Container name didn't match with the provided one."
+    );
     assert.ok(result.eTag!.length > 0);
     assert.ok(result.lastModified);
     assert.ok(result.requestId);
@@ -114,6 +136,12 @@ describe("Emulator Tests", () => {
       blobName
     );
 
+    assert.equal(
+      newClient.containerName,
+      containerName,
+      "Container name didn't match with the provided one."
+    );
+    assert.equal(newClient.blobName, blobName, "Blob name didn't match with the provided one.");
     await newClient.create(512);
     const result = await newClient.download(0);
     assert.deepStrictEqual(await bodyToString(result, 512), "\u0000".repeat(512));

sdk/storage/storage-queue/src/QueueClient.ts

@@ -12,11 +12,13 @@ import {
   appendToURLPath,
   extractConnectionStringParts,
   truncatedISO8061Date,
+  getValueInConnString,
   getStorageClientContext
 } from "./utils/utils.common";
 import { SharedKeyCredential } from "./credentials/SharedKeyCredential";
 import { AnonymousCredential } from "./credentials/AnonymousCredential";
 import { createSpan } from "./utils/tracing";
+import { DevelopmentConnectionString } from "./utils/constants";
 import { Metadata } from "./models";
 
 /**
@@ -979,14 +981,29 @@ export class QueueClient extends StorageClient {
   }
 
   private getQueueNameFromUrl(): string {
-    //  URL may look like the following
-    // "https://myaccount.queue.core.windows.net/myqueue?sasString".
-    // "https://myaccount.queue.core.windows.net/myqueue".
+    let queueName;
     try {
+      //  URL may look like the following
+      // "https://myaccount.queue.core.windows.net/myqueue?sasString".
+      // "https://myaccount.queue.core.windows.net/myqueue".
+      // or an emulator URL that starts with the endpoint `http://127.0.0.1:10001/devstoreaccount1`
+
       let urlWithoutSAS = this.url.split("?")[0]; // removing the sas part of url if present
       urlWithoutSAS = urlWithoutSAS.endsWith("/") ? urlWithoutSAS.slice(0, -1) : urlWithoutSAS; // Slicing off '/' at the end if exists
 
-      const queueName = urlWithoutSAS.match("([^/]*)://([^/]*)/([^/]*)")![3];
+      // http://127.0.0.1:10001/devstoreaccount1
+      const emulatorQueueEndpoint = getValueInConnString(
+        DevelopmentConnectionString,
+        "QueueEndpoint"
+      );
+
+      if (this.url.startsWith(emulatorQueueEndpoint)) {
+        // Emulator URL starts with `http://127.0.0.1:10001/devstoreaccount1`
+        queueName = urlWithoutSAS.match(emulatorQueueEndpoint + "/([^/]*)")![1];
+      } else {
+        queueName = urlWithoutSAS.match("([^/]*)://([^/]*)/([^/]*)")![3];
+      }
+
       if (!queueName) {
         throw new Error("Provided queueName is invalid.");
       } else {

sdk/storage/storage-queue/src/utils/utils.common.ts

@@ -141,7 +141,7 @@ function getProxyUriFromDevConnString(connectionString: string): string {
   return proxyUri;
 }
 
-function getValueInConnString(
+export function getValueInConnString(
   connectionString: string,
   argument:
     | "QueueEndpoint"

sdk/storage/storage-queue/test/node/emulator-tests.spec.ts

@@ -62,6 +62,7 @@ describe("Emulator Tests", () => {
 
     const result = await newClient.getProperties();
 
+    assert.equal(newClient.queueName, queueName, "Queue name didn't match with the provided one.");
     assert.ok(result.requestId);
     assert.ok(result.version);
     assert.ok(result.date);