/** * END-TO-END TEST: Verify VFS AND Graph Entities Are Created * * This test MUST PASS to ensure we don't regress on the createEntities bug. * * User frustration: Asked multiple times to ensure BOTH VFS and graph entities are created. * This test is the definitive proof that both are created and searchable. */ import { describe, it, expect, beforeEach, afterEach } from 'vitest' import { Brainy, NounType } from '../../src/index.js' import { clearGlobalCache } from '../../src/utils/unifiedCache.js' import * as fs from 'fs' import * as path from 'path' import * as XLSX from 'xlsx' describe('VFS + Graph Entities Integration Test', () => { let brain: Brainy // Unique storage directory PER TEST so no on-disk state from a prior (or // crashed) run can leak into the next. The dominant cross-test leak here is // the process-global VFS path cache, reset via clearGlobalCache() below; a // fresh directory is the complementary on-disk guarantee. let testDir: string let testExcelPath: string beforeEach(async () => { // The VFS path resolver caches `path -> entityId` in a PROCESS-GLOBAL // UnifiedCache, and the VFS root uses a fixed deterministic id shared by // every instance. Without a reset, a prior test's `/imports` mapping leaks // into the next test's fresh brain (whose storage does not contain that id), // so import()'s internal mkdir relates from a parent entity that no longer // exists and throws EntityNotFoundError. Reset so every test starts pristine. clearGlobalCache() testDir = `./test-vfs-graph-integration-${Date.now()}-${Math.random().toString(36).slice(2)}` testExcelPath = path.join(testDir, 'test-characters.xlsx') // Clean up if (fs.existsSync(testDir)) { fs.rmSync(testDir, { recursive: true }) } fs.mkdirSync(testDir, { recursive: true }) // Create a REAL Excel file with character data const characters = [ { Name: 'Arrowhead', Type: 'person', Description: 'An elven ranger who lives in Silverwood Forest' }, { Name: 'Grimjaw', Type: 'person', Description: 'A dwarven warrior from the Iron Mountains' }, { Name: 'Silverwood Forest', Type: 'location', Description: 'A mystical forest inhabited by elves' }, { Name: 'Iron Mountains', Type: 'location', Description: 'Mountain range home to dwarven clans' } ] const ws = XLSX.utils.json_to_sheet(characters) const wb = XLSX.utils.book_new() XLSX.utils.book_append_sheet(wb, ws, 'Characters') XLSX.writeFile(wb, testExcelPath) // Initialize Brainy brain = new Brainy({ requireSubtype: false, storage: { type: 'filesystem', path: testDir } }) await brain.init() }) afterEach(async () => { // Close the brain BEFORE deleting its storage directory (stops background // flush / writer-lock heartbeat from touching the dir after removal), then // clear the shared global cache so this test's VFS path mappings cannot // bleed into the next one. await brain.close() clearGlobalCache() if (fs.existsSync(testDir)) { fs.rmSync(testDir, { recursive: true }) } }) it('CRITICAL: Must create BOTH VFS wrappers AND graph entities', async () => { console.log('\n' + '='.repeat(80)) console.log('šŸ”¬ CRITICAL TEST: VFS + Graph Entities End-to-End') console.log('='.repeat(80)) // Import WITHOUT specifying createEntities (should default to true after fix) console.log('\nšŸ“„ Importing Excel file...') const result = await brain.import(testExcelPath, { vfsPath: '/imports/test-characters', groupBy: 'sheet' // NOTE: createEntities is NOT specified - MUST default to true! }) console.log('\nšŸ“Š Import Result:') console.log(` VFS files created: ${result.stats.vfsFilesCreated}`) console.log(` Graph nodes created: ${result.stats.graphNodesCreated}`) console.log(` Graph edges created: ${result.stats.graphEdgesCreated}`) // ASSERTION 1: VFS files were created expect(result.stats.vfsFilesCreated).toBeGreaterThan(0) console.log('\nāœ… ASSERTION 1: VFS files created') // ASSERTION 2: Graph entities were created expect(result.stats.graphNodesCreated).toBeGreaterThan(0) console.log('āœ… ASSERTION 2: Graph entities created') // ASSERTION 3: Should have created 4 character entities expect(result.stats.graphNodesCreated).toBeGreaterThanOrEqual(4) console.log('āœ… ASSERTION 3: All 4 character entities created') console.log('\n' + '='.repeat(80)) console.log('šŸ“‚ VFS VERIFICATION') console.log('='.repeat(80)) // Initialize VFS const vfs = brain.vfs await vfs.init() // ASSERTION 4: VFS directory structure exists const rootContents = await vfs.readdir('/imports/test-characters', { withFileTypes: true }) as any[] console.log(`\nšŸ“ VFS root contents (${rootContents.length} items):`) for (const item of rootContents) { console.log(` - ${item.name} (${item.type})`) } expect(rootContents.length).toBeGreaterThan(0) console.log('āœ… ASSERTION 4: VFS directory structure exists') // ASSERTION 5: VFS files are readable // Find the directory (might be 'Characters' or another name based on grouping) const sheetDir = rootContents.find((item: any) => item.type === 'directory') console.log(`\nšŸ“‚ Found directory: ${sheetDir?.name}`) expect(sheetDir).toBeDefined() expect(sheetDir?.type).toBe('directory') const sheetContents = await vfs.readdir(`/imports/test-characters/${sheetDir!.name}`, { withFileTypes: true }) as any[] console.log(`šŸ“ Sheet contents: ${sheetContents.length} files`) expect(sheetContents.length).toBeGreaterThan(0) console.log('āœ… ASSERTION 5: VFS files are readable') // ASSERTION 6: VFS file content is correct const firstFile = sheetContents.find((f: any) => f.type === 'file') expect(firstFile).toBeDefined() const fileContent = await vfs.readFile(`/imports/test-characters/${sheetDir!.name}/${firstFile!.name}`) const fileJson = JSON.parse(fileContent.toString()) console.log(`šŸ“„ First file: ${firstFile!.name}`) console.log(` Content: ${JSON.stringify(fileJson, null, 2).substring(0, 200)}...`) expect(fileJson.name).toBeDefined() console.log('āœ… ASSERTION 6: VFS file content is correct') console.log('\n' + '='.repeat(80)) console.log('šŸ” GRAPH ENTITY VERIFICATION') console.log('='.repeat(80)) // ASSERTION 7: All entities are queryable const allEntities = await brain.find({ limit: 100 }) console.log(`\nšŸ“Š Total entities in brain: ${allEntities.length}`) // Count by type const typeCounts: Record = {} for (const e of allEntities) { typeCounts[e.type] = (typeCounts[e.type] || 0) + 1 } console.log('\nšŸ“‹ Entity type breakdown:') for (const [type, count] of Object.entries(typeCounts)) { console.log(` ${type}: ${count}`) } expect(allEntities.length).toBeGreaterThan(4) console.log('āœ… ASSERTION 7: All entities queryable') // ASSERTION 8: VFS wrapper entities exist const vfsWrappers = allEntities.filter(e => e.metadata?.vfsType === 'file') console.log(`\nšŸ“¦ VFS wrapper entities: ${vfsWrappers.length}`) expect(vfsWrappers.length).toBeGreaterThan(0) console.log('āœ… ASSERTION 8: VFS wrapper entities exist') // ASSERTION 9: Graph entities exist (NOT VFS wrappers) const graphEntities = allEntities.filter(e => !e.metadata?.vfsType || e.metadata.vfsType !== 'file') console.log(`šŸ“Š Graph entities (non-VFS): ${graphEntities.length}`) expect(graphEntities.length).toBeGreaterThanOrEqual(4) console.log('āœ… ASSERTION 9: Graph entities exist') console.log('\n' + '='.repeat(80)) console.log('šŸŽÆ TYPE FILTERING VERIFICATION') console.log('='.repeat(80)) // ASSERTION 10: Type filtering works for graph entities const people = await brain.find({ type: NounType.Person, limit: 100 }) console.log(`\nšŸ‘„ Person entities: ${people.length}`) expect(people.length).toBeGreaterThanOrEqual(2) console.log('āœ… ASSERTION 10: Person type filtering works') // Verify person entities have correct data for (const person of people) { console.log(` - ${person.metadata?.name || person.id} (type: ${person.type})`) expect(person.type).toBe('person') } // ASSERTION 11: Location type filtering works const locations = await brain.find({ type: NounType.Location, limit: 100 }) console.log(`\nšŸ“ Location entities: ${locations.length}`) expect(locations.length).toBeGreaterThanOrEqual(2) console.log('āœ… ASSERTION 11: Location type filtering works') // Verify location entities for (const location of locations) { console.log(` - ${location.metadata?.name || location.id} (type: ${location.type})`) expect(location.type).toBe('location') } // ASSERTION 12: Document type filtering works for VFS wrappers const documents = await brain.find({ type: NounType.Document, limit: 100 }) console.log(`\nšŸ“„ Document entities (VFS wrappers): ${documents.length}`) expect(documents.length).toBeGreaterThan(0) console.log('āœ… ASSERTION 12: Document type filtering works') console.log('\n' + '='.repeat(80)) console.log('šŸ”— ENTITY LINKING VERIFICATION') console.log('='.repeat(80)) // ASSERTION 13: Graph entities have vfsPath metadata const personWithVfsPath = people.find(p => p.metadata?.vfsPath) console.log(`\nšŸ”— Graph entity with VFS link:`) console.log(` Name: ${personWithVfsPath?.metadata?.name}`) console.log(` VFS Path: ${personWithVfsPath?.metadata?.vfsPath}`) expect(personWithVfsPath).toBeDefined() expect(personWithVfsPath?.metadata?.vfsPath).toBeDefined() console.log('āœ… ASSERTION 13: Graph entities linked to VFS files') // ASSERTION 14: The VFS wrapper for an imported entity persists its content. // In 8.0 all VFS file content lives in content-addressable BlobStorage, // referenced by metadata.storage ({ type: 'blob', hash, size }). The legacy // inline `metadata.rawData` field is no longer written by writeFile() // (see src/vfs/VirtualFileSystem.ts: "No rawData - content is in BlobStorage"). // Pick a per-entity wrapper specifically: the import also writes system files // (_source.xlsx, _relationships.json, _metadata.json, import_history.json), // and only the per-entity `/.json` files hold the entity JSON. const isSystemVfsFile = (name?: string) => !name || name.startsWith('_') || name === 'import_history.json' const entityWrapper = vfsWrappers.find( w => w.metadata?.extension === 'json' && !isSystemVfsFile(w.metadata?.name) && w.metadata?.path?.startsWith('/imports/test-characters/') ) console.log(`\nšŸ“¦ Entity VFS wrapper:`) console.log(` Path: ${entityWrapper?.metadata?.path}`) console.log(` Storage: ${JSON.stringify(entityWrapper?.metadata?.storage)}`) expect(entityWrapper).toBeDefined() expect(entityWrapper!.metadata?.storage).toBeDefined() expect(entityWrapper!.metadata?.storage?.type).toBe('blob') expect(entityWrapper!.metadata?.storage?.hash).toBeDefined() console.log('āœ… ASSERTION 14: VFS wrappers persist content in BlobStorage') // ASSERTION 15: That persisted content reads back as the entity JSON. // Canonical read path for VFS content is vfs.readFile(path), which resolves // the blob by metadata.storage.hash and decompresses automatically. const wrapperContent = await vfs.readFile(entityWrapper!.metadata!.path) const entityData = JSON.parse(wrapperContent.toString()) console.log(`\nšŸ”“ VFS wrapper content (read via BlobStorage):`) console.log(` Entity name: ${entityData.name}`) console.log(` Entity type: ${entityData.type}`) expect(entityData.name).toBeDefined() expect(entityData.type).toBeDefined() console.log('āœ… ASSERTION 15: VFS wrapper content reads back correctly') console.log('\n' + '='.repeat(80)) console.log('āœ… ALL ASSERTIONS PASSED') console.log('='.repeat(80)) console.log('\nšŸ“Š Summary:') console.log(` āœ… VFS files created: ${result.stats.vfsFilesCreated}`) console.log(` āœ… Graph entities created: ${result.stats.graphNodesCreated}`) console.log(` āœ… VFS wrappers searchable: ${vfsWrappers.length}`) console.log(` āœ… Graph entities searchable: ${graphEntities.length}`) console.log(` āœ… Type filtering works: Person (${people.length}), Location (${locations.length})`) console.log('\nšŸŽ‰ BOTH VFS AND GRAPH ENTITIES WORKING CORRECTLY!\n') }) it('REGRESSION: Must fail if createEntities is explicitly false', async () => { console.log('\nšŸ”¬ Regression Test: createEntities: false should skip graph entities') const result = await brain.import(testExcelPath, { vfsPath: '/imports/no-graph', createEntities: false // Explicitly disable }) console.log(` VFS files: ${result.stats.vfsFilesCreated}`) console.log(` Graph entities: ${result.stats.graphNodesCreated}`) // Should create VFS but NOT graph entities expect(result.stats.vfsFilesCreated).toBeGreaterThan(0) expect(result.stats.graphNodesCreated).toBe(0) // Type filtering should return 0 for graph entities const people = await brain.find({ type: NounType.Person, limit: 100 }) expect(people.length).toBe(0) console.log(' āœ… Correctly skipped graph entities when disabled') }) it('REGRESSION: Must create graph entities when createEntities is explicitly true', async () => { console.log('\nšŸ”¬ Regression Test: createEntities: true should create graph entities') const result = await brain.import(testExcelPath, { vfsPath: '/imports/with-graph', createEntities: true // Explicitly enable }) console.log(` VFS files: ${result.stats.vfsFilesCreated}`) console.log(` Graph entities: ${result.stats.graphNodesCreated}`) // Should create BOTH VFS and graph entities expect(result.stats.vfsFilesCreated).toBeGreaterThan(0) expect(result.stats.graphNodesCreated).toBeGreaterThan(0) // Type filtering should work const people = await brain.find({ type: NounType.Person, limit: 100 }) expect(people.length).toBeGreaterThanOrEqual(2) console.log(' āœ… Correctly created graph entities when enabled') }) })