Skip to content

@codesoul-co/hypha-memory / memory-server-permanent-migration-fixtures

模块用法

用于编写确定性测试与契约断言。Memory server permanent migration fixtures 模块公开 1 常量、2 函数、2 接口、1 类型。

从包入口导入

ts
import {
  permanentMemoryFailureFixtures,
  createPermanentMemoryMigrationAdapterHarness,
  createReferencePermanentMemoryMigrationHarness,
} from '@codesoul-co/hypha-memory';

import type {
  PermanentMemoryFailureFixture,
  PermanentMemoryMigrationAcceptanceHarness,
  PermanentMemoryMigrationHarnessFactory,
} from '@codesoul-co/hypha-memory';

使用要点

  • 3 个类型/接口用于应用代码、Adapter 或测试中的静态契约;请使用 import type,运行时不应依赖它们。
  • 2 个函数是该模块的直接操作入口;每个 overload 的必需/可选参数与返回类型均在下方列出。
  • 1 个常量/枚举提供稳定值、Schema、Definition 或默认配置;应复用这些导出,避免在应用中复制内部值。

公共导出

Symbol种类签名说明
permanentMemoryFailureFixtures常量const permanentMemoryFailureFixtures: readonly PermanentMemoryFailureFixture[]memory-server-permanent-migration-fixtures 模块导出的 Permanent Memory Failure Fixtures 常量。
createPermanentMemoryMigrationAdapterHarness函数createPermanentMemoryMigrationAdapterHarness(fixture: PermanentMemoryFailureFixture): PermanentMemoryMigrationAcceptanceHarnessCreate Permanent Memory Migration Adapter Harness 函数,提供 1 个公开调用签名;参数与返回类型见下表。
createReferencePermanentMemoryMigrationHarness函数createReferencePermanentMemoryMigrationHarness(fixture: PermanentMemoryFailureFixture): PermanentMemoryMigrationAcceptanceHarnessCreate Reference Permanent Memory Migration Harness 函数,提供 1 个公开调用签名;参数与返回类型见下表。
PermanentMemoryFailureFixture接口interface PermanentMemoryFailureFixturePermanent Memory Failure Fixture 接口,共包含 10 个公开字段或方法。
PermanentMemoryMigrationAcceptanceHarness接口interface PermanentMemoryMigrationAcceptanceHarnessPermanent Memory Migration Acceptance Harness 接口,共包含 2 个公开字段或方法。
PermanentMemoryMigrationHarnessFactory类型type PermanentMemoryMigrationHarnessFactory = (fixture: PermanentMemoryFailureFixture) => PermanentMemoryMigrationAcceptanceHarnessPermanent Memory Migration Harness Factory 公共类型别名;完整类型表达式见声明。

permanentMemoryFailureFixtures

memory-server-permanent-migration-fixtures 模块导出的 Permanent Memory Failure Fixtures 常量。

声明

text
export declare const permanentMemoryFailureFixtures: readonly PermanentMemoryFailureFixture[];

createPermanentMemoryMigrationAdapterHarness

Create Permanent Memory Migration Adapter Harness 函数,提供 1 个公开调用签名;参数与返回类型见下表。

声明

text
export declare function createPermanentMemoryMigrationAdapterHarness(fixture: PermanentMemoryFailureFixture): PermanentMemoryMigrationAcceptanceHarness;

调用签名

text
createPermanentMemoryMigrationAdapterHarness(fixture: PermanentMemoryFailureFixture): PermanentMemoryMigrationAcceptanceHarness

参数

参数类型必需说明
fixturePermanentMemoryFailureFixture必需参数;接受的值由类型列定义。

返回值

  • 类型: PermanentMemoryMigrationAcceptanceHarness
  • 说明: 返回值契约由上述类型定义。

createReferencePermanentMemoryMigrationHarness

Create Reference Permanent Memory Migration Harness 函数,提供 1 个公开调用签名;参数与返回类型见下表。

声明

