David Snelling
780fb6444b
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)
104 lines
2.8 KiB
TypeScript
104 lines
2.8 KiB
TypeScript
/**
|
|
* Integration test to reproduce commit() ref update bug
|
|
* Bug: commit() creates blobs but doesn't update branch refs
|
|
*/
|
|
|
|
import { describe, it, expect, beforeEach, afterEach } from 'vitest'
|
|
import { Brainy } from '../../src/brainy.js'
|
|
import * as fs from 'fs'
|
|
import * as path from 'path'
|
|
import * as zlib from 'zlib'
|
|
|
|
const TEST_DATA_PATH = './test-commit-ref-bug-data'
|
|
|
|
describe('Commit Ref Update Bug (v5.2.0)', () => {
|
|
let brain: Brainy
|
|
|
|
beforeEach(async () => {
|
|
// Clean up test data
|
|
if (fs.existsSync(TEST_DATA_PATH)) {
|
|
fs.rmSync(TEST_DATA_PATH, { recursive: true, force: true })
|
|
}
|
|
|
|
brain = new Brainy({ requireSubtype: false,
|
|
storage: {
|
|
type: 'filesystem',
|
|
path: TEST_DATA_PATH,
|
|
branch: 'main',
|
|
enableCompression: true
|
|
},
|
|
silent: false // Enable logging
|
|
})
|
|
|
|
await brain.init()
|
|
})
|
|
|
|
afterEach(() => {
|
|
if (fs.existsSync(TEST_DATA_PATH)) {
|
|
fs.rmSync(TEST_DATA_PATH, { recursive: true, force: true })
|
|
}
|
|
})
|
|
|
|
it('should update branch ref after commit', async () => {
|
|
// Add an entity
|
|
await brain.add({
|
|
data: 'Test entity',
|
|
type: 'concept',
|
|
metadata: { test: true }
|
|
})
|
|
|
|
// Create first commit
|
|
const commit1Hash = await brain.commit({
|
|
message: 'First commit',
|
|
author: 'test@example.com'
|
|
})
|
|
|
|
console.log(`\n=== Commit 1 created: ${commit1Hash} ===`)
|
|
|
|
// Check the ref file directly
|
|
const refPath = path.join(TEST_DATA_PATH, '_cow', 'ref:refs', 'heads', 'main.gz')
|
|
|
|
expect(fs.existsSync(refPath), 'Ref file should exist').toBe(true)
|
|
|
|
const refContent1 = JSON.parse(
|
|
zlib.gunzipSync(fs.readFileSync(refPath)).toString()
|
|
)
|
|
|
|
console.log('Ref after commit 1:', {
|
|
commitHash: refContent1.commitHash,
|
|
updatedAt: new Date(refContent1.updatedAt).toISOString()
|
|
})
|
|
|
|
// THIS IS THE BUG: commitHash should equal commit1Hash
|
|
expect(refContent1.commitHash).toBe(commit1Hash)
|
|
expect(refContent1.commitHash).not.toBe('0'.repeat(64))
|
|
|
|
// Add another entity
|
|
await brain.add({
|
|
data: 'Second entity',
|
|
type: 'concept'
|
|
})
|
|
|
|
// Create second commit
|
|
const commit2Hash = await brain.commit({
|
|
message: 'Second commit',
|
|
author: 'test@example.com'
|
|
})
|
|
|
|
console.log(`\n=== Commit 2 created: ${commit2Hash} ===`)
|
|
|
|
// Check ref again
|
|
const refContent2 = JSON.parse(
|
|
zlib.gunzipSync(fs.readFileSync(refPath)).toString()
|
|
)
|
|
|
|
console.log('Ref after commit 2:', {
|
|
commitHash: refContent2.commitHash,
|
|
updatedAt: new Date(refContent2.updatedAt).toISOString()
|
|
})
|
|
|
|
// THIS IS THE BUG: commitHash should equal commit2Hash
|
|
expect(refContent2.commitHash).toBe(commit2Hash)
|
|
expect(refContent2.updatedAt).toBeGreaterThan(refContent1.updatedAt)
|
|
})
|
|
})
|