@ruiapp/rapid-core 0.1.19 → 0.1.21

package/src/server.ts

@@ -1,4 +1,3 @@
-import * as _ from "lodash";
 import DataAccessor from "./dataAccess/dataAccessor";
 import {
   GetDataAccessorOptions,
@@ -11,20 +10,24 @@ import {
   RpdDataModel,
   RpdServerEventTypes,
   RapidServerConfig,
+  RpdDataModelProperty,
 } from "./types";
 
 import QueryBuilder from "./queryBuilder/queryBuilder";
 import PluginManager from "./core/pluginManager";
 import EventManager from "./core/eventManager";
-import { ActionHandler, IPluginActionHandler } from "./core/actionHandler";
+import { ActionHandler, ActionHandlerContext, IPluginActionHandler } from "./core/actionHandler";
 import { IRpdServer, RapidPlugin } from "./core/server";
 import { buildRoutes } from "./core/routesBuilder";
 import { Next, RouteContext } from "./core/routeContext";
 import { RapidRequest } from "./core/request";
 import bootstrapApplicationConfig from "./bootstrapApplicationConfig";
 import EntityManager from "./dataAccess/entityManager";
+import { bind, cloneDeep, find, merge, omit } from "lodash";
+import { Logger } from "./facilities/log/LogFacility";
 
 export interface InitServerOptions {
+  logger: Logger;
   databaseAccessor: IDatabaseAccessor;
   databaseConfig: IDatabaseConfig;
   serverConfig: RapidServerConfig;
@@ -33,6 +36,7 @@ export interface InitServerOptions {
 }
 
 export class RapidServer implements IRpdServer {
+  #logger: Logger;
   #pluginManager: PluginManager;
   #plugins: RapidPlugin[];
   #eventManager: EventManager<RpdServerEventTypes>;
@@ -49,6 +53,8 @@ export class RapidServer implements IRpdServer {
   #buildedRoutes: (ctx: any, next: any) => any;
 
   constructor(options: InitServerOptions) {
+    this.#logger = options.logger;
+
     this.#pluginManager = new PluginManager(this);
     this.#eventManager = new EventManager();
     this.#middlewares = [];
@@ -69,6 +75,10 @@ export class RapidServer implements IRpdServer {
     this.#plugins = options.plugins || [];
   }
 
+  getLogger(): Logger {
+    return this.#logger;
+  }
+
   getApplicationConfig() {
     return this.#applicationConfig;
   }
@@ -77,12 +87,13 @@ export class RapidServer implements IRpdServer {
     const { models, routes } = config;
     if (models) {
       for (const model of models) {
-        const originalModel = _.find(this.#applicationConfig.models, (item) => item.singularCode == model.singularCode);
+        const originalModel = find(this.#applicationConfig.models, (item) => item.singularCode == model.singularCode);
         if (originalModel) {
+          merge(originalModel, omit(model, ["id", "maintainedBy", "namespace", "singularCode", "pluralCode", "schema", "tableName", "properties", "extensions"]));
           originalModel.name = model.name;
           const originalProperties = originalModel.properties;
           for (const property of model.properties) {
-            const originalProperty = _.find(originalProperties, (item) => item.code == property.code);
+            const originalProperty = find(originalProperties, (item) => item.code == property.code);
             if (originalProperty) {
               originalProperty.name = property.name;
             } else {
@@ -97,7 +108,7 @@ export class RapidServer implements IRpdServer {
 
     if (routes) {
       for (const route of routes) {
-        const originalRoute = _.find(this.#applicationConfig.routes, (item) => item.code == route.code);
+        const originalRoute = find(this.#applicationConfig.routes, (item) => item.code == route.code);
         if (originalRoute) {
           originalRoute.name = route.name;
           originalRoute.actions = route.actions;
@@ -108,11 +119,28 @@ export class RapidServer implements IRpdServer {
     }
   }
 
+  appendModelProperties(modelSingularCode: string, properties: RpdDataModelProperty[]) {
+    const originalModel = find(this.#applicationConfig.models, (item) => item.singularCode == modelSingularCode);
+    if (!originalModel) {
+      throw new Error(`Cannot append model properties. Model '${modelSingularCode}' was not found.`);
+    }
+
+    const originalProperties = originalModel.properties;
+    for (const property of properties) {
+      const originalProperty = find(originalProperties, (item) => item.code == property.code);
+      if (originalProperty) {
+        originalProperty.name = property.name;
+      } else {
+        originalProperties.push(property);
+      }
+    }
+  }
+
   registerActionHandler(
     plugin: RapidPlugin,
     options: IPluginActionHandler,
   ) {
-    const handler = _.bind(options.handler, null, plugin);
+    const handler = bind(options.handler, null, plugin);
     this.#actionHandlersMapByCode.set(options.code, handler);
   }
 
@@ -139,7 +167,7 @@ export class RapidServer implements IRpdServer {
       throw new Error(`Data model ${namespace}.${singularCode} not found.`);
     }
 
-    dataAccessor = new DataAccessor<T>(this.#databaseAccessor, {
+    dataAccessor = new DataAccessor<T>(this, this.#databaseAccessor, {
       model,
       queryBuilder: this.queryBuilder as QueryBuilder,
     });
@@ -180,7 +208,7 @@ export class RapidServer implements IRpdServer {
     sender: RapidPlugin,
     payload: RpdServerEventTypes[K][1],
   ) {
-    console.log(`Emit event "${eventName}"`, payload);
+    this.#logger.debug(`Emitting '${eventName}' event.`, { eventName, payload });
     await this.#eventManager.emit<K>(eventName, sender, payload as any);
 
     // TODO: should move this logic into metaManager
@@ -194,7 +222,7 @@ export class RapidServer implements IRpdServer {
   }
 
   async start() {
-    console.log("Starting rapid server...");
+    this.#logger.info("Starting rapid server...");
     const pluginManager = this.#pluginManager;
     await pluginManager.loadPlugins(this.#plugins);
 
@@ -208,13 +236,12 @@ export class RapidServer implements IRpdServer {
 
     await this.configureApplication();
 
-    console.log(`Application ready.`);
+    this.#logger.info(`Rapid server ready.`);
     await pluginManager.onApplicationReady(this.#applicationConfig);
   }
 
   async configureApplication() {
-    this.#applicationConfig = _.merge(
-      {},
+    this.#applicationConfig = cloneDeep(
       this.#bootstrapApplicationConfig,
     ) as RpdApplicationConfig;
 
@@ -232,14 +259,19 @@ export class RapidServer implements IRpdServer {
   }
 
   async queryDatabaseObject(sql: string, params?: unknown[] | Record<string,unknown>) : Promise<any[]> {
-    return await this.#databaseAccessor.queryDatabaseObject(sql, params);
+    try {
+      return await this.#databaseAccessor.queryDatabaseObject(sql, params);
+    } catch (err) {
+      this.#logger.error("Failed to query database object.", { errorMessage: err.message, sql, params });
+      throw err;
+    }
   }
 
   async tryQueryDatabaseObject(sql: string, params?: unknown[] | Record<string,unknown>) : Promise<any[]> {
     try {
       return await this.queryDatabaseObject(sql, params);
     } catch (err) {
-      console.error(err.message);
+      this.#logger.error("Failed to query database object.", { errorMessage: err.message, sql, params });
     }
 
     return [];
@@ -250,12 +282,16 @@ export class RapidServer implements IRpdServer {
   }
 
   async handleRequest(request: Request, next: Next) {
-    const rapidRequest = new RapidRequest(request);
+    const rapidRequest = new RapidRequest(this, request);
     await rapidRequest.parseBody();
-    const routeContext = new RouteContext(rapidRequest);
-    this.#pluginManager.onPrepareRouteContext(routeContext);
+    const routeContext = new RouteContext(this, rapidRequest);
+    await this.#pluginManager.onPrepareRouteContext(routeContext);
 
     await this.#buildedRoutes(routeContext, next);
     return routeContext.response.getResponse();
   }
+
+  async beforeRunRouteActions(handlerContext: ActionHandlerContext) {
+    await this.#pluginManager.beforeRunRouteActions(handlerContext);
+  }
 }

package/src/types.ts

@@ -133,6 +133,19 @@ export interface RpdDataModel {
   tableName: string;
   properties: RpdDataModelProperty[];
   extensions?: RpdDataModelExtension[];
+  permissionPolicies?: RpdDataModelPermissionPolicies;
+}
+
+export interface RpdDataModelPermissionPolicies {
+  find?: PermissionPolicy;
+  create?: PermissionPolicy;
+  update?: PermissionPolicy;
+  delete?: PermissionPolicy;
+}
+
+export interface PermissionPolicy {
+  any?: string[];
+  all?: string[];
 }
 
 export interface RpdDataModelProperty {

package/src/utilities/accessControlUtility.ts

@@ -0,0 +1,33 @@
+import { find } from "lodash";
+
+export type PermissionCheckPolicy = {
+  any?: string[];
+  all?: string[];
+}
+
+export function isAccessAllowed(policy: PermissionCheckPolicy, allowedActions: string[]): boolean {
+  let isAnyCheckPassed = true;
+  let isAllCheckPassed = true;
+
+  if (policy.any) {
+    isAnyCheckPassed = false;
+    for (const action of policy.any) {
+      if (find(allowedActions, item => item === action) != null) {
+        isAnyCheckPassed = true;
+        break;
+      }
+    }
+  }
+
+  if (policy.all) {
+    isAllCheckPassed = true;
+    for (const action of policy.all) {
+      if (find(allowedActions, item => item === action) == null) {
+        isAnyCheckPassed = false;
+        break;
+      }
+    }
+  }
+
+  return isAnyCheckPassed && isAllCheckPassed;
+}