chore: replace stdlib assertions with zod (#3859)

Fixes #3670

libraries/botbuilder-ai/package.json

@@ -34,7 +34,6 @@
     "botbuilder-dialogs": "4.1.6",
     "botbuilder-dialogs-adaptive-runtime-core": "4.1.6",
     "botbuilder-dialogs-declarative": "4.1.6",
-    "botbuilder-stdlib": "4.1.6",
     "lodash": "^4.17.21",
     "node-fetch": "^2.6.0",
     "url-parse": "^1.5.1",

libraries/botbuilder-ai/src/qnaMakerDialog.ts

@@ -5,6 +5,14 @@
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License.
  */
+
+import * as z from 'zod';
+import { ActiveLearningUtils, BindToActivity } from './qnamaker-utils';
+import { Activity, ActivityTypes, MessageFactory } from 'botbuilder-core';
+import { QnACardBuilder } from './qnaCardBuilder';
+import { QnAMaker, QnAMakerResult } from './';
+import { QnAMakerClient, QnAMakerClientKey } from './qnaMaker';
+
 import {
     ArrayExpression,
     ArrayExpressionConverter,
@@ -20,7 +28,7 @@ import {
     StringExpression,
     StringExpressionConverter,
 } from 'adaptive-expressions';
-import { Activity, ActivityTypes, MessageFactory } from 'botbuilder-core';
+
 import {
     Converter,
     ConverterFactory,
@@ -36,10 +44,7 @@ import {
     TurnPath,
     WaterfallStepContext,
 } from 'botbuilder-dialogs';
-import { assert, Test, tests } from 'botbuilder-stdlib';
-import { QnAMaker, QnAMakerResult } from './';
-import { QnACardBuilder } from './qnaCardBuilder';
-import { QnAMakerClient, QnAMakerClientKey } from './qnaMaker';
+
 import {
     FeedbackRecord,
     FeedbackRecords,
@@ -48,7 +53,6 @@ import {
     QnAMakerOptions,
     RankerTypes,
 } from './qnamaker-interfaces';
-import { ActiveLearningUtils, BindToActivity } from './qnamaker-utils';
 
 class QnAMakerDialogActivityConverter
     implements Converter<string, TemplateInterface<Partial<Activity>, DialogStateManager>> {
@@ -124,9 +128,9 @@ export interface QnAMakerDialogConfiguration extends DialogConfiguration {
  */
 export type QnASuggestionsActivityFactory = (suggestionsList: string[], noMatchesText: string) => Partial<Activity>;
 
-const isSuggestionsFactory: Test<QnASuggestionsActivityFactory> = (val): val is QnASuggestionsActivityFactory => {
-    return tests.isFunc(val);
-};
+const qnaSuggestionsActivityFactory = z.custom<QnASuggestionsActivityFactory>((val) => typeof val === 'function', {
+    message: 'QnASuggestionsActivityFactory',
+});
 
 /**
  * A dialog that supports multi-step and adaptive-learning QnA Maker services.
@@ -375,7 +379,7 @@ export class QnAMakerDialog extends WaterfallDialog implements QnAMakerDialogCon
         if (top) {
             this.top = new IntExpression(top);
         }
-        if (isSuggestionsFactory(activeLearningTitleOrFactory)) {
+        if (qnaSuggestionsActivityFactory.check(activeLearningTitleOrFactory)) {
             if (!cardNoMatchText) {
                 // Without a developer-provided cardNoMatchText, the end user will not be able to tell the convey to the bot and QnA Maker that the suggested alternative questions were not correct.
                 // When the user's reply to a suggested alternatives Activity matches the cardNoMatchText, the QnAMakerDialog sends this information to the QnA Maker service for active learning.
@@ -710,7 +714,7 @@ export class QnAMakerDialog extends WaterfallDialog implements QnAMakerDialogCon
                         dialogOptions.qnaDialogResponseOptions.cardNoMatchText
                     );
 
-                assert.object(message, ['suggestionsActivity']);
+                z.record(z.unknown()).parse(message, { path: ['message'] });
                 await step.context.sendActivity(message);
 
                 step.activeDialog.state[this.options] = dialogOptions;

libraries/botbuilder-ai/tests/qnaMakerDialog.test.js

@@ -1,9 +1,12 @@
 const fs = require('fs');
 const nock = require('nock');
 const sinon = require('sinon');
-const { ok, rejects, strictEqual, throws } = require('assert');
-const { join } = require('path');
 const { BoolExpression } = require('adaptive-expressions');
+const { Dialog, DialogSet, DialogTurnStatus, DialogManager, ScopePath } = require('botbuilder-dialogs');
+const { QnAMakerDialog, QnAMaker, QnACardBuilder } = require('..');
+const { join } = require('path');
+const { ok, rejects, strictEqual, throws } = require('assert');
+
 const {
     ActionTypes,
     ActivityTypes,
@@ -13,8 +16,6 @@ const {
     MessageFactory,
     TestAdapter,
 } = require('botbuilder-core');
-const { Dialog, DialogSet, DialogTurnStatus, DialogManager, ScopePath } = require('botbuilder-dialogs');
-const { QnAMakerDialog, QnAMaker, QnACardBuilder } = require('../lib');
 
 const KB_ID = process.env.QNAKNOWLEDGEBASEID;
 const ENDPOINT_KEY = process.env.QNAENDPOINTKEY;
@@ -439,7 +440,9 @@ describe('QnAMakerDialog', function () {
 
             await rejects(
                 adapter.send('QnaMaker_TopNAnswer.json').startTest(),
-                (thrown) => thrown.message === '`suggestionsActivity` must be of type "object"'
+                (thrown) =>
+                    thrown.message.includes('invalid_type at message') &&
+                    thrown.message.includes('Expected object, received number')
             );
         });
 
@@ -477,7 +480,7 @@ describe('QnAMakerDialog', function () {
 
             await rejects(
                 adapter.send('QnaMaker_TopNAnswer.json').startTest(),
-                (thrown) => thrown.message === '`suggestionsActivity` must be defined'
+                (thrown) => thrown.message.includes('invalid_type at message') && thrown.message.includes('Required')
             );
 
             sandbox.verify();

libraries/botbuilder-core/etc/botbuilder-core.api.md

@@ -8,7 +8,6 @@ import { Activity } from 'botframework-schema';
 import { AdaptiveCardInvokeResponse } from 'botframework-schema';
 import { AdaptiveCardInvokeValue } from 'botframework-schema';
 import { AnimationCard } from 'botframework-schema';
-import { Assertion } from 'botbuilder-stdlib';
 import { Attachment } from 'botframework-schema';
 import { AudioCard } from 'botframework-schema';
 import { AuthenticateRequestResult } from 'botframework-connector';
@@ -128,11 +127,15 @@ export class ActivityHandlerBase {
     run(context: TurnContext): Promise<void>;
 }
 
-// @public (undocumented)
-export const assertBotComponent: Assertion<BotComponent>;
+// Warning: (ae-internal-missing-underscore) The name "assertBotComponent" should be prefixed with an underscore because the declaration is marked as @internal
+//
+// @internal @deprecated (undocumented)
+export function assertBotComponent(val: unknown, ..._args: unknown[]): asserts val is BotComponent;
 
-// @public (undocumented)
-export const assertStoreItems: Assertion<StoreItems>;
+// Warning: (ae-internal-missing-underscore) The name "assertStoreItems" should be prefixed with an underscore because the declaration is marked as @internal
+//
+// @internal @deprecated (undocumented)
+export function assertStoreItems(val: unknown, ..._args: unknown[]): asserts val is StoreItem;
 
 // @public
 export class AutoSaveStateMiddleware implements Middleware {
@@ -174,6 +177,8 @@ export const BotCallbackHandlerKey = "botCallbackHandler";
 export abstract class BotComponent {
     // (undocumented)
     abstract configureServices(services: ServiceCollection, configuration: Configuration): void;
+    // (undocumented)
+    static z: z.ZodType<BotComponent, z.ZodTypeDef>;
 }
 
 export { BotFrameworkClient }

libraries/botbuilder-core/src/botComponent.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-import { Assertion, assert } from 'botbuilder-stdlib';
+import * as z from 'zod';
 import { Configuration, ServiceCollection } from 'botbuilder-dialogs-adaptive-runtime-core';
 
 /**
@@ -12,10 +12,19 @@ import { Configuration, ServiceCollection } from 'botbuilder-dialogs-adaptive-ru
  * gets called automatically on the components by the bot runtime, as long as the components are registered in the configuration.
  */
 export abstract class BotComponent {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    static z = z.custom<BotComponent>((val: any) => typeof val.configureServices === 'function', {
+        message: 'BotComponent',
+    });
+
     abstract configureServices(services: ServiceCollection, configuration: Configuration): void;
 }
 
-export const assertBotComponent: Assertion<BotComponent> = (val, path) => {
-    assert.unsafe.castObjectAs<BotComponent>(val, path);
-    assert.func(val.configureServices, path.concat('configureServices'));
-};
+/**
+ * @internal
+ *
+ * @deprecated Use `BotComponent.z.parse()` instead.
+ */
+export function assertBotComponent(val: unknown, ..._args: unknown[]): asserts val is BotComponent {
+    BotComponent.z.parse(val);
+}

libraries/botbuilder-core/src/storage.ts

@@ -5,16 +5,19 @@
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the MIT License.
  */
+
+import * as z from 'zod';
 import { TurnContext } from './turnContext';
-import { Assertion, assert } from 'botbuilder-stdlib';
 
 /**
  * Callback to calculate a storage key.
  *
  * ```TypeScript
  * type StorageKeyFactory = (context: TurnContext) => Promise<string>;
  * ```
+ *
  * @param StorageKeyFactory.context Context for the current turn of conversation with a user.
+ * @returns A promise resolving to the storage key string
  */
 export type StorageKeyFactory = (context: TurnContext) => Promise<string>;
 
@@ -71,7 +74,7 @@ export interface StoreItem {
     /**
      * Key/value pairs.
      */
-    [key: string]: any;
+    [key: string]: any; // eslint-disable-line @typescript-eslint/no-explicit-any
 
     /**
      * (Optional) eTag field for stores that support optimistic concurrency.
@@ -86,12 +89,19 @@ export interface StoreItems {
     /**
      * List of store items indexed by key.
      */
-    [key: string]: any;
+    [key: string]: any; // eslint-disable-line @typescript-eslint/no-explicit-any
 }
 
-export const assertStoreItems: Assertion<StoreItems> = (val, path) => {
-    assert.object(val, path);
-};
+const storeItems = z.record(z.unknown());
+
+/**
+ * @internal
+ *
+ * @deprecated Use `zod.record(zod.unknown())` instead.
+ */
+export function assertStoreItems(val: unknown, ..._args: unknown[]): asserts val is StoreItem {
+    storeItems.parse(val);
+}
 
 /**
  * Utility function to calculate a change hash for a `StoreItem`.
@@ -112,10 +122,12 @@ export const assertStoreItems: Assertion<StoreItems> = (val, path) => {
  *    await storage.write({ 'botState': state });
  * }
  * ```
+ *
  * @param item Item to calculate the change hash for.
+ * @returns change hash string
  */
 export function calculateChangeHash(item: StoreItem): string {
-    const cpy: any = { ...item };
+    const cpy = { ...item };
     if (cpy.eTag) {
         delete cpy.eTag;
     }

libraries/botbuilder-dialogs-adaptive-runtime/src/index.ts

@@ -53,7 +53,6 @@ import {
     TelemetryLoggerMiddleware,
     TranscriptLoggerMiddleware,
     UserState,
-    assertBotComponent,
     createBotFrameworkAuthenticationFromConfiguration,
 } from 'botbuilder';
 
@@ -390,9 +389,12 @@ async function addSettingsBotComponents(services: ServiceCollection, configurati
         }
 
         const instance = new DefaultExport();
-        assertBotComponent(instance, [`import(${name})`, 'default']);
 
-        return instance;
+        try {
+            return BotComponent.z.parse(instance);
+        } catch (err) {
+            throw new Error(`${name} does not extend BotComponent: ${err}`);
+        }
     };
 
     const components =

libraries/botbuilder-dialogs-adaptive-testing/etc/botbuilder-dialogs-adaptive-testing.api.md

@@ -313,7 +313,7 @@ export class UserActivity extends TestAction implements UserActivityConfiguratio
     // (undocumented)
     static $kind: string;
     activity: Activity;
-    execute(testAdapter: TestAdapter, callback: (context: TurnContext) => Promise<void>, inspector?: Inspector): Promise<void>;
+    execute(testAdapter: TestAdapter, callback: (context: TurnContext) => Promise<void>, _inspector?: Inspector): Promise<void>;
     user: string;
 }
 

libraries/botbuilder-dialogs-adaptive-testing/package.json

@@ -34,7 +34,8 @@
     "botbuilder-stdlib": "4.1.6",
     "murmurhash-js": "^1.0.0",
     "nock": "^11.9.1",
-    "url-parse": "^1.5.1"
+    "url-parse": "^1.5.1",
+    "zod": "~1.11.17"
   },
   "devDependencies": {
     "@microsoft/recognizers-text-suite": "1.1.4",

libraries/botbuilder-dialogs-adaptive-testing/src/testActions/userActivity.ts

@@ -6,9 +6,9 @@
  * Licensed under the MIT License.
  */
 
+import * as z from 'zod';
 import { Activity, TurnContext, TestAdapter } from 'botbuilder-core';
 import { Inspector, TestAction } from '../testAction';
-import { tests } from 'botbuilder-stdlib';
 
 export interface UserActivityConfiguration {
     activity?: Activity;
@@ -33,15 +33,16 @@ export class UserActivity extends TestAction implements UserActivityConfiguratio
 
     /**
      * Execute the test.
+     *
      * @param testAdapter Adapter to execute against.
      * @param callback Logic for the bot to use.
-     * @param inspector Inspector for dialog context.
+     * @param _inspector Inspector for dialog context.
      * @returns A Promise that represents the work queued to execute.
      */
     public async execute(
         testAdapter: TestAdapter,
         callback: (context: TurnContext) => Promise<void>,
-        inspector?: Inspector
+        _inspector?: Inspector
     ): Promise<void> {
         if (!this.activity) {
             throw new Error('You must define one of Text of Activity properties');
@@ -62,7 +63,7 @@ export class UserActivity extends TestAction implements UserActivityConfiguratio
             activity.from = { ...activity.from };
             activity.from.id = this.user;
             activity.from.name = this.user;
-        } else if (tests.isObject(this.activity?.from)) {
+        } else if (z.record(z.unknown()).check(this.activity?.from)) {
             activity.from = { ...this.activity.from };
         }
 

libraries/botbuilder-dialogs-declarative/package.json

@@ -31,7 +31,8 @@
     "botbuilder-core": "4.1.6",
     "botbuilder-dialogs": "4.1.6",
     "botbuilder-stdlib": "4.1.6",
-    "chokidar": "^3.4.0"
+    "chokidar": "^3.4.0",
+    "zod": "~1.11.17"
   },
   "devDependencies": {
     "adaptive-expressions": "4.1.6",

libraries/botbuilder-dialogs-declarative/src/componentDeclarativeTypes.ts

@@ -6,7 +6,7 @@
  * Licensed under the MIT License.
  */
 
-import { tests } from 'botbuilder-stdlib';
+import * as z from 'zod';
 import { DeclarativeType } from './declarativeType';
 import { ResourceExplorer } from './resources';
 
@@ -17,6 +17,11 @@ export interface ComponentDeclarativeTypes {
     getDeclarativeTypes(resourceExplorer: ResourceExplorer): DeclarativeType[];
 }
 
+const componentDeclarativeTypes = z.custom<ComponentDeclarativeTypes>(
+    (val: any) => typeof val.getDeclarativeTypes === 'function',
+    { message: 'ComponentDeclarativeTypes' }
+);
+
 /**
  * Check if a [ComponentRegistration](xref:botbuilder-core.ComponentRegistration) is
  * [ComponentDeclarativeTypes](xref:botbuilder-dialogs-declarative.ComponentDeclarativeTypes) or not.
@@ -25,5 +30,5 @@ export interface ComponentDeclarativeTypes {
  * @returns {boolean} Type check result.
  */
 export function isComponentDeclarativeTypes(component: unknown): component is ComponentDeclarativeTypes {
-    return tests.unsafe.isObjectAs<ComponentDeclarativeTypes>(component) && tests.isFunc(component.getDeclarativeTypes);
+    return componentDeclarativeTypes.check(component);
 }

libraries/botbuilder-dialogs-declarative/src/resources/resourceExplorer.ts

@@ -14,7 +14,7 @@ import { ResourceProvider, ResourceChangeEvent } from './resourceProvider';
 import { FolderResourceProvider } from './folderResourceProvider';
 import { Resource } from './resource';
 import { PathUtil } from '../pathUtil';
-import { ComponentDeclarativeTypes, isComponentDeclarativeTypes } from '../componentDeclarativeTypes';
+import { ComponentDeclarativeTypes } from '../componentDeclarativeTypes';
 import { DeclarativeType } from '../declarativeType';
 import { CustomDeserializer } from '../customDeserializer';
 import { DefaultLoader } from '../defaultLoader';