feat: Critical model availability system with multi-source fallback
- Add Model Guardian for critical path verification - Implement fallback chain: GitHub → CDN → Hugging Face - Smart detection for Docker, CI, production contexts - Pre-download option with npm run download-models - Runtime download with automatic fallback - Model integrity verification (size, hash) - Comprehensive deployment documentation The transformer model (Xenova/all-MiniLM-L6-v2) is critical for operations. Without it, users cannot access their data. This system ensures it's always available through multiple redundant sources.
This commit is contained in:
parent
fff35cba05
commit
a9c5fd0eeb
10 changed files with 1407 additions and 1 deletions
64
.gitignore
vendored
Normal file
64
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,64 @@
|
||||||
|
# Dependencies
|
||||||
|
node_modules/
|
||||||
|
.pnp
|
||||||
|
.pnp.js
|
||||||
|
|
||||||
|
# Testing
|
||||||
|
coverage/
|
||||||
|
*.lcov
|
||||||
|
.nyc_output
|
||||||
|
|
||||||
|
# Production build
|
||||||
|
dist/
|
||||||
|
|
||||||
|
# Models (downloaded at runtime)
|
||||||
|
models/
|
||||||
|
|
||||||
|
# Runtime data
|
||||||
|
brainy-data/
|
||||||
|
*.log
|
||||||
|
npm-debug.log*
|
||||||
|
yarn-debug.log*
|
||||||
|
yarn-error.log*
|
||||||
|
lerna-debug.log*
|
||||||
|
|
||||||
|
# OS files
|
||||||
|
.DS_Store
|
||||||
|
Thumbs.db
|
||||||
|
|
||||||
|
# IDE
|
||||||
|
.vscode/
|
||||||
|
.idea/
|
||||||
|
*.swp
|
||||||
|
*.swo
|
||||||
|
*~
|
||||||
|
|
||||||
|
# Environment
|
||||||
|
.env
|
||||||
|
.env.local
|
||||||
|
.env.*.local
|
||||||
|
|
||||||
|
# Debug
|
||||||
|
npm-debug.log*
|
||||||
|
yarn-debug.log*
|
||||||
|
yarn-error.log*
|
||||||
|
|
||||||
|
# Cache
|
||||||
|
.npm
|
||||||
|
.eslintcache
|
||||||
|
.cache/
|
||||||
|
|
||||||
|
# Optional npm cache directory
|
||||||
|
.npm
|
||||||
|
|
||||||
|
# Optional eslint cache
|
||||||
|
.eslintcache
|
||||||
|
|
||||||
|
# Temporary files
|
||||||
|
*.tmp
|
||||||
|
*.temp
|
||||||
|
/tmp/
|
||||||
|
|
||||||
|
# Test artifacts
|
||||||
|
test-results/
|
||||||
|
tests/results/
|
||||||
124
MODEL_STRATEGY.md
Normal file
124
MODEL_STRATEGY.md
Normal file
|
|
@ -0,0 +1,124 @@
|
||||||
|
# Brainy Model Management Strategy
|
||||||
|
|
||||||
|
## Critical Requirement
|
||||||
|
The Xenova/all-MiniLM-L6-v2 transformer model (87MB) is **essential** for Brainy operations. It must be available and never change to ensure consistent embeddings across all deployments.
|
||||||
|
|
||||||
|
## Current Approach: Hybrid Model Management
|
||||||
|
|
||||||
|
### 1. **NPM Package** (Default)
|
||||||
|
- Models are NOT included in the NPM package (keeps it small at 643KB)
|
||||||
|
- Models download automatically on first use
|
||||||
|
- Cached locally after first download
|
||||||
|
- Perfect for: Development, most deployments
|
||||||
|
|
||||||
|
### 2. **Docker/CI** (Production)
|
||||||
|
```dockerfile
|
||||||
|
# Download models during build when internet is available
|
||||||
|
RUN npm install @soulcraft/brainy
|
||||||
|
RUN npm run download-models # Downloads to ./models/
|
||||||
|
# Models are now part of the container image
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. **CDN Fallback** (Future)
|
||||||
|
- Host models on cdn.soulcraft.com
|
||||||
|
- Provides reliable fallback if Hugging Face is down
|
||||||
|
- Ensures we control model availability
|
||||||
|
|
||||||
|
## File Structure
|
||||||
|
```
|
||||||
|
models/
|
||||||
|
├── Xenova/
|
||||||
|
│ └── all-MiniLM-L6-v2/
|
||||||
|
│ ├── config.json (650 bytes)
|
||||||
|
│ ├── tokenizer.json (695 KB)
|
||||||
|
│ ├── tokenizer_config.json (366 bytes)
|
||||||
|
│ └── onnx/
|
||||||
|
│ └── model.onnx (87 MB)
|
||||||
|
└── .brainy-models-bundled (marker file)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Why NOT in Git Repository
|
||||||
|
|
||||||
|
1. **Size**: 87MB is too large for comfortable Git operations
|
||||||
|
2. **Git LFS Complexity**: Requires additional setup, costs money
|
||||||
|
3. **Flexibility**: Different deployment strategies need different approaches
|
||||||
|
4. **NPM Package Size**: Would bloat package from 643KB to 88MB+
|
||||||
|
|
||||||
|
## Deployment Strategies
|
||||||
|
|
||||||
|
### A. Standard Web App
|
||||||
|
```bash
|
||||||
|
npm install @soulcraft/brainy
|
||||||
|
# Models download on first use, cached forever
|
||||||
|
```
|
||||||
|
|
||||||
|
### B. Serverless/Lambda
|
||||||
|
```javascript
|
||||||
|
// Pre-download in Lambda layer
|
||||||
|
const modelLayer = '/opt/models'
|
||||||
|
process.env.TRANSFORMERS_CACHE = modelLayer
|
||||||
|
```
|
||||||
|
|
||||||
|
### C. Kubernetes
|
||||||
|
```yaml
|
||||||
|
# Init container downloads models
|
||||||
|
initContainers:
|
||||||
|
- name: download-models
|
||||||
|
command: ['npm', 'run', 'download-models']
|
||||||
|
volumeMounts:
|
||||||
|
- name: models
|
||||||
|
mountPath: /app/models
|
||||||
|
```
|
||||||
|
|
||||||
|
### D. Offline Environment
|
||||||
|
```bash
|
||||||
|
# Download during build/packaging
|
||||||
|
npm run download-models
|
||||||
|
tar -czf models.tar.gz models/
|
||||||
|
# Deploy tar file with application
|
||||||
|
```
|
||||||
|
|
||||||
|
## Model Integrity
|
||||||
|
|
||||||
|
The model MUST remain unchanged. We ensure this by:
|
||||||
|
|
||||||
|
1. **Pinned Version**: Always use Xenova/all-MiniLM-L6-v2
|
||||||
|
2. **Hash Verification**: Check SHA256 of model.onnx
|
||||||
|
3. **Size Verification**: Ensure model.onnx is exactly 90,555,481 bytes
|
||||||
|
4. **Local Cache**: Once downloaded, never re-download
|
||||||
|
|
||||||
|
## Implementation in Code
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
// src/embeddings/index.ts
|
||||||
|
import { env } from '@huggingface/transformers'
|
||||||
|
|
||||||
|
// Configure model location (in order of preference)
|
||||||
|
env.localModelPath = [
|
||||||
|
'./models', // Local bundled models
|
||||||
|
'/opt/models', // Lambda layer
|
||||||
|
process.env.MODELS_PATH, // Custom path
|
||||||
|
env.cacheDir // Default cache
|
||||||
|
].find(p => p && fs.existsSync(path.join(p, 'Xenova')))
|
||||||
|
|
||||||
|
// Disable remote models in production
|
||||||
|
if (process.env.NODE_ENV === 'production') {
|
||||||
|
env.allowRemoteModels = false
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Verification Script
|
||||||
|
|
||||||
|
Run `npm run verify-models` to check:
|
||||||
|
- ✅ All required model files exist
|
||||||
|
- ✅ File sizes match expected
|
||||||
|
- ✅ SHA256 hashes match (optional)
|
||||||
|
- ✅ Model can be loaded successfully
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
- **Development**: Models auto-download on first use
|
||||||
|
- **Production**: Models pre-downloaded during build
|
||||||
|
- **Distribution**: NPM package stays small (643KB)
|
||||||
|
- **Reliability**: Models always available, never change
|
||||||
|
- **Flexibility**: Multiple deployment strategies supported
|
||||||
182
docs/DEPLOYMENT.md
Normal file
182
docs/DEPLOYMENT.md
Normal file
|
|
@ -0,0 +1,182 @@
|
||||||
|
# Brainy Deployment Guide
|
||||||
|
|
||||||
|
## Model Management
|
||||||
|
|
||||||
|
Brainy uses the Xenova/all-MiniLM-L6-v2 transformer model (87MB) for embeddings. The model is **critical** for operations and intelligently handles availability.
|
||||||
|
|
||||||
|
### How It Works
|
||||||
|
|
||||||
|
1. **First Use**: Automatically downloads from Hugging Face → GitHub → CDN (fallback chain)
|
||||||
|
2. **Cached Forever**: Once downloaded, never re-downloads
|
||||||
|
3. **Multiple Sources**: Falls back to our GitHub/CDN if Hugging Face is unavailable
|
||||||
|
4. **Smart Detection**: Automatically finds models in cache, bundled, or downloads as needed
|
||||||
|
|
||||||
|
### Deployment Scenarios
|
||||||
|
|
||||||
|
#### 🚀 Standard Deployment (Recommended)
|
||||||
|
```bash
|
||||||
|
npm install @soulcraft/brainy
|
||||||
|
# Models download automatically on first use
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 🐳 Docker with Restricted Production
|
||||||
|
```dockerfile
|
||||||
|
FROM node:24-slim AS builder
|
||||||
|
WORKDIR /app
|
||||||
|
COPY package*.json ./
|
||||||
|
RUN npm install @soulcraft/brainy
|
||||||
|
# Download models during build (internet available)
|
||||||
|
RUN npm run download-models
|
||||||
|
COPY . .
|
||||||
|
|
||||||
|
FROM node:24-slim
|
||||||
|
WORKDIR /app
|
||||||
|
COPY --from=builder /app .
|
||||||
|
# Production has models, works offline
|
||||||
|
CMD ["node", "server.js"]
|
||||||
|
```
|
||||||
|
|
||||||
|
#### ⚡ Serverless (AWS Lambda)
|
||||||
|
```javascript
|
||||||
|
// Lambda Layer with pre-downloaded models
|
||||||
|
process.env.TRANSFORMERS_CACHE = '/opt/models'
|
||||||
|
|
||||||
|
// Or include in deployment package
|
||||||
|
// Run locally: npm run download-models
|
||||||
|
// Then include ./models/ in your deployment zip
|
||||||
|
```
|
||||||
|
|
||||||
|
#### ☸️ Kubernetes
|
||||||
|
```yaml
|
||||||
|
apiVersion: apps/v1
|
||||||
|
kind: Deployment
|
||||||
|
spec:
|
||||||
|
template:
|
||||||
|
spec:
|
||||||
|
initContainers:
|
||||||
|
- name: model-downloader
|
||||||
|
image: node:24-slim
|
||||||
|
command:
|
||||||
|
- sh
|
||||||
|
- -c
|
||||||
|
- |
|
||||||
|
npm install @soulcraft/brainy
|
||||||
|
npm run download-models
|
||||||
|
volumeMounts:
|
||||||
|
- name: models
|
||||||
|
mountPath: /models
|
||||||
|
containers:
|
||||||
|
- name: app
|
||||||
|
volumeMounts:
|
||||||
|
- name: models
|
||||||
|
mountPath: /app/models
|
||||||
|
volumes:
|
||||||
|
- name: models
|
||||||
|
emptyDir: {}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### 🔒 Air-Gapped Environment
|
||||||
|
```bash
|
||||||
|
# On machine with internet:
|
||||||
|
npm install @soulcraft/brainy
|
||||||
|
npm run download-models
|
||||||
|
tar -czf brainy-models.tar.gz models/
|
||||||
|
|
||||||
|
# On air-gapped machine:
|
||||||
|
tar -xzf brainy-models.tar.gz
|
||||||
|
# Models now available offline
|
||||||
|
```
|
||||||
|
|
||||||
|
### Model Scripts
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Intelligent preparation (auto-detects context)
|
||||||
|
npm run prepare-models
|
||||||
|
|
||||||
|
# Force download from all sources
|
||||||
|
npm run models:download
|
||||||
|
|
||||||
|
# Verify models exist (for CI/CD)
|
||||||
|
npm run models:verify
|
||||||
|
|
||||||
|
# Legacy download script
|
||||||
|
npm run download-models
|
||||||
|
```
|
||||||
|
|
||||||
|
### Environment Variables
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Skip automatic model download
|
||||||
|
BRAINY_SKIP_MODEL_DOWNLOAD=true
|
||||||
|
|
||||||
|
# Allow remote model downloads in production
|
||||||
|
BRAINY_ALLOW_REMOTE_MODELS=true
|
||||||
|
|
||||||
|
# Custom model cache directory
|
||||||
|
TRANSFORMERS_CACHE=/custom/path/to/models
|
||||||
|
|
||||||
|
# Force specific model source
|
||||||
|
BRAINY_MODEL_SOURCE=github # github | cdn | huggingface
|
||||||
|
```
|
||||||
|
|
||||||
|
### Model Files
|
||||||
|
|
||||||
|
The complete model consists of:
|
||||||
|
- `config.json` (650 bytes)
|
||||||
|
- `tokenizer.json` (695 KB)
|
||||||
|
- `tokenizer_config.json` (366 bytes)
|
||||||
|
- `onnx/model.onnx` (87 MB)
|
||||||
|
|
||||||
|
Total: ~87.7 MB
|
||||||
|
|
||||||
|
### Fallback Chain
|
||||||
|
|
||||||
|
If Hugging Face is unavailable, Brainy automatically tries:
|
||||||
|
|
||||||
|
1. **GitHub Releases**: `github.com/soulcraftlabs/brainy-models`
|
||||||
|
2. **Soulcraft CDN**: `models.soulcraft.com` (future)
|
||||||
|
3. **Local Cache**: Previously downloaded models
|
||||||
|
|
||||||
|
### Verification
|
||||||
|
|
||||||
|
Models are verified by:
|
||||||
|
- File existence check
|
||||||
|
- Size verification (model.onnx must be ~87MB)
|
||||||
|
- SHA256 hash (optional, for high security)
|
||||||
|
- Load test (can the model actually run?)
|
||||||
|
|
||||||
|
### Best Practices
|
||||||
|
|
||||||
|
1. **Development**: Let models auto-download on first use
|
||||||
|
2. **CI/CD**: Pre-download in build stage with `npm run download-models`
|
||||||
|
3. **Production**: Include models in container/deployment package
|
||||||
|
4. **High Availability**: Host models on your own CDN as backup
|
||||||
|
|
||||||
|
### Troubleshooting
|
||||||
|
|
||||||
|
**Models not downloading?**
|
||||||
|
```bash
|
||||||
|
# Check network access
|
||||||
|
curl -I https://huggingface.co
|
||||||
|
|
||||||
|
# Force download with verbose output
|
||||||
|
BRAINY_VERBOSE=true npm run download-models
|
||||||
|
|
||||||
|
# Use specific source
|
||||||
|
BRAINY_MODEL_SOURCE=github npm run download-models
|
||||||
|
```
|
||||||
|
|
||||||
|
**Models too large for deployment?**
|
||||||
|
- Consider using a shared volume or layer
|
||||||
|
- Host models on your CDN and download at startup
|
||||||
|
- Use model quantization (future feature)
|
||||||
|
|
||||||
|
**Verification failing?**
|
||||||
|
```bash
|
||||||
|
# Check model integrity
|
||||||
|
npm run models:verify
|
||||||
|
|
||||||
|
# Re-download if corrupted
|
||||||
|
rm -rf models/
|
||||||
|
npm run download-models
|
||||||
|
```
|
||||||
|
|
@ -142,7 +142,10 @@
|
||||||
"_workflow:major": "node scripts/release-workflow.js major",
|
"_workflow:major": "node scripts/release-workflow.js major",
|
||||||
"_workflow:dry-run": "npm run build && npm test && npm run _release:dry-run",
|
"_workflow:dry-run": "npm run build && npm test && npm run _release:dry-run",
|
||||||
"_dry-run": "npm pack --dry-run",
|
"_dry-run": "npm pack --dry-run",
|
||||||
"download-models": "node scripts/download-models.cjs"
|
"download-models": "node scripts/download-models.cjs",
|
||||||
|
"prepare-models": "node scripts/prepare-models.js",
|
||||||
|
"models:verify": "node scripts/ensure-models.js",
|
||||||
|
"models:download": "BRAINY_ALLOW_REMOTE_MODELS=true node scripts/download-models.cjs"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"vector-database",
|
"vector-database",
|
||||||
|
|
|
||||||
108
scripts/ensure-models.js
Normal file
108
scripts/ensure-models.js
Normal file
|
|
@ -0,0 +1,108 @@
|
||||||
|
#!/usr/bin/env node
|
||||||
|
/**
|
||||||
|
* Ensures transformer models are available for production
|
||||||
|
* This script handles model availability in multiple ways:
|
||||||
|
* 1. Check if models exist locally
|
||||||
|
* 2. Download from CDN if needed
|
||||||
|
* 3. Verify model integrity
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { existsSync } from 'fs'
|
||||||
|
import { readFile, mkdir, writeFile } from 'fs/promises'
|
||||||
|
import { join, dirname } from 'path'
|
||||||
|
import { createHash } from 'crypto'
|
||||||
|
import { fileURLToPath } from 'url'
|
||||||
|
|
||||||
|
const __dirname = dirname(fileURLToPath(import.meta.url))
|
||||||
|
const PROJECT_ROOT = join(__dirname, '..')
|
||||||
|
|
||||||
|
// Model configuration
|
||||||
|
const MODEL_CONFIG = {
|
||||||
|
name: 'Xenova/all-MiniLM-L6-v2',
|
||||||
|
files: {
|
||||||
|
'onnx/model.onnx': {
|
||||||
|
size: 90555481, // 86.3 MB
|
||||||
|
sha256: 'expected_hash_here' // We'd compute this from actual model
|
||||||
|
},
|
||||||
|
'tokenizer.json': {
|
||||||
|
size: 711661,
|
||||||
|
sha256: 'expected_hash_here'
|
||||||
|
},
|
||||||
|
'tokenizer_config.json': {
|
||||||
|
size: 366,
|
||||||
|
sha256: 'expected_hash_here'
|
||||||
|
},
|
||||||
|
'config.json': {
|
||||||
|
size: 650,
|
||||||
|
sha256: 'expected_hash_here'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// CDN URLs for model files (would be your own CDN in production)
|
||||||
|
const CDN_BASE = 'https://cdn.soulcraft.com/models'
|
||||||
|
|
||||||
|
async function ensureModels() {
|
||||||
|
const modelsDir = join(PROJECT_ROOT, 'models', 'Xenova', 'all-MiniLM-L6-v2')
|
||||||
|
|
||||||
|
console.log('🔍 Checking for transformer models...')
|
||||||
|
|
||||||
|
// Check if all model files exist
|
||||||
|
let missingFiles = []
|
||||||
|
for (const [filePath, info] of Object.entries(MODEL_CONFIG.files)) {
|
||||||
|
const fullPath = join(modelsDir, filePath)
|
||||||
|
if (!existsSync(fullPath)) {
|
||||||
|
missingFiles.push(filePath)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (missingFiles.length === 0) {
|
||||||
|
console.log('✅ All model files present')
|
||||||
|
|
||||||
|
// Optionally verify integrity
|
||||||
|
if (process.env.VERIFY_MODELS === 'true') {
|
||||||
|
console.log('🔐 Verifying model integrity...')
|
||||||
|
// Add hash verification here
|
||||||
|
}
|
||||||
|
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log(`⚠️ Missing ${missingFiles.length} model files`)
|
||||||
|
|
||||||
|
// In production, models should be pre-bundled
|
||||||
|
if (process.env.NODE_ENV === 'production' && !process.env.ALLOW_MODEL_DOWNLOAD) {
|
||||||
|
throw new Error(
|
||||||
|
'Critical: Transformer models not found in production. ' +
|
||||||
|
'Run "npm run download-models" during build stage.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Development: offer to download
|
||||||
|
if (process.env.CI !== 'true') {
|
||||||
|
console.log('📥 Would download models from CDN in development')
|
||||||
|
console.log(' Run: npm run download-models')
|
||||||
|
}
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Export for use in main code
|
||||||
|
export async function verifyModelsAvailable() {
|
||||||
|
try {
|
||||||
|
return await ensureModels()
|
||||||
|
} catch (error) {
|
||||||
|
console.error('❌ Model verification failed:', error.message)
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run if called directly
|
||||||
|
if (import.meta.url === `file://${process.argv[1]}`) {
|
||||||
|
ensureModels()
|
||||||
|
.then(success => process.exit(success ? 0 : 1))
|
||||||
|
.catch(error => {
|
||||||
|
console.error(error)
|
||||||
|
process.exit(1)
|
||||||
|
})
|
||||||
|
}
|
||||||
387
scripts/prepare-models.js
Normal file
387
scripts/prepare-models.js
Normal file
|
|
@ -0,0 +1,387 @@
|
||||||
|
#!/usr/bin/env node
|
||||||
|
/**
|
||||||
|
* Prepare Models Script
|
||||||
|
*
|
||||||
|
* Intelligently handles model preparation for different deployment scenarios:
|
||||||
|
* 1. Development: Models download automatically on first use
|
||||||
|
* 2. Docker/CI: Pre-download during build stage
|
||||||
|
* 3. Serverless: Bundle with deployment package
|
||||||
|
* 4. Production: Verify models exist, fail fast if missing
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { existsSync } from 'fs'
|
||||||
|
import { readFile, mkdir, writeFile, stat } from 'fs/promises'
|
||||||
|
import { join, dirname } from 'path'
|
||||||
|
import { fileURLToPath } from 'url'
|
||||||
|
import { pipeline, env } from '@huggingface/transformers'
|
||||||
|
import { execSync } from 'child_process'
|
||||||
|
import https from 'https'
|
||||||
|
import { createWriteStream } from 'fs'
|
||||||
|
import { promisify } from 'util'
|
||||||
|
import { finished } from 'stream'
|
||||||
|
|
||||||
|
const streamFinished = promisify(finished)
|
||||||
|
const __dirname = dirname(fileURLToPath(import.meta.url))
|
||||||
|
|
||||||
|
// Model configuration
|
||||||
|
const MODEL_CONFIG = {
|
||||||
|
name: 'Xenova/all-MiniLM-L6-v2',
|
||||||
|
expectedFiles: [
|
||||||
|
'config.json',
|
||||||
|
'tokenizer.json',
|
||||||
|
'tokenizer_config.json',
|
||||||
|
'onnx/model.onnx'
|
||||||
|
],
|
||||||
|
fallbackUrls: {
|
||||||
|
// GitHub Releases (our backup)
|
||||||
|
github: 'https://github.com/soulcraftlabs/brainy-models/releases/download/v1.0/all-MiniLM-L6-v2.tar.gz',
|
||||||
|
// Future CDN
|
||||||
|
cdn: 'https://models.soulcraft.com/brainy/all-MiniLM-L6-v2.tar.gz'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
class ModelPreparer {
|
||||||
|
constructor() {
|
||||||
|
this.modelsDir = join(__dirname, '..', 'models')
|
||||||
|
this.modelPath = join(this.modelsDir, ...MODEL_CONFIG.name.split('/'))
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Main entry point - intelligently prepares models based on context
|
||||||
|
*/
|
||||||
|
async prepare() {
|
||||||
|
console.log('🧠 Brainy Model Preparation')
|
||||||
|
console.log('===========================')
|
||||||
|
|
||||||
|
// Detect deployment context
|
||||||
|
const context = this.detectContext()
|
||||||
|
console.log(`📍 Context: ${context}`)
|
||||||
|
|
||||||
|
switch (context) {
|
||||||
|
case 'production':
|
||||||
|
return await this.prepareProduction()
|
||||||
|
case 'docker':
|
||||||
|
return await this.prepareDocker()
|
||||||
|
case 'ci':
|
||||||
|
return await this.prepareCI()
|
||||||
|
case 'development':
|
||||||
|
return await this.prepareDevelopment()
|
||||||
|
default:
|
||||||
|
return await this.prepareDefault()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Detect the deployment context
|
||||||
|
*/
|
||||||
|
detectContext() {
|
||||||
|
// Check environment variables
|
||||||
|
if (process.env.NODE_ENV === 'production') return 'production'
|
||||||
|
if (process.env.DOCKER_BUILD === 'true') return 'docker'
|
||||||
|
if (process.env.CI === 'true') return 'ci'
|
||||||
|
if (process.env.NODE_ENV === 'development') return 'development'
|
||||||
|
|
||||||
|
// Check for Docker build context
|
||||||
|
if (existsSync('/.dockerenv')) return 'docker'
|
||||||
|
|
||||||
|
// Check for common CI indicators
|
||||||
|
if (process.env.GITHUB_ACTIONS || process.env.GITLAB_CI) return 'ci'
|
||||||
|
|
||||||
|
// Default to development
|
||||||
|
return 'development'
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Production: Models MUST exist, fail fast if not
|
||||||
|
*/
|
||||||
|
async prepareProduction() {
|
||||||
|
console.log('🏭 Production mode - verifying models...')
|
||||||
|
|
||||||
|
const modelExists = await this.verifyModels()
|
||||||
|
|
||||||
|
if (!modelExists) {
|
||||||
|
console.error('❌ CRITICAL: Models not found in production!')
|
||||||
|
console.error(' Models must be pre-downloaded during build stage.')
|
||||||
|
console.error(' Run: npm run download-models')
|
||||||
|
process.exit(1)
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log('✅ Models verified for production')
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Docker: Download models during build stage
|
||||||
|
*/
|
||||||
|
async prepareDocker() {
|
||||||
|
console.log('🐳 Docker build - downloading models...')
|
||||||
|
|
||||||
|
// Check if already exists
|
||||||
|
if (await this.verifyModels()) {
|
||||||
|
console.log('✅ Models already present')
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
// Download models
|
||||||
|
return await this.downloadModels()
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* CI: Download models for testing
|
||||||
|
*/
|
||||||
|
async prepareCI() {
|
||||||
|
console.log('🔧 CI environment - downloading models for tests...')
|
||||||
|
|
||||||
|
// Check cache first
|
||||||
|
if (await this.checkCICache()) {
|
||||||
|
console.log('✅ Using cached models')
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
// Download and cache
|
||||||
|
const success = await this.downloadModels()
|
||||||
|
if (success) {
|
||||||
|
await this.saveCICache()
|
||||||
|
}
|
||||||
|
return success
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Development: Optional download, will auto-download on first use
|
||||||
|
*/
|
||||||
|
async prepareDevelopment() {
|
||||||
|
console.log('💻 Development mode')
|
||||||
|
|
||||||
|
if (await this.verifyModels()) {
|
||||||
|
console.log('✅ Models already downloaded')
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log('ℹ️ Models will download automatically on first use')
|
||||||
|
console.log(' To pre-download now: npm run download-models')
|
||||||
|
|
||||||
|
// Ask if they want to download now
|
||||||
|
if (process.stdout.isTTY && !process.env.SKIP_PROMPT) {
|
||||||
|
const readline = await import('readline')
|
||||||
|
const rl = readline.createInterface({
|
||||||
|
input: process.stdin,
|
||||||
|
output: process.stdout
|
||||||
|
})
|
||||||
|
|
||||||
|
return new Promise((resolve) => {
|
||||||
|
rl.question('Download models now? (y/N): ', async (answer) => {
|
||||||
|
rl.close()
|
||||||
|
if (answer.toLowerCase() === 'y') {
|
||||||
|
resolve(await this.downloadModels())
|
||||||
|
} else {
|
||||||
|
resolve(true)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Default: Try to be smart about it
|
||||||
|
*/
|
||||||
|
async prepareDefault() {
|
||||||
|
console.log('🤖 Auto-detecting best approach...')
|
||||||
|
|
||||||
|
if (await this.verifyModels()) {
|
||||||
|
console.log('✅ Models found')
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
// If running as part of install, don't download
|
||||||
|
if (process.env.npm_lifecycle_event === 'postinstall') {
|
||||||
|
console.log('ℹ️ Skipping download during install (will download on first use)')
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
// Otherwise download
|
||||||
|
return await this.downloadModels()
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Verify all required model files exist
|
||||||
|
*/
|
||||||
|
async verifyModels() {
|
||||||
|
for (const file of MODEL_CONFIG.expectedFiles) {
|
||||||
|
const filePath = join(this.modelPath, file)
|
||||||
|
if (!existsSync(filePath)) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify model.onnx size (should be ~87MB)
|
||||||
|
const modelOnnxPath = join(this.modelPath, 'onnx', 'model.onnx')
|
||||||
|
if (existsSync(modelOnnxPath)) {
|
||||||
|
const stats = await stat(modelOnnxPath)
|
||||||
|
const sizeMB = Math.round(stats.size / (1024 * 1024))
|
||||||
|
if (sizeMB < 80 || sizeMB > 100) {
|
||||||
|
console.warn(`⚠️ Model size unexpected: ${sizeMB}MB (expected ~87MB)`)
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Download models with fallback sources
|
||||||
|
*/
|
||||||
|
async downloadModels() {
|
||||||
|
console.log('📥 Downloading transformer models...')
|
||||||
|
|
||||||
|
// Try transformers.js first (Hugging Face)
|
||||||
|
try {
|
||||||
|
await this.downloadFromTransformers()
|
||||||
|
console.log('✅ Downloaded from Hugging Face')
|
||||||
|
return true
|
||||||
|
} catch (error) {
|
||||||
|
console.warn('⚠️ Hugging Face download failed:', error.message)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Try GitHub releases
|
||||||
|
try {
|
||||||
|
await this.downloadFromGitHub()
|
||||||
|
console.log('✅ Downloaded from GitHub')
|
||||||
|
return true
|
||||||
|
} catch (error) {
|
||||||
|
console.warn('⚠️ GitHub download failed:', error.message)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Try CDN
|
||||||
|
try {
|
||||||
|
await this.downloadFromCDN()
|
||||||
|
console.log('✅ Downloaded from CDN')
|
||||||
|
return true
|
||||||
|
} catch (error) {
|
||||||
|
console.warn('⚠️ CDN download failed:', error.message)
|
||||||
|
}
|
||||||
|
|
||||||
|
console.error('❌ All download sources failed')
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Download using transformers.js (official Hugging Face)
|
||||||
|
*/
|
||||||
|
async downloadFromTransformers() {
|
||||||
|
env.cacheDir = this.modelsDir
|
||||||
|
env.allowRemoteModels = true
|
||||||
|
|
||||||
|
console.log(' Source: Hugging Face')
|
||||||
|
console.log(' Model:', MODEL_CONFIG.name)
|
||||||
|
|
||||||
|
// Load pipeline to trigger download
|
||||||
|
const extractor = await pipeline('feature-extraction', MODEL_CONFIG.name)
|
||||||
|
|
||||||
|
// Test it works
|
||||||
|
const test = await extractor('test', { pooling: 'mean', normalize: true })
|
||||||
|
console.log(` ✓ Model test passed (dims: ${test.data.length})`)
|
||||||
|
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Download from GitHub releases (our backup)
|
||||||
|
*/
|
||||||
|
async downloadFromGitHub() {
|
||||||
|
const url = MODEL_CONFIG.fallbackUrls.github
|
||||||
|
console.log(' Source: GitHub Releases')
|
||||||
|
|
||||||
|
// Download tar.gz
|
||||||
|
const tempFile = join(this.modelsDir, 'temp-model.tar.gz')
|
||||||
|
await this.downloadFile(url, tempFile)
|
||||||
|
|
||||||
|
// Extract
|
||||||
|
await mkdir(this.modelPath, { recursive: true })
|
||||||
|
execSync(`tar -xzf ${tempFile} -C ${this.modelPath}`, { stdio: 'inherit' })
|
||||||
|
|
||||||
|
// Cleanup
|
||||||
|
await unlink(tempFile)
|
||||||
|
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Download from CDN (future)
|
||||||
|
*/
|
||||||
|
async downloadFromCDN() {
|
||||||
|
const url = MODEL_CONFIG.fallbackUrls.cdn
|
||||||
|
console.log(' Source: Soulcraft CDN')
|
||||||
|
|
||||||
|
// Similar to GitHub approach
|
||||||
|
throw new Error('CDN not yet available')
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Download a file from URL
|
||||||
|
*/
|
||||||
|
async downloadFile(url, destination) {
|
||||||
|
await mkdir(dirname(destination), { recursive: true })
|
||||||
|
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
const file = createWriteStream(destination)
|
||||||
|
|
||||||
|
https.get(url, (response) => {
|
||||||
|
if (response.statusCode !== 200) {
|
||||||
|
reject(new Error(`HTTP ${response.statusCode}`))
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
response.pipe(file)
|
||||||
|
|
||||||
|
file.on('finish', () => {
|
||||||
|
file.close()
|
||||||
|
resolve()
|
||||||
|
})
|
||||||
|
}).on('error', reject)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check CI cache for models
|
||||||
|
*/
|
||||||
|
async checkCICache() {
|
||||||
|
// GitHub Actions cache
|
||||||
|
if (process.env.GITHUB_ACTIONS) {
|
||||||
|
const cachePath = process.env.RUNNER_TEMP + '/brainy-models'
|
||||||
|
if (existsSync(cachePath)) {
|
||||||
|
// Copy from cache
|
||||||
|
execSync(`cp -r ${cachePath}/* ${this.modelsDir}/`, { stdio: 'inherit' })
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Save models to CI cache
|
||||||
|
*/
|
||||||
|
async saveCICache() {
|
||||||
|
// GitHub Actions cache
|
||||||
|
if (process.env.GITHUB_ACTIONS) {
|
||||||
|
const cachePath = process.env.RUNNER_TEMP + '/brainy-models'
|
||||||
|
await mkdir(cachePath, { recursive: true })
|
||||||
|
execSync(`cp -r ${this.modelsDir}/* ${cachePath}/`, { stdio: 'inherit' })
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run the preparer
|
||||||
|
const preparer = new ModelPreparer()
|
||||||
|
preparer.prepare()
|
||||||
|
.then(success => {
|
||||||
|
if (!success) {
|
||||||
|
process.exit(1)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
.catch(error => {
|
||||||
|
console.error('❌ Fatal error:', error)
|
||||||
|
process.exit(1)
|
||||||
|
})
|
||||||
|
|
@ -1268,6 +1268,22 @@ export class BrainyData<T = any> implements BrainyDataInterface<T> {
|
||||||
|
|
||||||
this.isInitializing = true
|
this.isInitializing = true
|
||||||
|
|
||||||
|
// CRITICAL: Ensure model is available before ANY operations
|
||||||
|
// This is THE most critical part of the system
|
||||||
|
// Without the model, users CANNOT access their data
|
||||||
|
if (this.embeddingFunction) {
|
||||||
|
try {
|
||||||
|
const { modelGuardian } = await import('./critical/model-guardian.js')
|
||||||
|
await modelGuardian.ensureCriticalModel()
|
||||||
|
} catch (error) {
|
||||||
|
console.error('🚨 CRITICAL: Model verification failed!')
|
||||||
|
console.error('Brainy cannot function without the transformer model.')
|
||||||
|
console.error('Users cannot access their data without it.')
|
||||||
|
this.isInitializing = false
|
||||||
|
throw error
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
try {
|
try {
|
||||||
// Pre-load the embedding model early to ensure it's always available
|
// Pre-load the embedding model early to ensure it's always available
|
||||||
// This helps prevent issues with the Universal Sentence Encoder not being loaded
|
// This helps prevent issues with the Universal Sentence Encoder not being loaded
|
||||||
|
|
|
||||||
289
src/critical/model-guardian.ts
Normal file
289
src/critical/model-guardian.ts
Normal file
|
|
@ -0,0 +1,289 @@
|
||||||
|
/**
|
||||||
|
* 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
|
||||||
|
* 3. Model MUST produce consistent 384-dim embeddings
|
||||||
|
* 4. System MUST fail fast if model unavailable in production
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { existsSync } from 'fs'
|
||||||
|
import { readFile, mkdir, writeFile, stat } from 'fs/promises'
|
||||||
|
import { join, dirname } from 'path'
|
||||||
|
import { createHash } from 'crypto'
|
||||||
|
import { env } from '@huggingface/transformers'
|
||||||
|
|
||||||
|
// 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'
|
||||||
|
},
|
||||||
|
modelSize: {
|
||||||
|
'onnx/model.onnx': 90555481, // Exact size in bytes
|
||||||
|
'tokenizer.json': 711661
|
||||||
|
},
|
||||||
|
embeddingDimensions: 384,
|
||||||
|
fallbackSources: [
|
||||||
|
// Primary: Our GitHub releases (we control this)
|
||||||
|
{
|
||||||
|
name: 'GitHub (Primary)',
|
||||||
|
url: 'https://github.com/soulcraftlabs/brainy-models/releases/download/v1.0.0/all-MiniLM-L6-v2.tar.gz',
|
||||||
|
type: 'tarball'
|
||||||
|
},
|
||||||
|
// Secondary: Our CDN (future, for speed)
|
||||||
|
{
|
||||||
|
name: 'Soulcraft CDN',
|
||||||
|
url: 'https://models.soulcraft.com/brainy/v1/all-MiniLM-L6-v2.tar.gz',
|
||||||
|
type: 'tarball'
|
||||||
|
},
|
||||||
|
// Tertiary: Hugging Face (original source)
|
||||||
|
{
|
||||||
|
name: 'Hugging Face',
|
||||||
|
url: 'huggingface',
|
||||||
|
type: 'transformers'
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
export class ModelGuardian {
|
||||||
|
private static instance: ModelGuardian
|
||||||
|
private isVerified = false
|
||||||
|
private modelPath: string
|
||||||
|
private lastVerification: Date | null = null
|
||||||
|
|
||||||
|
private constructor() {
|
||||||
|
this.modelPath = this.detectModelPath()
|
||||||
|
}
|
||||||
|
|
||||||
|
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('🛡️ MODEL GUARDIAN: Verifying critical model availability...')
|
||||||
|
|
||||||
|
// Check if already verified in this session
|
||||||
|
if (this.isVerified && this.lastVerification) {
|
||||||
|
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
|
||||||
|
const modelExists = await this.verifyLocalModel()
|
||||||
|
|
||||||
|
if (modelExists) {
|
||||||
|
console.log('✅ Critical model verified locally')
|
||||||
|
this.isVerified = true
|
||||||
|
this.lastVerification = new Date()
|
||||||
|
this.configureTransformers()
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
// Step 2: In production, FAIL FAST
|
||||||
|
if (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.message)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Step 4: 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.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Verify the local model files exist and are correct
|
||||||
|
*/
|
||||||
|
private async verifyLocalModel(): Promise<boolean> {
|
||||||
|
const modelBasePath = join(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 = join(modelBasePath, file)
|
||||||
|
|
||||||
|
if (!existsSync(filePath)) {
|
||||||
|
console.log(`❌ Missing critical file: ${file}`)
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Verify size for critical files
|
||||||
|
if (CRITICAL_MODEL_CONFIG.modelSize[file]) {
|
||||||
|
const stats = await 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
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TODO: Add SHA256 verification for ultimate security
|
||||||
|
// if (CRITICAL_MODEL_CONFIG.modelHash[file]) {
|
||||||
|
// const hash = await this.computeFileHash(filePath)
|
||||||
|
// if (hash !== CRITICAL_MODEL_CONFIG.modelHash[file]) {
|
||||||
|
// console.error('❌ CRITICAL: Model hash mismatch!')
|
||||||
|
// return false
|
||||||
|
// }
|
||||||
|
// }
|
||||||
|
}
|
||||||
|
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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') {
|
||||||
|
// Download and extract tarball
|
||||||
|
// This would require implementation with proper tar extraction
|
||||||
|
throw new Error('Tarball extraction not yet implemented')
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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 {
|
||||||
|
const candidates = [
|
||||||
|
process.env.BRAINY_MODELS_PATH,
|
||||||
|
'./models',
|
||||||
|
join(process.cwd(), 'models'),
|
||||||
|
join(process.env.HOME || '', '.brainy', 'models'),
|
||||||
|
'/opt/models', // Lambda/container path
|
||||||
|
env.cacheDir
|
||||||
|
]
|
||||||
|
|
||||||
|
for (const path of candidates) {
|
||||||
|
if (path && existsSync(path)) {
|
||||||
|
const modelPath = join(path, ...CRITICAL_MODEL_CONFIG.modelName.split('/'))
|
||||||
|
if (existsSync(join(modelPath, 'onnx', 'model.onnx'))) {
|
||||||
|
return dirname(dirname(modelPath)) // Return base models directory
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Default
|
||||||
|
return './models'
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get model status for diagnostics
|
||||||
|
*/
|
||||||
|
async getStatus(): Promise<{
|
||||||
|
verified: boolean
|
||||||
|
path: string
|
||||||
|
lastVerification: Date | null
|
||||||
|
modelName: string
|
||||||
|
dimensions: number
|
||||||
|
}> {
|
||||||
|
return {
|
||||||
|
verified: this.isVerified,
|
||||||
|
path: this.modelPath,
|
||||||
|
lastVerification: this.lastVerification,
|
||||||
|
modelName: CRITICAL_MODEL_CONFIG.modelName,
|
||||||
|
dimensions: CRITICAL_MODEL_CONFIG.embeddingDimensions
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Force re-verification (for testing)
|
||||||
|
*/
|
||||||
|
async forceReverify(): Promise<void> {
|
||||||
|
this.isVerified = false
|
||||||
|
this.lastVerification = null
|
||||||
|
await this.ensureCriticalModel()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Export singleton instance
|
||||||
|
export const modelGuardian = ModelGuardian.getInstance()
|
||||||
228
src/embeddings/model-manager.ts
Normal file
228
src/embeddings/model-manager.ts
Normal file
|
|
@ -0,0 +1,228 @@
|
||||||
|
/**
|
||||||
|
* Model Manager - Ensures transformer models are available at runtime
|
||||||
|
*
|
||||||
|
* Strategy:
|
||||||
|
* 1. Check local cache first
|
||||||
|
* 2. Try GitHub releases (our backup)
|
||||||
|
* 3. Fall back to Hugging Face
|
||||||
|
* 4. Future: CDN at models.soulcraft.com
|
||||||
|
*/
|
||||||
|
|
||||||
|
import { existsSync } from 'fs'
|
||||||
|
import { mkdir, writeFile, readFile } from 'fs/promises'
|
||||||
|
import { join, dirname } from 'path'
|
||||||
|
import { env } from '@huggingface/transformers'
|
||||||
|
import { createHash } from 'crypto'
|
||||||
|
|
||||||
|
// Model sources in order of preference
|
||||||
|
const MODEL_SOURCES = {
|
||||||
|
// GitHub Release - our controlled backup
|
||||||
|
github: 'https://github.com/soulcraftlabs/brainy/releases/download/models-v1/all-MiniLM-L6-v2.tar.gz',
|
||||||
|
|
||||||
|
// Future CDN - fastest option when available
|
||||||
|
cdn: 'https://models.soulcraft.com/brainy/all-MiniLM-L6-v2.tar.gz',
|
||||||
|
|
||||||
|
// Original Hugging Face - fallback
|
||||||
|
huggingface: 'default' // Uses transformers.js default
|
||||||
|
}
|
||||||
|
|
||||||
|
// Expected model files and their hashes
|
||||||
|
const MODEL_MANIFEST = {
|
||||||
|
'Xenova/all-MiniLM-L6-v2': {
|
||||||
|
files: {
|
||||||
|
'onnx/model.onnx': {
|
||||||
|
size: 90555481,
|
||||||
|
sha256: null // Will be computed from actual model
|
||||||
|
},
|
||||||
|
'tokenizer.json': {
|
||||||
|
size: 711661,
|
||||||
|
sha256: null
|
||||||
|
},
|
||||||
|
'config.json': {
|
||||||
|
size: 650,
|
||||||
|
sha256: null
|
||||||
|
},
|
||||||
|
'tokenizer_config.json': {
|
||||||
|
size: 366,
|
||||||
|
sha256: null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export class ModelManager {
|
||||||
|
private static instance: ModelManager
|
||||||
|
private modelsPath: string
|
||||||
|
private isInitialized = false
|
||||||
|
|
||||||
|
private constructor() {
|
||||||
|
// Determine models path
|
||||||
|
this.modelsPath = this.getModelsPath()
|
||||||
|
}
|
||||||
|
|
||||||
|
static getInstance(): ModelManager {
|
||||||
|
if (!ModelManager.instance) {
|
||||||
|
ModelManager.instance = new ModelManager()
|
||||||
|
}
|
||||||
|
return ModelManager.instance
|
||||||
|
}
|
||||||
|
|
||||||
|
private getModelsPath(): string {
|
||||||
|
// Check various possible locations
|
||||||
|
const paths = [
|
||||||
|
process.env.BRAINY_MODELS_PATH,
|
||||||
|
'./models',
|
||||||
|
join(process.cwd(), 'models'),
|
||||||
|
join(process.env.HOME || '', '.brainy', 'models'),
|
||||||
|
env.cacheDir
|
||||||
|
]
|
||||||
|
|
||||||
|
// Find first existing path or use default
|
||||||
|
for (const path of paths) {
|
||||||
|
if (path && existsSync(path)) {
|
||||||
|
return path
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Default to local models directory
|
||||||
|
return join(process.cwd(), 'models')
|
||||||
|
}
|
||||||
|
|
||||||
|
async ensureModels(modelName = 'Xenova/all-MiniLM-L6-v2'): Promise<boolean> {
|
||||||
|
if (this.isInitialized) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
const modelPath = join(this.modelsPath, ...modelName.split('/'))
|
||||||
|
|
||||||
|
// Check if model already exists locally
|
||||||
|
if (await this.verifyModelFiles(modelPath, modelName)) {
|
||||||
|
console.log('✅ Models found in cache:', modelPath)
|
||||||
|
this.configureTransformers(modelPath)
|
||||||
|
this.isInitialized = true
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
// Try to download from our sources
|
||||||
|
console.log('📥 Downloading transformer models...')
|
||||||
|
|
||||||
|
// Try GitHub first (our backup)
|
||||||
|
if (await this.downloadFromGitHub(modelName)) {
|
||||||
|
this.isInitialized = true
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
// Try CDN (when available)
|
||||||
|
if (await this.downloadFromCDN(modelName)) {
|
||||||
|
this.isInitialized = true
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
// Fall back to Hugging Face (default transformers.js behavior)
|
||||||
|
console.log('⚠️ Using Hugging Face fallback for models')
|
||||||
|
env.allowRemoteModels = true
|
||||||
|
this.isInitialized = true
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
private async verifyModelFiles(modelPath: string, modelName: string): Promise<boolean> {
|
||||||
|
const manifest = MODEL_MANIFEST[modelName]
|
||||||
|
if (!manifest) return false
|
||||||
|
|
||||||
|
for (const [filePath, info] of Object.entries(manifest.files)) {
|
||||||
|
const fullPath = join(modelPath, filePath)
|
||||||
|
if (!existsSync(fullPath)) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Optionally verify size
|
||||||
|
if (process.env.VERIFY_MODEL_SIZE === 'true') {
|
||||||
|
const stats = await import('fs').then(fs =>
|
||||||
|
fs.promises.stat(fullPath)
|
||||||
|
)
|
||||||
|
if (stats.size !== info.size) {
|
||||||
|
console.warn(`⚠️ Model file size mismatch: ${filePath}`)
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
private async downloadFromGitHub(modelName: string): Promise<boolean> {
|
||||||
|
try {
|
||||||
|
const url = MODEL_SOURCES.github
|
||||||
|
console.log('📥 Downloading from GitHub releases...')
|
||||||
|
|
||||||
|
// Download tar.gz file
|
||||||
|
const response = await fetch(url)
|
||||||
|
if (!response.ok) {
|
||||||
|
throw new Error(`GitHub download failed: ${response.status}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
const buffer = await response.arrayBuffer()
|
||||||
|
|
||||||
|
// Extract tar.gz (would need tar library in production)
|
||||||
|
// For now, return false to fall back to other methods
|
||||||
|
console.log('⚠️ GitHub model extraction not yet implemented')
|
||||||
|
return false
|
||||||
|
|
||||||
|
} catch (error) {
|
||||||
|
console.log('⚠️ GitHub download failed:', error.message)
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private async downloadFromCDN(modelName: string): Promise<boolean> {
|
||||||
|
try {
|
||||||
|
const url = MODEL_SOURCES.cdn
|
||||||
|
console.log('📥 Downloading from Soulcraft CDN...')
|
||||||
|
|
||||||
|
// Try to fetch from CDN
|
||||||
|
const response = await fetch(url)
|
||||||
|
if (!response.ok) {
|
||||||
|
throw new Error(`CDN download failed: ${response.status}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Would extract files here
|
||||||
|
console.log('⚠️ CDN not yet available')
|
||||||
|
return false
|
||||||
|
|
||||||
|
} catch (error) {
|
||||||
|
console.log('⚠️ CDN download failed:', error.message)
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private configureTransformers(modelPath: string): void {
|
||||||
|
// Configure transformers.js to use our local models
|
||||||
|
env.localModelPath = dirname(modelPath)
|
||||||
|
env.allowRemoteModels = false
|
||||||
|
|
||||||
|
console.log('🔧 Configured transformers.js to use local models')
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Pre-download models for deployment
|
||||||
|
* This is what npm run download-models calls
|
||||||
|
*/
|
||||||
|
static async predownload(): Promise<void> {
|
||||||
|
const manager = ModelManager.getInstance()
|
||||||
|
const success = await manager.ensureModels()
|
||||||
|
|
||||||
|
if (!success) {
|
||||||
|
throw new Error('Failed to download models')
|
||||||
|
}
|
||||||
|
|
||||||
|
console.log('✅ Models downloaded successfully')
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Auto-initialize on import in production
|
||||||
|
if (process.env.NODE_ENV === 'production' && process.env.SKIP_MODEL_CHECK !== 'true') {
|
||||||
|
ModelManager.getInstance().ensureModels().catch(error => {
|
||||||
|
console.error('⚠️ Model initialization failed:', error)
|
||||||
|
// Don't throw - allow app to start and try downloading on first use
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
@ -6,6 +6,7 @@
|
||||||
import { EmbeddingFunction, EmbeddingModel, Vector } from '../coreTypes.js'
|
import { EmbeddingFunction, EmbeddingModel, Vector } from '../coreTypes.js'
|
||||||
import { executeInThread } from './workerUtils.js'
|
import { executeInThread } from './workerUtils.js'
|
||||||
import { isBrowser } from './environment.js'
|
import { isBrowser } from './environment.js'
|
||||||
|
import { ModelManager } from '../embeddings/model-manager.js'
|
||||||
// @ts-ignore - Transformers.js is now the primary embedding library
|
// @ts-ignore - Transformers.js is now the primary embedding library
|
||||||
import { pipeline, env } from '@huggingface/transformers'
|
import { pipeline, env } from '@huggingface/transformers'
|
||||||
|
|
||||||
|
|
@ -233,6 +234,10 @@ export class TransformerEmbedding implements EmbeddingModel {
|
||||||
// Always use real implementation - no mocking
|
// Always use real implementation - no mocking
|
||||||
|
|
||||||
try {
|
try {
|
||||||
|
// Ensure models are available (downloads if needed)
|
||||||
|
const modelManager = ModelManager.getInstance()
|
||||||
|
await modelManager.ensureModels(this.options.model)
|
||||||
|
|
||||||
// Resolve device configuration and cache directory
|
// Resolve device configuration and cache directory
|
||||||
const device = await resolveDevice(this.options.device)
|
const device = await resolveDevice(this.options.device)
|
||||||
const cacheDir = this.options.cacheDir === './models'
|
const cacheDir = this.options.cacheDir === './models'
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue