|
| 1 | +// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license. |
| 2 | + |
| 3 | +import { describe, it, expect, vi, beforeEach } from 'vitest'; |
| 4 | +import { ObjectQL } from './engine'; |
| 5 | +import { SchemaRegistry } from './registry'; |
| 6 | + |
| 7 | +/** |
| 8 | + * #2552 — multi-value fields must reach the driver as ARRAYS. |
| 9 | + * |
| 10 | + * The write pipeline used to pass a lone scalar for a multiselect / |
| 11 | + * tags / select+multiple / lookup+multiple field straight through to the |
| 12 | + * driver (`PATCH { labels: "frontend" }` → stored verbatim as a string), |
| 13 | + * silently corrupting the column shape for every array-consumer. The |
| 14 | + * engine now normalizes unambiguous scalars into single-element arrays |
| 15 | + * BEFORE validation, and validation rejects any remaining non-array |
| 16 | + * shape with `invalid_type` instead of letting it hit storage. |
| 17 | + * |
| 18 | + * These tests assert on what the DRIVER receives — the actual corruption |
| 19 | + * point — not just on validator return values. |
| 20 | + */ |
| 21 | +vi.mock('./registry', () => { |
| 22 | + const instance: any = { |
| 23 | + getObject: vi.fn(), |
| 24 | + resolveObject: vi.fn((n: string) => instance.getObject(n)), |
| 25 | + registerObject: vi.fn(), |
| 26 | + getObjectOwner: vi.fn(), |
| 27 | + registerNamespace: vi.fn(), |
| 28 | + registerKind: vi.fn(), |
| 29 | + registerItem: vi.fn(), |
| 30 | + registerApp: vi.fn(), |
| 31 | + installPackage: vi.fn(), |
| 32 | + reset: vi.fn(), |
| 33 | + metadata: { get: vi.fn(() => new Map()) }, |
| 34 | + }; |
| 35 | + function SchemaRegistry() { |
| 36 | + return instance; |
| 37 | + } |
| 38 | + Object.assign(SchemaRegistry, instance); |
| 39 | + return { |
| 40 | + SchemaRegistry, |
| 41 | + computeFQN: (_ns: string | undefined, name: string) => name, |
| 42 | + parseFQN: (fqn: string) => ({ namespace: undefined, shortName: fqn }), |
| 43 | + RESERVED_NAMESPACES: new Set(['base', 'system']), |
| 44 | + }; |
| 45 | +}); |
| 46 | + |
| 47 | +const PROJECT_SCHEMA = { |
| 48 | + name: 'project', |
| 49 | + fields: { |
| 50 | + name: { type: 'text' }, |
| 51 | + labels: { type: 'multiselect', options: ['frontend', 'backend', 'design'] }, |
| 52 | + tags: { type: 'tags' }, |
| 53 | + channels: { type: 'select', multiple: true, options: ['email', 'sms'] }, |
| 54 | + related_docs: { type: 'lookup', multiple: true, reference_to: 'document' }, |
| 55 | + // Field.user expands to type 'user' at runtime — the showcase |
| 56 | + // team_members field ships exactly this shape (#2552 e2e regression). |
| 57 | + team_members: { type: 'user', multiple: true, reference: 'sys_user' }, |
| 58 | + status: { type: 'select', options: ['active', 'done'] }, |
| 59 | + }, |
| 60 | +}; |
| 61 | + |
| 62 | +function makeDriver() { |
| 63 | + const created: any[] = []; |
| 64 | + const updated: any[] = []; |
| 65 | + const driver: any = { |
| 66 | + name: 'memory', |
| 67 | + supports: {}, |
| 68 | + connect: vi.fn().mockResolvedValue(undefined), |
| 69 | + disconnect: vi.fn().mockResolvedValue(undefined), |
| 70 | + find: vi.fn().mockResolvedValue([]), |
| 71 | + findOne: vi.fn().mockResolvedValue({ id: 'r1' }), |
| 72 | + create: vi.fn(async (_obj: string, row: any) => { |
| 73 | + created.push(row); |
| 74 | + return { id: 'r1', ...row }; |
| 75 | + }), |
| 76 | + update: vi.fn(async (_obj: string, id: string, row: any) => { |
| 77 | + updated.push(row); |
| 78 | + return { id, ...row }; |
| 79 | + }), |
| 80 | + delete: vi.fn(), |
| 81 | + }; |
| 82 | + return { driver, created, updated }; |
| 83 | +} |
| 84 | + |
| 85 | +async function makeEngine(driver: any) { |
| 86 | + vi.mocked((SchemaRegistry as any).getObject).mockImplementation((name: string) => |
| 87 | + name === 'project' ? PROJECT_SCHEMA : undefined, |
| 88 | + ); |
| 89 | + const ql = new ObjectQL(); |
| 90 | + ql.registerDriver(driver, true); |
| 91 | + await ql.init(); |
| 92 | + return ql; |
| 93 | +} |
| 94 | + |
| 95 | +describe('engine write pipeline — multi-value scalar normalization (#2552)', () => { |
| 96 | + beforeEach(() => { |
| 97 | + vi.clearAllMocks(); |
| 98 | + }); |
| 99 | + |
| 100 | + it('insert: wraps scalars so the driver receives arrays', async () => { |
| 101 | + const { driver, created } = makeDriver(); |
| 102 | + const ql = await makeEngine(driver); |
| 103 | + await ql.insert('project', { |
| 104 | + name: 'P1', |
| 105 | + labels: 'frontend', |
| 106 | + tags: 'urgent', |
| 107 | + channels: 'email', |
| 108 | + related_docs: 'doc-1', |
| 109 | + team_members: 'user-1', |
| 110 | + }); |
| 111 | + expect(created).toHaveLength(1); |
| 112 | + expect(created[0]).toMatchObject({ |
| 113 | + labels: ['frontend'], |
| 114 | + tags: ['urgent'], |
| 115 | + channels: ['email'], |
| 116 | + related_docs: ['doc-1'], |
| 117 | + team_members: ['user-1'], |
| 118 | + }); |
| 119 | + }); |
| 120 | + |
| 121 | + it('update: wraps scalars so the driver receives arrays', async () => { |
| 122 | + const { driver, updated } = makeDriver(); |
| 123 | + const ql = await makeEngine(driver); |
| 124 | + await ql.update('project', { id: 'r1', labels: 'design', team_members: 'user-2' }); |
| 125 | + expect(updated).toHaveLength(1); |
| 126 | + expect(updated[0]).toMatchObject({ labels: ['design'], team_members: ['user-2'] }); |
| 127 | + }); |
| 128 | + |
| 129 | + it('update: legal arrays pass through untouched (select+multiple was mis-rejected before)', async () => { |
| 130 | + const { driver, updated } = makeDriver(); |
| 131 | + const ql = await makeEngine(driver); |
| 132 | + await ql.update('project', { |
| 133 | + id: 'r1', |
| 134 | + labels: ['frontend', 'design'], |
| 135 | + channels: ['email', 'sms'], |
| 136 | + related_docs: ['d1', 'd2'], |
| 137 | + team_members: ['u1', 'u2'], |
| 138 | + }); |
| 139 | + expect(updated[0]).toMatchObject({ |
| 140 | + labels: ['frontend', 'design'], |
| 141 | + channels: ['email', 'sms'], |
| 142 | + related_docs: ['d1', 'd2'], |
| 143 | + team_members: ['u1', 'u2'], |
| 144 | + }); |
| 145 | + }); |
| 146 | + |
| 147 | + it('update: un-wrappable junk is rejected BEFORE reaching the driver', async () => { |
| 148 | + const { driver, updated } = makeDriver(); |
| 149 | + const ql = await makeEngine(driver); |
| 150 | + await expect( |
| 151 | + ql.update('project', { id: 'r1', labels: { nested: true } }), |
| 152 | + ).rejects.toThrow(/invalid_type/i); |
| 153 | + expect(updated).toHaveLength(0); |
| 154 | + }); |
| 155 | + |
| 156 | + it('insert: invalid option inside a wrapped scalar still 400s', async () => { |
| 157 | + const { driver, created } = makeDriver(); |
| 158 | + const ql = await makeEngine(driver); |
| 159 | + await expect(ql.insert('project', { name: 'P2', labels: 'nope' })).rejects.toThrow( |
| 160 | + /invalid_option/i, |
| 161 | + ); |
| 162 | + expect(created).toHaveLength(0); |
| 163 | + }); |
| 164 | + |
| 165 | + it('single-value fields are untouched', async () => { |
| 166 | + const { driver, created } = makeDriver(); |
| 167 | + const ql = await makeEngine(driver); |
| 168 | + await ql.insert('project', { name: 'P3', status: 'active' }); |
| 169 | + expect(created[0].status).toBe('active'); |
| 170 | + }); |
| 171 | +}); |
0 commit comments