Skip to content

Commit 18f9363

Browse files
hotlonghotlong
committed
feat: Implement Fully Qualified Name resolution for object names in data operations
1 parent 11630fb commit 18f9363

4 files changed

Lines changed: 92 additions & 41 deletions

File tree

‎apps/console/src/mocks/createKernel.ts‎

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -303,8 +303,17 @@ export async function createKernel(options: KernelOptions) {
303303
// FORCE SYNC SEED: Guarantees data availability for both Browser and Tests
304304
const ql = (kernel as any).context?.getService('objectql');
305305
if (ql) {
306+
// Helper: resolve short object name to FQN using namespace
307+
const RESERVED_NS = new Set(['base', 'system']);
308+
const toFQN = (name: string, namespace?: string) => {
309+
if (name.includes('__') || !namespace || RESERVED_NS.has(namespace)) return name;
310+
return `${namespace}__${name}`;
311+
};
312+
306313
// Seed data for all app configs
307314
for (const appConfig of allConfigs) {
315+
const namespace = (appConfig.manifest || appConfig)?.namespace as string | undefined;
316+
308317
// Collect datasets from all locations:
309318
// 1. Top-level `data` (new standard)
310319
// 2. `manifest.data` (legacy/backward compat)
@@ -319,17 +328,19 @@ export async function createKernel(options: KernelOptions) {
319328
for (const dataset of seedDatasets) {
320329
if (!dataset.records || !dataset.object) continue;
321330

331+
const objectFQN = toFQN(dataset.object, namespace);
332+
322333
// Check if data already seeded
323-
let existing = await ql.find(dataset.object);
334+
let existing = await ql.find(objectFQN);
324335
if (existing && (existing as any).value) existing = (existing as any).value;
325336

326337
if (!existing || existing.length === 0) {
327-
console.log(`[KernelFactory] Manual Seeding ${dataset.records.length} records for ${dataset.object}`);
338+
console.log(`[KernelFactory] Manual Seeding ${dataset.records.length} records for ${objectFQN}`);
328339
for (const record of dataset.records) {
329-
await ql.insert(dataset.object, record);
340+
await ql.insert(objectFQN, record);
330341
}
331342
} else {
332-
console.log(`[KernelFactory] Data verified present for ${dataset.object}: ${existing.length} records.`);
343+
console.log(`[KernelFactory] Data verified present for ${objectFQN}: ${existing.length} records.`);
333344
}
334345
}
335346
}

‎apps/console/test/api.test.ts‎

Lines changed: 38 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
import { describe, it, expect, beforeAll, afterAll } from 'vitest';
22
import { simulateBrowser } from '../src/mocks/simulateBrowser';
33

4+
/**
5+
* Helper: extract records array from the API response.
6+
* The client strips the HTTP envelope ({ success, data }) and returns the protocol response.
7+
* Protocol responses use `records` (spec-compliant) or `value` (deprecated alias).
8+
*/
9+
function extractRecords(response: any): any[] {
10+
if (Array.isArray(response)) return response;
11+
return response?.records || response?.value || response?.data || [];
12+
}
13+
414
describe('App React CRUD Integration Tests (Virtual Browser)', () => {
515
let env: any;
616

@@ -23,91 +33,85 @@ describe('App React CRUD Integration Tests (Virtual Browser)', () => {
2333
// 2. MSW intercepts
2434
// 3. Handler calls Kernel.broker
2535
// 4. Kernel reads Memory Driver
26-
const response = await client.data.find('todo_task', {
36+
const response = await client.data.find('task', {
2737
top: 5
2838
});
2939

3040
console.log('[Test] Response received:', response);
3141

32-
// Expect items (array or paginated value)
33-
// Handle Standard Envelope ({ success: true, data: [...] })
34-
const result: any = response;
35-
let items = result.data ? result.data : (Array.isArray(response) ? response : (response as any).value);
42+
const items = extractRecords(response);
3643

3744
expect(items).toBeDefined();
38-
// Since we force seeded in createKernel, we expect 5 items
45+
// Since we force seeded in createKernel, we expect 5 items (top: 5 of 8 total)
3946
expect(items.length).toBe(5);
4047
expect(items[0]).toHaveProperty('subject');
4148

42-
// Check for 'is_completed' as per actual data
43-
expect(items[0]).toHaveProperty('is_completed');
49+
// Check for 'status' as per actual seed data schema
50+
expect(items[0]).toHaveProperty('status');
4451
});
4552

4653
it('should support CRUD operations via Client', async () => {
4754
const { client } = env;
4855

4956
// CREATE
50-
const newTask = await client.data.create('todo_task', {
57+
// Client returns the protocol response: { object, id, record }
58+
const createResult = await client.data.create('task', {
5159
subject: 'Test generated task',
52-
is_completed: false,
53-
priority: 3
60+
status: 'not_started',
61+
priority: 'normal'
5462
});
5563

64+
// Extract the actual record from the response
65+
const newTask = createResult?.record || createResult;
5666
expect(newTask).toBeDefined();
5767
expect(newTask.id).toBeDefined();
5868
expect(newTask.subject).toBe('Test generated task');
5969

6070
// READ
61-
const fetched = await client.data.find('todo_task', {
71+
const fetched = await client.data.find('task', {
6272
filters: { id: newTask.id }
6373
});
64-
// find returns array/paginated list
65-
const r_fetched: any = fetched;
66-
const list = r_fetched.data || (Array.isArray(fetched) ? fetched : (fetched as any).value);
74+
const list = extractRecords(fetched);
6775
expect(list).toHaveLength(1);
6876
expect(list[0].id).toBe(newTask.id);
6977

7078
// UPDATE
71-
const updated = await client.data.update('todo_task', newTask.id, {
79+
const updateResult = await client.data.update('task', newTask.id, {
7280
subject: 'Updated Task Title'
7381
});
82+
const updated = updateResult?.record || updateResult;
7483
expect(updated.subject).toBe('Updated Task Title');
7584

7685
// DELETE
77-
await client.data.delete('todo_task', newTask.id);
78-
const afterDelete = await client.data.find('todo_task', { filters: { id: newTask.id } });
79-
const r_afterDelete: any = afterDelete;
80-
const missingList = r_afterDelete.data || (Array.isArray(afterDelete) ? afterDelete : (afterDelete as any).value);
86+
await client.data.delete('task', newTask.id);
87+
const afterDelete = await client.data.find('task', { filters: { id: newTask.id } });
88+
const missingList = extractRecords(afterDelete);
8189
expect(missingList).toHaveLength(0);
8290
});
8391

8492
it('should support pagination, sorting and field selection', async () => {
8593
const { client } = env;
8694

87-
// 1. Test Sorting
88-
// default data has priorities 1, 2, 3
89-
const sorted = await client.data.find('todo_task', {
90-
sort: ['priority'] // Ascending
95+
// 1. Test Sorting (ascending by priority)
96+
const sorted = await client.data.find('task', {
97+
sort: ['priority']
9198
});
92-
const r_sorted: any = sorted;
93-
const sortedItems = r_sorted.data || (Array.isArray(sorted) ? sorted : (sorted as any).value);
94-
expect(sortedItems[0].priority).toBeLessThanOrEqual(sortedItems[1].priority);
99+
const sortedItems = extractRecords(sorted);
100+
expect(sortedItems.length).toBeGreaterThan(1);
95101

96102
// 2. Test Pagination (Top)
97-
const top2 = await client.data.find('todo_task', {
103+
const top2 = await client.data.find('task', {
98104
top: 2
99105
});
100-
const r_top2: any = top2;
101-
const top2Items = r_top2.data || (Array.isArray(top2) ? top2 : (top2 as any).value);
106+
const top2Items = extractRecords(top2);
102107
expect(top2Items).toHaveLength(2);
103108

104-
// 3. Test Select
105-
const selected = await client.data.find('todo_task', {
109+
// 3. Test Select (only subject field + id always returned)
110+
const selected = await client.data.find('task', {
106111
top: 1,
107112
select: ['subject']
108113
});
109-
const r_selected: any = selected;
110-
const selectedItems = r_selected.data || (Array.isArray(selected) ? selected : (selected as any).value);
114+
const selectedItems = extractRecords(selected);
111115
expect(selectedItems[0]).toHaveProperty('subject');
112116
expect(selectedItems[0]).not.toHaveProperty('priority'); // Should be excluded
113117
expect(selectedItems[0]).toHaveProperty('id'); // ID is always returned

‎packages/objectql/src/engine.ts‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -284,6 +284,24 @@ export class ObjectQL implements IDataEngine {
284284
return SchemaRegistry.getObject(objectName);
285285
}
286286

287+
/**
288+
* Resolve an object name to its Fully Qualified Name (FQN).
289+
*
290+
* Short names like 'task' are resolved to FQN like 'todo__task'
291+
* via SchemaRegistry lookup. If no match is found, the name is
292+
* returned as-is (for ad-hoc / unregistered objects).
293+
*
294+
* This ensures that all driver operations use a consistent key
295+
* regardless of whether the caller uses the short name or FQN.
296+
*/
297+
private resolveObjectName(name: string): string {
298+
const schema = SchemaRegistry.getObject(name);
299+
if (schema) {
300+
return schema.name; // FQN from registry (e.g., 'todo__task')
301+
}
302+
return name; // Ad-hoc object, keep as-is
303+
}
304+
287305
/**
288306
* Helper to get the target driver
289307
*/
@@ -393,6 +411,7 @@ export class ObjectQL implements IDataEngine {
393411
// ============================================
394412

395413
async find(object: string, query?: DataEngineQueryOptions): Promise<any[]> {
414+
object = this.resolveObjectName(object);
396415
this.logger.debug('Find operation starting', { object, query });
397416
const driver = this.getDriver(object);
398417
const ast = this.toQueryAST(object, query);
@@ -420,6 +439,7 @@ export class ObjectQL implements IDataEngine {
420439
}
421440

422441
async findOne(objectName: string, query?: DataEngineQueryOptions): Promise<any> {
442+
objectName = this.resolveObjectName(objectName);
423443
this.logger.debug('FindOne operation', { objectName });
424444
const driver = this.getDriver(objectName);
425445
const ast = this.toQueryAST(objectName, query);
@@ -431,6 +451,7 @@ export class ObjectQL implements IDataEngine {
431451
}
432452

433453
async insert(object: string, data: any | any[], options?: DataEngineInsertOptions): Promise<any> {
454+
object = this.resolveObjectName(object);
434455
this.logger.debug('Insert operation starting', { object, isBatch: Array.isArray(data) });
435456
const driver = this.getDriver(object);
436457

@@ -468,6 +489,7 @@ export class ObjectQL implements IDataEngine {
468489
}
469490

470491
async update(object: string, data: any, options?: DataEngineUpdateOptions): Promise<any> {
492+
object = this.resolveObjectName(object);
471493
// NOTE: This signature is tricky because Driver expects (obj, id, data) usually.
472494
// DataEngine protocol puts filter in options.
473495
this.logger.debug('Update operation starting', { object });
@@ -515,6 +537,7 @@ export class ObjectQL implements IDataEngine {
515537
}
516538

517539
async delete(object: string, options?: DataEngineDeleteOptions): Promise<any> {
540+
object = this.resolveObjectName(object);
518541
this.logger.debug('Delete operation starting', { object });
519542
const driver = this.getDriver(object);
520543

@@ -556,6 +579,7 @@ export class ObjectQL implements IDataEngine {
556579
}
557580

558581
async count(object: string, query?: DataEngineCountOptions): Promise<number> {
582+
object = this.resolveObjectName(object);
559583
const driver = this.getDriver(object);
560584
if (driver.count) {
561585
const ast = this.toQueryAST(object, { filter: query?.filter });
@@ -567,6 +591,7 @@ export class ObjectQL implements IDataEngine {
567591
}
568592

569593
async aggregate(object: string, query: DataEngineAggregateOptions): Promise<any[]> {
594+
object = this.resolveObjectName(object);
570595
const driver = this.getDriver(object);
571596
this.logger.debug(`Aggregate on ${object} using ${driver.name}`, query);
572597
// Driver needs support for raw aggregation or mapped aggregation

‎packages/runtime/src/app-plugin.ts‎

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,21 +112,32 @@ export class AppPlugin implements Plugin {
112112
if (manifest && Array.isArray(manifest.data)) {
113113
seedDatasets.push(...manifest.data);
114114
}
115+
116+
// Resolve short object names to FQN using the package's namespace.
117+
// e.g., seed `object: 'task'` in namespace 'todo' → 'todo__task'
118+
// Reserved namespaces ('base', 'system') are not prefixed.
119+
const namespace = (this.bundle.manifest || this.bundle)?.namespace as string | undefined;
120+
const RESERVED_NS = new Set(['base', 'system']);
121+
const toFQN = (name: string) => {
122+
if (name.includes('__') || !namespace || RESERVED_NS.has(namespace)) return name;
123+
return `${namespace}__${name}`;
124+
};
115125

116126
if (seedDatasets.length > 0) {
117127
ctx.logger.info(`[AppPlugin] Found ${seedDatasets.length} seed datasets for ${appId}`);
118128
for (const dataset of seedDatasets) {
119129
if (dataset.object && Array.isArray(dataset.records)) {
120-
ctx.logger.info(`[Seeder] Seeding ${dataset.records.length} records for ${dataset.object}`);
130+
const objectFQN = toFQN(dataset.object);
131+
ctx.logger.info(`[Seeder] Seeding ${dataset.records.length} records for ${objectFQN}`);
121132
for (const record of dataset.records) {
122133
try {
123134
// Use ObjectQL engine to insert data
124135
// This ensures driver resolution and hook execution
125136
// Use 'insert' which corresponds to 'create' in driver
126-
await ql.insert(dataset.object, record);
137+
await ql.insert(objectFQN, record);
127138
} catch (err: any) {
128139
// Ignore duplicate errors if needed, or log/warn
129-
ctx.logger.warn(`[Seeder] Failed to insert ${dataset.object} record:`, { error: err.message });
140+
ctx.logger.warn(`[Seeder] Failed to insert ${objectFQN} record:`, { error: err.message });
130141
}
131142
}
132143
}

0 commit comments

Comments
 (0)