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)
108 lines
3.4 KiB
TypeScript
108 lines
3.4 KiB
TypeScript
/**
|
|
* Domain and Time Clustering Tests
|
|
*
|
|
* Tests for clusterByDomain() and clusterByTime() methods
|
|
* that were previously stub implementations.
|
|
*/
|
|
|
|
import { describe, it, expect, beforeEach } from 'vitest'
|
|
import { Brainy } from '../../../src/brainy'
|
|
import { NounType } from '../../../src/types/graphTypes'
|
|
import { createAddParams } from '../../helpers/test-factory'
|
|
|
|
describe('Domain and Time Clustering', () => {
|
|
let brain: Brainy
|
|
|
|
beforeEach(async () => {
|
|
brain = new Brainy({ requireSubtype: false,
|
|
enableCache: false,
|
|
storage: { type: 'memory' } // Use memory storage for tests
|
|
})
|
|
await brain.init()
|
|
})
|
|
|
|
describe('clusterByTime() - Temporal clustering', () => {
|
|
it('should cluster entities by createdAt timestamps', async () => {
|
|
// These will use the auto-generated createdAt timestamps
|
|
const id1 = await brain.add(createAddParams({
|
|
data: 'First item'
|
|
}))
|
|
|
|
// Wait a bit to ensure different timestamps
|
|
await new Promise(resolve => setTimeout(resolve, 10))
|
|
|
|
const id2 = await brain.add(createAddParams({
|
|
data: 'Second item'
|
|
}))
|
|
|
|
const now = new Date()
|
|
const timeWindows = [
|
|
{
|
|
start: new Date(now.getTime() - 60 * 60 * 1000), // Last hour
|
|
end: new Date(now.getTime() + 60 * 60 * 1000), // Next hour (to include all)
|
|
label: 'Now'
|
|
}
|
|
]
|
|
|
|
const clusters = await brain.neural().clusterByTime('createdAt', timeWindows, {
|
|
timeField: 'createdAt',
|
|
windows: timeWindows
|
|
})
|
|
|
|
expect(Array.isArray(clusters)).toBe(true)
|
|
|
|
// Both items should be in the 'Now' time window
|
|
const nowCluster = clusters.find(c => c.timeWindow?.label === 'Now')
|
|
expect(nowCluster).toBeDefined()
|
|
if (nowCluster) {
|
|
expect(nowCluster.members.length).toBeGreaterThanOrEqual(2)
|
|
}
|
|
})
|
|
|
|
it('should handle empty time windows gracefully', async () => {
|
|
const futureStart = new Date(Date.now() + 365 * 24 * 60 * 60 * 1000) // 1 year from now
|
|
const futureEnd = new Date(Date.now() + 2 * 365 * 24 * 60 * 60 * 1000) // 2 years from now
|
|
|
|
const timeWindows = [
|
|
{
|
|
start: futureStart,
|
|
end: futureEnd,
|
|
label: 'Future'
|
|
}
|
|
]
|
|
|
|
const clusters = await brain.neural().clusterByTime('createdAt', timeWindows, {
|
|
timeField: 'createdAt',
|
|
windows: timeWindows
|
|
})
|
|
|
|
// Should return empty array or array with empty clusters
|
|
expect(Array.isArray(clusters)).toBe(true)
|
|
})
|
|
})
|
|
|
|
describe('Cross-domain functionality', () => {
|
|
it('should find cross-domain clusters when enabled', async () => {
|
|
// Add entities from different domains with similar content
|
|
await brain.add(createAddParams({
|
|
data: 'Machine learning and artificial intelligence',
|
|
type: NounType.Document,
|
|
metadata: { category: 'tech' }
|
|
}))
|
|
await brain.add(createAddParams({
|
|
data: 'AI and neural networks',
|
|
type: NounType.Concept,
|
|
metadata: { category: 'science' }
|
|
}))
|
|
|
|
const clusters = await brain.neural().clusterByDomain('category', {
|
|
minClusterSize: 1,
|
|
preserveDomainBoundaries: false, // Enable cross-domain clustering
|
|
crossDomainThreshold: 0.5
|
|
})
|
|
|
|
expect(Array.isArray(clusters)).toBe(true)
|
|
expect(clusters.length).toBeGreaterThan(0)
|
|
})
|
|
})
|
|
})
|