brainy/.recovery-workspace/dist-backup-20250910-141917/augmentations/serverSearchAugmentations.js
David Snelling 8ff382ca3b chore: recovery checkpoint - v3.0 API successfully recovered
CRITICAL CHECKPOINT - DO NOT PUSH TO GITHUB

Recovery Status:
- Successfully recovered brainy.ts from compiled JavaScript
- All core v3.0 API methods functional (add, get, update, delete, relate, find, etc.)
- Neural subsystem intact (562KB embedded patterns, NLP working)
- Augmentation pipeline operational (20+ augmentations)
- HNSW clustering system complete
- Triple Intelligence compiled (needs constructor fix)
- Test suite validates functionality

Changes preserved:
- 898 files with changes from last 3 days
- 144,475 insertions
- All augmentation improvements
- All test coverage enhancements
- Complete v3.0 feature set

This is a LOCAL checkpoint only - contains recovered work after corruption incident.
Created backup in .backups/brainy-full-20250910-151314.tar.gz

Branch: recovery-checkpoint-20250910-151433
Date: Wed Sep 10 03:18:04 PM PDT 2025
2025-09-10 15:18:04 -07:00

586 lines
No EOL
20 KiB
JavaScript

/**
* Server Search Augmentations
*
* This file implements conduit and activation augmentations for browser-server search functionality.
* It allows Brainy to search a server-hosted instance and store results locally.
*/
import { BaseAugmentation } from '../augmentations/brainyAugmentation.js';
/**
* ServerSearchConduitAugmentation
*
* A specialized conduit augmentation that provides functionality for searching
* a server-hosted Brainy instance and storing results locally.
*/
export class ServerSearchConduitAugmentation extends BaseAugmentation {
constructor(name) {
super();
this.name = 'server-search-conduit';
this.timing = 'after';
this.metadata = 'readonly'; // Reads metadata to sync with server
this.operations = ['addNoun', 'delete', 'addVerb'];
this.priority = 20;
this.localDb = null;
if (name) {
// Override name if provided (though it's readonly, this won't work)
// Keep constructor parameter for API compatibility but ignore it
}
}
/**
* Initialize the augmentation
*/
async onInitialize() {
// Local DB must be set before initialization
if (!this.localDb) {
this.log('Local database not set. Call setLocalDb before using server search.', 'warn');
return;
}
this.log('Server search conduit initialized');
}
/**
* Set the local Brainy instance
* @param db The Brainy instance to use for local storage
*/
setLocalDb(db) {
this.localDb = db;
}
/**
* Stub method for performing search operations via WebSocket
* TODO: Implement proper WebSocket communication
*/
async performSearch(params) {
this.log('Search operation not yet implemented - returning empty results', 'warn');
return {
success: true,
data: []
};
}
/**
* Stub method for performing write operations via WebSocket
* TODO: Implement proper WebSocket communication
*/
async performWrite(params) {
this.log('Write operation not yet implemented', 'warn');
return {
success: false,
data: null,
error: 'Write operation not implemented'
};
}
/**
* Get the local Brainy instance
* @returns The local Brainy instance
*/
getLocalDb() {
return this.localDb;
}
/**
* Execute method - required by BaseAugmentation
*/
async execute(operation, params, next) {
// Just pass through for now - server search operations are handled by the activation augmentation
return next();
}
/**
* Search the server-hosted Brainy instance and store results locally
* @param connectionId The ID of the established connection
* @param query The search query
* @param limit Maximum number of results to return
* @returns Search results
*/
async searchServer(connectionId, query, limit = 10) {
if (!this.isInitialized) {
throw new Error('ServerSearchConduitAugmentation not initialized');
}
try {
// Create a search request (TODO: Implement proper WebSocket communication)
const readResult = await this.performSearch({
connectionId,
query: {
type: 'search',
query,
limit
}
});
if (readResult.success && readResult.data) {
const searchResults = readResult.data;
// Store the results in the local Brainy instance
if (this.localDb) {
for (const result of searchResults) {
// Check if the noun already exists in the local database
const existingNoun = await this.localDb.getNoun(result.id);
if (!existingNoun) {
// Add the noun to the local database
await this.localDb.addNoun(result.vector, result.metadata);
}
}
}
return {
success: true,
data: searchResults
};
}
else {
return {
success: false,
data: null,
error: readResult.error || 'Unknown error searching server'
};
}
}
catch (error) {
console.error('Error searching server:', error);
return {
success: false,
data: null,
error: `Error searching server: ${error}`
};
}
}
/**
* Search the local Brainy instance
* @param query The search query
* @param limit Maximum number of results to return
* @returns Search results
*/
async searchLocal(query, limit = 10) {
if (!this.isInitialized) {
throw new Error('ServerSearchConduitAugmentation not initialized');
}
try {
if (!this.localDb) {
return {
success: false,
data: null,
error: 'Local database not initialized'
};
}
const results = await this.localDb.searchText(query, limit);
return {
success: true,
data: results
};
}
catch (error) {
console.error('Error searching local database:', error);
return {
success: false,
data: null,
error: `Error searching local database: ${error}`
};
}
}
/**
* Search both server and local instances, combine results, and store server results locally
* @param connectionId The ID of the established connection
* @param query The search query
* @param limit Maximum number of results to return
* @returns Combined search results
*/
async searchCombined(connectionId, query, limit = 10) {
if (!this.isInitialized) {
throw new Error('ServerSearchConduitAugmentation not initialized');
}
try {
// Search local first
const localSearchResult = await this.searchLocal(query, limit);
if (!localSearchResult.success) {
return localSearchResult;
}
const localResults = localSearchResult.data;
// If we have enough local results, return them
if (localResults.length >= limit) {
return localSearchResult;
}
// Otherwise, search server for additional results
const serverSearchResult = await this.searchServer(connectionId, query, limit - localResults.length);
if (!serverSearchResult.success) {
// If server search fails, return local results
return localSearchResult;
}
const serverResults = serverSearchResult.data;
// Combine results, removing duplicates
const combinedResults = [...localResults];
const localIds = new Set(localResults.map((r) => r.id));
for (const result of serverResults) {
if (!localIds.has(result.id)) {
combinedResults.push(result);
}
}
return {
success: true,
data: combinedResults
};
}
catch (error) {
console.error('Error performing combined search:', error);
return {
success: false,
data: null,
error: `Error performing combined search: ${error}`
};
}
}
/**
* Add data to both local and server instances
* @param connectionId The ID of the established connection
* @param data Text or vector to add
* @param metadata Metadata for the data
* @returns ID of the added data
*/
async addToBoth(connectionId, data, metadata = {}) {
if (!this.isInitialized) {
throw new Error('ServerSearchConduitAugmentation not initialized');
}
try {
if (!this.localDb) {
return {
success: false,
data: '',
error: 'Local database not initialized'
};
}
// Add to local first - addNoun handles both strings and vectors automatically
const id = await this.localDb.addNoun(data, metadata);
// Get the vector and metadata
const noun = (await this.localDb.getNoun(id));
if (!noun) {
return {
success: false,
data: '',
error: 'Failed to retrieve newly created noun'
};
}
// Add to server (TODO: Implement proper WebSocket communication)
const writeResult = await this.performWrite({
connectionId,
data: {
type: 'addNoun',
vector: noun.vector,
metadata: noun.metadata
}
});
if (!writeResult.success) {
return {
success: true,
data: id,
error: `Added locally but failed to add to server: ${writeResult.error}`
};
}
return {
success: true,
data: id
};
}
catch (error) {
console.error('Error adding data to both:', error);
return {
success: false,
data: '',
error: `Error adding data to both: ${error}`
};
}
}
/**
* Establish connection to remote server
* @param serverUrl Server URL to connect to
* @param options Connection options
* @returns Connection promise
*/
establishConnection(serverUrl, options) {
// Stub implementation - remote connection functionality not yet fully implemented in 2.0
console.warn('establishConnection: Remote server connections not yet fully implemented in Brainy 2.0');
return Promise.resolve({ connected: false, reason: 'Not implemented' });
}
/**
* Close WebSocket connection
* @param connectionId Connection ID to close
* @returns Promise that resolves when connection is closed
*/
async closeWebSocket(connectionId) {
// Stub implementation - WebSocket functionality not yet fully implemented in 2.0
console.warn(`closeWebSocket: WebSocket functionality not yet fully implemented in Brainy 2.0 (connectionId: ${connectionId})`);
}
}
/**
* ServerSearchActivationAugmentation
*
* An activation augmentation that provides actions for server search functionality.
*/
export class ServerSearchActivationAugmentation extends BaseAugmentation {
constructor(name) {
super();
this.name = 'server-search-activation';
this.timing = 'after';
this.metadata = 'readonly'; // Reads metadata for server activation
this.operations = ['search', 'addNoun'];
this.priority = 20;
this.conduitAugmentation = null;
this.connections = new Map();
if (name) {
// Keep constructor parameter for API compatibility but ignore it
}
}
async onInitialize() {
// Initialization logic if needed
}
async onShutdown() {
// Cleanup connections
this.connections.clear();
}
async execute(operation, params, next) {
// Execute the operation first
const result = await next();
// Handle server search operations
if (operation === 'search' && this.conduitAugmentation) {
// Trigger server search when local search happens
const connectionId = this.connections.keys().next().value;
if (connectionId && params.query) {
await this.conduitAugmentation.searchServer(connectionId, params.query, params.limit || 10);
}
}
return result;
}
/**
* Set the conduit augmentation to use for server search
* @param conduit The ServerSearchConduitAugmentation to use
*/
setConduitAugmentation(conduit) {
this.conduitAugmentation = conduit;
}
/**
* Store a connection for later use
* @param connectionId The ID to use for the connection
* @param connection The WebSocket connection
*/
storeConnection(connectionId, connection) {
this.connections.set(connectionId, connection);
}
/**
* Get a stored connection
* @param connectionId The ID of the connection to retrieve
* @returns The WebSocket connection
*/
getConnection(connectionId) {
return this.connections.get(connectionId);
}
/**
* Trigger an action based on a processed command or internal state
* @param actionName The name of the action to trigger
* @param parameters Optional parameters for the action
*/
triggerAction(actionName, parameters) {
if (!this.conduitAugmentation) {
return {
success: false,
data: null,
error: 'Conduit augmentation not set'
};
}
// Handle different actions
switch (actionName) {
case 'connectToServer':
return this.handleConnectToServer(parameters || {});
case 'searchServer':
return this.handleSearchServer(parameters || {});
case 'searchLocal':
return this.handleSearchLocal(parameters || {});
case 'searchCombined':
return this.handleSearchCombined(parameters || {});
case 'addToBoth':
return this.handleAddToBoth(parameters || {});
default:
return {
success: false,
data: null,
error: `Unknown action: ${actionName}`
};
}
}
/**
* Handle the connectToServer action
* @param parameters Action parameters
*/
handleConnectToServer(parameters) {
const serverUrl = parameters.serverUrl;
const protocols = parameters.protocols;
if (!serverUrl) {
return {
success: false,
data: null,
error: 'serverUrl parameter is required'
};
}
// Return a promise that will be resolved when the connection is established
return {
success: true,
data: this.conduitAugmentation.establishConnection(serverUrl, {
protocols
})
};
}
/**
* Handle the searchServer action
* @param parameters Action parameters
*/
handleSearchServer(parameters) {
const connectionId = parameters.connectionId;
const query = parameters.query;
const limit = parameters.limit || 10;
if (!connectionId) {
return {
success: false,
data: null,
error: 'connectionId parameter is required'
};
}
if (!query) {
return {
success: false,
data: null,
error: 'query parameter is required'
};
}
// Return a promise that will be resolved when the search is complete
return {
success: true,
data: this.conduitAugmentation.searchServer(connectionId, query, limit)
};
}
/**
* Handle the searchLocal action
* @param parameters Action parameters
*/
handleSearchLocal(parameters) {
const query = parameters.query;
const limit = parameters.limit || 10;
if (!query) {
return {
success: false,
data: null,
error: 'query parameter is required'
};
}
// Return a promise that will be resolved when the search is complete
return {
success: true,
data: this.conduitAugmentation.searchLocal(query, limit)
};
}
/**
* Handle the searchCombined action
* @param parameters Action parameters
*/
handleSearchCombined(parameters) {
const connectionId = parameters.connectionId;
const query = parameters.query;
const limit = parameters.limit || 10;
if (!connectionId) {
return {
success: false,
data: null,
error: 'connectionId parameter is required'
};
}
if (!query) {
return {
success: false,
data: null,
error: 'query parameter is required'
};
}
// Return a promise that will be resolved when the search is complete
return {
success: true,
data: this.conduitAugmentation.searchCombined(connectionId, query, limit)
};
}
/**
* Handle the addToBoth action
* @param parameters Action parameters
*/
handleAddToBoth(parameters) {
const connectionId = parameters.connectionId;
const data = parameters.data;
const metadata = parameters.metadata || {};
if (!connectionId) {
return {
success: false,
data: null,
error: 'connectionId parameter is required'
};
}
if (!data) {
return {
success: false,
data: null,
error: 'data parameter is required'
};
}
// Return a promise that will be resolved when the add is complete
return {
success: true,
data: this.conduitAugmentation.addToBoth(connectionId, data, metadata)
};
}
/**
* Generates an expressive output or response from Brainy
* @param knowledgeId The identifier of the knowledge to express
* @param format The desired output format (e.g., 'text', 'json')
*/
generateOutput(knowledgeId, format) {
// This method is not used for server search functionality
return {
success: false,
data: '',
error: 'generateOutput is not implemented for ServerSearchActivationAugmentation'
};
}
/**
* Interacts with an external system or API
* @param systemId The identifier of the external system
* @param payload The data to send to the external system
*/
interactExternal(systemId, payload) {
// This method is not used for server search functionality
return {
success: false,
data: null,
error: 'interactExternal is not implemented for ServerSearchActivationAugmentation'
};
}
}
/**
* Factory function to create server search augmentations
* @param serverUrl The URL of the server to connect to
* @param options Additional options
* @returns An object containing the created augmentations
*/
export async function createServerSearchAugmentations(serverUrl, options = {}) {
// Create the conduit augmentation
const conduit = new ServerSearchConduitAugmentation(options.conduitName);
// Set the local database if provided
if (options.localDb) {
conduit.setLocalDb(options.localDb);
}
// Create the activation augmentation
const activation = new ServerSearchActivationAugmentation(options.activationName);
// Note: Augmentations will be initialized when added to BrainyData
// Link the augmentations
activation.setConduitAugmentation(conduit);
// TODO: Connect to the server (stub implementation for now)
const connection = {
connectionId: `stub-connection-${Date.now()}`,
url: serverUrl,
status: 'connected',
close: async () => { },
send: async (data) => { }
};
// Store the connection in the activation augmentation
activation.storeConnection(connection.connectionId, connection);
return {
conduit,
activation,
connection
};
}
//# sourceMappingURL=serverSearchAugmentations.js.map