All files / server/src/features/program-item programItemUtils.ts

91.05% Statements 112/123
81.81% Branches 54/66
100% Functions 24/24
90.98% Lines 111/122

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 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395                                                                    58x             427x 290x           427x 427x   427x 6123x         6123x 6069x         54x         5022x       5022x 16x 5015x 12x       427x     58x                 427x   427x 14x             427x 10x                 427x     1421x 260x   427x 18x             427x             58x               427x         427x 1421x           427x   259x       258x       260x             427x     427x   427x       427x 24x     24x     24x         427x 18x       18x 18x       18x 18x     18x         427x     58x       713x 713x     713x   713x 713x     713x 713x     713x   713x 6480x 6477x   6480x                                     713x     58x         6480x       6480x 6480x       6480x           6480x 3x         6480x 4372x     6479x 870x     6476x     6476x 7x     6475x     58x             6480x   6480x 6484x       6480x 6480x 100x       58x         88x             6480x     58x       144x 137x     121x     58x       427x 385x   267x   48x     188x     188x   42x   48x 54x   48x     48x                   188x 20x 20x       20x     188x    
import dayjs, { Dayjs } from "dayjs";
import { config } from "shared/config";
import { EventSignupStrategy } from "shared/config/eventConfigTypes";
import { MongoDbError } from "shared/types/api/errors";
import { EventLogAction } from "shared/types/models/eventLog";
import {
  ProgramItem,
  ProgramItemSignupStrategy,
  ProgramItemWithUserSignups,
  ProgramType,
  SignupType,
  State,
  UserSignup,
} from "shared/types/models/programItem";
import { Settings, SignupQuestion } from "shared/types/models/settings";
import { UserGroup } from "shared/types/models/user";
import { isLotterySignupProgramItem } from "shared/utils/isLotterySignupProgramItem";
import { differenceBy } from "shared/utils/remedaExtend";
import { Result, makeSuccessResult } from "shared/utils/result";
import { tooEarlyForLotterySignup } from "shared/utils/tooEarlyForLotterySignup";
import { getTimeNow } from "server/features/assignment/utils/getTimeNow";
import {
  delDirectSignupDocumentsByProgramItemIds,
  findDirectSignups,
  findDirectSignupsByProgramItemIds,
  resetDirectSignupsByProgramItemIds,
} from "server/features/direct-signup/directSignupRepository";
import { DirectSignupsForProgramItem } from "server/features/direct-signup/directSignupTypes";
import { queueCancelledDeletedEmails } from "server/features/notifications/queueCancelledDeletedEmails";
import { removeProgramItems } from "server/features/program-item/programItemRepository";
import { findOrCreateSettings } from "server/features/settings/settingsRepository";
import { addEventLogItems } from "server/features/user/event-log/eventLogRepository";
import { logger } from "server/utils/logger";
 
const getCancelledProgramItems = (
  updatedProgramItems: readonly ProgramItem[],
  currentProgramItems: readonly ProgramItem[],
): {
  cancelledProgramItemIds: string[];
  signupTypeChangedProgramItemIds: string[];
} => {
  const currentProgramItemsMap = new Map(
    currentProgramItems.map((currentProgramItem) => [
      currentProgramItem.programItemId,
      currentProgramItem,
    ]),
  );
 
  const cancelledProgramItemIds: string[] = [];
  const signupTypeChangedProgramItemIds: string[] = [];
 
  for (const updatedProgramItem of updatedProgramItems) {
    const currentProgramItem = currentProgramItemsMap.get(
      updatedProgramItem.programItemId,
    );
 
    // Newly added program item not yet in DB
    if (!currentProgramItem) {
      continue;
    }
 
    // Program item marked as 'cancelled'
    const programItemCancelled =
      currentProgramItem.state === State.ACCEPTED &&
      updatedProgramItem.state === State.CANCELLED;
 
    // Program item no longer using 'konsti' sign-up type
    const programItemKonstiSignupRemoved =
      currentProgramItem.signupType === SignupType.KONSTI &&
      updatedProgramItem.signupType !== SignupType.KONSTI;
 
    // Cancellation takes precedence when both changed in the same update
    if (programItemCancelled) {
      cancelledProgramItemIds.push(updatedProgramItem.programItemId);
    } else if (programItemKonstiSignupRemoved) {
      signupTypeChangedProgramItemIds.push(updatedProgramItem.programItemId);
    }
  }
 
  return { cancelledProgramItemIds, signupTypeChangedProgramItemIds };
};
 
