All files / server/src/features/direct-signup directSignupRepository.ts

73.29% Statements 129/176
62.5% Branches 20/32
100% Functions 29/29
73.14% Lines 128/175

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 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605                                                54x     288x 288x 288x 288x                 54x     904x 904x   904x   904x 10586x 10586x               10586x     904x                 54x     62x 62x       62x             62x       62x   62x 71x 71x                 71x     62x                               54x       64x   3548x   550x   64x 64x       64x   64x 553x 553x               553x       64x 553x           64x                     54x     333x 333x       333x   333x 32x 32x               32x     333x                     54x                   130x     130x     130x     130x 130x                                               130x 11x     11x     11x   11x             11x     122x       119x 122x                 122x                     54x       65x   337x     65x   65x     128x 5784x   128x       128x 128x   3x         3x 3x 3x     128x                           326x                                       65x 65x 65x 65x                                 54x           13x 13x                               13x 4x         4x     9x 6x     9x                 9x           9x 9x                 9x                         54x     64x 59x     20x 5x 7x                           5x 5x                 54x     18x 18x     18x                           54x     26x 26x           26x                     54x         63x 3544x 2347x   63x 63x                                                     63x     63x                 54x     290x 3665x             290x 290x 290x     290x                      
import { AnyBulkWriteOperation } from "mongoose";
import { first, groupBy, shuffle } from "remeda";
import { findProgramItemById } from "server/features/program-item/programItemRepository";
import {
  DirectSignupsForProgramItem,
  SignupRepositoryAddSignupResponse,
  SignupRepositoryAddSignup,
  UserDirectSignup,
} from "server/features/direct-signup/directSignupTypes";
import {
  DirectSignupSchemaDb,
  SignupModel,
} from "server/features/direct-signup/directSignupSchema";
import { logger } from "server/utils/logger";
import { MongoDbError } from "shared/types/api/errors";
import {
  Result,
  makeErrorResult,
  makeSuccessResult,
} from "shared/utils/result";
import { isLotterySignupProgramItem } from "shared/utils/isLotterySignupProgramItem";
import { isStartTimeMatch } from "server/utils/isStartTimeMatch";
import { ProgramItem } from "shared/types/models/programItem";
 
export const removeDirectSignups = async (): Promise<
  Result<void, MongoDbError>
> => {
  logger.info("MongoDB: remove ALL direct signups from db");
  try {
    await SignupModel.deleteMany({});
    return makeSuccessResult();
  } catch (error) {
    logger.error(
      new Error("MongoDB: Error removing direct signups", { cause: error }),
    );
    return makeErrorResult(MongoDbError.UNKNOWN_ERROR);
  }
};
 
export const findDirectSignups = async (): Promise<
  Result<DirectSignupsForProgramItem[], MongoDbError>
> => {
  try {
    const response = await SignupModel.find({}).lean();
 
    logger.debug("MongoDB: Direct signups found");
 
    const signups = response.flatMap((signup) => {
      const result = DirectSignupSchemaDb.safeParse(signup);
      Iif (!result.success) {
        logger.error(
          new Error(
            `Error validating findDirectSignups DB value: programItemId: ${signup.programItemId}, ${JSON.stringify(result.error)}`,
          ),
        );
        return [];
      }
      return result.data;
    });
 
    return makeSuccessResult(signups);
  } catch (error) {
    logger.error(
      new Error("MongoDB: Error finding direct signups", { cause: error }),
    );
    return makeErrorResult(MongoDbError.UNKNOWN_ERROR);
  }
};
 
export const findDirectSignupsByProgramItemIds = async (
  programItemIds: string[],
): Promise<Result<DirectSignupsForProgramItem[], MongoDbError>> => {
  try {
    const responses = await SignupModel.find({
      programItemId: { $in: programItemIds },
    }).lean();
 
    Iif (responses.length === 0) {
      logger.info(
        `MongoDB: No direct signups found for program item IDs: ${programItemIds.join(", ")}`,
      );
      return makeSuccessResult([]);
    }
 
    logger.debug(
      `MongoDB: Found ${responses.length} direct signups for program item IDs: ${programItemIds.join(", ")}`,
    );
 
    const validSignups: DirectSignupsForProgramItem[] = [];
 
    for (const response of responses) {
      const result = DirectSignupSchemaDb.safeParse(response);
      Iif (!result.success) {
        logger.error(
          new Error(
            `Error validating findDirectSignupsByProgramItemIds DB value: programItemId ${response.programItemId}: ${JSON.stringify(result.error)}`,
          ),
        );
        continue;
      }
 
      validSignups.push(result.data);
    }
 
    return makeSuccessResult(validSignups);
  } catch (error) {
    logger.error(
      new Error(
        `MongoDB: Error finding direct signups for program items ${programItemIds.join(", ")}`,
        { cause: error },
      ),
    );
    return makeErrorResult(MongoDbError.UNKNOWN_ERROR);
  }
};
 
