@ruiapp/rapid-core 0.5.0 → 0.5.2

package/dist/index.js

@@ -202,8 +202,8 @@ const pgPropertyTypeColumnMap = {
     "image[]": "jsonb",
 };
 
-const objLeftQuoteChar = "\"";
-const objRightQuoteChar = "\"";
+const objLeftQuoteChar = '"';
+const objRightQuoteChar = '"';
 const relationalOperatorsMap = new Map([
     ["eq", "="],
     ["ne", "<>"],
@@ -250,6 +250,9 @@ class QueryBuilder {
             }
         }
     }
+    formatValueToSqlLiteral(value) {
+        return formatValueToSqlLiteral(value);
+    }
     select(model, options) {
         const ctx = {
             model,
@@ -369,7 +372,7 @@ class QueryBuilder {
             paramToLiteral: false,
         };
         let { filters } = options;
-        let command = "SELECT COUNT(*)::int as \"count\" FROM ";
+        let command = 'SELECT COUNT(*)::int as "count" FROM ';
         command += this.quoteTable(model);
         if (filters && filters.length) {
             command += " WHERE ";
@@ -389,7 +392,7 @@ class QueryBuilder {
             paramToLiteral: false,
         };
         let { filters } = options;
-        let command = "SELECT COUNT(*)::int as \"count\" FROM ";
+        let command = 'SELECT COUNT(*)::int as "count" FROM ';
         command += `${this.quoteTable(derivedModel)} LEFT JOIN ${this.quoteTable(baseModel)} ON ${this.quoteObject(derivedModel.tableName)}.id = ${this.quoteObject(baseModel.tableName)}.id`;
         if (filters && filters.length) {
             command += " WHERE ";
@@ -996,7 +999,6 @@ function mergeHeaders(target, source) {
     else if (lodash.isObject(source)) {
         Object.entries(source).forEach(([key, value]) => target.set(key, value));
     }
-    return target;
 }
 function newResponse(options) {
     return new Response(options.body, {
@@ -1005,6 +1007,7 @@ function newResponse(options) {
     });
 }
 class RapidResponse {
+    // TODO: remove this field.
     #response;
     status;
     body;
@@ -1024,13 +1027,16 @@ class RapidResponse {
         if (headers) {
             mergeHeaders(responseHeaders, headers);
         }
-        this.#response = newResponse({ body, status: status || 200, headers: responseHeaders });
+        this.status = status || 200;
+        this.body = body;
+        this.#response = newResponse({ body, status: this.status, headers: responseHeaders });
     }
     redirect(location, status) {
         this.headers.set("Location", location);
+        this.status = status || 302;
         this.#response = newResponse({
             headers: this.headers,
-            status: status || 302,
+            status: this.status,
         });
     }
     getResponse() {
@@ -4158,19 +4164,27 @@ class RapidServer {
         const rapidRequest = new RapidRequest(this, request);
         await rapidRequest.parseBody();
         const routeContext = new RouteContext(this, rapidRequest);
+        const { response } = routeContext;
         try {
             await this.#pluginManager.onPrepareRouteContext(routeContext);
             await this.#buildedRoutes(routeContext, next);
         }
         catch (ex) {
             this.#logger.error("handle request error:", ex);
-            routeContext.response.json({
+            response.json({
                 error: {
                     message: ex.message || ex,
                 },
             }, 500);
         }
-        return routeContext.response.getResponse();
+        if (!response.status && !response.body) {
+            response.json({
+                error: {
+                    message: "No route handler was found to handle this request.",
+                },
+            }, 404);
+        }
+        return response.getResponse();
     }
     async beforeRunRouteActions(handlerContext) {
         await this.#pluginManager.beforeRunRouteActions(handlerContext);
@@ -4638,7 +4652,7 @@ function listDataDictionaries(server) {
 async function syncDatabaseSchema(server, applicationConfig) {
     const logger = server.getLogger();
     logger.info("Synchronizing database schema...");
-    const sqlQueryTableInformations = `SELECT table_schema, table_name FROM information_schema.tables`;
+    const sqlQueryTableInformations = `SELECT table_schema, table_name, obj_description((table_schema||'.'||quote_ident(table_name))::regclass) as table_description FROM information_schema.tables`;
     const tablesInDb = await server.queryDatabaseObject(sqlQueryTableInformations);
     const { queryBuilder } = server;
     for (const model of applicationConfig.models) {
@@ -4649,9 +4663,14 @@ async function syncDatabaseSchema(server, applicationConfig) {
         if (!tableInDb) {
             await server.queryDatabaseObject(`CREATE TABLE IF NOT EXISTS ${queryBuilder.quoteTable(model)} ()`, []);
         }
+        if (!tableInDb || tableInDb.table_description != model.name) {
+            await server.queryDatabaseObject(`COMMENT ON TABLE ${queryBuilder.quoteTable(model)} IS ${queryBuilder.formatValueToSqlLiteral(model.name)};`, []);
+        }
     }
-    const sqlQueryColumnInformations = `SELECT table_schema, table_name, column_name, data_type, udt_name, is_nullable, column_default, character_maximum_length, numeric_precision, numeric_scale
-  FROM information_schema.columns;`;
+    const sqlQueryColumnInformations = `SELECT c.table_schema, c.table_name, c.column_name, c.ordinal_position, d.description, c.data_type,  c.udt_name, c.is_nullable, c.column_default, c.character_maximum_length, c.numeric_precision, c.numeric_scale
+    FROM information_schema.columns c
+    INNER JOIN pg_catalog.pg_statio_all_tables st ON (st.schemaname = c.table_schema and st.relname = c.table_name)
+    LEFT JOIN pg_catalog.pg_description d ON (d.objoid = st.relid and d.objsubid = c.ordinal_position);`;
     const columnsInDb = await server.queryDatabaseObject(sqlQueryColumnInformations, []);
     for (const model of applicationConfig.models) {
         logger.debug(`Checking data columns for '${model.namespace}.${model.singularCode}'...`);
@@ -4678,6 +4697,9 @@ async function syncDatabaseSchema(server, applicationConfig) {
                             notNull: property.required,
                         });
                     }
+                    if (!columnInDb || columnInDb.description != property.name) {
+                        await server.queryDatabaseObject(`COMMENT ON COLUMN ${queryBuilder.quoteTable(model)}.${queryBuilder.quoteObject(property.targetIdColumnName)} IS ${queryBuilder.formatValueToSqlLiteral(property.name)};`, []);
+                    }
                 }
                 else if (property.relation === "many") {
                     if (property.linkTableName) {
@@ -4780,6 +4802,9 @@ async function syncDatabaseSchema(server, applicationConfig) {
                         }
                     }
                 }
+                if (!columnInDb || columnInDb.description != property.name) {
+                    await server.queryDatabaseObject(`COMMENT ON COLUMN ${queryBuilder.quoteTable(model)}.${queryBuilder.quoteObject(property.columnName || property.code)} IS ${queryBuilder.formatValueToSqlLiteral(property.name)};`, []);
+                }
             }
         }
     }
@@ -4975,7 +5000,13 @@ async function handler$q(plugin, ctx, options) {
             routeContext,
         });
         if (!entity) {
-            throw new Error(`${options.namespace}.${options.singularCode} with id "${id}" was not found.`);
+            ctx.routerContext.response.json({
+                error: {
+                    message: `${options.namespace}.${options.singularCode} with id "${id}" was not found.`,
+                },
+            }, 404);
+            // routerContext.json() function will not be called if the ctx.output is null or undefined.
+            return;
         }
         return entity;
     });

package/dist/queryBuilder/queryBuilder.d.ts

@@ -1,4 +1,4 @@
-import { RpdDataModel, CreateEntityOptions, QuoteTableOptions, DatabaseQuery } from "../types";
+import { RpdDataModel, CreateEntityOptions, QuoteTableOptions, DatabaseQuery, IQueryBuilder } from "../types";
 import { CountRowOptions, DeleteRowOptions, FindRowOptions, RowFilterOptions, UpdateRowOptions, ColumnSelectOptions } from "../dataAccess/dataAccessTypes";
 export interface BuildQueryContext {
     model: RpdDataModel;
@@ -13,12 +13,13 @@ export interface BuildQueryContext {
 export interface InitQueryBuilderOptions {
     dbDefaultSchema: string;
 }
-export default class QueryBuilder {
+export default class QueryBuilder implements IQueryBuilder {
     #private;
     constructor(options: InitQueryBuilderOptions);
     quoteTable(options: QuoteTableOptions): string;
     quoteObject(name: string): string;
     quoteColumn(model: RpdDataModel, column: ColumnSelectOptions, emitTableAlias: boolean): string;
+    formatValueToSqlLiteral(value: any): string;
     select(model: RpdDataModel, options: FindRowOptions): DatabaseQuery;
     selectDerived(derivedModel: RpdDataModel, baseModel: RpdDataModel, options: FindRowOptions): DatabaseQuery;
     count(model: RpdDataModel, options: CountRowOptions): DatabaseQuery;

package/dist/types.d.ts

@@ -154,6 +154,7 @@ export interface IQueryBuilder {
     quoteTable: (options: QuoteTableOptions) => string;
     quoteObject: (name: string) => string;
     buildFiltersExpression(model: RpdDataModel, filters: RowFilterOptions[]): any;
+    formatValueToSqlLiteral: (value: any) => string;
 }
 export interface RpdApplicationConfig {
     code?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ruiapp/rapid-core",
-  "version": "0.5.0",
+  "version": "0.5.2",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/core/response.ts

@@ -15,7 +15,6 @@ function mergeHeaders(target: Headers, source: HeadersInit) {
   } else if (isObject(source)) {
     Object.entries(source).forEach(([key, value]) => target.set(key, value));
   }
-  return target;
 }
 
 interface NewResponseOptions {
@@ -32,6 +31,7 @@ function newResponse(options: NewResponseOptions) {
 }
 
 export class RapidResponse {
+  // TODO: remove this field.
   #response: Response;
   status: number;
   body: BodyInit;
@@ -53,14 +53,17 @@ export class RapidResponse {
     if (headers) {
       mergeHeaders(responseHeaders, headers);
     }
-    this.#response = newResponse({ body, status: status || 200, headers: responseHeaders });
+    this.status = status || 200;
+    this.body = body;
+    this.#response = newResponse({ body, status: this.status, headers: responseHeaders });
   }
 
   redirect(location: string, status?: HttpStatus) {
     this.headers.set("Location", location);
+    this.status = status || 302;
     this.#response = newResponse({
       headers: this.headers,
-      status: status || 302,
+      status: this.status,
     });
   }
 

package/src/plugins/dataManage/actionHandlers/findCollectionEntityById.ts

@@ -14,7 +14,16 @@ export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, op
       routeContext,
     });
     if (!entity) {
-      throw new Error(`${options.namespace}.${options.singularCode} with id "${id}" was not found.`);
+      ctx.routerContext.response.json(
+        {
+          error: {
+            message: `${options.namespace}.${options.singularCode} with id "${id}" was not found.`,
+          },
+        },
+        404,
+      );
+      // routerContext.json() function will not be called if the ctx.output is null or undefined.
+      return;
     }
     return entity;
   });

package/src/plugins/metaManage/MetaManagePlugin.ts

@@ -181,12 +181,15 @@ function listDataDictionaries(server: IRpdServer) {
 type TableInformation = {
   table_schema: string;
   table_name: string;
+  table_description: string;
 };
 
 type ColumnInformation = {
   table_schema: string;
   table_name: string;
   column_name: string;
+  ordinal_position: number;
+  description?: string;
   data_type: string;
   udt_name: string;
   is_nullable: "YES" | "NO";
@@ -206,7 +209,7 @@ type ConstraintInformation = {
 async function syncDatabaseSchema(server: IRpdServer, applicationConfig: RpdApplicationConfig) {
   const logger = server.getLogger();
   logger.info("Synchronizing database schema...");
-  const sqlQueryTableInformations = `SELECT table_schema, table_name FROM information_schema.tables`;
+  const sqlQueryTableInformations = `SELECT table_schema, table_name, obj_description((table_schema||'.'||quote_ident(table_name))::regclass) as table_description FROM information_schema.tables`;
   const tablesInDb: TableInformation[] = await server.queryDatabaseObject(sqlQueryTableInformations);
   const { queryBuilder } = server;
 
@@ -219,10 +222,15 @@ async function syncDatabaseSchema(server: IRpdServer, applicationConfig: RpdAppl
     if (!tableInDb) {
       await server.queryDatabaseObject(`CREATE TABLE IF NOT EXISTS ${queryBuilder.quoteTable(model)} ()`, []);
     }
+    if (!tableInDb || tableInDb.table_description != model.name) {
+      await server.queryDatabaseObject(`COMMENT ON TABLE ${queryBuilder.quoteTable(model)} IS ${queryBuilder.formatValueToSqlLiteral(model.name)};`, []);
+    }
   }
 
-  const sqlQueryColumnInformations = `SELECT table_schema, table_name, column_name, data_type, udt_name, is_nullable, column_default, character_maximum_length, numeric_precision, numeric_scale
-  FROM information_schema.columns;`;
+  const sqlQueryColumnInformations = `SELECT c.table_schema, c.table_name, c.column_name, c.ordinal_position, d.description, c.data_type,  c.udt_name, c.is_nullable, c.column_default, c.character_maximum_length, c.numeric_precision, c.numeric_scale
+    FROM information_schema.columns c
+    INNER JOIN pg_catalog.pg_statio_all_tables st ON (st.schemaname = c.table_schema and st.relname = c.table_name)
+    LEFT JOIN pg_catalog.pg_description d ON (d.objoid = st.relid and d.objsubid = c.ordinal_position);`;
   const columnsInDb: ColumnInformation[] = await server.queryDatabaseObject(sqlQueryColumnInformations, []);
 
   for (const model of applicationConfig.models) {
@@ -253,6 +261,15 @@ async function syncDatabaseSchema(server: IRpdServer, applicationConfig: RpdAppl
               notNull: property.required,
             });
           }
+
+          if (!columnInDb || columnInDb.description != property.name) {
+            await server.queryDatabaseObject(
+              `COMMENT ON COLUMN ${queryBuilder.quoteTable(model)}.${queryBuilder.quoteObject(
+                property.targetIdColumnName,
+              )} IS ${queryBuilder.formatValueToSqlLiteral(property.name)};`,
+              [],
+            );
+          }
         } else if (property.relation === "many") {
           if (property.linkTableName) {
             const tableInDb = find(tablesInDb, {
@@ -359,6 +376,15 @@ async function syncDatabaseSchema(server: IRpdServer, applicationConfig: RpdAppl
             }
           }
         }
+
+        if (!columnInDb || columnInDb.description != property.name) {
+          await server.queryDatabaseObject(
+            `COMMENT ON COLUMN ${queryBuilder.quoteTable(model)}.${queryBuilder.quoteObject(
+              property.columnName || property.code,
+            )} IS ${queryBuilder.formatValueToSqlLiteral(property.name)};`,
+            [],
+          );
+        }
       }
     }
   }

package/src/queryBuilder/queryBuilder.ts

@@ -1,5 +1,5 @@
 import { find, isBoolean, isNull, isNumber, isString, isUndefined } from "lodash";
-import { RpdDataModel, RpdDataModelProperty, CreateEntityOptions, QuoteTableOptions, DatabaseQuery } from "../types";
+import { RpdDataModel, RpdDataModelProperty, CreateEntityOptions, QuoteTableOptions, DatabaseQuery, IQueryBuilder } from "../types";
 import {
   CountRowOptions,
   DeleteRowOptions,
@@ -19,8 +19,8 @@ import {
 } from "~/dataAccess/dataAccessTypes";
 import { pgPropertyTypeColumnMap } from "~/dataAccess/columnTypeMapper";
 
-const objLeftQuoteChar = "\"";
-const objRightQuoteChar = "\"";
+const objLeftQuoteChar = '"';
+const objRightQuoteChar = '"';
 
 const relationalOperatorsMap = new Map<RowFilterRelationalOperators, string>([
   ["eq", "="],
@@ -46,7 +46,7 @@ export interface InitQueryBuilderOptions {
   dbDefaultSchema: string;
 }
 
-export default class QueryBuilder {
+export default class QueryBuilder implements IQueryBuilder {
   #dbDefaultSchema: string;
 
   constructor(options: InitQueryBuilderOptions) {
@@ -84,6 +84,10 @@ export default class QueryBuilder {
     }
   }
 
+  formatValueToSqlLiteral(value: any) {
+    return formatValueToSqlLiteral(value);
+  }
+
   select(model: RpdDataModel, options: FindRowOptions): DatabaseQuery {
     const ctx: BuildQueryContext = {
       model,
@@ -223,7 +227,7 @@ export default class QueryBuilder {
       paramToLiteral: false,
     };
     let { filters } = options;
-    let command = "SELECT COUNT(*)::int as \"count\" FROM ";
+    let command = 'SELECT COUNT(*)::int as "count" FROM ';
 
     command += this.quoteTable(model);
 
@@ -247,7 +251,7 @@ export default class QueryBuilder {
       paramToLiteral: false,
     };
     let { filters } = options;
-    let command = "SELECT COUNT(*)::int as \"count\" FROM ";
+    let command = 'SELECT COUNT(*)::int as "count" FROM ';
 
     command += `${this.quoteTable(derivedModel)} LEFT JOIN ${this.quoteTable(baseModel)} ON ${this.quoteObject(derivedModel.tableName)}.id = ${this.quoteObject(
       baseModel.tableName,
@@ -498,11 +502,10 @@ function buildRangeFilterQuery(ctx: BuildQueryContext, filter: FindRowRangeFilte
     ctx.params.push(filter.value[0]);
     command += `$${ctx.params.length}`;
 
-    command += " AND "
+    command += " AND ";
 
     ctx.params.push(filter.value[1]);
     command += `$${ctx.params.length}`;
-
   } else {
     throw new Error(`Filter operator '${filter.operator}' is not supported.`);
   }

package/src/server.ts

@@ -400,13 +400,14 @@ export class RapidServer implements IRpdServer {
     const rapidRequest = new RapidRequest(this, request);
     await rapidRequest.parseBody();
     const routeContext: RouteContext = new RouteContext(this, rapidRequest);
+    const { response } = routeContext;
 
     try {
       await this.#pluginManager.onPrepareRouteContext(routeContext);
       await this.#buildedRoutes(routeContext, next);
     } catch (ex) {
       this.#logger.error("handle request error:", ex);
-      routeContext.response.json(
+      response.json(
         {
           error: {
             message: ex.message || ex,
@@ -415,7 +416,18 @@ export class RapidServer implements IRpdServer {
         500,
       );
     }
-    return routeContext.response.getResponse();
+
+    if (!response.status && !response.body) {
+      response.json(
+        {
+          error: {
+            message: "No route handler was found to handle this request.",
+          },
+        },
+        404,
+      );
+    }
+    return response.getResponse();
   }
 
   async beforeRunRouteActions(handlerContext: ActionHandlerContext) {

package/src/types.ts

@@ -179,6 +179,7 @@ export interface IQueryBuilder {
   quoteTable: (options: QuoteTableOptions) => string;
   quoteObject: (name: string) => string;
   buildFiltersExpression(model: RpdDataModel, filters: RowFilterOptions[]);
+  formatValueToSqlLiteral: (value: any) => string;
 }
 
 export interface RpdApplicationConfig {