All files / server/src/features/user/lottery-signup lotterySignupService.ts

90.9% Statements 60/66
86.36% Branches 38/44
100% Functions 3/3
90.9% Lines 60/66

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                                                42x               42x         112x 1x             111x 111x 1x           110x   110x 1x             109x 1x                 108x 1x                 107x 107x             107x 1x             106x 106x             106x           106x 2x             104x   104x     1x 1x 1x             103x 103x       103x 1x             102x 102x             102x 102x 1x               101x 1x             100x   25x           100x 1x             99x             99x         99x               99x             42x       9x     9x 1x           8x 8x               8x   8x       8x 1x             7x             7x               7x    
import { isEqual } from "date-fns";
import {
  DeleteLotterySignupResponse,
  PostLotterySignupResponse,
} from "shared/types/api/myProgramItems";
import { SignupType, State } from "shared/types/models/programItem";
import { getProgramItemValidity } from "shared/utils/getProgramItemValidity";
import {
  getLotterySignupEndTime,
  getLotterySignupStartTime,
  willNotBeLotteried,
} from "shared/utils/signupTimes";
import { isSameOrAfter } from "shared/utils/timeComparison";
import { getTimeNow } from "server/features/assignment/utils/getTimeNow";
import { findProgramItemById } from "server/features/program-item/programItemRepository";
import { findOrCreateSettings } from "server/features/settings/settingsRepository";
import {
  delLotterySignups,
  saveLotterySignup,
} from "server/features/user/lottery-signup/lotterySignupRepository";
import { findUser } from "server/features/user/userRepository";
import { hasSignupEnded } from "server/features/user/userUtils";
import { logger } from "server/utils/logger";
 
const validPriorities = new Set([1, 2, 3]);
 
interface StoreLotterySignupParams {
  programItemId: string;
  priority: number;
  username: string;
}
 
