Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/memory.md
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,13 @@ pushed to a delivery target in your account, enabling event-driven architectures

### Enabling Streaming

Via the interactive wizard:

```bash
agentcore add memory
# Select "Yes" when prompted for streaming, then provide the data stream ARN and content level
```

Via CLI flags:

```bash
Expand Down
5 changes: 3 additions & 2 deletions src/cli/commands/add/validate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import {
getSupportedModelProviders,
matchEnumValue,
} from '../../../schema';
import { ARN_VALIDATION_MESSAGE, isValidArn } from '../shared/arn-utils';
import { parseAndValidateLifecycleOptions } from '../shared/lifecycle-utils';
import { validateVpcOptions } from '../shared/vpc-utils';
import { validateJwtAuthorizerOptions } from './auth-options';
Expand Down Expand Up @@ -697,8 +698,8 @@ export function validateAddMemoryOptions(options: AddMemoryOptions): ValidationR
return { valid: false, error: '--data-stream-arn is required when --delivery-type is set' };
}

if (options.dataStreamArn && !options.dataStreamArn.startsWith('arn:')) {
return { valid: false, error: '--data-stream-arn must be a valid ARN (starts with arn:)' };
if (options.dataStreamArn && !isValidArn(options.dataStreamArn)) {
return { valid: false, error: `--data-stream-arn: ${ARN_VALIDATION_MESSAGE}` };
}

if (
Expand Down
28 changes: 28 additions & 0 deletions src/cli/commands/shared/__tests__/arn-utils.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import { isValidArn } from '../arn-utils';
import { describe, expect, it } from 'vitest';

describe('isValidArn', () => {
it('accepts a valid Kinesis stream ARN', () => {
expect(isValidArn('arn:aws:kinesis:us-west-2:123456789012:stream/my-stream')).toBe(true);
});

it('accepts a valid Lambda ARN', () => {
expect(isValidArn('arn:aws:lambda:us-east-1:123456789012:function:my-func')).toBe(true);
});

it('rejects a string that does not start with arn:', () => {
expect(isValidArn('not-an-arn')).toBe(false);
});

it('rejects an ARN with too few parts', () => {
expect(isValidArn('arn:aws:kinesis:us-west-2:123456789012')).toBe(false);
});

it('accepts an ARN with colons in the resource part', () => {
expect(isValidArn('arn:aws:kinesis:us-west-2:123456789012:stream:extra:parts')).toBe(true);
});

it('rejects an empty string', () => {
expect(isValidArn('')).toBe(false);
});
});
11 changes: 11 additions & 0 deletions src/cli/commands/shared/arn-utils.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
const ARN_PART_COUNT = 6;
const ARN_FORMAT = 'arn:partition:service:region:account:resource';

/**
* Check whether a string looks like a valid ARN (starts with `arn:` and has at least 6 colon-separated parts).
*/
export function isValidArn(value: string): boolean {
return value.startsWith('arn:') && value.split(':').length >= ARN_PART_COUNT;
}

export const ARN_VALIDATION_MESSAGE = `Must be a valid ARN (${ARN_FORMAT})`;
3 changes: 3 additions & 0 deletions src/cli/tui/hooks/useCreateMemory.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ interface CreateMemoryConfig {
name: string;
eventExpiryDuration: number;
strategies: { type: string }[];
streaming?: { dataStreamArn: string; contentLevel: string };
}

interface CreateStatus<T> {
Expand All @@ -27,6 +28,8 @@ export function useCreateMemory() {
name: config.name,
expiry: config.eventExpiryDuration,
strategies: strategiesStr || undefined,
dataStreamArn: config.streaming?.dataStreamArn,
contentLevel: config.streaming?.contentLevel,
});
if (!addResult.success) {
throw new Error(addResult.error ?? 'Failed to create memory');
Expand Down
92 changes: 81 additions & 11 deletions src/cli/tui/screens/memory/AddMemoryScreen.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import type { MemoryStrategyType } from '../../../../schema';
import { AgentNameSchema } from '../../../../schema';
import { AgentNameSchema, StreamContentLevelSchema } from '../../../../schema';
import { ARN_VALIDATION_MESSAGE, isValidArn } from '../../../commands/shared/arn-utils';
import {
ConfirmReview,
Panel,
Expand All @@ -14,7 +15,7 @@ import { HELP_TEXT } from '../../constants';
import { useListNavigation, useMultiSelectNavigation } from '../../hooks';
import { generateUniqueName } from '../../utils';
import type { AddMemoryConfig } from './types';
import { EVENT_EXPIRY_OPTIONS, MEMORY_STEP_LABELS, MEMORY_STRATEGY_OPTIONS } from './types';
import { CONTENT_LEVEL_OPTIONS, EVENT_EXPIRY_OPTIONS, MEMORY_STEP_LABELS, MEMORY_STRATEGY_OPTIONS } from './types';
import { useAddMemoryWizard } from './useAddMemoryWizard';
import React, { useMemo } from 'react';

Expand All @@ -24,6 +25,11 @@ interface AddMemoryScreenProps {
existingMemoryNames: string[];
}

const STREAMING_OPTIONS: SelectableItem[] = [
{ id: 'no', title: 'No', description: 'No streaming' },
{ id: 'yes', title: 'Yes', description: 'Stream memory record events to a delivery target (e.g. Kinesis)' },
];

export function AddMemoryScreen({ onComplete, onExit, existingMemoryNames }: AddMemoryScreenProps) {
const wizard = useAddMemoryWizard();

Expand All @@ -37,9 +43,17 @@ export function AddMemoryScreen({ onComplete, onExit, existingMemoryNames }: Add
[]
);

const contentLevelItems: SelectableItem[] = useMemo(
() => CONTENT_LEVEL_OPTIONS.map(opt => ({ id: opt.id, title: opt.title, description: opt.description })),
[]
);

const isNameStep = wizard.step === 'name';
const isExpiryStep = wizard.step === 'expiry';
const isStrategiesStep = wizard.step === 'strategies';
const isStreamingStep = wizard.step === 'streaming';
const isStreamArnStep = wizard.step === 'streamArn';
const isContentLevelStep = wizard.step === 'contentLevel';
const isConfirmStep = wizard.step === 'confirm';

const expiryNav = useListNavigation({
Expand All @@ -58,6 +72,20 @@ export function AddMemoryScreen({ onComplete, onExit, existingMemoryNames }: Add
requireSelection: false,
});

const streamingNav = useListNavigation({
items: STREAMING_OPTIONS,
onSelect: item => wizard.setStreamingEnabled(item.id === 'yes'),
onExit: () => wizard.goBack(),
isActive: isStreamingStep,
});

const contentLevelNav = useListNavigation({
items: contentLevelItems,
onSelect: item => wizard.setContentLevel(StreamContentLevelSchema.parse(item.id)),
onExit: () => wizard.goBack(),
isActive: isContentLevelStep,
});

useListNavigation({
items: [{ id: 'confirm', title: 'Confirm' }],
onSelect: () => onComplete(wizard.config),
Expand All @@ -67,16 +95,37 @@ export function AddMemoryScreen({ onComplete, onExit, existingMemoryNames }: Add

const helpText = isStrategiesStep
? 'Space toggle · Enter confirm · Esc back'
: isExpiryStep
: isExpiryStep || isStreamingStep || isContentLevelStep
? HELP_TEXT.NAVIGATE_SELECT
: isConfirmStep
? HELP_TEXT.CONFIRM_CANCEL
: HELP_TEXT.TEXT_INPUT;

const headerContent = <StepIndicator steps={wizard.steps} currentStep={wizard.step} labels={MEMORY_STEP_LABELS} />;

const confirmFields = useMemo(
() => [
{ label: 'Name', value: wizard.config.name },
{ label: 'Event Expiry', value: `${wizard.config.eventExpiryDuration} days` },
{ label: 'Strategies', value: wizard.config.strategies.map(s => s.type).join(', ') || 'None' },
...(wizard.config.streaming
? [
{ label: 'Stream ARN', value: wizard.config.streaming.dataStreamArn },
{ label: 'Content Level', value: wizard.config.streaming.contentLevel },
]
: [{ label: 'Streaming', value: 'Disabled' }]),
],
[wizard.config]
);

return (
<Screen title="Add Memory" onExit={onExit} helpText={helpText} headerContent={headerContent}>
<Screen
title="Add Memory"
onExit={onExit}
helpText={helpText}
headerContent={headerContent}
exitEnabled={isNameStep}
>
<Panel>
{isNameStep && (
<TextInput
Expand Down Expand Up @@ -109,15 +158,36 @@ export function AddMemoryScreen({ onComplete, onExit, existingMemoryNames }: Add
/>
)}

{isConfirmStep && (
<ConfirmReview
fields={[
{ label: 'Name', value: wizard.config.name },
{ label: 'Event Expiry', value: `${wizard.config.eventExpiryDuration} days` },
{ label: 'Strategies', value: wizard.config.strategies.map(s => s.type).join(', ') || 'None' },
]}
{isStreamingStep && (
<WizardSelect
title="Enable memory record streaming?"
description="Stream memory record lifecycle events to a delivery target"
items={STREAMING_OPTIONS}
selectedIndex={streamingNav.selectedIndex}
/>
)}

{isStreamArnStep && (
<TextInput
key="streamArn"
prompt="Delivery target ARN (e.g. Kinesis stream)"
initialValue=""
onSubmit={wizard.setStreamArn}
onCancel={() => wizard.goBack()}
customValidation={value => isValidArn(value) || ARN_VALIDATION_MESSAGE}
/>
)}

{isContentLevelStep && (
<WizardSelect
title="Stream content level"
description="What data to include in stream events"
items={contentLevelItems}
selectedIndex={contentLevelNav.selectedIndex}
/>
)}

{isConfirmStep && <ConfirmReview fields={confirmFields} />}
</Panel>
</Screen>
);
Expand Down
22 changes: 20 additions & 2 deletions src/cli/tui/screens/memory/types.ts
Original file line number Diff line number Diff line change
@@ -1,26 +1,35 @@
import type { MemoryStrategyType } from '../../../../schema';
import type { MemoryStrategyType, StreamContentLevel } from '../../../../schema';
import { MemoryStrategyTypeSchema } from '../../../../schema';

// ─────────────────────────────────────────────────────────────────────────────
// Memory Flow Types
// ─────────────────────────────────────────────────────────────────────────────

export type AddMemoryStep = 'name' | 'expiry' | 'strategies' | 'confirm';
export type AddMemoryStep = 'name' | 'expiry' | 'strategies' | 'streaming' | 'streamArn' | 'contentLevel' | 'confirm';

export interface AddMemoryStrategyConfig {
type: MemoryStrategyType;
}

export interface AddMemoryStreamingConfig {
dataStreamArn: string;
contentLevel: StreamContentLevel;
}

export interface AddMemoryConfig {
name: string;
eventExpiryDuration: number;
strategies: AddMemoryStrategyConfig[];
streaming?: AddMemoryStreamingConfig;
}

export const MEMORY_STEP_LABELS: Record<AddMemoryStep, string> = {
name: 'Name',
expiry: 'Expiry',
strategies: 'Strategies',
streaming: 'Streaming',
streamArn: 'Stream ARN',
contentLevel: 'Content Level',
confirm: 'Confirm',
};

Expand Down Expand Up @@ -49,6 +58,15 @@ export const EVENT_EXPIRY_OPTIONS = [
{ id: 365, title: '365 days', description: 'Maximum retention' },
] as const;

export const CONTENT_LEVEL_OPTIONS = [
{ id: 'FULL_CONTENT' as const, title: 'Full content', description: 'Include memory record text in stream events' },
{
id: 'METADATA_ONLY' as const,
title: 'Metadata only',
description: 'Only include metadata (IDs, timestamps, namespaces)',
},
] as const satisfies readonly { id: StreamContentLevel; title: string; description: string }[];

// ─────────────────────────────────────────────────────────────────────────────
// Defaults
// ─────────────────────────────────────────────────────────────────────────────
Expand Down
Loading
Loading