Confusing Endpoints

[AydanPirani]

The overall GET / implies that this gets overall registration status, but this does not include drafts. Even if we have two collections under the hood (which we shouldn't but that's a different discussion), callers should not have to choose which collection to pull from. Maybe return something like:

{
submitted: True,
data: ...
}

adonix/src/services/registration/registration-router.ts

Lines 66 to 126 in 8c8a9f3

	registrationRouter.get(
	"/",
	specification({
	method: "get",
	path: "/registration/",
	tag: Tag.REGISTRATION,
	role: Role.USER,
	summary: "Gets the currently authenticated user's submitted registration data",
	responses: {
	[StatusCode.SuccessOK]: {
	description: "The submitted registration information",
	schema: RegistrationApplicationDraftSchema,
	},
	[StatusCode.ClientErrorNotFound]: {
	description: "Couldn't find submitted registration information (make sure you create it first!)",
	schema: RegistrationNotFoundErrorSchema,
	},
	},
	}),
	async (req, res) => {
	const { id: userId } = getAuthenticatedUser(req);
	const registrationData = await Models.RegistrationApplicationSubmitted.findOne({ userId });
	if (!registrationData) {
	return res.status(StatusCode.ClientErrorNotFound).send(RegistrationNotFoundError);
	}
	return res.status(StatusCode.SuccessOK).send(registrationData);
	},
	);
	registrationRouter.get(
	"/draft/",
	specification({
	method: "get",
	path: "/registration/draft/",
	tag: Tag.REGISTRATION,
	role: Role.USER,
	summary: "Gets the currently authenticated user's draft registration data",
	responses: {
	[StatusCode.SuccessOK]: {
	description: "The draft registration information",
	schema: RegistrationApplicationDraftSchema,
	},
	[StatusCode.ClientErrorNotFound]: {
	description: "Couldn't find draft registration information (make sure you create it first!)",
	schema: RegistrationNotFoundErrorSchema,
	},
	},
	}),
	async (req, res) => {
	const { id: userId } = getAuthenticatedUser(req);
	const registrationData = await Models.RegistrationApplicationDraft.findOne({ userId });
	if (!registrationData) {
	return res.status(StatusCode.ClientErrorNotFound).send(RegistrationNotFoundError);
	}
	return res.status(StatusCode.SuccessOK).send(registrationData);
	},
	);

[AydanPirani]

Adding onto this , the caller must first PUT /registrations/draft, then POST /registration/submit. This is extremely counterintuitive and breaks the standard REST API contract, where actions happen on objects.

adonix/src/services/registration/registration-router.ts

Lines 168 to 301 in 8c8a9f3

	registrationRouter.put(
	"/draft/",
	specification({
	method: "put",
	path: "/registration/draft/",
	tag: Tag.REGISTRATION,
	role: Role.USER,
	summary: "Creates or updates the currently authenticated user's draft registration data",
	body: RegistrationApplicationDraftRequestSchema,
	responses: {
	[StatusCode.SuccessOK]: {
	description: "The registration draft was created or updated",
	schema: RegistrationApplicationDraftRequestSchema,
	},
	[StatusCode.ClientErrorForbidden]: {
	description: "Registration is closed",
	schema: RegistrationClosedErrorSchema,
	},
	[StatusCode.ClientErrorBadRequest]: {
	description: "Registration is already submitted, cannot update anymore",
	schema: RegistrationAlreadySubmittedErrorSchema,
	},
	},
	}),
	async (req, res) => {
	const { id: userId } = getAuthenticatedUser(req);
	if (!isRegistrationAlive()) {
	return res.status(StatusCode.ClientErrorForbidden).send(RegistrationClosedError);
	}
	const setRequest = req.body;
	const isSubmitted = await Models.RegistrationApplicationSubmitted.findOne({ userId: userId });
	if (isSubmitted) {
	return res.status(StatusCode.ClientErrorBadRequest).send(RegistrationAlreadySubmittedError);
	}
	const registrationData: RegistrationApplicationDraft = {
	...setRequest,
	userId,
	} as RegistrationApplicationDraft;
	const newRegistrationInfo = await Models.RegistrationApplicationDraft.findOneAndUpdate({ userId }, registrationData, {
	upsert: true,
	new: true,
	});
	if (!newRegistrationInfo) {
	throw Error("Failed to update registration info");
	}
	return res.status(StatusCode.SuccessOK).send(newRegistrationInfo);
	},
	);
	registrationRouter.post(
	"/submit/",
	specification({
	method: "post",
	path: "/registration/submit/",
	tag: Tag.REGISTRATION,
	role: Role.USER,
	summary: "Submits the currently authenticated user's registration - permanent",
	body: RegistrationApplicationSubmittedRequestSchema,
	responses: {
	[StatusCode.SuccessOK]: {
	description: "The new registration information",
	schema: RegistrationApplicationSubmittedRequestSchema,
	},
	[StatusCode.ClientErrorBadRequest]: {
	id: RegistrationAlreadySubmittedError.error,
	description: "Registration is already submitted, cannot update anymore",
	schema: RegistrationAlreadySubmittedErrorSchema,
	},
	[StatusCode.ClientErrorForbidden]: {
	description: "Registration is closed",
	schema: RegistrationClosedErrorSchema,
	},
	},
	}),
	async (req, res) => {
	const { id: userId } = getAuthenticatedUser(req);
	if (!isRegistrationAlive()) {
	return res.status(StatusCode.ClientErrorForbidden).send(RegistrationClosedError);
	}
	const isSubmitted = await Models.RegistrationApplicationSubmitted.findOne({ userId: userId });
	if (isSubmitted) {
	return res.status(StatusCode.ClientErrorBadRequest).send(RegistrationAlreadySubmittedError);
	}
	const submissionData: RegistrationApplicationSubmitted = {
	...req.body,
	userId: userId,
	} as RegistrationApplicationSubmitted;
	const [newSubmissionInfo] = await Promise.all([
	Models.RegistrationApplicationSubmitted.create(submissionData),
	Models.RegistrationApplicationDraft.deleteOne({ userId: userId }),
	]);
	if (!newSubmissionInfo) {
	throw Error("Failed to submit registration");
	}
	const admissionInfo = await Models.AdmissionDecision.findOneAndUpdate(
	{
	userId: userId,
	},
	{
	userId,
	status: DecisionStatus.TBD,
	},
	{ upsert: true, new: true },
	);
	if (!admissionInfo) {
	throw Error("Failed to update admission");
	}
	// SEND SUCCESSFUL REGISTRATION EMAIL
	const mailInfo: MailInfo = {
	templateId: Templates.REGISTRATION_SUBMISSION,
	recipient: newSubmissionInfo.email,
	templateData: { name: newSubmissionInfo.firstName, pro: newSubmissionInfo.pro ?? false },
	};
	await sendMail(mailInfo);
	return res.status(StatusCode.SuccessOK).send(newSubmissionInfo);
	},
	);