/** * Unit tests for `scope-extractor.extract` — the 5-pass driver * (RFC §5.3; Ring 2 PKG #919). * * Tests are organized by pass so a regression localizes to the pass it * broke. A `MockProvider` emits synthetic `CaptureMatch[]` with no real * AST; the extractor is pure given those captures. */ import { describe, it, expect } from 'vitest'; import type { Capture, CaptureMatch, ParsedImport, ParsedTypeBinding, ReferenceKind, Scope, ScopeKind, } from 'gitnexus-shared'; import { extract, type ScopeExtractorHooks } from '../../../src/core/ingestion/scope-extractor.js'; // ─── Synthetic-capture helpers ────────────────────────────────────────────── const cap = ( name: string, startLine: number, startCol: number, endLine: number, endCol: number, text = '', ): Capture => ({ name, range: { startLine, startCol, endLine, endCol }, text, }); const scopeMatch = ( kind: Lowercase, startLine: number, startCol: number, endLine: number, endCol: number, ): CaptureMatch => ({ [`@scope.${kind}`]: cap(`@scope.${kind}`, startLine, startCol, endLine, endCol), }); const declMatch = ( kindStr: string, name: string, startLine: number, startCol: number, endLine: number, endCol: number, extras: Record = {}, ): CaptureMatch => ({ [`@declaration.${kindStr}`]: cap(`@declaration.${kindStr}`, startLine, startCol, endLine, endCol), '@declaration.name': cap('@declaration.name', startLine, startCol, endLine, endCol, name), ...extras, }); const importMatch = ( startLine: number, startCol: number, endLine: number, endCol: number, ): CaptureMatch => ({ '@import.statement': cap('@import.statement', startLine, startCol, endLine, endCol), }); const typeBindingMatch = ( startLine: number, startCol: number, endLine: number, endCol: number, ): CaptureMatch => ({ '@type-binding.parameter': cap('@type-binding.parameter', startLine, startCol, endLine, endCol), }); const refMatch = ( suffix: string, name: string, startLine: number, startCol: number, endLine: number, endCol: number, extras: Record = {}, ): CaptureMatch => ({ [`@reference.${suffix}`]: cap(`@reference.${suffix}`, startLine, startCol, endLine, endCol), '@reference.name': cap('@reference.name', startLine, startCol, endLine, endCol, name), ...extras, }); // ─── MockProvider ─────────────────────────────────────────────────────────── // // The extractor declares its dependency on a narrow `ScopeExtractorHooks` // surface — not the full `LanguageProvider`. Tests implement exactly that // surface, so adding a new hook to `extract()` that's not in // `ScopeExtractorHooks` is a compile error, not a silent test pass. function mockProvider(hooks: Partial = {}): ScopeExtractorHooks { return hooks; } // ─── §Pass 1: scope tree construction ────────────────────────────────────── describe('Pass 1: scope tree', () => { it('creates a single Module scope from one @scope.module match', () => { const result = extract([scopeMatch('module', 1, 0, 100, 0)], 'a.ts', mockProvider()); expect(result.scopes).toHaveLength(1); expect(result.scopes[0]!.kind).toBe('Module'); expect(result.scopes[0]!.parent).toBeNull(); expect(result.moduleScope).toBe(result.scopes[0]!.id); }); it('synthesizes a single empty Module scope when the provider emits no captures', () => { const result = extract([], 'empty.py', mockProvider()); expect(result.scopes).toHaveLength(1); expect(result.scopes[0]!).toMatchObject({ kind: 'Module', parent: null, range: { startLine: 0, startCol: 0, endLine: 0, endCol: 0 }, }); expect(result.moduleScope).toBe(result.scopes[0]!.id); }); it('nests Class under Module when the class range is contained in the module range', () => { const result = extract( [scopeMatch('module', 1, 0, 100, 0), scopeMatch('class', 5, 0, 50, 0)], 'a.ts', mockProvider(), ); expect(result.scopes).toHaveLength(2); const cls = result.scopes.find((s) => s.kind === 'Class')!; const mod = result.scopes.find((s) => s.kind === 'Module')!; expect(cls.parent).toBe(mod.id); }); it('nests Method under Class, Class under Module — deep nesting', () => { const result = extract( [ scopeMatch('module', 1, 0, 100, 0), scopeMatch('class', 5, 0, 50, 0), scopeMatch('function', 10, 2, 30, 2), ], 'a.ts', mockProvider(), ); const mod = result.scopes.find((s) => s.kind === 'Module')!; const cls = result.scopes.find((s) => s.kind === 'Class')!; const fn = result.scopes.find((s) => s.kind === 'Function')!; expect(cls.parent).toBe(mod.id); expect(fn.parent).toBe(cls.id); }); it('places non-nested siblings at the same level under the module', () => { const result = extract( [ scopeMatch('module', 1, 0, 100, 0), scopeMatch('function', 10, 0, 20, 0), scopeMatch('function', 30, 0, 40, 0), ], 'a.ts', mockProvider(), ); const mod = result.scopes.find((s) => s.kind === 'Module')!; const fns = result.scopes.filter((s) => s.kind === 'Function'); expect(fns).toHaveLength(2); for (const fn of fns) expect(fn.parent).toBe(mod.id); }); it('uses `provider.resolveScopeKind` to override the default kind from the suffix', () => { // Provider upgrades a `@scope.block` to `Expression` for a comprehension- // style use case. const result = extract( [scopeMatch('module', 1, 0, 100, 0), scopeMatch('block', 10, 0, 15, 0)], 'a.ts', mockProvider({ resolveScopeKind: (match) => (match['@scope.block'] !== undefined ? 'Expression' : null), }), ); expect(result.scopes.find((s) => s.kind === 'Expression')).toBeDefined(); }); it('throws ScopeTreeInvariantError when siblings overlap (provider bug)', () => { expect(() => extract( [ scopeMatch('module', 1, 0, 100, 0), scopeMatch('function', 10, 0, 20, 0), scopeMatch('function', 15, 0, 25, 0), // overlaps ], 'a.ts', mockProvider(), ), ).toThrow(/overlap/i); }); it('throws when no Module scope is present', () => { expect(() => extract([scopeMatch('function', 1, 0, 10, 0)], 'a.ts', mockProvider())).toThrow( /Module/, ); }); }); // ─── §Pass 2: declarations + local bindings ──────────────────────────────── describe('Pass 2: declarations + local bindings', () => { it('attaches a Class declaration to its enclosing Module scope', () => { const result = extract( [ scopeMatch('module', 1, 0, 100, 0), scopeMatch('class', 5, 0, 50, 0), declMatch('class', 'User', 5, 6, 5, 10), ], 'a.ts', mockProvider(), ); // The declaration sits at line 5 → innermost scope is Class (at 5:0..50:0). const cls = result.scopes.find((s) => s.kind === 'Class')!; expect(cls.ownedDefs).toHaveLength(1); expect(cls.ownedDefs[0]!.type).toBe('Class'); expect(cls.ownedDefs[0]!.qualifiedName).toBe('User'); expect(cls.bindings.get('User')).toBeDefined(); expect(cls.bindings.get('User')![0]!.origin).toBe('local'); }); it('records the declaration in `localDefs` as well', () => { const result = extract( [scopeMatch('module', 1, 0, 100, 0), declMatch('function', 'render', 5, 0, 5, 6)], 'a.ts', mockProvider(), ); expect(result.localDefs).toHaveLength(1); expect(result.localDefs[0]!.type).toBe('Function'); }); it('honors `provider.bindingScopeFor` to hoist a binding to an outer scope', () => { // Treat every declaration as hoisted to the module scope. const result = extract( [ scopeMatch('module', 1, 0, 100, 0), scopeMatch('function', 10, 0, 30, 0), declMatch('variable', 'x', 15, 4, 15, 5), ], 'a.ts', mockProvider({ bindingScopeFor: (_match, _innermost, scopeTree) => { for (const s of scopeTree.byId.values()) if (s.kind === 'Module') return s.id; return null; }, }), ); const mod = result.scopes.find((s) => s.kind === 'Module')!; const fn = result.scopes.find((s) => s.kind === 'Function')!; // Binding hoisted to module; function scope's bindings empty for 'x'. expect(mod.bindings.get('x')).toBeDefined(); expect(fn.bindings.get('x')).toBeUndefined(); // `ownedDefs` stays structural (innermost = function). expect(fn.ownedDefs).toHaveLength(1); }); it('ignores declarations with unknown kind suffixes', () => { const result = extract( [scopeMatch('module', 1, 0, 100, 0), declMatch('mystery', 'x', 5, 0, 5, 1)], 'a.ts', mockProvider(), ); expect(result.localDefs).toHaveLength(0); }); }); // ─── §Pass 3: imports ────────────────────────────────────────────────────── describe('Pass 3: raw imports', () => { it('collects imports via `provider.interpretImport`', () => { const named: ParsedImport = { kind: 'named', localName: 'User', importedName: 'User', targetRaw: './models', }; const result = extract( [scopeMatch('module', 1, 0, 100, 0), importMatch(3, 0, 3, 30)], 'a.ts', mockProvider({ interpretImport: () => named, }), ); expect(result.parsedImports).toEqual([named]); }); it('drops imports when `interpretImport` returns null', () => { const result = extract( [scopeMatch('module', 1, 0, 100, 0), importMatch(3, 0, 3, 30)], 'a.ts', mockProvider({ interpretImport: () => null, }), ); expect(result.parsedImports).toEqual([]); }); it('emits no imports when the provider does not implement `interpretImport`', () => { const result = extract( [scopeMatch('module', 1, 0, 100, 0), importMatch(3, 0, 3, 30)], 'a.ts', mockProvider(), ); expect(result.parsedImports).toEqual([]); }); }); // ─── §Pass 4: type bindings ─────────────────────────────────────────────── describe('Pass 4: type bindings', () => { it('attaches a parameter-annotation TypeRef to the innermost scope', () => { const parsed: ParsedTypeBinding = { boundName: 'user', rawTypeName: 'User', source: 'parameter-annotation', }; const result = extract( [ scopeMatch('module', 1, 0, 100, 0), scopeMatch('function', 5, 0, 20, 0), typeBindingMatch(6, 4, 6, 14), ], 'a.ts', mockProvider({ interpretTypeBinding: () => parsed, }), ); const fn = result.scopes.find((s) => s.kind === 'Function')!; const tb = fn.typeBindings.get('user'); expect(tb).toBeDefined(); expect(tb!.rawName).toBe('User'); expect(tb!.source).toBe('parameter-annotation'); expect(tb!.declaredAtScope).toBe(fn.id); }); it('skips type-binding matches when the provider returns null', () => { const result = extract( [ scopeMatch('module', 1, 0, 100, 0), scopeMatch('function', 5, 0, 20, 0), typeBindingMatch(6, 4, 6, 14), ], 'a.ts', mockProvider({ interpretTypeBinding: () => null, }), ); const fn = result.scopes.find((s) => s.kind === 'Function')!; expect(fn.typeBindings.size).toBe(0); }); }); // ─── §Pass 5: reference sites ───────────────────────────────────────────── describe('Pass 5: reference sites', () => { it('emits a call reference with the innermost scope anchor', () => { const result = extract( [ scopeMatch('module', 1, 0, 100, 0), scopeMatch('function', 5, 0, 20, 0), refMatch('call.free', 'print', 10, 4, 10, 9), ], 'a.ts', mockProvider(), ); const fn = result.scopes.find((s) => s.kind === 'Function')!; expect(result.referenceSites).toHaveLength(1); expect(result.referenceSites[0]!.name).toBe('print'); expect(result.referenceSites[0]!.kind).toBe('call'); expect(result.referenceSites[0]!.callForm).toBe('free'); expect(result.referenceSites[0]!.inScope).toBe(fn.id); }); it('classifies member calls via the `@reference.call.member` sub-tag', () => { const result = extract( [ scopeMatch('module', 1, 0, 100, 0), refMatch('call.member', 'save', 3, 4, 3, 8, { '@reference.receiver': cap('@reference.receiver', 3, 0, 3, 4, 'user'), }), ], 'a.ts', mockProvider(), ); expect(result.referenceSites[0]!.callForm).toBe('member'); expect(result.referenceSites[0]!.explicitReceiver).toEqual({ name: 'user' }); }); it('falls back to `provider.classifyCallForm` when the anchor has no sub-tag', () => { const result = extract( [scopeMatch('module', 1, 0, 100, 0), refMatch('call', 'foo', 3, 0, 3, 3)], 'a.ts', mockProvider({ classifyCallForm: () => 'member', }), ); expect(result.referenceSites[0]!.callForm).toBe('member'); }); it('recognizes all reference kinds (call, read, write, inherits, type, import_use)', () => { const kindsToEmit: Array<[string, ReferenceKind]> = [ ['call.free', 'call'], ['read', 'read'], ['write', 'write'], ['inherits', 'inherits'], ['type', 'type-reference'], ['import_use', 'import-use'], ]; const matches = [ scopeMatch('module', 1, 0, 100, 0), ...kindsToEmit.map(([suffix], i) => refMatch(suffix, `ref${i}`, 10 + i, 0, 10 + i, 5)), ]; const result = extract(matches, 'a.ts', mockProvider()); expect(result.referenceSites.map((s) => s.kind)).toEqual(kindsToEmit.map(([, kind]) => kind)); }); it('picks the call anchor over a wider-ranged @reference.receiver (regression for KNOWN_SUB_TAGS exclusion)', () => { // Regression for the bug fixed before commit: a member call like // `user.save()` where the receiver capture (`user`) spans MORE source // than the call anchor (`save`). The broadest-range anchor heuristic // would have picked the receiver — `anchorCaptureFor` must exclude // known sub-tags (`@reference.receiver`, `@reference.name`, etc.) to // route the match as a `call` reference. const result = extract( [ scopeMatch('module', 1, 0, 100, 0), { // Receiver spans columns 0-10 (wider). '@reference.receiver': cap('@reference.receiver', 3, 0, 3, 10, 'longUserName'), // Call name spans columns 11-15 (narrower). '@reference.name': cap('@reference.name', 3, 11, 3, 15, 'save'), // The anchor — call.member — spans 0-17 (full expression). In the // buggy behavior the receiver would have tied-or-won. Even here, // the fix guarantees we pick the call anchor, never the sub-tag. '@reference.call.member': cap('@reference.call.member', 3, 0, 3, 17), }, ], 'a.ts', mockProvider(), ); expect(result.referenceSites).toHaveLength(1); expect(result.referenceSites[0]!.name).toBe('save'); // NOT 'longUserName' expect(result.referenceSites[0]!.kind).toBe('call'); expect(result.referenceSites[0]!.callForm).toBe('member'); expect(result.referenceSites[0]!.explicitReceiver).toEqual({ name: 'longUserName' }); }); it('parses arity from @reference.arity when present', () => { const result = extract( [ scopeMatch('module', 1, 0, 100, 0), refMatch('call.free', 'foo', 3, 0, 3, 3, { '@reference.arity': cap('@reference.arity', 3, 0, 3, 0, '2'), }), ], 'a.ts', mockProvider(), ); expect(result.referenceSites[0]!.arity).toBe(2); }); }); // ─── §End-to-end fixture ────────────────────────────────────────────────── describe('end-to-end fixture (all 5 passes together)', () => { it('produces a well-formed ParsedFile from a representative multi-pass input', () => { const matches: CaptureMatch[] = [ // Pass 1: nested scopes scopeMatch('module', 1, 0, 100, 0), scopeMatch('class', 5, 0, 50, 0), scopeMatch('function', 10, 2, 40, 2), // Pass 2: declarations declMatch('class', 'User', 5, 6, 5, 10), declMatch('method', 'save', 10, 2, 10, 6), declMatch('field', 'count', 7, 2, 7, 7), // Pass 3: import importMatch(3, 0, 3, 30), // Pass 4: type binding typeBindingMatch(10, 14, 10, 18), // Pass 5: references refMatch('call.member', 'log', 20, 4, 20, 7, { '@reference.receiver': cap('@reference.receiver', 20, 0, 20, 4, 'self'), }), refMatch('read', 'count', 25, 4, 25, 9), ]; const parsedImport: ParsedImport = { kind: 'named', localName: 'Logger', importedName: 'Logger', targetRaw: './logger', }; const parsedTypeBinding: ParsedTypeBinding = { boundName: 'name', rawTypeName: 'string', source: 'parameter-annotation', }; const result = extract( matches, 'user.ts', mockProvider({ interpretImport: () => parsedImport, interpretTypeBinding: () => parsedTypeBinding, }), ); // Three scopes, properly nested. expect(result.scopes).toHaveLength(3); const kinds = result.scopes.map((s: Scope) => s.kind); expect(kinds).toEqual(expect.arrayContaining(['Module', 'Class', 'Function'])); // Declarations landed on the correct scopes. const cls = result.scopes.find((s) => s.kind === 'Class')!; const fn = result.scopes.find((s) => s.kind === 'Function')!; expect(cls.ownedDefs.map((d) => d.qualifiedName).sort()).toEqual(['User', 'count'].sort()); expect(fn.ownedDefs.map((d) => d.qualifiedName)).toEqual(['save']); // Local bindings present. expect(cls.bindings.get('User')).toBeDefined(); expect(cls.bindings.get('count')).toBeDefined(); expect(fn.bindings.get('save')).toBeDefined(); // Import collected. expect(result.parsedImports).toEqual([parsedImport]); // Type binding attached to function scope. expect(fn.typeBindings.get('name')?.rawName).toBe('string'); // References emitted. expect(result.referenceSites).toHaveLength(2); expect(result.referenceSites.map((r) => r.kind)).toEqual(['call', 'read']); // `localDefs` is the union across scopes. expect(result.localDefs).toHaveLength(3); expect(result.localDefs.map((d) => d.type).sort()).toEqual( ['Class', 'Method', 'Property'].sort(), ); // Module scope id matches the ParsedFile header. const mod = result.scopes.find((s) => s.kind === 'Module')!; expect(result.moduleScope).toBe(mod.id); }); });