All files / server/src/features/assignment/padg/utils runPadgAssignment.ts

97.91% Statements 47/48
100% Branches 9/9
100% Functions 10/10
97.67% Lines 42/43

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143                                                    50x 185x     368x 48x 11x       368x 41x 4x     4841x       162x   50x             37x         37x       37x               37x 37x   37x 37x 37x   37x 185x     185x   185x                 185x 185x 185x 185x                   185x 5x   180x   180x   180x 35x 35x       37x   37x     37x 1x                 1x     36x 36x   36x    
import eventassigner from "eventassigner-js";
import { clone, groupBy, shuffle } from "remeda";
import { config } from "shared/config";
import { AssignmentError } from "shared/types/api/errors";
import { ProgramItem } from "shared/types/models/programItem";
import { User } from "shared/types/models/user";
import {
  Result,
  makeErrorResult,
  makeSuccessResult,
} from "shared/utils/result";
import { calculateHappiness } from "server/features/assignment/padg/utils/calculateHappiness";
import { formatResults } from "server/features/assignment/utils/formatResults";
import { getEvents } from "server/features/assignment/utils/getEvents";
import { getGroups } from "server/features/assignment/utils/getGroups";
import { getList } from "server/features/assignment/utils/getList";
import { DirectSignupsForProgramItem } from "server/features/direct-signup/directSignupTypes";
import {
  ListItem,
  PadgError,
  PadgInput,
  PadgRandomAssignResult,
} from "server/types/assignmentTypes";
import { AssignmentAlgorithmResult, Input } from "server/types/resultTypes";
import { logger } from "server/utils/logger";
 
const sortList = (list: ListItem[], i: number): ListItem[] => {
  switch (i) {
    case 0:
      // Sort by gain, randomize between same gain values
      return Object.values(groupBy(list, (item) => item.gain)) // Group by gain
        .map((group) => shuffle(group)) // Shuffle each group
        .toSorted((a, b) => a[0].gain - b[0].gain) // Sort groups by gain, ascending
        .flat();
    case 1:
      // Sort by group size, randomize between groups of same size
      return Object.values(groupBy(list, (item) => item.size)) // Group by size
        .map((group) => shuffle(group)) // Shuffle each group
        .toSorted((a, b) => a[0].size - b[0].size) // Sort groups by size, ascending
        .flat();
    default:
      return list.toSorted((_a, _b) => 0.5 - Math.random());
  }
};
 
const updateL = (input: Input): string => input.list;
 
export const runPadgAssignment = (
  lotterySignupProgramItems: readonly ProgramItem[],
  attendeeGroups: readonly User[][],
  assignmentTime: string,
  lotteryParticipantDirectSignups: readonly DirectSignupsForProgramItem[],
  allProgramItems: readonly ProgramItem[],
): Result<AssignmentAlgorithmResult, AssignmentError> => {
  const groups = getGroups(
    attendeeGroups,
    assignmentTime,
    lotterySignupProgramItems,
  );
  const events = getEvents(
    lotterySignupProgramItems,
    lotteryParticipantDirectSignups,
  );
  const list = getList({
    attendeeGroups,
    assignmentTime,
    lotteryParticipantDirectSignups,
    lotterySignupProgramItems,
    allProgramItems,
  });
 
  logger.debug("PADG assignment: start");
  const { padgAssignmentRounds } = config.server();
 
  let finalHappiness = 0;
  let finalAssignResults: PadgRandomAssignResult[] = [];
  let anyRoundSucceeded = false;
 
  for (let i = 0; i < padgAssignmentRounds; i++) {
    logger.debug(`PADG algorithm round ${i + 1}`);
 
    // Bug in eventassigner-js: mutates input array
    const eventsCopy = clone(events);
 
    const input: PadgInput = {
      groups,
      events: eventsCopy,
      list: sortList(list, i),
      updateL,
    };
 
    let assignResults: PadgRandomAssignResult[] | PadgError | undefined;
 
    try {
      logger.debug("Run PADG algorithm: start");
      assignResults = eventassigner.eventAssignment(input);
      logger.debug("Run PADG algorithm: finished");
    } catch (error) {
      logger.error(
        new Error(
          `Padg assignment round failed: ${String(error)}. Input: ${JSON.stringify(input)}`,
        ),
      );
    }
 
    // Skip error results
    if (!Array.isArray(assignResults)) {
      continue;
    }
    anyRoundSucceeded = true;
 
    const happiness = calculateHappiness(assignResults, groups);
 
    if (happiness > finalHappiness) {
      finalHappiness = happiness;
      finalAssignResults = assignResults;
    }
  }
 
  logger.debug(`Padg assignment completed with happiness ${finalHappiness}%`);
 
  logger.debug("PADG assignment: completed");
 
  // Every round failed (eventassigner threw or returned a non-array each time)
  if (!anyRoundSucceeded) {
    logger.error(
      new Error(
        `Padg assignment for start time ${assignmentTime} failed with input: groups: ${JSON.stringify(
          groups,
        )}, events: ${JSON.stringify(events)}, list: ${JSON.stringify(
          list,
        )}, updateL: ${JSON.stringify(updateL)}`,
      ),
    );
    return makeErrorResult(AssignmentError.UNKNOWN_ERROR);
  }
 
  const results = formatResults(finalAssignResults, attendeeGroups);
  const message = "Padg assignment completed";
 
  return makeSuccessResult({ results, message });
};