interface FindDirectSignupsByStartTimeResponse extends UserDirectSignup {
  programItemId: string;
}
 
export const findDirectSignupsByStartTime = async (
  startTime: string,
  programItems: ProgramItem[],
): Promise<Result<FindDirectSignupsByStartTimeResponse[], MongoDbError>> => {
  const programItemsIds = programItems
    .filter((programItem) =>
      isStartTimeMatch(programItem.startTime, startTime, programItem.parentId),
    )
    .map((programItem) => programItem.programItemId);
 
  try {
    const response = await SignupModel.find({
      programItemId: { $in: programItemsIds },
    }).lean();
 
    logger.debug(`MongoDB: Found signups for time ${startTime}`);
 
    const signups = response.flatMap((signup) => {
      const result = DirectSignupSchemaDb.safeParse(signup);
      Iif (!result.success) {
        logger.error(
          new Error(
            `Error validating findDirectSignupsByStartTime DB value: programItemId: ${signup.programItemId}, ${JSON.stringify(result.error)}`,
          ),
        );
        return [];
      }
      return result.data;
    });
 
    const formattedResponse: FindDirectSignupsByStartTimeResponse[] =
      signups.flatMap((signup) => {
        return signup.userSignups.map((userSignup) => ({
          ...userSignup,
          programItemId: signup.programItemId,
        }));
      });
 
    return makeSuccessResult(formattedResponse);
  } catch (error) {
    logger.error(
      new Error(`MongoDB: Error finding signups for time ${startTime}`, {
        cause: error,
      }),
    );
    return makeErrorResult(MongoDbError.UNKNOWN_ERROR);
  }
};
 
export const findUserDirectSignups = async (
  username: string,
): Promise<Result<DirectSignupsForProgramItem[], MongoDbError>> => {
  try {
    const response = await SignupModel.find({
      "userSignups.username": username,
    }).lean();
 
    logger.debug(`MongoDB: Found signups for user ${username}`);
 
    const signups = response.flatMap((signup) => {
      const result = DirectSignupSchemaDb.safeParse(signup);
      Iif (!result.success) {
        logger.error(
          new Error(
            `Error validating findUserDirectSignups DB value: programItemId: ${signup.programItemId}, ${JSON.stringify(result.error)}`,
          ),
        );
        return [];
      }
      return result.data;
    });
 
    return makeSuccessResult(signups);
  } catch (error) {
    logger.error(
      new Error(`MongoDB: Error finding signups for user ${username}`, {
        cause: error,
      }),
    );
    return makeErrorResult(MongoDbError.UNKNOWN_ERROR);
  }
};
 
export const saveDirectSignup = async (
  signupsRequest: SignupRepositoryAddSignup,
): Promise<Result<DirectSignupsForProgramItem, MongoDbError>> => {
  const {
    username,
    directSignupProgramItemId,
    signedToStartTime,
    signupTime,
    message,
    priority,
  } = signupsRequest;
 
  // TODO: Remove fetching program item
  const programItemResult = await findProgramItemById(
    directSignupProgramItemId,
  );
  Iif (!programItemResult.ok) {
    return programItemResult;
  }
  try {
    const response = await SignupModel.findOneAndUpdate(
      {
        programItemId: directSignupProgramItemId,
        count: { $lt: programItemResult.value.maxAttendance },
        "userSignups.username": { $ne: username },
      },
      {
        $addToSet: {
          userSignups: {
            username,
            priority,
            signedToStartTime,
            signupTime,
            message,
          },
        },
        $inc: { count: 1 },
      },
      {
        returnDocument: "after",
      },
    ).lean();
 
    // No response means that direct signups for program item is either not found of program item is full
    if (!response) {
      const signupsResult = await findDirectSignupsByProgramItemIds([
        directSignupProgramItemId,
      ]);
      Iif (!signupsResult.ok) {
        return signupsResult;
      }
      const signup = first(signupsResult.value);
 
      Iif (!signup) {
        logger.warn(
          `Saving direct signup for user '${username}' failed: program item '${directSignupProgramItemId}' not found`,
        );
        return makeErrorResult(MongoDbError.SIGNUP_NOT_FOUND);
      }
 
      return makeSuccessResult(signup);
    }
 
    logger.info(
      `MongoDB: Direct signup to '${directSignupProgramItemId}' saved for user "${username}"`,
    );
 
    const result = DirectSignupSchemaDb.safeParse(response);
    Iif (!result.success) {
      logger.error(
        new Error(
          `Error validating saveDirectSignup DB value: ${JSON.stringify(result.error)}`,
        ),
      );
      return makeErrorResult(MongoDbError.UNKNOWN_ERROR);
    }
 
    return makeSuccessResult(result.data);
  } catch (error) {
    logger.error(
      new Error(`MongoDB: Error saving direct signup for user '${username}'`, {
        cause: error,
      }),
    );
    return makeErrorResult(MongoDbError.UNKNOWN_ERROR);
  }
};
 
