File size: 11,948 Bytes
aa89cb5
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
import { inspect } from 'node:util';
import { SelectQuery, OrderBy } from '../src/core/ast';
import { UserContext } from '../src/core/context';
import { QueryRequest } from '../src/core/request-intent';
import { PLAINTEXT_LOG_ENV, PLAINTEXT_LOG_ACK } from '../src/core/log-privacy';
import { AbstractSQLTeaQLClient, EntitySchema, SQLExecutionMetadata } from '../src/sql/core';
import { SQLiteDriver } from '../src/sql/sqlite';

const secret = 'PRIVATE-CHILD-COUNT-CANARY', credential = 'CHILD-PASSWORD-CANARY', visible = 'PUBLIC-PAGE';
const column = (columnName: string, integer = false) => ({ columnName,
  logicalType: integer ? 'integer' as const : 'text' as const,
  decode: integer ? 'number' as const : 'native' as const, logPolicy: 'plain' as const });
const schemas: Record<string, EntitySchema> = { Entry: {
  table:'entry_data', auditMaskFields:['name'], columns:{id:column('id',true), version:column('version',true),
    parentId:{...column('parent_id',true), nullable:true}, name:column('name'), marker:column('marker'), password:column('password')},
  relations:{children:{targetEntity:'Entry',localKey:'id',foreignKey:'parentId',many:true}},
} };
class Client extends AbstractSQLTeaQLClient {
  constructor(driver: SQLiteDriver) { super(driver, schemas); }
}
async function fixture() {
  const driver = new SQLiteDriver(':memory:');
  const client = new Client(driver).setDiagnosticSQLLogSink(undefined);
  await new UserContext().insertResource('dataService',client).ensureSchema();
  for(let id=1;id<=3;id++) {
    await client.executeMutation({entity:'Entry',action:'Create',id:String(id),payload:{name:'root',marker:visible},comment:'seed roots'});
    await client.executeMutation({entity:'Entry',action:'Create',id:String(id+10),payload:{parentId:id,name:secret,password:credential,marker:'child'},comment:'seed children'});
  }
  const logs:SQLExecutionMetadata[]=[];
  client.setDiagnosticSQLLogSink({write:entry=>logs.push(entry)});
  const reads=jest.spyOn(driver,'query');
  const child=new SelectQuery('Entry').filter({name:{$eq:secret}, password:{$eq:credential}}).limit(2);
  const query=new SelectQuery('Entry').filter({marker:{$eq:visible}}).relationQuery('children',child)
    .order(OrderBy.asc('id')).offset(1).limit(2).comment(`inspect ${secret} ${credential} ${visible}`).purpose(`verify ${secret} ${visible}`);
  return {driver,client,logs,reads,query,child};
}
const prior=process.env[PLAINTEXT_LOG_ENV];
beforeEach(()=>{delete process.env[PLAINTEXT_LOG_ENV];});
afterEach(()=>{if(prior===undefined)delete process.env[PLAINTEXT_LOG_ENV];else process.env[PLAINTEXT_LOG_ENV]=prior;});

test.each(['root','count','count-clone','count-failure','count-stream'])('derived intent privacy: %s',async mode=>{
  const f=await fixture();
  try {
    if(mode==='count-failure') {await f.driver.query('DROP TABLE entry_data');f.reads.mockClear();}
    let error:unknown;
    try {
      if(mode==='root') expect(await f.client.executeQuery(f.query)).toHaveLength(2);
      else if(mode==='count-clone') {
        const count=f.query.forExactCount().clone();
        f.child.filterCondition.name.$eq='changed source';
        expect((await f.client.executeQuery(count))[0].__teaql_total).toBe(3);
      } else if(mode==='count-stream') {
        const rows:any[]=[];
        for await(const chunk of f.client.executeForStream(f.query.forExactCount(),1))rows.push(...chunk);
        expect(rows[0].__teaql_total).toBe(3);
      } else expect(await f.client.executeCount(f.query)).toBe(3);
    } catch(err) {error=err;}
    if(mode==='count-failure')expect(error).toBeDefined();else expect(error).toBeUndefined();
    expect(f.logs.length).toBeGreaterThan(0);
    expect(JSON.stringify(f.logs)).not.toContain(secret);
    expect(JSON.stringify(f.logs)).not.toContain(credential);
    for(const entry of f.logs) {expect(entry.comment).toContain(visible);expect(entry.purpose).toContain(visible);}
    if(mode!=='root')expect(f.logs).toHaveLength(1);
    if(!['root','count-stream'].includes(mode))expect(f.reads).toHaveBeenCalledTimes(1);
    if(mode==='count-failure')expect(f.logs[0].executionOutcome).toBe('failure');
    else {
      await f.client.executeQuery(new SelectQuery('Entry').limit(1).comment(secret).purpose('independent query'));
      expect(f.logs[f.logs.length-1]?.comment).toBe(secret);
    }
  } finally {await f.client.close();}
});

test('count source is neither JSON nor inspect output',()=>{
  const query=new SelectQuery('Entry').relationQuery('children',new SelectQuery('Entry').filter({name:{$eq:secret}}));
  const count=query.forExactCount().clone();
  expect(JSON.stringify(count)).not.toContain(secret);
  expect(inspect(count,{depth:10,showHidden:true})).not.toContain(secret);
});

test('count debug retains business values but never credentials',async()=>{
  const f=await fixture();
  try {
    process.env[PLAINTEXT_LOG_ENV]=PLAINTEXT_LOG_ACK;
    await f.client.executeCount(f.query);
    expect(f.logs[0].comment).toContain(secret);
    expect(JSON.stringify(f.logs)).not.toContain(credential);
  } finally {await f.client.close();}
});

test('logs off still requires owned comment and purpose before SQL',async()=>{
  const f=await fixture();
  try {
    f.client.setQueryLoggingEnabled(false);
    await expect(f.client.executeCount(f.query.clone().comment(' '))).rejects.toMatchObject({code:'REQUEST_COMMENT_REQUIRED'});
    await expect(f.client.executeCount(f.query.clone().purpose(' '))).rejects.toMatchObject({code:'QUERY_PURPOSE_REQUIRED'});
    expect(f.reads).not.toHaveBeenCalled();
    expect(await f.client.executeCount(f.query)).toBe(3);
    expect(f.logs).toHaveLength(0);
  } finally {await f.client.close();}
});

test('request captures nested predicates, not only intent strings',async()=>{
  const f=await fixture();
  try {
    const request=new QueryRequest(f.query);
    f.query.filterCondition.marker.$eq='mutated after capture';
    f.child.filterCondition.name.$eq='mutated child';
    expect(await f.client.executeCount(request)).toBe(3);
    expect(await f.client.executeQuery(request)).toHaveLength(2);
    expect(JSON.stringify(f.logs)).not.toContain(secret);
  } finally {await f.client.close();}
});

test.each(['aggregate','facet'])('count retains removed %s bindings',async shape=>{
  const f=await fixture();
  try {
    f.query.relations=[];
    if(shape==='aggregate')f.query.relationAggregate('children','childCount',f.child);
    else f.query.facets=[{facetName:'children',relationName:'children',query:f.child,includeAllFacets:true}];
    const before=f.client.sqlTrace.length;
    expect(await f.client.executeCount(f.query)).toBe(3);
    expect(f.reads).toHaveBeenCalledTimes(1);
    expect(f.client.sqlTrace.length-before).toBe(1);
    expect(JSON.stringify(f.logs)).not.toContain(secret);
    expect(JSON.stringify(f.logs)).not.toContain(credential);
  } finally {await f.client.close();}
});

test.each(['cancelled','failure'])('count stream terminal keeps source: %s',async outcome=>{
  const f=await fixture();
  try {
    if(outcome==='failure')await f.driver.query('DROP TABLE entry_data');
    const iterator=f.client.executeForStream(f.query.forExactCount(),1)[Symbol.asyncIterator]();
    // Native better-sqlite3 errors can cross Jest VM realms. Verify the rejected
    // provider code/message, not instanceof the current realm's Error.
    if(outcome==='failure')await expect(iterator.next()).rejects.toMatchObject({code:'SQLITE_ERROR',message:expect.stringContaining('no such table: entry_data')});
    else {expect((await iterator.next()).done).toBe(false);await iterator.return?.();}
    expect(f.logs).toHaveLength(1);
    expect(f.logs[0].executionOutcome).toBe(outcome);
    expect(JSON.stringify(f.logs)).not.toContain(secret);
    expect(JSON.stringify(f.logs)).not.toContain(credential);
  } finally {await f.client.close();}
});

