chore: make errors lowercase (#64)

NathanFlurry · NathanFlurry · commit cc9b3880acb3 · 2024-03-15T12:30:39.000Z
diff --git a/.github/workflows/test-all.yml b/.github/workflows/test-all.yml
@@ -3,7 +3,7 @@ on:
   - push
 
 env:
-  CURRENT_WORKING_ENGINE_COMMIT: cbdd1e1b364b1906347b3ef541a4a5057651650f
+  CURRENT_WORKING_ENGINE_COMMIT: 1971d6db5c5ffd065fec24764c122b4ab74e3172
 
 jobs:
   build:
diff --git a/modules/auth/module.yaml b/modules/auth/module.yaml
@@ -1,16 +1,37 @@
+name: Authentication
+description: Authenticate users with multiple authentication methods.
+icon: key
+tags:
+  - core
+  - auth
+  - user
+authors:
+  - rivet-gg
+  - NathanFlurry
+status: stable
 dependencies:
   email: {}
   users: {}
   rate_limit: {}
 scripts:
   auth_email_passwordless:
+    name: Authenticate Email Passwordless
+    description: Send a one-time verification code to a user's email address to authenticate them.
     public: true
   verify_email_passwordless:
+    name: Verify Email Passwordless
+    description: Verify a user's email address with a one-time verification code.
     public: true
 errors:
-  PROVIDER_DISABLED: {}
-  VERIFICATION_CODE_INVALID: {}
-  VERIFICATION_CODE_ATTEMPT_LIMIT: {}
-  VERIFICATION_CODE_EXPIRED: {}
-  VERIFICATION_CODE_ALREADY_USED: {}
-  EMAIL_ALREADY_USED: {}
+  provider_disabled:
+    name: Provider Disabled
+  verification_code_invalid:
+    name: Verification Code Invalid
+  verification_code_attempt_limit:
+    name: Verification Code Attempt Limit
+  verification_code_expired:
+    name: Verification Code Expired
+  verification_code_already_used:
+    name: Verification Code Already Used
+  email_already_used:
+    name: Email Already Used
diff --git a/modules/auth/scripts/auth_email_passwordless.ts b/modules/auth/scripts/auth_email_passwordless.ts
@@ -17,7 +17,7 @@ export async function run(
 ): Promise<Response> {
 	await ctx.modules.rateLimit.throttlePublic({});
 
-	if (!ctx.userConfig.email) throw new RuntimeError("PROVIDER_DISABLED");
+	if (!ctx.userConfig.email) throw new RuntimeError("provider_disabled");
 
 	// Fetch existing user if session token is provided
 	let userId: string | undefined;
@@ -31,7 +31,7 @@ export async function run(
 			where: { email: req.email },
 		});
 		if (existingIdentity && existingIdentity.userId !== userId) {
-			throw new RuntimeError("EMAIL_ALREADY_USED");
+			throw new RuntimeError("email_already_used");
 		}
 	}
 
diff --git a/modules/auth/scripts/verify_email_passwordless.ts b/modules/auth/scripts/verify_email_passwordless.ts
@@ -45,20 +45,20 @@ export async function run(
 			},
 		});
 		if (!verification) {
-			throw new RuntimeError("VERIFICATION_CODE_INVALID");
+			throw new RuntimeError("verification_code_invalid");
 		}
 		if (verification.attemptCount >= verification.maxAttemptCount) {
-			throw new RuntimeError("VERIFICATION_CODE_ATTEMPT_LIMIT");
+			throw new RuntimeError("verification_code_attempt_limit");
 		}
 		if (verification.completedAt !== null) {
-			throw new RuntimeError("VERIFICATION_CODE_ALREADY_USED");
+			throw new RuntimeError("verification_code_already_used");
 		}
 		if (verification.code !== code) {
 			// Same error as above to prevent exploitation
-			throw new RuntimeError("VERIFICATION_CODE_INVALID");
+			throw new RuntimeError("verification_code_invalid");
 		}
 		if (verification.expireAt < new Date()) {
-			throw new RuntimeError("VERIFICATION_CODE_EXPIRED");
+			throw new RuntimeError("verification_code_expired");
 		}
 
 		// Mark as used
@@ -73,7 +73,7 @@ export async function run(
 				},
 			});
 		if (verificationConfirmation === null) {
-			throw new RuntimeError("VERIFICATION_CODE_ALREADY_USED");
+			throw new RuntimeError("verification_code_already_used");
 		}
 
 		// Get or create user
