Feat: replace active quantifier

CHANGELOG.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ### Added
+- Admins can replace an actively assigned quantifier with another
 
 ### Fixed
 

packages/api/package.json

@@ -14,7 +14,6 @@
     "test": "NODE_ENV=testing yarn run load-env nyc mocha -r ts-node/register -r tsconfig-paths/register -r src/tests/setup.ts 'src/tests/**/*.spec.ts' --exit",
     "import-praise": "yarn run load-env ts-node -r tsconfig-paths/register src/scripts/import-praise.ts",
     "not-yet-activated": "yarn run load-env ts-node -r tsconfig-paths/register src/scripts/not-yet-activated.ts",
-    "replace-quantifier": "yarn run load-env ts-node -r tsconfig-paths/register src/scripts/replace-quantifier.ts",
     "migrator": "yarn run load-env ts-node -r tsconfig-paths/register src/scripts/umzug-cli.ts",
     "drop-database": "yarn run load-env ts-node -r tsconfig-paths/register src/scripts/drop-database.ts"
   },
@@ -80,4 +79,4 @@
     "typescript": "^4.5.4",
     "yargs": "^17.3.1"
   }
-}
+}

packages/api/src/period/controllers/assignment.ts

@@ -28,13 +28,15 @@ import {
   PeriodDetailsDto,
   PeriodStatusType,
   VerifyQuantifierPoolSizeResponse,
+  PeriodReplaceQuantifierDto,
 } from '../types';
 import {
   findPeriodDetailsDto,
-  getPreviousPeriodEndDate,
   verifyAnyPraiseAssigned,
+  getPeriodDateRangeQuery,
 } from '../utils';
 import { PeriodModel } from '../entities';
