@autofleet/zehut 3.1.2-beta.8 → 3.1.2

package/lib/user/ApiUser.js

@@ -10,10 +10,30 @@ const object_hash_1 = __importDefault(require("object-hash"));
 const uuid_1 = require("uuid");
 const outbreak_1 = require("@autofleet/outbreak");
 const services_1 = require("../services");
-const utils_1 = require("../utils");
 exports.ELEVATED_PERMISSIONS_HEADER = 'x-af-elevated-permissions';
 exports.CONTEXTS_IDS_HEADER = 'x-af-context-ids';
 const userCache = new node_cache_1.default({ stdTTL: 10 });
+const mergePermissions = (target, sources) => {
+    const permissions = {
+        ...(target || {}),
+        fleets: { ...target?.fleets },
+        businessModels: { ...target?.businessModels },
+        demandSources: { ...target?.demandSources },
+        // Clone other nested objects as needed
+    };
+    // eslint-disable-next-line no-restricted-syntax
+    for (const source of sources) {
+        Object.keys(source).forEach((entityType) => {
+            // eslint-disable-next-line no-param-reassign
+            permissions[entityType] ?? (permissions[entityType] = {});
+            Object.entries(source[entityType]).forEach(([entityId, perms]) => {
+                // eslint-disable-next-line no-param-reassign
+                permissions[entityType][entityId] = (permissions[entityType][entityId] || []).concat(perms);
+            });
+        });
+    }
+    return permissions;
+};
 class ApiUser {
     constructor(id, accountType, elevatedPermissions, contextIds) {
         this.id = id;
@@ -82,22 +102,13 @@ class ApiUser {
         return Object.keys(this.privatePermissions[key] || {});
     }
     get elevatedPermissions() {
-        let permissions = {
-            fleets: {},
-            businessModels: {},
-            demandSources: {},
-        };
-        [...this.privateElevatedPermissionsHash.values()].forEach((p) => {
-            permissions = (0, utils_1.mergeDeep)(permissions, p);
-        });
-        return permissions;
+        return mergePermissions(undefined, this.privateElevatedPermissionsHash.values());
     }
     get permissions() {
         if (!this.privatePermissions) {
             throw new Error('Cannot get permissions without calling (async) getUserPermissions before');
         }
-        const permissions = (0, utils_1.mergeDeep)(this.privatePermissions, this.elevatedPermissions);
-        return permissions;
+        return mergePermissions(this.privatePermissions, this.privateElevatedPermissionsHash.values());
     }
     elevatePermissions(addedPermissions) {
         const elevationId = (0, uuid_1.v4)();

package/lib/user/api-user-flows.test.js

@@ -8,6 +8,20 @@ const express_1 = __importDefault(require("express"));
 const axios_1 = __importDefault(require("axios"));
 const index_1 = require("../index");
 const index_2 = require("./index");
+const services_1 = require("../services");
+jest.spyOn(services_1.IdentityNetwork, 'get').mockImplementation(async (url) => {
+    if (url.includes('/api/v1/users/')) {
+        return {
+            data: {
+                accountType: 'user',
+                fleets: {},
+                businessModels: {},
+                demandSources: {},
+            },
+        };
+    }
+    return { data: {} };
+});
 const generateApp = async (addEndpoints, port) => {
     const app = (0, express_1.default)();
     addEndpoints(app);
@@ -122,4 +136,167 @@ describe('E2E', () => {
         closeServer1();
         expect(error.message).toEqual('Entity id on elevatePermissions is not a valid UUID, provided: nnn');
     });
+    it('should correctly handle elevation of permissions and their reversion', async () => {
+        let capturedError = null;
+        // Snapshots to capture state after each step
+        let afterFirstElevationElevated = {
+            fleets: {},
+            businessModels: {},
+            demandSources: {},
+        };
+        let afterFirstElevationCombined = {
+            fleets: {},
+            businessModels: {},
+            demandSources: {},
+        };
+        let afterSecondElevationElevated = {
+            fleets: {},
+            businessModels: {},
+            demandSources: {},
+        };
+        let afterSecondElevationCombined = {
+            fleets: {},
+            businessModels: {},
+            demandSources: {},
+        };
+        let afterCloseSecondElevated = {
+            fleets: {},
+            businessModels: {},
+            demandSources: {},
+        };
+        let afterCloseSecondCombined = {
+            fleets: {},
+            businessModels: {},
+            demandSources: {},
+        };
+        let afterCloseFirstElevated = {
+            fleets: {},
+            businessModels: {},
+            demandSources: {},
+        };
+        let afterCloseFirstCombined = {
+            fleets: {},
+            businessModels: {},
+            demandSources: {},
+        };
+        (0, index_1.enableTracing)({
+            outbreakOptions: {
+                headersPrefix: 'x-af-',
+            },
+        });
+        const userId = (0, uuid_1.v4)();
+        // Generate UUIDs for test entities
+        const fleetUUID1 = (0, uuid_1.v4)();
+        const fleetUUID2 = (0, uuid_1.v4)();
+        const bmUUID1 = (0, uuid_1.v4)();
+        const dsUUID1 = (0, uuid_1.v4)();
+        const dsUUID2 = (0, uuid_1.v4)();
+        // Spin up a test server
+        const closeServer = await generateApp((app) => {
+            app.use((0, index_2.middleware)());
+            app.get('/', async (req, res) => {
+                try {
+                    const user = (0, index_1.getUser)();
+                    // Load base permissions (mocked)
+                    await user.getUserPermissions();
+                    // Now user.privatePermissions is set
+                    // 1. First Elevation
+                    const closeElevation1 = user.elevatePermissions({
+                        fleets: {
+                            [fleetUUID1]: ['readF1'],
+                        },
+                        businessModels: {
+                            [bmUUID1]: ['writeBM1'],
+                        },
+                        demandSources: {
+                            [dsUUID1]: ['readDS1'],
+                        },
+                    });
+                    // Capture elevated and combined permissions after first elevation
+                    afterFirstElevationElevated = user.elevatedPermissions;
+                    afterFirstElevationCombined = user.permissions; // Non-null assertion since privatePermissions is set
+                    // 2. Second Elevation
+                    const closeElevation2 = user.elevatePermissions({
+                        fleets: {
+                            [fleetUUID1]: ['manageF1'],
+                            [fleetUUID2]: ['createF2'], // New fleet
+                        },
+                        businessModels: {
+                            [bmUUID1]: ['writeBM2'], // Additional permission to existing business model
+                        },
+                        demandSources: {
+                            [dsUUID2]: ['readDS2', 'readDS2'], // New demand source with duplicate permissions
+                        },
+                    });
+                    // Capture elevated and combined permissions after second elevation
+                    afterSecondElevationElevated = user.elevatedPermissions;
+                    afterSecondElevationCombined = user.permissions;
+                    // 3. Close Second Elevation
+                    closeElevation2();
+                    afterCloseSecondElevated = user.elevatedPermissions;
+                    afterCloseSecondCombined = user.permissions;
+                    // 4. Close First Elevation
+                    closeElevation1();
+                    afterCloseFirstElevated = user.elevatedPermissions;
+                    afterCloseFirstCombined = user.permissions;
+                }
+                catch (e) {
+                    capturedError = e;
+                }
+                res.json({ status: 'ok' });
+            });
+        }, 8089);
+        // Trigger the test route
+        const response = await axios_1.default.get('http://localhost:8089', {
+            headers: {
+                'x-af-user-id': userId,
+            },
+        });
+        closeServer();
+        // Basic assertions
+        expect(response.status).toEqual(200);
+        expect(capturedError).toBeNull();
+        // ---------------------
+        // Assertions After First Elevation
+        // ---------------------
+        expect(afterFirstElevationElevated.fleets?.[fleetUUID1]).toEqual(expect.arrayContaining(['readF1']));
+        expect(afterFirstElevationElevated.businessModels?.[bmUUID1]).toEqual(expect.arrayContaining(['writeBM1']));
+        expect(afterFirstElevationElevated.demandSources?.[dsUUID1]).toEqual(expect.arrayContaining(['readDS1']));
+        expect(afterFirstElevationCombined.fleets?.[fleetUUID1]).toEqual(expect.arrayContaining(['readF1']));
+        expect(afterFirstElevationCombined.businessModels?.[bmUUID1]).toEqual(expect.arrayContaining(['writeBM1']));
+        expect(afterFirstElevationCombined.demandSources?.[dsUUID1]).toEqual(expect.arrayContaining(['readDS1']));
+        // ---------------------
+        // Assertions After Second Elevation
+        // ---------------------
+        expect(afterSecondElevationElevated.fleets?.[fleetUUID1]).toEqual(expect.arrayContaining(['readF1', 'manageF1']));
+        expect(afterSecondElevationElevated.fleets?.[fleetUUID2]).toEqual(expect.arrayContaining(['createF2']));
+        expect(afterSecondElevationElevated.businessModels?.[bmUUID1]).toEqual(expect.arrayContaining(['writeBM1', 'writeBM2']));
+        expect(afterSecondElevationElevated.demandSources?.[dsUUID2]).toEqual(expect.arrayContaining(['readDS2', 'readDS2']));
+        expect(afterSecondElevationCombined.fleets?.[fleetUUID1]).toEqual(expect.arrayContaining(['readF1', 'manageF1']));
+        expect(afterSecondElevationCombined.fleets?.[fleetUUID2]).toEqual(expect.arrayContaining(['createF2']));
+        expect(afterSecondElevationCombined.businessModels?.[bmUUID1]).toEqual(expect.arrayContaining(['writeBM1', 'writeBM2']));
+        expect(afterSecondElevationCombined.demandSources?.[dsUUID2]).toEqual(expect.arrayContaining(['readDS2', 'readDS2']));
+        // ---------------------
+        // Assertions After Closing Second Elevation
+        // ---------------------
+        expect(afterCloseSecondElevated.fleets?.[fleetUUID1]).toEqual(expect.arrayContaining(['readF1']));
+        expect(afterCloseSecondElevated.fleets?.[fleetUUID2]).toBeUndefined();
+        expect(afterCloseSecondElevated.businessModels?.[bmUUID1]).toEqual(expect.arrayContaining(['writeBM1']));
+        expect(afterCloseSecondElevated.demandSources?.[dsUUID1]).toEqual(expect.arrayContaining(['readDS1']));
+        expect(afterCloseSecondElevated.demandSources?.[dsUUID2]).toBeUndefined();
+        expect(afterCloseSecondCombined.fleets?.[fleetUUID1]).toEqual(expect.arrayContaining(['readF1']));
+        expect(afterCloseSecondCombined.fleets?.[fleetUUID2]).toBeUndefined();
+        expect(afterCloseSecondCombined.businessModels?.[bmUUID1]).toEqual(expect.arrayContaining(['writeBM1']));
+        expect(afterCloseSecondCombined.demandSources?.[dsUUID1]).toEqual(expect.arrayContaining(['readDS1']));
+        expect(afterCloseSecondCombined.demandSources?.[dsUUID2]).toBeUndefined();
+        // ---------------------
+        // Assertions After Closing First Elevation
+        // ---------------------
+        expect(afterCloseFirstElevated.fleets).toEqual({});
+        expect(afterCloseFirstElevated.businessModels).toEqual({});
+        expect(afterCloseFirstElevated.demandSources).toEqual({});
+        expect(afterCloseFirstCombined.fleets).toEqual({});
+        expect(afterCloseFirstCombined.businessModels).toEqual({});
+        expect(afterCloseFirstCombined.demandSources).toEqual({});
+    });
 });

package/lib/utils.d.ts

@@ -3,11 +3,3 @@ export declare const decodeBearer: (bearer: string, appSecret?: string) => any;
 export declare const parsePermissions: (contextId: any, decodedToken: any) => any;
 export declare const getEntitiesFromContext: (contextId: string, decodedToken: any) => any;
 export declare const getContextAttributes: (contextId: string, decodedToken: any) => any;
-/**
- * Custom deep merge function that merges `source` into `target`.
- *
- * @param target - The object to receive merged properties.
- * @param source - The object whose properties are merged into the target.
- * @returns The modified `target` object.
- */
-export declare const mergeDeep: <T extends object>(target: T, source: Partial<T>) => T;

package/lib/utils.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.mergeDeep = exports.getContextAttributes = exports.getEntitiesFromContext = exports.parsePermissions = exports.decodeBearer = exports.getAuthFromBearer = void 0;
+exports.getContextAttributes = exports.getEntitiesFromContext = exports.parsePermissions = exports.decodeBearer = exports.getAuthFromBearer = void 0;
 /* eslint-disable prefer-destructuring */
 const jwt = __importStar(require("jsonwebtoken"));
 const secret_getter_1 = require("./secret-getter");
@@ -97,34 +97,3 @@ const getContextAttributes = (contextId, decodedToken) => {
     return attributes;
 };
 exports.getContextAttributes = getContextAttributes;
-/**
- * A simple helper to check if a value is a plain object.
- */
-const isObject = (value) => (typeof value === 'object'
-    && value !== null
-    && !Array.isArray(value));
-/**
- * Custom deep merge function that merges `source` into `target`.
- *
- * @param target - The object to receive merged properties.
- * @param source - The object whose properties are merged into the target.
- * @returns The modified `target` object.
- */
-const mergeDeep = (target, source) => {
-    if (!isObject(target) || !isObject(source)) {
-        throw new Error('Both arguments must be objects to merge');
-    }
-    Object.keys(source).forEach((key) => {
-        const sourceValue = source[key];
-        const targetValue = target[key];
-        if (isObject(sourceValue) && isObject(targetValue)) {
-            (0, exports.mergeDeep)(targetValue, sourceValue);
-        }
-        else {
-            // eslint-disable-next-line no-param-reassign
-            target[key] = sourceValue;
-        }
-    });
-    return target;
-};
-exports.mergeDeep = mergeDeep;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autofleet/zehut",
-  "version": "3.1.2-beta.8",
+  "version": "3.1.2",
   "description": "manage user's identity",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -48,6 +48,14 @@
     "ts-jest": "^29.1.1",
     "typescript": "^4.9.5"
   },
+  "peerDependencies": {
+    "@autofleet/shtinker": "^1.2.0"
+  },
+  "peerDependenciesMeta": {
+    "@autofleet/shtinker": {
+      "optional": true
+    }
+  },
   "files": [
     "lib/**/*"
   ]