const getCancelledAndDeletedProgramItems = (
  updatedProgramItems: readonly ProgramItem[],
  currentProgramItems: readonly ProgramItem[],
): {
  cancelledProgramItemIds: string[];
  signupTypeChangedProgramItemIds: string[];
  deletedProgramItemIds: string[];
} => {
  const { cancelledProgramItemIds, signupTypeChangedProgramItemIds } =
    getCancelledProgramItems(updatedProgramItems, currentProgramItems);
 
  if (cancelledProgramItemIds.length > 0) {
    logger.info(
      `Found ${
        cancelledProgramItemIds.length
      } cancelled program items: ${cancelledProgramItemIds.join(", ")}`,
    );
  }
 
  if (signupTypeChangedProgramItemIds.length > 0) {
    logger.info(
      `Found ${
        signupTypeChangedProgramItemIds.length
      } program items no longer using Konsti signup: ${signupTypeChangedProgramItemIds.join(
        ", ",
      )}`,
    );
  }
 
  const deletedProgramItemIds = differenceBy(
    currentProgramItems,
    updatedProgramItems,
    (programItem) => programItem.programItemId,
  ).map((p) => p.programItemId);
 
  if (deletedProgramItemIds.length > 0) {
    logger.info(
      `Found ${
        deletedProgramItemIds.length
      } deleted program items: ${deletedProgramItemIds.join(", ")}`,
    );
  }
 
  return {
    cancelledProgramItemIds,
    signupTypeChangedProgramItemIds,
    deletedProgramItemIds,
  };
};
 
export const handleCancelledDeletedProgramItems = async (
  updatedProgramItems: readonly ProgramItem[],
  currentProgramItems: readonly ProgramItem[],
): Promise<Result<DirectSignupsForProgramItem[], MongoDbError>> => {
  const {
    cancelledProgramItemIds,
    signupTypeChangedProgramItemIds,
    deletedProgramItemIds,
  } = getCancelledAndDeletedProgramItems(
    updatedProgramItems,
    currentProgramItems,
  );
 
  const programItemTitlesById = new Map(
    [...updatedProgramItems, ...currentProgramItems].map((programItem) => [
      programItem.programItemId,
      programItem.title,
    ]),
  );
 
  const notifyUsersWithDirectSignupsResult = await notifyUsersWithDirectSignups(
    [
      ...cancelledProgramItemIds.map((programItemId) => ({
        programItemId,
        action: EventLogAction.PROGRAM_ITEM_CANCELLED,
      })),
      ...signupTypeChangedProgramItemIds.map((programItemId) => ({
        programItemId,
        action: EventLogAction.PROGRAM_ITEM_NO_KONSTI_SIGNUP_ANYMORE,
      })),
      ...deletedProgramItemIds.map((programItemId) => ({
        programItemId,
        action: EventLogAction.PROGRAM_ITEM_DELETED,
      })),
    ],
    programItemTitlesById,
  );
  Iif (!notifyUsersWithDirectSignupsResult.ok) {
    return notifyUsersWithDirectSignupsResult;
  }
  const affectedDirectSignups = notifyUsersWithDirectSignupsResult.value;
 
  const removeDirectSignupsProgramItemIds = [
    ...cancelledProgramItemIds,
    ...signupTypeChangedProgramItemIds,
  ];
  if (removeDirectSignupsProgramItemIds.length > 0) {
    logger.info(
      "Remove direct signups if program item is cancelled or not using Konsti signup anymore",
    );
    const resetSignupDocumentsResult = await resetDirectSignupsByProgramItemIds(
      removeDirectSignupsProgramItemIds,
    );
    Iif (!resetSignupDocumentsResult.ok) {
      return resetSignupDocumentsResult;
    }
  }
 
  if (deletedProgramItemIds.length > 0) {
    logger.info(
      "Remove direct signups and signup document for deleted program items",
    );
    const delSignupDocumentsResult =
      await delDirectSignupDocumentsByProgramItemIds(deletedProgramItemIds);
    Iif (!delSignupDocumentsResult.ok) {
      return delSignupDocumentsResult;
    }
 
    logger.info("Remove deleted program items");
    const removeProgramItemsResult = await removeProgramItems(
      deletedProgramItemIds,
    );
    Iif (!removeProgramItemsResult.ok) {
      return removeProgramItemsResult;
    }
  }
 
  return makeSuccessResult(affectedDirectSignups);
};
 
export const enrichProgramItems = async (
  programItems: readonly ProgramItem[],
  userGroup: UserGroup | null,
): Promise<Result<ProgramItemWithUserSignups[], MongoDbError>> => {
  const settingsResult = await findOrCreateSettings();
  Iif (!settingsResult.ok) {
    return settingsResult;
  }
  const settings = settingsResult.value;
 
  const signupsResult = await findDirectSignups();
  Iif (!signupsResult.ok) {
    return signupsResult;
  }
  const currentTimeResult = await getTimeNow();
  Iif (!currentTimeResult.ok) {
    return currentTimeResult;
  }
  const currentTime = currentTimeResult.value;
 
  const enrichedProgramItems = programItems.map((programItem) => {
    const signupQuestion = settings.signupQuestions.find(
      (message) => message.programItemId === programItem.programItemId,
    );
    return {
      programItem: {
        ...programItem,
        signupStrategy: getSignupStrategyForProgramItem(
          programItem,
          settings,
          currentTime,
        ),
      },
      users: getDirectSignupsForProgramItem(
        signupsResult.value,
        programItem.programItemId,
        programItem.programType,
        userGroup,
        signupQuestion,
      ),
    };
  });
 
  return makeSuccessResult(enrichedProgramItems);
};
 
