refactor(agent): move the connector credential helpers out of VaultStore (P1.2)

getConnectorCredential, setConnectorCredential and setConnectorCredentialBundle
are now plain functions over a SecretStore in
packages/agent/src/connectors/connector-credentials.ts. The secret names,
metadata layout and the rule that tokens never go into plaintext metadata are
unchanged, so existing vault files keep working.

A bundle still lands as one update: SecretStore gains writeBatch, which
VaultStore applies with a single vault-file replacement.

Connector tests seed a Map-backed SecretStore instead of mocking VaultStore
methods; the helper tests from core and server moved to the agent package.
This commit is contained in:
shumeiko.it
2026-10-24 16:34:20 +02:00
parent 23431550ae
commit 3528a242f6
60 changed files with 602 additions and 606 deletions

View File

@@ -19,6 +19,7 @@ import fs from 'node:fs';
import path from 'node:path';
import os from 'node:os';
import { MindDB, FrameStore, SessionStore, VaultStore } from '@waggle/core';
import { getConnectorCredential, setConnectorCredential } from '@waggle/agent';
import { buildLocalServer } from '../src/local/index.js';
import type { FastifyInstance } from 'fastify';
import { injectWithAuth } from './test-utils.js';
@@ -439,13 +440,13 @@ describe('Vault encryption cross-platform', () => {
it('connector credential helpers work', () => {
const vault = new VaultStore(tmpDir);
vault.setConnectorCredential('github', {
setConnectorCredential(vault, 'github', {
type: 'bearer',
value: 'ghp_test123',
scopes: ['repo', 'read:org'],
});
const cred = vault.getConnectorCredential('github');
const cred = getConnectorCredential(vault, 'github');
expect(cred).not.toBeNull();
expect(cred!.value).toBe('ghp_test123');
expect(cred!.type).toBe('bearer');

View File

@@ -1,7 +1,7 @@
import { describe, it, expect, vi } from 'vitest';
import { ConnectorRegistry } from '@waggle/agent';
import { BaseConnector, type ConnectorAction, type ConnectorResult } from '@waggle/agent';
import type { VaultStore } from '@waggle/core';
import type { SecretStore } from '@waggle/core';
import type { ConnectorHealth } from '@waggle/shared';
import { needsConfirmation, getApprovalClass } from '@waggle/agent';
@@ -38,21 +38,30 @@ class TestConnector extends BaseConnector {
}
}
function createMockVault(credentials: Record<string, { value: string; isExpired: boolean }> = {}): VaultStore {
/** Serves `connector:<id>` entries in the layout setConnectorCredential writes. */
function createMockVault(credentials: Record<string, { value: string; isExpired: boolean }> = {}): SecretStore {
return {
getConnectorCredential: vi.fn((id: string) => {
const cred = credentials[id];
get: vi.fn((name: string) => {
const cred = credentials[name.replace(/^connector:/, '')];
if (!cred) return null;
return { value: cred.value, type: 'bearer', isExpired: cred.isExpired };
return {
name,
value: cred.value,
metadata: {
credentialType: 'bearer',
expiresAt: cred.isExpired ? '2020-01-01T00:00:00.000Z' : undefined,
},
updatedAt: new Date().toISOString(),
};
}),
setConnectorCredential: vi.fn(),
set: vi.fn(),
get: vi.fn(),
setAsync: vi.fn(),
writeBatch: vi.fn(),
delete: vi.fn(),
deleteAsync: vi.fn(),
list: vi.fn(() => []),
has: vi.fn(() => false),
migrateFromConfig: vi.fn(() => 0),
} as unknown as VaultStore;
};
}
// ─── Integration Tests ───────────────────────────────────────────────

View File

@@ -19,6 +19,8 @@ import {
GoogleCalendarConnector,
JiraConnector,
SalesforceConnector,
getConnectorCredential,
setConnectorCredential,
type ConnectorAction,
type ConnectorResult,
} from '@waggle/agent';
@@ -48,7 +50,7 @@ class TestConnector extends BaseConnector {
this.connectCalls += 1;
if (this.connectGate) await this.connectGate;
if (this.connectError) throw this.connectError;
this.credentialValue = vault.getConnectorCredential(this.id)?.value ?? null;
this.credentialValue = getConnectorCredential(vault, this.id)?.value ?? null;
}
async healthCheck(): Promise<ConnectorHealth> {
this.healthCheckCalls += 1;
@@ -147,7 +149,7 @@ describe('Connector routes — Phase 4 extensions', () => {
expect(res.statusCode).toBe(400);
expect(res.json()).toEqual({ error: 'Valid Salesforce instanceUrl required' });
expect(vault.getConnectorCredential('salesforce')).toBeNull();
expect(getConnectorCredential(vault, 'salesforce')).toBeNull();
expect(vault.get('connector:salesforce:instance_url')).toBeNull();
});
@@ -173,7 +175,7 @@ describe('Connector routes — Phase 4 extensions', () => {
});
it('rehydrates persisted Salesforce state on restart and hides incomplete legacy state', async () => {
vault.setConnectorCredential('salesforce', { type: 'bearer', value: 'persisted-token' });
setConnectorCredential(vault, 'salesforce', { type: 'bearer', value: 'persisted-token' });
vault.set('connector:salesforce:instance_url', 'https://acme.my.salesforce.com');
const restarted = registerConnectors(vault);
@@ -193,7 +195,7 @@ describe('Connector routes — Phase 4 extensions', () => {
it('rejects unsafe Jira site origins without partial writes, then accepts a corrected retry', async () => {
const jira = new JiraConnector();
registry.register(jira);
vault.setConnectorCredential('jira', { type: 'bearer', value: 'old-token' });
setConnectorCredential(vault, 'jira', { type: 'bearer', value: 'old-token' });
vault.set('connector:jira:email', 'old@example.com');
vault.set('connector:jira:base_url', 'https://old-team.atlassian.net');
await registry.hydrate('jira');
@@ -210,7 +212,7 @@ describe('Connector routes — Phase 4 extensions', () => {
expect(blankToken.statusCode).toBe(400);
expect(blankToken.json()).toEqual({ error: 'token or apiKey required' });
expect(vault.getConnectorCredential('jira')?.value).toBe('old-token');
expect(getConnectorCredential(vault, 'jira')?.value).toBe('old-token');
expect(vault.get('connector:jira:email')?.value).toBe('old@example.com');
expect(vault.get('connector:jira:base_url')?.value).toBe('https://old-team.atlassian.net');
@@ -226,7 +228,7 @@ describe('Connector routes — Phase 4 extensions', () => {
expect(rejected.statusCode).toBe(400);
expect(rejected.json()).toEqual({ error: 'Valid Jira baseUrl required' });
expect(vault.getConnectorCredential('jira')?.value).toBe('old-token');
expect(getConnectorCredential(vault, 'jira')?.value).toBe('old-token');
expect(vault.get('connector:jira:email')?.value).toBe('old@example.com');
expect(vault.get('connector:jira:base_url')?.value).toBe('https://old-team.atlassian.net');
@@ -242,7 +244,7 @@ describe('Connector routes — Phase 4 extensions', () => {
expect(accepted.statusCode).toBe(200);
expect(accepted.json()).toEqual({ connected: true, connectorId: 'jira' });
expect(vault.getConnectorCredential('jira')?.value).toBe('new-token');
expect(getConnectorCredential(vault, 'jira')?.value).toBe('new-token');
expect(vault.get('connector:jira:email')?.value).toBe('new@example.com');
expect(vault.get('connector:jira:base_url')?.value).toBe('https://new-team.atlassian.net');
expect(registry.getDefinitions().find(def => def.id === 'jira')?.status).toBe('connected');
@@ -269,7 +271,7 @@ describe('Connector routes — Phase 4 extensions', () => {
it('does not advertise Jira as usable when email or a safe site origin is missing', async () => {
const jira = new JiraConnector();
registry.register(jira);
vault.setConnectorCredential('jira', { type: 'bearer', value: 'jira-token' });
setConnectorCredential(vault, 'jira', { type: 'bearer', value: 'jira-token' });
vault.set('connector:jira:base_url', 'https://team.atlassian.net');
await registry.hydrate('jira');
@@ -287,7 +289,7 @@ describe('Connector routes — Phase 4 extensions', () => {
error: expect.stringContaining('Not connected'),
});
vault.setConnectorCredential('jira', { type: 'bearer', value: ' ' });
setConnectorCredential(vault, 'jira', { type: 'bearer', value: ' ' });
vault.set('connector:jira:base_url', 'https://team.atlassian.net');
await registry.hydrate('jira');
@@ -297,7 +299,7 @@ describe('Connector routes — Phase 4 extensions', () => {
});
it('waits for startup hydration before health checks or issued-tool execution', async () => {
vault.setConnectorCredential('test-conn', { type: 'bearer', value: 'persisted-token' });
setConnectorCredential(vault, 'test-conn', { type: 'bearer', value: 'persisted-token' });
let releaseHydration!: () => void;
const hydrationGate = new Promise<void>((resolve) => {
releaseHydration = resolve;
@@ -363,7 +365,7 @@ describe('Connector routes — Phase 4 extensions', () => {
payload: { token: 'secret-token' },
});
const issuedTool = registry.generateTools().find(tool => tool.name === 'connector_test-conn_read_data')!;
const credentialRead = vi.spyOn(vault, 'getConnectorCredential').mockImplementation(() => {
const credentialRead = vi.spyOn(vault, 'get').mockImplementation(() => {
throw new Error('vault offline');
});
@@ -475,7 +477,7 @@ describe('Connector routes — Phase 4 extensions', () => {
expect(healthResponse.statusCode).toBe(200);
expect(healthResponse.json().status).toBe('error');
expect(vault.getConnectorCredential('gcal')).toBeNull();
expect(getConnectorCredential(vault, 'gcal')).toBeNull();
expect(fetchMock).toHaveBeenCalledTimes(1);
});
@@ -550,7 +552,7 @@ describe('Connector routes — Phase 4 extensions', () => {
it('revoke purges credentials, sub-keys AND OAuth tokens, then audits', async () => {
// Seed: connector credential + sub-keys + the oauth.ts-style token keys
vault.setConnectorCredential('test-conn', { type: 'oauth2', value: 'access-tok', refreshToken: 'refresh-tok' });
setConnectorCredential(vault, 'test-conn', { type: 'oauth2', value: 'access-tok', refreshToken: 'refresh-tok' });
vault.set('connector:test-conn:email', 'a@b.c');
vault.set('connector:test-conn:lastSync', new Date().toISOString());
vault.set('test-conn_oauth_token', 'oauth-access', { credentialType: 'oauth2' });
@@ -561,7 +563,7 @@ describe('Connector routes — Phase 4 extensions', () => {
expect(res.json()).toMatchObject({ ok: true, connectorId: 'test-conn', revoked: true, oauthPurged: 2 });
// Everything gone: credential, every sub-key, both OAuth tokens
expect(vault.getConnectorCredential('test-conn')).toBeNull();
expect(getConnectorCredential(vault, 'test-conn')).toBeNull();
expect(vault.get('connector:test-conn:email')).toBeNull();
expect(vault.get('connector:test-conn:lastSync')).toBeNull();
expect(vault.get('connector:test-conn:refresh')).toBeNull();
@@ -579,7 +581,7 @@ describe('Connector routes — Phase 4 extensions', () => {
// gcal/gdrive/gdocs/gmail/gsheets all authenticate via the 'google' OAuth
// provider — oauth.ts stores google_oauth_token, never gcal_oauth_token.
// Without the id→provider map the live google token pair survived forever.
vault.setConnectorCredential('gcal', { type: 'oauth2', value: 'access-tok' });
setConnectorCredential(vault, 'gcal', { type: 'oauth2', value: 'access-tok' });
vault.set('google_oauth_token', 'g-access', { credentialType: 'oauth2' });
vault.set('google_oauth_refresh_token', 'g-refresh', { credentialType: 'oauth2' });
@@ -590,7 +592,7 @@ describe('Connector routes — Phase 4 extensions', () => {
// The PROVIDER-keyed pair (the actual live tokens) is purged
expect(vault.get('google_oauth_token')).toBeNull();
expect(vault.get('google_oauth_refresh_token')).toBeNull();
expect(vault.getConnectorCredential('gcal')).toBeNull();
expect(getConnectorCredential(vault, 'gcal')).toBeNull();
const audit = auditStore.getByCapability('gcal');
expect(audit).toHaveLength(1);
@@ -604,7 +606,7 @@ describe('Connector routes — Phase 4 extensions', () => {
});
it('disconnect stays the lighter alias: cleans vault keys but writes NO audit entry', async () => {
vault.setConnectorCredential('test-conn', { type: 'bearer', value: 'tok' });
setConnectorCredential(vault, 'test-conn', { type: 'bearer', value: 'tok' });
vault.set('test-conn_oauth_token', 'oauth-access');
const res = await server.inject({ method: 'POST', url: '/api/connectors/test-conn/disconnect' });
@@ -612,7 +614,7 @@ describe('Connector routes — Phase 4 extensions', () => {
expect(res.json().disconnected).toBe(true);
// Connector keyspace cleaned, but OAuth tokens are NOT purged (revoke-only)
expect(vault.getConnectorCredential('test-conn')).toBeNull();
expect(getConnectorCredential(vault, 'test-conn')).toBeNull();
expect(vault.get('test-conn_oauth_token')?.value).toBe('oauth-access');
expect(auditStore.getByCapability('test-conn')).toHaveLength(0);
});

View File

@@ -1,8 +1,4 @@
import { describe, it, expect } from 'vitest';
import path from 'node:path';
import { VaultStore } from '@waggle/core';
import fs from 'node:fs';
import os from 'node:os';
describe('Connector Foundation', () => {
it('exports connectorRoutes function', async () => {
@@ -12,74 +8,6 @@ describe('Connector Foundation', () => {
});
});
describe('Vault Connector Credential Methods', () => {
const tmpDir = path.join(os.tmpdir(), `waggle-vault-test-${Date.now()}`);
it('setConnectorCredential stores and getConnectorCredential retrieves', () => {
fs.mkdirSync(tmpDir, { recursive: true });
const vault = new VaultStore(tmpDir);
vault.setConnectorCredential('github', {
type: 'bearer',
value: 'ghp_test_token_12345',
scopes: ['repo', 'user'],
});
const cred = vault.getConnectorCredential('github');
expect(cred).not.toBeNull();
expect(cred!.value).toBe('ghp_test_token_12345');
expect(cred!.type).toBe('bearer');
expect(cred!.scopes).toEqual(['repo', 'user']);
expect(cred!.isExpired).toBe(false);
// Cleanup
fs.rmSync(tmpDir, { recursive: true, force: true });
});
it('detects expired tokens', () => {
fs.mkdirSync(tmpDir, { recursive: true });
const vault = new VaultStore(tmpDir);
vault.setConnectorCredential('slack', {
type: 'oauth2',
value: 'xoxb-expired-token',
expiresAt: '2020-01-01T00:00:00.000Z', // Way in the past
});
const cred = vault.getConnectorCredential('slack');
expect(cred).not.toBeNull();
expect(cred!.isExpired).toBe(true);
fs.rmSync(tmpDir, { recursive: true, force: true });
});
it('returns null for non-existent connector', () => {
fs.mkdirSync(tmpDir, { recursive: true });
const vault = new VaultStore(tmpDir);
const cred = vault.getConnectorCredential('nonexistent');
expect(cred).toBeNull();
fs.rmSync(tmpDir, { recursive: true, force: true });
});
it('disconnect removes credential from vault', () => {
fs.mkdirSync(tmpDir, { recursive: true });
const vault = new VaultStore(tmpDir);
vault.setConnectorCredential('github', {
type: 'bearer',
value: 'ghp_test_token',
});
expect(vault.getConnectorCredential('github')).not.toBeNull();
vault.delete('connector:github');
expect(vault.getConnectorCredential('github')).toBeNull();
fs.rmSync(tmpDir, { recursive: true, force: true });
});
});
describe('ConnectorDefinition Types', () => {
it('shared types include connector types', async () => {
// Verify the types compile correctly by importing them