@memberjunction/server 6.1.0-edge.5 → 6.1.0-edge.7

package/src/__tests__/resolverBase.fls.test.ts

@@ -0,0 +1,483 @@
+/**
+ * Tests for ResolverBase.StripDeniedReadFieldsFromClientInput — the field-level-security
+ * guard on the update path.
+ *
+ * The hazard it closes: a read-denied field is stripped from every payload the client
+ * receives, so the client's Save fabricates a value for it (default / 0 / '' / null) and sends
+ * it back. Without the guard, UpdateRecord's SetMany applies the fabrication — silent data
+ * loss when the user holds update access, and a spurious save failure on UNRELATED edits when
+ * they don't. The guard strips denied-read keys from the client's new values and OldValues
+ * before anything applies them, and its `true` return forces the caller onto the
+ * load-truth-from-DB branch so denied fields hold real values a stripped SetMany never
+ * touches.
+ */
+import { describe, it, expect, vi, beforeEach } from 'vitest';
+
+// ─── Hoisted mocks ────────────────────────────────────────────────────────
+const { mockUserCacheUsers } = vi.hoisted(() => ({
+    mockUserCacheUsers: [] as Array<{ Email: string; ID: string }>,
+}));
+
+// Stub external deps before imports
+vi.mock('@memberjunction/sqlserver-dataprovider', () => ({
+    SQLServerDataProvider: class {},
+}));
+
+// UserCache moved to the shared provider package, so the mock has to follow it — mocking it on
+// sqlserver-dataprovider silently no-ops and the real (empty) cache answers instead.
+vi.mock('@memberjunction/generic-database-provider', () => ({
+    UserCache: {
+        get Users() { return mockUserCacheUsers; },
+    },
+}));
+
+vi.mock('cloudevents', () => ({
+    CloudEvent: class {},
+    httpTransport: () => () => undefined,
+    emitterFor: () => () => undefined,
+}));
+
+vi.mock('type-graphql', () => ({
+    Resolver:           () => () => undefined,
+    Mutation:           () => () => undefined,
+    Query:              () => () => undefined,
+    Subscription:       () => () => undefined,
+    Ctx:                () => () => undefined,
+    Arg:                () => () => undefined,
+    PubSub:             () => () => undefined,
+    Root:               () => () => undefined,
+    ObjectType:         () => () => undefined,
+    InputType:          () => () => undefined,
+    Field:              () => () => undefined,
+    FieldResolver:      () => () => undefined,
+    Int:                () => undefined,
+    Float:              () => undefined,
+    registerEnumType:   () => undefined,
+}));
+
+vi.mock('graphql', () => ({
+    GraphQLError: class extends Error {
+        constructor(msg: string) { super(msg); }
+    },
+}));
+
+vi.mock('mssql', () => ({}));
+
+vi.mock('@memberjunction/api-keys', () => ({
+    GetAPIKeyEngine: vi.fn(),
+}));
+
+vi.mock('@memberjunction/encryption', () => ({
+    EncryptionEngine: { Instance: {} },
+}));
+
+vi.mock('@memberjunction/graphql-dataprovider', () => ({
+    FieldMapper: class { static Instance = { MapFieldsFromCodeNamesToDBNames: vi.fn() }; },
+}));
+
+vi.mock('../generic/PubSubManager.js', () => ({
+    PubSubManager: class { static Instance = { publish: vi.fn() }; },
+}));
+
+vi.mock('../generic/PushStatusResolver.js', () => ({
+    PUSH_STATUS_UPDATES_TOPIC: 'test-push-topic',
+    PushStatusNotification: class {},
+    PushStatusResolver: class {},
+}));
+
+vi.mock('../generic/CacheInvalidationResolver.js', () => ({
+    CACHE_INVALIDATION_TOPIC: 'test-cache-topic',
+}));
+
+vi.mock('../generic/RunViewResolver.js', () => ({
+    RunViewByIDInput: class {},
+    RunViewByNameInput: class {},
+    RunDynamicViewInput: class {},
+}));
+
+vi.mock('../generic/DeleteOptionsInput.js', () => ({
+    DeleteOptionsInput: class {},
+}));
+
+vi.mock('../types.js', () => ({
+    RunViewGenericParams: class {},
+}));
+
+vi.mock('@memberjunction/core', async () => {
+    const actual = await vi.importActual<typeof import('@memberjunction/core')>('@memberjunction/core');
+    return {
+        ...actual,
+        LogError: vi.fn(),
+        LogStatus: vi.fn(),
+    };
+});
+
+vi.mock('@memberjunction/core-entities', () => ({}));
+
+// ─── Import after mocks ──────────────────────────────────────────────────
+import { ResolverBase } from '../generic/ResolverBase';
+import { EntityInfo, UserInfo, UserRoleInfo } from '@memberjunction/core';
+
+// ─── Metadata builders (mirrors MJCore's fieldSecurity.enforcement tests) ──
+
+const HR_ROLE_ID = 'A0000000-0000-0000-0000-000000000001';
+const INTERN_ROLE_ID = 'A0000000-0000-0000-0000-000000000003';
+const ENTITY_ID = 'entity-employees';
+
+/**
+ * An `Employees` entity: `Salary` and `Base Salary` are readable/updatable only by HR.
+ * `Base Salary` has a space, so its CodeName (`Base_Salary`) differs from its Name —
+ * exercising the Name→CodeName bridge (input keys are CodeNames).
+ */
+/**
+ * Full access to `fieldId` for every listed role. Snapshot initialization writes rows like these
+ * for every (field, role) that should have one — which is why the UNRESTRICTED fields below need
+ * them explicitly. On an FLS-enabled entity a field with no rows is denied, not open.
+ */
+function openTo(fieldId: string, roles: string[] = [HR_ROLE_ID, INTERN_ROLE_ID]): Record<string, unknown>[] {
+    return roles.map((roleId, i) => ({
+        ID: `${fieldId}-open-${i}`,
+        EntityFieldID: fieldId,
+        RoleID: roleId,
+        ReadAccess: 'Allow',
+        UpdateAccess: 'Allow',
+        CreateAccess: 'Allow',
+    }));
+}
+
+function employeeEntityInit(withFls: boolean): Record<string, unknown> {
+    return {
+        ID: ENTITY_ID,
+        Name: 'Employees',
+        SchemaName: 'dbo',
+        BaseTable: 'Employee',
+        BaseView: 'vwEmployees',
+        IncludeInAPI: true,
+        AllowCreateAPI: true,
+        AllowUpdateAPI: true,
+        AllowDeleteAPI: true,
+        // The flag is the enforcement gate — `withFls: false` switches field security off
+        // entirely rather than merely removing rows.
+        EnableFieldLevelSecurity: withFls,
+        Permissions: [
+            { EntityID: ENTITY_ID, RoleID: HR_ROLE_ID, CanCreate: true, CanRead: true, CanUpdate: true, CanDelete: true },
+            { EntityID: ENTITY_ID, RoleID: INTERN_ROLE_ID, CanCreate: true, CanRead: true, CanUpdate: true, CanDelete: true },
+        ],
+        Fields: [
+            { ID: 'f-id', EntityID: ENTITY_ID, Sequence: 1, Name: 'ID', Entity: 'Employees', Type: 'uniqueidentifier', IsPrimaryKey: true },
+            { ID: 'f-name', EntityID: ENTITY_ID, Sequence: 2, Name: 'Name', Entity: 'Employees', Type: 'nvarchar', EntityFieldPermissions: openTo('f-name') },
+            { ID: 'f-salary', EntityID: ENTITY_ID, Sequence: 3, Name: 'Salary', Entity: 'Employees', Type: 'money', EntityFieldPermissions: openTo('f-salary', [HR_ROLE_ID]) },
+            { ID: 'f-base-salary', EntityID: ENTITY_ID, Sequence: 4, Name: 'Base Salary', Entity: 'Employees', Type: 'money', EntityFieldPermissions: openTo('f-base-salary', [HR_ROLE_ID]) },
+            { ID: 'f-notes', EntityID: ENTITY_ID, Sequence: 5, Name: 'Notes', Entity: 'Employees', Type: 'nvarchar', EntityFieldPermissions: openTo('f-notes') },
+        ],
+    };
+}
+
+function buildUser(roleIds: string[], id = 'user-1'): UserInfo {
+    const u = new UserInfo();
+    u.ID = id;
+    u.Name = 'Test User';
+    u.Email = `${id}@test.com`;
+    u.IsActive = true;
+    (u as unknown as Record<string, unknown>)['_UserRoles'] =
+        roleIds.map(rid => new UserRoleInfo({ UserID: id, RoleID: rid, Role: `Role-${rid}` }));
+    return u;
+}
+
+type ClientInput = { OldValues___?: Array<{ Key: string; Value: unknown }> } & Record<string, unknown>;
+
+/** Subclass that exposes the protected guards for testing. */
+class TestResolver extends ResolverBase {
+    public TestStrip(entityInfo: EntityInfo, userInfo: UserInfo, input: ClientInput, clientNewValues: Record<string, unknown>): boolean {
+        return this.StripDeniedReadFieldsFromClientInput(entityInfo, userInfo, input, clientNewValues);
+    }
+
+    public TestMustLoadTruth(entityInfo: EntityInfo, input: ClientInput, hasDeniedReadFields: boolean, hasNarrowedAuditPayload: boolean): boolean {
+        return this.MustLoadTruthFromDatabase(entityInfo, input, hasDeniedReadFields, hasNarrowedAuditPayload);
+    }
+}
+
+/** Builds the (input, clientNewValues) pair the way UpdateRecord does. */
+function makeClientPayload(fields: Record<string, unknown>, oldValues?: Array<{ Key: string; Value: unknown }>): { input: ClientInput; clientNewValues: Record<string, unknown> } {
+    const input: ClientInput = { ...fields };
+    if (oldValues) {
+        input.OldValues___ = oldValues;
+    }
+    const clientNewValues: Record<string, unknown> = { ...fields };
+    return { input, clientNewValues };
+}
+
+// ─── Tests ────────────────────────────────────────────────────────────────
+
+describe('ResolverBase.StripDeniedReadFieldsFromClientInput', () => {
+    let resolver: TestResolver;
+    let flsEntity: EntityInfo;
+    let noFlsEntity: EntityInfo;
+
+    beforeEach(() => {
+        resolver = new TestResolver();
+        flsEntity = new EntityInfo(employeeEntityInit(true));
+        noFlsEntity = new EntityInfo(employeeEntityInit(false));
+    });
+
+    it('strips a denied-read field from clientNewValues AND input, and returns true', () => {
+        const { input, clientNewValues } = makeClientPayload({ ID: '1', Notes: 'edited', Salary: 0 });
+        const result = resolver.TestStrip(flsEntity, buildUser([INTERN_ROLE_ID]), input, clientNewValues);
+
+        expect(result).toBe(true);
+        expect(clientNewValues).not.toHaveProperty('Salary');
+        expect(input).not.toHaveProperty('Salary');
+        expect(clientNewValues).toEqual({ ID: '1', Notes: 'edited' });
+    });
+
+    it('removes denied-field entries from OldValues___ (fabricated old values must not drive conflict detection)', () => {
+        const { input, clientNewValues } = makeClientPayload(
+            { ID: '1', Notes: 'edited', Salary: 0 },
+            [{ Key: 'ID', Value: '1' }, { Key: 'Notes', Value: 'orig' }, { Key: 'Salary', Value: '0' }]
+        );
+        resolver.TestStrip(flsEntity, buildUser([INTERN_ROLE_ID]), input, clientNewValues);
+
+        expect(input.OldValues___).toEqual([{ Key: 'ID', Value: '1' }, { Key: 'Notes', Value: 'orig' }]);
+    });
+
+    it('bridges Name → CodeName: a denied field with a space is stripped by its CodeName key', () => {
+        // 'Base Salary' arrives from the wire as its CodeName 'Base_Salary'
+        const { input, clientNewValues } = makeClientPayload(
+            { ID: '1', Notes: 'edited', Base_Salary: 100 },
+            [{ Key: 'Base_Salary', Value: '100' }]
+        );
+        const result = resolver.TestStrip(flsEntity, buildUser([INTERN_ROLE_ID]), input, clientNewValues);
+
+        expect(result).toBe(true);
+        expect(clientNewValues).not.toHaveProperty('Base_Salary');
+        expect(input.OldValues___).toEqual([]);
+    });
+
+    it('leaves permitted fields and metadata blobs untouched', () => {
+        const restore = { marker: true };
+        const { input, clientNewValues } = makeClientPayload({ ID: '1', Name: 'Ada', Notes: 'n', Salary: 5 });
+        (input as Record<string, unknown>)['RestoreContext___'] = restore;
+        resolver.TestStrip(flsEntity, buildUser([INTERN_ROLE_ID]), input, clientNewValues);
+
+        expect(clientNewValues).toEqual({ ID: '1', Name: 'Ada', Notes: 'n' });
+        expect(input['RestoreContext___']).toBe(restore);
+        expect(input['Name']).toBe('Ada');
+    });
+
+    it('returns true even when the client sent nothing for the denied field — the truth-load must still be forced', () => {
+        const { input, clientNewValues } = makeClientPayload({ ID: '1', Notes: 'edited' });
+        const result = resolver.TestStrip(flsEntity, buildUser([INTERN_ROLE_ID]), input, clientNewValues);
+
+        expect(result).toBe(true);
+        expect(clientNewValues).toEqual({ ID: '1', Notes: 'edited' });
+    });
+
+    it('is a no-op returning false when the entity has no field security', () => {
+        const { input, clientNewValues } = makeClientPayload({ ID: '1', Salary: 12345 });
+        const result = resolver.TestStrip(noFlsEntity, buildUser([INTERN_ROLE_ID]), input, clientNewValues);
+
+        expect(result).toBe(false);
+        expect(clientNewValues['Salary']).toBe(12345);
+        expect(input['Salary']).toBe(12345);
+    });
+
+    it('is a no-op returning false for a user who HOLDS the granting role', () => {
+        const { input, clientNewValues } = makeClientPayload(
+            { ID: '1', Salary: 99000 },
+            [{ Key: 'Salary', Value: '85000' }]
+        );
+        const result = resolver.TestStrip(flsEntity, buildUser([HR_ROLE_ID]), input, clientNewValues);
+
+        expect(result).toBe(false);
+        expect(clientNewValues['Salary']).toBe(99000);
+        expect(input.OldValues___).toHaveLength(1);
+    });
+
+    it('is a no-op returning false without a user', () => {
+        const { input, clientNewValues } = makeClientPayload({ ID: '1', Salary: 1 });
+        const result = resolver.TestStrip(flsEntity, undefined as unknown as UserInfo, input, clientNewValues);
+
+        expect(result).toBe(false);
+        expect(clientNewValues['Salary']).toBe(1);
+    });
+
+    it('matches input keys case-insensitively (wire casing must not defeat the strip)', () => {
+        const { input, clientNewValues } = makeClientPayload({ ID: '1', SALARY: 0 });
+        const result = resolver.TestStrip(flsEntity, buildUser([INTERN_ROLE_ID]), input, clientNewValues);
+
+        expect(result).toBe(true);
+        expect(clientNewValues).not.toHaveProperty('SALARY');
+    });
+});
+
+// ─── A write-only field is a FORBIDDEN configuration ──────────────────────
+//
+// Read is required for Update, enforced by a row-level CHECK constraint AND by the clamp in
+// EntityFieldInfo.GetUserFieldPermissions that catches the across-roles case the constraint
+// cannot see. These tests write the forbidden rows DIRECTLY into metadata, bypassing the
+// constraint, and assert the runtime still refuses to produce a write-only outcome.
+
+describe('write-only fields are unreachable, so every denied-read field is stripped', () => {
+    const resolver = new TestResolver();
+
+    /**
+     * Salary with the forbidden shape written straight into metadata: the intern is denied READ
+     * but granted UPDATE. A CHECK constraint would refuse this row; reaching it here means it
+     * was written outside the entity path.
+     */
+    function forbiddenWriteOnlyEntity(): EntityInfo {
+        const init = employeeEntityInit(true);
+        const fields = init['Fields'] as Array<Record<string, unknown>>;
+        const salary = fields.find(f => f['Name'] === 'Salary')!;
+        salary['EntityFieldPermissions'] = [
+            ...openTo('f-salary', [HR_ROLE_ID]),
+            { ID: 'p2', EntityFieldID: 'f-salary', RoleID: INTERN_ROLE_ID, ReadAccess: 'No Access', UpdateAccess: 'Allow', CreateAccess: 'No Access' },
+        ];
+        return new EntityInfo(init);
+    }
+
+    it('the aggregation clamps the forbidden row — update does not survive a denied read', () => {
+        const entity = forbiddenWriteOnlyEntity();
+        const intern = buildUser([INTERN_ROLE_ID]);
+
+        expect(entity.GetDeniedReadFields(intern).has('salary')).toBe(true);
+        expect(entity.GetDeniedUpdateFields(intern).has('salary')).toBe(true);
+    });
+
+    it('strips the value anyway — a client cannot have a legitimate value for a field it never saw', () => {
+        const entity = forbiddenWriteOnlyEntity();
+        const { input, clientNewValues } = makeClientPayload({ ID: '1', Salary: 123456 });
+        const result = resolver.TestStrip(entity, buildUser([INTERN_ROLE_ID]), input, clientNewValues);
+
+        expect(result).toBe(true); // truth-load still forced — the denied-read set is non-empty
+        expect(clientNewValues).not.toHaveProperty('Salary');
+        expect(input).not.toHaveProperty('Salary');
+    });
+
+    it('removes the OldValues entry too (the client cannot know a true old value)', () => {
+        const entity = forbiddenWriteOnlyEntity();
+        const { input, clientNewValues } = makeClientPayload(
+            { ID: '1', Salary: 123456 },
+            [{ Key: 'ID', Value: '1' }, { Key: 'Salary', Value: '99' }]
+        );
+        resolver.TestStrip(entity, buildUser([INTERN_ROLE_ID]), input, clientNewValues);
+
+        expect(input.OldValues___).toEqual([{ Key: 'ID', Value: '1' }]);
+        expect(clientNewValues).not.toHaveProperty('Salary');
+    });
+
+    it('strips EVERY denied-read field, with no update-permission split', () => {
+        // Base Salary is denied read AND update; Salary carries the forbidden write-only row.
+        // Both are stripped, because denied-read ∩ denied-update is now just denied-read.
+        const entity = forbiddenWriteOnlyEntity();
+        const { input, clientNewValues } = makeClientPayload({ ID: '1', Salary: 123456, Base_Salary: 7 });
+        resolver.TestStrip(entity, buildUser([INTERN_ROLE_ID]), input, clientNewValues);
+
+        expect(clientNewValues).not.toHaveProperty('Salary');
+        expect(clientNewValues).not.toHaveProperty('Base_Salary');
+    });
+});
+
+/**
+ * Tests for ResolverBase.MustLoadTruthFromDatabase — the hydration-source decision.
+ *
+ * `UpdateRecord` may hydrate the entity from the client's `OldValues___` instead of loading the
+ * row, as an optimization for the case where nothing needs true prior state. This predicate decides
+ * when that shortcut is unsafe.
+ *
+ * The security case, and the reason `EnableFieldLevelSecurity` is in the condition at all: the
+ * canonical FLS configuration is Read Allow + Update Deny, which leaves `hasDeniedReadFields`
+ * FALSE. Before this predicate consulted the entity flag, such a caller took the shortcut and was
+ * hydrated from its own `OldValues___`. A value supplied there arrives via `LoadFromData`, which
+ * the EntityField setter records as the field's initial value — so it is not dirty,
+ * `CheckFieldLevelUpdatePermissions` (which rejects only `field.Dirty && denied`) never sees it,
+ * and `GenerateSaveSQL` sends it anyway because it filters on `NotLoaded`, never on `Dirty`.
+ * Pinning a value in `OldValues___` was a write to a field the caller may not write.
+ */
+describe('ResolverBase.MustLoadTruthFromDatabase', () => {
+    let resolver: TestResolver;
+
+    beforeEach(() => {
+        resolver = new TestResolver();
+    });
+
+    /**
+     * `Employees` where the Intern role may READ every field — including Salary — but may not
+     * UPDATE Salary. "You can see the salaries, you just cannot change them."
+     *
+     * Every field must be readable, not just Salary. `StripDeniedReadFieldsFromClientInput`
+     * returns `true` whenever the caller's denied-READ set is non-empty AT ALL, regardless of what
+     * the payload contained, so a single unrelated read denial anywhere on the entity would force
+     * the truth-load by itself and mask the gap. A caller with no read denials is the one whose
+     * hydration source was decided purely by the terms this test is about.
+     */
+    function readAllowUpdateDenyEntity(withFls: boolean): EntityInfo {
+        const init = employeeEntityInit(withFls);
+        init['TrackRecordChanges'] = false; // the shortcut is only reachable with tracking off
+        const fields = init['Fields'] as Array<Record<string, unknown>>;
+        for (const f of fields) {
+            if (f['ID'] === 'f-id') continue; // primary key — never restrictable
+            f['EntityFieldPermissions'] = openTo(f['ID'] as string);
+        }
+        const salary = fields.find((f) => f['ID'] === 'f-salary')!;
+        salary['EntityFieldPermissions'] = [
+            ...openTo('f-salary', [HR_ROLE_ID]),
+            { ID: 'f-salary-intern', EntityFieldID: 'f-salary', RoleID: INTERN_ROLE_ID, ReadAccess: 'Allow', UpdateAccess: 'Deny', CreateAccess: 'Deny' },
+        ];
+        return new EntityInfo(init);
+    }
+
+    const withOldValues = (): ClientInput => ({
+        ID: '1',
+        Notes: 'edited',
+        OldValues___: [
+            { Key: 'ID', Value: '1' },
+            { Key: 'Notes', Value: 'original' },
+            { Key: 'Salary', Value: '999999' }, // the pinned value — never in the mutation input
+        ],
+    });
+
+    it('the fixture really is Read Allow + Update Deny, with an EMPTY denied-READ set', () => {
+        const entity = readAllowUpdateDenyEntity(true);
+        const intern = buildUser([INTERN_ROLE_ID]);
+
+        // This is what makes the bypass reachable: nothing to strip, so hasDeniedReadFields is false.
+        expect(entity.GetDeniedReadFields(intern).size).toBe(0);
+        expect(entity.GetDeniedUpdateFields(intern).has('salary')).toBe(true);
+    });
+
+    it('REGRESSION: forces the truth-load on an FLS entity even when no field is denied READ', () => {
+        const entity = readAllowUpdateDenyEntity(true);
+        const intern = buildUser([INTERN_ROLE_ID]);
+        const input = withOldValues();
+
+        // Exactly what UpdateRecord computes: the strip finds nothing to remove, so it returns false.
+        const hasDeniedReadFields = resolver.TestStrip(entity, intern, input, { ID: '1', Notes: 'edited' });
+        expect(hasDeniedReadFields).toBe(false);
+        expect(input.OldValues___).toContainEqual({ Key: 'Salary', Value: '999999' }); // survives the strip
+
+        // Before the fix every other term was false here and the client's OldValues won.
+        expect(resolver.TestMustLoadTruth(entity, input, hasDeniedReadFields, false)).toBe(true);
+    });
+
+    it('keeps the OldValues shortcut when field-level security is OFF (no cost to the ~99%)', () => {
+        const entity = readAllowUpdateDenyEntity(false);
+        expect(resolver.TestMustLoadTruth(entity, withOldValues(), false, false)).toBe(false);
+    });
+
+    it('still forces the truth-load for each pre-existing reason, independently', () => {
+        const flsOff = readAllowUpdateDenyEntity(false);
+
+        // No OldValues to hydrate from.
+        expect(resolver.TestMustLoadTruth(flsOff, { ID: '1' }, false, false)).toBe(true);
+        // A denied READ field was stripped.
+        expect(resolver.TestMustLoadTruth(flsOff, withOldValues(), true, false)).toBe(true);
+        // The audit payload was narrowed.
+        expect(resolver.TestMustLoadTruth(flsOff, withOldValues(), false, true)).toBe(true);
+
+        // The entity tracks record changes.
+        const tracked = employeeEntityInit(false);
+        tracked['TrackRecordChanges'] = true;
+        expect(resolver.TestMustLoadTruth(new EntityInfo(tracked), withOldValues(), false, false)).toBe(true);
+    });
+});