feat(auth): add facebook sign in/up

.dockerignore

@@ -1,9 +1,38 @@
+# Git
+/.git
+/.gitignore
+
+# GitHub
 /.github
-/.husky
-/.vscode
+
+# Build
 /dist
 /dist-lint
-/localstack
 /node_modules
+/coverage
+
+# DevTools
+/.husky
+/.vscode
+/localstack
+/.czrc
+/.editorconfig
+/.eslintrc.js
+/.lintstagedrc
+/.nvmrc
+/jest.config.json
+/LICENSE
+/redocly.yaml
+
+# Env
+.env.*
+!.env.docker
+!/prisma/.env
+
+# Deploy
+/appspec.yml
+
+# Unnecessary
 /openapi
 /scripts
+/testes

.env.example

@@ -10,6 +10,9 @@ AWS_REGION=us-east-1
 GOOGLE_CLIENT_ID=
 GOOGLE_CLIENT_SECRET=
 
+FACEBOOK_CLIENT_ID=
+FACEBOOK_CLIENT_SECRET=
+
 PASETO_PRIVATE_KEY=2MPoBMMJwdnHwx5qIso9RcxR5o3SycCgBgWFeHCE2Oz6uI3sCLGOQLqwdmRAPFmU28UPMc9FGuncPy3tpKq+bg==
 
 DATABASE_URL=postgresql://username:password@postgres:5432/database?schema=public

.github/workflows/api-deploy.yml

@@ -33,7 +33,9 @@ jobs:
           envkey_AWS_REGION: ${{ secrets.AWS_REGION }}
           envkey_GOOGLE_CLIENT_ID: ${{ secrets.GOOGLE_CLIENT_ID }}
           envkey_GOOGLE_CLIENT_SECRET: ${{ secrets.GOOGLE_CLIENT_SECRET }}
-          envkey_JWT_SECRET: ${{ secrets.JWT_SECRET }}
+          envkey_FACEBOOK_CLIENT_ID: ${{ secrets.FACEBOOK_CLIENT_ID }}
+          envkey_FACEBOOK_CLIENT_SECRET: ${{ secrets.FACEBOOK_CLIENT_SECRET }}
+          envkey_PASETO_PRIVATE_KEY: ${{ secrets.PASETO_PRIVATE_KEY }}
           envkey_DATABASE_URL: ${{ secrets.DATABASE_URL }}
 
       - name: Build

.gitignore

@@ -39,6 +39,7 @@ lerna-debug.log*
 .env
 .env.*
 !.env.example
+!/prisma/.env
 
 # Temp
 /tmp

Dockerfile.dev

@@ -3,14 +3,11 @@ FROM node:20
 WORKDIR /app
 
 COPY ./package.json ./package.json
-COPY ./pnpm-lock.yaml ./pnpm-lock.yaml
 
-RUN pnpm i --ignore-scripts
-
-ADD ./prisma ./prisma
-
-RUN pnpm run prepare
+RUN npm i --ignore-scripts --no-package-lock
 
 ADD ./ ./
 
-CMD pnpm run start:docker
+RUN npm run db:prisma
+
+CMD npm run start:docker

README.md

