refactor: better define the api bounderies of the module

.github/codecov.yml

@@ -0,0 +1,34 @@
+component_management:
+  default_rules:
+    statuses:
+      - type: project
+        target: auto
+      - type: patch
+        target: auto
+  individual_components:
+    - component_id: server
+      name: Server
+      paths:
+        - "apps/server/src/**"
+    - component_id: config
+      name: Config
+      paths:
+        - libs/config/src/**
+    - component_id: web
+      name: Web
+      paths:
+        - libs/web/src/**
+    - component_id: utils
+      name: Utils
+      paths:
+        - libs/util/src/**
+    - component_id: all_tests
+      name: All Tests
+      paths:
+        - "apps/*/test/**"
+        - "libs/*/test/**"
+
+comment:
+  layout: diff, flags, components, files, header, footer
+  hide_project_coverage: false
+  show_carryforward_flags: true

.github/workflows/ci.yml

@@ -10,7 +10,6 @@ permissions:
   actions: read
   contents: read
 
-
 jobs:
   main:
     runs-on: ubuntu-22.04
@@ -25,8 +24,9 @@ jobs:
       # Run this command as early as possible, before dependencies are installed
       # Learn more at https://nx.dev/ci/reference/nx-cloud-cli#npx-nxcloud-startcirun
       # Connect your workspace by running "nx connect" and uncomment this
-      # - run: pnpm dlx nx-cloud start-ci-run --distribute-on="3 linux-medium-js" --stop-agents-after="build"
-
+      - run: pnpm dlx nx-cloud start-ci-run --distribute-on="3 linux-medium-js" --stop-agents-after="build"
+        env:
+          NX_CLOUD_AUTH_TOKEN: ${{ secrets.NX_CLOUD_AUTH_TOKEN }}
       # Cache node_modules
       - uses: actions/setup-node@v3
         with:
@@ -35,19 +35,21 @@ jobs:
 
       - run: pnpm install --frozen-lockfile
       - uses: nrwl/nx-set-shas@v4
-
+        env:
+          NX_CLOUD_AUTH_TOKEN: ${{ secrets.NX_CLOUD_AUTH_TOKEN }}
       # Prepend any command with "nx-cloud record --" to record its logs to Nx Cloud
       # - run: pnpm exec nx-cloud record -- echo Hello World
       # Nx Affected runs only tasks affected by the changes in this PR/commit. Learn more: https://nx.dev/ci/features/affected
       - run: make test
         env:
           NX_CLOUD_AUTH_TOKEN: ${{ secrets.NX_CLOUD_AUTH_TOKEN }}
+
       - name: Upload test results to Codecov
         if: ${{ !cancelled() }}
         uses: codecov/test-results-action@v1
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
       - name: Upload coverage reports to Codecov
-        uses: codecov/[email protected]
+        run: make codecov
         with:
           token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -10,8 +10,4 @@ node_modules
 coverage
 *.xml
 
-# tell Git to ignore/stop ignoring this file
-#$ git update-index --assume-unchanged <file-to-ignore>
-#$ git update-index --no-assume-unchanged <file-to-ignore>
-# Credit: https://web.archive.org/web/20240726013834/https://practicalgit.com/blog/make-git-ignore-local-changes-to-tracked-files.html
-nx.json
+.env

Makefile

@@ -1,5 +1,20 @@
 test:
-	./scripts/inject-token.sh
-	pnpm exec nx affected -t lint build test
+	pnpm exec nx affected -t lint test build
 
-@PHONY: test
+codecov_install:
+	pip install codecov-cli
+
+codecov: codecov_install
+	codecovcli --verbose upload-process --fail-on-error -t ${{ secrets.CODECOV_TOKEN }} -n Server -F Server -f apps/server/coverage/lcov.info
+	codecovcli --verbose upload-process --fail-on-error -t ${{ secrets.CODECOV_TOKEN }} -n Config -F Config -f libs/config/coverage/lcov.info
+	codecovcli --verbose upload-process --fail-on-error -t ${{ secrets.CODECOV_TOKEN }} -n Utils -F Utils -f libs/utils/coverage/lcov.info
+	codecovcli --verbose upload-process --fail-on-error -t ${{ secrets.CODECOV_TOKEN }} -n Web -F Web -f libs/web/coverage/lcov.info
+
+codecov_local:
+	codecovcli --verbose upload-process --fail-on-error -n Server -F Server -f apps/server/coverage/lcov.info
+	codecovcli --verbose upload-process --fail-on-error -n Config -F Config -f libs/config/coverage/lcov.info
+	codecovcli --verbose upload-process --fail-on-error -n Utils -F Utils -f libs/utils/coverage/lcov.info
+	codecovcli --verbose upload-process --fail-on-error -n Web -F Web -f libs/web/coverage/lcov.info
+
+
+@PHONY: test codecov_install codecov

apps/server/.env.example

@@ -0,0 +1,2 @@
+NX_CLOUD_AUTH_TOKEN=
+SENTRY_DSN=

apps/server/package.json

@@ -8,7 +8,8 @@
     "build": "tsc --build  --verbose",
     "check-types": "tsc --noEmit",
     "lint": "eslint src",
-    "start": "node dist/src/index.js",
+    "prestart": "nx run @rusty/server:build",
+    "start": "node --env-file .env dist/src/index.js",
     "test": "vitest",
     "dev": "node --import 'data:text/javascript,import { register } from \"node:module\"; import { pathToFileURL } from \"node:url\"; register(\"ts-node/esm\", pathToFileURL(\"./\"));' --watch src/index.ts"
   },
@@ -30,6 +31,8 @@
   },
   "dependencies": {
     "@rusty/util": "workspace:*",
-    "@rusty/web": "workspace:*"
+    "@rusty/web": "workspace:*",
+    "@sentry/node": "^8.20.0",
+    "@sentry/profiling-node": "^8.20.0"
   }
 }

apps/server/src/ServerController.ts

@@ -4,7 +4,7 @@
 import { WrappedServer } from "./WrappedServer.js";
 import { exit } from "node:process";
 import { log } from "@rusty/util";
-import { handleWebRequests } from "@rusty/web";
+import { processWebRequests } from "@rusty/web";
 import { headersToRecords } from "./headersToRecords.js";
 
 /**
@@ -16,7 +16,7 @@
   req: import("node:http").IncomingMessage,
   res: import("node:http").ServerResponse
 ) {
-  const response = await handleWebRequests({
+  const response = await processWebRequests({
     headers: headersToRecords(req.headers),
     remoteAddress: req.socket.remoteAddress || "",
     method: req.method || "",

apps/server/src/index.ts

@@ -1,4 +1,27 @@
+// IMPORTANT: Make sure to import `instrument.js` at the top of your file.
+// If you're using ECMAScript Modules (ESM) syntax, use `import "./instrument.js";`
+void import ("./instrument.js");
+
+// All other imports below
+import * as Sentry from "@sentry/node";
 import { ServerController } from "./ServerController.js";
 
-const serverController = new ServerController();
-void serverController.start();
+process.on("unhandledRejection", (reason, promise) => {
+    console.error("Unhandled Rejection at:", promise, "reason:", reason);
+    Sentry.captureException(reason as Error);
+    process.exit(1);
+    })
+
+process.on("uncaughtException", (error) => {
+    console.error("Uncaught Exception thrown", error);
+    Sentry.captureException(error);
+    process.exit(1);
+    })  
+
+function main() {
+    const serverController = new ServerController();
+    void serverController.start();
+}
+
+main();
+

apps/server/src/instrument.ts

@@ -0,0 +1,18 @@
+// Import with `import * as Sentry from "@sentry/node"` if you are using ESM
+import * as Sentry from "@sentry/node";
+import { nodeProfilingIntegration } from "@sentry/profiling-node";
+
+if (typeof process.env.SENTRY_DSN === "undefined" || process.env.SENTRY_DSN === "") {
+  console.error("No SENTRY_DSN provided");
+  process.exit(1);
+}
+
+Sentry.init({
+  dsn: process.env.SENTRY_DSN,
+  integrations: [nodeProfilingIntegration()],
+  // Performance Monitoring
+  tracesSampleRate: 1.0, //  Capture 100% of the transactions
+
+  // Set sampling rate for profiling - this is relative to tracesSampleRate
+  profilesSampleRate: 1.0,
+});

libs/config/eslint.config.js

@@ -0,0 +1,24 @@
+// @ts-check
+
+import eslint from "@eslint/js";
+import tseslint from "typescript-eslint";
+
+export default tseslint.config(
+  eslint.configs.recommended,
+  ...tseslint.configs.recommendedTypeChecked,
+  {
+    languageOptions: {
+      parserOptions: {
+        project: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+  },
+  {
+    files: ["eslint.config.js", "vitest.config.js", "**/*.d.ts"],
+    ...tseslint.configs.disableTypeChecked,
+  },
+  {
+    ignores: ["**/coverage/*", "**/dist/*"],
+  }
+);

