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 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 | 60x 510x 510x 510x 510x 60x 1x 1x 1x 1x 60x 2659x 20061x 20061x 2x 2x 20059x 60x 1660x 1660x 1660x 1660x 60x 341x 341x 341x 460x 60x 209x 209x 209x 209x 209x 209x 60x 128x 1984x 2742x 358x 128x 128x 128x 128x 128x 349x 128x 60x 530x 530x 530x 530x 60x 216x 216x 216x 216x 216x 216x 12x 12x 12x 12x 12x 207x 204x 207x 207x 60x 132x 132x 132x 132x 164x 320x 132x 325x 325x 2x 1x 1x 1x 1x 323x 132x 4x 5x 4x 4x 132x 60x 151x 322x 151x 322x 151x 60x 132x 337x 132x 151x 2221x 151x 151x 132x 132x 132x 132x 132x 132x 60x 60x 20x 20x 20x 4x 4x 16x 10x 16x 16x 16x 16x 16x 60x 128x 112x 61x 16x 19x 16x 16x 60x 18x 18x 18x 60x 30x 30x 30x 60x 507x 507x 507x 2322x 507x 505x 505x 2x 1x 1x 1x 1x | import { AnyBulkWriteOperation } from "mongoose";
import { countBy, first, groupBy } from "remeda";
import { MongoDbError } from "shared/types/api/errors";
import { ProgramItem } from "shared/types/models/programItem";
import {
Result,
makeErrorResult,
makeSuccessResult,
} from "shared/utils/result";
import { isSameTime } from "shared/utils/timeComparison";
import { isDuplicateKeyBulkWriteError } from "server/db/duplicateKeyError";
import {
DirectSignupSchemaDb,
SignupModel,
} from "server/features/direct-signup/directSignupSchema";
import {
DirectSignupsForProgramItem,
SignupRepositoryAddSignup,
SignupRepositoryAddSignupResponse,
UserDirectSignup,
} from "server/features/direct-signup/directSignupTypes";
import { findProgramItemById } from "server/features/program-item/programItemRepository";
import { logger } from "server/utils/logger";
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);
}
};
// Empties every sign-up document without deleting it. Only the data generators need this: a
// programme import owns creating the documents, so one wiped between imports never comes back
export const resetDirectSignups = async (): Promise<
Result<void, MongoDbError>
> => {
logger.info("MongoDB: remove ALL direct signups from program items");
try {
await SignupModel.updateMany({}, { userSignups: [], count: 0 });
return makeSuccessResult();
} catch (error) {
logger.error(
new Error("MongoDB: Error resetting direct signups", { cause: error }),
);
return makeErrorResult(MongoDbError.UNKNOWN_ERROR);
}
};
// A document that cannot be read is skipped rather than failing the whole query, so one unreadable
// row does not hide every other sign-up. The query name locates the caller in the log
const parseSignupDocuments = (
responses: readonly { programItemId: string }[],
queryName: string,
): DirectSignupsForProgramItem[] =>
responses.flatMap((response) => {
const result = DirectSignupSchemaDb.safeParse(response);
if (!result.success) {
logger.error(
new Error(
`Error validating ${queryName} DB value: programItemId: ${response.programItemId}`,
{ cause: result.error },
),
);
return [];
}
return result.data;
});
export const findDirectSignups = async (): Promise<
Result<DirectSignupsForProgramItem[], MongoDbError>
> => {
try {
const responses = await SignupModel.find({}).lean();
logger.debug("MongoDB: Direct signups found");
return makeSuccessResult(
parseSignupDocuments(responses, "findDirectSignups"),
);
} catch (error) {
logger.error(
new Error("MongoDB: Error finding direct signups", { cause: error }),
);
return makeErrorResult(MongoDbError.UNKNOWN_ERROR);
}
};
interface SignupDocuments {
signups: DirectSignupsForProgramItem[];
// Which program items have a document at all, readable or not. A write that does not upsert
// stores nothing when there is none, where an unreadable one says only that a check cannot tell
presentProgramItemIds: Set<string>;
}
const findSignupDocumentsByProgramItemIds = async (
programItemIds: string[],
queryName: string,
): Promise<Result<SignupDocuments, MongoDbError>> => {
try {
const responses = await SignupModel.find({
programItemId: { $in: programItemIds },
}).lean();
return makeSuccessResult({
signups: parseSignupDocuments(responses, queryName),
presentProgramItemIds: new Set(
responses.map((response) => response.programItemId),
),
});
} catch (error) {
logger.error(
new Error(
`MongoDB: Error finding direct signups for program items ${programItemIds.join(", ")}`,
{ cause: error },
),
);
return makeErrorResult(MongoDbError.UNKNOWN_ERROR);
}
};
export const findDirectSignupsByProgramItemIds = async (
programItemIds: string[],
): Promise<Result<DirectSignupsForProgramItem[], MongoDbError>> => {
const documentsResult = await findSignupDocumentsByProgramItemIds(
programItemIds,
"findDirectSignupsByProgramItemIds",
);
Iif (!documentsResult.ok) {
return documentsResult;
}
const { signups } = documentsResult.value;
Iif (signups.length === 0) {
logger.info(
`MongoDB: No direct signups found for program item IDs: ${programItemIds.join(", ")}`,
);
return makeSuccessResult([]);
}
logger.debug(
`MongoDB: Found ${signups.length} direct signups for program item IDs: ${programItemIds.join(", ")}`,
);
return makeSuccessResult(signups);
};
interface FindDirectSignupsByStartTimeResponse extends UserDirectSignup {
programItemId: string;
}
// Matched on each program item's own start time: a spot is held for the hour its attendee turns
// up, and the parent override only says when a batch is lotteried
export const findDirectSignupsByStartTimes = async (
startTimes: readonly string[],
programItems: ProgramItem[],
): Promise<Result<FindDirectSignupsByStartTimeResponse[], MongoDbError>> => {
const programItemsIds = programItems
.filter((programItem) =>
startTimes.some((startTime) =>
isSameTime(programItem.startTime, startTime),
),
)
.map((programItem) => programItem.programItemId);
try {
const response = await SignupModel.find({
programItemId: { $in: programItemsIds },
}).lean();
logger.debug(`MongoDB: Found signups for times ${startTimes.join(", ")}`);
const signups = parseSignupDocuments(
response,
"findDirectSignupsByStartTimes",
);
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 times ${startTimes.join(", ")}`,
{
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}`);
return makeSuccessResult(
parseSignupDocuments(response, "findUserDirectSignups"),
);
} 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 the program item's sign-up document was not found or the 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`, {
cause: 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);
}
};
// The attendance cap is applied by the write itself, so which sign-ups actually landed is
// only known afterwards. Reporting the ones that didn't lets the caller treat them as not
// placed rather than telling the attendee they got a spot that was never stored.
const findSignupsNotSaved = async (
signupsByProgramItems: Record<string, SignupRepositoryAddSignup[]>,
): Promise<Result<SignupRepositoryAddSignup[], MongoDbError>> => {
const documentsResult = await findSignupDocumentsByProgramItemIds(
Object.keys(signupsByProgramItems),
"findSignupsNotSaved",
);
Iif (!documentsResult.ok) {
return documentsResult;
}
const { signups, presentProgramItemIds } = documentsResult.value;
const savedUsernamesByProgramItemId = new Map(
signups.map((signup) => [
signup.programItemId,
new Set(signup.userSignups.map((userSignup) => userSignup.username)),
]),
);
const notSaved = Object.values(signupsByProgramItems)
.flat()
.filter((signup) => {
const savedUsernames = savedUsernamesByProgramItemId.get(
signup.directSignupProgramItemId,
);
if (!savedUsernames) {
// No document to update and the write does not create one, so nothing was stored.
// Saying otherwise would send an acceptance email for a spot that does not exist.
if (!presentProgramItemIds.has(signup.directSignupProgramItemId)) {
logger.error(
new Error(
`Assignment signups for program item ${signup.directSignupProgramItemId} were not saved: it has no sign-up document`,
),
);
return true;
}
// The document is there but could not be read, which says nothing about the write.
// Reporting them dropped would tell attendees holding a spot that they got none.
logger.error(
new Error(
`Could not verify the assignment signups saved to program item ${signup.directSignupProgramItemId}, treating them as saved`,
),
);
return false;
}
return !savedUsernames.has(signup.username);
});
if (notSaved.length > 0) {
const notSavedCounts = Object.entries(
countBy(notSaved, (signup) => signup.directSignupProgramItemId),
).map(([programItemId, count]) => `${programItemId}: ${count}`);
logger.error(
new Error(
`${notSaved.length} assignment signups did not fit the program item they were assigned to and were not saved - ${notSavedCounts.join(", ")}`,
),
);
}
return makeSuccessResult(notSaved);
};
// Append the new sign-ups and recompute count from the resulting array in a single atomic
// pipeline update, so count can never drift from the userSignups it tallies
const appendSignupsPipeline = (
directSignups: readonly SignupRepositoryAddSignup[],
maxAttendance: number,
): object[] => {
// $literal: a username is data, and one starting with "$" would otherwise be read as a field
// path and match nothing
const appendedUsernames = {
$literal: directSignups.map((signup) => signup.username),
};
const appendedSignups = {
$literal: directSignups.map((signup) => ({
username: signup.username,
priority: signup.priority,
signedToStartTime: new Date(signup.signedToStartTime),
signupTime: new Date(signup.signupTime),
message: signup.message,
})),
};
return [
{
$set: {
userSignups: {
$let: {
vars: {
// An attendee being written keeps one entry, the new one. A program item being
// lotteried holds no spots, so this is defence in depth: a second entry would
// seat them twice and charge their own place against it
keptSignups: {
$filter: {
input: { $ifNull: ["$userSignups", []] },
cond: {
$not: [{ $in: ["$$this.username", appendedUsernames] }],
},
},
},
},
// The only cap on the attendance limit, and it runs on the array as it stands rather
// than on a count read beforehand. Never below the attendees this write leaves alone,
// so an over-full program item loses only the ones being written.
in: {
$slice: [
{ $concatArrays: ["$$keptSignups", appendedSignups] },
{ $max: [maxAttendance, { $size: "$$keptSignups" }] },
],
},
},
},
},
},
{
$set: { count: { $size: "$userSignups" } },
},
];
};
export const saveDirectSignups = async (
signupsRequests: SignupRepositoryAddSignup[],
programItems: ProgramItem[],
): Promise<Result<SignupRepositoryAddSignupResponse, MongoDbError>> => {
const signupsByProgramItems = groupBy(
signupsRequests,
(signupsRequest) => signupsRequest.directSignupProgramItemId,
);
const bulkOps: AnyBulkWriteOperation[] = Object.entries(
signupsByProgramItems,
).flatMap(([programItemId, directSignups]) => {
const programItem = programItems.find(
(p) => p.programItemId === programItemId,
);
Iif (!programItem) {
return [];
}
return {
updateOne: {
filter: {
programItemId: programItem.programItemId,
},
update: appendSignupsPipeline(directSignups, programItem.maxAttendance),
},
};
});
try {
const response = await SignupModel.bulkWrite(bulkOps);
logger.info(`Updated signups for ${response.modifiedCount} program items`);
const notSavedResult = await findSignupsNotSaved(signupsByProgramItems);
Iif (!notSavedResult.ok) {
// The write has landed by now, so failing the caller here would abort a lottery run that
// has already placed people. The unverified ones read as saved, like a skipped document.
logger.error(
new Error(
`Could not verify which assignment signups were saved, treating them as saved: ${notSavedResult.error}`,
),
);
}
return makeSuccessResult({
modifiedCount: response.modifiedCount,
droppedSignups: notSavedResult.ok ? notSavedResult.value : [],
});
} catch (error) {
logger.error(
new Error("MongoDB: Error saving direct signups", { cause: error }),
);
return makeErrorResult(MongoDbError.UNKNOWN_ERROR);
}
};
interface DelDirectSignupParams {
directSignupProgramItemId: string;
username: string;
}
// Drop the user's sign-ups and recompute count from what is left, rather than decrementing it.
// count gates the sign-up endpoint's capacity check, and a decrement drifts from the array
// whenever it removes more than one entry
const removeUsernamePipeline = (username: string): object[] => [
{
$set: {
userSignups: {
$filter: {
input: "$userSignups",
as: "userSignup",
// $literal: a username is data, and one starting with "$" would
// otherwise be read as a field path and match nothing
cond: {
$ne: ["$$userSignup.username", { $literal: username }],
},
},
},
},
},
{
$set: { count: { $size: "$userSignups" } },
},
];
export const delDirectSignup = async ({
directSignupProgramItemId,
username,
}: DelDirectSignupParams): Promise<
Result<DirectSignupsForProgramItem, MongoDbError>
> => {
try {
const signup = await SignupModel.findOneAndUpdate(
{
programItemId: directSignupProgramItemId,
"userSignups.username": username,
},
removeUsernamePipeline(username),
{ returnDocument: "after", updatePipeline: true },
).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`, {
cause: 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 sign-ups 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: removeUsernamePipeline(username),
},
})),
);
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 createEmptyDirectSignupDocumentForProgramItems = async (
programItemIds: string[],
): Promise<Result<void, MongoDbError>> => {
Iif (programItemIds.length === 0) {
return makeSuccessResult();
}
try {
// $setOnInsert leaves an existing document alone, so a program item whose document appeared
// between the caller deciding it was missing and this write keeps the sign-ups it holds
const bulkOps: AnyBulkWriteOperation[] = programItemIds.map(
(programItemId) => ({
updateOne: {
filter: { programItemId },
update: { $setOnInsert: { userSignups: [], count: 0 } },
upsert: true,
},
}),
);
// Unordered so one program item another caller is creating at the same time does not stop
// the documents for the rest of the batch
await SignupModel.bulkWrite(bulkOps, { ordered: false });
logger.info(
`MongoDB: Signup collection created for ${programItemIds.length} program items: ${programItemIds.join(", ")}`,
);
return makeSuccessResult();
} catch (error) {
// Another caller created the document first, which is what this was for. Reporting it as a
// failure would fail the program item import over a state it did reach
if (isDuplicateKeyBulkWriteError(error)) {
logger.info(
"MongoDB: Signup documents already created by a concurrent caller",
);
return makeSuccessResult();
}
logger.error(
new Error(
`MongoDB: Creating signup collection for ${programItemIds.length} program items failed`,
{ cause: error },
),
);
return makeErrorResult(MongoDbError.UNKNOWN_ERROR);
}
};
|