[storage] improve datalake and changefeed samples (Azure#11164)

* improve datalake and changefeed samples * fix samples to work with dev-tool Co-authored-by: Lin Jian <ljian3377@gmail.com>
AzureSDKAutomation · openapi-sdkautomation · Aug 28, 2020 · Aug 28, 2020 · Aug 28, 2020 · Aug 29, 2020
commit 58e908a600f03f6988a22389d91a34475f2af3d1
diff --git a/sdk/storage/storage-blob-changefeed/samples/javascript/README.md b/sdk/storage/storage-blob-changefeed/samples/javascript/README.md
@@ -10,7 +10,7 @@ urlFragment: storage-blob-changefeed-javascript
 
 # Azure Storage Blob client library samples for JavaScript
 
-These sample programs show how to use the JavaScript client libraries for Azure Storage Blobs in some common scenarios.
+These sample programs show how to use the JavaScript client libraries for Azure Storage Blobs Change Feed in some common scenarios.
 
 | **File Name**       | **Description**                                                             |
 | ------------------- | --------------------------------------------------------------------------- |

diff --git a/sdk/storage/storage-blob-changefeed/samples/javascript/package.json b/sdk/storage/storage-blob-changefeed/samples/javascript/package.json
@@ -0,0 +1,36 @@
+{
+  "name": "azure-storage-blob-changefeed-samples-js",
+  "private": true,
+  "version": "0.1.0",
+  "description": "Azure Storage Blob Change Feed client library samples for JavaScript",
+  "engine": {
+    "node": ">=8.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Azure/azure-sdk-for-js.git"
+  },
+  "keywords": [
+    "Azure",
+    "Storage",
+    "Blob",
+    "Change Feed",
+    "Node.js",
+    "JavaScript"
+  ],
+  "author": "Microsoft Corporation",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Azure/azure-sdk-for-js/issues"
+  },
+  "homepage": "https://github.com/Azure/azure-sdk-for-js#readme",
+  "sideEffects": false,
+  "dependencies": {
+    "@azure/storage-blob": "latest",
+    "@azure/storage-blob-changefeed": "latest",
+    "dotenv": "^8.2.0"
+  },
+  "devDependencies": {
+    "rimraf": "^3.0.0"
+  }
+}
diff --git a/sdk/storage/storage-blob-changefeed/samples/javascript/sample.env b/sdk/storage/storage-blob-changefeed/samples/javascript/sample.env
@@ -0,0 +1,3 @@
+# Used in most samples. Retrieve these values from a storage account in the Azure Portal.
+ACCOUNT_NAME=<storage-account-name>
+ACCOUNT_KEY=<storage-account-key>
diff --git a/sdk/storage/storage-blob-changefeed/samples/typescript/sample.env b/sdk/storage/storage-blob-changefeed/samples/typescript/sample.env
@@ -1,20 +1,3 @@
 # Used in most samples. Retrieve these values from a storage account in the Azure Portal.
 ACCOUNT_NAME=<storage-account-name>
 ACCOUNT_KEY=<storage-account-key>