+import { praiseDocumentListTransformer } from '@praise/transformers';
 
 /**
  * Get all receivers with praise data
@@ -44,12 +46,12 @@ import { PeriodModel } from '../entities';
 const queryReceiversWithPraise = async (
   period: PeriodDocument
 ): Promise<Receiver[]> => {
-  const previousPeriodEndDate = await getPreviousPeriodEndDate(period);
+  const dateRangeQuery = await getPeriodDateRangeQuery(period);
 
   return PraiseModel.aggregate([
     {
       $match: {
-        createdAt: { $gt: previousPeriodEndDate, $lte: period.endDate },
+        createdAt: dateRangeQuery,
       },
     },
     {
@@ -215,10 +217,10 @@ const verifyAssignments = async (
   PRAISE_QUANTIFIERS_PER_PRAISE_RECEIVER: number,
   assignments: Assignments
 ): Promise<void> => {
-  const previousPeriodEndDate = await getPreviousPeriodEndDate(period);
+  const dateRangeQuery = await getPeriodDateRangeQuery(period);
 
   const totalPraiseCount: number = await PraiseModel.count({
-    createdAt: { $gt: previousPeriodEndDate, $lte: period.endDate },
+    createdAt: dateRangeQuery,
   });
   const expectedAccountedPraiseCount: number =
     totalPraiseCount * PRAISE_QUANTIFIERS_PER_PRAISE_RECEIVER;
@@ -561,3 +563,101 @@ export const assignQuantifiers = async (
   const periodDetailsDto = await findPeriodDetailsDto(periodId);
   res.status(StatusCodes.OK).json(periodDetailsDto);
 };
+
+export const replaceQuantifier = async (
+  req: Request,
+  res: TypedResponse<PeriodReplaceQuantifierDto>
+): Promise<void> => {
+  const { periodId } = req.params;
+  const { currentQuantifierId, newQuantifierId } = req.body;
+  const period = await PeriodModel.findById(periodId);
+  if (!period) throw new NotFoundError('Period');
+  if (period.status !== 'QUANTIFY')
+    throw new BadRequestError(
+      'Quantifiers can only be replaced on periods with status QUANTIFY.'
+    );
+
+  if (!currentQuantifierId || !newQuantifierId)
+    throw new BadRequestError(
+      'Both originalQuantifierId and newQuantifierId must be specified'
+    );
+
+  if (currentQuantifierId === newQuantifierId)
+    throw new BadRequestError('Cannot replace a quantifier with themselves');
+
+  const currentQuantifier = await UserModel.findById(currentQuantifierId);
+  if (!currentQuantifier)
+    throw new BadRequestError('Current quantifier does not exist');
+
+  const newQuantifier = await UserModel.findById(newQuantifierId);
+  if (!newQuantifier)
+    throw new BadRequestError('Replacement quantifier does not exist');
+
+  if (!newQuantifier.roles.includes(UserRole.QUANTIFIER))
+    throw new BadRequestError(
+      'Replacement quantifier does not have role QUANTIFIER'
+    );
+
+  const dateRangeQuery = await getPeriodDateRangeQuery(period);
+  const affectedPraiseIds = await PraiseModel.find({
+    // Praise within time period
+    createdAt: dateRangeQuery,
+
+    // Original quantifier
+    'quantifications.quantifier': currentQuantifierId,
+  }).distinct('_id');
+
+  await PraiseModel.updateMany(
+    {
+      // Praise within time period
+      createdAt: dateRangeQuery,
+
+      // Original quantifier
+      'quantifications.quantifier': currentQuantifierId,
+    },
+    {
+      $set: {
+        // Reset score
+        'quantifications.$[elem].score': 0,
+        'quantifications.$[elem].dismissed': false,
+
+        // Assign new quantifier
+        'quantifications.$[elem].quantifier': newQuantifierId,
+      },
+      $unset: {
+        'quantifications.$[elem].duplicatePraise': 1,
+      },
+    },
+    {
+      arrayFilters: [
+        {
+          'elem.quantifier': currentQuantifierId,
+        },
+      ],
+    }
+  );
+
+  await logEvent(
+    EventLogTypeKey.PERIOD,
+    `Reassigned all praise in period "${
+      period.name
+    }" that is currently assigned to user with id "${
+      currentQuantifierId as string
+    }", to user with id "${newQuantifierId as string}"`,
+    {
+      userId: res.locals.currentUser._id,
+    }
+  );
+
+  const updatedPraises = await PraiseModel.find({
+    _id: { $in: affectedPraiseIds },
+  }).populate('giver receiver forwarder');
+
+  const affectedPraises = await praiseDocumentListTransformer(updatedPraises);
+  const periodDetailsDto = await findPeriodDetailsDto(periodId);
+
+  res.status(StatusCodes.OK).json({
+    period: periodDetailsDto,
+    praises: affectedPraises,
+  });
+};

packages/api/src/period/routes.ts

@@ -1,33 +1,32 @@
 import { Router } from '@awaitjs/express';
-import * as periodController from '@period/controllers';
+import * as core from '@period/controllers/core';
+import * as assignment from '@period/controllers/assignment';
 
 // Period-routes
 const periodRouter = Router();
 
-periodRouter.getAsync('/all', periodController.all);
-periodRouter.getAsync('/:periodId', periodController.single);
-periodRouter.getAsync(
-  '/:periodId/receiverPraise',
-  periodController.receiverPraise
-);
-periodRouter.getAsync(
-  '/:periodId/quantifierPraise',
-  periodController.quantifierPraise
-);
+periodRouter.getAsync('/all', core.all);
+periodRouter.getAsync('/:periodId', core.single);
+periodRouter.getAsync('/:periodId/receiverPraise', core.receiverPraise);
+periodRouter.getAsync('/:periodId/quantifierPraise', core.quantifierPraise);
 
 // ADMIN Period-routes
 const adminPeriodRouter = Router();
-adminPeriodRouter.postAsync('/create', periodController.create);
-adminPeriodRouter.patchAsync('/:periodId/update', periodController.update);
-adminPeriodRouter.patchAsync('/:periodId/close', periodController.close);
+adminPeriodRouter.postAsync('/create', core.create);
+adminPeriodRouter.patchAsync('/:periodId/update', core.update);
+adminPeriodRouter.patchAsync('/:periodId/close', core.close);
 adminPeriodRouter.getAsync(
   '/:periodId/verifyQuantifierPoolSize',
-  periodController.verifyQuantifierPoolSize
+  assignment.verifyQuantifierPoolSize
 );
 adminPeriodRouter.patchAsync(
   '/:periodId/assignQuantifiers',
-  periodController.assignQuantifiers
+  assignment.assignQuantifiers
+);
+adminPeriodRouter.patchAsync(
+  '/:periodId/replaceQuantifier',
+  assignment.replaceQuantifier
 );
-adminPeriodRouter.getAsync('/:periodId/export', periodController.exportPraise);
+adminPeriodRouter.getAsync('/:periodId/export', core.exportPraise);
 
 export { periodRouter, adminPeriodRouter };

packages/api/src/period/types.ts

@@ -3,6 +3,7 @@ import {
   QuantificationDocument,
   QuantificationDto,
   Quantification,
+  PraiseDto,
 } from '@praise/types';
 import { Query } from '@shared/types';
 import { UserAccountDocument, UserAccountDto } from '@useraccount/types';
@@ -103,3 +104,8 @@ export interface PeriodDateRange {
   $gt: Date;
   $lte: Date;
 }
+
+export interface PeriodReplaceQuantifierDto {
+  period: PeriodDetailsDto;
+  praises: PraiseDto[];
+}

packages/frontend/src/pages/QuantifyPeriodReceiver/components/MarkDuplicateButton.tsx → packages/frontend/src/components/IconButton.tsx

@@ -1,13 +1,17 @@
+import { IconProp } from '@fortawesome/fontawesome-svg-core';
 import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
-import { faCopy } from '@fortawesome/free-solid-svg-icons';
 
 interface Props {
   disabled?: boolean;
+  icon: IconProp;
+  text: string;
   onClick();
 }
 
-const MarkDuplicateButton = ({
+const IconButton = ({
   disabled = false,
+  icon,
+  text,
   onClick,
 }: Props): JSX.Element => {
   return (
@@ -20,10 +24,10 @@ const MarkDuplicateButton = ({
       }
       onClick={onClick}
     >
-      <FontAwesomeIcon icon={faCopy} size="1x" />
-      <span>Mark as duplicates</span>
+      <FontAwesomeIcon icon={icon} size="1x" />
+      <span>{text}</span>
     </button>
   );
 };
 
-export default MarkDuplicateButton;
+export default IconButton;