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

**feat(docs): add compatibility and testing guides; enforce Universal Sentence Encoder usage**

Browse source 
- Added new documentation files:
  - `COMPATIBILITY.md` detailing environment-specific compatibility and behavior (Node.js, Browser, Worker).
  - `TESTING.md` providing instructions for verifying cache detection across environments.
  - Created browser (`test-browser-cache-detection.html`) and worker (`test-worker-cache-detection.html`) test scripts to validate cache mechanisms.

- Removed fallback mechanisms for embedding:
  - Updated `embedding.ts` to enforce strict usage of Universal Sentence Encoder (USE).
  - Fallback methods (`generateFallbackVector`) and related logic have been removed.
  - Errors are thrown when USE initialization or embedding fails, ensuring stricter reliability.

- Improved error handling:
  - Standardized error throwing for all USE-related failures across single and batch embeddings.
  - Logging updated to reflect critical embedding issues without allowing degraded operations.

**Purpose**: Improve documentation for environment compatibility and testing while enforcing consistent use of Universal Sentence Encoder for deterministic embeddings, removing unreliable fallback mechanisms.
This commit is contained in:
David Snelling 2025-08-01 11:02:01 -07:00
parent 6ee0881d86
commit 885a8b403a
6 changed files with 585 additions and 106 deletions
Download patch file Download diff file Expand all files Collapse all files

78
test-browser-cache-detection.html Normal file
View file

@ -0,0 +1,78 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Brainy Cache Detection Browser Test</title>
<style>
body {
font-family: Arial, sans-serif;
max-width: 800px;
margin: 0 auto;
padding: 20px;
}
#results {
margin-top: 20px;
padding: 10px;
border: 1px solid #ccc;
border-radius: 5px;
background-color: #f9f9f9;
}
.success {
color: green;
font-weight: bold;
}
.error {
color: red;
font-weight: bold;
}
</style>
</head>
<body>
<h1>Brainy Cache Detection Browser Test</h1>
<p>This page tests if Brainy's cache detection works properly in browser environments.</p>
<button id="runTest">Run Test</button>
<div id="results">
<p>Test results will appear here...</p>
</div>
<script type="module">
import { BrainyData } from './dist/unified.js';
document.getElementById('runTest').addEventListener('click', async () => {
const resultsDiv = document.getElementById('results');
resultsDiv.innerHTML = '<p>Running test...</p>';
try {
console.log('Creating BrainyData instance...');
resultsDiv.innerHTML += '<p>Creating BrainyData instance...</p>';
const brainy = new BrainyData();
console.log('BrainyData instance created successfully!');
resultsDiv.innerHTML += '<p class="success">BrainyData instance created successfully!</p>';
// Initialize to make sure all components are created
await brainy.init();
console.log('BrainyData initialized successfully!');
resultsDiv.innerHTML += '<p class="success">BrainyData initialized successfully!</p>';
// Add a simple item to verify everything works
const id = await brainy.add("Test item for browser cache detection");
console.log('Added test item with ID:', id);
resultsDiv.innerHTML += `<p class="success">Added test item with ID: ${id}</p>`;
resultsDiv.innerHTML += '<p class="success">✅ Test completed successfully! Cache detection works in browser environment.</p>';
} catch (error) {
console.error('Error during cache detection test:', error);
resultsDiv.innerHTML += `<p class="error">❌ Error during test: ${error.message}</p>`;
resultsDiv.innerHTML += `<p class="error">Stack trace: ${error.stack}</p>`;
}
});
</script>
</body>
</html>