Set context user (#239)

kbarbounakis · web-flow · commit 14480d243877 · 2025-10-27T07:35:41.000+02:00
* set context user

* handler context user and interactive user changes

* validate context user

* remove unused import

* validate context serialization

* 2.23.0
diff --git a/UserService.d.ts b/UserService.d.ts
@@ -0,0 +1,32 @@
+import { ApplicationBase, ApplicationService } from '@themost/common';
+import { DataContext } from './types';
+import { BehaviorSubject, Observable } from 'rxjs';
+
+export declare interface OnFinalizeService {
+    finalizeAsync(): Promise<void>;
+}
+
+export declare interface OnRemoveUser {
+    removeUser(name: string): Promise<void>;
+}
+
+export declare class UserService extends ApplicationService {
+    
+    constructor(app:any);
+
+    getUser(context: DataContext, name: string): Promise<any>;
+
+    getAnonymousUser(context: DataContext): Promise<any>;
+    
+    getGroup(context: DataContext, name: string): Promise<any>;
+
+    /**
+     * An observable that emits the anonymous user data.
+     * This can be used to track or handle the state of an anonymous user in the application.
+     * 
+     * @type {Observable<any>}
+     */
+    anonymousUser$: Observable<any>;
+
+    refreshAnonymousUser$: BehaviorSubject<any>;
+}
diff --git a/UserService.js b/UserService.js
@@ -0,0 +1,61 @@
+const { ApplicationService } = require('@themost/common');
+const { BehaviorSubject, shareReplay, switchMap, from, of } = require('rxjs');
+
+class UserService extends ApplicationService {
+  constructor(app) {
+    super(app);
+
+    this.refreshAnonymousUser$ = new BehaviorSubject(void 0);
+    
+    this.anonymousUser$ = this.refreshAnonymousUser$.pipe(switchMap((value) => {
+        if (typeof value !== 'undefined') {
+            return of(value);
+        }
+        // create a new context
+        const context = this.getApplication().createContext();
+        // get anonymous user
+        return from(this.getAnonymousUser(context).finally(() => {
+            // finalize context
+            return context.finalizeAsync();
+        }));
+    }), shareReplay(1));
+
+  }
+
+  /**
+   * @param {import('@themost/common').DataContextBase} context
+   * @param {string} name 
+   * @returns {Promise<any>}
+   */
+  getUser(context, name) {
+    return context.model('User').asQueryable().where((x, username) => {
+        return x.name === username;
+    }, name).expand((x) => x.groups).silent().getItem();
+  }
+
+  /**
+   * @param {import('@themost/common').DataContextBase} context
+   * @param {string} name 
+   * @returns {Promise<any>}
+   */
+  getGroup(context, name) {
+    return context.model('Group').asQueryable().where((x, username) => {
+        return x.name === username;
+    }, name).silent().getItem();
+  }
+
+  /**
+   * @param {import('@themost/common').DataContextBase} context
+   * @returns {Promise<any>}
+   */
+  getAnonymousUser(context) {
+    return context.model('User').asQueryable().where((x) => {
+        return x.name === 'anonymous';
+    }).expand((x) => x.groups).silent().getItem();
+  }
+  
+}
+
+module.exports = {
+    UserService
+};
diff --git a/index.d.ts b/index.d.ts
@@ -23,3 +23,4 @@ export * from './UnattendedMode';
 export * from './data-value-resolver';
 export * from './ValueFormatter';
 export * from './select-object-query';
+export * from './UserService';
diff --git a/index.js b/index.js
@@ -94,6 +94,8 @@ var { ValueFormatter, ValueDialect } = require('./ValueFormatter');
 
 var { SelectObjectQuery } = require('./select-object-query');
 
+var { UserService } = require('./UserService');
+
 module.exports = {
     TypeParser,
     PrivilegeType,
@@ -181,6 +183,7 @@ module.exports = {
     DataValueResolver,
     ValueFormatter,
     ValueDialect,
-    SelectObjectQuery
+    SelectObjectQuery,
+    UserService
 };
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@themost/data",
-  "version": "2.22.0",
+  "version": "2.23.0",
   "description": "MOST Web Framework Codename Blueshift - Data module",
   "main": "index.js",
   "scripts": {
@@ -36,6 +36,7 @@
     "node-cache": "^1.1.0",
     "pluralize": "^7.0.0",
     "q": "^1.4.1",
+    "rxjs": "^7.8.2",
     "sprintf-js": "^1.1.2",
     "symbol": "^0.3.1",
     "uuid": "^10.0.0"
diff --git a/spec/DataContext.spec.ts b/spec/DataContext.spec.ts
@@ -0,0 +1,103 @@
+import {TestApplication, TestApplication2} from './TestApplication';
+import {DataContext, UserService} from '@themost/data';
+import {firstValueFrom} from 'rxjs';
+
+describe('DataContext', () => {
+    let app: TestApplication;
+    let context: DataContext;
+    beforeAll((done) => {
+        app = new TestApplication2();
+        app.useService(UserService);
+        context = app.createContext();
+        return done();
+    });
+    afterAll(async () => {
+        await context.finalizeAsync();
+        await app.finalize();
+    });
+
+    it('should serialize context as empty object', async () => {
+        context.setUser({
+            name: 'alexis.rees@example.com',
+        });
+        const user = await firstValueFrom(context.user$);
+        const str = JSON.stringify(context);
+        expect(str).toEqual('{}');
+    })
+
+    it('should have user$', async () => {
+        context.setUser(null);
+        const user = await firstValueFrom(context.user$);
+        expect(user?.name).toBeFalsy();
+        context.setUser({
+            name: 'alexis.rees@example.com'
+        });
+        const user2 = await firstValueFrom(context.user$);
+        expect(user2?.name).toBe('alexis.rees@example.com');
+        context.switchUser({
+            name: 'james.may@example.com'
+        });
+        const user3 = await firstValueFrom(context.user$);
+        expect(user3?.name).toBe('james.may@example.com');
+    });
+
+    it('should have interactiveUser$', async () => {
+        let user = await firstValueFrom(context.interactiveUser$);
+        expect(user?.name).toBeFalsy();
+        context.setInteractiveUser({
+            name: 'alexis.rees@example.com'
+        });
+        user = await firstValueFrom(context.interactiveUser$);
+        expect(user?.name).toBe('alexis.rees@example.com');
+    });
+
+    it('should use different context', async () => {
+        context.switchUser({
+            name: 'james.may@example.com'
+        });
+        let user = await firstValueFrom(context.user$);
+        expect(user?.name).toBe('james.may@example.com');
+
+        const otherContext = app.createContext();
+        otherContext.setUser({
+            name: 'alexis.rees@example.com'
+        });
+        user = await firstValueFrom(otherContext.user$);
+        expect(user?.name).toBe('alexis.rees@example.com');
+        user = await firstValueFrom(context.user$);
+        expect(user?.name).toBe('james.may@example.com');
+
+    });
+
+    it('should set user', async () => {
+        context.user = null;
+        let user = await firstValueFrom(context.user$);
+        expect(user?.name).toBeFalsy();
+        context.user = {
+            name: 'alexis.rees@example.com'
+        };
+        user = await firstValueFrom(context.user$);
+        expect(user?.name).toBe('alexis.rees@example.com');
+        context.user = {
+            name: 'james.may@example.com'
+        };
+        user = await firstValueFrom(context.user$);
+        expect(user?.name).toBe( 'james.may@example.com');
+    });
+
+    it('should set user name', async () => {
+        context.user = null;
+        let user = await firstValueFrom(context.user$);
+        expect(user?.name).toBeFalsy();
+        context.user = {
+            name: 'alexis.rees@example.com'
+        };
+        expect(context.user.name).toBe('alexis.rees@example.com');
+        user = await firstValueFrom(context.user$);
+        expect(user?.name).toBe('alexis.rees@example.com');
+        context.user.name =  'james.may@example.com';
+        user = await firstValueFrom(context.user$);
+        expect(user?.name).toBe( 'james.may@example.com');
+    });
+
+});
diff --git a/spec/TestApplication.ts b/spec/TestApplication.ts
@@ -1,4 +1,4 @@
-import { IApplication, ConfigurationBase } from "@themost/common";
+import {IApplication, ConfigurationBase, ApplicationService, ApplicationServiceConstructor} from "@themost/common";
 import {resolve} from 'path';
 import {
     DataConfigurationStrategy,
@@ -14,6 +14,12 @@ export class TestApplication extends IApplication {
     private _services: Map<any,any> = new Map();
     private readonly _configuration: ConfigurationBase;
 
+    useService(serviceCtor: ApplicationServiceConstructor<any>) {
+        const ServiceClass: any = serviceCtor;
+        this._services.set(ServiceClass.name, new ServiceClass(this));
+        return this;
+    }
+
     useStrategy(serviceCtor: void, strategyCtor: void): this {
         const ServiceClass: any = serviceCtor;
         const StrategyClass: any = strategyCtor;
@@ -23,9 +29,15 @@ export class TestApplication extends IApplication {
     hasStrategy(serviceCtor: void): boolean {
         return this._services.has((<any>serviceCtor).name);
     }
+
     getStrategy<T>(serviceCtor: new () => T): T {
         return this._services.get(serviceCtor.name);
     }
+
+    getService<T>(serviceCtor: new () => T): T {
+        return this._services.get(serviceCtor.name);
+    }
+
     getConfiguration(): ConfigurationBase {
         return this._configuration;
     }
@@ -67,6 +79,7 @@ export class TestApplication extends IApplication {
         context.getConfiguration = () => {
             return this._configuration;
         };
+        context.setApplication(this);
         return context;
     }
 
diff --git a/types.d.ts b/types.d.ts
diff --git a/types.js b/types.js