test('overlapping counts share an immutable source, never owned intent',async()=>{
  const f=await fixture();
  try {
    const source=f.query.forExactCount();
    const a=source.clone().comment('first '+secret).purpose('first purpose');
    const b=source.clone().comment('second '+secret).purpose('second purpose');
    const first=f.client.executeQuery(a),second=f.client.executeQuery(b);
    a.comment('mutated caller');b.filterCondition.marker.$eq='mutated caller';
    const rows=await Promise.all([first,second]);
    expect(rows.map(result=>result[0].__teaql_total)).toEqual([3,3]);
    expect(f.logs).toHaveLength(2);
    expect(f.logs.map(entry=>entry.purpose).sort()).toEqual(['first purpose','second purpose']);
    expect(JSON.stringify(f.logs)).not.toMatch(/PRIVATE-CHILD-COUNT-CANARY|mutated caller/);
  } finally {await f.client.close();}
});

test('stream captures nested input and intent before its first poll without opening a cursor',async()=>{
  const f=await fixture();
  const streamCall=jest.spyOn(f.driver,'stream');
  try {
    const stream=f.client.executeForStream(f.query,1);
    expect(streamCall).not.toHaveBeenCalled();expect(f.reads).not.toHaveBeenCalled();expect(f.logs).toHaveLength(0);
    f.query.comment('replaced caller comment').purpose('replaced purpose');
    f.query.filterCondition.marker.$eq='no matching root';
    f.child.filterCondition.name.$eq='no matching child';
    const rows:any[]=[];
    for await(const chunk of stream)rows.push(...chunk);
    expect(rows.map(row=>row.id)).toEqual([2,3]);
    expect(rows.map(row=>row.children.length)).toEqual([1,1]);
    expect(streamCall).toHaveBeenCalledTimes(1);
    for(const entry of f.logs){expect(entry.comment).toContain(visible);expect(entry.purpose).toContain(visible);}
    expect(JSON.stringify(f.logs)).not.toMatch(/PRIVATE-CHILD-COUNT-CANARY|CHILD-PASSWORD-CANARY|replaced caller|replaced purpose/);
  } finally {await f.client.close();}
});

test('two delayed streams from one mutable builder keep distinct captured requests',async()=>{
  const f=await fixture();
  try {
    const secondQuery=f.query.clone().comment('first '+secret).purpose('first purpose');
    const first=f.client.executeForStream(secondQuery,1);
    secondQuery.filter({id:{$eq:3}}).offset(0).comment('second '+secret).purpose('second purpose');
    const second=f.client.executeForStream(secondQuery,1);
    secondQuery.filterCondition.id.$eq=999;secondQuery.comment('changed second');
    const collect=async(stream:AsyncIterable<any[]>)=>{const rows:any[]=[];for await(const chunk of stream)rows.push(...chunk);return rows;};
    const rows=await Promise.all([collect(first),collect(second)]);
    expect(rows.map(result=>result.map(row=>row.id))).toEqual([[2,3],[3]]);
    expect(new Set(f.logs.map(entry=>entry.purpose))).toEqual(new Set(['first purpose','second purpose']));
    expect(JSON.stringify(f.logs)).not.toMatch(/PRIVATE-CHILD-COUNT-CANARY|CHILD-PASSWORD-CANARY|changed second/);
  } finally {await f.client.close();}
});

test.each(['comment','purpose'] as const)('invalid captured stream %s cannot be repaired by mutating its builder',async field=>{
  const f=await fixture();
  try {
    f.query[field](' ');
    const stream=f.client.executeForStream(f.query,1);
    const iterator=stream[Symbol.asyncIterator]();
    f.query[field]('repaired too late');
    try {await expect(iterator.next()).rejects.toMatchObject({code:field==='comment'?'REQUEST_COMMENT_REQUIRED':'QUERY_PURPOSE_REQUIRED'});}
    finally {await iterator.return?.();}
    expect(f.logs).toHaveLength(0);expect(f.reads).not.toHaveBeenCalled();
  } finally {await f.client.close();}
});

test('abandoning a never-polled stream produces no physical SQL fact',async()=>{
  const f=await fixture();
  const streamCall=jest.spyOn(f.driver,'stream');
  try {
    const iterator=f.client.executeForStream(f.query,1)[Symbol.asyncIterator]();
    await iterator.return?.();
    expect(f.logs).toHaveLength(0);expect(f.reads).not.toHaveBeenCalled();expect(streamCall).not.toHaveBeenCalled();
  } finally {await f.client.close();}
});