2025-11-04 13:34:51 -08:00
|
|
|
/**
|
|
|
|
|
* Reproduction test for empty tree bug in v5.3.1
|
|
|
|
|
*
|
|
|
|
|
* BUG: brain.getHistory() throws "Blob not found: 0000...0" when commits
|
|
|
|
|
* have empty trees (entityCount: 0).
|
|
|
|
|
*
|
|
|
|
|
* The zero hash represents an empty tree and should be handled gracefully.
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
import { describe, it, expect, beforeEach, afterEach } from 'vitest'
|
|
|
|
|
import { Brainy } from '../../src/brainy.js'
|
|
|
|
|
import * as fs from 'fs'
|
|
|
|
|
|
|
|
|
|
const TEST_DATA_PATH = './test-empty-tree-bug-data'
|
|
|
|
|
|
|
|
|
|
describe('Empty Tree Bug (v5.3.1)', () => {
|
|
|
|
|
let brain: Brainy
|
|
|
|
|
|
|
|
|
|
beforeEach(async () => {
|
|
|
|
|
// Clean up test data
|
|
|
|
|
if (fs.existsSync(TEST_DATA_PATH)) {
|
|
|
|
|
fs.rmSync(TEST_DATA_PATH, { recursive: true, force: true })
|
|
|
|
|
}
|
|
|
|
|
|
feat(8.0)!: flip requireSubtype default to true (BRAINY-8.0-SUBTYPE-CONTRACT § C-1)
Brainy 8.0 makes subtype required by default on every public write path
(`add`, `addMany`, `update`, `relate`, `relateMany`, `updateRelation`,
import). Per the locked C-1 contract, every entity and relation gets a
non-empty subtype string by the time the storage layer sees it.
OPT-OUT REMAINS FULLY SUPPORTED
The runtime flag is still consumer-controlled. Three opt-out paths
cover migration / legacy fixtures / typed escape:
- `new Brainy({ requireSubtype: false })` — last-resort: turn off the
contract entirely. Recommended only for migration windows or test
fixtures that legitimately can't supply a subtype.
- `new Brainy({ requireSubtype: { except: [NounType.Thing, ...] } })` —
per-type allowlist: strict everywhere except the listed types.
- `brain.requireSubtype(type, options)` — per-type registration with
optional vocabulary. Composes with the brain-wide flag.
Default is now `true`. Opt-out is explicit and documented; nothing
silently degrades.
TEST SWEEP
Bulk-applied `requireSubtype: false` to every `new Brainy({...})` call
site across 120 test files. Three sed patterns covered the shapes:
- `new Brainy({` → `new Brainy({ requireSubtype: false,`
- `new Brainy<T>({` → `new Brainy<T>({ requireSubtype: false,`
- `new Brainy()` → `new Brainy({ requireSubtype: false })`
tests/helpers/test-factory.ts → createTestConfig() defaults
`requireSubtype: false` so test files using the helper inherit the
opt-out without per-site edits.
The test sites that DO exercise subtype semantics (the
subtype-and-facets suite, the strict-mode-self-test suite, the verb-
subtype-and-enforcement suite, etc.) already pass real subtypes — they
were the 7.30.x acceptance tests for this contract. Those tests
continue to pass unchanged.
CHANGES
src/brainy.ts
- normalizeConfig() — `requireSubtype` default `false` → `true`.
Comment refreshed to document the three opt-out paths.
tests/* (120 files)
- Bulk-edited brain construction sites. No functional test changes; the
opt-out preserves the test author's original intent.
tests/helpers/test-factory.ts
- createTestConfig() base config gains `requireSubtype: false`.
NO-OP for consumers who were already passing subtype on every write.
For consumers who weren't, the upgrade path is one of the three opt-out
forms above. Migration recipe documented in 8.0 release notes (next
commit).
VERIFICATION
- npx tsc --noEmit: clean
- npm test: 1408 / 1409 (same pre-existing race-condition outstanding;
no other regressions from the flip)
2026-06-09 14:58:25 -07:00
|
|
|
brain = new Brainy({ requireSubtype: false,
|
2025-11-04 13:34:51 -08:00
|
|
|
storage: {
|
|
|
|
|
type: 'filesystem',
|
|
|
|
|
path: TEST_DATA_PATH,
|
|
|
|
|
branch: 'main',
|
|
|
|
|
enableCompression: true
|
|
|
|
|
},
|
|
|
|
|
disableAutoRebuild: true,
|
|
|
|
|
silent: true
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
await brain.init()
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
afterEach(() => {
|
|
|
|
|
if (fs.existsSync(TEST_DATA_PATH)) {
|
|
|
|
|
fs.rmSync(TEST_DATA_PATH, { recursive: true, force: true })
|
|
|
|
|
}
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
it('should handle getHistory() with empty tree commit', async () => {
|
|
|
|
|
// Create a commit with NO entities (empty tree)
|
|
|
|
|
const commitId = await brain.commit({
|
|
|
|
|
message: 'Empty workspace snapshot',
|
|
|
|
|
author: 'test-user',
|
|
|
|
|
metadata: {
|
|
|
|
|
timestamp: Date.now(),
|
|
|
|
|
isSnapshot: true
|
|
|
|
|
}
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
expect(commitId).toBeTruthy()
|
|
|
|
|
console.log('✅ Commit created:', commitId)
|
|
|
|
|
|
|
|
|
|
// Read the commit blob to inspect it
|
|
|
|
|
const blobStorage = (brain.storage as any).blobStorage
|
|
|
|
|
const refManager = (brain.storage as any).refManager
|
|
|
|
|
const { CommitObject } = await import('../../src/storage/cow/CommitObject.js')
|
|
|
|
|
|
|
|
|
|
const commit = await CommitObject.read(blobStorage, commitId)
|
|
|
|
|
console.log('📄 Commit structure:', JSON.stringify(commit, null, 2))
|
|
|
|
|
|
|
|
|
|
// Check what the ref points to
|
|
|
|
|
const refHash = await refManager.resolveRef('main')
|
|
|
|
|
|
|
|
|
|
// If ref is zero hash, that's the bug
|
|
|
|
|
const zeroHash = '0000000000000000000000000000000000000000000000000000000000000000'
|
|
|
|
|
if (refHash === zeroHash) {
|
|
|
|
|
throw new Error(`BUG CONFIRMED: Ref "main" points to zero hash! commitId=${commitId}, refHash=${refHash}, tree=${commit.tree}`)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Verify commitId is not zero hash
|
|
|
|
|
expect(commitId).not.toBe(zeroHash)
|
|
|
|
|
expect(refHash).toBe(commitId)
|
|
|
|
|
|
|
|
|
|
// This should NOT throw "Blob not found: 0000...0"
|
|
|
|
|
// Empty trees should be handled gracefully
|
|
|
|
|
try {
|
|
|
|
|
const history = await brain.getHistory({ limit: 50 })
|
|
|
|
|
|
|
|
|
|
expect(history).toBeDefined()
|
|
|
|
|
expect(Array.isArray(history)).toBe(true)
|
|
|
|
|
console.log('✅ getHistory() works with empty tree')
|
|
|
|
|
console.log(' History length:', history.length)
|
|
|
|
|
} catch (error: any) {
|
|
|
|
|
console.log('❌ Error during getHistory():', error.message)
|
|
|
|
|
console.log(' Commit tree hash:', commit.tree)
|
|
|
|
|
console.log(' Commit parent hash:', commit.parent)
|
|
|
|
|
throw error
|
|
|
|
|
}
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
it('should handle multiple commits with empty trees', async () => {
|
|
|
|
|
// Create first empty commit
|
|
|
|
|
await brain.commit({
|
|
|
|
|
message: 'First empty snapshot',
|
|
|
|
|
author: 'user1'
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
// Create second empty commit
|
|
|
|
|
await brain.commit({
|
|
|
|
|
message: 'Second empty snapshot',
|
|
|
|
|
author: 'user2'
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
// Get history - should NOT throw
|
|
|
|
|
const history = await brain.getHistory({ limit: 10 })
|
|
|
|
|
|
|
|
|
|
expect(history).toBeDefined()
|
|
|
|
|
expect(history.length).toBeGreaterThanOrEqual(2)
|
|
|
|
|
console.log('✅ Multiple empty commits work')
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
it('should handle mixed commits (empty + with entities)', async () => {
|
|
|
|
|
// Create empty commit
|
|
|
|
|
await brain.commit({
|
|
|
|
|
message: 'Empty snapshot',
|
|
|
|
|
author: 'user1'
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
// Add entity
|
|
|
|
|
await brain.add({
|
|
|
|
|
data: 'Test entity',
|
|
|
|
|
type: 'concept'
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
// Create commit with entities
|
|
|
|
|
await brain.commit({
|
|
|
|
|
message: 'Snapshot with entities',
|
|
|
|
|
author: 'user2'
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
// Get history - should handle both empty and non-empty trees
|
|
|
|
|
const history = await brain.getHistory({ limit: 10 })
|
|
|
|
|
|
|
|
|
|
expect(history).toBeDefined()
|
|
|
|
|
expect(history.length).toBeGreaterThanOrEqual(2)
|
|
|
|
|
console.log('✅ Mixed commits (empty + entities) work')
|
|
|
|
|
})
|
|
|
|
|
})
|