-
-# Used for withConnString
-STORAGE_CONNECTION_STRING=<storage-account-connection-string>
-
-# Used for the advanced and anonymousCred tests. Create a SAS token for a storage account in the Azure Portal.
-ACCOUNT_SAS=<shared-access-signature>
-
-# Used to authenticate using Azure AD as a service principal for role-based authentication.
-#
-# See the documentation for `EnvironmentCredential` at the following link:
-# https://docs.microsoft.com/javascript/api/@azure/identity/environmentcredential
-AZURE_TENANT_ID=<AD tenant id or name>
-AZURE_CLIENT_ID=<ID of the user/service principal to authenticate as>
-AZURE_CLIENT_SECRET=<client secret used to authenticate to Azure AD>
-
-# To run the proxyAuth sample, set up an HTTP proxy and enter your information:
-# HTTP_PROXY=http://localhost:3128
diff --git a/sdk/storage/storage-blob/samples/README.md b/sdk/storage/storage-blob/samples/README.md
@@ -15,10 +15,6 @@ npm init -y
 npm install @azure/storage-blob
 ```
 
-### Running Samples
-
-Also, change `"../.."` to `"@azure/storage-blob"` in the samples in order to import the published package instead of using source code.
-
 ## Get account credentials of your storage account
 
 - In the [Azure Portal](https://portal.azure.com), go to **Dashboard > Storage > _your-storage-account_**.

diff --git a/sdk/storage/storage-blob/samples/javascript/package.json b/sdk/storage/storage-blob/samples/javascript/package.json
@@ -2,7 +2,7 @@
   "name": "azure-storage-blob-samples-js",
   "private": true,
   "version": "0.1.0",
-  "description": "Azure Storage Blob client library samples for TypeScript",
+  "description": "Azure Storage Blob client library samples for JavaScript",
   "engine": {
     "node": ">=8.0.0"
   },

diff --git a/sdk/storage/storage-file-datalake/package.json b/sdk/storage/storage-file-datalake/package.json
@@ -31,15 +31,16 @@
     "build:autorest": "autorest ./swagger/README.md --typescript --use=@microsoft.azure/autorest.typescript@5.0.1",
     "build:es6": "tsc -p tsconfig.json",
     "build:nodebrowser": "rollup -c 2>&1",
-    "build:js-samples": "npm run clean && npm run build:es6 && cross-env ONLY_NODE=true rollup -c 2>&1",
-    "build:ts-samples": "npm run clean && cd samples && tsc -p . ",
+    "build:samples": "npm run clean && npm run build:es6 && cross-env ONLY_NODE=true rollup -c 2>&1 && npm run build:prep-samples",
+    "build:prep-samples": "dev-tool samples prep && cd dist-samples && tsc",
     "build:test": "npm run build:es6 && rollup -c rollup.test.config.js 2>&1",
     "build:types": "downlevel-dts typings/latest typings/3.1",
     "build": "npm run build:es6 && npm run build:nodebrowser && api-extractor run --local && npm run build:types",
     "check-format": "prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
     "clean": "rimraf dist dist-esm dist-test typings temp dist-browser/*.js* dist-browser/*.zip statistics.html coverage coverage-browser .nyc_output *.tgz *.log test*.xml TEST*.xml",
+    "clean:samples": "rimraf samples/javascript/node_modules samples/typescript/node_modules samples/typescript/dist samples/typescript/package-lock.json samples/javascript/package-lock.json",
     "extract-api": "tsc -p . && api-extractor run --local",
-    "execute:samples": "echo skipped until samples automation ready",
+    "execute:samples": "npm run build:samples && dev-tool samples run dist-samples/javascript dist-samples/typescript/dist/storage-file-datalake/dist-samples/typescript/src/",
     "format": "prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
     "integration-test:browser": "karma start --single-run",
     "integration-test:node": "nyc mocha -r esm --require source-map-support/register --reporter ../../../common/tools/mocha-multi-reporter.js --full-trace -t 120000  dist-esm/storage-file-datalake/test/*.spec.js dist-esm/storage-file-datalake/test/node/*.spec.js",
@@ -106,6 +107,7 @@
     "tslib": "^2.0.0"
   },
   "devDependencies": {
+    "@azure/dev-tool": "^1.0.0",
     "@azure/identity": "^1.1.0",
     "@azure/test-utils-recorder": "^1.0.0",
     "@microsoft/api-extractor": "7.7.11",

diff --git a/sdk/storage/storage-file-datalake/samples/README.md b/sdk/storage/storage-file-datalake/samples/README.md
@@ -15,10 +15,6 @@ npm init -y
 npm install @azure/storage-file-datalake
 ```
 
