mirror of
https://github.com/hanzoai/insights.git
synced 2026-10-30 16:15:31 +00:00
zeekay
40d120dbf7
Every first-party Python caller and test now names the mount the API actually answers on. Mechanical: URL literals only, and only where the /api/ was ours -- a preceding word character means it was a module path like insights/api/ or a third-party host like slack.com/api/, and those are untouched. Left saying /api/, each for a reason rather than for safety: - products/warehouse_sources/.../sources/** is a catalogue of vendor endpoints - services/llm-gateway deploys separately and is under a code freeze, so moving its two calls would break it during the skew - the mcp_store and Slack/Teams redirect_uris are registered with third parties and must byte-match what was registered - the Wizard and Raycast client-metadata paths are OAuth client_ids - /api/surveys and /api/feature_flag/local_evaluation are SDK aliases the ingress routes to the Rust fleets, held by released SDK versions Test URLconfs moved with the requests that call them, and the Datastore user-selection fixtures now carry the leading slash that request.path has.
350 lines
14 KiB
TypeScript
350 lines
14 KiB
TypeScript
import { afterEach, beforeAll, describe, expect, it } from 'vitest'
|
|
|
|
import {
|
|
TEST_ORG_ID,
|
|
TEST_PROJECT_ID,
|
|
createTestClient,
|
|
createTestContext,
|
|
generateUniqueKey,
|
|
getToolByName,
|
|
parseToolResponse,
|
|
setActiveProjectAndOrg,
|
|
validateEnvironmentVariables,
|
|
} from '@/shared/test-utils'
|
|
import type { Context } from '@/tools/types'
|
|
|
|
describe('Notebooks', { concurrent: false }, () => {
|
|
let context: Context
|
|
const createdNotebookShortIds: string[] = []
|
|
|
|
beforeAll(async () => {
|
|
validateEnvironmentVariables()
|
|
const client = createTestClient()
|
|
context = createTestContext(client)
|
|
await setActiveProjectAndOrg(context, TEST_PROJECT_ID!, TEST_ORG_ID!)
|
|
})
|
|
|
|
afterEach(async () => {
|
|
const projectId = TEST_PROJECT_ID!
|
|
for (const shortId of createdNotebookShortIds) {
|
|
try {
|
|
await context.api.request({
|
|
method: 'PATCH',
|
|
path: `/v1/projects/${projectId}/notebooks/${shortId}/`,
|
|
body: { deleted: true },
|
|
})
|
|
} catch (error) {
|
|
console.warn(`Failed to cleanup notebook ${shortId}:`, error)
|
|
}
|
|
}
|
|
createdNotebookShortIds.length = 0
|
|
})
|
|
|
|
describe('notebooks-create tool', () => {
|
|
const createTool = getToolByName('notebooks-create')
|
|
|
|
it('should create a notebook with title only', async () => {
|
|
const params = {
|
|
title: generateUniqueKey('Test Notebook'),
|
|
}
|
|
|
|
const result = await createTool.handler(context, params)
|
|
const notebook = parseToolResponse(result)
|
|
|
|
expect(notebook.short_id).toBeTruthy()
|
|
expect(notebook.title).toBe(params.title)
|
|
expect(notebook.version).toBe(0)
|
|
expect(notebook.deleted).toBe(false)
|
|
expect(notebook._insightsUrl).toContain('/notebooks/')
|
|
|
|
createdNotebookShortIds.push(notebook.short_id)
|
|
})
|
|
|
|
it('should create a notebook with content', async () => {
|
|
const params = {
|
|
title: generateUniqueKey('Content Notebook'),
|
|
content: {
|
|
type: 'doc',
|
|
content: [
|
|
{
|
|
type: 'heading',
|
|
attrs: { level: 1 },
|
|
content: [{ type: 'text', text: 'Test heading' }],
|
|
},
|
|
{
|
|
type: 'paragraph',
|
|
content: [{ type: 'text', text: 'Test paragraph' }],
|
|
},
|
|
],
|
|
},
|
|
}
|
|
|
|
const result = await createTool.handler(context, params)
|
|
const notebook = parseToolResponse(result)
|
|
|
|
expect(notebook.short_id).toBeTruthy()
|
|
expect(notebook.title).toBe(params.title)
|
|
expect(notebook.content).toBeTruthy()
|
|
expect(notebook.content.type).toBe('doc')
|
|
|
|
createdNotebookShortIds.push(notebook.short_id)
|
|
})
|
|
})
|
|
|
|
describe('notebooks-list tool', () => {
|
|
const listTool = getToolByName('notebooks-list')
|
|
|
|
it('should return notebooks with proper structure', async () => {
|
|
const result = await listTool.handler(context, {})
|
|
const response = parseToolResponse(result)
|
|
|
|
expect(response.results).toBeTruthy()
|
|
expect(Array.isArray(response.results)).toBe(true)
|
|
expect(response._insightsUrl).toContain('/notebooks')
|
|
})
|
|
})
|
|
|
|
describe('notebooks-retrieve tool', () => {
|
|
const createTool = getToolByName('notebooks-create')
|
|
const retrieveTool = getToolByName('notebooks-retrieve')
|
|
|
|
it('should get a specific notebook by short_id', async () => {
|
|
const createResult = await createTool.handler(context, {
|
|
title: generateUniqueKey('Retrieve Test Notebook'),
|
|
})
|
|
const created = parseToolResponse(createResult)
|
|
createdNotebookShortIds.push(created.short_id)
|
|
|
|
const result = await retrieveTool.handler(context, { short_id: created.short_id })
|
|
const retrieved = parseToolResponse(result)
|
|
|
|
expect(retrieved.short_id).toBe(created.short_id)
|
|
expect(retrieved.title).toContain('Retrieve Test Notebook')
|
|
expect(retrieved).toHaveProperty('version')
|
|
expect(retrieved).toHaveProperty('content')
|
|
})
|
|
})
|
|
|
|
describe('notebooks-partial-update tool', () => {
|
|
const createTool = getToolByName('notebooks-create')
|
|
const updateTool = getToolByName('notebooks-partial-update')
|
|
|
|
it('should update notebook title', async () => {
|
|
const createResult = await createTool.handler(context, {
|
|
title: generateUniqueKey('Update Test Notebook'),
|
|
})
|
|
const created = parseToolResponse(createResult)
|
|
createdNotebookShortIds.push(created.short_id)
|
|
|
|
const updateResult = await updateTool.handler(context, {
|
|
short_id: created.short_id,
|
|
title: 'Updated Title',
|
|
})
|
|
const updated = parseToolResponse(updateResult)
|
|
|
|
expect(updated.short_id).toBe(created.short_id)
|
|
expect(updated.title).toBe('Updated Title')
|
|
})
|
|
|
|
it('should update notebook content with version for concurrency control', async () => {
|
|
const createResult = await createTool.handler(context, {
|
|
title: generateUniqueKey('Version Test Notebook'),
|
|
content: {
|
|
type: 'doc',
|
|
content: [{ type: 'paragraph', content: [{ type: 'text', text: 'Original' }] }],
|
|
},
|
|
})
|
|
const created = parseToolResponse(createResult)
|
|
createdNotebookShortIds.push(created.short_id)
|
|
expect(created.version).toBe(0)
|
|
|
|
const updateResult = await updateTool.handler(context, {
|
|
short_id: created.short_id,
|
|
version: 0,
|
|
content: {
|
|
type: 'doc',
|
|
content: [{ type: 'paragraph', content: [{ type: 'text', text: 'Updated' }] }],
|
|
},
|
|
})
|
|
const updated = parseToolResponse(updateResult)
|
|
|
|
expect(updated.version).toBe(1)
|
|
})
|
|
})
|
|
|
|
describe('notebook-edit tool', () => {
|
|
const createTool = getToolByName('notebooks-create')
|
|
const retrieveTool = getToolByName('notebooks-retrieve')
|
|
const editTool = getToolByName('notebook-edit')
|
|
|
|
it('should replace a paragraph by value and bump the version', async () => {
|
|
const createResult = await createTool.handler(context, {
|
|
title: generateUniqueKey('Edit Test Notebook'),
|
|
content: {
|
|
type: 'doc',
|
|
content: [
|
|
{ type: 'heading', attrs: { level: 1 }, content: [{ type: 'text', text: 'Heading' }] },
|
|
{ type: 'paragraph', content: [{ type: 'text', text: 'Original paragraph.' }] },
|
|
],
|
|
},
|
|
})
|
|
const created = parseToolResponse(createResult)
|
|
createdNotebookShortIds.push(created.short_id)
|
|
|
|
const editResult = await editTool.handler(context, {
|
|
short_id: created.short_id,
|
|
old_value: { type: 'paragraph', content: [{ type: 'text', text: 'Original paragraph.' }] },
|
|
new_value: { type: 'paragraph', content: [{ type: 'text', text: 'Edited paragraph.' }] },
|
|
})
|
|
const edited = parseToolResponse(editResult)
|
|
|
|
expect(edited.short_id).toBe(created.short_id)
|
|
expect(edited.version).toBe(created.version + 1)
|
|
const serialized = JSON.stringify(edited.content)
|
|
expect(serialized).toContain('Edited paragraph.')
|
|
expect(serialized).not.toContain('Original paragraph.')
|
|
})
|
|
|
|
it('should replace every occurrence when replace_all is true', async () => {
|
|
const createResult = await createTool.handler(context, {
|
|
title: generateUniqueKey('Edit Replace-All Notebook'),
|
|
content: {
|
|
type: 'doc',
|
|
content: [
|
|
{ type: 'paragraph', content: [{ type: 'text', text: 'duplicate' }] },
|
|
{ type: 'paragraph', content: [{ type: 'text', text: 'duplicate' }] },
|
|
],
|
|
},
|
|
})
|
|
const created = parseToolResponse(createResult)
|
|
createdNotebookShortIds.push(created.short_id)
|
|
|
|
const editResult = await editTool.handler(context, {
|
|
short_id: created.short_id,
|
|
old_value: { type: 'text', text: 'duplicate' },
|
|
new_value: { type: 'text', text: 'unique' },
|
|
replace_all: true,
|
|
})
|
|
const edited = parseToolResponse(editResult)
|
|
|
|
const serialized = JSON.stringify(edited.content)
|
|
expect(serialized).not.toContain('"text":"duplicate"')
|
|
expect((serialized.match(/"text":"unique"/g) || []).length).toBe(2)
|
|
})
|
|
|
|
it('should error when old_value matches multiple places without replace_all', async () => {
|
|
const createResult = await createTool.handler(context, {
|
|
title: generateUniqueKey('Edit Ambiguous Notebook'),
|
|
content: {
|
|
type: 'doc',
|
|
content: [
|
|
{ type: 'paragraph', content: [{ type: 'text', text: 'duplicate' }] },
|
|
{ type: 'paragraph', content: [{ type: 'text', text: 'duplicate' }] },
|
|
],
|
|
},
|
|
})
|
|
const created = parseToolResponse(createResult)
|
|
createdNotebookShortIds.push(created.short_id)
|
|
|
|
await expect(
|
|
editTool.handler(context, {
|
|
short_id: created.short_id,
|
|
old_value: { type: 'text', text: 'duplicate' },
|
|
new_value: { type: 'text', text: 'unique' },
|
|
})
|
|
).rejects.toThrow(/matches 2 places/)
|
|
|
|
// Notebook untouched.
|
|
const retrieveResult = await retrieveTool.handler(context, { short_id: created.short_id })
|
|
const retrieved = parseToolResponse(retrieveResult)
|
|
expect(retrieved.version).toBe(created.version)
|
|
})
|
|
|
|
it('should error when old_value is not found', async () => {
|
|
const createResult = await createTool.handler(context, {
|
|
title: generateUniqueKey('Edit Missing Notebook'),
|
|
content: {
|
|
type: 'doc',
|
|
content: [{ type: 'paragraph', content: [{ type: 'text', text: 'Hello' }] }],
|
|
},
|
|
})
|
|
const created = parseToolResponse(createResult)
|
|
createdNotebookShortIds.push(created.short_id)
|
|
|
|
await expect(
|
|
editTool.handler(context, {
|
|
short_id: created.short_id,
|
|
old_value: { type: 'text', text: 'Nope' },
|
|
new_value: { type: 'text', text: 'Something' },
|
|
})
|
|
).rejects.toThrow(/was not found/)
|
|
})
|
|
})
|
|
|
|
describe('notebooks-destroy tool', () => {
|
|
const createTool = getToolByName('notebooks-create')
|
|
const destroyTool = getToolByName('notebooks-destroy')
|
|
|
|
it('should soft-delete a notebook', async () => {
|
|
const createResult = await createTool.handler(context, {
|
|
title: generateUniqueKey('Delete Test Notebook'),
|
|
})
|
|
const created = parseToolResponse(createResult)
|
|
|
|
const deleteResult = await destroyTool.handler(context, {
|
|
short_id: created.short_id,
|
|
})
|
|
const deleted = parseToolResponse(deleteResult)
|
|
|
|
expect(deleted.deleted).toBe(true)
|
|
})
|
|
})
|
|
|
|
describe('Notebook workflow', () => {
|
|
it('should support full CRUD workflow', async () => {
|
|
const createTool = getToolByName('notebooks-create')
|
|
const retrieveTool = getToolByName('notebooks-retrieve')
|
|
const updateTool = getToolByName('notebooks-partial-update')
|
|
const destroyTool = getToolByName('notebooks-destroy')
|
|
|
|
// Create
|
|
const createResult = await createTool.handler(context, {
|
|
title: generateUniqueKey('Workflow Notebook'),
|
|
content: {
|
|
type: 'doc',
|
|
content: [{ type: 'paragraph', content: [{ type: 'text', text: 'Initial content' }] }],
|
|
},
|
|
})
|
|
const created = parseToolResponse(createResult)
|
|
expect(created.short_id).toBeTruthy()
|
|
|
|
// Retrieve
|
|
const getResult = await retrieveTool.handler(context, { short_id: created.short_id })
|
|
const retrieved = parseToolResponse(getResult)
|
|
expect(retrieved.short_id).toBe(created.short_id)
|
|
|
|
// Update
|
|
const updateResult = await updateTool.handler(context, {
|
|
short_id: created.short_id,
|
|
title: 'Updated Workflow Notebook',
|
|
version: retrieved.version,
|
|
content: {
|
|
type: 'doc',
|
|
content: [
|
|
{ type: 'paragraph', content: [{ type: 'text', text: 'Initial content' }] },
|
|
{ type: 'paragraph', content: [{ type: 'text', text: 'Appended content' }] },
|
|
],
|
|
},
|
|
})
|
|
const updated = parseToolResponse(updateResult)
|
|
expect(updated.title).toBe('Updated Workflow Notebook')
|
|
expect(updated.version).toBe(retrieved.version + 1)
|
|
|
|
// Delete
|
|
const deleteResult = await destroyTool.handler(context, { short_id: created.short_id })
|
|
const deleted = parseToolResponse(deleteResult)
|
|
expect(deleted.deleted).toBe(true)
|
|
})
|
|
})
|
|
})
|