@@ -38,6 +38,13 @@ This project use lot's of tools to be as efficient as possible, here's the list
 - [API](https://econominhas.readme.io/reference/)
 - [Database](https://dbdocs.io/henriqueleite42/Econominhas?view=relationships)
 
+### Running the API for the first time
+
+1. Copy and paste <code>.env.example</code> and rename the copy to <code>.env.docker</code>
+2. Run <code>pnpm run start:db</code>
+3. Open another console tab and run `pnpm run db:gen-migration <MIGRATION_NAME>`
+4. The API will be available at http://localhost:3000/v1
+
 ## Useful commands
 
 | Command                   | Description                                                                                                                    |
@@ -209,14 +216,4 @@ This phase is were we convert the documentation to code and make everything work
 	</tbody>
 </table>
 
-### Running the API for the first time
-
-1. Copy and paste <code>.env.example</code> and rename the copy to <code>.env</code>
-2. Run <code>pnpm run start:dev</code>
-3. Run econominhas-api migrations
-   - Step 2.1: List id container Run<code>docker ps</code>
-   - Step 2.2: Run <code>docker exec -it \<container id\> sh</code>
-   - Step 2.3: Run <code>pnpm run db:migrate</code>
-4. Available at http://localhost:3000/v1
-
 <br/>

docker-compose.yml

@@ -44,7 +44,7 @@ services:
     ports:
       - 3000:3000
     env_file:
-      - .env
+      - .env.docker
     volumes:
       - ./:/app/
     networks:

localstack/buckets.sh

@@ -1,18 +1,17 @@
 #!/usr/bin/env bash
-bucket1="las-musas-public"
-bucket2="las-musas-private"
+bucket1="econominhas-public"
+bucket2="econominhas-private"
 
-##buckets verification
 if awslocal s3 ls "s3://$bucket1" 2>/dev/null; then
-    echo "[INFO] $bucket1 bucket already exists"
-else 
-    awslocal s3 mb s3://$bucket1
-    echo "[INFO] $bucket1 created"
+	echo "[INFO] $bucket1 bucket already exists"
+else
+	awslocal s3 mb s3://$bucket1
+	echo "[INFO] $bucket1 created"
 fi
 
 if awslocal s3 ls "s3://$bucket2" 2>/dev/null; then
-    echo "[INFO] $bucket2 bucket already exists"
-else 
-    awslocal s3 mb s3://$bucket2
-    echo "[INFO] $bucket2 created"
+	echo "[INFO] $bucket2 bucket already exists"
+else
+	awslocal s3 mb s3://$bucket2
+	echo "[INFO] $bucket2 created"
 fi

openapi/openapi.yaml

@@ -65,6 +65,8 @@ servers:
 paths:
   /auth/google:
     $ref: paths/auth/google.yaml
+  /auth/facebook:
+    $ref: paths/auth/facebook.yaml
   /auth/email:
     $ref: paths/auth/email.yaml
   /auth/phone:

openapi/paths/auth/facebook.yaml

@@ -0,0 +1,15 @@
+post:
+  tags:
+    - Auth
+  summary: Sign In/Up with Facebook
+  description: |
+    Sign Ins or Sign Ups a user using a facebook account
+  operationId: auth-facebook
+  requestBody:
+    content:
+      application/json:
+        schema:
+          $ref: ../../components/schemas/auth-with-external-provider.yaml
+    required: true
+  responses:
+    $ref: ../../components/responses/auth.yaml

openapi/paths/auth/google.yaml

@@ -9,7 +9,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: ../../components/schemas/auth-with-3rd-party.yaml
+          $ref: ../../components/schemas/auth-with-external-provider.yaml
     required: true
   responses:
     $ref: ../../components/responses/auth.yaml

package.json

@@ -12,7 +12,6 @@
 		"type": "git",
 		"url": "git+https://github.com/econominhas/backend.git"
 	},
-	"packageManager": "^[email protected]",
 	"engines": {
 		"node": ">=20"
 	},
@@ -94,7 +93,7 @@
 		"format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"",
 		"start": "nest start",
 		"start:docker": "nest start --watch",
-		"start:dev": "docker compose up",
+		"start:dev": "docker compose up --build",
 		"start:db": "docker compose up postgres",
 		"start:prod": "node main",
 		"clean:docker": "docker container rm econominhas-api && docker image rm econominhas-api",

prisma/.env

@@ -0,0 +1 @@
+DATABASE_URL=postgresql://username:password@localhost:5432/database?schema=public

prisma/migrations/20240410001429_add_facebook_to_providers/migration.sql

@@ -0,0 +1,5 @@
+-- AlterEnum
+ALTER TYPE "sign_in_provider_enum" ADD VALUE 'FACEBOOK';
+
+-- AlterTable
+ALTER TABLE "sign_in_providers" ALTER COLUMN "refresh_token" DROP NOT NULL;

prisma/schema.prisma

@@ -27,6 +27,7 @@ datasource db {
 // **********************************
 
 enum SignInProviderEnum {
+  FACEBOOK
   GOOGLE
 
   @@map("sign_in_provider_enum")
@@ -65,7 +66,7 @@ model SignInProvider {
   provider     SignInProviderEnum
   providerId   String             @map("provider_id") @db.VarChar(50)
   accessToken  String             @map("access_token") @db.VarChar(250)
-  refreshToken String             @map("refresh_token") @db.VarChar(250)
+  refreshToken String?            @map("refresh_token") @db.VarChar(250)
   expiresAt    DateTime           @map("expires_at")
 
   account Account @relation(fields: [accountId], references: [id], onDelete: Cascade)

src/adapters/google.ts → src/adapters/auth-provider.ts

@@ -6,7 +6,7 @@ export interface ExchangeCodeInput {
 export interface ExchangeCodeOutput {
 	scopes: Array<string>;
 	accessToken: string;
-	refreshToken: string;
+	refreshToken?: string;
 	expiresAt: Date;
 }
 
@@ -17,12 +17,8 @@ export interface GetAuthenticatedUserDataOutput {
 	isEmailVerified: boolean;
 }
 
-export abstract class GoogleAdapter {
-	readonly requiredScopes = [
-		"https://www.googleapis.com/auth/userinfo.profile",
-		"openid",
-		"https://www.googleapis.com/auth/userinfo.email",
-	];
+export abstract class AuthProviderAdapter {
+	abstract requiredScopes: Array<string>;
 
 	abstract exchangeCode(i: ExchangeCodeInput): Promise<ExchangeCodeOutput>;
 

src/adapters/email.ts

@@ -2,7 +2,7 @@ import { type Account } from "@prisma/client";
 
 export const EMAIL_TEMPLATES = {
 	MAGIC_LINK_LOGIN: {
-		from: "",
+		from: "[email protected]",
 		title: "",
 		body: "",
 	},

src/adapters/implementations/facebook/facebook.module.ts

@@ -0,0 +1,20 @@
+import { Module } from "@nestjs/common";
+import { ConfigModule } from "@nestjs/config";
+import axios from "axios";
+
+import { DayJsAdapterModule } from "../dayjs/dayjs.module";
+
+import { FacebookAdapterService } from "./facebook.service";
+
+@Module({
+	imports: [DayJsAdapterModule, ConfigModule],
+	providers: [
+		{
+			provide: "axios",
+			useValue: axios,
+		},
+		FacebookAdapterService,
+	],
+	exports: [FacebookAdapterService],
+})
+export class FacebookAdapterModule {}