-### Running Samples
-
-Also, change `"../.."` to `"@azure/storage-file-datalake"` in the samples in order to import the published package instead of using source code.
-
 ## Get account credentials of your storage account
 
 - In the [Azure Portal](https://portal.azure.com), go to **Dashboard > Storage > _your-storage-account_**.

diff --git a/sdk/storage/storage-file-datalake/samples/javascript/README.md b/sdk/storage/storage-file-datalake/samples/javascript/README.md
@@ -0,0 +1,56 @@
+---
+page_type: sample
+languages:
+  - javascript
+products:
+  - azure
+  - azure-storage
+urlFragment: storage-file-datalake-javascript
+---
+
+# Azure Data Lake Storage client library samples for JavaScript
+
+These sample programs show how to use the JavaScript client libraries for Azure Data Lake Storage in some common scenarios.
+
+| **File Name**     | **Description**                                                                                                                 |
+| ----------------- | ------------------------------------------------------------------------------------------------------------------------------- |
+| [basic.js][basic] | authenticate with the service using an account name & key; create and delete filesystem; create and download a file, list paths |
+
+## Prerequisites
+
+The sample are compatible with Node.js >= 8.0.0, except for the samples that use the async `for await` syntax, which require Node.js >= 10.0.0.
+
+You need [an Azure subscription][freesub] and [an Azure Storage account][azstorage] to run these sample programs. Samples retrieve credentials to access the storage account from environment variables. Alternatively, edit the source code to include the appropriate credentials. See each individual sample for details on which environment variables/credentials it requires to function.
+
+## Setup
+
+To run the samples using the published version of the package:
+
+1. Install the dependencies using `npm`:
+
+```bash
+npm install
+```
+
+2. Edit the file `sample.env`, adding the correct credentials to access the Azure service and run the samples. Then rename the file from `sample.env` to just `.env`. The sample programs will read this file automatically.
+
+3. Run whichever samples you like:
+
+```bash
+node basic.js
+```
+
+Alternatively, run a single sample with the correct environment variables set (step 3 is not required if you do this), for example (cross-platform):
+
+```bash
+npx cross-env ACCOUNT_NAME="<account name>" ACCOUNT_KEY="<account key>" node basic.js
+```
+
+## Next Steps
+
+Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
+
+[basic]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/storage/storage-file-datalake/samples/javascript/basic.js
+[apiref]: https://docs.microsoft.com/javascript/api/@azure/storage-file-datalake
+[azstorage]: https://docs.microsoft.com/azure/storage/common/storage-account-overview
+[freesub]: https://azure.microsoft.com/free/
diff --git a/sdk/storage/storage-file-datalake/samples/javascript/basic.js b/sdk/storage/storage-file-datalake/samples/javascript/basic.js
@@ -2,7 +2,10 @@
  Setup: Enter your storage account name and shared key in main()
 */
 
-const { DataLakeServiceClient, StorageSharedKeyCredential } = require("../.."); // Change to "@azure/storage-file-datalake" in your package
+const { DataLakeServiceClient, StorageSharedKeyCredential } = require("@azure/storage-file-datalake");
+
+// Load the .env file if it exists
+require("dotenv").config();
 
 async function main() {
   // Enter your storage account name and shared key
@@ -95,11 +98,6 @@ async function streamToBuffer(readableStream) {
   });
 }
 
