Merge pull request #102 from UN-OCHA/skip-validation

Add `skipValidation` support to `find` and `update` methods

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unocha/hpc-api-core",
-  "version": "4.4.3",
+  "version": "4.4.4",
   "description": "Core libraries supporting HPC.Tools API Backend",
   "license": "Apache-2.0",
   "private": false,

src/db/util/raw-model.ts

@@ -39,6 +39,11 @@ export type FindFn<F extends FieldDefinition, AdditionalArgs = {}> = (
     limit?: number;
     offset?: number;
     orderBy?: OrderByCond<F> | Array<OrderByCond<F>>;
+    /**
+     * WARNING: Only use this in very rare cases when performance gains
+     * from disabling validation are worth the risk!
+     */
+    skipValidation?: boolean;
     trx?: Knex.Transaction<any, any>;
   } & AdditionalArgs
 ) => Promise<Array<InstanceDataOf<F>>>;
@@ -53,6 +58,11 @@ export type FindOneFn<F extends FieldDefinition, AdditionalArgs = {}> = (
 export type UpdateFn<F extends FieldDefinition> = (args: {
   values: Partial<UserDataOf<F>>;
   where: WhereCond<F>;
+  /**
+   * WARNING: Only use this in very rare cases when performance gains
+   * from disabling validation are worth the risk!
+   */
+  skipValidation?: boolean;
   trx?: Knex.Transaction<any, any>;
 }) => Promise<Array<InstanceDataOf<F>>>;
 
@@ -138,6 +148,7 @@ export const defineRawModel =
       limit,
       offset,
       orderBy,
+      skipValidation = false,
       trx,
     } = {}) => {
       const builder = trx ? tbl().transacting(trx) : tbl();
@@ -159,6 +170,11 @@ export const defineRawModel =
       }
 
       const res = await query;
+
+      if (skipValidation) {
+        return res as Instance[];
+      }
+
       return res.map(validateAndFilter);
     };
 
@@ -173,12 +189,22 @@ export const defineRawModel =
       }
     };
 
-    const update: UpdateFn<F> = async ({ values, where, trx }) => {
+    const update: UpdateFn<F> = async ({
+      values,
+      where,
+      skipValidation = false,
+      trx,
+    }) => {
       const builder = trx ? tbl().transacting(trx) : tbl();
       const res = await builder
         .where(prepareCondition(where || {}))
         .update(values as any)
         .returning('*');
+
+      if (skipValidation) {
+        return res as Instance[];
+      }
+
       return (res as unknown[]).map(validateAndFilter);
     };