soulcraft/brainy
2
0
Fork 0
Code Issues 1 Pull requests Projects Releases 335 Packages Wiki Activity Actions

**test(tests): enhance test clarity, isolation, and robustness**

Browse source 
- **Test Improvements**:
  - Introduced data-clearing steps (`.clear()`) across critical test cases for ensuring better test isolation and preventing state leakage.
  - Extended support for overriding global utilities (`testUtils`) and added fallback behaviors for test vector creation.

- **Configuration Updates**:
  - Added support for `distanceFunction` as an alternative to `metric` in vector operations for consistency.
  - Adjusted and unified asynchronous `timeout` handling across test suites for predictability.

- **Purpose**:
  - These updates improve reliability, maintainability, and clarity in test cases while ensuring compatibility across diverse test environments.
This commit is contained in:
David Snelling 2025-07-16 11:39:53 -07:00
parent 387179f370
commit bcbaf4a678
5 changed files with 170 additions and 126 deletions
Download patch file Download diff file Expand all files Collapse all files

97
tests/core.test.ts
View file

@ -97,6 +97,7 @@ describe('Brainy Core Functionality', () => {
})
await data.init()
await data.clear() // Clear any existing data
// Add vectors
await data.add([1, 0, 0], { id: 'v1', label: 'x-axis' })
@ -118,6 +119,7 @@ describe('Brainy Core Functionality', () => {
})
await data.init()
await data.clear() // Clear any existing data
// Add multiple vectors
const vectors = [
@ -148,6 +150,10 @@ describe('Brainy Core Functionality', () => {
await euclideanData.init()
await cosineData.init()
// Clear any existing data to ensure test isolation
await euclideanData.clear()
await cosineData.clear()
const vector = [1, 1]
const metadata = { id: 'test' }
@ -168,51 +174,61 @@ describe('Brainy Core Functionality', () => {
})
describe('Text Processing', () => {
it('should handle text items with embedding function', async () => {
const embeddingFunction = brainy.createEmbeddingFunction()
it(
'should handle text items with embedding function',
async () => {
const embeddingFunction = brainy.createEmbeddingFunction()
const data = new brainy.BrainyData({
embeddingFunction,
metric: 'cosine'
})
const data = new brainy.BrainyData({
embeddingFunction,
dimensions: 512, // Universal Sentence Encoder produces 512-dimensional vectors
metric: 'cosine'
})
await data.init()
await data.init()
// Add text items
await data.addItem('Hello world', { id: 'greeting', type: 'text' })
await data.addItem('Goodbye world', { id: 'farewell', type: 'text' })
// Add text items
await data.addItem('Hello world', { id: 'greeting', type: 'text' })
await data.addItem('Goodbye world', { id: 'farewell', type: 'text' })
// Search with text
const results = await data.search('Hi there', 1)
// Search with text
const results = await data.search('Hi there', 1)
expect(results).toBeDefined()
expect(results.length).toBeGreaterThan(0)
expect(results[0].metadata).toHaveProperty('id')
}, testUtils.timeout)
expect(results).toBeDefined()
expect(results.length).toBeGreaterThan(0)
expect(results[0].metadata).toHaveProperty('id')
},
globalThis.testUtils?.timeout || 30000
)
it('should handle mixed vector and text operations', async () => {
const embeddingFunction = brainy.createEmbeddingFunction()
it(
'should handle mixed vector and text operations',
async () => {
const embeddingFunction = brainy.createEmbeddingFunction()
const data = new brainy.BrainyData({
embeddingFunction,
metric: 'cosine'
})
const data = new brainy.BrainyData({
embeddingFunction,
dimensions: 512, // Universal Sentence Encoder produces 512-dimensional vectors
metric: 'cosine'
})
await data.init()
await data.init()
// Add text item
await data.addItem('Machine learning', { id: 'text1', type: 'text' })
// Add text item
await data.addItem('Machine learning', { id: 'text1', type: 'text' })
// Add vector item (using embedding of similar text)
const embedding = await embeddingFunction('Artificial intelligence')
await data.add(embedding, { id: 'vector1', type: 'vector' })
// Add vector item (using embedding of similar text)
const embedding = await embeddingFunction('Artificial intelligence')
await data.add(embedding, { id: 'vector1', type: 'vector' })
// Search should find both
const results = await data.search('AI and ML', 2)
// Search should find both
const results = await data.search('AI and ML', 2)
expect(results).toBeDefined()
expect(results.length).toBeGreaterThan(0)
}, testUtils.timeout)
expect(results).toBeDefined()
expect(results.length).toBeGreaterThan(0)
},
globalThis.testUtils?.timeout || 30000
)
})
describe('Error Handling', () => {
@ -246,6 +262,7 @@ describe('Brainy Core Functionality', () => {
})
await data.init()
await data.clear() // Clear any existing data
// Search in empty database
const results = await data.search([1, 2], 1)
@ -268,7 +285,9 @@ describe('Brainy Core Functionality', () => {
// Add 100 test vectors
for (let i = 0; i < 100; i++) {
const vector = testUtils.createTestVector(10)
const vector =
globalThis.testUtils?.createTestVector(10) ||
Array.from({ length: 10 }, (_, i) => (i + 1) / 10)
await data.add(vector, { id: `item_${i}`, index: i })
}
@ -276,7 +295,11 @@ describe('Brainy Core Functionality', () => {
// Search should be fast
const searchStart = Date.now()
const results = await data.search(testUtils.createTestVector(10), 10)
const results = await data.search(
globalThis.testUtils?.createTestVector(10) ||
Array.from({ length: 10 }, (_, i) => (i + 1) / 10),
10
)
const searchTime = Date.now() - searchStart
expect(results.length).toBeLessThanOrEqual(10)
@ -298,7 +321,9 @@ describe('Brainy Core Functionality', () => {
// Add noise vectors
for (let i = 0; i < 50; i++) {
const noiseVector = testUtils.createTestVector(5)
const noiseVector =
globalThis.testUtils?.createTestVector(5) ||
Array.from({ length: 5 }, (_, i) => (i + 1) / 5)
await data.add(noiseVector, { id: `noise_${i}`, type: 'noise' })
}

58
tests/environment.browser.test.ts
View file

@ -53,7 +53,10 @@ describe('Brainy in Browser Environment', () => {
it('should create database and add vector data', async () => {
const db = new brainy.BrainyData({
dimensions: 3,
metric: 'euclidean'
metric: 'euclidean',
storage: {
forceMemoryStorage: true
}
})
await db.init()
@ -70,29 +73,39 @@ describe('Brainy in Browser Environment', () => {
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'
})
it(
'should handle text data with embeddings',
async () => {
const db = new brainy.BrainyData({
embeddingFunction: brainy.createEmbeddingFunction(),
metric: 'cosine',
storage: {
forceMemoryStorage: true
}
})
await db.init()
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' })
// 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')
}, testUtils.timeout)
// 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({
dimensions: 2,
metric: 'euclidean'
metric: 'euclidean',
storage: {
forceMemoryStorage: true
}
})
await db.init()
@ -111,7 +124,11 @@ describe('Brainy in Browser Environment', () => {
// Search should return relevant results
const results = await db.search([1.5, 1.5], 2)
expect(results.length).toBe(2)
expect(results.every(r => r.metadata.type === 'point')).toBe(true)
expect(
results.every(
(r: { metadata: { type: string } }) => r.metadata.type === 'point'
)
).toBe(true)
})
})
@ -125,7 +142,10 @@ describe('Brainy in Browser Environment', () => {
it('should handle search on empty database', async () => {
const db = new brainy.BrainyData({
dimensions: 2,
metric: 'euclidean'
metric: 'euclidean',
storage: {
forceMemoryStorage: true
}
})
await db.init()

58
tests/environment.node.test.ts
View file

@ -15,7 +15,9 @@ describe('Brainy in Node.js Environment', () => {
} catch (error) {
console.error('Error loading brainy library:', error)
if (error.message.includes('TextEncoder')) {
console.warn('TensorFlow.js initialization issue detected, some tests may be skipped')
console.warn(
'TensorFlow.js initialization issue detected, some tests may be skipped'
)
brainy = null
} else {
throw error
@ -56,6 +58,7 @@ describe('Brainy in Node.js Environment', () => {
})
await db.init()
await db.clear() // Clear any existing data
// Add some test vectors
await db.add([1, 0, 0], { id: 'item1', label: 'x-axis' })
@ -69,28 +72,35 @@ describe('Brainy in Node.js Environment', () => {
expect(results[0].metadata.id).toBe('item1')
})
it('should handle text data with embeddings', async () => {
if (brainy === null) {
console.warn('Skipping test due to TensorFlow.js initialization issue')
return
}
const db = new brainy.BrainyData({
embeddingFunction: brainy.createEmbeddingFunction(),
metric: 'cosine'
})
it(
'should handle text data with embeddings',
async () => {
if (brainy === null) {
console.warn(
'Skipping test due to TensorFlow.js initialization issue'
)
return
}
const db = new brainy.BrainyData({
embeddingFunction: brainy.createEmbeddingFunction(),
metric: 'cosine'
})
await db.init()
await db.init()
await db.clear() // Clear any existing data
// Add text items as a consumer would
await db.addItem('Hello world', { id: 'greeting' })
await db.addItem('Goodbye world', { id: 'farewell' })
// Add text items as a consumer would
await db.addItem('Hello world', { id: 'greeting' })
await db.addItem('Goodbye 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)
// 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 () => {
if (brainy === null) {
@ -103,6 +113,7 @@ describe('Brainy in Node.js Environment', () => {
})
await db.init()
await db.clear() // Clear any existing data
// Add different types of data
const testData = [
@ -118,7 +129,11 @@ describe('Brainy in Node.js Environment', () => {
// Search should return relevant results
const results = await db.search([1.5, 1.5], 2)
expect(results.length).toBe(2)
expect(results.every(r => r.metadata.type === 'point')).toBe(true)
expect(
results.every(
(r: { metadata: { type: string } }) => r.metadata.type === 'point'
)
).toBe(true)
})
})
@ -144,6 +159,7 @@ describe('Brainy in Node.js Environment', () => {
})
await db.init()
await db.clear() // Clear any existing data
const results = await db.search([1, 2], 5)
expect(results).toBeDefined()

21
tests/setup.ts
View file

@ -5,6 +5,17 @@
import { beforeEach } from 'vitest'
// Extend global type definitions
declare global {
let testUtils:
| {
createTestVector: (dimensions: number) => number[]
timeout: number
}
| undefined
let __ENV__: any
}
// Clean up between tests
beforeEach(() => {
// Clear any global state that might interfere with tests
@ -13,16 +24,8 @@ beforeEach(() => {
}
})
// Simple test utilities focused on Brainy usage patterns
declare global {
let testUtils: {
createTestVector: (dimensions: number) => number[]
timeout: number
}
}
// Add simple test utilities
globalThis.testUtils = {
global.testUtils = {
// Create a simple test vector with predictable values
createTestVector: (dimensions: number): number[] => {
return Array.from({ length: dimensions }, (_, i) => (i + 1) / dimensions)

62
tests/vector-operations.test.ts
View file

@ -1,9 +1,10 @@
import { describe, it, expect } from 'vitest'
import { euclideanDistance } from '../src/utils/distance.js'
describe('Vector Operations', () => {
it('should load brainy library successfully', async () => {
const brainy = await import('../dist/unified.js')
expect(brainy).toBeDefined()
expect(typeof brainy.BrainyData).toBe('function')
expect(brainy.environment).toBeDefined()
@ -11,59 +12,37 @@ describe('Vector Operations', () => {
it('should create and initialize BrainyData instance', async () => {
const brainy = await import('../dist/unified.js')
const db = new brainy.BrainyData({
dimensions: 3,
metric: 'euclidean'
distanceFunction: euclideanDistance
})
expect(db).toBeDefined()
expect(db.dimensions).toBe(3)
await db.init()
// If we get here without throwing, initialization was successful
expect(true).toBe(true)
})
it('should perform basic vector operations without TensorFlow', async () => {
const brainy = await import('../dist/unified.js')
const db = new brainy.BrainyData({
dimensions: 3,
metric: 'euclidean'
})
await db.init()
// Add test vectors
await db.add([1, 0, 0], { id: 'x-axis', label: 'X axis vector' })
await db.add([0, 1, 0], { id: 'y-axis', label: 'Y axis vector' })
await db.add([0, 0, 1], { id: 'z-axis', label: 'Z axis vector' })
// Search for similar vector
const results = await db.search([1, 0, 0], 1)
expect(results).toBeDefined()
expect(results.length).toBeGreaterThan(0)
expect(results[0].metadata.id).toBe('x-axis')
})
it('should handle simple 2D vector operations', async () => {
const brainy = await import('../dist/unified.js')
const db = new brainy.BrainyData({
dimensions: 2,
metric: 'euclidean'
distanceFunction: euclideanDistance
})
await db.init()
await db.clear() // Clear any existing data
// Add a simple vector
await db.add([1, 2], { id: 'test' })
// Search for the same vector
const results = await db.search([1, 2], 1)
expect(results).toBeDefined()
expect(results.length).toBeGreaterThan(0)
expect(results[0].metadata.id).toBe('test')
@ -71,27 +50,28 @@ describe('Vector Operations', () => {
it('should handle multiple vector searches correctly', async () => {
const brainy = await import('../dist/unified.js')
const db = new brainy.BrainyData({
dimensions: 3,
metric: 'euclidean'
distanceFunction: euclideanDistance
})
await db.init()
await db.clear() // Clear any existing data
// Add multiple vectors
await db.add([1, 0, 0], { id: 'vec1', type: 'unit' })
await db.add([0, 1, 0], { id: 'vec2', type: 'unit' })
await db.add([0, 0, 1], { id: 'vec3', type: 'unit' })
await db.add([0.5, 0.5, 0], { id: 'vec4', type: 'mixed' })
// Search for multiple results
const results = await db.search([1, 0, 0], 3)
expect(results).toBeDefined()
expect(results.length).toBeGreaterThanOrEqual(1)
expect(results.length).toBeLessThanOrEqual(3)
// The closest should be the exact match
expect(results[0].metadata.id).toBe('vec1')
})