Move common type guards into core-util (#22872)

A few type guards had duplicate definitions in multiple packages. This change moves the common functions to `core-util`. Fixes #21734
Azure · Aug 12, 2022 · f6c54e1 · f6c54e1
1 parent fdb65d1
commit f6c54e1
Show file tree

Hide file tree

Showing 55 changed files with 123 additions and 289 deletions.
diff --git a/sdk/appconfiguration/app-configuration/package.json b/sdk/appconfiguration/app-configuration/package.json
@@ -87,7 +87,7 @@
     "@azure/core-rest-pipeline": "^1.6.0",
     "@azure/core-tracing": "^1.0.0",
     "@azure/core-auth": "^1.3.0",
-    "@azure/core-util": "^1.0.0",
+    "@azure/core-util": "^1.0.1",
     "tslib": "^2.2.0"
   },
   "devDependencies": {

diff --git a/sdk/appconfiguration/app-configuration/src/internal/helpers.ts b/sdk/appconfiguration/app-configuration/src/internal/helpers.ts
@@ -19,7 +19,7 @@ import {
   SecretReferenceValue,
   secretReferenceContentType,
 } from "../secretReference";
-import { isDefined } from "./typeguards";
+import { isDefined } from "@azure/core-util";
 
 /**
  * Formats the etag so it can be used with a If-Match/If-None-Match header

diff --git a/sdk/appconfiguration/app-configuration/src/internal/typeguards.ts b/sdk/appconfiguration/app-configuration/src/internal/typeguards.ts
diff --git a/sdk/core/core-amqp/package.json b/sdk/core/core-amqp/package.json
@@ -69,7 +69,7 @@
   "dependencies": {
     "@azure/abort-controller": "^1.0.0",
     "@azure/core-auth": "^1.3.0",
-    "@azure/core-util": "^1.0.0",
+    "@azure/core-util": "^1.0.1",
     "@azure/logger": "^1.0.0",
     "buffer": "^6.0.0",
     "events": "^3.0.0",

diff --git a/sdk/core/core-amqp/src/auth/tokenProvider.ts b/sdk/core/core-amqp/src/auth/tokenProvider.ts
@@ -8,7 +8,7 @@ import {
   isNamedKeyCredential,
   isSASCredential,
 } from "@azure/core-auth";
-import { isObjectWithProperties } from "../util/typeGuards";
+import { isObjectWithProperties } from "@azure/core-util";
 import jssha from "jssha";
 
 /**

diff --git a/sdk/core/core-amqp/src/connectionConfig/connectionConfig.ts b/sdk/core/core-amqp/src/connectionConfig/connectionConfig.ts
@@ -2,7 +2,7 @@
 // Licensed under the MIT license.
 
 import { WebSocketImpl } from "rhea-promise";
-import { isDefined } from "../util/typeGuards";
+import { isDefined } from "@azure/core-util";
 import { parseConnectionString } from "../util/utils";
 
 /**

diff --git a/sdk/core/core-amqp/src/errors.ts b/sdk/core/core-amqp/src/errors.ts
@@ -3,7 +3,7 @@
 /* eslint-disable eqeqeq */
 
 import { AmqpError, AmqpResponseStatusCode, isAmqpError as rheaIsAmqpError } from "rhea-promise";
-import { isDefined, isObjectWithProperties } from "./util/typeGuards";
+import { isDefined, isObjectWithProperties } from "@azure/core-util";
 import { isNode, isNumber, isString } from "../src/util/utils";
 import { isError } from "@azure/core-util";
 

diff --git a/sdk/core/core-amqp/src/log.ts b/sdk/core/core-amqp/src/log.ts
@@ -2,7 +2,7 @@
 // Licensed under the MIT license.
 
 import { createClientLogger } from "@azure/logger";
-import { isObjectWithProperties } from "./util/typeGuards";
+import { isObjectWithProperties } from "@azure/core-util";
 
 /**
  * The \@azure/logger configuration for this package.

diff --git a/sdk/core/core-amqp/src/requestResponseLink.ts b/sdk/core/core-amqp/src/requestResponseLink.ts
@@ -18,7 +18,7 @@ import {
 } from "rhea-promise";
 import { Constants, StandardAbortMessage } from "./util/constants";
 import { logErrorStackTrace, logger } from "./log";
-import { isDefined } from "./util/typeGuards";
+import { isDefined } from "@azure/core-util";
 
 /**
  * Describes the options that can be specified while sending a request.

diff --git a/sdk/core/core-amqp/src/util/typeGuards.ts b/sdk/core/core-amqp/src/util/typeGuards.ts
@@ -2,53 +2,7 @@
 // Licensed under the MIT license.
 
 import { SasTokenProvider } from "../auth/tokenProvider";
-
-/**
- * Helper TypeGuard that checks if something is defined or not.
- * @param thing - Anything
- * @internal
- */
-export function isDefined<T>(thing: T | undefined | null): thing is T {
-  return typeof thing !== "undefined" && thing !== null;
-}
-
-/**
- * Helper TypeGuard that checks if the input is an object with the specified properties.
- * Note: The properties may be inherited.
- * @param thing - Anything.
- * @param properties - The name of the properties that should appear in the object.
- * @internal
- */
-export function isObjectWithProperties<Thing, PropertyName extends string>(
-  thing: Thing,
-  properties: PropertyName[]
-): thing is Thing & Record<PropertyName, unknown> {
-  if (!isDefined(thing) || typeof thing !== "object") {
-    return false;
-  }
-
-  for (const property of properties) {
-    if (!objectHasProperty(thing, property)) {
-      return false;
-    }
-  }
-
-  return true;
-}
-
-/**
- * Helper TypeGuard that checks if the input is an object with the specified property.
- * Note: The property may be inherited.
- * @param thing - Any object.
- * @param property - The name of the property that should appear in the object.
- * @internal
- */
-export function objectHasProperty<Thing, PropertyName extends string>(
-  thing: Thing,
-  property: PropertyName
-): thing is Thing & Record<PropertyName, unknown> {
-  return typeof thing === "object" && property in (thing as Record<string, unknown>);
-}
+import { isObjectWithProperties } from "@azure/core-util";
 
 /**
  * Typeguard that checks if the input is a SasTokenProvider.

diff --git a/sdk/core/core-amqp/src/util/utils.ts b/sdk/core/core-amqp/src/util/utils.ts
@@ -5,7 +5,7 @@ import { AbortError, AbortSignalLike } from "@azure/abort-controller";
 import { CancellableAsyncLock, CancellableAsyncLockImpl } from "./lock";
 import { StandardAbortMessage } from "./constants";
 import { WebSocketImpl } from "rhea-promise";
-import { isDefined } from "./typeGuards";
+import { isDefined } from "@azure/core-util";
 
 /**
  * @internal

diff --git a/sdk/core/core-auth/package.json b/sdk/core/core-auth/package.json
@@ -63,6 +63,7 @@
   "sideEffects": false,
   "dependencies": {
     "@azure/abort-controller": "^1.0.0",
+    "@azure/core-util": "^1.0.1",
     "tslib": "^2.2.0"
   },
   "devDependencies": {

diff --git a/sdk/core/core-auth/src/azureNamedKeyCredential.ts b/sdk/core/core-auth/src/azureNamedKeyCredential.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import { isObjectWithProperties } from "./typeguards";
+import { isObjectWithProperties } from "@azure/core-util";
 
 /**
  * Represents a credential defined by a static API name and key.

diff --git a/sdk/core/core-auth/src/azureSASCredential.ts b/sdk/core/core-auth/src/azureSASCredential.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 
-import { isObjectWithProperties } from "./typeguards";
+import { isObjectWithProperties } from "@azure/core-util";
 
 /**
  * Represents a credential defined by a static shared access signature.

diff --git a/sdk/core/core-auth/src/typeguards.ts b/sdk/core/core-auth/src/typeguards.ts
diff --git a/sdk/core/core-http/package.json b/sdk/core/core-http/package.json
@@ -119,6 +119,7 @@
     "@azure/abort-controller": "^1.0.0",
     "@azure/core-auth": "^1.3.0",
     "@azure/core-tracing": "1.0.0-preview.13",
+    "@azure/core-util": "^1.0.1",
     "@azure/logger": "^1.0.0",
     "@types/node-fetch": "^2.5.0",
     "@types/tunnel": "^0.0.3",

diff --git a/sdk/core/core-http/src/util/delay.ts b/sdk/core/core-http/src/util/delay.ts
@@ -2,7 +2,7 @@
 // Licensed under the MIT license.
 
 import { AbortError, AbortSignalLike } from "@azure/abort-controller";
-import { isDefined } from "./typeguards";
+import { isDefined } from "@azure/core-util";
 
 const StandardAbortMessage = "The operation was aborted.";
 

diff --git a/sdk/core/core-http/src/util/typeguards.ts b/sdk/core/core-http/src/util/typeguards.ts
diff --git a/sdk/core/core-util/CHANGELOG.md b/sdk/core/core-util/CHANGELOG.md
@@ -4,6 +4,8 @@
 
 ### Features Added
 
+- Add helper type guards `isDefined`, `isObjectWithProperties`, `objectHasProperty`.
+
 ### Breaking Changes
 
 ### Bugs Fixed

diff --git a/sdk/core/core-util/review/core-util.api.md b/sdk/core/core-util/review/core-util.api.md
@@ -19,6 +19,9 @@ export function getErrorMessage(e: unknown): string;
 // @public
 export function getRandomIntegerInclusive(min: number, max: number): number;
 
+// @public
+export function isDefined<T>(thing: T | undefined | null): thing is T;
+
 // @public
 export function isError(e: unknown): e is Error;
 
@@ -28,6 +31,12 @@ export const isNode: boolean;
 // @public
 export function isObject(input: unknown): input is UnknownObject;
 
+// @public
+export function isObjectWithProperties<Thing, PropertyName extends string>(thing: Thing, properties: PropertyName[]): thing is Thing & Record<PropertyName, unknown>;
+
+// @public
+export function objectHasProperty<Thing, PropertyName extends string>(thing: Thing, property: PropertyName): thing is Thing & Record<PropertyName, unknown>;
+
 // @public
 export type UnknownObject = {
     [s: string]: unknown;

diff --git a/sdk/core/core-util/src/index.ts b/sdk/core/core-util/src/index.ts
@@ -7,3 +7,4 @@ export { getRandomIntegerInclusive } from "./random";
 export { isObject, UnknownObject } from "./object";
 export { isError, getErrorMessage } from "./error";
 export { computeSha256Hash, computeSha256Hmac } from "./sha256";
+export { isDefined, isObjectWithProperties, objectHasProperty } from "./typeGuards";
diff --git a/sdk/core/core-client-rest/src/typeGuards.ts → sdk/core/core-util/src/typeGuards.ts b/sdk/core/core-client-rest/src/typeGuards.ts → sdk/core/core-util/src/typeGuards.ts
@@ -4,7 +4,6 @@
 /**
  * Helper TypeGuard that checks if something is defined or not.
  * @param thing - Anything
- * @internal
  */
 export function isDefined<T>(thing: T | undefined | null): thing is T {
   return typeof thing !== "undefined" && thing !== null;
@@ -14,7 +13,6 @@ export function isDefined<T>(thing: T | undefined | null): thing is T {
  * Helper TypeGuard that checks if the input is an object with the specified properties.
  * @param thing - Anything.
  * @param properties - The name of the properties that should appear in the object.
- * @internal
  */
 export function isObjectWithProperties<Thing, PropertyName extends string>(
   thing: Thing,
@@ -37,11 +35,12 @@ export function isObjectWithProperties<Thing, PropertyName extends string>(
  * Helper TypeGuard that checks if the input is an object with the specified property.
  * @param thing - Any object.
  * @param property - The name of the property that should appear in the object.
- * @internal
  */
-function objectHasProperty<Thing, PropertyName extends string>(
+export function objectHasProperty<Thing, PropertyName extends string>(
   thing: Thing,
   property: PropertyName
 ): thing is Thing & Record<PropertyName, unknown> {
-  return typeof thing === "object" && property in (thing as Record<string, unknown>);
+  return (
+    isDefined(thing) && typeof thing === "object" && property in (thing as Record<string, unknown>)
+  );
 }