omg: migrate nest server to netlify functions (#977)

Author: moshfeu

.env

@@ -41,4 +41,79 @@ debug.log
 
 # Next.js
 .next
+server/src/app.module.ts
+server/src/logger.ts
+server/src/main.ts
+server/src/config/index.ts
+server/src/database/database.module.ts
+server/src/database/database.providers.ts
+server/src/middlewares/auth.middleware.ts
+server/src/modules/admin/admin.controller.ts
+server/src/modules/admin/admin.module.ts
+server/src/modules/admin/__tests__/mentors.controller.spec.ts
+server/src/modules/common/auth0.service.ts
+server/src/modules/common/common.module.ts
+server/src/modules/common/common.providers.ts
+server/src/modules/common/file.service.ts
+server/src/modules/common/mentors.service.ts
+server/src/modules/common/users.service.ts
+server/src/modules/common/dto/application.dto.ts
+server/src/modules/common/dto/filter.dto.ts
+server/src/modules/common/dto/findOneParams.dto.ts
+server/src/modules/common/dto/mentorfilters.dto.ts
+server/src/modules/common/dto/pagination.dto.ts
+server/src/modules/common/dto/user-record.dto.ts
+server/src/modules/common/dto/user.dto.ts
+server/src/modules/common/interfaces/application.interface.ts
+server/src/modules/common/interfaces/filemeta.interface.ts
+server/src/modules/common/interfaces/user-record.interface.ts
+server/src/modules/common/interfaces/user.interface.ts
+server/src/modules/common/pipes/pagination.pipe.ts
+server/src/modules/common/schemas/application.schema.ts
+server/src/modules/common/schemas/user-record.schema.ts
+server/src/modules/common/schemas/user.schema.ts
+server/src/modules/email/email.module.ts
+server/src/modules/email/email.service.ts
+server/src/modules/email/interfaces/email.interface.ts
+server/src/modules/lists/favorites.controller.ts
+server/src/modules/lists/list.providers.ts
+server/src/modules/lists/lists.controller.ts
+server/src/modules/lists/lists.module.ts
+server/src/modules/lists/lists.service.ts
+server/src/modules/lists/__tests__/favorites.controller.spec.ts
+server/src/modules/lists/__tests__/lists.controller.spec.ts
+server/src/modules/lists/dto/list.dto.ts
+server/src/modules/lists/interfaces/list.interface.ts
+server/src/modules/lists/schemas/list.schema.ts
+server/src/modules/mentors/mentors.controller.ts
+server/src/modules/mentors/mentors.module.ts
+server/src/modules/mentors/__tests__/mentors.controller.spec.ts
+server/src/modules/mentorships/mentorships.controller.ts
+server/src/modules/mentorships/mentorships.module.ts
+server/src/modules/mentorships/mentorships.providers.ts
+server/src/modules/mentorships/mentorships.service.ts
+server/src/modules/mentorships/mentorshipsToDto.ts
+server/src/modules/mentorships/__tests__/mentorships.controller.spec.ts
+server/src/modules/mentorships/dto/mentorship.dto.ts
+server/src/modules/mentorships/dto/mentorshipSummary.dto.ts
+server/src/modules/mentorships/dto/mentorshipUpdatePayload.dto.ts
+server/src/modules/mentorships/interfaces/mentorship.interface.ts
+server/src/modules/mentorships/schemas/mentorship.schema.ts
+server/src/modules/reports/reports.controller.ts
+server/src/modules/reports/reports.module.ts
+server/src/modules/reports/reports.service.ts
+server/src/modules/reports/__tests__/reports.controller.spec.ts
+server/src/modules/reports/interfaces/totals.interface.ts
+server/src/modules/users/users.controller.ts
+server/src/modules/users/users.module.ts
+server/src/modules/users/__tests__/users.controller.spec.ts
+server/src/utils/mimes.ts
+server/src/utils/objectid.ts
+server/src/utils/request.d.ts
+
+# Local Netlify folder
+.netlify
+netlify/functions/**/*.js
+# Environment variables
+.env*
 .netlify

.env.development

@@ -1,3 +1,4 @@
 .next
 build
-tsconfig.json
+tsconfig.json
+netlify

.gitignore

@@ -6,9 +6,6 @@
 [![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-%230074c1.svg)](http://www.typescriptlang.org/)
 
 
-[![Powered By Vercel](https://github.com/Coding-Coach/find-a-mentor/blob/3390fb723a8148c06ea88a7fdb972fd81b5a6064/src/assets/powered-by-vercel.svg)](https://vercel.com/codingcoach?utm_source=coding-coach&utm_campaign=oss)
-
-
 ## Support Us
 
 CodingCoach is a FREE platform that is built and managed entirely by volunteers. As always, there are ongoing costs to run this site such as servers, domains, email, and more.  Please consider becoming a patron so we can continue our mission of being accessible and free ❤️

.prettierignore

@@ -0,0 +1,3 @@
+export enum ErrorCodes {
+  EmailNotVerified = 1,
+}

README.md

@@ -0,0 +1,21 @@
+# Authentication System
+
+We're using Auth0 to handle authentication in our application. This document outlines the authentication flow and how to set up your environment for development.
+
+## Registration
+
+1. User clicks on the "Sign Up" button.
+2. User is redirected to the Auth0 login page.
+3. User enters their email and password.
+4. Auth0 sends a verification email, which we leverage for the welcome email.
+5. User clicks on the verification link in the email.
+6. User is redirected to the application with a verification token. For more information about the redirection see the [docs](https://auth0.com/docs/customize/email/email-templates#configure-template-fields) - open the "Redirect the URL" section.
+> **ℹ️ Info**
+> Remember. The application.callback_domain variable will contain the origin of the first URL listed in the application's Allowed Callback URL list
+
+## Authentication
+
+1. User clicks on the "Log In" button.
+2. User is redirected to the Auth0 login page.
+3. User enters their email and password.
+4. Auth0 verifies the credentials and redirects the user back to the application with an access token which includes auth0id and an `email_verified` and `picture` added by a [custom action](https://manage.auth0.com/dashboard/eu/codingcoach/actions/library/details/e425e5f6-fcd0-4ec9-a3b5-68b3ef8eca75). `email_verified` is enabled by the `email` scope and `picture` is enabled by the `profile` scope.

api-types/errorCodes.ts

@@ -2,9 +2,16 @@
   command = "yarn build"
   publish = ".next"
 
+[functions]
+  directory = "netlify/functions-src/functions"
+  included_files = ["netlify/functions-src/functions/email/templates/**.html"]
+
+[dev]
+  command = "yarn start"
+
 [build.environment]
   NEXT_TELEMETRY_DISABLED = "1"
   NODE_VERSION = "18"
 
 [[plugins]]
-  package = "@netlify/plugin-nextjs"
+  package = "@netlify/plugin-nextjs"

docs/auth.md

@@ -0,0 +1,48 @@
+import Config from '../config';
+
+const auth0Domain = Config.auth0.backend.DOMAIN;
+
+const getAdminAccessToken = async (): Promise<string> => {
+  try {
+
+    const response = await fetch(`https://${auth0Domain}/oauth/token`, {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+      },
+      body: JSON.stringify({
+        client_id: Config.auth0.backend.CLIENT_ID,
+        client_secret: Config.auth0.backend.CLIENT_SECRET,
+        audience: Config.auth0.backend.AUDIENCE,
+        grant_type: 'client_credentials',
+      }),
+    });
+    const data = await response.json();
+    return data.access_token;
+  } catch (error) {
+    // eslint-disable-next-line no-console
+    console.error('Error fetching admin access token:', error);
+    throw new Error('Failed to fetch access token');
+  }
+};
+
+
+export const deleteUser = async (userId: string): Promise<void> => {
+  const accessToken = await getAdminAccessToken();
+  if (!accessToken) {
+    throw new Error('Failed to get access token');
+  }
+
+  const response = await fetch(`https://${auth0Domain}/api/v2/users/${userId}`, {
+    method: 'DELETE',
+    headers: {
+      Authorization: `Bearer ${accessToken}`,
+    },
+  });
+
+  if (!response.ok) {
+    throw new Error(`Failed to delete user: ${response.statusText}`);
+  }
+
+  return response.json();
+}

netlify.toml

@@ -0,0 +1,79 @@
+import axios, { type AxiosResponse } from 'axios'
+import Config from '../config'
+
+class Auth0Service {
+  private readonly auth0Domain = Config.auth0.backend.DOMAIN
+  private readonly clientId = Config.auth0.backend.CLIENT_ID
+  private readonly clientSecret = Config.auth0.backend.CLIENT_SECRET
+  private readonly audience = Config.auth0.backend.AUDIENCE
+
+  async getAdminAccessToken(): Promise<AxiosResponse<{ access_token: string }>['data']> {
+    try {
+      const response = await axios.post(`https://${this.auth0Domain}/oauth/token`, {
+        client_id: this.clientId,
+        client_secret: this.clientSecret,
+        audience: this.audience,
+        grant_type: 'client_credentials',
+      })
+      return response.data
+    } catch (error) {
+      console.error('getAdminAccessToken, Error:', error)
+      throw new Error('Error getting access token')
+    }
+  }
+
+  async getUserProfile(auth0Id: string): Promise<AxiosResponse<{ email: string, nickname: string, picture: string }>['data']> {
+    try {
+      const { access_token } = await this.getAdminAccessToken();
+      const response = await axios.get(`https://${this.auth0Domain}/api/v2/users/${auth0Id}`, {
+        headers: {
+          Authorization: `Bearer ${access_token}`,
+        },
+      })
+      return response.data
+    } catch (error) {
+      console.error('getUserProfile, Error:', error)
+      throw new Error('Error getting user profile')
+    }
+  }
+
+  async deleteUser(accessToken: string, userId: string): Promise<void> {
+    await axios.delete(`https://${this.auth0Domain}/api/v2/users/${userId}`, {
+      headers: {
+        Authorization: `Bearer ${accessToken}`,
+      },
+    })
+  }
+
+  async createVerificationEmailTicket(
+    auth0UserId: string,
+  ) {
+    try {
+      const { access_token: accessToken } = await this.getAdminAccessToken();
+      const [provider, userId] = auth0UserId.split('|');
+      const payload = {
+        result_url: Config.urls.CLIENT_BASE_URL,
+        user_id: auth0UserId,
+        identity: { user_id: userId, provider },
+      };
+
+      const response = await axios.post(
+        `https://${Config.auth0.backend.DOMAIN}/api/v2/tickets/email-verification`,
+        payload,
+        {
+          headers: {
+            Authorization: `Bearer ${accessToken}`,
+            'content-type': 'application/json',
+          },
+        },
+      );
+
+      return response.data;
+    } catch (error) {
+      console.error('createVerificationEmailTicket, Error:', error)
+      throw error;
+    }
+  }
+}
+
+export const auth0Service = new Auth0Service();