diff --git a/modules/currency/module.yaml b/modules/currency/module.yaml
@@ -1,19 +1,32 @@
-status: preview
+name: Currency
+description: Track user balances and allow them to deposit and withdraw.
+icon: coin
+tags:
+  - economy
 authors:
   - ABCxFF
+status: preview
 dependencies:
   rate_limit: {}
   users: {}
 scripts:
   # Maybe deposit?
-  deposit: {}
+  deposit:
+    name: Deposit
   # Maybe withdraw?
-  withdraw: {}
-  get_balance: {}
-  set_balance: {}
+  withdraw:
+    name: Withdraw
+  get_balance:
+    name: Get Balance
+  set_balance:
+    name: Set Balance
   get_balance_by_token:
+    name: Get Balance by Token
     public: true
 errors:
-  INVALID_USER: {}
-  INVALID_AMOUNT: {}
-  NOT_ENOUGH_FUNDS: {}
+  invalid_user:
+    name: Invalid User
+  invalid_amount:
+    name: Invalid Amount
+  not_enough_funds:
+    name: Not Enough Funds
diff --git a/modules/currency/scripts/deposit.ts b/modules/currency/scripts/deposit.ts
@@ -19,20 +19,20 @@ export async function run(
 	await ctx.modules.rateLimit.throttlePublic({ requests: 25 });
 
 	if (req.amount < 0 || !Number.isFinite(req.amount)) {
-		throw new RuntimeError("INVALID_AMOUNT");
+		throw new RuntimeError("invalid_amount");
 	}
 
 	return ctx.db.$transaction(async (tx) => {
 		const balance = await getBalance(tx, req.userId);
 
 		const updatedBalance = balance + req.amount;
 
-		if (updatedBalance < 0) throw new RuntimeError("NOT_ENOUGH_FUNDS");
+		if (updatedBalance < 0) throw new RuntimeError("not_enough_funds");
 
 		try {
 			await setBalance(tx, req.userId, updatedBalance);
 		} catch {
-			throw new RuntimeError("INVALID_AMOUNT");
+			throw new RuntimeError("invalid_amount");
 		}
 
 		return {
diff --git a/modules/currency/scripts/set_balance.ts b/modules/currency/scripts/set_balance.ts
@@ -17,13 +17,13 @@ export async function run(
 	await ctx.modules.rateLimit.throttlePublic({ requests: 25 });
 
 	if (req.balance < 0 || !Number.isFinite(req.balance)) {
-		throw new RuntimeError("INVALID_AMOUNT");
+		throw new RuntimeError("invalid_amount");
 	}
 
 	try {
 		await setBalance(ctx.db, req.userId, req.balance);
 	} catch {
-		throw new RuntimeError("INVALID_AMOUNT");
+		throw new RuntimeError("invalid_amount");
 	}
 
 	return {};
diff --git a/modules/currency/scripts/withdraw.ts b/modules/currency/scripts/withdraw.ts
@@ -19,20 +19,20 @@ export async function run(
 	await ctx.modules.rateLimit.throttlePublic({ requests: 25 });
 
 	if (req.amount < 0 || !Number.isFinite(req.amount)) {
-		throw new RuntimeError("INVALID_AMOUNT");
+		throw new RuntimeError("invalid_amount");
 	}
 
 	return ctx.db.$transaction(async (tx) => {
 		const balance = await getBalance(tx, req.userId);
 
 		const updatedBalance = balance - req.amount;
 
-		if (updatedBalance < 0) throw new RuntimeError("NOT_ENOUGH_FUNDS");
+		if (updatedBalance < 0) throw new RuntimeError("not_enough_funds");
 
 		try {
 			await setBalance(tx, req.userId, updatedBalance);
 		} catch {
-			throw new RuntimeError("INVALID_AMOUNT");
+			throw new RuntimeError("invalid_amount");
 		}
 
 		return {
diff --git a/modules/currency/utils/set_balance.ts b/modules/currency/utils/set_balance.ts
@@ -10,7 +10,7 @@ export const setBalance = async (
 	userId: string,
 	balance: number,
 ) => {
-	if (balance < 0) throw new RuntimeError("INVALID_AMOUNT");
+	if (balance < 0) throw new RuntimeError("invalid_amount");
 
 	await db.userWallet.upsert({
 		where: {
diff --git a/modules/email/module.yaml b/modules/email/module.yaml
@@ -1,6 +1,18 @@
+name: Email
+description: Send emails using multiple providers.
+icon: envelope
+tags:
+  - email
+authors:
+  - rivet-gg
+  - NathanFlurry
+status: stable
 scripts:
-  send_email: {}
+  send_email:
+    name: Send Email
 errors:
-  EMAIL_MISSING_CONTENT:
+  email_missing_content:
+    name: Email Missing Content
     description: Email must have `html` and/or `text`
-  SENDGRID_ERROR: {}
+  sendgrid_error:
+    name: SendGrid Error
diff --git a/modules/email/scripts/send_email.ts b/modules/email/scripts/send_email.ts
@@ -22,15 +22,15 @@ export async function run(
 	req: Request,
 ): Promise<Response> {
 	if (!req.html && !req.text) {
-		throw new RuntimeError("EMAIL_MISSING_CONTENT");
+		throw new RuntimeError("email_missing_content");
 	}
 
 	if ("test" in ctx.userConfig.provider) {
 		// Do nothing
 	} else if ("sendGrid" in ctx.userConfig.provider) {
 		await useSendGrid(ctx.userConfig.provider.sendGrid, req);
 	} else {
-		throw new RuntimeError("UNREACHABLE");
+		throw new RuntimeError("unreachable");
 	}
 
 	return {};
diff --git a/modules/friends/module.yaml b/modules/friends/module.yaml
@@ -1,29 +1,56 @@
-status: preview
+name: Friends
+description: Allow users to send and accept friend requests.
+icon: user-group
+tags:
+  - social
 authors:
+  - rivet-gg
   - NathanFlurry
+status: beta
 dependencies:
   rate_limit: {}
   users: {}
 scripts:
   send_request:
+    name: Send Request
+    description: Send a friend request to another user.
     public: true
   accept_request:
+    name: Accept Request
+    description: Accept a friend request from another user.
     public: true
   decline_request:
+    name: Decline Request
+    description: Decline a friend request from another user.
     public: true
   remove_friend:
+    name: Remove Friend
+    description: Remove a friend from your friends list.
     public: true
   list_friends:
+    name: List Friends
+    description: List all friends of a user.
     public: true
   list_outgoing_friend_requests:
+    name: List Outgoing Friend Requests
+    description: List all friend requests sent by a user.
     public: true
   list_incoming_friend_requests:
+    name: List Incoming Friend Requests
+    description: List all friend requests received by a user.
     public: true
 errors:
-  ALREADY_FRIENDS: {}
-  FRIEND_REQUEST_NOT_FOUND: {}
-  FRIEND_REQUEST_ALREADY_EXISTS: {}
-  NOT_FRIEND_REQUEST_RECIPIENT: {}
-  FRIEND_REQUEST_ALREADY_ACCEPTED: {}
-  FRIEND_REQUEST_ALREADY_DECLINED: {}
-  CANNOT_SEND_TO_SELF: {}
+  already_friends:
+    name: Already Friends
+  friend_request_not_found:
+    name: Friend Request Not Found
+  friend_request_already_exists:
+    name: Friend Request Already Exists
+  not_friend_request_recipient:
+    name: Not Friend Request Recipient
+  friend_request_already_accepted:
+    name: Friend Request Already Accepted
+  friend_request_already_declined:
+    name: Friend Request Already Declined
+  cannot_send_to_self:
+    name: Cannot Send to Self
diff --git a/modules/friends/scripts/send_request.ts b/modules/friends/scripts/send_request.ts
@@ -21,7 +21,7 @@ export async function run(
 	});
 
 	if (userId === req.targetUserId) {
-		throw new RuntimeError("CANNOT_SEND_TO_SELF");
+		throw new RuntimeError("cannot_send_to_self");
 	}
 
 	// Sort the user IDs to ensure consistency
diff --git a/modules/rate_limit/module.yaml b/modules/rate_limit/module.yaml
@@ -1,8 +1,20 @@
-status: preview
+name: Rate Limit
+description: Prevent abuse by limiting request rate.
+icon: gauge-circle-minus
+tags:
+  - core
+  - utility
 authors:
+  - rivet-gg
   - NathanFlurry
+status: stable
 scripts:
-  throttle: {}
-  throttle_public: {}
+  throttle:
+    name: Throttle
+    description: Limit the amount of times an request can be made by a given key.
+  throttle_public:
+    name: Throttle Public
+    description: Limit the amount of times a public request can be made by a given key. This will rate limit based off the user's IP address.
 errors:
-  RATE_LIMIT_EXCEEDED: {}
+  rate_limit_exceeded:
+    name: Rate Limit Exceeded
diff --git a/modules/tokens/module.yaml b/modules/tokens/module.yaml
diff --git a/modules/tokens/scripts/validate.ts b/modules/tokens/scripts/validate.ts
diff --git a/modules/users/module.yaml b/modules/users/module.yaml
diff --git a/modules/users/scripts/validate_user_token.ts b/modules/users/scripts/validate_user_token.ts

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ export async function run(`
`17`	`17`	`): Promise<Response> {`
`18`	`18`	`await ctx.modules.rateLimit.throttlePublic({});`
`19`	`19`
`20`		`- if (!ctx.userConfig.email) throw new RuntimeError("PROVIDER_DISABLED");`
	`20`	`+ if (!ctx.userConfig.email) throw new RuntimeError("provider_disabled");`
`21`	`21`
`22`	`22`	`// Fetch existing user if session token is provided`
`23`	`23`	`let userId: string \| undefined;`
`@@ -31,7 +31,7 @@ export async function run(`
`31`	`31`	`where: { email: req.email },`
`32`	`32`	`});`
`33`	`33`	`if (existingIdentity && existingIdentity.userId !== userId) {`
`34`		`- throw new RuntimeError("EMAIL_ALREADY_USED");`
	`34`	`+ throw new RuntimeError("email_already_used");`
`35`	`35`	`}`
`36`	`36`	`}`
`37`	`37`
Original file line number	Diff line number	Diff line change
`@@ -45,20 +45,20 @@ export async function run(`
`45`	`45`	`},`
`46`	`46`	`});`
`47`	`47`	`if (!verification) {`
`48`		`- throw new RuntimeError("VERIFICATION_CODE_INVALID");`
	`48`	`+ throw new RuntimeError("verification_code_invalid");`
`49`	`49`	`}`
`50`	`50`	`if (verification.attemptCount >= verification.maxAttemptCount) {`
`51`		`- throw new RuntimeError("VERIFICATION_CODE_ATTEMPT_LIMIT");`
	`51`	`+ throw new RuntimeError("verification_code_attempt_limit");`
`52`	`52`	`}`
`53`	`53`	`if (verification.completedAt !== null) {`
`54`		`- throw new RuntimeError("VERIFICATION_CODE_ALREADY_USED");`
	`54`	`+ throw new RuntimeError("verification_code_already_used");`
`55`	`55`	`}`
`56`	`56`	`if (verification.code !== code) {`
`57`	`57`	`// Same error as above to prevent exploitation`
`58`		`- throw new RuntimeError("VERIFICATION_CODE_INVALID");`
	`58`	`+ throw new RuntimeError("verification_code_invalid");`
`59`	`59`	`}`
`60`	`60`	`if (verification.expireAt < new Date()) {`
`61`		`- throw new RuntimeError("VERIFICATION_CODE_EXPIRED");`
	`61`	`+ throw new RuntimeError("verification_code_expired");`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`// Mark as used`
`@@ -73,7 +73,7 @@ export async function run(`
`73`	`73`	`},`
`74`	`74`	`});`
`75`	`75`	`if (verificationConfirmation === null) {`
`76`		`- throw new RuntimeError("VERIFICATION_CODE_ALREADY_USED");`
	`76`	`+ throw new RuntimeError("verification_code_already_used");`
`77`	`77`	`}`
`78`	`78`
`79`	`79`	`// Get or create user`
Original file line number	Diff line number	Diff line change
`@@ -17,13 +17,13 @@ export async function run(`
`17`	`17`	`await ctx.modules.rateLimit.throttlePublic({ requests: 25 });`
`18`	`18`
`19`	`19`	`if (req.balance < 0 \|\| !Number.isFinite(req.balance)) {`
`20`		`- throw new RuntimeError("INVALID_AMOUNT");`
	`20`	`+ throw new RuntimeError("invalid_amount");`
`21`	`21`	`}`
`22`	`22`
`23`	`23`	`try {`
`24`	`24`	`await setBalance(ctx.db, req.userId, req.balance);`
`25`	`25`	`} catch {`
`26`		`- throw new RuntimeError("INVALID_AMOUNT");`
	`26`	`+ throw new RuntimeError("invalid_amount");`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`return {};`