brainy/tests/environment.node.test.ts
David Snelling e6514b10cf **feat(core): enhance logging, storage options, and testing coverage**
- **Core Improvements**:
  - Refactored logging functions into a unified `logger` method for consistent output across the library.
  - Enabled the `forceMemoryStorage` option in `BrainyData` initialization for improved storage flexibility in tests and specific use cases.

- **TensorFlow.js and Environment Updates**:
  - Clarified the dependency structure in `README.md` to emphasize bundled dependencies and remove legacy peer dependency instructions.
  - Simplified and reformatted environment detection logic for better maintainability and readability.

- **Testing Enhancements**:
  - Added `tests/package-size-limit.test.ts` to monitor and validate npm package size against defined thresholds.
  - Updated `tests/environment.node.test.ts` and core tests to leverage `forceMemoryStorage` for better test setup standardization.
  - Improved test isolation with expanded `globalThis` utility definitions and cleanup logic.

- **Documentation**:
  - Added detailed best practices for debugging and organizing tests in `DEVELOPERS.md`.
  - Removed outdated installation hints from `package.json` and streamlined scripts by including `test:size` for package size validation.

**Purpose**: These changes unify core logging mechanisms, expand configurability of storage options, and improve testing reliability and coverage. Documentation and clarity are enhanced to align with updated functionality and best practices.
2025-07-17 10:00:28 -07:00

182 lines
5.2 KiB
TypeScript

/**
* Node.js Environment Tests
* Tests Brainy functionality in Node.js environment as a consumer would use it
*/
import { describe, it, expect, beforeAll } from 'vitest'
describe('Brainy in Node.js Environment', () => {
let brainy: any
beforeAll(async () => {
// Load brainy library as a consumer would
try {
brainy = await import('../dist/unified.js')
} 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'
)
brainy = null
} else {
throw error
}
}
})
describe('Library Loading', () => {
it('should load brainy library successfully', () => {
if (brainy === null) {
console.warn('Skipping test due to TensorFlow.js initialization issue')
return
}
expect(brainy).toBeDefined()
expect(brainy.BrainyData).toBeDefined()
expect(typeof brainy.BrainyData).toBe('function')
})
it('should detect Node.js environment correctly', () => {
if (brainy === null) {
console.warn('Skipping test due to TensorFlow.js initialization issue')
return
}
expect(brainy.environment.isNode).toBe(true)
expect(brainy.environment.isBrowser).toBe(false)
})
})
describe('Core Functionality - Add Data and Search', () => {
it('should create database and add vector data', async () => {
if (brainy === null) {
console.warn('Skipping test due to TensorFlow.js initialization issue')
return
}
const db = new brainy.BrainyData({
dimensions: 3,
metric: 'euclidean',
storage: {
forceMemoryStorage: true
}
})
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' })
await db.add([0, 1, 0], { id: 'item2', label: 'y-axis' })
await db.add([0, 0, 1], { id: 'item3', label: 'z-axis' })
// Search should work
const results = await db.search([1, 0, 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 () => {
if (brainy === null) {
console.warn(
'Skipping test due to TensorFlow.js initialization issue'
)
return
}
const db = new brainy.BrainyData({
embeddingFunction: brainy.createEmbeddingFunction(),
metric: 'cosine',
storage: {
forceMemoryStorage: true
}
})
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' })
// 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) {
console.warn('Skipping test due to TensorFlow.js initialization issue')
return
}
const db = new brainy.BrainyData({
dimensions: 2,
metric: 'euclidean',
storage: {
forceMemoryStorage: true
}
})
await db.init()
await db.clear() // Clear any existing data
// Add different types of data
const testData = [
{ vector: [1, 1], metadata: { type: 'point', name: 'A' } },
{ vector: [2, 2], metadata: { type: 'point', name: 'B' } },
{ vector: [3, 3], 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([1.5, 1.5], 2)
expect(results.length).toBe(2)
expect(
results.every(
(r: { metadata: { type: string } }) => r.metadata.type === 'point'
)
).toBe(true)
})
})
describe('Error Handling', () => {
it('should handle invalid configurations gracefully', () => {
if (brainy === null) {
console.warn('Skipping test due to TensorFlow.js initialization issue')
return
}
expect(() => {
new brainy.BrainyData({ dimensions: 0 })
}).toThrow()
})
it('should handle search on empty database', async () => {
if (brainy === null) {
console.warn('Skipping test due to TensorFlow.js initialization issue')
return
}
const db = new brainy.BrainyData({
dimensions: 2,
metric: 'euclidean',
storage: {
forceMemoryStorage: true
}
})
await db.init()
await db.clear() // Clear any existing data
const results = await db.search([1, 2], 5)
expect(results).toBeDefined()
expect(Array.isArray(results)).toBe(true)
expect(results.length).toBe(0)
})
})
})