-// An async method returns a Promise object, which is compatible with then().catch() coding style.
-main()
-  .then(() => {
-    console.log("Successfully executed sample.");
-  })
-  .catch((err) => {
-    console.log(err.message);
-  });
+main().catch((err) => {
+  console.error("Error running sample:", err.message);
+});
diff --git a/sdk/storage/storage-file-datalake/samples/javascript/package.json b/sdk/storage/storage-file-datalake/samples/javascript/package.json
@@ -0,0 +1,36 @@
+{
+  "name": "azure-storage-file-datalake-samples-js",
+  "private": true,
+  "version": "0.1.0",
+  "description": "Azure Data Lake Storage client library samples for JavaScript",
+  "engine": {
+    "node": ">=8.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Azure/azure-sdk-for-js.git"
+  },
+  "keywords": [
+    "Azure",
+    "Storage",
+    "ADLS",
+    "DFS",
+    "datalake",
+    "Node.js",
+    "JavaScript"
+  ],
+  "author": "Microsoft Corporation",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Azure/azure-sdk-for-js/issues"
+  },
+  "homepage": "https://github.com/Azure/azure-sdk-for-js#readme",
+  "sideEffects": false,
+  "dependencies": {
+    "@azure/storage-file-datalake": "latest",
+    "dotenv": "^8.2.0"
+  },
+  "devDependencies": {
+    "rimraf": "^3.0.0"
+  }
+}
diff --git a/sdk/storage/storage-file-datalake/samples/javascript/sample.env b/sdk/storage/storage-file-datalake/samples/javascript/sample.env
@@ -0,0 +1,3 @@
+# Used in most samples. Retrieve these values from a storage account in the Azure Portal.
+ACCOUNT_NAME=<storage-account-name>
+ACCOUNT_KEY=<storage-account-key>
diff --git a/sdk/storage/storage-file-datalake/samples/package.json b/sdk/storage/storage-file-datalake/samples/package.json
diff --git a/sdk/storage/storage-file-datalake/samples/tsconfig.json b/sdk/storage/storage-file-datalake/samples/tsconfig.json
@@ -1,13 +1,9 @@
 {
-    "extends": "../tsconfig.json",
-    "compilerOptions": {
-        "module": "commonjs"
-    },
-    "include": [
-        "**/*.ts"
-    ],
-    "exclude": [
-        "../node_modules",
-        "../typings/**",
-    ]
-}
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "module": "commonjs",
+    "outDir": "typescript/dist"
+  },
+  "include": ["typescript/src/**.ts"],
+  "exclude": ["typescript/*.json", "**/node_modules/", "../node_modules", "../typings"]
+}
diff --git a/sdk/storage/storage-file-datalake/samples/typescript/README.md b/sdk/storage/storage-file-datalake/samples/typescript/README.md
@@ -0,0 +1,69 @@
+---
+page_type: sample
+languages:
+  - typescript
+products:
+  - azure
+  - azure-storage
+urlFragment: storage-file-datalake-typescript
+---
+
+# Azure Data Lake Storage client library samples for TypeScript
+
+These sample programs show how to use the TypeScript client libraries for Azure Data Lake Storage in some common scenarios.
+
+| **File Name**     | **Description**                                                                                                                 |
+| ----------------- | ------------------------------------------------------------------------------------------------------------------------------- |
+| [basic.ts][basic] | authenticate with the service using an account name & key; create and delete filesystem; create and download a file, list paths |
+
+## Prerequisites
+
+The samples are compatible with Node.js >= 8.0.0, except for the samples that use the async `for await` syntax, which require a Node.js >= 10.0.0.
+
+Before running the samples in Node, they must be compiled to JavaScript using the TypeScript compiler. For more information on TypeScript, see the [TypeScript documentation][typescript]. Install the TypeScript compiler using
+
+```bash
+npm install -g typescript
+```
+
+You need [an Azure subscription][freesub] and [an Azure Storage account][azstorage] to run these sample programs. Samples retrieve credentials to access the storage account from environment variables. Alternatively, edit the source code to include the appropriate credentials. See each individual sample for details on which environment variables/credentials it requires to function.
+
+## Setup
+
+To run the samples using the published version of the package:
+
+1. Install the dependencies using `npm`:
+
+```bash
+npm install
+```
+
+2. Compile the samples
+
+```bash
+npm run build
+```
+
+3. Edit the file `sample.env`, adding the correct credentials to access the Azure service and run the samples. Then rename the file from `sample.env` to just `.env`. The sample programs will read this file automatically.
+
+4. Run whichever samples you like:
+
+```bash
+node dist/basic.js
+```
+
+Alternatively, run a single sample with the correct environment variables set (step 3 is not required if you do this), for example (cross-platform):
+
+```bash
+npx cross-env ACCOUNT_NAME="<account name>" ACCOUNT_KEY="<account key>" node dist/basic.js
+```
+
+## Next Steps
+
+Take a look at our [API Documentation][apiref] for more information about the APIs that are available in the clients.
+
+[basic]: https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/storage/storage-file-datalake/samples/typescript/src/basic.ts
+[apiref]: https://docs.microsoft.com/javascript/api/@azure/storage-file-datalake
+[azstorage]: https://docs.microsoft.com/azure/storage/common/storage-account-overview
+[freesub]: https://azure.microsoft.com/free/
+[typescript]: https://www.typescriptlang.org/docs/home.html