@codesoul-co/hypha-memory / memory-server-migration-acceptance
模块用法
用于使用该功能边界的公共契约与操作。Memory server migration acceptance 模块公开 4 函数、8 接口。
从包入口导入
ts
import {
runCanonicalConsumerMigrationAcceptance,
runMemoryServerMigrationAcceptance,
runPermanentMemoryMigrationAcceptance,
runRedisWorkingMemoryMigrationAcceptance,
} from '@codesoul-co/hypha-memory';
import type {
CanonicalMemoryConsumerObservation,
MemoryMigrationObservationPort,
MemoryServerMigrationAcceptancePorts,
MemoryServerMigrationAcceptanceReport,
MemoryServerMigrationFinding,
MemoryServerMigrationSuiteReport,
PermanentMemoryFailureObservation,
RedisWorkingMemoryObservation,
} from '@codesoul-co/hypha-memory';使用要点
- 8 个类型/接口用于应用代码、Adapter 或测试中的静态契约；请使用
import type，运行时不应依赖它们。 - 4 个函数是该模块的直接操作入口；每个 overload 的必需/可选参数与返回类型均在下方列出。
公共导出
| Symbol | 种类 | 签名 | 说明 |
|---|---|---|---|
runCanonicalConsumerMigrationAcceptance | 函数 | runCanonicalConsumerMigrationAcceptance(port: MemoryServerMigrationAcceptancePorts["canonicalConsumer"], acceptance?: MemoryServerMigrationAcceptance): Promise<MemoryServerMigrationSuiteReport> | Run Canonical Consumer Migration Acceptance 函数，提供 1 个公开调用签名；参数与返回类型见下表。 |
runMemoryServerMigrationAcceptance | 函数 | runMemoryServerMigrationAcceptance(ports: MemoryServerMigrationAcceptancePorts, acceptance?: MemoryServerMigrationAcceptance): Promise<MemoryServerMigrationAcceptanceReport> | Run Memory Server Migration Acceptance 函数，提供 1 个公开调用签名；参数与返回类型见下表。 |
runPermanentMemoryMigrationAcceptance | 函数 | runPermanentMemoryMigrationAcceptance(port: MemoryServerMigrationAcceptancePorts["permanentMemory"], acceptance?: MemoryServerMigrationAcceptance): Promise<MemoryServerMigrationSuiteReport> | Run Permanent Memory Migration Acceptance 函数，提供 1 个公开调用签名；参数与返回类型见下表。 |
runRedisWorkingMemoryMigrationAcceptance | 函数 | runRedisWorkingMemoryMigrationAcceptance(port: MemoryServerMigrationAcceptancePorts["redisWorkingMemory"], acceptance?: MemoryServerMigrationAcceptance): Promise<MemoryServerMigrationSuiteReport> | Run Redis Working Memory Migration Acceptance 函数，提供 1 个公开调用签名；参数与返回类型见下表。 |
CanonicalMemoryConsumerObservation | 接口 | interface CanonicalMemoryConsumerObservation | Canonical Memory Consumer Observation 接口，共包含 9 个公开字段或方法。 |
MemoryMigrationObservationPort | 接口 | interface MemoryMigrationObservationPort | Memory Migration Observation Port 接口，共包含 1 个公开字段或方法。 |
MemoryServerMigrationAcceptancePorts | 接口 | interface MemoryServerMigrationAcceptancePorts | Memory Server Migration Acceptance Ports 接口，共包含 3 个公开字段或方法。 |
MemoryServerMigrationAcceptanceReport | 接口 | interface MemoryServerMigrationAcceptanceReport | Memory Server Migration Acceptance Report 接口，共包含 3 个公开字段或方法。 |
MemoryServerMigrationFinding | 接口 | interface MemoryServerMigrationFinding | Memory Server Migration Finding 接口，共包含 3 个公开字段或方法。 |
MemoryServerMigrationSuiteReport | 接口 | interface MemoryServerMigrationSuiteReport | Memory Server Migration Suite Report 接口，共包含 3 个公开字段或方法。 |
PermanentMemoryFailureObservation | 接口 | interface PermanentMemoryFailureObservation | Permanent Memory Failure Observation 接口，共包含 4 个公开字段或方法。 |
RedisWorkingMemoryObservation | 接口 | interface RedisWorkingMemoryObservation | Redis Working Memory Observation 接口，共包含 3 个公开字段或方法。 |
runCanonicalConsumerMigrationAcceptance
Run Canonical Consumer Migration Acceptance 函数，提供 1 个公开调用签名；参数与返回类型见下表。
- 种类: 函数
- 导入:
import { runCanonicalConsumerMigrationAcceptance } from '@codesoul-co/hypha-memory'; - 源码模块:
memory-server-migration-acceptance
声明
text
export declare function runCanonicalConsumerMigrationAcceptance(port: MemoryServerMigrationAcceptancePorts['canonicalConsumer'], acceptance?: MemoryServerMigrationAcceptance): Promise<MemoryServerMigrationSuiteReport>;调用签名
text
runCanonicalConsumerMigrationAcceptance(port: MemoryServerMigrationAcceptancePorts["canonicalConsumer"], acceptance?: MemoryServerMigrationAcceptance): Promise<MemoryServerMigrationSuiteReport>参数
| 参数 | 类型 | 必需 | 说明 |
|---|---|---|---|
port | MemoryMigrationObservationPort<CanonicalMemoryConsumerObservation> | 是 | 必需参数；接受的值由类型列定义。 |
acceptance | MemoryServerMigrationAcceptance | 否 | 可选参数；接受的值由类型列定义。 |
返回值
- 类型:
Promise<MemoryServerMigrationSuiteReport> - 说明: 返回值契约由上述类型定义。
runMemoryServerMigrationAcceptance
Run Memory Server Migration Acceptance 函数，提供 1 个公开调用签名；参数与返回类型见下表。
- 种类: 函数
- 导入:
import { runMemoryServerMigrationAcceptance } from '@codesoul-co/hypha-memory'; - 源码模块:
memory-server-migration-acceptance
声明
text
export declare function runMemoryServerMigrationAcceptance(ports: MemoryServerMigrationAcceptancePorts, acceptance?: MemoryServerMigrationAcceptance): Promise<MemoryServerMigrationAcceptanceReport>;调用签名
text
runMemoryServerMigrationAcceptance(ports: MemoryServerMigrationAcceptancePorts, acceptance?: MemoryServerMigrationAcceptance): Promise<MemoryServerMigrationAcceptanceReport>参数
| 参数 | 类型 | 必需 | 说明 |
|---|---|---|---|
ports | MemoryServerMigrationAcceptancePorts | 是 | 必需参数；接受的值由类型列定义。 |
acceptance | MemoryServerMigrationAcceptance | 否 | 可选参数；接受的值由类型列定义。 |
返回值
- 类型:
Promise<MemoryServerMigrationAcceptanceReport> - 说明: 返回值契约由上述类型定义。
runPermanentMemoryMigrationAcceptance
Run Permanent Memory Migration Acceptance 函数，提供 1 个公开调用签名；参数与返回类型见下表。
- 种类: 函数
- 导入:
import { runPermanentMemoryMigrationAcceptance } from '@codesoul-co/hypha-memory'; - 源码模块:
memory-server-migration-acceptance
声明
text
export declare function runPermanentMemoryMigrationAcceptance(port: MemoryServerMigrationAcceptancePorts['permanentMemory'], acceptance?: MemoryServerMigrationAcceptance): Promise<MemoryServerMigrationSuiteReport>;调用签名
text
runPermanentMemoryMigrationAcceptance(port: MemoryServerMigrationAcceptancePorts["permanentMemory"], acceptance?: MemoryServerMigrationAcceptance): Promise<MemoryServerMigrationSuiteReport>参数
| 参数 | 类型 | 必需 | 说明 |
|---|---|---|---|
port | MemoryMigrationObservationPort<PermanentMemoryFailureObservation> | 是 | 必需参数；接受的值由类型列定义。 |
acceptance | MemoryServerMigrationAcceptance | 否 | 可选参数；接受的值由类型列定义。 |
返回值
- 类型:
Promise<MemoryServerMigrationSuiteReport> - 说明: 返回值契约由上述类型定义。
runRedisWorkingMemoryMigrationAcceptance
Run Redis Working Memory Migration Acceptance 函数，提供 1 个公开调用签名；参数与返回类型见下表。
- 种类: 函数
- 导入:
import { runRedisWorkingMemoryMigrationAcceptance } from '@codesoul-co/hypha-memory'; - 源码模块:
memory-server-migration-acceptance
声明
text
export declare function runRedisWorkingMemoryMigrationAcceptance(port: MemoryServerMigrationAcceptancePorts['redisWorkingMemory'], acceptance?: MemoryServerMigrationAcceptance): Promise<MemoryServerMigrationSuiteReport>;调用签名
text
runRedisWorkingMemoryMigrationAcceptance(port: MemoryServerMigrationAcceptancePorts["redisWorkingMemory"], acceptance?: MemoryServerMigrationAcceptance): Promise<MemoryServerMigrationSuiteReport>参数
| 参数 | 类型 | 必需 | 说明 |
|---|---|---|---|
port | MemoryMigrationObservationPort<RedisWorkingMemoryObservation> | 是 | 必需参数；接受的值由类型列定义。 |
acceptance | MemoryServerMigrationAcceptance | 否 | 可选参数；接受的值由类型列定义。 |
返回值
- 类型:
Promise<MemoryServerMigrationSuiteReport> - 说明: 返回值契约由上述类型定义。
CanonicalMemoryConsumerObservation
Canonical Memory Consumer Observation 接口，共包含 9 个公开字段或方法。
- 种类: 接口
- 导入:
import type { CanonicalMemoryConsumerObservation } from '@codesoul-co/hypha-memory'; - 源码模块:
memory-server-migration-acceptance
声明
text
export interface CanonicalMemoryConsumerObservation {
compositionReceipt?: MemoryRuntimeCompositionReceipt;
consumerServiceInstanceIds: Partial<Record<MemoryServerConsumer, string>>;
serviceRegistrationCount: number;
runtimeDependencies: readonly string[];
unresolvedDependencyRefs: readonly string[];
directStoreConsumers: readonly MemoryServerConsumer[];
secondWritePaths: readonly string[];
profileSwitches: readonly CanonicalProfileSwitchObservation[];
legacyAdapterResponsibilities: readonly string[];
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
compositionReceipt | 属性 | compositionReceipt?: MemoryRuntimeCompositionReceipt | 公开属性；类型、只读和可选状态以签名列为准。 |
consumerServiceInstanceIds | 属性 | consumerServiceInstanceIds: Partial<Record<MemoryServerConsumer, string>> | 公开属性；类型、只读和可选状态以签名列为准。 |
directStoreConsumers | 属性 | directStoreConsumers: readonly MemoryServerConsumer[] | 公开属性；类型、只读和可选状态以签名列为准。 |
legacyAdapterResponsibilities | 属性 | legacyAdapterResponsibilities: readonly string[] | 公开属性；类型、只读和可选状态以签名列为准。 |
profileSwitches | 属性 | profileSwitches: readonly CanonicalProfileSwitchObservation[] | 公开属性；类型、只读和可选状态以签名列为准。 |
runtimeDependencies | 属性 | runtimeDependencies: readonly string[] | 公开属性；类型、只读和可选状态以签名列为准。 |
secondWritePaths | 属性 | secondWritePaths: readonly string[] | 公开属性；类型、只读和可选状态以签名列为准。 |
serviceRegistrationCount | 属性 | serviceRegistrationCount: number | 公开属性；类型、只读和可选状态以签名列为准。 |
unresolvedDependencyRefs | 属性 | unresolvedDependencyRefs: readonly string[] | 公开属性；类型、只读和可选状态以签名列为准。 |
MemoryMigrationObservationPort
Memory Migration Observation Port 接口，共包含 1 个公开字段或方法。
- 种类: 接口
- 导入:
import type { MemoryMigrationObservationPort } from '@codesoul-co/hypha-memory'; - 源码模块:
memory-server-migration-acceptance
声明
text
export interface MemoryMigrationObservationPort<T> {
observe(fixture: MemoryServerMigrationSharedFixture): Promise<T>;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
observe | 方法 | observe(fixture: MemoryServerMigrationSharedFixture): Promise<T> | 公开方法；参数与返回类型以签名列为准。 |
MemoryServerMigrationAcceptancePorts
Memory Server Migration Acceptance Ports 接口，共包含 3 个公开字段或方法。
- 种类: 接口
- 导入:
import type { MemoryServerMigrationAcceptancePorts } from '@codesoul-co/hypha-memory'; - 源码模块:
memory-server-migration-acceptance
声明
text
export interface MemoryServerMigrationAcceptancePorts {
canonicalConsumer: MemoryMigrationObservationPort<CanonicalMemoryConsumerObservation>;
redisWorkingMemory: MemoryMigrationObservationPort<RedisWorkingMemoryObservation>;
permanentMemory: MemoryMigrationObservationPort<PermanentMemoryFailureObservation>;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
canonicalConsumer | 属性 | canonicalConsumer: MemoryMigrationObservationPort<CanonicalMemoryConsumerObservation> | 公开属性；类型、只读和可选状态以签名列为准。 |
permanentMemory | 属性 | permanentMemory: MemoryMigrationObservationPort<PermanentMemoryFailureObservation> | 公开属性；类型、只读和可选状态以签名列为准。 |
redisWorkingMemory | 属性 | redisWorkingMemory: MemoryMigrationObservationPort<RedisWorkingMemoryObservation> | 公开属性；类型、只读和可选状态以签名列为准。 |
MemoryServerMigrationAcceptanceReport
Memory Server Migration Acceptance Report 接口，共包含 3 个公开字段或方法。
- 种类: 接口
- 导入:
import type { MemoryServerMigrationAcceptanceReport } from '@codesoul-co/hypha-memory'; - 源码模块:
memory-server-migration-acceptance
声明
text
export interface MemoryServerMigrationAcceptanceReport {
contractRef: MemoryServerMigrationAcceptance['contractRef'];
passed: boolean;
suites: readonly MemoryServerMigrationSuiteReport[];
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
contractRef | 属性 | contractRef: import("/Users/erwin/Downloads/codespace/Hypha/packages/memory/dist/contracts").MemoryContractSpecRef | 公开属性；类型、只读和可选状态以签名列为准。 |
passed | 属性 | passed: boolean | 公开属性；类型、只读和可选状态以签名列为准。 |
suites | 属性 | suites: readonly MemoryServerMigrationSuiteReport[] | 公开属性；类型、只读和可选状态以签名列为准。 |
MemoryServerMigrationFinding
Memory Server Migration Finding 接口，共包含 3 个公开字段或方法。
- 种类: 接口
- 导入:
import type { MemoryServerMigrationFinding } from '@codesoul-co/hypha-memory'; - 源码模块:
memory-server-migration-acceptance
声明
text
export interface MemoryServerMigrationFinding {
issue: MemoryServerMigrationIssue;
code: string;
message: string;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
code | 属性 | code: string | 公开属性；类型、只读和可选状态以签名列为准。 |
issue | 属性 | issue: MemoryServerMigrationIssue | 公开属性；类型、只读和可选状态以签名列为准。 |
message | 属性 | message: string | 公开属性；类型、只读和可选状态以签名列为准。 |
MemoryServerMigrationSuiteReport
Memory Server Migration Suite Report 接口，共包含 3 个公开字段或方法。
- 种类: 接口
- 导入:
import type { MemoryServerMigrationSuiteReport } from '@codesoul-co/hypha-memory'; - 源码模块:
memory-server-migration-acceptance
声明
text
export interface MemoryServerMigrationSuiteReport {
issue: MemoryServerMigrationIssue;
passed: boolean;
findings: MemoryServerMigrationFinding[];
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
findings | 属性 | findings: MemoryServerMigrationFinding[] | 公开属性；类型、只读和可选状态以签名列为准。 |
issue | 属性 | issue: MemoryServerMigrationIssue | 公开属性；类型、只读和可选状态以签名列为准。 |
passed | 属性 | passed: boolean | 公开属性；类型、只读和可选状态以签名列为准。 |
PermanentMemoryFailureObservation
Permanent Memory Failure Observation 接口，共包含 4 个公开字段或方法。
- 种类: 接口
- 导入:
import type { PermanentMemoryFailureObservation } from '@codesoul-co/hypha-memory'; - 源码模块:
memory-server-migration-acceptance
声明
text
export interface PermanentMemoryFailureObservation {
notFoundReturnsEmpty: boolean;
providerFailureResult: 'normalized_error' | 'empty_result' | 'success';
normalizedFailure?: NormalizedMemoryError;
failureDisposition: 'retry_reconcile_quarantine_or_dlq' | 'empty_result' | 'none';
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
failureDisposition | 属性 | failureDisposition: "none" | "retry_reconcile_quarantine_or_dlq" | "empty_result" | 公开属性；类型、只读和可选状态以签名列为准。 |
normalizedFailure | 属性 | normalizedFailure?: NormalizedMemoryError | 公开属性；类型、只读和可选状态以签名列为准。 |
notFoundReturnsEmpty | 属性 | notFoundReturnsEmpty: boolean | 公开属性；类型、只读和可选状态以签名列为准。 |
providerFailureResult | 属性 | providerFailureResult: "normalized_error" | "success" | "empty_result" | 公开属性；类型、只读和可选状态以签名列为准。 |
RedisWorkingMemoryObservation
Redis Working Memory Observation 接口，共包含 3 个公开字段或方法。
- 种类: 接口
- 导入:
import type { RedisWorkingMemoryObservation } from '@codesoul-co/hypha-memory'; - 源码模块:
memory-server-migration-acceptance
声明
text
export interface RedisWorkingMemoryObservation {
trimArgumentSemantics: 'target_max_length' | 'deletion_count';
newestReadStrategy: 'reverse_range' | 'forward_range' | 'reliable_metadata';
cleanupStrategy: 'scan' | 'keys';
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
cleanupStrategy | 属性 | cleanupStrategy: "scan" | "keys" | 公开属性；类型、只读和可选状态以签名列为准。 |
newestReadStrategy | 属性 | newestReadStrategy: "reverse_range" | "forward_range" | "reliable_metadata" | 公开属性；类型、只读和可选状态以签名列为准。 |
trimArgumentSemantics | 属性 | trimArgumentSemantics: "target_max_length" | "deletion_count" | 公开属性；类型、只读和可选状态以签名列为准。 |