Merge pull request #70 from UN-OCHA/HPC-8149

🐛 HPC-8149: Don't include deleted data by default

package.json

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

src/db/util/id-model.ts

@@ -7,7 +7,11 @@ import {
   FieldDefinition,
   InstanceDataOf,
 } from './model-definition';
-import { defineSequelizeModel, FieldsWithSequelize } from './sequelize-model';
+import {
+  AdditionalFindArgsForSequelizeTables,
+  defineSequelizeModel,
+  FieldsWithSequelize,
+} from './sequelize-model';
 import { Op } from './conditions';
 
 /**
@@ -32,7 +36,7 @@ type IdOf<
 export interface ModelWithId<
   F extends FieldDefinition,
   IDField extends null | keyof F['generated']
-> extends Model<F> {
+> extends Model<F, AdditionalFindArgsForSequelizeTables> {
   readonly get: (id: IdOf<F, IDField>) => Promise<null | InstanceDataOf<F>>;
   readonly getAll: (
     id: Iterable<IdOf<F, IDField>>

src/db/util/raw-model.ts

@@ -33,18 +33,22 @@ export type OrderByCond<F extends FieldDefinition> = {
   order?: 'asc' | 'desc';
 };
 
-export type FindFn<F extends FieldDefinition> = (args?: {
-  where?: WhereCond<F>;
-  limit?: number;
-  offset?: number;
-  orderBy?: OrderByCond<F> | Array<OrderByCond<F>>;
-  trx?: Knex.Transaction<any, any>;
-}) => Promise<Array<InstanceDataOf<F>>>;
+export type FindFn<F extends FieldDefinition, AdditionalArgs = {}> = (
+  args?: {
+    where?: WhereCond<F>;
+    limit?: number;
+    offset?: number;
+    orderBy?: OrderByCond<F> | Array<OrderByCond<F>>;
+    trx?: Knex.Transaction<any, any>;
+  } & AdditionalArgs
+) => Promise<Array<InstanceDataOf<F>>>;
 
-export type FindOneFn<F extends FieldDefinition> = (args: {
-  where: WhereCond<F>;
-  trx?: Knex.Transaction<any, any>;
-}) => Promise<InstanceDataOf<F> | null>;
+export type FindOneFn<F extends FieldDefinition, AdditionalArgs = {}> = (
+  args: {
+    where: WhereCond<F>;
+    trx?: Knex.Transaction<any, any>;
+  } & AdditionalArgs
+) => Promise<InstanceDataOf<F> | null>;
 
 export type UpdateFn<F extends FieldDefinition> = (args: {
   values: Partial<UserDataOf<F>>;
@@ -67,12 +71,12 @@ export type ModelInternals<F extends FieldDefinition> = {
 /**
  * The definition of a model
  */
-export type Model<F extends FieldDefinition> = {
+export type Model<F extends FieldDefinition, AdditionalFindArgs = {}> = {
   readonly _internals: ModelInternals<F>;
   readonly create: CreateFn<F>;
   readonly createMany: CreateManyFn<F>;
-  readonly find: FindFn<F>;
-  readonly findOne: FindOneFn<F>;
+  readonly find: FindFn<F, AdditionalFindArgs>;
+  readonly findOne: FindOneFn<F, AdditionalFindArgs>;
   readonly update: UpdateFn<F>;
   readonly destroy: DestroyFn<F>;
 };
@@ -84,9 +88,10 @@ export type InstanceDataOfModel<M extends Model<any>> = M extends Model<infer F>
 /**
  * A function that takes a knex connection and returns the model definition
  */
-export type ModelInitializer<F extends FieldDefinition> = (
-  conn: Knex
-) => Model<F>;
+export type ModelInitializer<
+  F extends FieldDefinition,
+  AdditionalFindArgs = {}
+> = (conn: Knex) => Model<F, AdditionalFindArgs>;
 
 export const defineRawModel =
   <F extends FieldDefinition>(opts: {

src/db/util/sequelize-model.ts

@@ -11,8 +11,11 @@ import {
   CreateFn,
   CreateManyFn,
   UpdateFn,
+  FindFn,
+  FindOneFn,
 } from './raw-model';
 import { FieldDefinition } from './model-definition';
+import { Cond, Op } from './conditions';
 
 type DeletedAtField<SoftDeletionEnabled extends boolean> =
   SoftDeletionEnabled extends true
@@ -60,6 +63,15 @@ const genDeletedAtField = <P extends boolean>(
       }
     : {}) as DeletedAtField<P>;
 
+export type AdditionalFindArgsForSequelizeTables = {
+  /**
+   * If true, also include deleted records in the result.
+   *
+   * This only affects tables with softDeletionEnabled set to true
+   */
+  includeDeleted?: true;
+};
+
 /**
  * A model that has been defined by sequelize
  *
@@ -78,7 +90,10 @@ export const defineSequelizeModel =
      */
     genIdentifier?: (data: unknown) => string;
     softDeletionEnabled: SoftDeletionEnabled;
-  }): ModelInitializer<FieldsWithSequelize<F, SoftDeletionEnabled>> =>
+  }): ModelInitializer<
+    FieldsWithSequelize<F, SoftDeletionEnabled>,
+    AdditionalFindArgsForSequelizeTables
+  > =>
   (conn) => {
     type Fields = FieldsWithSequelize<F, SoftDeletionEnabled>;
 
@@ -93,6 +108,50 @@ export const defineSequelizeModel =
       fields,
     })(conn);
 
+    const find: FindFn<Fields, AdditionalFindArgsForSequelizeTables> = (
+      args
+    ) => {
+      if (args?.includeDeleted || !opts.softDeletionEnabled) {
+        return model.find(args);
+      } else {
+        return model.find({
+          ...args,
+          where: {
+            [Cond.AND]: [
+              {
+                deletedAt: {
+                  [Op.IS_NULL]: true,
+                },
+              },
+              args?.where || {},
+            ],
+          },
+        });
+      }
+    };
+
+    const findOne: FindOneFn<Fields, AdditionalFindArgsForSequelizeTables> = (
+      args
+    ) => {
+      if (args?.includeDeleted || !opts.softDeletionEnabled) {
+        return model.findOne(args);
+      } else {
+        return model.findOne({
+          ...args,
+          where: {
+            [Cond.AND]: [
+              {
+                deletedAt: {
+                  [Op.IS_NULL]: true,
+                },
+              },
+              args?.where || {},
+            ],
+          },
+        });
+      }
+    };
+
     const create: CreateFn<Fields> = (data, opts) => {
       return model.create(
         {
@@ -127,6 +186,8 @@ export const defineSequelizeModel =
 
     return {
       ...model,
+      find,
+      findOne,
       create,
       createMany,
       update,