text
export declare function createReferencePermanentMemoryMigrationHarness(fixture: PermanentMemoryFailureFixture): PermanentMemoryMigrationAcceptanceHarness;

调用签名

text
createReferencePermanentMemoryMigrationHarness(fixture: PermanentMemoryFailureFixture): PermanentMemoryMigrationAcceptanceHarness

参数

参数类型必需说明
fixturePermanentMemoryFailureFixture必需参数;接受的值由类型列定义。

返回值

  • 类型: PermanentMemoryMigrationAcceptanceHarness
  • 说明: 返回值契约由上述类型定义。

PermanentMemoryFailureFixture

Permanent Memory Failure Fixture 接口,共包含 10 个公开字段或方法。

声明

text
export interface PermanentMemoryFailureFixture {
    id: string;
    operation: PermanentMemoryMigrationOperation;
    providerError: Record<string, unknown>;
    expectedCode?: NormalizedMemoryError['code'];
    expectedRetryable?: boolean;
    expectedDisposition?: PermanentMemoryFailureDisposition;
    expectedFinalState?: PermanentMemoryFailureFinalState;
    expectedEmpty?: 'null' | 'array' | 'false';
    attempt?: number;
    maxAttempts?: number;
}

契约成员

成员种类签名说明
attempt属性attempt?: number公开属性;类型、只读和可选状态以签名列为准。
expectedCode属性expectedCode?: "MEMORY_INVALID_INPUT" | "MEMORY_EXTRACTION_SOURCE_UNAVAILABLE" | "MEMORY_EXTRACTION_FAILED" | "MEMORY_EXTRACTION_CURSOR_CONFLICT" | "MEMORY_MAINTENANCE_CONFLICT" | "MEMORY_RANKING_FAILED" | "MEMORY_IDEMPOTENCY_CONFLICT" | "MEMORY_SCOPE_DENIED" | "MEMORY_PERMISSION_DENIED" | "MEMORY_NOT_FOUND" | "MEMORY_REVISION_CONFLICT" | "MEMORY_PROVIDER_NOT_INSTALLED" | "MEMORY_PROVIDER_UNAVAILABLE" | "MEMORY_PR...公开属性;类型、只读和可选状态以签名列为准。
expectedDisposition属性expectedDisposition?: PermanentMemoryFailureDisposition公开属性;类型、只读和可选状态以签名列为准。
expectedEmpty属性expectedEmpty?: "array" | "null" | "false"公开属性;类型、只读和可选状态以签名列为准。
expectedFinalState属性expectedFinalState?: PermanentMemoryFailureFinalState公开属性;类型、只读和可选状态以签名列为准。
expectedRetryable属性expectedRetryable?: boolean公开属性;类型、只读和可选状态以签名列为准。
id属性id: string公开属性;类型、只读和可选状态以签名列为准。
maxAttempts属性maxAttempts?: number公开属性;类型、只读和可选状态以签名列为准。
operation属性operation: PermanentMemoryMigrationOperation公开属性;类型、只读和可选状态以签名列为准。
providerError属性providerError: Record<string, unknown>公开属性;类型、只读和可选状态以签名列为准。

PermanentMemoryMigrationAcceptanceHarness

Permanent Memory Migration Acceptance Harness 接口,共包含 2 个公开字段或方法。

声明

text
export interface PermanentMemoryMigrationAcceptanceHarness {
    port: PermanentMemoryMigrationPort;
    events: PermanentMemoryFailureEvent[];
}

契约成员

成员种类签名说明
events属性events: PermanentMemoryFailureEvent[]公开属性;类型、只读和可选状态以签名列为准。
port属性port: PermanentMemoryMigrationPort公开属性;类型、只读和可选状态以签名列为准。

PermanentMemoryMigrationHarnessFactory

Permanent Memory Migration Harness Factory 公共类型别名;完整类型表达式见声明。

声明

text
export type PermanentMemoryMigrationHarnessFactory = (fixture: PermanentMemoryFailureFixture) => PermanentMemoryMigrationAcceptanceHarness;