chore: address feedback around admin reindex endpoints

hrm-domain/hrm-core/case/adminCaseRoutesV0.ts

@@ -0,0 +1,46 @@
+/**
+ * Copyright (C) 2021-2023 Technology Matters
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see https://www.gnu.org/licenses/.
+ */
+
+import type { Request, Response, NextFunction } from 'express';
+import { isErr, mapHTTPError } from '@tech-matters/types';
+import { SafeRouter, publicEndpoint } from '../permissions';
+import { reindexCases } from './caseReindexService';
+
+const adminContactsRouter = SafeRouter();
+
+// admin POST endpoint to reindex contacts. req body has accountSid, dateFrom, dateTo
+adminContactsRouter.post(
+  '/reindex',
+  publicEndpoint,
+  async (req: Request, res: Response, next: NextFunction) => {
+    const { hrmAccountId } = req;
+    const { dateFrom, dateTo } = req.body;
+
+    const result = await reindexCases(hrmAccountId, dateFrom, dateTo);
+
+    if (isErr(result)) {
+      return next(
+        mapHTTPError(result, {
+          InvalidParameterError: 400,
+        }),
+      );
+    }
+
+    res.json(result.data);
+  },
+);
+
+export default adminContactsRouter.expressRouter;

hrm-domain/hrm-core/case/caseReindexService.ts

@@ -0,0 +1,74 @@
+/**
+ * Copyright (C) 2021-2023 Technology Matters
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see https://www.gnu.org/licenses/.
+ */
+
+import { HrmAccountId, newErr, newOkFromData } from '@tech-matters/types';
+import { CaseService, searchCases } from './caseService';
+import { publishCaseToSearchIndex } from '../jobs/search/publishToSearchIndex';
+import { maxPermissions } from '../permissions';
+import {
+  AsyncProcessor,
+  SearchFunction,
+  processInBatch,
+} from '@tech-matters/batch-processing';
+import formatISO from 'date-fns/formatISO';
+
+export const reindexCases = async (
+  accountSid: HrmAccountId,
+  dateFrom: string,
+  dateTo: string,
+) => {
+  try {
+    const filters = {
+      updatedAt: {
+        from: formatISO(new Date(dateFrom)),
+        to: formatISO(new Date(dateTo)),
+      },
+    };
+
+    const searchFunction: SearchFunction<CaseService> = async limitAndOffset => {
+      const res = await searchCases(
+        accountSid,
+        {
+          limit: limitAndOffset.limit.toString(),
+          offset: limitAndOffset.offset.toString(),
+        },
+        {},
+        { filters },
+        maxPermissions,
+      );
+      return { records: res.cases as CaseService[], count: res.count };
+    };
+
+    const asyncProcessor: AsyncProcessor<CaseService, void> = async casesResult => {
+      const promises = casesResult.records.map(caseObj => {
+        return publishCaseToSearchIndex({
+          accountSid,
+          case: caseObj,
+          operation: 'index',
+        });
+      });
+
+      await Promise.all(promises);
+    };
+
+    await processInBatch(searchFunction, asyncProcessor);
+
+    return newOkFromData('Successfully indexed contacts');
+  } catch (error) {
+    console.error('Error reindexing contacts', error);
+    return newErr({ error, message: 'Error reindexing contacts' });
+  }
+};

hrm-domain/hrm-core/contact/adminContactRoutesV0.ts

@@ -0,0 +1,46 @@
+/**
+ * Copyright (C) 2021-2023 Technology Matters
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see https://www.gnu.org/licenses/.
+ */
+
+import type { Request, Response, NextFunction } from 'express';
+import { isErr, mapHTTPError } from '@tech-matters/types';
+import { SafeRouter, publicEndpoint } from '../permissions';
+import { reindexContacts } from './contactsReindexService';
+
+const adminContactsRouter = SafeRouter();
+
+// admin POST endpoint to reindex contacts. req body has accountSid, dateFrom, dateTo
+adminContactsRouter.post(
+  '/reindex',
+  publicEndpoint,
+  async (req: Request, res: Response, next: NextFunction) => {
+    const { hrmAccountId } = req;
+    const { dateFrom, dateTo } = req.body;
+
+    const result = await reindexContacts(hrmAccountId, dateFrom, dateTo);
+
+    if (isErr(result)) {
+      return next(
+        mapHTTPError(result, {
+          InvalidParameterError: 400,
+        }),
+      );
+    }
+
+    res.json(result.data);
+  },
+);
+
+export default adminContactsRouter.expressRouter;

hrm-domain/hrm-core/contact/contactsReindexService.ts