export const saveDirectSignups = async (
  signupsRequests: SignupRepositoryAddSignup[],
  programItems: ProgramItem[],
): Promise<Result<SignupRepositoryAddSignupResponse, MongoDbError>> => {
  const signupsByProgramItems = groupBy(
    signupsRequests,
    (signupsRequest) => signupsRequest.directSignupProgramItemId,
  );
 
  const droppedSignups: SignupRepositoryAddSignup[] = [];
 
  const bulkOps: AnyBulkWriteOperation[] = Object.entries(
    signupsByProgramItems,
  ).flatMap(([programItemId, directSignups]) => {
    const programItem = programItems.find(
      (p) => p.programItemId === programItemId,
    );
    Iif (!programItem) {
      return [];
    }
 
    let finalSignups: SignupRepositoryAddSignup[] = directSignups;
    if (directSignups.length > programItem.maxAttendance) {
      // This case is handled gracefully, but it's still a bug worth flagging
      logger.error(
        new Error(
          `Too many signups passed to saveSignups for program item ${programItem.programItemId} - maxAttendance: ${programItem.maxAttendance}, direct signups: ${directSignups.length}, dropping ${directSignups.length - programItem.maxAttendance} signups`,
        ),
      );
      const shuffledSignups = shuffle(directSignups);
      finalSignups = shuffledSignups.slice(0, programItem.maxAttendance);
      droppedSignups.push(...shuffledSignups.slice(programItem.maxAttendance));
    }
 
    return {
      updateOne: {
        filter: {
          programItemId: programItem.programItemId,
        },
        // Append the new signups and recompute count from the resulting array in a single
        // atomic pipeline update, so count can never drift from the userSignups it tallies
        update: [
          {
            $set: {
              userSignups: {
                $concatArrays: [
                  { $ifNull: ["$userSignups", []] },
                  {
                    $literal: finalSignups.map((signup) => ({
                      username: signup.username,
                      priority: signup.priority,
                      signedToStartTime: new Date(signup.signedToStartTime),
                      signupTime: new Date(signup.signupTime),
                      message: signup.message,
                    })),
                  },
                ],
              },
            },
          },
          {
            $set: { count: { $size: "$userSignups" } },
          },
        ],
      },
    };
  });
 
  try {
    const response = await SignupModel.bulkWrite(bulkOps);
    logger.info(`Updated signups for ${response.modifiedCount} program items`);
    return makeSuccessResult({
      modifiedCount: response.modifiedCount,
      droppedSignups,
    });
  } catch (error) {
    logger.error(
      new Error("MongoDB: Error saving direct signups", { cause: error }),
    );
    return makeErrorResult(MongoDbError.UNKNOWN_ERROR);
  }
};
 
interface DelDirectSignupParams {
  directSignupProgramItemId: string;
  username: string;
}
 
export const delDirectSignup = async ({
  directSignupProgramItemId,
  username,
}: DelDirectSignupParams): Promise<
  Result<DirectSignupsForProgramItem, MongoDbError>
> => {
  try {
    const signup = await SignupModel.findOneAndUpdate(
      {
        programItemId: directSignupProgramItemId,
        "userSignups.username": username,
      },
      {
        $pull: {
          userSignups: {
            username,
          },
        },
        $inc: { count: -1 },
      },
      { returnDocument: "after" },
    ).lean();
 
    if (!signup) {
      logger.error(
        new Error(
          `Signups to program item ${directSignupProgramItemId} for user ${username} not found`,
        ),
      );
      return makeErrorResult(MongoDbError.UNKNOWN_ERROR);
    }
 
    const signupStillRemaining = signup.userSignups.some(
      (userSignup) => userSignup.username === username,
    );
 
    Iif (signupStillRemaining) {
      logger.error(
        new Error(
          `Error removing signup to program item ${directSignupProgramItemId} from user ${username}`,
        ),
      );
      return makeErrorResult(MongoDbError.UNKNOWN_ERROR);
    }
 
    logger.info(
      `MongoDB: Direct signup to '${
        directSignupProgramItemId
      }' removed from user '${username}'`,
    );
 
    const result = DirectSignupSchemaDb.safeParse(signup);
    Iif (!result.success) {
      logger.error(
        new Error(
          `Error validating delDirectSignup DB value: ${JSON.stringify(result.error)}`,
        ),
      );
      return makeErrorResult(MongoDbError.UNKNOWN_ERROR);
    }
 
    return makeSuccessResult(result.data);
  } catch (error) {
    logger.error(
      new Error(
        `MongoDB: Error deleting signup to program item ${directSignupProgramItemId} from user ${username}`,
        { cause: error },
      ),
    );
    return makeErrorResult(MongoDbError.UNKNOWN_ERROR);
  }
};
 
