brainy/tests/environment.browser.test.ts
dpsifr 86fb1220b6 **feat(core, migration, docs): introduce dimension mismatch resolution tools and migration guide**
- **Core**:
  - Added `check-database.js` to verify database status and validate search functionality.
  - Created `fix-dimension-mismatch.js` to handle re-embedding of existing data to resolve dimension mismatch from 3 to 512.
  - Improved test cases by updating vector operations to support 512 dimensions, replacing previously hardcoded dimensions.

- **Migration**:
  - Developed `DIMENSION_MISMATCH_SUMMARY.md`, detailing the root cause, solution, and preventive strategies for dimension mismatch issues.
  - Added `production-migration-guide.md` for structured production migration with detailed steps on re-embedding strategies, batching, and error handling.

- **Tests**:
  - Enhanced test coverage with 512-dimensional vector validation.
  - Introduced helper functions for consistent vector testing behavior and streamlined search test cases.

- **Documentation**:
  - Updated project documentation to highlight the resolution process for dimension mismatches, emphasizing preventive mechanisms such as auto-migration and version tracking.

**Purpose**: Address critical dimension mismatch issues caused by embedding changes, restore functionality, and provide a roadmap for robust prevention strategies and migration processes.
2025-07-25 13:38:56 -07:00

168 lines
4.9 KiB
TypeScript

/**
* Browser Environment Tests
* Tests Brainy functionality in browser environment as a consumer would use it
* @vitest-environment jsdom
*/
import { describe, it, expect, beforeAll, vi } from 'vitest'
/**
* Helper function to create a 512-dimensional vector for testing
* @param primaryIndex The index to set to 1.0, all other indices will be 0.0
* @returns A 512-dimensional vector with a single 1.0 value at the specified index
*/
function createTestVector(primaryIndex: number = 0): number[] {
const vector = new Array(512).fill(0)
vector[primaryIndex % 512] = 1.0
return vector
}
describe('Brainy in Browser Environment', () => {
let brainy: any
beforeAll(async () => {
// Minimal browser environment setup for jsdom
if (typeof window !== 'undefined') {
Object.defineProperty(window, 'TextEncoder', {
writable: true,
value: TextEncoder
})
Object.defineProperty(window, 'TextDecoder', {
writable: true,
value: TextDecoder
})
// Mock Web Workers for jsdom
Object.defineProperty(window, 'Worker', {
writable: true,
value: vi.fn().mockImplementation(() => ({
postMessage: vi.fn(),
terminate: vi.fn(),
addEventListener: vi.fn(),
removeEventListener: vi.fn()
}))
})
}
// Load brainy library as a consumer would
brainy = await import('../dist/unified.js')
})
describe('Library Loading', () => {
it('should load brainy library successfully', () => {
expect(brainy).toBeDefined()
expect(brainy.BrainyData).toBeDefined()
expect(typeof brainy.BrainyData).toBe('function')
})
it('should detect browser environment correctly', () => {
expect(brainy.environment.isBrowser).toBe(true)
expect(brainy.environment.isNode).toBe(false)
})
})
describe('Core Functionality - Add Data and Search', () => {
it('should create database and add vector data', async () => {
const db = new brainy.BrainyData({
metric: 'euclidean',
storage: {
forceMemoryStorage: true
}
})
await db.init()
// Add some test vectors
await db.add(createTestVector(0), { id: 'item1', label: 'x-axis' })
await db.add(createTestVector(1), { id: 'item2', label: 'y-axis' })
await db.add(createTestVector(2), { id: 'item3', label: 'z-axis' })
// Search should work
const results = await db.search(createTestVector(0), 1)
expect(results).toBeDefined()
expect(results.length).toBe(1)
expect(results[0].metadata.id).toBe('item1')
})
it(
'should handle text data with embeddings',
async () => {
const db = new brainy.BrainyData({
embeddingFunction: brainy.createEmbeddingFunction(),
metric: 'cosine',
storage: {
forceMemoryStorage: true
}
})
await db.init()
// Add text items as a consumer would
await db.addItem('Hello browser world', { id: 'greeting' })
await db.addItem('Goodbye browser world', { id: 'farewell' })
// Search with text
const results = await db.search('Hi there', 1)
expect(results).toBeDefined()
expect(results.length).toBeGreaterThan(0)
expect(results[0].metadata).toHaveProperty('id')
},
globalThis.testUtils?.timeout || 30000
)
it('should handle multiple data types', async () => {
const db = new brainy.BrainyData({
metric: 'euclidean',
storage: {
forceMemoryStorage: true
}
})
await db.init()
// Add different types of data
const testData = [
{ vector: createTestVector(10), metadata: { type: 'point', name: 'A' } },
{ vector: createTestVector(20), metadata: { type: 'point', name: 'B' } },
{ vector: createTestVector(30), metadata: { type: 'point', name: 'C' } }
]
for (const item of testData) {
await db.add(item.vector, item.metadata)
}
// Search should return relevant results
const results = await db.search(createTestVector(15), 2)
expect(results.length).toBe(2)
expect(
results.every(
(r: { metadata: { type: string } }) => r.metadata.type === 'point'
)
).toBe(true)
})
})
describe('Error Handling', () => {
it('should not throw with valid configuration', () => {
expect(() => {
new brainy.BrainyData({ metric: 'euclidean' })
}).not.toThrow()
})
it('should handle search on empty database', async () => {
const db = new brainy.BrainyData({
metric: 'euclidean',
storage: {
forceMemoryStorage: true
}
})
await db.init()
const results = await db.search(createTestVector(0), 5)
expect(results).toBeDefined()
expect(Array.isArray(results)).toBe(true)
expect(results.length).toBe(0)
})
})
})