const getSignupStrategyForProgramItem = (
  programItem: ProgramItem,
  settings: Settings,
  currentTime: Dayjs,
): ProgramItemSignupStrategy => {
  const parentStartTime = config
    .event()
    .startTimesByParentIds.get(programItem.parentId);
 
  const start = dayjs(parentStartTime ?? programItem.startTime);
  const { directSignupPhaseStart } = config.event();
 
  // lottery
 
  Iif (settings.signupStrategy === EventSignupStrategy.LOTTERY) {
    return ProgramItemSignupStrategy.LOTTERY;
  }
 
  // direct
 
  Iif (settings.signupStrategy === EventSignupStrategy.DIRECT) {
    return ProgramItemSignupStrategy.DIRECT;
  }
 
  // lottery+direct
 
  if (!isLotterySignupProgramItem(programItem)) {
    return ProgramItemSignupStrategy.DIRECT;
  }
 
  if (tooEarlyForLotterySignup(programItem)) {
    return ProgramItemSignupStrategy.DIRECT;
  }
 
  const isAfterDirectSignupStarted = currentTime.isAfter(
    start.subtract(directSignupPhaseStart, "minutes"),
  );
  if (isAfterDirectSignupStarted) {
    return ProgramItemSignupStrategy.DIRECT;
  }
 
  return ProgramItemSignupStrategy.LOTTERY;
};
 
const getDirectSignupsForProgramItem = (
  directSignups: DirectSignupsForProgramItem[],
  programItemId: string,
  programType: ProgramType,
  userGroup: UserGroup | null,
  signupQuestion?: SignupQuestion,
): UserSignup[] => {
  const { hideParticipantListProgramTypes } = config.event();
 
  const directSignupsForProgramItem = directSignups.filter(
    (signup) => signup.programItemId === programItemId,
  );
 
  const formattedDirectSignupsForProgramItem =
    directSignupsForProgramItem.flatMap((directSignupForProgramItem) => {
      return directSignupForProgramItem.userSignups.map((userSignups) => {
        if (
          hideParticipantListProgramTypes.includes(programType) &&
          !(userGroup === UserGroup.ADMIN || userGroup === UserGroup.HELPER)
        ) {
          return {
            username: "redacted",
            signupMessage: "redacted",
          };
        }
        return {
          username: userSignups.username,
          signupMessage: getSignupMessage(signupQuestion, userSignups.message),
        };
      });
    });
 
  return formattedDirectSignupsForProgramItem;
};
 
export const getSignupMessage = (
  signupQuestion: SignupQuestion | undefined,
  signupMessage: string,
): string => {
  if (!signupQuestion || signupQuestion.private) {
    return "";
  }
 
  return signupMessage;
};
 
const notifyUsersWithDirectSignups = async (
  programItemActions: { programItemId: string; action: EventLogAction }[],
  programItemTitlesById: Map<string, string>,
): Promise<Result<DirectSignupsForProgramItem[], MongoDbError>> => {
  if (programItemActions.length === 0) {
    return makeSuccessResult([]);
  }
  const directSignupsResult = await findDirectSignupsByProgramItemIds(
    programItemActions.map(
      (programItemAction) => programItemAction.programItemId,
    ),
  );
  Iif (!directSignupsResult.ok) {
    return directSignupsResult;
  }
  const directSignups = directSignupsResult.value;
 
  const userUpdates = programItemActions.flatMap(
    ({ programItemId, action }) => {
      const directSignup = directSignups.find(
        (signup) => signup.programItemId === programItemId,
      );
      Iif (!directSignup) {
        return [];
      }
      return directSignup.userSignups.map((userSignup) => ({
        username: userSignup.username,
        programItemId,
        programItemStartTime: userSignup.signedToStartTime,
        createdAt: dayjs().toISOString(),
        action,
      }));
    },
  );
 
  if (userUpdates.length > 0) {
    const addEventLogItemsResult = await addEventLogItems(userUpdates);
    Iif (!addEventLogItemsResult.ok) {
      return addEventLogItemsResult;
    }
 
    await queueCancelledDeletedEmails(userUpdates, programItemTitlesById);
  }
 
  return makeSuccessResult(directSignups);
};