Merge pull request #2 from lobrien/lobrien_quickstart

Azure Search Node.js quickstart

Author: HeidiSteen

.gitignore

@@ -4,58 +4,43 @@ logs
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
-
 # Runtime data
 pids
 *.pid
 *.seed
 *.pid.lock
-
 # Directory for instrumented libs generated by jscoverage/JSCover
 lib-cov
-
 # Coverage directory used by tools like istanbul
 coverage
-
 # nyc test coverage
 .nyc_output
-
 # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
 .grunt
-
 # Bower dependency directory (https://bower.io/)
 bower_components
-
 # node-waf configuration
 .lock-wscript
-
 # Compiled binary addons (https://nodejs.org/api/addons.html)
 build/Release
-
 # Dependency directories
 node_modules/
 jspm_packages/
-
 # TypeScript v1 declaration files
 typings/
-
 # Optional npm cache directory
 .npm
-
 # Optional eslint cache
 .eslintcache
-
 # Optional REPL history
 .node_repl_history
-
 # Output of 'npm pack'
 *.tgz
-
 # Yarn Integrity file
 .yarn-integrity
-
 # dotenv environment variables file
 .env
-
 # next.js build output
 .next
+**/.vscode/*
+package-lock.json

quickstart/.eslintrc

@@ -0,0 +1,3 @@
+{
+  "extends": ["airbnb-base", "prettier"]
+}

quickstart/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "tabWidth" : 4
+}

quickstart/AzureSearchClient.js

@@ -0,0 +1,97 @@
+const fetch = require('node-fetch');
+
+class AzureSearchClient {
+    constructor(searchServiceName, adminKey, queryKey, indexName) {
+        this.searchServiceName = searchServiceName;
+        this.adminKey = adminKey;
+        // The query key is used for read-only requests and so can be distributed with less risk of abuse.
+        this.queryKey = queryKey;
+        this.indexName = indexName;
+        this.apiVersion = '2019-05-06';
+    }
+
+    getIndexUrl() { return `https://${this.searchServiceName}.search.windows.net/indexes/${this.indexName}?api-version=${this.apiVersion}`; }
+    
+    getPostDataUrl() { return `https://${this.searchServiceName}.search.windows.net/indexes/${this.indexName}/docs/index?api-version=${this.apiVersion}`;  }
+
+    getSearchUrl(searchTerm) { return `https://${this.searchServiceName}.search.windows.net/indexes/${this.indexName}/docs?api-version=${this.apiVersion}&search=${searchTerm}&searchMode=all`; }
+    
+    static async request(url, method, apiKey, bodyJson = null) {
+        // Uncomment the following for request details:
+        /*
+        console.log(`\n${method} ${url}`);
+        console.log(`\nKey ${apiKey}`);
+        if (bodyJson !== null) {
+            console.log(`\ncontent: ${JSON.stringify(bodyJson, null, 4)}`);
+        }
+        */
+
+        const headers = {
+            'content-type' : 'application/json',
+            'api-key' : apiKey
+        };
+        const init = bodyJson === null ?
+            { 
+                method, 
+                headers
+            }
+            : 
+            {
+                method, 
+                headers,
+                body : JSON.stringify(bodyJson)
+            };
+        return fetch(url, init);
+    }
+
+    static throwOnHttpError(response) {
+        const statusCode = response.status;
+        if (statusCode >= 300){
+            console.log(`Request failed: ${JSON.stringify(response, null, 4)}`);
+            throw new Error(`Failure in request. HTTP Status was ${statusCode}`);
+        }
+    }
+
+    async indexExistsAsync() { 
+        console.log("\n Checking if index exists...");
+        const endpoint = this.getIndexUrl();
+        const response = await AzureSearchClient.request(endpoint, "GET", this.adminKey);
+        // Success has a few likely status codes: 200 or 204 (No Content), but accept all in 200 range...
+        const exists = response.status >= 200 && response.status < 300;
+        return exists;
+    }
+
+    async deleteIndexAsync() {
+        console.log("\n Deleting existing index...");
+        const endpoint = this.getIndexUrl();
+        const response = await AzureSearchClient.request(endpoint, "DELETE", this.adminKey);
+        AzureSearchClient.throwOnHttpError(response);
+        return this;
+    }
+
+    async createIndexAsync(definition) {
+        console.log("\n Creating index...");
+        const endpoint = this.getIndexUrl();
+        const response = await AzureSearchClient.request(endpoint, "PUT", this.adminKey, definition);
+        AzureSearchClient.throwOnHttpError(response);
+        return this;
+    }
+
+    async postDataAsync(hotelsData) {
+        console.log("\n Adding hotel data...");
+        const endpoint = this.getPostDataUrl();
+        const response = await AzureSearchClient.request(endpoint,"POST", this.adminKey, hotelsData);
+        AzureSearchClient.throwOnHttpError(response);
+        return this;
+    }
+
+    async queryAsync(searchTerm) {
+        console.log("\n Querying...")
+        const endpoint = this.getSearchUrl(searchTerm);
+        const response = await AzureSearchClient.request(endpoint, "GET", this.queryKey);
+        AzureSearchClient.throwOnHttpError(response);
+        return response;
+    }
+}
+
+module.exports = AzureSearchClient;

