Chore : Shifting from String to EmailAddress in Graphql Schema (#2986)

* Chore : Shifting from String to EmailAddress in Graphql Schema * Forgot to include a file * CodeRabbit suggestions * coderabbit.ai improvements * coderabbit.ai improvements:2
PalisadoesFoundation · Feb 4, 2025 · ff6784b · ff6784b
1 parent ee24a95
commit ff6784b
Show file tree

Hide file tree

Showing 12 changed files with 61 additions and 20 deletions.
diff --git a/schema.graphql b/schema.graphql
@@ -404,6 +404,11 @@ A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `dat
 """
 scalar DateTime
 
+"""
+A field whose value conforms to the standard internet email address format as specified in HTML Spec: https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address.
+"""
+scalar EmailAddress
+
 type Event {
   """
   GraphQL connection to traverse through the agenda folders that contain agenda items constituting a part of the agenda for the event.
@@ -1747,7 +1752,7 @@ input MutationCreateUserInput {
   educationGrade: UserEducationGrade
 
   """Email address of the user."""
-  emailAddress: String!
+  emailAddress: EmailAddress!
 
   """Employment status of the user."""
   employmentStatus: UserEmploymentStatus
@@ -1982,7 +1987,7 @@ input MutationSignUpInput {
   educationGrade: UserEducationGrade
 
   """Email address of the user."""
-  emailAddress: String!
+  emailAddress: EmailAddress!
 
   """Employment status of the user."""
   employmentStatus: UserEmploymentStatus
@@ -2202,7 +2207,7 @@ input MutationUpdateCurrentUserInput {
   educationGrade: UserEducationGrade
 
   """Email address of the user."""
-  emailAddress: String
+  emailAddress: EmailAddress
 
   """Employment status of the user."""
   employmentStatus: UserEmploymentStatus
@@ -2419,7 +2424,7 @@ input MutationUpdateUserInput {
   educationGrade: UserEducationGrade
 
   """Email address of the user."""
-  emailAddress: String
+  emailAddress: EmailAddress
 
   """Employment status of the user."""
   employmentStatus: UserEmploymentStatus
@@ -2965,7 +2970,7 @@ input QueryPostInput {
 """"""
 input QuerySignInInput {
   """Email address of the user."""
-  emailAddress: String!
+  emailAddress: EmailAddress!
 
   """Password of the user to sign in to talawa."""
   password: String!
@@ -3149,7 +3154,7 @@ type User {
   educationGrade: UserEducationGrade
 
   """Email address of the user."""
-  emailAddress: String
+  emailAddress: EmailAddress
 
   """Employment status of the user."""
   employmentStatus: UserEmploymentStatus

diff --git a/src/graphql/inputs/MutationCreateUserInput.ts b/src/graphql/inputs/MutationCreateUserInput.ts
@@ -61,9 +61,10 @@ export const MutationCreateUserInput = builder
 				description: "Primary education grade of the user.",
 				type: UserEducationGrade,
 			}),
-			emailAddress: t.string({
+			emailAddress: t.field({
 				description: "Email address of the user.",
 				required: true,
+				type: "EmailAddress",
 			}),
 			employmentStatus: t.field({
 				description: "Employment status of the user.",

diff --git a/src/graphql/inputs/MutationSignUpInput.ts b/src/graphql/inputs/MutationSignUpInput.ts
@@ -56,9 +56,10 @@ export const MutationSignUpInput = builder
 				description: "Primary education grade of the user.",
 				type: UserEducationGrade,
 			}),
-			emailAddress: t.string({
+			emailAddress: t.field({
 				description: "Email address of the user.",
 				required: true,
+				type: "EmailAddress",
 			}),
 			employmentStatus: t.field({
 				description: "Employment status of the user.",

diff --git a/src/graphql/inputs/MutationUpdateCurrentUserInput.ts b/src/graphql/inputs/MutationUpdateCurrentUserInput.ts
@@ -69,8 +69,9 @@ export const MutationUpdateCurrentUserInput = builder
 				description: "Primary education grade of the user.",
 				type: UserEducationGrade,
 			}),
-			emailAddress: t.string({
+			emailAddress: t.field({
 				description: "Email address of the user.",
+				type: "EmailAddress",
 			}),
 			employmentStatus: t.field({
 				description: "Employment status of the user.",

diff --git a/src/graphql/inputs/MutationUpdateUserInput.ts b/src/graphql/inputs/MutationUpdateUserInput.ts
@@ -76,8 +76,9 @@ export const MutationUpdateUserInput = builder
 				description: "Primary education grade of the user.",
 				type: UserEducationGrade,
 			}),
-			emailAddress: t.string({
+			emailAddress: t.field({
 				description: "Email address of the user.",
+				type: "EmailAddress",
 			}),
 			employmentStatus: t.field({
 				description: "Employment status of the user.",

diff --git a/src/graphql/inputs/QuerySignInInput.ts b/src/graphql/inputs/QuerySignInInput.ts
@@ -15,9 +15,10 @@ export const QuerySignInInput = builder
 	.implement({
 		description: "",
 		fields: (t) => ({
-			emailAddress: t.string({
+			emailAddress: t.field({
 				description: "Email address of the user.",
 				required: true,
+				type: "EmailAddress",
 			}),
 			password: t.string({
 				description: "Password of the user to sign in to talawa.",

diff --git a/src/graphql/scalars/EmailAddress.ts b/src/graphql/scalars/EmailAddress.ts
@@ -0,0 +1,24 @@
+import { EmailAddressResolver } from "graphql-scalars";
+import { builder } from "~/src/graphql/builder";
+
+/**
+ * A custom scalar type for validating email addresses according to RFC 5322.
+ * This ensures that all email fields in the schema are properly validated.
+ * More information at this link: {@link https://the-guild.dev/graphql/scalars/docs/scalars/email-address}
+ */
+export const EmailAddress = builder.addScalarType(
+	"EmailAddress",
+	EmailAddressResolver,
+);
+
+/**
+ * `EmailAddress` scalar type for pothos schema.
+ * The underscore prefix indicates this is an internal type definition.
+ * @example
+ * Valid: user@example.com
+ * Invalid: user@, user@.com, @example.com
+ */
+export type _EmailAddress = {
+	Input: string;
+	Output: string;
+};
diff --git a/src/graphql/scalars/index.ts b/src/graphql/scalars/index.ts
@@ -3,10 +3,12 @@ import "./Date";
 import "./DateTime";
 import "./PhoneNumber";
 import "./Upload";
+import "./EmailAddress";
 
 import type { _BigInt } from "./BigInt";
 import type { _Date } from "./Date";
 import type { DateTime } from "./DateTime";
+import type { _EmailAddress } from "./EmailAddress";
 import type { PhoneNumber } from "./PhoneNumber";
 import type { Upload } from "./Upload";
 
@@ -19,6 +21,7 @@ export type CustomScalars = {
 	DateTime: DateTime;
 	PhoneNumber: PhoneNumber;
 	Upload: Upload;
+	EmailAddress: _EmailAddress;
 };
 
 /**
@@ -29,4 +32,5 @@ export type ClientCustomScalars = {
 	Date: string;
 	DateTime: string;
 	PhoneNumber: string;
+	EmailAddress: string;
 };
diff --git a/src/graphql/types/User/emailAddress.ts b/src/graphql/types/User/emailAddress.ts
@@ -3,7 +3,7 @@ import { User } from "./User";
 
 User.implement({
 	fields: (t) => ({
-		emailAddress: t.string({
+		emailAddress: t.field({
 			description: "Email address of the user.",
 			resolve: async (parent, _args, ctx) => {
 				if (!ctx.currentClient.isAuthenticated) {
@@ -44,6 +44,7 @@ User.implement({
 
 				return parent.emailAddress;
 			},
+			type: "EmailAddress",
 		}),
 	}),
 });
diff --git a/src/routes/graphql.ts b/src/routes/graphql.ts
@@ -124,7 +124,7 @@ export const graphql = fastifyPlugin(async (fastify) => {
 					fastify,
 					isSubscription: true,
 					request,
-					socket,
+					socket: socket as unknown as WebSocket,
 				}),
 			// Intervals in milli-seconds to wait before sending the `GQL_CONNECTION_KEEP_ALIVE` message to the client to check if the connection is alive. This helps detect disconnected subscription clients and prevent unnecessary data transfer.
 			keepAlive: 1000 * 30,