[FormRecognizer] whitelist header names and query parameters for logg…

…ing (#9149)
Azure · Jun 5, 2020 · 527f241 · 527f241
1 parent 3093009
commit 527f241
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 5 deletions.
diff --git a/sdk/formrecognizer/ai-form-recognizer/src/constants.ts b/sdk/formrecognizer/ai-form-recognizer/src/constants.ts
@@ -12,3 +12,18 @@ export const LIB_INFO = `azsdk-js-ai-formrecognizer/${SDK_VERSION}`;
  * @internal
  */
 export const MAX_INPUT_DOCUMENT_SIZE = 50 * 1024 * 1024; // 50 MB
+
+export const FormRecognizerLoggingAllowedHeaderNames = [
+  "apim-request-id",
+  "Location",
+  "Operation-Location",
+  "Strict-Transport-Security",
+  "X-Content-Type-Options",
+  "x-envoy-upstream-service-time"
+];
+
+export const FormRecognizerLoggingAllowedQueryParameters = [
+  "includeTextDetails",
+  "includeKeys",
+  "op"
+];
diff --git a/sdk/formrecognizer/ai-form-recognizer/src/formRecognizerClient.ts b/sdk/formrecognizer/ai-form-recognizer/src/formRecognizerClient.ts
@@ -12,7 +12,12 @@ import {
 } from "@azure/core-http";
 import { TokenCredential } from "@azure/identity";
 import { KeyCredential } from "@azure/core-auth";
-import { SDK_VERSION, DEFAULT_COGNITIVE_SCOPE } from "./constants";
+import {
+  SDK_VERSION,
+  DEFAULT_COGNITIVE_SCOPE,
+  FormRecognizerLoggingAllowedHeaderNames,
+  FormRecognizerLoggingAllowedQueryParameters
+} from "./constants";
 import { logger } from "./logger";
 import { createSpan } from "./tracing";
 import {
@@ -253,7 +258,8 @@ export class FormRecognizerClient {
       ...{
         loggingOptions: {
           logger: logger.info,
-          allowedHeaderNames: ["x-ms-correlation-request-id", "x-ms-request-id"]
+          allowedHeaderNames: FormRecognizerLoggingAllowedHeaderNames,
+          allowedQueryParameters: FormRecognizerLoggingAllowedQueryParameters
         }
       }
     };

diff --git a/sdk/formrecognizer/ai-form-recognizer/src/formTrainingClient.ts b/sdk/formrecognizer/ai-form-recognizer/src/formTrainingClient.ts
@@ -16,7 +16,12 @@ import { TokenCredential } from "@azure/identity";
 import { KeyCredential } from "@azure/core-auth";
 import { PagedAsyncIterableIterator, PageSettings } from "@azure/core-paging";
 import "@azure/core-paging";
-import { SDK_VERSION, DEFAULT_COGNITIVE_SCOPE } from "./constants";
+import {
+  SDK_VERSION,
+  DEFAULT_COGNITIVE_SCOPE,
+  FormRecognizerLoggingAllowedHeaderNames,
+  FormRecognizerLoggingAllowedQueryParameters
+} from "./constants";
 import { logger } from "./logger";
 import { createSpan } from "./tracing";
 import { CanonicalCode } from "@opentelemetry/api";
@@ -188,7 +193,8 @@ export class FormTrainingClient {
       ...{
         loggingOptions: {
           logger: logger.info,
-          allowedHeaderNames: ["x-ms-correlation-request-id", "x-ms-request-id"]
+          allowedHeaderNames: FormRecognizerLoggingAllowedHeaderNames,
+          allowedQueryParameters: FormRecognizerLoggingAllowedQueryParameters
         }
       }
     };

diff --git a/sdk/formrecognizer/ai-form-recognizer/src/index.ts b/sdk/formrecognizer/ai-form-recognizer/src/index.ts
@@ -11,5 +11,4 @@ export {
   FormRecognizerOperationOptions } from "./common";
 export * from "./formRecognizerClient";
 export * from "./formTrainingClient";
-
 export * from "./models";