quickstart/CONTRIBUTING.md

@@ -0,0 +1,76 @@
+# Contributing to Azure Search Quickstart
+
+This project welcomes contributions and suggestions.  Most contributions require you to agree to a
+Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
+the rights to use your contribution. For details, visit https://cla.microsoft.com.
+
+When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
+a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
+provided by the bot. You will only need to do this once across all repos using our CLA.
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
+contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
+
+ - [Code of Conduct](#coc)
+ - [Issues and Bugs](#issue)
+ - [Feature Requests](#feature)
+ - [Submission Guidelines](#submit)
+
+## <a name="coc"></a> Code of Conduct
+Help us keep this project open and inclusive. Please read and follow our [Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+
+## <a name="issue"></a> Found an Issue?
+If you find a bug in the source code or a mistake in the documentation, you can help us by
+[submitting an issue](#submit-issue) to the GitHub Repository. Even better, you can
+[submit a Pull Request](#submit-pr) with a fix.
+
+## <a name="feature"></a> Want a Feature?
+You can *request* a new feature by [submitting an issue](#submit-issue) to the GitHub
+Repository. If you would like to *implement* a new feature, please submit an issue with
+a proposal for your work first, to be sure that we can use it.
+
+* **Small Features** can be crafted and directly [submitted as a Pull Request](#submit-pr).
+
+## <a name="submit"></a> Submission Guidelines
+
+### <a name="submit-issue"></a> Submitting an Issue
+Before you submit an issue, search the archive, maybe your question was already answered.
+
+If your issue appears to be a bug, and hasn't been reported, open a new issue.
+Help us to maximize the effort we can spend fixing issues and adding new
+features, by not reporting duplicate issues.  Providing the following information will increase the
+chances of your issue being dealt with quickly:
+
+* **Overview of the Issue** - if an error is being thrown a non-minified stack trace helps
+* **Version** - what version is affected (e.g. 0.1.2)
+* **Motivation for or Use Case** - explain what are you trying to do and why the current behavior is a bug for you
+* **Browsers and Operating System** - is this a problem with all browsers?
+* **Reproduce the Error** - provide a live example or a unambiguous set of steps
+* **Related Issues** - has a similar issue been reported before?
+* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
+  causing the problem (line of code or commit)
+
+You can file new issues by providing the above information at the corresponding repository's issues link: https://github.com/[organization-name]/[repository-name]/issues/new].
+
+### <a name="submit-pr"></a> Submitting a Pull Request (PR)
+Before you submit your Pull Request (PR) consider the following guidelines:
+
+* Search the repository (https://github.com/[organization-name]/[repository-name]/pulls) for an open or closed PR
+  that relates to your submission. You don't want to duplicate effort.
+
+* Make your changes in a new git fork:
+
+* Commit your changes using a descriptive commit message
+* Push your fork to GitHub:
+* In GitHub, create a pull request
+* If we suggest changes then:
+  * Make the required updates.
+  * Rebase your fork and force push to your GitHub repository (this will update your Pull Request):
+
+    ```shell
+    git rebase master -i
+    git push -f
+    ```
+
+That's it! Thank you for your contribution!

quickstart/LICENSE.md

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation. All rights reserved.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

quickstart/README.md

@@ -0,0 +1,91 @@
+---
+page-type: sample
+languages:
+  - nodejs
+name: Quickstart in Node.js
+description: |
+  Learn basic steps for creating, loading, and querying an Azure Search index using REST APIs and Node.js.
+products:
+  - azure
+  - azure-search
+urlFragment: nodejs-quickstart
+---
+
+# Quickstart sample for Azure Search with Node.js
+
+![Quickstart sample MIT license badge](https://img.shields.io/badge/license-MIT-green.svg)
+
+Demonstrates using Node.js and the Azure Search REST API to create an index, load it with documents, and execute a few queries. The index is modeled on a subset of the Hotels dataset, reduced for readability and comprehension. Index definition and documents are included in the code.
+
+This Node.js console application is featured in [Node.js Quickstart: Create, load, and query indexes using Azure Search REST APIs](https://docs.microsoft.com/azure/search/search-get-started-nodejs). When you run the program, a console window emits output messages for each step: deleting and then re-creating a hotels-quickstart index, loading documents, running queries. This sample uses the [REST API](https://docs.microsoft.com/en-us/rest/api/searchservice/) and runs on an Azure Search service using connection information that you provide.
+
+## Contents
+
+| File/folder | Description |
+|-------------|-------------|
+| `index.js` | The main program |
+| `AzureSearchClient.js` | Defines a class that can makes Azure Search REST API requests. |
+| `azure_search_config.json` | Key-value configuration data. | 
+| `hotels_quickstart_index.json` | Specifies the structure of the Azure Search index. | 
+| `hotels.json` | A small amount of sample data to populate Azure Search. | 
+| `package.json` | The Node project definition file. | 
+| `package-lock.json` | The version dependencies of the project. | 
+| `.eslintrc` | Coding standards used by [ESLint](https://eslint.org/). |
+| `.prettierrc` | Formatting standards used by [Prettier](https://prettier.io/). | 
+| `.gitignore` | Define what to ignore at commit time. |
+| `CONTRIBUTING.md` | Guidelines for contributing to the sample. |
+| `README.md` | This README file. |
+| `LICENSE.md`   | The license for the sample. |
+
+## Prerequisites
+
++ [Node.js](https://nodejs.org).
++ [NPM](https://www.npmjs.com) should be installed by Node.js.
++ [Create an Azure Search service](search-create-service-portal.md) or [find an existing service](https://ms.portal.azure.com/#blade/HubsExtension/BrowseResourceBlade/resourceType/Microsoft.Search%2FsearchServices) under your current subscription. You can use a free service for this quickstart.
+
+Recommended:
+
+* [Visual Studio Code](https://code.visualstudio.com).
+* [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) and [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) extensions for VSCode.
+
+## Setup
+
+1. Clone or download this sample repository.
+1. Run the following command to install the node dependencies.
+    ```bash
+    npm install 
+    ```
+1. Modify the values in `azure_search_config.json` 
+    1. Replace `[SEARCH_SERVICE_NAME]` with the name of your search service. 
+    1. Replace `[SEARCH_SERVICE_ADMIN_KEY]` with either of the admin keys of your search service.
+    1. Replace `[SEARCH_SERVICE_QUERY_KEY]` with the query key of your search service
+
+### Running quickstart
+
+1. Run the following command to start the program.
+    ```bash
+    node index.js
+    ```
+
+You should see a series of messages relating to the creation of the search index, adding documents to it, and, finally, results of a series of queries.
+
+## Key concepts 
+
+The file **hotels_quickstart_index.json** holds the definition of an index for the data in the file **hotels.json**. Review those files to see the fields, which ones are searchable, etc. 
+
+The file **AzureSearchClient.js** defines a class, `AzureSearchClient` that knows how to construct the URLs of the REST API and prepare and execute an HTTP request using the `fetch` API. It uses the query API key for queries and, otherwise, uses the admin API key. 
+
+The file **index.js** reads the **azure_search_config.json** file, and passes the configuration data it finds there to the constructor of `AzureSearchClient`. The `sleep` function is used to pause execution in between major steps such as creating the index, submitting data for indexing, etc. Such pauses are generally only needed in test, demo, and sample code. 
+
+The `run` function :
+
+* Checks if the `hotels-quickstart` index exists.
+* If so, the program deletes the existing index.
+* Creates a new `hotels-quickstart` index from the structure in **hotels_quickstart_index.json**.
+* Adds the data from **hotels.json** to the `hotels-quickstart` index.
+* Executes a few basic queries against the search index.
+
+## Next steps 
+
+You can learn more about Azure Search on the [official documentation site](https://docs.microsoft.com/azure/search/).
+

quickstart/azure_search_config.json

@@ -0,0 +1,6 @@
+{
+    "serviceName" : "[SEARCH_SERVICE_NAME]",
+    "adminKey" : "[SEARCH_SERVICE_ADMIN_KEY]",
+    "queryKey" : "[SEARCH_SERVICE_QUERY_KEY]",
+    "indexName" : "hotels-quickstart"
+}