@microsoft/agents-hosting 1.9.0-beta.3.gb2d23c1c44 → 1.9.1

package/src/storage/memoryStorage.ts

@@ -3,66 +3,94 @@
  * Licensed under the MIT License.
  */
 
-import { trace } from '@microsoft/agents-telemetry'
 import { ExceptionHelper } from '@microsoft/agents-activity'
-import { StorageTraceDefinitions } from '../observability'
-import { Storage, StoreItem } from './storage'
-import { debug } from '@microsoft/agents-telemetry'
+import { debug, redactString, trace } from '@microsoft/agents-telemetry'
 import { Errors } from '../errorHelper'
+import { StorageTraceDefinitions } from '../observability'
+import { getStorageWriteExpiry } from './storageExpiry'
+import {
+  StorageDeleteOptions,
+  StorageDeleteResults,
+  StorageOperationStatus,
+  StorageReadResults,
+  StorageWriteMode,
+  StorageWriteOptions,
+  StorageWriteResults,
+  Storage,
+  StorageV2,
+  StoreItem,
+} from './storage'
 
 const logger = debug('agents:memory-storage')
 
-/**
- * A simple in-memory storage provider that implements the Storage interface.
- *
- * @remarks
- * This class provides a volatile storage solution that keeps data in memory,
- * which means data is lost when the process terminates. It's primarily useful for:
- * - Development and testing scenarios
- * - Simple applications that don't require data persistence across restarts
- * - Stateless environments where external storage isn't available
- *
- * MemoryStorage supports optimistic concurrency control through eTags and
- * can be used as a singleton through the {@link MemoryStorage.getSingleInstance | getSingleInstance() method} to
- * share state across different parts of an application.
- */
-export class MemoryStorage implements Storage {
-  private static instance: MemoryStorage
-  /**
-   * Counter used to generate unique eTags for stored items
-   */
-  private etag: number = 1
+interface MemoryStorageState {
+  memory: { [key: string]: string };
+  versions: { [key: string]: string };
+  expirations: { [key: string]: number };
+  etag: number;
+}
 
-  /**
-   * Creates a new instance of the MemoryStorage class.
-   *
-   * @param memory An optional initial memory store to seed the storage with data
-   */
-  constructor (private memory: { [k: string]: string } = {}) { }
+class MemoryStorageInternals {
+  private static readonly states = new WeakMap<object, MemoryStorageState>()
+
+  readonly state: MemoryStorageState
 
   /**
-   * Gets a single shared instance of the MemoryStorage class.
-   *
-   * @returns The singleton instance of MemoryStorage
-   *
-   * @remarks
-   * Using this method ensures that the same storage instance is used across
-   * the application, allowing for shared state without passing references.
-   *
+   * Creates an internal in-memory provider for the selected storage contract.
    */
-  static getSingleInstance (): MemoryStorage {
-    if (!MemoryStorage.instance) {
-      MemoryStorage.instance = new MemoryStorage()
+  constructor (memory: { [key: string]: string } = {}) {
+    let state = MemoryStorageInternals.states.get(memory)
+    if (!state) {
+      state = { memory, versions: {}, expirations: {}, etag: getNextETag(memory) }
+      MemoryStorageInternals.states.set(memory, state)
     }
-    return MemoryStorage.instance
+    this.state = state
+  }
+
+  save (key: string, item: unknown, expiresAt?: number): string {
+    const version = (this.state.etag++).toString()
+    this.state.memory[key] = JSON.stringify(item)
+    this.state.versions[key] = version
+    if (expiresAt === undefined) delete this.state.expirations[key]
+    else this.state.expirations[key] = expiresAt
+    return version
+  }
+
+  getVersion (key: string, value: StoreItem): string | undefined {
+    return this.state.versions[key] ?? value.eTag as string | undefined
+  }
+
+  isExpired (key: string): boolean {
+    const expiresAt = this.state.expirations[key]
+    return expiresAt !== undefined && expiresAt <= Date.now()
+  }
+
+  remove (key: string): void {
+    delete this.state.memory[key]
+    delete this.state.versions[key]
+    delete this.state.expirations[key]
+  }
+}
+
+/**
+ * A simple in-memory storage provider for development and testing.
+ *
+ * This class implements the legacy {@link Storage} contract. Use
+ * {@link MemoryStorageV2} for the structured StorageV2 contract.
+ */
+export class MemoryStorage extends MemoryStorageInternals implements Storage {
+  private static instance: MemoryStorage
+
+  constructor (memory: { [key: string]: string } = {}) {
+    super(memory)
   }
 
   /**
-   * Reads storage items from memory.
+   * Reads legacy items from process-local memory.
    *
-   * @param keys The keys of the items to read
-   * @returns A promise that resolves to the read items
-   * @throws Will throw an error if keys are not provided or the array is empty
+   * @param keys The keys to read; must not be empty.
+   * @returns Existing items keyed by storage key. Missing keys are omitted and returned items
+   * include their legacy `eTag`.
    */
   async read (keys: string[]): Promise<StoreItem> {
     return trace(StorageTraceDefinitions.read, async ({ record }) => {
@@ -74,85 +102,240 @@ export class MemoryStorage implements Storage {
       const data: StoreItem = {}
       for (const key of keys) {
         logger.debug(`Reading key: ${key}`)
-        const item = this.memory[key]
+        const item = this.state.memory[key]
         if (item) {
-          data[key] = JSON.parse(item)
+          const value = JSON.parse(item)
+          const version = this.getVersion(key, value)
+          data[key] = version === undefined ? value : { ...value, eTag: version }
         }
       }
-
       return data
     })
   }
 
   /**
-   * Writes storage items to memory.
-   *
-   * @param changes The items to write, indexed by key
-   * @returns A promise that resolves when the write operation is complete
-   * @throws Will throw an error if changes are not provided or if there's an eTag conflict
+   * Writes legacy items to process-local memory.
    *
-   * @remarks
-   * This method supports optimistic concurrency control through eTags.
-   * If an item has an eTag, it will only be updated if the existing item
-   * has the same eTag. If an item has an eTag of '*' or no eTag, it will
-   * always be written regardless of the current state.
+   * @param changes The items to write, keyed by storage key.
+   * @throws If `changes` is invalid or an item supplies a stale legacy `eTag`.
    */
   async write (changes: StoreItem): Promise<void> {
     return trace(StorageTraceDefinitions.write, async ({ record }) => {
-      if (!changes || changes.length === 0) {
+      record({ keyCount: changes ? Object.keys(changes).length : undefined })
+      if (!changes || typeof changes !== 'object' || Array.isArray(changes)) {
         throw ExceptionHelper.generateException(ReferenceError, Errors.StorageWriteChangesRequired)
       }
-      record({ keyCount: changes.length })
 
       for (const [key, newItem] of Object.entries(changes)) {
         logger.debug(`Writing key: ${key}`)
-        const oldItemStr = this.memory[key]
+        const oldItemStr = this.state.memory[key]
         if (!oldItemStr || newItem.eTag === '*' || !newItem.eTag) {
-          this.saveItem(key, newItem)
+          const { eTag: _eTag, ...value } = newItem
+          this.save(key, { ...value, eTag: (this.state.etag).toString() })
+          continue
+        }
+        const oldItem = JSON.parse(oldItemStr)
+        if (newItem.eTag === this.getVersion(key, oldItem)) {
+          const { eTag: _eTag, ...value } = newItem
+          this.save(key, { ...value, eTag: (this.state.etag).toString() })
         } else {
-          const oldItem = JSON.parse(oldItemStr)
-          if (newItem.eTag === oldItem.eTag) {
-            this.saveItem(key, newItem)
-          } else {
-            throw ExceptionHelper.generateException(Error, Errors.StorageETagConflict, undefined, { key })
-          }
+          throw ExceptionHelper.generateException(Error, Errors.StorageETagConflict, undefined, { key })
         }
       }
     })
   }
 
   /**
-   * Deletes storage items from memory.
+   * Deletes legacy items from process-local memory.
    *
-   * @param keys The keys of the items to delete
-   * @returns A promise that resolves when the delete operation is complete
+   * @param keys The keys to delete. Missing keys are ignored.
    */
   async delete (keys: string[]): Promise<void> {
     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]
+        this.remove(key)
       }
     })
   }
 
+  static getSingleInstance (): MemoryStorage {
+    if (!MemoryStorage.instance) MemoryStorage.instance = new MemoryStorage()
+    return MemoryStorage.instance
+  }
+}
+
+/**
+ * An in-memory provider for the structured {@link StorageV2} contract.
+ *
+ * Unlike {@link MemoryStorage}, every read returns an outcome for every requested key, and every
+ * write and delete returns an outcome for every supplied key. Storage versions are returned
+ * separately from application values, so an `eTag` property in a value is preserved. Use
+ * {@link StorageWriteMode.CreateOnly}, {@link StorageWriteMode.Replace}, or `expectedVersion` to
+ * guard concurrent writes.
+ *
+ * This provider is intended for development and testing only; state is process-local.
+ */
+export class MemoryStorageV2 extends StorageV2 {
+  private static instance: MemoryStorageV2
+  private readonly internals: MemoryStorageInternals
+
   /**
-   * Saves an item to memory with a new eTag.
+   * Creates a V2 in-memory storage provider.
    *
-   * @param key The key of the item to save
-   * @param item The item to save
+   * @param memory Optional backing store to share with another in-memory storage instance.
+   */
+  constructor (memory: { [key: string]: string } = {}) {
+    super()
+    this.internals = new MemoryStorageInternals(memory)
+  }
+
+  /**
+   * Reads items from process-local memory.
    *
-   * @remarks
-   * This private method handles the details of:
-   * - Creating a clone of the item to prevent modification of the original
-   * - Generating a new eTag for optimistic concurrency control
-   * - Converting the item to a JSON string for storage
+   * @param keys The keys to read. Empty batches are valid.
+   * @returns A result for every key, with `notFound` for missing items and a separate storage
+   * version for successful reads.
+   */
+  async read<T extends object = Record<string, unknown>> (keys: string[]): Promise<StorageReadResults<T>> {
+    return trace(StorageTraceDefinitions.read, async ({ record }) => {
+      record({ keyCount: keys?.length })
+      if (!Array.isArray(keys)) {
+        throw ExceptionHelper.generateException(ReferenceError, Errors.StorageReadKeysRequired)
+      }
+      if (keys.some(key => typeof key !== 'string' || key.trim() === '')) {
+        throw ExceptionHelper.generateException(ReferenceError, Errors.StorageV2KeyRequired)
+      }
+
+      const results: StorageReadResults<T> = {}
+      for (const key of keys) {
+        logger.debug(`Reading key: ${key}`)
+        if (this.internals.isExpired(key)) {
+          logger.info('Item expired, deleting from memory', { key: redactString(key, true) })
+          this.internals.remove(key)
+        }
+        const item = this.internals.state.memory[key]
+        if (!item) {
+          results[key] = { key, status: StorageOperationStatus.NotFound }
+          continue
+        }
+        const value = JSON.parse(item) as T & StoreItem
+        results[key] = { key, status: StorageOperationStatus.Succeeded, value, version: this.internals.getVersion(key, value) }
+      }
+      return results
+    })
+  }
+
+  /**
+   * Writes items to process-local memory with optional concurrency conditions.
+   *
+   * @param changes The values to write, keyed by storage key.
+   * @param options Create-only, replace, or expected-version conditions.
+   * @returns A result for every supplied key, including `conflict` or `conditionNotMet` when a
+   * condition cannot be satisfied.
+   */
+  async write<T extends object = Record<string, unknown>> (changes: Record<string, T>, options?: StorageWriteOptions): Promise<StorageWriteResults> {
+    return trace(StorageTraceDefinitions.write, async ({ record }) => {
+      record({ keyCount: changes ? Object.keys(changes).length : undefined })
+      if (options?.expectedVersion === '') {
+        throw ExceptionHelper.generateException(RangeError, Errors.StorageV2ExpectedVersionEmpty)
+      }
+      if (!changes || typeof changes !== 'object' || Array.isArray(changes)) {
+        throw ExceptionHelper.generateException(ReferenceError, Errors.StorageWriteChangesRequired)
+      }
+      if (Object.values(changes).some(value => value === null || typeof value !== 'object' || Array.isArray(value))) {
+        throw ExceptionHelper.generateException(TypeError, Errors.StorageV2ValueRequired)
+      }
+      if (Object.keys(changes).some(key => key.trim() === '')) {
+        throw ExceptionHelper.generateException(ReferenceError, Errors.StorageV2KeyRequired)
+      }
+
+      const results: StorageWriteResults = {}
+      const expiresAt = getStorageWriteExpiry(options)
+      const mode = options?.mode ?? StorageWriteMode.Upsert
+      if (!Object.values(StorageWriteMode).includes(mode)) {
+        throw ExceptionHelper.generateException(RangeError, Errors.StorageV2WriteModeUnsupported, undefined, { mode: String(mode) })
+      }
+      for (const [key, newItem] of Object.entries(changes)) {
+        if (this.internals.isExpired(key)) {
+          logger.info('Item expired, deleting from memory', { key: redactString(key, true) })
+          this.internals.remove(key)
+        }
+        const oldItemStr = this.internals.state.memory[key]
+        const oldItem = oldItemStr ? JSON.parse(oldItemStr) as StoreItem : undefined
+        const currentVersion = oldItem ? this.internals.getVersion(key, oldItem) : undefined
+        if (mode === StorageWriteMode.CreateOnly && oldItemStr) {
+          results[key] = { key, status: StorageOperationStatus.Conflict, version: currentVersion }
+        } else if (mode === StorageWriteMode.Replace && !oldItemStr) {
+          results[key] = { key, status: StorageOperationStatus.NotFound }
+        } else if (options?.expectedVersion !== undefined && options.expectedVersion !== currentVersion) {
+          results[key] = { key, status: StorageOperationStatus.ConditionNotMet, version: currentVersion }
+        } else {
+          results[key] = { key, status: StorageOperationStatus.Succeeded, version: this.internals.save(key, newItem, expiresAt) }
+        }
+      }
+      return results
+    })
+  }
+
+  /**
+   * Deletes items from process-local memory with an optional version condition.
    *
-   * @private
+   * @param keys The keys to delete. Empty batches are valid.
+   * @param options An optional expected storage version.
+   * @returns A result for every supplied key.
    */
-  private saveItem (key: string, item: unknown): void {
-    const clone = Object.assign({}, item, { eTag: (this.etag++).toString() })
-    this.memory[key] = JSON.stringify(clone)
+  async delete (keys: string[], options?: StorageDeleteOptions): Promise<StorageDeleteResults> {
+    return trace(StorageTraceDefinitions.delete, async ({ record }) => {
+      record({ keyCount: keys?.length })
+      if (options?.expectedVersion === '') {
+        throw ExceptionHelper.generateException(RangeError, Errors.StorageV2ExpectedVersionEmpty)
+      }
+      if (!Array.isArray(keys)) {
+        throw ExceptionHelper.generateException(ReferenceError, Errors.StorageReadKeysRequired)
+      }
+      if (keys.some(key => typeof key !== 'string' || key.trim() === '')) {
+        throw ExceptionHelper.generateException(ReferenceError, Errors.StorageV2KeyRequired)
+      }
+
+      const results: StorageDeleteResults = {}
+      for (const key of keys) {
+        if (this.internals.isExpired(key)) {
+          logger.info('Item expired, deleting from memory', { key: redactString(key, true) })
+          this.internals.remove(key)
+        }
+        const item = this.internals.state.memory[key]
+        if (!item) {
+          results[key] = { key, status: StorageOperationStatus.NotFound }
+          continue
+        }
+        const value = JSON.parse(item) as StoreItem
+        const version = this.internals.getVersion(key, value)
+        if (options?.expectedVersion !== undefined && options.expectedVersion !== version) {
+          results[key] = { key, status: StorageOperationStatus.ConditionNotMet, version }
+          continue
+        }
+        this.internals.remove(key)
+        results[key] = { key, status: StorageOperationStatus.Succeeded, version }
+      }
+      return results
+    })
+  }
+
+  static getSingleInstance (): MemoryStorageV2 {
+    if (!MemoryStorageV2.instance) MemoryStorageV2.instance = new MemoryStorageV2()
+    return MemoryStorageV2.instance
   }
 }
+
+function getNextETag (memory: { [key: string]: string }): number {
+  return Object.values(memory).reduce((next, item) => {
+    try {
+      const version = Number(JSON.parse(item)?.eTag)
+      return Number.isSafeInteger(version) && version >= next ? version + 1 : next
+    } catch {
+      return next
+    }
+  }, 1)
+}

package/src/storage/storage.ts

@@ -63,7 +63,7 @@ export interface StoreItems {
 export type StorageKeyFactory = (context: TurnContext) => string | Promise<string>
 
 /**
- * Defines the interface for storage operations in the Agents platform.
+ * Defines the version 1 interface for storage operations in the Agents platform.
  *
  * @remarks
  * Storage providers persist state data across conversation turns, enabling
@@ -72,7 +72,9 @@ export type StorageKeyFactory = (context: TurnContext) => string | Promise<strin
  *
  * The interface is designed to be simple with just three core operations:
  * read, write, and delete. All operations are asynchronous to support both
- * in-memory and remote storage providers.
+ * in-memory and remote storage providers. New implementations should use
+ * {@link StorageV2}; this V1 interface remains supported by
+ * {@link StorageProvider} through a compatibility adapter.
  */
 export interface Storage {
   /**
@@ -101,3 +103,113 @@ export interface Storage {
    */
   delete: (keys: string[]) => Promise<void>;
 }
+
+/**
+ * The result of a version 2 storage read operation.
+ *
+ * A result is returned for every requested key. `value` and `version` are
+ * available when `status` is {@link StorageOperationStatus.Succeeded}.
+ */
+export interface StorageReadResult<T extends object = Record<string, unknown>> {
+  key: string;
+  status: StorageOperationStatus;
+  value?: T;
+  version?: string;
+}
+
+/**
+ * The result of a version 2 storage write operation.
+ */
+export interface StorageWriteResult {
+  key: string;
+  status: StorageOperationStatus;
+  version?: string;
+}
+
+/**
+ * The result of a version 2 storage delete operation.
+ */
+export interface StorageDeleteResult {
+  key: string;
+  status: StorageOperationStatus;
+  version?: string;
+}
+
+/** A keyed set of storage read results. */
+export type StorageReadResults<T extends object = Record<string, unknown>> = Record<string, StorageReadResult<T>>
+
+/** A keyed set of storage write results. */
+export type StorageWriteResults = Record<string, StorageWriteResult>
+
+/** A keyed set of storage delete results. */
+export type StorageDeleteResults = Record<string, StorageDeleteResult>
+
+/** The outcome of one version 2 storage operation. */
+export enum StorageOperationStatus {
+  Succeeded = 'succeeded',
+  NotFound = 'notFound',
+  Conflict = 'conflict',
+  ConditionNotMet = 'conditionNotMet',
+}
+
+/** The write mode for a version 2 storage operation. */
+export enum StorageWriteMode {
+  Upsert = 'upsert',
+  CreateOnly = 'createOnly',
+  Replace = 'replace',
+}
+
+/** Options applied to every item in a version 2 write operation. */
+export interface StorageWriteOptions {
+  /**
+   * Optional time to live, in seconds, for written items.
+   *
+   * When set, storage providers stop returning the written items after this
+   * duration has elapsed. Values must be finite numbers greater than zero.
+   */
+  ttl?: number;
+  mode?: StorageWriteMode;
+  expectedVersion?: string;
+}
+
+/** Options applied to every item in a version 2 delete operation. */
+export interface StorageDeleteOptions {
+  expectedVersion?: string;
+}
+
+/**
+ * The version 2 storage contract.
+ *
+ * This does not extend {@link Storage}: JavaScript cannot overload methods by
+ * return type at runtime. V2 providers are exposed as separately named classes.
+ */
+export abstract class StorageV2 {
+  /**
+   * Reads stored values and returns one result for every requested key.
+   *
+   * @param keys The keys to read. An empty array is valid.
+   * @returns Keyed results containing a value and storage version when found.
+   */
+  abstract read<T extends object = Record<string, unknown>> (keys: string[]): Promise<StorageReadResults<T>>
+
+  /**
+   * Writes values with optional create, replace, or version conditions.
+   *
+   * @param changes Values indexed by their storage keys.
+   * @param options Conditions applied to every value in the batch.
+   * @returns One result for every supplied key.
+   */
+  abstract write<T extends object = Record<string, unknown>> (changes: Record<string, T>, options?: StorageWriteOptions): Promise<StorageWriteResults>
+
+  /**
+   * Deletes values with an optional version condition.
+   *
+   * @param keys The keys to delete. An empty array is valid.
+   * @param options Conditions applied to every key in the batch.
+   * @returns One result for every supplied key.
+   */
+  abstract delete (keys: string[], options?: StorageDeleteOptions): Promise<StorageDeleteResults>
+}
+
+/** A storage implementation supported by public hosting interfaces. */
+export type StorageProvider = Storage | StorageV2