Keep original request object

Author: compulim

packages/api-middleware/src/index.ts

@@ -42,5 +42,6 @@ export {
 } from './errorBoxPolymiddleware';
 
 // TODO: [P0] Add tests for nesting `polymiddleware`.
+export { __INTERNAL_DO_NOT_USE__legacyAvatarMiddlewareOriginalRequestSymbol } from './legacy/avatarMiddleware';
 export { default as PolymiddlewareComposer } from './PolymiddlewareComposer';
 export { type Polymiddleware } from './types/Polymiddleware';

packages/api-middleware/src/legacy/avatarMiddleware.ts

@@ -1,8 +1,14 @@
 // TODO: This is moved from /api, need to revisit/rewrite everything in this file.
 import { type WebChatActivity } from 'botframework-webchat-core';
 import { type ReactNode } from 'react';
+import type { AvatarPolymiddlewareRequest } from '../avatarPolymiddleware';
+
+// Polymiddleware requires immutable request object.
+// When bridging between legacy and polymiddlware, this symbol helps keeping the original object.
+const __INTERNAL_DO_NOT_USE__legacyAvatarMiddlewareOriginalRequestSymbol = Symbol();
 
 type LegacyAvatarComponentFactoryArguments = {
+  readonly [__INTERNAL_DO_NOT_USE__legacyAvatarMiddlewareOriginalRequestSymbol]: AvatarPolymiddlewareRequest;
   readonly activity: WebChatActivity;
   readonly fromUser: boolean;
   readonly styleOptions: Readonly<Record<string, unknown>>;
@@ -16,4 +22,8 @@ type LegacyAvatarEnhancer = (
 
 type LegacyAvatarMiddleware = () => LegacyAvatarEnhancer;
 
-export type { LegacyAvatarMiddleware, LegacyAvatarRenderer };
+export {
+  __INTERNAL_DO_NOT_USE__legacyAvatarMiddlewareOriginalRequestSymbol,
+  type LegacyAvatarMiddleware,
+  type LegacyAvatarRenderer
+};

packages/api/src/legacy/createAvatarPolymiddlewareFromLegacy.tsx

@@ -1,5 +1,6 @@
 import {
   __INTERNAL_DO_NOT_USE__avatarPolymiddlewareRequestStyleOptionsSymbol,
+  __INTERNAL_DO_NOT_USE__legacyAvatarMiddlewareOriginalRequestSymbol,
   avatarComponent,
   createAvatarPolymiddleware,
   type AvatarPolymiddleware
@@ -46,37 +47,45 @@ function createAvatarPolymiddlewareFromLegacy(...middlewares: readonly LegacyAva
   const legacyEnhancer = composeEnhancer(...middlewares.map(middleware => middleware()));
 
   return createAvatarPolymiddleware(next => {
-    const legacyHandler = legacyEnhancer(({ activity, fromUser, styleOptions }) => {
-      // Pass styleOptions through the polymiddleware chain via the internal runtime extension
-      // so downstream handlers (e.g. core middleware) can still read it.
-      const handler = next(
-        Object.freeze({
-          activity,
-          fromUser,
-          [__INTERNAL_DO_NOT_USE__avatarPolymiddlewareRequestStyleOptionsSymbol]: styleOptions
-        })
-      );
+    const legacyHandler = legacyEnhancer(
+      ({ [__INTERNAL_DO_NOT_USE__legacyAvatarMiddlewareOriginalRequestSymbol]: originalRequest }) => {
+        if (!originalRequest) {
+          // TODO: Add a test
+          throw new Error('botframework-webchat: `avatarMiddleware` must not modify the request object');
+        }
+
+        // Pass styleOptions through the polymiddleware chain via the internal runtime extension
+        // so downstream handlers (e.g. core middleware) can still read it.
+        const handler = next(originalRequest);
 
-      // TODO: Warn if the result is wrong. Also add tests.
-      // if (result !== false && typeof result !== 'function') {
-      //   console.warn(
-      //     'botframework-webchat: avatarMiddleware should return a function to render the avatar, or return false if avatar should be hidden. Please refer to HOOKS.md for details.'
-      //   );
+        // TODO: Warn if the result is wrong. Also add tests.
+        // if (result !== false && typeof result !== 'function') {
+        //   console.warn(
+        //     'botframework-webchat: avatarMiddleware should return a function to render the avatar, or return false if avatar should be hidden. Please refer to HOOKS.md for details.'
+        //   );
 
-      //   return () => result;
-      // }
+        //   return () => result;
+        // }
 
-      return !!handler && ((): Exclude<ReactNode, boolean | null | undefined> => handler.render({}));
-    });
+        return !!handler && ((): Exclude<ReactNode, boolean | null | undefined> => handler.render({}));
+      }
+    );
 
     return request => {
       const {
+        [__INTERNAL_DO_NOT_USE__avatarPolymiddlewareRequestStyleOptionsSymbol]: styleOptions,
         activity,
-        fromUser,
-        [__INTERNAL_DO_NOT_USE__avatarPolymiddlewareRequestStyleOptionsSymbol]: styleOptions
+        fromUser
       } = request;
 
-      const legacyResult = legacyHandler(Object.freeze({ activity, fromUser, styleOptions }));
+      const legacyResult = legacyHandler(
+        Object.freeze({
+          activity,
+          fromUser,
+          styleOptions,
+          [__INTERNAL_DO_NOT_USE__legacyAvatarMiddlewareOriginalRequestSymbol]: request
+        })
+      );
 
       return legacyResult
         ? avatarComponent(MemoizedLegacyAvatarBridge, Object.freeze({ renderFn: legacyResult }))

packages/api/src/types/AvatarMiddleware.ts

@@ -1,10 +1,15 @@
 import { type WebChatActivity } from 'botframework-webchat-core';
 
+import type {
+  __INTERNAL_DO_NOT_USE__legacyAvatarMiddlewareOriginalRequestSymbol,
+  AvatarPolymiddlewareRequest
+} from '@msinternal/botframework-webchat-api-middleware';
 import { StrictStyleOptions } from '../StyleOptions';
 import ComponentMiddleware, { ComponentFactory } from './ComponentMiddleware';
 
 type AvatarComponentFactoryArguments = [
   {
+    [__INTERNAL_DO_NOT_USE__legacyAvatarMiddlewareOriginalRequestSymbol]: AvatarPolymiddlewareRequest;
     activity: WebChatActivity;
     fromUser: boolean;
     styleOptions: StrictStyleOptions;