refactor: clean code, add more test scripts (#34)

DanielRamosAcosta · web-flow · commit 1e541acbf988 · 2024-05-01T12:10:23.000+01:00
* add integration tests to scripts

* refactor: rename to FactorialAuthenticator, remove dead code

* refactor: remove not needed toPrimitives

* refactor: simplify workflows

* refactor: update dependencies without grouping and daily

* refactor: add auto merge bot

* only run ci if targeting main

* refactor: extract project variable to env

* chore: bump version
diff --git a/.env.example b/.env.example
@@ -1,2 +1,3 @@
 FACTORIAL_USER_EMAIL=youremail@example.com
 FACTORIAL_USER_PASSWORD=yourpassword
+FACTORIAL_PROJECT_NAME=yourprojectname
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -3,17 +3,8 @@ updates:
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
-      interval: "weekly"
-      time: "09:00"
-      timezone: "Europe/Madrid"
+      interval: "daily"
   - package-ecosystem: "npm"
     directory: "/"
-    groups:
-      dependencies:
-        dependency-type: production
-      dev-dependencies:
-        dependency-type: development
     schedule:
-      interval: "weekly"
-      time: "09:00"
-      timezone: "Europe/Madrid"
+      interval: "daily"
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,29 +1,20 @@
 name: CI
 
-on: [push, pull_request]
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["main"]
 
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
         with:
-          fetch-depth: 2
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20
-
-      - name: Install dependencies
-        run: npm install
-
-      - name: Check types
-        run: npm run typecheck
-
-      - name: Run the tests
-        run: npm run test
-
-      - name: Build
-        run: npm run build
+          node-version: 22
+      - run: npm ci
+      - run: npm run typecheck
+      - run: npm run test
+      - run: npm run build
diff --git a/.github/workflows/dependabot.yml b/.github/workflows/dependabot.yml
@@ -0,0 +1,14 @@
+name: auto-merge
+
+on:
+  pull_request:
+
+jobs:
+  auto-merge:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ahmadnassri/action-dependabot-auto-merge@v2
+        with:
+          target: major
+          github-token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
diff --git a/.github/workflows/npm-publish.yml b/.github/workflows/npm-publish.yml
@@ -15,12 +15,9 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: 20
-      - name: Install dependencies
-        run: npm ci
-      - name: Build
-        run: npm run build
-      - name: Test
-        run: npm test
+      - run: npm ci
+      - run: npm run build
+      - run: npm test
 
   publish-npm:
     needs: build
@@ -31,11 +28,8 @@ jobs:
         with:
           node-version: 20
           registry-url: https://registry.npmjs.org
-      - name: Install dependencies
-        run: npm ci
-      - name: Build
-        run: npm run build
-      - name: Publish
-        run: npm publish
+      - run: npm ci
+      - run: npm run build
+      - run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
diff --git a/.gitignore b/.gitignore
@@ -6,3 +6,4 @@ build
 
 node_modules
 dist
+coverage
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "factorial-cli",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "type": "module",
   "description": "Fill your factorial shifts with ease",
   "main": "dist/src/infrastructure/cli/main.js",
@@ -12,6 +12,8 @@
   "scripts": {
     "test": "npm run test:unitary",
     "test:unitary": "vitest --config vite.config.unitary.ts",
+    "test:integration": "vitest --config vite.config.integration.ts",
+    "test:e2e": "vitest --config vite.config.e2e.ts",
     "build": "tsc",
     "clean": "rimraf dist coverage",
     "typecheck": "tsc --noEmit"
diff --git a/src/domain/models/Day.ts b/src/domain/models/Day.ts
@@ -1,13 +1,16 @@
-import { Primitives } from "../../shared/Primitives.js";
-import { Leave } from "./Leave.js";
+import { Leave, LeavePrimitives } from "./Leave.js";
 import { PeriodId } from "./PeriodId.js";
 import { Shift } from "./Shift.js";
 import { DayRange } from "./DayRange.js";
 import { DayNumber } from "./DayNumber.js";
 import { MonthOfTheYear } from "./MonthOfTheYear.js";
 import { EmployeeId } from "./EmployeeId.js";
 
-export type DayPrimitives = Primitives<Day>;
+export type DayPrimitives = {
+  dayNumber: number;
+  leaves: Array<LeavePrimitives>;
+  isLaborable: boolean;
+};
 
 export class Day {
   static fromPrimitives(primitives: DayPrimitives) {
@@ -18,10 +21,6 @@ export class Day {
     );
   }
 
-  static toPrimitives(day: Day) {
-    return day.toPrimitives();
-  }
-
   static at(number: number) {
     return new Day(new DayNumber(number), [], true);
   }
@@ -56,14 +55,6 @@ export class Day {
     );
   }
 
-  toPrimitives() {
-    return {
-      dayNumber: this.dayNumber.toPrimitives(),
-      leaves: this.leaves.map(Leave.toPrimitives),
-      isLaborable: this.isLaborable,
-    };
-  }
-
   toString(): string {
     return this.dayNumber.toString();
   }
diff --git a/src/domain/models/Leave.ts b/src/domain/models/Leave.ts
@@ -1,21 +1,11 @@
-import { Primitives } from "../../shared/Primitives.js";
-
-export type LeavePrimitives = Primitives<Leave>;
+export type LeavePrimitives = {
+  name: string;
+};
 
 export class Leave {
   static fromPrimitives(primitives: LeavePrimitives) {
     return new Leave(primitives.name);
   }
 
-  static toPrimitives(leave: Leave) {
-    return leave.toPrimitives();
-  }
-
   constructor(private readonly name: string) {}
-
-  toPrimitives() {
-    return {
-      name: this.name,
-    };
-  }
 }
diff --git a/src/domain/models/Month.ts b/src/domain/models/Month.ts
@@ -1,8 +1,10 @@
-import { Day } from "./Day.js";
-import { Primitives } from "../../shared/Primitives.js";
-import { MonthOfTheYear } from "./MonthOfTheYear.js";
+import { Day, DayPrimitives } from "./Day.js";
+import { MonthOfTheYear, MonthOfTheYearPrimitives } from "./MonthOfTheYear.js";
 
-type MonthPrimitives = Primitives<Month>;
+type MonthPrimitives = {
+  monthOfTheYear: MonthOfTheYearPrimitives;
+  days: Array<DayPrimitives>;
+};
 
 export class Month {
   static fromPrimitives(primitives: MonthPrimitives) {
@@ -20,11 +22,4 @@ export class Month {
   daysBefore(date: Date) {
     return this.days.filter((day) => day.toDate(this.monthOfTheYear) < date);
   }
-
-  toPrimitives() {
-    return {
-      monthOfTheYear: this.monthOfTheYear.toPrimitives(),
-      days: this.days.map(Day.toPrimitives),
-    };
-  }
 }
diff --git a/src/infrastructure/factorial-client/FactorialClient.integration-test.ts b/src/infrastructure/factorial-client/FactorialClient.integration-test.ts
@@ -1,7 +1,7 @@
 import { beforeAll, beforeEach, describe, expect, it } from "vitest";
 import { FactorialClient } from "./FactorialClient.js";
 
-describe.skip("FactorialClient", () => {
+describe("FactorialClient", () => {
   let client: FactorialClient;
   const employeeId = 292281;
 
diff --git a/src/infrastructure/factorial-client/FactorialClient.ts b/src/infrastructure/factorial-client/FactorialClient.ts
@@ -1,6 +1,6 @@
 import camelcaseKeys from "camelcase-keys";
 import { HttpClientFetch } from "../http-client/HttpClientFetch.js";
-import { FactorialLogger } from "../factorial-logger/FactorialLogger.js";
+import { FactorialAuthenticator } from "../factorial-logger/FactorialAuthenticator.js";
 import { Employees } from "./schema/Employees.js";
 import { Periods } from "./schema/Periods.js";
 import { Calendar } from "./schema/Calendar.js";
@@ -17,13 +17,13 @@ export class FactorialClient {
     password = config.password,
   } = {}) {
     const client = HttpClientFetch.create();
-    const logger = new FactorialLogger(client);
+    const authenticator = new FactorialAuthenticator(client);
 
-    const cookie = await logger.login({ email, password });
+    const cookie = await authenticator.login({ email, password });
 
     const authenticatedClient = HttpClientFetch.create({
       baseURL: "https://api.factorialhr.com",
-      headers: FactorialLogger.authenticatedHeadersWith(cookie),
+      headers: FactorialAuthenticator.authenticatedHeadersWith(cookie),
     });
 
     return new FactorialClient(authenticatedClient);
diff --git a/src/infrastructure/factorial-logger/FactorialAuthenticator.integration-test.ts b/src/infrastructure/factorial-logger/FactorialAuthenticator.integration-test.ts
@@ -1,11 +1,11 @@
 import { describe, expect, it } from "vitest";
-import { FactorialLogger } from "./FactorialLogger.js";
+import { FactorialAuthenticator } from "./FactorialAuthenticator.js";
 import { HttpClientFetch } from "../http-client/HttpClientFetch.js";
 import { config } from "../config.js";
 
-describe("FactorialLogger", () => {
+describe("FactorialAuthenticator", () => {
   it("returns the session cookie", async () => {
-    const logger = new FactorialLogger(HttpClientFetch.create());
+    const logger = new FactorialAuthenticator(HttpClientFetch.create());
 
     const cookie = await logger.login({
       email: config.email,
@@ -17,7 +17,7 @@ describe("FactorialLogger", () => {
   });
 
   it("throws an error if password is invalid", async () => {
-    const logger = new FactorialLogger(HttpClientFetch.create());
+    const logger = new FactorialAuthenticator(HttpClientFetch.create());
 
     const result = logger.login({
       email: "some@one.com",
diff --git a/src/infrastructure/factorial-logger/FactorialAuthenticator.ts b/src/infrastructure/factorial-logger/FactorialAuthenticator.ts
@@ -6,7 +6,7 @@ type Credentials = {
   password: string;
 };
 
-export class FactorialLogger {
+export class FactorialAuthenticator {
   private static LOGIN_URL = "https://api.factorialhr.com/es/users/sign_in";
 
   public static authenticatedHeadersWith(cookie: string) {
@@ -31,7 +31,9 @@ export class FactorialLogger {
       throw new Error("Password must be provided");
     }
 
-    const response = await this.http.get<string>(FactorialLogger.LOGIN_URL);
+    const response = await this.http.get<string>(
+      FactorialAuthenticator.LOGIN_URL,
+    );
     const session = this.getSessionCookieFrom(response);
     const authenticityToken = this.getAuthenticityTokenFrom(response);
 
@@ -42,10 +44,10 @@ export class FactorialLogger {
     });
 
     const authenticatedResponse = await this.http.post(
-      FactorialLogger.LOGIN_URL,
+      FactorialAuthenticator.LOGIN_URL,
       params.toString(),
       {
-        headers: FactorialLogger.authenticatedHeadersWith(session),
+        headers: FactorialAuthenticator.authenticatedHeadersWith(session),
         maxRedirects: 0,
       },
     );
@@ -56,7 +58,7 @@ export class FactorialLogger {
   }
 
   private ensureIsOk(authenticatedResponse: HttpResponse) {
-    if (authenticatedResponse.data.includes(FactorialLogger.LOGIN_URL)) {
+    if (authenticatedResponse.data.includes(FactorialAuthenticator.LOGIN_URL)) {
       throw new Error("Invalid email or password");
     }
   }
diff --git a/src/infrastructure/http-client/HttpClientFetch.ts b/src/infrastructure/http-client/HttpClientFetch.ts
@@ -27,15 +27,8 @@ export class HttpClientFetch implements HttpClient {
 
   constructor(private options: PrivateHttpClientOptions) {}
 
-  updateConfig(options: HttpClientOptions) {
-    this.options = {
-      ...this.options,
-      ...options,
-    };
-  }
-
   async get<T = any>(
-    url: string,
+    path: string,
     options?: RequestOptions,
   ): Promise<HttpResponse<T>> {
     const fetchOptions: RequestInit = {
@@ -46,7 +39,7 @@ export class HttpClientFetch implements HttpClient {
       },
     };
 
-    let newLocal = this.options.baseURL + url;
+    let url = this.options.baseURL + path;
 
     if (options?.params) {
       const params = new URLSearchParams();
@@ -55,10 +48,10 @@ export class HttpClientFetch implements HttpClient {
         params.append(key, value.toString());
       });
 
-      newLocal += `?${params.toString()}`;
+      url += `?${params.toString()}`;
     }
 
-    const response = await fetch(newLocal, fetchOptions);
+    const response = await fetch(url, fetchOptions);
 
     const headers: Record<string, string> = {};
 
diff --git a/test/e2e/FillShifts.e2e-test.ts b/test/e2e/FillShifts.e2e-test.ts
@@ -14,13 +14,18 @@ describe("FillShifts", () => {
   });
 
   it("saves the shifts", async () => {
+    const year = new Date().getFullYear();
+    const month = new Date().getMonth() + 1;
     const start = MomentOfTheDay.oClock(8);
     const end = MomentOfTheDay.oClock(16);
     const dayRange = DayRange.from(start).to(end);
+    const projectName = process.env.FACTORIAL_PROJECT_NAME;
+
+    if (!projectName) throw new Error("FACTORIAL_PROJECT_NAME is not set");
 
     await app.fillShifts.execute({
-      monthOfTheYear: MonthOfTheYear.at(2024, 1),
-      projectName: "My project",
+      monthOfTheYear: MonthOfTheYear.at(year, month),
+      projectName,
       dayRange,
       maxRandomMinute: new Minute(10),
     });
diff --git a/vite.config.e2e.ts b/vite.config.e2e.ts
diff --git a/vite.config.integration.ts b/vite.config.integration.ts

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
`1`	`1`	`FACTORIAL_USER_EMAIL=[email protected]`
`2`	`2`	`FACTORIAL_USER_PASSWORD=yourpassword`
	`3`	`+FACTORIAL_PROJECT_NAME=yourprojectname`
Original file line number	Diff line number	Diff line change
`@@ -6,3 +6,4 @@ build`
`6`	`6`
`7`	`7`	`node_modules`
`8`	`8`	`dist`
	`9`	`+coverage`