Migrate /privacy to new architecture (#4202)

This commit is contained in:
Abhi 2025-07-15 01:45:06 -04:00 committed by GitHub
parent 886faa2990
commit e584241141
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 71 additions and 11 deletions

View File

@ -12,6 +12,7 @@ import { helpCommand } from '../ui/commands/helpCommand.js';
import { clearCommand } from '../ui/commands/clearCommand.js'; import { clearCommand } from '../ui/commands/clearCommand.js';
import { authCommand } from '../ui/commands/authCommand.js'; import { authCommand } from '../ui/commands/authCommand.js';
import { themeCommand } from '../ui/commands/themeCommand.js'; import { themeCommand } from '../ui/commands/themeCommand.js';
import { privacyCommand } from '../ui/commands/privacyCommand.js';
// Mock the command modules to isolate the service from the command implementations. // Mock the command modules to isolate the service from the command implementations.
vi.mock('../ui/commands/memoryCommand.js', () => ({ vi.mock('../ui/commands/memoryCommand.js', () => ({
@ -29,6 +30,9 @@ vi.mock('../ui/commands/authCommand.js', () => ({
vi.mock('../ui/commands/themeCommand.js', () => ({ vi.mock('../ui/commands/themeCommand.js', () => ({
themeCommand: { name: 'theme', description: 'Mock Theme' }, themeCommand: { name: 'theme', description: 'Mock Theme' },
})); }));
vi.mock('../ui/commands/privacyCommand.js', () => ({
privacyCommand: { name: 'privacy', description: 'Mock Privacy' },
}));
describe('CommandService', () => { describe('CommandService', () => {
describe('when using default production loader', () => { describe('when using default production loader', () => {
@ -54,7 +58,7 @@ describe('CommandService', () => {
const tree = commandService.getCommands(); const tree = commandService.getCommands();
// Post-condition assertions // Post-condition assertions
expect(tree.length).toBe(5); expect(tree.length).toBe(6);
const commandNames = tree.map((cmd) => cmd.name); const commandNames = tree.map((cmd) => cmd.name);
expect(commandNames).toContain('auth'); expect(commandNames).toContain('auth');
@ -62,19 +66,20 @@ describe('CommandService', () => {
expect(commandNames).toContain('help'); expect(commandNames).toContain('help');
expect(commandNames).toContain('clear'); expect(commandNames).toContain('clear');
expect(commandNames).toContain('theme'); expect(commandNames).toContain('theme');
expect(commandNames).toContain('privacy');
}); });
it('should overwrite any existing commands when called again', async () => { it('should overwrite any existing commands when called again', async () => {
// Load once // Load once
await commandService.loadCommands(); await commandService.loadCommands();
expect(commandService.getCommands().length).toBe(5); expect(commandService.getCommands().length).toBe(6);
// Load again // Load again
await commandService.loadCommands(); await commandService.loadCommands();
const tree = commandService.getCommands(); const tree = commandService.getCommands();
// Should not append, but overwrite // Should not append, but overwrite
expect(tree.length).toBe(5); expect(tree.length).toBe(6);
}); });
}); });
@ -86,12 +91,13 @@ describe('CommandService', () => {
await commandService.loadCommands(); await commandService.loadCommands();
const loadedTree = commandService.getCommands(); const loadedTree = commandService.getCommands();
expect(loadedTree.length).toBe(5); expect(loadedTree.length).toBe(6);
expect(loadedTree).toEqual([ expect(loadedTree).toEqual([
authCommand, authCommand,
clearCommand, clearCommand,
helpCommand, helpCommand,
memoryCommand, memoryCommand,
privacyCommand,
themeCommand, themeCommand,
]); ]);
}); });

View File

@ -10,12 +10,14 @@ import { helpCommand } from '../ui/commands/helpCommand.js';
import { clearCommand } from '../ui/commands/clearCommand.js'; import { clearCommand } from '../ui/commands/clearCommand.js';
import { authCommand } from '../ui/commands/authCommand.js'; import { authCommand } from '../ui/commands/authCommand.js';
import { themeCommand } from '../ui/commands/themeCommand.js'; import { themeCommand } from '../ui/commands/themeCommand.js';
import { privacyCommand } from '../ui/commands/privacyCommand.js';
const loadBuiltInCommands = async (): Promise<SlashCommand[]> => [ const loadBuiltInCommands = async (): Promise<SlashCommand[]> => [
authCommand, authCommand,
clearCommand, clearCommand,
helpCommand, helpCommand,
memoryCommand, memoryCommand,
privacyCommand,
themeCommand, themeCommand,
]; ];

View File

@ -0,0 +1,38 @@
/**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { describe, it, expect, beforeEach } from 'vitest';
import { privacyCommand } from './privacyCommand.js';
import { type CommandContext } from './types.js';
import { createMockCommandContext } from '../../test-utils/mockCommandContext.js';
describe('privacyCommand', () => {
let mockContext: CommandContext;
beforeEach(() => {
mockContext = createMockCommandContext();
});
it('should return a dialog action to open the privacy dialog', () => {
// Ensure the command has an action to test.
if (!privacyCommand.action) {
throw new Error('The privacy command must have an action.');
}
const result = privacyCommand.action(mockContext, '');
// Assert that the action returns the correct object to trigger the privacy dialog.
expect(result).toEqual({
type: 'dialog',
dialog: 'privacy',
});
});
it('should have the correct name and description', () => {
expect(privacyCommand.name).toBe('privacy');
expect(privacyCommand.description).toBe('display the privacy notice');
});
});

View File

@ -0,0 +1,16 @@
/**
* @license
* Copyright 2025 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import { OpenDialogActionReturn, SlashCommand } from './types.js';
export const privacyCommand: SlashCommand = {
name: 'privacy',
description: 'display the privacy notice',
action: (): OpenDialogActionReturn => ({
type: 'dialog',
dialog: 'privacy',
}),
};

View File

@ -66,7 +66,7 @@ export interface MessageActionReturn {
export interface OpenDialogActionReturn { export interface OpenDialogActionReturn {
type: 'dialog'; type: 'dialog';
// TODO: Add 'theme' | 'auth' | 'editor' | 'privacy' as migration happens. // TODO: Add 'theme' | 'auth' | 'editor' | 'privacy' as migration happens.
dialog: 'help' | 'auth' | 'theme'; dialog: 'help' | 'auth' | 'theme' | 'privacy';
} }
export type SlashCommandActionReturn = export type SlashCommandActionReturn =

View File

@ -247,11 +247,6 @@ export const useSlashCommandProcessor = (
description: 'set external editor preference', description: 'set external editor preference',
action: (_mainCommand, _subCommand, _args) => openEditorDialog(), action: (_mainCommand, _subCommand, _args) => openEditorDialog(),
}, },
{
name: 'privacy',
description: 'display the privacy notice',
action: (_mainCommand, _subCommand, _args) => openPrivacyNotice(),
},
{ {
name: 'stats', name: 'stats',
altName: 'usage', altName: 'usage',
@ -1023,7 +1018,6 @@ export const useSlashCommandProcessor = (
}, [ }, [
addMessage, addMessage,
openEditorDialog, openEditorDialog,
openPrivacyNotice,
toggleCorgiMode, toggleCorgiMode,
savedChatTags, savedChatTags,
config, config,
@ -1125,6 +1119,9 @@ export const useSlashCommandProcessor = (
case 'theme': case 'theme':
openThemeDialog(); openThemeDialog();
return { type: 'handled' }; return { type: 'handled' };
case 'privacy':
openPrivacyNotice();
return { type: 'handled' };
default: { default: {
const unhandled: never = result.dialog; const unhandled: never = result.dialog;
throw new Error( throw new Error(
@ -1208,6 +1205,7 @@ export const useSlashCommandProcessor = (
commandContext, commandContext,
addMessage, addMessage,
openThemeDialog, openThemeDialog,
openPrivacyNotice,
], ],
); );