@ruiapp/rapid-core 0.1.72 → 0.1.74

package/src/dataAccess/entityManager.ts

@@ -14,6 +14,8 @@ import {
   IRpdDataAccessor,
   RemoveEntityRelationsOptions,
   RpdDataModel,
+  RpdDataModelIndex,
+  RpdDataModelIndexOptions,
   RpdDataModelProperty,
   UpdateEntityByIdOptions,
 } from "~/types";
@@ -22,7 +24,7 @@ import { mapDbRowToEntity, mapEntityToDbRow } from "./entityMapper";
 import { mapPropertyNameToColumnName } from "./propertyMapper";
 import { IRpdServer, RapidPlugin } from "~/core/server";
 import { getEntityPartChanges } from "~/helpers/entityHelpers";
-import { filter, find, first, forEach, isArray, isNumber, isObject, isString, keys, map, reject, uniq } from "lodash";
+import { cloneDeep, filter, find, first, forEach, isArray, isNumber, isObject, isString, keys, map, reject, uniq } from "lodash";
 import {
   getEntityPropertiesIncludingBase,
   getEntityProperty,
@@ -35,6 +37,7 @@ import { ColumnSelectOptions, CountRowOptions, FindRowOptions, FindRowOrderByOpt
 import { newEntityOperationError } from "~/utilities/errorUtility";
 import { getNowStringWithTimezone } from "~/utilities/timeUtility";
 import { or } from "xstate";
+import { RouteContext } from "~/core/routeContext";
 
 export type FindOneRelationEntitiesOptions = {
   server: IRpdServer;
@@ -703,6 +706,26 @@ async function createEntity(server: IRpdServer, dataAccessor: IRpdDataAccessor,
     routeContext,
   });
 
+  // check unique constraints
+  if (!options.postponeUniquenessCheck) {
+    if (model.indexes && model.indexes.length) {
+      for (const indexConfig of model.indexes) {
+        if (!indexConfig.unique) {
+          continue;
+        }
+
+        const duplicate = await willEntityDuplicate(server, dataAccessor, {
+          routeContext: options.routeContext,
+          entityToSave: entity,
+          indexConfig,
+        });
+        if (duplicate) {
+          throw new Error(getEntityDuplicatedErrorMessage(server, model, indexConfig));
+        }
+      }
+    }
+  }
+
   const oneRelationPropertiesToCreate: RpdDataModelProperty[] = [];
   const manyRelationPropertiesToCreate: RpdDataModelProperty[] = [];
   keys(entity).forEach((propertyCode) => {
@@ -936,6 +959,27 @@ async function updateEntityById(server: IRpdServer, dataAccessor: IRpdDataAccess
 
   changes = getEntityPartChanges(server, model, entity, entityToSave);
 
+  // check unique constraints
+  if (!options.postponeUniquenessCheck) {
+    if (model.indexes && model.indexes.length) {
+      for (const indexConfig of model.indexes) {
+        if (!indexConfig.unique) {
+          continue;
+        }
+
+        const duplicate = await willEntityDuplicate(server, dataAccessor, {
+          routeContext: options.routeContext,
+          entityId: id,
+          entityToSave: changes,
+          indexConfig,
+        });
+        if (duplicate) {
+          throw new Error(getEntityDuplicatedErrorMessage(server, model, indexConfig));
+        }
+      }
+    }
+  }
+
   const oneRelationPropertiesToUpdate: RpdDataModelProperty[] = [];
   const manyRelationPropertiesToUpdate: RpdDataModelProperty[] = [];
   keys(changes).forEach((propertyCode) => {
@@ -1134,6 +1178,68 @@ async function updateEntityById(server: IRpdServer, dataAccessor: IRpdDataAccess
   return updatedEntity;
 }
 
+export type CheckEntityDuplicatedOptions = {
+  routeContext?: RouteContext;
+  entityId?: number;
+  entityToSave: any;
+  indexConfig: RpdDataModelIndex;
+};
+
+async function willEntityDuplicate(server: IRpdServer, dataAccessor: IRpdDataAccessor, options: CheckEntityDuplicatedOptions): Promise<boolean> {
+  const { entityId, entityToSave, routeContext, indexConfig } = options;
+
+  let filters: EntityFilterOptions[] = [];
+  if (indexConfig.conditions) {
+    filters = cloneDeep(indexConfig.conditions);
+  }
+
+  for (const propConfig of indexConfig.properties) {
+    let propCode: string;
+    if (isString(propConfig)) {
+      propCode = propConfig;
+    } else {
+      propCode = propConfig.code;
+    }
+
+    if (!entityToSave.hasOwnProperty(propCode)) {
+      // skip duplicate checking when  any index prop missing in entityToSave.
+      return false;
+    }
+
+    filters.push({
+      operator: "eq",
+      field: propCode,
+      value: entityToSave[propCode],
+    });
+  }
+
+  const entityInDb = await findEntity(server, dataAccessor, {
+    filters,
+    routeContext,
+  });
+
+  if (entityId) {
+    return entityInDb && entityInDb.Id !== entityId;
+  } else {
+    return !!entityInDb;
+  }
+}
+
+function getEntityDuplicatedErrorMessage(server: IRpdServer, model: RpdDataModel, indexConfig: RpdDataModelIndex) {
+  const propertyNames = indexConfig.properties.map((propConfig) => {
+    let propCode: string;
+    if (isString(propConfig)) {
+      propCode = propConfig;
+    } else {
+      propCode = propConfig.code;
+    }
+    const prop = getEntityPropertyByCode(server, model, propCode);
+    return prop.name;
+  });
+
+  return `已存在 ${propertyNames.join(", ")} 相同的记录。`;
+}
+
 export default class EntityManager<TEntity = any> {
   #server: IRpdServer;
   #dataAccessor: IRpdDataAccessor;

package/src/plugins/fileManage/actionHandlers/downloadFile.ts

@@ -1,28 +1,33 @@
-import path from "path";
-import { readFile } from "~/utilities/fsUtility";
-import { ActionHandlerContext } from "~/core/actionHandler";
-import { RapidPlugin } from "~/core/server";
-
-export const code = "downloadFile";
-
-export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any) {
-  const { server, applicationConfig, routerContext, input } = ctx;
-  const { request, response } = routerContext;
-
-  const dataAccessor = ctx.server.getDataAccessor({
-    singularCode: "ecm_storage_object",
-  });
-
-  const storageObject = await dataAccessor.findById(input.fileId);
-  if (!storageObject) {
-    ctx.output = { error: new Error("Storage object not found.") };
-    return;
-  }
-
-  const fileKey = storageObject.key;
-  const filePathName = path.join(server.config.localFileStoragePath, fileKey);
-  const attachmentFileName = input.fileName || path.basename(fileKey);
-
-  response.body = await readFile(filePathName);
-  response.headers.set("Content-Disposition", `attachment; filename="${encodeURIComponent(attachmentFileName)}"`);
-}
+import path from "path";
+import { readFile } from "~/utilities/fsUtility";
+import { ActionHandlerContext } from "~/core/actionHandler";
+import { RapidPlugin } from "~/core/server";
+
+export const code = "downloadFile";
+
+export async function handler(plugin: RapidPlugin, ctx: ActionHandlerContext, options: any) {
+  const { server, applicationConfig, routerContext, input } = ctx;
+  const { request, response } = routerContext;
+  //TODO: only public files can download by this handler
+
+  let fileKey: string = input.fileKey;
+
+  if (!fileKey && input.fileId) {
+    const dataAccessor = ctx.server.getDataAccessor({
+      singularCode: "ecm_storage_object",
+    });
+
+    const storageObject = await dataAccessor.findById(input.fileId);
+    if (!storageObject) {
+      ctx.output = { error: new Error("Storage object not found.") };
+      return;
+    }
+
+    fileKey = storageObject.key;
+  }
+  const filePathName = path.join(server.config.localFileStoragePath, fileKey);
+  const attachmentFileName = input.fileName || path.basename(fileKey);
+
+  response.body = await readFile(filePathName);
+  response.headers.set("Content-Disposition", `attachment; filename="${encodeURIComponent(attachmentFileName)}"`);
+}

package/src/plugins/metaManage/MetaManagePlugin.ts

@@ -7,6 +7,7 @@ import {
   QuoteTableOptions,
   RpdApplicationConfig,
   RpdDataModel,
+  RpdDataModelIndex,
   RpdDataModelProperty,
   RpdDataPropertyTypes,
   RpdEntityCreateEventPayload,
@@ -24,8 +25,8 @@ import {
 import * as listMetaModels from "./actionHandlers/listMetaModels";
 import * as listMetaRoutes from "./actionHandlers/listMetaRoutes";
 import * as getMetaModelDetail from "./actionHandlers/getMetaModelDetail";
-import { find } from "lodash";
-import { getEntityPropertiesIncludingBase, isRelationProperty } from "~/helpers/metaHelper";
+import { find, isString, map } from "lodash";
+import { getEntityPropertiesIncludingBase, getEntityPropertyByCode, isOneRelationProperty, isRelationProperty } from "~/helpers/metaHelper";
 
 class MetaManager implements RapidPlugin {
   get code(): string {
@@ -366,6 +367,18 @@ async function syncDatabaseSchema(server: IRpdServer, applicationConfig: RpdAppl
       );
     }
   }
+
+  // generate indexes
+  for (const model of applicationConfig.models) {
+    if (!model.indexes || !model.indexes.length) {
+      continue;
+    }
+
+    for (const index of model.indexes) {
+      const sqlCreateIndex = generateTableIndexDDL(queryBuilder, server, model, index);
+      await server.tryQueryDatabaseObject(sqlCreateIndex, []);
+    }
+  }
 }
 
 function generateCreateColumnDDL(
@@ -422,6 +435,56 @@ function generateLinkTableDDL(
   return columnDDL;
 }
 
+function generateTableIndexDDL(queryBuilder: IQueryBuilder, server: IRpdServer, model: RpdDataModel, index: RpdDataModelIndex) {
+  let indexName = index.name;
+  if (!indexName) {
+    indexName = model.tableName;
+    for (const indexProp of index.properties) {
+      const propCode = isString(indexProp) ? indexProp : indexProp.code;
+      const property = getEntityPropertyByCode(server, model, propCode);
+      if (!isRelationProperty(property)) {
+        indexName += "_" + property.columnName;
+      } else if (isOneRelationProperty(property)) {
+        indexName += "_" + property.targetIdColumnName;
+      }
+    }
+    indexName += index.unique ? "_uindex" : "_index";
+  }
+
+  const indexColumns = map(index.properties, (indexProp) => {
+    let columnName: string;
+    const propCode = isString(indexProp) ? indexProp : indexProp.code;
+    const property = getEntityPropertyByCode(server, model, propCode);
+    if (!isRelationProperty(property)) {
+      columnName = property.columnName;
+    } else if (isOneRelationProperty(property)) {
+      columnName = property.targetIdColumnName;
+    }
+
+    if (isString(indexProp)) {
+      return columnName;
+    }
+
+    if (indexProp.order === "desc") {
+      return `${columnName} desc`;
+    }
+
+    return columnName;
+  });
+
+  let ddl = `CREATE ${index.unique ? "UNIQUE" : ""} INDEX ${indexName} `;
+  ddl += `ON ${queryBuilder.quoteTable({
+    schema: model.schema,
+    tableName: model.tableName,
+  })} (${indexColumns.join(", ")})`;
+
+  if (index.conditions) {
+    ddl += ` WHERE ${queryBuilder.buildFiltersExpression(model, index.conditions)}`;
+  }
+
+  return ddl;
+}
+
 const pgPropertyTypeColumnMap: Partial<Record<RpdDataPropertyTypes, string>> = {
   integer: "int4",
   long: "int8",

package/src/queryBuilder/queryBuilder.ts

@@ -1,4 +1,4 @@
-import { find } from "lodash";
+import { find, isBoolean, isNull, isNumber, isString, isUndefined } from "lodash";
 import { RpdDataModel, RpdDataModelProperty, CreateEntityOptions, QuoteTableOptions, DatabaseQuery } from "../types";
 import {
   CountRowOptions,
@@ -32,6 +32,10 @@ export interface BuildQueryContext {
   builder: QueryBuilder;
   params: any[];
   emitTableAlias: boolean;
+  /**
+   * emit parameter value to sql literal.
+   */
+  paramToLiteral: boolean;
 }
 
 export interface InitQueryBuilderOptions {
@@ -82,6 +86,7 @@ export default class QueryBuilder {
       builder: this,
       params: [],
       emitTableAlias: true,
+      paramToLiteral: false,
     };
     let { fields: columns, filters, orderBy, pagination } = options;
     let command = "SELECT ";
@@ -143,6 +148,7 @@ export default class QueryBuilder {
       builder: this,
       params: [],
       emitTableAlias: true,
+      paramToLiteral: false,
     };
     let { fields: columns, filters, orderBy, pagination } = options;
     let command = "SELECT ";
@@ -210,6 +216,7 @@ export default class QueryBuilder {
       builder: this,
       params: [],
       emitTableAlias: false,
+      paramToLiteral: false,
     };
     let { filters } = options;
     let command = 'SELECT COUNT(*)::int as "count" FROM ';
@@ -233,6 +240,7 @@ export default class QueryBuilder {
       builder: this,
       params: [],
       emitTableAlias: true,
+      paramToLiteral: false,
     };
     let { filters } = options;
     let command = 'SELECT COUNT(*)::int as "count" FROM ';
@@ -259,6 +267,7 @@ export default class QueryBuilder {
       builder: this,
       params,
       emitTableAlias: false,
+      paramToLiteral: false,
     };
     const { entity } = options;
     let command = "INSERT INTO ";
@@ -302,6 +311,7 @@ export default class QueryBuilder {
       builder: this,
       params,
       emitTableAlias: false,
+      paramToLiteral: false,
     };
     let { entity, filters } = options;
     let command = "UPDATE ";
@@ -349,6 +359,7 @@ export default class QueryBuilder {
       builder: this,
       params,
       emitTableAlias: false,
+      paramToLiteral: false,
     };
     let { filters } = options;
     let command = "DELETE FROM ";
@@ -365,6 +376,19 @@ export default class QueryBuilder {
       params: ctx.params,
     };
   }
+
+  buildFiltersExpression(model: RpdDataModel, filters: RowFilterOptions[]) {
+    const params: any[] = [];
+    const ctx: BuildQueryContext = {
+      model,
+      builder: this,
+      params,
+      emitTableAlias: false,
+      paramToLiteral: true,
+    };
+
+    return buildFiltersQuery(ctx, filters);
+  }
 }
 
 export function buildFiltersQuery(ctx: BuildQueryContext, filters: RowFilterOptions[]) {
@@ -434,8 +458,13 @@ function buildInFilterQuery(ctx: BuildQueryContext, filter: FindRowSetFilterOpti
   } else {
     command += " <> ";
   }
-  ctx.params.push(filter.value);
-  command += `ANY($${ctx.params.length}::${filter.itemType || "int"}[])`;
+
+  if (ctx.paramToLiteral) {
+    // TODO: implement it
+  } else {
+    ctx.params.push(filter.value);
+    command += `ANY($${ctx.params.length}::${filter.itemType || "int"}[])`;
+  }
 
   return command;
 }
@@ -444,8 +473,13 @@ function buildContainsFilterQuery(ctx: BuildQueryContext, filter: FindRowRelatio
   let command = ctx.builder.quoteColumn(ctx.model, filter.field, ctx.emitTableAlias);
 
   command += " LIKE ";
-  ctx.params.push(`%${filter.value}%`);
-  command += "$" + ctx.params.length;
+
+  if (ctx.paramToLiteral) {
+    // TODO: implement it
+  } else {
+    ctx.params.push(`%${filter.value}%`);
+    command += "$" + ctx.params.length;
+  }
 
   return command;
 }
@@ -454,8 +488,12 @@ function buildNotContainsFilterQuery(ctx: BuildQueryContext, filter: FindRowRela
   let command = ctx.builder.quoteColumn(ctx.model, filter.field, ctx.emitTableAlias);
 
   command += " NOT LIKE ";
-  ctx.params.push(`%${filter.value}%`);
-  command += "$" + ctx.params.length;
+  if (ctx.paramToLiteral) {
+    // TODO: implement it
+  } else {
+    ctx.params.push(`%${filter.value}%`);
+    command += "$" + ctx.params.length;
+  }
 
   return command;
 }
@@ -464,8 +502,13 @@ function buildStartsWithFilterQuery(ctx: BuildQueryContext, filter: FindRowRelat
   let command = ctx.builder.quoteColumn(ctx.model, filter.field, ctx.emitTableAlias);
 
   command += " LIKE ";
-  ctx.params.push(`${filter.value}%`);
-  command += "$" + ctx.params.length;
+
+  if (ctx.paramToLiteral) {
+    // TODO: implement it
+  } else {
+    ctx.params.push(`${filter.value}%`);
+    command += "$" + ctx.params.length;
+  }
 
   return command;
 }
@@ -474,8 +517,13 @@ function buildNotStartsWithFilterQuery(ctx: BuildQueryContext, filter: FindRowRe
   let command = ctx.builder.quoteColumn(ctx.model, filter.field, ctx.emitTableAlias);
 
   command += " NOT LIKE ";
-  ctx.params.push(`${filter.value}%`);
-  command += "$" + ctx.params.length;
+
+  if (ctx.paramToLiteral) {
+    // TODO: implement it
+  } else {
+    ctx.params.push(`${filter.value}%`);
+    command += "$" + ctx.params.length;
+  }
 
   return command;
 }
@@ -484,8 +532,13 @@ function buildEndsWithFilterQuery(ctx: BuildQueryContext, filter: FindRowRelatio
   let command = ctx.builder.quoteColumn(ctx.model, filter.field, ctx.emitTableAlias);
 
   command += " LIKE ";
-  ctx.params.push(`%${filter.value}`);
-  command += "$" + ctx.params.length;
+
+  if (ctx.paramToLiteral) {
+    // TODO: implement it
+  } else {
+    ctx.params.push(`%${filter.value}`);
+    command += "$" + ctx.params.length;
+  }
 
   return command;
 }
@@ -494,8 +547,13 @@ function buildNotEndsWithFilterQuery(ctx: BuildQueryContext, filter: FindRowRela
   let command = ctx.builder.quoteColumn(ctx.model, filter.field, ctx.emitTableAlias);
 
   command += " NOT LIKE ";
-  ctx.params.push(`%${filter.value}`);
-  command += "$" + ctx.params.length;
+
+  if (ctx.paramToLiteral) {
+    // TODO: implement it
+  } else {
+    ctx.params.push(`%${filter.value}`);
+    command += "$" + ctx.params.length;
+  }
 
   return command;
 }
@@ -505,8 +563,32 @@ function buildRelationalFilterQuery(ctx: BuildQueryContext, filter: FindRowRelat
 
   command += relationalOperatorsMap.get(filter.operator);
 
-  ctx.params.push(filter.value);
-  command += "$" + ctx.params.length;
+  if (ctx.paramToLiteral) {
+    command += formatValueToSqlLiteral(filter.value);
+  } else {
+    ctx.params.push(filter.value);
+    command += "$" + ctx.params.length;
+  }
 
   return command;
 }
+
+function formatValueToSqlLiteral(value: any) {
+  if (isNull(value) || isUndefined(value)) {
+    return "null";
+  }
+
+  if (isString(value)) {
+    return `'${value.replaceAll("'", "''")}'`;
+  }
+
+  if (isBoolean(value)) {
+    return value ? "true" : "false";
+  }
+
+  if (isNumber(value)) {
+    return value.toString();
+  }
+
+  return `'${value.toString().replaceAll("'", "''")}'`;
+}