[storage] add fromConnectString to DataLakeServiceClient (Azure#13420)

* add fromConnectString to DataLakeServiceClient

* fix Azure#13395 readme issue

* changelog

Author: ljian3377

sdk/storage/storage-file-datalake/CHANGELOG.md

@@ -5,6 +5,7 @@
 - Fixed a bug where `generateDataLakeSASQueryParameters()` won't correctly set the resource type if `DataLakeSASSignatureValues.permissions` is not specified. Fixed issue [13223](https://github.com/Azure/azure-sdk-for-js/issues/13223).
 - Fixed a compile failure due to "Can't resolve 'crypto'" in Angular. [Issue #13267](https://github.com/Azure/azure-sdk-for-js/issues/13267).
 - The `"Unclosed root tag"` XML parser error is now retriable. [PR #13076](https://github.com/Azure/azure-sdk-for-js/pull/13076).
+- Added `fromConnectionString` to `DataLakeServiceClient` to support construction from a connection string. Fixed bug [13396](https://github.com/Azure/azure-sdk-for-js/issues/13396).
 
 ## 12.3.0 (2021-01-12)
 

sdk/storage/storage-file-datalake/recordings/browsers/datalakeserviceclient/recording_can_be_created_from_sasconnstring.json

@@ -323,6 +323,7 @@ export interface DataLakeSASSignatureValues {
 export class DataLakeServiceClient extends StorageClient {
     constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions);
     constructor(url: string, pipeline: Pipeline);
+    static fromConnectionString(connectionString: string, options?: StoragePipelineOptions): DataLakeServiceClient;
     generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string;
     getFileSystemClient(fileSystemName: string): DataLakeFileSystemClient;
     getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions): Promise<ServiceGetUserDelegationKeyResponse>;

sdk/storage/storage-file-datalake/recordings/node/datalakeserviceclient/recording_can_be_created_from_accountconnstring.js

@@ -3,7 +3,7 @@
 
 import "@azure/core-paging";
 
-import { TokenCredential } from "@azure/core-http";
+import { getDefaultProxySettings, isNode, TokenCredential } from "@azure/core-http";
 import { PagedAsyncIterableIterator } from "@azure/core-paging";
 import { BlobServiceClient } from "@azure/storage-blob";
 
@@ -18,9 +18,13 @@ import {
 } from "./models";
 import { Pipeline, StoragePipelineOptions, newPipeline } from "./Pipeline";
 import { StorageClient } from "./StorageClient";
-import { appendToURLPath, appendToURLQuery } from "./utils/utils.common";
+import {
+  appendToURLPath,
+  appendToURLQuery,
+  extractConnectionStringParts
+} from "./utils/utils.common";
 import { createSpan } from "./utils/tracing";
-import { toFileSystemPagedAsyncIterableIterator } from "./transforms";
+import { toDfsEndpointUrl, toFileSystemPagedAsyncIterableIterator } from "./transforms";
 import { ServiceGetUserDelegationKeyOptions, ServiceGetUserDelegationKeyResponse } from "./models";
 import { CanonicalCode } from "@opentelemetry/api";
 import { AccountSASPermissions } from "./sas/AccountSASPermissions";
@@ -48,6 +52,47 @@ export class DataLakeServiceClient extends StorageClient {
    */
   private blobServiceClient: BlobServiceClient;
 
+  /**
+   *
+   * Creates an instance of DataLakeServiceClient from connection string.
+   *
+   * @param {string} connectionString Account connection string or a SAS connection string of an Azure storage account.
+   *                                  [ Note - Account connection string can only be used in NODE.JS runtime. ]
+   *                                  Account connection string example -
+   *                                  `DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net`
+   *                                  SAS connection string example -
+   *                                  `BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString`
+   * @param {StoragePipelineOptions} [options] Optional. Options to configure the HTTP pipeline.
+   * @memberof DataLakeServiceClient
+   */
+  public static fromConnectionString(connectionString: string, options?: StoragePipelineOptions) {
+    options = options || {};
+    const extractedCreds = extractConnectionStringParts(connectionString);
+    if (extractedCreds.kind === "AccountConnString") {
+      if (isNode) {
+        const sharedKeyCredential = new StorageSharedKeyCredential(
+          extractedCreds.accountName!,
+          extractedCreds.accountKey
+        );
+        options.proxyOptions = getDefaultProxySettings(extractedCreds.proxyUri);
+        const pipeline = newPipeline(sharedKeyCredential, options);
+        return new DataLakeServiceClient(toDfsEndpointUrl(extractedCreds.url), pipeline);
+      } else {
+        throw new Error("Account connection string is only supported in Node.js environment");
+      }
+    } else if (extractedCreds.kind === "SASConnString") {
+      const pipeline = newPipeline(new AnonymousCredential(), options);
+      return new DataLakeServiceClient(
+        toDfsEndpointUrl(extractedCreds.url) + "?" + extractedCreds.accountSas,
+        pipeline
+      );
+    } else {
+      throw new Error(
+        "Connection string must be either an Account connection string or a SAS connection string"
+      );
+    }
+  }
+
   /**
    * Creates an instance of DataLakeServiceClient from url.
    *

sdk/storage/storage-file-datalake/recordings/node/datalakeserviceclient/recording_can_be_created_from_sasconnstring.js

@@ -0,0 +1,35 @@
+import { record, Recorder } from "@azure/test-utils-recorder";
+import * as assert from "assert";
+import * as dotenv from "dotenv";
+
+import { DataLakeServiceClient } from "../../src";
+import { recorderEnvSetup, getConnectionStringFromEnvironment } from "../utils";
+
+dotenv.config();
+
+describe("DataLakeServiceClient", () => {
+  let recorder: Recorder;
+
+  beforeEach(async function() {
+    recorder = record(this, recorderEnvSetup);
+  });
+
+  afterEach(async function() {
+    await recorder.stop();
+  });
+
+  it("can be created from AccountConnString", async () => {
+    const newClient = DataLakeServiceClient.fromConnectionString(
+      getConnectionStringFromEnvironment(),
+      {
+        retryOptions: {
+          maxTries: 1
+        }
+      }
+    );
+
+    const listIter = newClient.listFileSystems();
+    await listIter.next();
+    assert.ok(newClient.url.includes("dfs"));
+  });
+});

sdk/storage/storage-file-datalake/review/storage-file-datalake.api.md

@@ -3,7 +3,12 @@ import * as assert from "assert";
 import * as dotenv from "dotenv";
 
 import { DataLakeServiceClient, ServiceListFileSystemsSegmentResponse } from "../src";
-import { getDataLakeServiceClient, getTokenDataLakeServiceClient, recorderEnvSetup } from "./utils";
+import {
+  getDataLakeServiceClient,
+  getSASConnectionStringFromEnvironment,
+  getTokenDataLakeServiceClient,
+  recorderEnvSetup
+} from "./utils";
 
 dotenv.config();
 
@@ -346,4 +351,19 @@ describe("DataLakeServiceClient", () => {
     assert.notDeepStrictEqual(response.signedObjectId, undefined);
     assert.notDeepStrictEqual(response.signedExpiresOn, undefined);
   });
+
+  it("can be created from SASConnString", async () => {
+    const newClient = DataLakeServiceClient.fromConnectionString(
+      getSASConnectionStringFromEnvironment(),
+      {
+        retryOptions: {
+          maxTries: 1
+        }
+      }
+    );
+
+    const listIter = newClient.listFileSystems();
+    await listIter.next();
+    assert.ok(newClient.url.includes("dfs"));
+  });
 });

sdk/storage/storage-file-datalake/src/DataLakeServiceClient.ts

@@ -171,3 +171,8 @@ export function getBrowserFile(name: string, size: number): File {
   file.name = name;
   return file;
 }
+
+export function getSASConnectionStringFromEnvironment(): string {
+  const env = (window as any).__env__;
+  return `BlobEndpoint=https://${env.DFS_ACCOUNT_NAME}.blob.core.windows.net/;QueueEndpoint=https://${env.DFS_ACCOUNT_NAME}.queue.core.windows.net/;FileEndpoint=https://${env.DFS_ACCOUNT_NAME}.file.core.windows.net/;TableEndpoint=https://${env.DFS_ACCOUNT_NAME}.table.core.windows.net/;SharedAccessSignature=${env.DFS_ACCOUNT_SAS}`;
+}

sdk/storage/storage-file-datalake/test/node/serviceclient.spec.ts

@@ -11,10 +11,15 @@ import { DataLakeServiceClient } from "../../src/DataLakeServiceClient";
 import { newPipeline, StoragePipelineOptions } from "../../src/Pipeline";
 import { getUniqueName, SimpleTokenCredential } from "./testutils.common";
 import {
+  AccountSASPermissions,
+  AccountSASResourceTypes,
+  AccountSASServices,
   DataLakeFileSystemClient,
   DataLakeSASSignatureValues,
+  generateAccountSASQueryParameters,
   generateDataLakeSASQueryParameters
 } from "../../src";
+import { extractConnectionStringParts } from "../../src/utils/utils.common";
 
 dotenv.config();
 
@@ -240,3 +245,43 @@ export async function createRandomLocalFile(
     ws.on("error", reject);
   });
 }
+
+export function getConnectionStringFromEnvironment(accountType: string = "DFS_"): string {
+  const connectionStringEnvVar = `${accountType}STORAGE_CONNECTION_STRING`;
+  const connectionString = process.env[connectionStringEnvVar];
+
+  if (!connectionString) {
+    throw new Error(`${connectionStringEnvVar} environment variables not specified.`);
+  }
+
+  return connectionString;
+}
+
+export function getSASConnectionStringFromEnvironment(): string {
+  const now = new Date();
+  now.setMinutes(now.getMinutes() - 5); // Skip clock skew with server
+
+  const tmr = new Date();
+  tmr.setDate(tmr.getDate() + 1);
+
+  const sharedKeyCredential = getGenericCredential("DFS_");
+
+  const sas = generateAccountSASQueryParameters(
+    {
+      expiresOn: tmr,
+      permissions: AccountSASPermissions.parse("rwdlacup"),
+      resourceTypes: AccountSASResourceTypes.parse("sco").toString(),
+      services: AccountSASServices.parse("btqf").toString()
+    },
+    sharedKeyCredential as StorageSharedKeyCredential
+  ).toString();
+
+  const blobEndpoint = extractConnectionStringParts(getConnectionStringFromEnvironment()).url;
+  return `BlobEndpoint=${blobEndpoint}/;QueueEndpoint=${blobEndpoint.replace(
+    ".blob.",
+    ".queue."
+  )}/;FileEndpoint=${blobEndpoint.replace(
+    ".queue.",
+    ".file."
+  )}/;TableEndpoint=${blobEndpoint.replace(".queue.", ".table.")}/;SharedAccessSignature=${sas}`;
+}