// Remove several users' direct signups in a single bulk write instead of one round-trip each
export const delDirectSignups = async (
  signups: readonly DelDirectSignupParams[],
): Promise<Result<void, MongoDbError>> => {
  if (signups.length === 0) {
    return makeSuccessResult();
  }
 
  try {
    await SignupModel.bulkWrite(
      signups.map(({ directSignupProgramItemId, username }) => ({
        updateOne: {
          filter: {
            programItemId: directSignupProgramItemId,
            "userSignups.username": username,
          },
          update: {
            $pull: { userSignups: { username } },
            $inc: { count: -1 },
          },
        },
      })),
    );
 
    logger.info(`MongoDB: Removed ${signups.length} direct signups`);
    return makeSuccessResult();
  } catch (error) {
    logger.error(
      new Error("MongoDB: Error deleting direct signups", { cause: error }),
    );
    return makeErrorResult(MongoDbError.UNKNOWN_ERROR);
  }
};
 
export const delDirectSignupDocumentsByProgramItemIds = async (
  programItemIds: string[],
): Promise<Result<void, MongoDbError>> => {
  try {
    await SignupModel.deleteMany({
      programItemId: { $in: programItemIds },
    });
    return makeSuccessResult();
  } catch (error) {
    logger.error(
      new Error(
        "MongoDB: Error removing signup documents for program item IDs",
        {
          cause: error,
        },
      ),
    );
    return makeErrorResult(MongoDbError.UNKNOWN_ERROR);
  }
};
 
export const resetDirectSignupsByProgramItemIds = async (
  programItemIds: readonly string[],
): Promise<Result<void, MongoDbError>> => {
  try {
    await SignupModel.updateMany(
      {
        programItemId: { $in: programItemIds },
      },
      { userSignups: [], count: 0 },
    );
    return makeSuccessResult();
  } catch (error) {
    logger.error(
      new Error("MongoDB: Error removing signups for program item IDs", {
        cause: error,
      }),
    );
    return makeErrorResult(MongoDbError.UNKNOWN_ERROR);
  }
};
 
export const delAssignmentDirectSignupsByStartTime = async (
  assignmentTime: string,
  programItems: ProgramItem[],
): Promise<Result<void, MongoDbError>> => {
  // Only remove "twoPhaseSignupProgramTypes" signups and don't remove "directSignupAlwaysOpen" signups
  const doNotRemoveProgramItemIds = programItems
    .filter((programItem) => !isLotterySignupProgramItem(programItem))
    .map((programItem) => programItem.programItemId);
 
  try {
    await SignupModel.updateMany(
      {
        programItemId: { $nin: doNotRemoveProgramItemIds },
      },
      [
        {
          $set: {
            userSignups: {
              $filter: {
                input: "$userSignups",
                as: "userSignup",
                cond: {
                  $ne: [
                    "$$userSignup.signedToStartTime",
                    new Date(assignmentTime),
                  ],
                },
              },
            },
          },
        },
        {
          $set: { count: { $size: "$userSignups" } },
        },
      ],
      { updatePipeline: true },
    );
    logger.info(
      `MongoDB: Deleted old signups for assignmentTime: ${assignmentTime}`,
    );
    return makeSuccessResult();
  } catch (error) {
    logger.error(
      new Error("MongoDB: Error removing invalid signup", { cause: error }),
    );
    return makeErrorResult(MongoDbError.UNKNOWN_ERROR);
  }
};
 
export const createEmptyDirectSignupDocumentForProgramItems = async (
  programItemIds: string[],
): Promise<Result<void, MongoDbError>> => {
  const signupDocs = programItemIds.map((programItemId) => {
    return new SignupModel({
      programItemId,
      userSignups: [],
      count: 0,
    });
  });
 
  try {
    await SignupModel.create(signupDocs);
    logger.info(
      `MongoDB: Signup collection created for ${programItemIds.length} program items: ${programItemIds.join(", ")}`,
    );
    return makeSuccessResult();
  } catch (error) {
    logger.error(
      new Error(
        `MongoDB: Creating signup collection for ${programItemIds.length} program items failed`,
        { cause: error },
      ),
    );
    return makeErrorResult(MongoDbError.UNKNOWN_ERROR);
  }
};