libs/config/index.ts

@@ -0,0 +1 @@
+export { getServerURL } from "./src/index.js";

libs/config/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@rusty/config",
+  "version": "1.0.0",
+  "private": true,
+  "type": "module",
+  "imports": {
+    "#internal": "./dist/src/index.js"
+  },
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "tsc --build  --verbose",
+    "test": "vitest",
+    "check-types": "tsc --noEmit",
+    "lint": "eslint src"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "GPL-3.0-only",
+  "devDependencies": {
+    "@types/node": "20.14.12",
+    "@types/pino": "7.0.5",
+    "@vitest/coverage-v8": "^2.0.4",
+    "@vitest/ui": "^2.0.4",
+    "eslint": "^8.57.0",
+    "nx": "19.5.1",
+    "ts-node": "^10.9.2",
+    "tslib": "^2.6.3",
+    "typescript": "^5.5.4",
+    "vite": "2.0.4",
+    "vitest": "^2.0.4"
+  },
+  "dependencies": {
+    "@rusty/util": "workspace:*",
+    "@sentry/node": "^8.20.0",
+    "@sentry/profiling-node": "^8.20.0",
+    "pino": "9.3.1"
+  }
+}

libs/config/src/config.ts

@@ -0,0 +1,4 @@
+export function getServerURL(): string {
+  const serverURL = process.env.SERVER_URL ?? "https://rusty-motors.com";
+  return serverURL;
+}