@@ -0,0 +1,67 @@
+/**
+ * Copyright (C) 2021-2023 Technology Matters
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see https://www.gnu.org/licenses/.
+ */
+
+import { HrmAccountId, newErr, newOkFromData } from '@tech-matters/types';
+import { Contact, searchContacts } from './contactService';
+import { publishContactToSearchIndex } from '../jobs/search/publishToSearchIndex';
+import { maxPermissions } from '../permissions';
+import {
+  AsyncProcessor,
+  SearchFunction,
+  processInBatch,
+} from '@tech-matters/batch-processing';
+
+export const reindexContacts = async (
+  accountSid: HrmAccountId,
+  dateFrom: string,
+  dateTo: string,
+) => {
+  try {
+    const searchParameters = {
+      dateFrom,
+      dateTo,
+    };
+
+    const searchFunction: SearchFunction<Contact> = async limitAndOffset => {
+      const res = await searchContacts(
+        accountSid,
+        searchParameters,
+        limitAndOffset,
+        maxPermissions,
+      );
+      return { records: res.contacts, count: res.count };
+    };
+
+    const asyncProcessor: AsyncProcessor<Contact, void> = async contactsResult => {
+      const promises = contactsResult.records.map(contact => {
+        return publishContactToSearchIndex({
+          accountSid,
+          contact,
+          operation: 'index',
+        });
+      });
+
+      await Promise.all(promises);
+    };
+
+    await processInBatch(searchFunction, asyncProcessor);
+
+    return newOkFromData('Successfully indexed contacts');
+  } catch (error) {
+    console.error('Error reindexing contacts', error);
+    return newErr({ error, message: 'Error reindexing contacts' });
+  }
+};

hrm-domain/hrm-core/jobs/search/publishToSearchIndex.ts

@@ -37,7 +37,6 @@ const publishToSearchIndex = async ({
       JSON.stringify(message),
     );
     const queueUrl = await getSsmParameter(PENDING_INDEX_QUEUE_SSM_PATH);
-
     return await sendSqsMessage({
       queueUrl,
       message: JSON.stringify(message),

hrm-domain/hrm-core/package.json

@@ -25,6 +25,7 @@
   "dependencies": {
     "@tech-matters/hrm-search-config": "^1.0.0",
     "@tech-matters/hrm-types": "^1.0.0",
+    "@tech-matters/batch-processing": "^1.0.0",
     "@tech-matters/http": "^1.0.0",
     "@tech-matters/resources-service": "^1.0.0",
     "@tech-matters/s3-client": "^1.0.0",

hrm-domain/hrm-core/permissions/index.ts

@@ -15,16 +15,16 @@
  */
 
 import { SafeRouterRequest } from './safe-router';
+import { rulesMap } from './rulesMap';
+import { type InitializedCan, initializeCanForRules } from './initializeCanForRules';
+import { type RulesFile } from './rulesMap';
+import type { Request, Response, NextFunction } from 'express';
+import type { TwilioUser } from '@tech-matters/twilio-worker-auth';
+import type { AccountSID } from '@tech-matters/types';
 
 export { SafeRouter, publicEndpoint } from './safe-router';
-export { rulesMap } from './rulesMap';
-export { Actions, actionsMaps } from './actions';
-
-import { InitializedCan, initializeCanForRules } from './initializeCanForRules';
-import { RulesFile } from './rulesMap';
-import type { Request, Response, NextFunction } from 'express';
-import { TwilioUser } from '@tech-matters/twilio-worker-auth';
-import { AccountSID } from '@tech-matters/types';
+export { type Actions, actionsMaps } from './actions';
+export { rulesMap };
 
 declare global {
   namespace Express {
@@ -72,3 +72,18 @@ export const setupPermissions =
 export type RequestWithPermissions = SafeRouterRequest & {
   can: InitializedCan;
 };
+
+export const maxPermissions: {
+  user: TwilioUser;
+  can: () => boolean;
+  permissions: (typeof rulesMap)[keyof typeof rulesMap];
+} = {
+  can: () => true,
+  user: {
+    accountSid: 'ACxxx',
+    workerSid: 'WKxxx',
+    roles: ['supervisor'],
+    isSupervisor: true,
+  },
+  permissions: rulesMap.open,
+};

hrm-domain/hrm-core/routes.ts

@@ -24,6 +24,8 @@ import referrals from './referral/referral-routes-v0';
 import permissions from './permissions/permissions-routes-v0';
 import profiles from './profile/profileRoutesV0';
 import adminProfiles from './profile/adminProfileRoutesV0';
+import adminContacts from './contact/adminContactRoutesV0';
+import adminCases from './case/adminCaseRoutesV0';
 import { Permissions } from './permissions';
 
 export const HRM_ROUTES: {
@@ -49,7 +51,11 @@ export const apiV0 = (rules: Permissions) => {
 export const ADMIN_ROUTES: {
   path: string;
   routerFactory: () => Router;
-}[] = [{ path: '/profiles', routerFactory: () => adminProfiles }];
+}[] = [
+  { path: '/profiles', routerFactory: () => adminProfiles },
+  { path: '/contacts', routerFactory: () => adminContacts },
+  { path: '/cases', routerFactory: () => adminCases },
+];
 
 export const adminApiV0 = () => {
   const router: IRouter = Router();

hrm-domain/hrm-service/scripts/README.md

@@ -22,6 +22,8 @@ admin-cli
 |   ├── create:       # Create a new profile flag
 |   ├── edit:         # Edit an existing profile flag
 |   ├── delete:       # Delete an existing profile flag
+├── reindex
+| ├── hrm:            # Reindex contacts and cases based on date range
 ```
 
 ### Usage

hrm-domain/hrm-service/scripts/admin-commands/reindex.ts

@@ -0,0 +1,25 @@
+/**
+ * Copyright (C) 2021-2023 Technology Matters
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published
+ * by the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see https://www.gnu.org/licenses/.
+ */
+
+export const command = 'reindex <command>';
+export const desc = 'admin endpoints for reindexing contacts and cases';
+
+export const builder = function (yargs) {
+  return yargs.commandDir('reindex', {
+    exclude: /^(index|_)/,
+    extensions: ['ts'],
+  });
+};