refactor: enhance magic link strategy to create user if not found and update email templates

Author: tomast1337

server/src/auth/strategies/magicLinkEmail.strategy.spec.ts

@@ -12,6 +12,7 @@ describe('MagicLinkEmailStrategy', () => {
 
   const mockUserService = {
     findByEmail: jest.fn(),
+    createWithEmail: jest.fn(),
   };
 
   const mockMailingService = {
@@ -57,7 +58,10 @@ describe('MagicLinkEmailStrategy', () => {
   describe('sendMagicLink', () => {
     it('should send a magic link email', async () => {
       const email = '[email protected]';
-      const magicLink = '/api/v1/auth/magic-link/callback?token=test_token';
+
+      const magicLink =
+        'http://localhost/api/v1/auth/magic-link/callback?token=test_token';
+
       const user = { username: 'testuser', email };
 
       mockUserService.findByEmail.mockResolvedValue(user);
@@ -69,34 +73,50 @@ describe('MagicLinkEmailStrategy', () => {
       )(email, magicLink);
 
       expect(mockUserService.findByEmail).toHaveBeenCalledWith(email);
-      // TODO: Fix this test
+
       expect(mockMailingService.sendEmail).toHaveBeenCalledWith({
         to: email,
         context: {
           magicLink:
-            'http://localhost:3000/api/v1/auth/magic-link/callback?token=test_token',
+            'http://localhost/api/v1/auth/magic-link/callback?token=test_token',
           username: 'testuser',
         },
         subject: 'Noteblock Magic Link',
         template: 'magic-link',
       });
     });
 
-    it('should log an error if user is not found', async () => {
-      const email = '[email protected]';
-      const magicLink = '/api/v1/auth/magic-link/callback?token=test_token';
+    it('should create a new user if not found and send a magic link email', async () => {
+      const email = '[email protected]';
 
-      mockUserService.findByEmail.mockResolvedValue(null);
+      const magicLink =
+        'http://localhost/api/v1/auth/magic-link/callback?token=test_token';
 
-      const loggerSpy = jest.spyOn(MagicLinkEmailStrategy.logger, 'error');
+      const user = { username: 'testuser', email };
+
+      mockUserService.findByEmail.mockResolvedValue(null);
+      mockUserService.createWithEmail.mockResolvedValue(user);
 
       await MagicLinkEmailStrategy.sendMagicLink(
         'http://localhost:3000',
         userService,
         mailingService,
       )(email, magicLink);
 
-      expect(loggerSpy).toHaveBeenCalledWith('User not found');
+      expect(mockUserService.findByEmail).toHaveBeenCalledWith(email);
+
+      expect(mockUserService.createWithEmail).toHaveBeenCalledWith(email);
+
+      expect(mockMailingService.sendEmail).toHaveBeenCalledWith({
+        to: email,
+        context: {
+          magicLink:
+            'http://localhost/api/v1/auth/magic-link/callback?token=test_token',
+          username: 'testuser',
+        },
+        subject: 'Welcome to Noteblock.world',
+        template: 'magic-link-new-account',
+      });
     });
   });
 

server/src/auth/strategies/magicLinkEmail.strategy.ts

@@ -55,29 +55,30 @@ export class MagicLinkEmailStrategy extends PassportStrategy(
     async (email: string, magicLink: string) => {
       let user = await userService.findByEmail(email);
 
-      if (!user)
+      if (!user) {
         // Create user if not found
         user = await userService.createWithEmail(email);
 
-      const context = {
-        magicLink: magicLink,
-        username: user.username,
-      };
-
-      MagicLinkEmailStrategy.logger.debug(
-        `Sending magic link to ${email} with data ${JSON.stringify(
-          context,
-          null,
-          2,
-        )}`,
-      );
-
-      mailingService.sendEmail({
-        to: email,
-        context,
-        subject: 'Noteblock Magic Link',
-        template: 'magic-link',
-      });
+        mailingService.sendEmail({
+          to: email,
+          context: {
+            magicLink: magicLink,
+            username: user.username,
+          },
+          subject: 'Welcome to Noteblock.world',
+          template: 'magic-link-new-account',
+        });
+      } else {
+        mailingService.sendEmail({
+          to: email,
+          context: {
+            magicLink: magicLink,
+            username: user.username,
+          },
+          subject: 'Noteblock Magic Link',
+          template: 'magic-link',
+        });
+      }
     };
 
   async validate(payload: authenticationLinkPayload) {

server/src/mailing/templates/magic-link-new-account.hbs

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Welcome to the OpenNoteBlockWorld!</title>
+</head>
+
+<body>
+    <h1>Wellcome, {{username}}!</h1>
+    <p>Click the link below to log in to your account:</p>
+    <a href="{{magicLink}}">Login</a>
+    <p>If you did not request this login link, please ignore this email.</p>
+</body>
+
+</html>