[Search] Miscellaneous small fixups (Azure#29600)

Author: dgetu

common/config/rush/pnpm-lock.yaml

@@ -1,18 +1,18 @@
 {
   "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-  "mainEntryPointFilePath": "types/src/index.d.ts",
-  "docModel": {
-    "enabled": true
-  },
   "apiReport": {
     "enabled": true,
     "reportFolder": "./review"
   },
+  "docModel": {
+    "enabled": true
+  },
   "dtsRollup": {
     "enabled": true,
     "publicTrimmedFilePath": "./types/search-documents.d.ts",
     "untrimmedFilePath": ""
   },
+  "mainEntryPointFilePath": "types/src/index.d.ts",
   "messages": {
     "extractorMessageReporting": {
       "ae-missing-release-tag": {
@@ -27,5 +27,6 @@
         "logLevel": "none"
       }
     }
-  }
+  },
+  "newlineKind": "lf"
 }

sdk/search/search-documents/api-extractor.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "js",
   "TagPrefix": "js/search/search-documents",
-  "Tag": "js/search/search-documents_13f2a06b1c"
+  "Tag": "js/search/search-documents_e4f423ced3"
 }

sdk/search/search-documents/assets.json

@@ -46,13 +46,7 @@ module.exports = function (config) {
     // inject following environment values into browser testing with window.__env__
     // environment values MUST be exported or set with same console running "karma start"
     // https://www.npmjs.com/package/karma-env-preprocessor
-    envPreprocessor: [
-      "TEST_MODE",
-      "ENDPOINT",
-      "SEARCH_API_ADMIN_KEY",
-      "SEARCH_API_ADMIN_KEY_ALT",
-      "RECORDINGS_RELATIVE_PATH",
-    ],
+    envPreprocessor: ["TEST_MODE", "ENDPOINT", "RECORDINGS_RELATIVE_PATH"],
 
     // test results reporter to use
     // possible values: 'dots', 'progress'

sdk/search/search-documents/karma.conf.js

@@ -95,12 +95,14 @@
     "tslib": "^2.2.0"
   },
   "devDependencies": {
+    "@azure-tools/test-credential": "^2.0.0",
     "@azure-tools/test-recorder": "^3.0.0",
+    "@azure-tools/test-utils": "^1.0.1",
     "@azure/core-util": "^1.6.1",
     "@azure/dev-tool": "^1.0.0",
     "@azure/eslint-plugin-azure-sdk": "^3.0.0",
+    "@azure/identity": "^4.0.1",
     "@azure/openai": "1.0.0-beta.13",
-    "@azure-tools/test-utils": "^1.0.1",
     "@microsoft/api-extractor": "^7.31.1",
     "@types/chai": "^4.1.6",
     "@types/mocha": "^10.0.0",

sdk/search/search-documents/package.json

@@ -1,18 +1,9 @@
-# The primary key of your Azure Search account.
-SEARCH_API_ADMIN_KEY=<search-api-admin-key>
-
-# (optional) The secondary key of your Azure Search account.
-SEARCH_API_ADMIN_KEY_ALT=<search-api-admin-key-alt>
-
 # The endpoint of your Azure Search account.
 ENDPOINT=<endpoint>
 
 # The endpoint for the OpenAI service.
 AZURE_OPENAI_ENDPOINT=<openai-endpoint>
 
-# The key for the OpenAI service.
-AZURE_OPENAI_KEY=<openai-key>
-
 # The name of the OpenAI deployment you'd like your tests to use.
 AZURE_OPENAI_DEPLOYMENT_NAME=<deployment-name>
 

sdk/search/search-documents/sample.env

@@ -5,8 +5,8 @@
  * @summary Demonstrates the SearchIndexingBufferedSender with Autoflush based on size.
  */
 
+import { DefaultAzureCredential } from "@azure/identity";
 import {
-  AzureKeyCredential,
   GeographyPoint,
   SearchClient,
   SearchIndexClient,
@@ -26,7 +26,6 @@ dotenv.config();
  * by default.
  */
 const endpoint = process.env.ENDPOINT || "";
-const apiKey = process.env.SEARCH_API_ADMIN_KEY || "";
 const TEST_INDEX_NAME = "example-index-sample-4";
 
 function getDocumentsArray(size: number): Hotel[] {
@@ -59,14 +58,14 @@ function getDocumentsArray(size: number): Hotel[] {
 }
 
 async function main(): Promise<void> {
-  if (!endpoint || !apiKey) {
-    console.log("Make sure to set valid values for endpoint and apiKey with proper authorization.");
+  if (!endpoint) {
+    console.log("Be sure to set a valid endpoint with proper authorization.");
     return;
   }
 
   console.log(`Running SearchIndexingBufferedSender-uploadDocuments-With Auto Flush Sizes Sample`);
 
-  const credential = new AzureKeyCredential(apiKey);
+  const credential = new DefaultAzureCredential();
   const searchClient: SearchClient<Hotel> = new SearchClient<Hotel>(
     endpoint,
     TEST_INDEX_NAME,

sdk/search/search-documents/samples-dev/bufferedSenderAutoFlushSize.ts

@@ -5,8 +5,8 @@
  * @summary Demonstrates the SearchIndexingBufferedSender with Autoflush based on timer.
  */
 
+import { DefaultAzureCredential } from "@azure/identity";
 import {
-  AzureKeyCredential,
   DEFAULT_FLUSH_WINDOW,
   GeographyPoint,
   SearchClient,
@@ -27,18 +27,17 @@ dotenv.config();
  * by default.
  */
 const endpoint = process.env.ENDPOINT || "";
-const apiKey = process.env.SEARCH_API_ADMIN_KEY || "";
 const TEST_INDEX_NAME = "example-index-sample-5";
 
 export async function main(): Promise<void> {
-  if (!endpoint || !apiKey) {
-    console.log("Make sure to set valid values for endpoint and apiKey with proper authorization.");
+  if (!endpoint) {
+    console.log("Be sure to set a valid endpoint with proper authorization.");
     return;
   }
 
   console.log(`Running SearchIndexingBufferedSender-uploadDocuments-With Auto Flush Timer Sample`);
 
-  const credential = new AzureKeyCredential(apiKey);
+  const credential = new DefaultAzureCredential();
   const searchClient: SearchClient<Hotel> = new SearchClient<Hotel>(
     endpoint,
     TEST_INDEX_NAME,

sdk/search/search-documents/samples-dev/bufferedSenderAutoFlushTimer.ts

@@ -5,8 +5,8 @@
  * @summary Demonstrates the SearchIndexingBufferedSender with Manual Flush.
  */
 
+import { DefaultAzureCredential } from "@azure/identity";
 import {
-  AzureKeyCredential,
   GeographyPoint,
   SearchClient,
   SearchIndexClient,
@@ -24,18 +24,17 @@ dotenv.config();
  * wants to call the flush manually.
  */
 const endpoint = process.env.ENDPOINT || "";
-const apiKey = process.env.SEARCH_API_ADMIN_KEY || "";
 const TEST_INDEX_NAME = "example-index-sample-6";
 
 export async function main(): Promise<void> {
-  if (!endpoint || !apiKey) {
-    console.log("Make sure to set valid values for endpoint and apiKey with proper authorization.");
+  if (!endpoint) {
+    console.log("Be sure to set a valid endpoint with proper authorization.");
     return;
   }
 
   console.log(`Running SearchIndexingBufferedSender-uploadDocuments-Without AutoFlush Sample`);
 
-  const credential = new AzureKeyCredential(apiKey);
+  const credential = new DefaultAzureCredential();
   const searchClient: SearchClient<Hotel> = new SearchClient<Hotel>(
     endpoint,
     TEST_INDEX_NAME,

sdk/search/search-documents/samples-dev/bufferedSenderManualFlush.ts

@@ -5,17 +5,13 @@
  * @summary Demonstrates the DataSource Connection Operations.
  */
 
-import {
-  AzureKeyCredential,
-  SearchIndexerClient,
-  SearchIndexerDataSourceConnection,
-} from "@azure/search-documents";
+import { DefaultAzureCredential } from "@azure/identity";
+import { SearchIndexerClient, SearchIndexerDataSourceConnection } from "@azure/search-documents";
 
 import * as dotenv from "dotenv";
 dotenv.config();
 
 const endpoint = process.env.ENDPOINT || "";
-const apiKey = process.env.SEARCH_API_ADMIN_KEY || "";
 const connectionString = process.env.CONNECTION_STRING || "";
 const TEST_DATA_SOURCE_CONNECTION_NAME = "example-ds-connection-sample-1";
 
@@ -79,11 +75,11 @@ async function deleteDataSourceConnection(
 
 async function main(): Promise<void> {
   console.log(`Running DS Connection Operations Sample....`);
-  if (!endpoint || !apiKey || !connectionString) {
-    console.log("Make sure to set valid values for endpoint and apiKey with proper authorization.");
+  if (!endpoint || !connectionString) {
+    console.log("Be sure to set a valid endpoint with proper authorization.");
     return;
   }
-  const client = new SearchIndexerClient(endpoint, new AzureKeyCredential(apiKey));
+  const client = new SearchIndexerClient(endpoint, new DefaultAzureCredential());
   try {
     await createDataSourceConnection(TEST_DATA_SOURCE_CONNECTION_NAME, client);
     await getAndUpdateDataSourceConnection(TEST_DATA_SOURCE_CONNECTION_NAME, client);