feat: replace transformers.js with direct ONNX WASM for Bun compatibility

- Remove @huggingface/transformers dependency (539MB native binaries)
- Add direct ONNX Runtime Web embedding engine
- Bundle all-MiniLM-L6-v2-q8 model (24MB, no runtime downloads)
- Works with Node.js, Bun, and bun build --compile
- Air-gap compatible: fully self-contained, no internet required

New WASM embedding components:
- WASMEmbeddingEngine: Main integration class
- WordPieceTokenizer: Pure TypeScript tokenizer
- EmbeddingPostProcessor: Mean pooling + L2 normalization
- ONNXInferenceEngine: Direct ONNX Runtime Web wrapper
- AssetLoader: Model file loading

Tests added:
- 11 WASM embedding integration tests
- 8 Bun compatibility tests

New npm scripts:
- test:wasm - Run WASM embedding tests
- test:bun - Run tests with Bun
- test:bun:compile - Build and run compiled binary
This commit is contained in:
David Snelling 2025-12-17 17:42:37 -08:00
parent c1deb7a623
commit 1f59aa2013
21 changed files with 34431 additions and 3459 deletions

View file

@ -1,330 +1,131 @@
/**
* MODEL GUARDIAN - CRITICAL PATH
*
*
* THIS IS THE MOST CRITICAL COMPONENT OF BRAINY
* Without the exact model, users CANNOT access their data
*
*
* Requirements:
* 1. Model MUST be Xenova/all-MiniLM-L6-v2 (never changes)
* 2. Model MUST be available at runtime
* 1. Model MUST be all-MiniLM-L6-v2-q8 (bundled in package)
* 2. Model MUST be available at runtime (embedded in npm package)
* 3. Model MUST produce consistent 384-dim embeddings
* 4. System MUST fail fast if model unavailable in production
*/
import { env } from '@huggingface/transformers'
import { createHash } from '../universal/crypto.js'
import { WASMEmbeddingEngine } from '../embeddings/wasm/index.js'
// CRITICAL: These values MUST NEVER CHANGE
const CRITICAL_MODEL_CONFIG = {
modelName: 'Xenova/all-MiniLM-L6-v2',
modelHash: {
// SHA256 of model.onnx - computed from actual model
'onnx/model.onnx': 'add_actual_hash_here',
'tokenizer.json': 'add_actual_hash_here'
} as Record<string, string>,
modelSize: {
'onnx/model.onnx': 90387606, // Exact size in bytes (updated to match actual file)
'tokenizer.json': 711661
} as Record<string, number>,
modelName: 'all-MiniLM-L6-v2-q8',
embeddingDimensions: 384,
fallbackSources: [
// Primary: Our Google Cloud Storage CDN (we control this, fastest)
{
name: 'Soulcraft CDN (Primary)',
url: 'https://models.soulcraft.com/models/all-MiniLM-L6-v2.tar.gz',
type: 'tarball'
},
// Secondary: GitHub releases backup
{
name: 'GitHub Backup',
url: 'https://github.com/soulcraftlabs/brainy-models/releases/download/v1.0.0/all-MiniLM-L6-v2.tar.gz',
type: 'tarball'
},
// Tertiary: Hugging Face (original source)
{
name: 'Hugging Face',
url: 'huggingface',
type: 'transformers'
}
]
// Model is bundled in package - no external downloads needed
bundled: true
}
export class ModelGuardian {
private static instance: ModelGuardian
private isVerified = false
private modelPath: string
private lastVerification: Date | null = null
private constructor() {
this.modelPath = this.detectModelPath()
// Model is bundled - no path detection needed
}
static getInstance(): ModelGuardian {
if (!ModelGuardian.instance) {
ModelGuardian.instance = new ModelGuardian()
}
return ModelGuardian.instance
}
/**
* CRITICAL: Verify model availability and integrity
* This MUST be called before any embedding operations
*/
async ensureCriticalModel(): Promise<void> {
console.log('DEBUG: ensureCriticalModel called')
console.log('🛡️ MODEL GUARDIAN: Verifying critical model availability...')
console.log(`🚀 Debug: Model path: ${this.modelPath}`)
console.log(`🚀 Debug: Already verified: ${this.isVerified}`)
// Check if already verified in this session
if (this.isVerified && this.lastVerification) {
const hoursSinceVerification =
const hoursSinceVerification =
(Date.now() - this.lastVerification.getTime()) / (1000 * 60 * 60)
if (hoursSinceVerification < 24) {
console.log('✅ Model previously verified in this session')
return
}
}
// Step 1: Check if model exists locally
console.log('🔍 Debug: Calling verifyLocalModel()')
const modelExists = await this.verifyLocalModel()
if (modelExists) {
console.log('✅ Critical model verified locally')
// Verify the bundled WASM model works
const modelWorks = await this.verifyBundledModel()
if (modelWorks) {
this.isVerified = true
this.lastVerification = new Date()
this.configureTransformers()
return
}
// Step 2: In production, FAIL FAST (Node.js only)
if (typeof window === 'undefined' && process.env.NODE_ENV === 'production' && !process.env.BRAINY_ALLOW_RUNTIME_DOWNLOAD) {
throw new Error(
'🚨 CRITICAL FAILURE: Transformer model not found in production!\n' +
'The model is REQUIRED for Brainy to function.\n' +
'Users CANNOT access their data without it.\n' +
'Solution: Run "npm run download-models" during build stage.'
)
}
// Step 3: Attempt to download from fallback sources
console.warn('⚠️ Model not found locally, attempting download...')
for (const source of CRITICAL_MODEL_CONFIG.fallbackSources) {
try {
console.log(`📥 Trying ${source.name}...`)
await this.downloadFromSource(source)
// Verify the download
if (await this.verifyLocalModel()) {
console.log(`✅ Successfully downloaded from ${source.name}`)
this.isVerified = true
this.lastVerification = new Date()
this.configureTransformers()
return
}
} catch (error) {
console.warn(`${source.name} failed:`, (error as Error).message)
}
}
// Step 4: CRITICAL FAILURE
// CRITICAL FAILURE
throw new Error(
'🚨 CRITICAL FAILURE: Cannot obtain transformer model!\n' +
'Tried all fallback sources.\n' +
'Brainy CANNOT function without the model.\n' +
'Users CANNOT access their data.\n' +
'Please check network connectivity or pre-download models.'
'🚨 CRITICAL FAILURE: Bundled transformer model not working!\n' +
'The model is REQUIRED for Brainy to function.\n' +
'Users CANNOT access their data without it.\n' +
'This indicates a package installation issue.'
)
}
/**
* Verify the local model files exist and are correct
* Verify the bundled WASM model works correctly
*/
private async verifyLocalModel(): Promise<boolean> {
// Browser doesn't have local file access
if (typeof window !== 'undefined') {
console.log('⚠️ Model verification skipped in browser environment')
return false
}
private async verifyBundledModel(): Promise<boolean> {
try {
const engine = WASMEmbeddingEngine.getInstance()
// Dynamically import Node.js modules
const fs = await import('node:fs')
const fsPromises = await import('node:fs/promises')
const path = await import('node:path')
// Initialize the engine (loads bundled model)
await engine.initialize()
const modelBasePath = path.join(this.modelPath, ...CRITICAL_MODEL_CONFIG.modelName.split('/'))
console.log(`🔍 Debug: Checking model at path: ${modelBasePath}`)
console.log(`🔍 Debug: Model path components: ${this.modelPath} + ${CRITICAL_MODEL_CONFIG.modelName.split('/')}`)
// Check critical files
const criticalFiles = [
'onnx/model.onnx',
'tokenizer.json',
'config.json'
]
for (const file of criticalFiles) {
const filePath = path.join(modelBasePath, file)
console.log(`🔍 Debug: Checking file: ${filePath}`)
// Test embedding generation
const testEmbedding = await engine.embed('test verification')
if (!fs.existsSync(filePath)) {
console.log(`❌ Missing critical file: ${file} at ${filePath}`)
// Verify dimensions
if (testEmbedding.length !== CRITICAL_MODEL_CONFIG.embeddingDimensions) {
console.error(
`❌ CRITICAL: Model dimension mismatch!\n` +
`Expected: ${CRITICAL_MODEL_CONFIG.embeddingDimensions}\n` +
`Got: ${testEmbedding.length}`
)
return false
}
// Verify size for critical files
if (CRITICAL_MODEL_CONFIG.modelSize[file]) {
const stats = await fsPromises.stat(filePath)
const expectedSize = CRITICAL_MODEL_CONFIG.modelSize[file]
if (Math.abs(stats.size - expectedSize) > 1000) { // Allow 1KB variance
console.error(
`❌ CRITICAL: Model file size mismatch!\n` +
`File: ${file}\n` +
`Expected: ${expectedSize} bytes\n` +
`Actual: ${stats.size} bytes\n` +
`This indicates model corruption or version mismatch!`
)
return false
}
// Verify normalization (should be unit length)
const norm = Math.sqrt(testEmbedding.reduce((sum, v) => sum + v * v, 0))
if (Math.abs(norm - 1.0) > 0.01) {
console.error(`❌ CRITICAL: Embeddings not normalized! Norm: ${norm}`)
return false
}
// SHA256 verification for ultimate security
if (CRITICAL_MODEL_CONFIG.modelHash && CRITICAL_MODEL_CONFIG.modelHash[file]) {
const hash = await this.computeFileHash(filePath)
if (hash !== CRITICAL_MODEL_CONFIG.modelHash[file]) {
console.error(
`❌ CRITICAL: Model hash mismatch for ${file}!\n` +
`Expected: ${CRITICAL_MODEL_CONFIG.modelHash[file]}\n` +
`Got: ${hash}\n` +
`This indicates model tampering or corruption!`
)
return false
}
}
}
return true
}
/**
* Compute SHA256 hash of a file
*/
private async computeFileHash(filePath: string): Promise<string> {
try {
const { readFile } = await import('node:fs/promises')
const { createHash } = await import('node:crypto')
const fileBuffer = await readFile(filePath)
const hash = createHash('sha256').update(fileBuffer).digest('hex')
return hash
return true
} catch (error) {
console.error(`Failed to compute hash for ${filePath}:`, error)
return ''
console.error('❌ Model verification failed:', error)
return false
}
}
/**
* Download model from a fallback source
*/
private async downloadFromSource(source: any): Promise<void> {
if (source.type === 'transformers') {
// Use transformers.js native download
const { pipeline } = await import('@huggingface/transformers')
env.cacheDir = this.modelPath
env.allowRemoteModels = true
const extractor = await pipeline(
'feature-extraction',
CRITICAL_MODEL_CONFIG.modelName
)
// Test the model
const test = await extractor('test', { pooling: 'mean', normalize: true })
if (test.data.length !== CRITICAL_MODEL_CONFIG.embeddingDimensions) {
throw new Error(
`CRITICAL: Model dimension mismatch! ` +
`Expected ${CRITICAL_MODEL_CONFIG.embeddingDimensions}, ` +
`got ${test.data.length}`
)
}
} else if (source.type === 'tarball') {
// Tarball extraction would require additional dependencies
// Skip this source and try next fallback
console.warn(`⚠️ Tarball extraction not available for ${source.name}. Trying next source...`)
return // Will continue to next source in the loop
}
}
/**
* Configure transformers.js to use verified local model
*/
private configureTransformers(): void {
env.localModelPath = this.modelPath
env.allowRemoteModels = false // Force local only after verification
console.log('🔒 Transformers configured to use verified local model')
}
/**
* Detect where models should be stored
*/
private detectModelPath(): string {
// Browser always uses default path
if (typeof window !== 'undefined') {
return './models'
}
// Use require for synchronous access in Node.js
try {
const fs = require('node:fs')
const path = require('node:path')
const candidates = [
process.env.BRAINY_MODELS_PATH,
'./models',
path.join(process.cwd(), 'models'),
path.join(process.env.HOME || '', '.brainy', 'models'),
'/opt/models', // Lambda/container path
env.cacheDir
]
for (const candidatePath of candidates) {
if (candidatePath && fs.existsSync(candidatePath)) {
const modelPath = path.join(candidatePath, ...CRITICAL_MODEL_CONFIG.modelName.split('/'))
if (fs.existsSync(path.join(modelPath, 'onnx', 'model.onnx'))) {
return candidatePath // Return the models directory, not its parent
}
}
}
} catch (e) {
// If Node.js modules not available, return default
}
// Default
return './models'
}
/**
* Get model status for diagnostics
*/
async getStatus(): Promise<{
verified: boolean
path: string
lastVerification: Date | null
modelName: string
dimensions: number
bundled: boolean
}> {
return {
verified: this.isVerified,
path: this.modelPath,
lastVerification: this.lastVerification,
modelName: CRITICAL_MODEL_CONFIG.modelName,
dimensions: CRITICAL_MODEL_CONFIG.embeddingDimensions
dimensions: CRITICAL_MODEL_CONFIG.embeddingDimensions,
bundled: CRITICAL_MODEL_CONFIG.bundled
}
}
/**
* Force re-verification (for testing)
*/
@ -336,4 +137,4 @@ export class ModelGuardian {
}
// Export singleton instance
export const modelGuardian = ModelGuardian.getInstance()
export const modelGuardian = ModelGuardian.getInstance()