export const storeLotterySignup = async ({
  programItemId,
  priority,
  username,
}: StoreLotterySignupParams): Promise<PostLotterySignupResponse> => {
  if (!validPriorities.has(priority)) {
    return {
      errorId: "invalidPriority",
      message: `Invalid priority: ${priority}`,
      status: "error",
    };
  }
 
  const programItemResult = await findProgramItemById(programItemId);
  if (!programItemResult.ok) {
    return {
      message: `Program item not found: ${programItemId}`,
      status: "error",
      errorId: "programItemNotFound",
    };
  }
  const programItem = programItemResult.value;
 
  if (programItem.signupType !== SignupType.KONSTI) {
    return {
      message: "No Konsti signup for this program item",
      status: "error",
      errorId: "noKonstiSignup",
    };
  }
 
  if (programItem.state === State.CANCELLED) {
    return {
      message: "Program item is cancelled",
      status: "error",
      errorId: "cancelled",
    };
  }
 
  // Invalid program items have their sign-up disabled in the client, but a
  // sign-up can still arrive from a stale or bugged page
  if (!getProgramItemValidity(programItem).allValuesValid) {
    return {
      message: "Program item is missing required information",
      status: "error",
      errorId: "invalidProgramItem",
    };
  }
 
  // Hidden program items are only filtered from the client's list view, so a
  // sign-up for one can still arrive from a stale page or a direct link
  const settingsResult = await findOrCreateSettings();
  Iif (!settingsResult.ok) {
    return {
      message: "Error loading settings",
      status: "error",
      errorId: "unknown",
    };
  }
  if (settingsResult.value.hiddenProgramItemIds.includes(programItemId)) {
    return {
      message: "Program item is hidden",
      status: "error",
      errorId: "hidden",
    };
  }
 
  const timeNowResult = await getTimeNow();
  Iif (!timeNowResult.ok) {
    return {
      message: "Unable to get current time",
      status: "error",
      errorId: "unknown",
    };
  }
  const timeNow = timeNowResult.value;
 
  // A program item is lotteried at most once, and one already holding sign-ups is not lotteried
  // at all. Either way the sign-up window these times are derived from can still be open - a
  // move reopens it, and a program item passed over is marked while it is - so without this a
  // sign-up could be made to a lottery that will not happen.
  if (willNotBeLotteried(programItem)) {
    return {
      message: `Program item ${programItemId} does not take part in a lottery`,
      status: "error",
      errorId: "lotteryAlreadyRun",
    };
  }
 
  const lotterySignupStartTime = getLotterySignupStartTime(programItem);
 
  if (!isSameOrAfter(timeNow, lotterySignupStartTime)) {
    // String rather than toISOString, which throws on an unparseable date - the
    // very case this branch exists to report
    const message = `Signup for program item ${programItemId} not open yet, opens ${String(lotterySignupStartTime)}`;
    logger.warn(message);
    return {
      errorId: "signupNotOpenYet",
      message,
      status: "error",
    };
  }
 
  const lotterySignupEndTime = getLotterySignupEndTime(programItem);
  const signupEnded = hasSignupEnded({
    signupEndTime: lotterySignupEndTime,
    timeNow,
  });
  if (signupEnded) {
    return {
      errorId: "signupEnded",
      message: `Signup for program item ${programItemId} has ended at ${lotterySignupEndTime.toISOString()}`,
      status: "error",
    };
  }
 
  const userResult = await findUser(username);
  Iif (!userResult.ok) {
    return {
      message: "Error finding user",
      status: "error",
      errorId: "unknown",
    };
  }
  const user = userResult.value;
  if (!user) {
    return {
      message: "Error finding user",
      status: "error",
      errorId: "unknown",
    };
  }
 
  // Group members don't make their own lottery sign-ups; the group creator signs up for the group
  if (user.groupCode !== "0" && !user.isGroupCreator) {
    return {
      message: "Group member cannot create lottery signups",
      status: "error",
      errorId: "groupMember",
    };
  }
 
  const priorityReserved = user.lotterySignups.some(
    (lotterySignup) =>
      isEqual(
        new Date(lotterySignup.signedToStartTime),
        new Date(programItem.startTime),
      ) && lotterySignup.priority === priority,
  );
 
  if (priorityReserved) {
    return {
      message: "Duplicate priority score found",
      status: "error",
      errorId: "samePriority",
    };
  }
 
  const lotterySignup = {
    programItemId,
    priority,
    // Lottery sign-ups always store the item's own startTime; parent override is only used for lottery batching
    signedToStartTime: programItem.startTime,
  };
 
  const responseResult = await saveLotterySignup({
    lotterySignup,
    username,
  });
 
  Iif (!responseResult.ok) {
    return {
      message: "Signup failure",
      status: "error",
      errorId: "unknown",
    };
  }
 
  return {
    message: "Lottery signup success",
    status: "success",
    lotterySignups: responseResult.value.lotterySignups,
  };
};
 
export const removeLotterySignup = async (
  lotterySignupProgramItemId: string,
  username: string,
): Promise<DeleteLotterySignupResponse> => {
  const programItemResult = await findProgramItemById(
    lotterySignupProgramItemId,
  );
  if (!programItemResult.ok) {
    return {
      message: `Program item not found: ${lotterySignupProgramItemId}`,
      status: "error",
      errorId: "programItemNotFound",
    };
  }
  const timeNowResult = await getTimeNow();
  Iif (!timeNowResult.ok) {
    return {
      message: "Unable to get current time",
      status: "error",
      errorId: "unknown",
    };
  }
 
  const lotterySignupEndTime = getLotterySignupEndTime(programItemResult.value);
 
  const signupEnded = hasSignupEnded({
    signupEndTime: lotterySignupEndTime,
    timeNow: timeNowResult.value,
  });
  if (signupEnded) {
    return {
      errorId: "signupEnded",
      message: `Signup for program item ${lotterySignupProgramItemId} has ended at ${lotterySignupEndTime.toISOString()}`,
      status: "error",
    };
  }
 
  const responseResult = await delLotterySignups([
    {
      lotterySignupProgramItemIds: [lotterySignupProgramItemId],
      username,
    },
  ]);
 
  Iif (!responseResult.ok) {
    return {
      message: "Removing lottery signup failed",
      status: "error",
      errorId: "unknown",
    };
  }
 
  return { message: "Lottery signup remove success", status: "success" };
};