libs/config/src/index.ts

@@ -0,0 +1 @@
+export { getServerURL } from "./config.js";

libs/config/src/types.ts

@@ -0,0 +1,24 @@
+export type rawHttpRequestData = {
+  headers: Record<string, string>;
+  remoteAddress: string;
+  method: string;
+  url: string;
+};
+
+export type parsedHttpRequestData = {
+  headers: Record<string, string>;
+  remoteAddress: string;
+  method: string;
+  pathname: string;
+  searchParams: URLSearchParams;
+};
+export type RequestResponse = {
+  statusCode: number;
+  body: string;
+  headers: Record<string, string>;
+};
+
+export type User = {
+  username: string;
+  password: string;
+};

libs/config/test/config.test.ts

@@ -0,0 +1,13 @@
+import { describe, expect, it } from "vitest";
+import { getServerURL } from "@rusty/config";
+
+describe("config", () => {
+  it("should have a default serverURL if SERVER_URL environment variable is not set", () => {
+    expect(getServerURL()).toBe("https://rusty-motors.com");
+  });
+
+  it("should use the SERVER_URL environment variable if set", () => {
+    process.env.SERVER_URL = "https://example.com";
+    expect(getServerURL()).toBe("https://example.com");
+  });
+});

libs/config/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "declarationDir": "./dist",
+    "composite": true
+  },
+  "include": ["index.ts", "src/**/*.ts", "test/**/*.ts"],
+  "exclude": ["node_modules", "dist"],
+  "references": [{ "path": "../util" }]
+}

libs/config/vitest.config.js

@@ -0,0 +1,20 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    coverage: {
+      enabled: true,
+      all: true,
+      exclude: [
+        "dist/**",
+        "eslint.config.js",
+        "vitest.config.js"
+      ],
+      reporter: ["lcov", "text", "cobertura"],
+    },
+    reporters: ["junit", "default", "hanging-process"],
+    outputFile: "mcos.junit.xml",
+    pool: "forks",
+    watch: false,
+  },
+});

libs/util/package.json

@@ -31,6 +31,8 @@
     "vitest": "^2.0.4"
   },
   "dependencies": {
+    "@sentry/node": "^8.20.0",
+    "@sentry/profiling-node": "^8.20.0",
     "pino": "9.3.1"
   }
 }

libs/web/index.ts

@@ -1 +1,4 @@
-export { handleWebRequests } from "./src/index.js";
+/**
+ * External exports for the web library
+ */
+export { processWebRequests } from "./src/processors/processWebRequests.js";

libs/web/package.json

@@ -3,6 +3,9 @@
   "version": "1.0.0",
   "private": true,
   "type": "module",
+  "imports": {
+    "#internal": "./dist/src/index.js"
+  },
   "exports": {
     ".": "./dist/index.js"
   },
@@ -32,6 +35,9 @@
   },
   "dependencies": {
     "@rusty/util": "workspace:*",
+    "@sentry/node": "^8.20.0",
+    "@sentry/profiling-node": "^8.20.0",
+    "@rusty/config": "workspace:*",
     "pino": "9.3.1",
     "sequelize": "6.37.3",
     "sqlite3": "5.1.7"