chore: add tests for last two prs (#69)

* test: version scraping

* setup vitest

* Update .github/workflows/main.yml

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* chore: quality tools

---------

Co-authored-by: Gabriel Le Breton <[email protected]>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Author: 3 people

.github/ISSUE_TEMPLATE/bug_report.md

@@ -12,13 +12,11 @@ A clear and concise description of what the bug is.
 **To Reproduce**
 Steps to reproduce the behavior:
 
--
+- **Expected behavior**
+  A clear and concise description of what you expected to happen.
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+  **Screenshots**
+  If applicable, add screenshots to help explain your problem.
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
-
-**Additional context**
-Add any other context about the problem here.
+  **Additional context**
+  Add any other context about the problem here.

.github/workflows/main.yml

@@ -27,10 +27,24 @@ jobs:
         run: yarn install --immutable
 
       - name: run linter
-        run: yarn lint && yarn workspace functions lint
+        run: yarn lint
+
+      - name: run format
+        run: yarn format
+
+      - name: run typecheck
+        run: yarn typecheck
 
       - name: run tests
-        run: yarn test && yarn workspace functions test
+        run: yarn coverage
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/[email protected]
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          slug: game-ci/versioning-backend
+          files: ./functions/coverage/lcov.info
+          flags: unittests,integration
 
   build:
     name: 🛠 Build

.husky/pre-commit

@@ -0,0 +1,8 @@
+#!/bin/sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+# Fix from https://github.com/typicode/husky/issues/968#issuecomment-1176848345
+if [ -t 2 ] ; then exec >/dev/tty 2>&1 ; fi
+
+# Check changes that are staged for commit
+yarn lint-staged

.oxlintrc.json

@@ -0,0 +1,5 @@
+{
+  "rules": {
+    "no-unsafe-declaration-merging": "off"
+  }
+}

.prettierignore

@@ -1,3 +1,4 @@
 **/node_modules/**
 **/public/**
 **/lib/**
+**/coverage/**

.yarnrc.yml

@@ -1,3 +1,3 @@
 nodeLinker: node-modules
 
-npmRegistryServer: "https://registry.npmjs.org/"
+npmRegistryServer: 'https://registry.npmjs.org/'

DEVELOPMENT.md

@@ -52,6 +52,7 @@ This will compile the TypeScript code into JavaScript in the `lib` directory, wh
 To use Firebase Admin SDK locally:
 
 1. Download a service account key from your Firebase project settings:
+
    - Go to [Firebase Console](https://console.firebase.google.com/)
    - Select your project
    - Go to Project Settings > Service accounts
@@ -61,11 +62,13 @@ To use Firebase Admin SDK locally:
 2. Set the environment variable to the key file:
 
 **Linux / macOS**:
+
 ```bash
 export GOOGLE_APPLICATION_CREDENTIALS="/path/to/serviceAccountKey.json"
 ```
 
 **Windows (PowerShell)**:
+
 ```powershell
 $env:GOOGLE_APPLICATION_CREDENTIALS="C:\path\to\serviceAccountKey.json"
 ```
@@ -77,17 +80,20 @@ $env:GOOGLE_APPLICATION_CREDENTIALS="C:\path\to\serviceAccountKey.json"
 To test integrations locally, set these environment variables:
 
 **Discord**:
+
 ```bash
 export DISCORD_TOKEN="your_discord_token"
 ```
 
 **GitHub**:
+
 ```bash
 export GITHUB_CLIENT_SECRET="your_github_app_client_secret"
 export GITHUB_PRIVATE_KEY="your_github_app_private_key"
 ```
 
 **Internal Token**:
+
 ```bash
 export INTERNAL_TOKEN="your_internal_token"
 ```
@@ -141,11 +147,13 @@ To use Firebase Admin SDK locally:
 2. Set the environment variable to the key file
 
 **Linux / macOS**:
+
 ```bash
 export GOOGLE_APPLICATION_CREDENTIALS="/path/to/serviceAccountKey.json"
 ```
 
 **Windows (PowerShell)**:
+
 ```powershell
 $env:GOOGLE_APPLICATION_CREDENTIALS="C:\path\to\serviceAccountKey.json"
 ```
@@ -155,17 +163,20 @@ $env:GOOGLE_APPLICATION_CREDENTIALS="C:\path\to\serviceAccountKey.json"
 To test integrations locally, set these environment variables:
 
 **Discord**:
+
 ```bash
 export DISCORD_TOKEN="your_discord_token"
 ```
 
 **GitHub**:
+
 ```bash
 export GITHUB_CLIENT_SECRET="your_github_app_client_secret"
 export GITHUB_PRIVATE_KEY="your_github_app_private_key"
 ```
 
 **Internal Token**:
+
 ```bash
 export INTERNAL_TOKEN="your_internal_token"
 ```
@@ -177,16 +188,19 @@ export INTERNAL_TOKEN="your_internal_token"
 > **Note:** You need project access to deploy.
 
 1. Login to Firebase:
+
    ```bash
    firebase login
    ```
 
 2. Deploy everything:
+
    ```bash
    firebase deploy
    ```
 
    Or deploy specific services:
+
    ```bash
    firebase deploy --only functions
    ```
@@ -216,25 +230,27 @@ firebase functions:config:set internal.token="your_internal_token"
    firebase emulators:start
    ```
 4. For hot reloading during development:
+
    ```bash
    # In one terminal
    cd functions && yarn watch
-   
-   # In another terminal  
+
+   # In another terminal
    firebase emulators:start
    ```
+
 5. Test your changes
 6. Deploy when ready
 
 ## Troubleshooting
 
 - **Firebase Login Issues**: Make sure you have access to the Firebase project
-- **Emulator Port Conflicts**: 
+- **Emulator Port Conflicts**:
   - Check for services using ports 4000, 5001, 8080, or 9000
   - This project uses port 5002 for hosting to avoid conflicts with AirPlay Receiver on macOS
   - Feel free to change any port in your local `firebase.json` if you encounter conflicts
   - See the [Port Configuration](#port-configuration) section for details
-- **Java Not Found Error**: 
+- **Java Not Found Error**:
   - The Firebase emulators require Java to be installed
   - On macOS, install Java using `brew install openjdk@17` or download from [java.com](https://www.java.com)
   - Make sure Java is on your PATH: `java -version` should return the installed version
@@ -245,6 +261,6 @@ firebase functions:config:set internal.token="your_internal_token"
 - **Admin SDK Configuration Errors**:
   - Set up the `GOOGLE_APPLICATION_CREDENTIALS` environment variable as described in the [Set Up Credentials](#4-set-up-credentials) section
   - For testing, you can often ignore this warning as the emulators will still run with limited functionality
-- **Integration Issues**: 
+- **Integration Issues**:
   - Ensure all required environment variables are correctly set
   - For local development without integration testing, you can often proceed without setting these variables

functions/.eslintrc.js

@@ -21,11 +21,11 @@ module.exports = {
     '@typescript-eslint/prefer-for-of': 'warn',
     '@typescript-eslint/triple-slash-reference': 'error',
     '@typescript-eslint/unified-signatures': 'warn',
-    "@typescript-eslint/no-redeclare": [
-      "error",
+    '@typescript-eslint/no-redeclare': [
+      'error',
       {
-        "ignoreDeclarationMerge": true,
-      }
+        ignoreDeclarationMerge: true,
+      },
     ],
     'comma-dangle': ['warn', 'always-multiline'],
     'constructor-super': 'error',

functions/package.json

@@ -1,15 +1,20 @@
 {
   "name": "functions",
   "scripts": {
+    "dev": "yarn watch",
     "lint": "eslint \"src/**/*\"",
-    "build": "tsc",
-    "watch": "tsc --watch",
-    "serve": "npm run build && firebase emulators:start --only functions",
-    "shell": "npm run build && firebase functions:shell",
-    "start": "npm run shell",
+    "build": "run -T tsc",
+    "watch": "run -T tsc --watch",
+    "serve": "yarn build && firebase emulators:start --only functions",
+    "shell": "yarn build && firebase functions:shell",
+    "start": "yarn shell",
     "deploy": "firebase deploy --only functions",
     "logs": "firebase functions:log",
-    "test": "echo \"No tests yet, feel free to add\" && exit 0"
+    "test": "run -T vitest",
+    "typecheck": "run -T tsc --noEmit",
+    "coverage": "run -T vitest run --coverage",
+    "test:run": "run -T vitest run",
+    "test:ui": "run -T vitest --ui"
   },
   "engines": {
     "node": "22"
@@ -38,8 +43,7 @@
     "eslint": "^8.57.0",
     "eslint-plugin-import": "^2.29.1",
     "firebase-functions-test": "^3.3.0",
-    "jest": "^29.7.0",
-    "typescript": "^5.6.3"
+    "jest": "^29.7.0"
   },
   "private": true,
   "volta": {

functions/src/config/credential.ts

@@ -5,7 +5,7 @@ export const getCredential = (): credential.Credential => {
     const serviceAccount = require(process.env.GOOGLE_APPLICATION_CREDENTIALS ??
       '../../service-account.json');
     return credential.cert(serviceAccount);
-  } catch (e) {
+  } catch {
     return credential.applicationDefault();
   }
 };