@microsoft/agents-hosting 1.5.0-beta.6.ga236d9a19c → 1.5.1

package/src/state/agentState.ts

@@ -7,7 +7,7 @@ import { Storage, StorageKeyFactory, StoreItem } from '../storage/storage'
 import { TurnContext } from '../turnContext'
 import { createHash } from 'node:crypto'
 import { AgentStatePropertyAccessor } from './agentStatePropertyAccesor'
-import { debug } from '@microsoft/agents-activity/logger'
+import { debug } from '@microsoft/agents-telemetry'
 
 const logger = debug('agents:state')
 

package/src/storage/fileStorage.ts

@@ -6,6 +6,8 @@
 import path from 'path'
 import fs from 'fs'
 import { Storage, StoreItem } from './storage'
+import { trace } from '@microsoft/agents-telemetry'
+import { StorageTraceDefinitions } from '../observability'
 
 /**
  * A file-based storage implementation that persists data to the local filesystem.
@@ -91,19 +93,22 @@ export class FileStorage implements Storage {
    *
    */
   read (keys: string[]) : Promise<StoreItem> {
-    return new Promise((resolve, reject) => {
-      if (!keys || keys.length === 0) {
-        reject(new ReferenceError('Keys are required when reading.'))
-      } else {
-        const data: StoreItem = {}
-        for (const key of keys) {
-          const item = this._stateFile[key]
-          if (item) {
-            data[key] = item
+    return trace(StorageTraceDefinitions.read, async ({ record }) => {
+      record({ keyCount: keys?.length })
+      return new Promise<StoreItem>((resolve, reject) => {
+        if (!keys || keys.length === 0) {
+          reject(new ReferenceError('Keys are required when reading.'))
+        } else {
+          const data: StoreItem = {}
+          for (const key of keys) {
+            const item = this._stateFile[key]
+            if (item) {
+              data[key] = item
+            }
           }
+          resolve(data)
         }
-        resolve(data)
-      }
+      })
     })
   }
 
@@ -124,12 +129,14 @@ export class FileStorage implements Storage {
    *
    */
   write (changes: StoreItem) : Promise<void> {
-    const keys = Object.keys(changes)
-    for (const key of keys) {
-      this._stateFile[key] = changes[key]
-    }
-    fs.writeFileSync(this._folder + '/state.json', JSON.stringify(this._stateFile, null, 2))
-    return Promise.resolve()
+    return trace(StorageTraceDefinitions.write, async ({ record }) => {
+      const keys = Object.keys(changes)
+      record({ keyCount: keys?.length })
+      for (const key of keys) {
+        this._stateFile[key] = changes[key]
+      }
+      fs.writeFileSync(this._folder + '/state.json', JSON.stringify(this._stateFile, null, 2))
+    })
   }
 
   /**
@@ -147,16 +154,19 @@ export class FileStorage implements Storage {
    *
    */
   delete (keys: string[]) : Promise<void> {
-    return new Promise((resolve, reject) => {
-      if (!keys || keys.length === 0) {
-        reject(new ReferenceError('Keys are required when deleting.'))
-      } else {
-        for (const key of keys) {
-          delete this._stateFile[key]
+    return trace(StorageTraceDefinitions.delete, async ({ record }) => {
+      record({ keyCount: keys?.length })
+      return new Promise<void>((resolve, reject) => {
+        if (!keys || keys.length === 0) {
+          reject(new ReferenceError('Keys are required when deleting.'))
+        } else {
+          for (const key of keys) {
+            delete this._stateFile[key]
+          }
+          fs.writeFileSync(this._folder + '/state.json', JSON.stringify(this._stateFile, null, 2))
+          resolve(undefined)
         }
-        fs.writeFileSync(this._folder + '/state.json', JSON.stringify(this._stateFile, null, 2))
-      }
-      resolve()
+      })
     })
   }
 }

package/src/storage/memoryStorage.ts

@@ -3,8 +3,10 @@
  * Licensed under the MIT License.
  */
 
+import { trace } from '@microsoft/agents-telemetry'
+import { StorageTraceDefinitions } from '../observability'
 import { Storage, StoreItem } from './storage'
-import { debug } from '@microsoft/agents-activity/logger'
+import { debug } from '@microsoft/agents-telemetry'
 
 const logger = debug('agents:memory-storage')
 
@@ -61,20 +63,23 @@ export class MemoryStorage implements Storage {
    * @throws Will throw an error if keys are not provided or the array is empty
    */
   async read (keys: string[]): Promise<StoreItem> {
-    if (!keys || keys.length === 0) {
-      throw new ReferenceError('Keys are required when reading.')
-    }
+    return trace(StorageTraceDefinitions.read, async ({ record }) => {
+      record({ keyCount: keys?.length })
+      if (!keys || keys.length === 0) {
+        throw new ReferenceError('Keys are required when reading.')
+      }
 
-    const data: StoreItem = {}
-    for (const key of keys) {
-      logger.debug(`Reading key: ${key}`)
-      const item = this.memory[key]
-      if (item) {
-        data[key] = JSON.parse(item)
+      const data: StoreItem = {}
+      for (const key of keys) {
+        logger.debug(`Reading key: ${key}`)
+        const item = this.memory[key]
+        if (item) {
+          data[key] = JSON.parse(item)
+        }
       }
-    }
 
-    return data
+      return data
+    })
   }
 
   /**
@@ -91,24 +96,27 @@ export class MemoryStorage implements Storage {
    * always be written regardless of the current state.
    */
   async write (changes: StoreItem): Promise<void> {
-    if (!changes || changes.length === 0) {
-      throw new ReferenceError('Changes are required when writing.')
-    }
+    return trace(StorageTraceDefinitions.write, async ({ record }) => {
+      if (!changes || changes.length === 0) {
+        throw new ReferenceError('Changes are required when writing.')
+      }
+      record({ keyCount: changes.length })
 
-    for (const [key, newItem] of Object.entries(changes)) {
-      logger.debug(`Writing key: ${key}`)
-      const oldItemStr = this.memory[key]
-      if (!oldItemStr || newItem.eTag === '*' || !newItem.eTag) {
-        this.saveItem(key, newItem)
-      } else {
-        const oldItem = JSON.parse(oldItemStr)
-        if (newItem.eTag === oldItem.eTag) {
+      for (const [key, newItem] of Object.entries(changes)) {
+        logger.debug(`Writing key: ${key}`)
+        const oldItemStr = this.memory[key]
+        if (!oldItemStr || newItem.eTag === '*' || !newItem.eTag) {
           this.saveItem(key, newItem)
         } else {
-          throw new Error(`Storage: error writing "${key}" due to eTag conflict.`)
+          const oldItem = JSON.parse(oldItemStr)
+          if (newItem.eTag === oldItem.eTag) {
+            this.saveItem(key, newItem)
+          } else {
+            throw new Error(`Storage: error writing "${key}" due to eTag conflict.`)
+          }
         }
       }
-    }
+    })
   }
 
   /**
@@ -118,10 +126,13 @@ export class MemoryStorage implements Storage {
    * @returns A promise that resolves when the delete operation is complete
    */
   async delete (keys: string[]): Promise<void> {
-    logger.debug(`Deleting keys: ${keys.join(', ')}`)
-    for (const key of keys) {
-      delete this.memory[key]
-    }
+    return trace(StorageTraceDefinitions.delete, async ({ record }) => {
+      record({ keyCount: keys?.length })
+      logger.debug(`Deleting keys: ${keys.join(', ')}`)
+      for (const key of keys) {
+        delete this.memory[key]
+      }
+    })
   }
 
   /**

package/src/transcript/fileTranscriptLogger.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { debug } from '@microsoft/agents-activity/logger'
+import { debug } from '@microsoft/agents-telemetry'
 import { PagedResult, TranscriptInfo } from './transcriptLogger'
 import { TranscriptStore } from './transcriptStore'
 import * as fs from 'fs/promises'

package/src/transcript/transcriptLoggerMiddleware.ts

@@ -3,7 +3,7 @@ import { ResourceResponse } from '../connector-client'
 import { Middleware } from '../middlewareSet'
 import { TranscriptLogger } from './transcriptLogger'
 import { Activity, ActivityEventNames, ActivityTypes, ConversationReference, RoleTypes } from '@microsoft/agents-activity'
-import { debug } from '@microsoft/agents-activity/logger'
+import { debug } from '@microsoft/agents-telemetry'
 
 const appLogger = debug('agents:rest-client')
 

package/src/turnContext.ts

@@ -8,6 +8,8 @@ import { AttachmentInfo } from './connector-client/attachmentInfo'
 import { AttachmentData } from './connector-client/attachmentData'
 import { StreamingResponse } from './app/streaming/streamingResponse'
 import { JwtPayload } from 'jsonwebtoken'
+import { trace } from '@microsoft/agents-telemetry'
+import { TurnContextTraceDefinitions } from './observability'
 
 /**
  * Defines a handler for processing and sending activities.
@@ -166,50 +168,54 @@ export class TurnContext {
    * the adapter.
    */
   async sendActivities (activities: Activity[]): Promise<ResourceResponse[]> {
-    let sentNonTraceActivity = false
-    const ref = this.activity.getConversationReference()
-    const output = activities.map((activity) => {
-      const newActivity = Activity.fromObject(activity)
-      const result = newActivity.applyConversationReference(ref)
-      if (!result.type) {
-        result.type = ActivityTypes.Message
-      }
-      if (result.type === ActivityTypes.InvokeResponse) {
-        this.turnState.set(INVOKE_RESPONSE_KEY, result)
-      }
-      if (result.type !== ActivityTypes.Trace) {
-        sentNonTraceActivity = true
-      }
-      if (result.id) {
-        delete result.id
-      }
-      return result
-    })
-    return await this.emit(this._onSendActivities, output, async () => {
-      if (this.activity.deliveryMode === DeliveryModes.ExpectReplies) {
-        const responses: ResourceResponse[] = []
-        output.forEach((a) => {
-          this.bufferedReplyActivities.push(a)
-          if (a.type === ActivityTypes.InvokeResponse) {
-            this.turnState.set(INVOKE_RESPONSE_KEY, a)
-          }
-          responses.push({ id: '' })
-        })
-        if (sentNonTraceActivity) {
-          this.responded = true
+    return trace(TurnContextTraceDefinitions.sendActivities, async ({ record, actions }) => {
+      record({ activityCount: activities?.length })
+      let sentNonTraceActivity = false
+      const ref = this.activity.getConversationReference()
+      const output = activities.map((activity) => {
+        actions.recordActivity(activity)
+        const newActivity = Activity.fromObject(activity)
+        const result = newActivity.applyConversationReference(ref)
+        if (!result.type) {
+          result.type = ActivityTypes.Message
         }
-        return responses
-      } else {
-        const responses = await this.adapter.sendActivities(this, output)
-        for (let index = 0; index < responses?.length; index++) {
-          const activity = output[index]
-          activity.id = responses[index].id
+        if (result.type === ActivityTypes.InvokeResponse) {
+          this.turnState.set(INVOKE_RESPONSE_KEY, result)
         }
-        if (sentNonTraceActivity) {
-          this.responded = true
+        if (result.type !== ActivityTypes.Trace) {
+          sentNonTraceActivity = true
         }
-        return responses
-      }
+        if (result.id) {
+          delete result.id
+        }
+        return result
+      })
+      return await this.emit(this._onSendActivities, output, async () => {
+        if (this.activity.deliveryMode === DeliveryModes.ExpectReplies) {
+          const responses: ResourceResponse[] = []
+          output.forEach((a) => {
+            this.bufferedReplyActivities.push(a)
+            if (a.type === ActivityTypes.InvokeResponse) {
+              this.turnState.set(INVOKE_RESPONSE_KEY, a)
+            }
+            responses.push({ id: '' })
+          })
+          if (sentNonTraceActivity) {
+            this.responded = true
+          }
+          return responses
+        } else {
+          const responses = await this.adapter.sendActivities(this, output)
+          for (let index = 0; index < responses?.length; index++) {
+            const activity = output[index]
+            activity.id = responses[index].id
+          }
+          if (sentNonTraceActivity) {
+            this.responded = true
+          }
+          return responses
+        }
+      })
     })
   }