Merge pull request #40 from qtchaos/index-OK

Add a success message to the base path

.docker/development/docker-compose.yml

@@ -41,7 +41,7 @@ services:
     links: 
       - postgres:postgres
     environment:
-      - DATABASE_URL=postgres://postgres:postgres@postgres:5432/postgres?sslmode=disable
+      - PGWEB_DATABASE_URL=postgres://postgres:postgres@postgres:5432/postgres?sslmode=disable
     depends_on:
       - postgres
 

.github/CODEOWNERS

@@ -1,3 +1 @@
-* @movie-web/core
+* @movie-web/project-leads
-
-.github @binaryoverload

.github/workflows/linting_testing.yml

@@ -14,16 +14,16 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
                   
       - uses: pnpm/action-setup@v2
         with:
           version: 8
 
       - name: Install Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
           cache: 'pnpm'
       
       - name: Install packages
@@ -38,16 +38,16 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
                   
       - uses: pnpm/action-setup@v2
         with:
           version: 8
 
       - name: Install Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 20
           cache: 'pnpm'
       
       - name: Install packages
@@ -62,10 +62,10 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       
       - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
 
       - name: Build
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5

.github/workflows/release.yml

@@ -12,7 +12,7 @@ jobs:
 
     steps:
     - name: Checkout code
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     - name: Get version
       id: package-version
@@ -42,10 +42,10 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup Docker buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
 
       - name: Get version
         id: package-version
@@ -70,9 +70,12 @@ jobs:
 
       - name: Build and push Docker image
         id: build-and-push
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           push: true
+          platforms: linux/amd64,linux/arm64
           context: .
           labels: ${{ steps.meta.outputs.labels }}
           tags: ${{ steps.meta.outputs.tags }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max

package.json

@@ -1,6 +1,6 @@
 {
   "name": "backend",
-  "version": "1.2.0",
+  "version": "1.3.1",
   "private": true,
   "homepage": "https://github.com/movie-web/backend",
   "engines": {
@@ -8,16 +8,16 @@
   },
   "scripts": {
     "dev": "nodemon -r tsconfig-paths/register src/main.ts",
-    "build": "npm run build:pre && npm run build:compile",
+    "build": "pnpm run build:pre && pnpm run build:compile",
     "start": "node dist/main.js",
     "lint": "eslint --ext .ts,.js,.json,.tsx src/",
     "lint:fix": "eslint --fix --ext .ts,.js,.json,.tsx src/",
     "build:pre": "rimraf dist/",
     "build:compile": "tsc && tsc-alias",
     "preinstall": "npx -y only-allow pnpm",
-    "migration:create": "npx -y mikro-orm migration:create",
+    "migration:create": "pnpm exec mikro-orm migration:create",
-    "migration:up": "npx -y mikro-orm migration:up",
+    "migration:up": "pnpm exec mikro-orm migration:up",
-    "migration:down": "npx -y mikro-orm migration:down"
+    "migration:down": "pnpm exec mikro-orm migration:down"
   },
   "mikro-orm": {
     "useTsNode": true,

src/config/orm.ts

@@ -2,6 +2,7 @@ import { devFragment } from '@/config/fragments/dev';
 import { dockerFragment } from '@/config/fragments/docker';
 import { createConfigLoader } from 'neat-config';
 import { z } from 'zod';
+import { booleanSchema } from './schema';
 
 const fragments = {
   dev: devFragment,
@@ -12,6 +13,8 @@ export const ormConfigSchema = z.object({
   postgres: z.object({
     // connection URL for postgres database
     connection: z.string(),
+    // whether to use SSL for the connection
+    ssl: booleanSchema.default(false),
   }),
 });
 

src/config/schema.ts

@@ -1,5 +1,7 @@
 import { z } from 'zod';
 
+export const booleanSchema = z.preprocess((val) => val === 'true', z.boolean());
+
 export const configSchema = z.object({
   server: z
     .object({
@@ -11,13 +13,13 @@ export const configSchema = z.object({
 
       // disable cross origin restrictions, allow any site.
       // overwrites the cors option above
-      allowAnySite: z.coerce.boolean().default(false),
+      allowAnySite: booleanSchema.default(false),
 
       // should it trust reverse proxy headers? (for ip gathering)
-      trustProxy: z.coerce.boolean().default(false),
+      trustProxy: booleanSchema.default(false),
 
       // should it trust cloudflare headers? (for ip gathering, cloudflare has priority)
-      trustCloudflare: z.coerce.boolean().default(false),
+      trustCloudflare: booleanSchema.default(false),
 
       // prefix for where the instance is run on. for example set it to /backend if you're hosting it on example.com/backend
       // if this is set, do not apply url rewriting before proxing
@@ -30,7 +32,7 @@ export const configSchema = z.object({
       format: z.enum(['json', 'pretty']).default('pretty'),
 
       // show debug logs?
-      debug: z.coerce.boolean().default(false),
+      debug: booleanSchema.default(false),
     })
     .default({}),
   postgres: z.object({
@@ -38,16 +40,19 @@ export const configSchema = z.object({
     connection: z.string(),
 
     // run all migrations on boot of the application
-    migrateOnBoot: z.coerce.boolean().default(false),
+    migrateOnBoot: booleanSchema.default(false),
 
     // try to sync the schema on boot, useful for development
     // will always keep the database schema in sync with the connected database
     // it is extremely destructive, do not use it EVER in production
-    syncSchema: z.coerce.boolean().default(false),
+    syncSchema: booleanSchema.default(false),
 
     // Enable debug logging for MikroORM - Outputs queries and entity management logs
     // Do NOT use in production, leaks all sensitive data
-    debugLogging: z.coerce.boolean().default(false),
+    debugLogging: booleanSchema.default(false),
+
+    // Enable SSL for the postgres connection
+    ssl: booleanSchema.default(false),
   }),
   crypto: z.object({
     // session secret. used for signing session tokens
@@ -62,7 +67,7 @@ export const configSchema = z.object({
   captcha: z
     .object({
       // enabled captchas on register
-      enabled: z.coerce.boolean().default(false),
+      enabled: booleanSchema.default(false),
 
       // captcha secret
       secret: z.string().min(1).optional(),
@@ -73,7 +78,7 @@ export const configSchema = z.object({
   ratelimits: z
     .object({
       // enabled captchas on register
-      enabled: z.coerce.boolean().default(false),
+      enabled: booleanSchema.default(false),
       redisUrl: z.string().optional(),
     })
     .default({}),

src/db/migrations/.snapshot-postgres.json

@@ -483,6 +483,15 @@
           "primary": false,
           "nullable": true,
           "mappedType": "string"
+        },
+        "proxy_urls": {
+          "name": "proxy_urls",
+          "type": "text[]",
+          "unsigned": false,
+          "autoincrement": false,
+          "primary": false,
+          "nullable": true,
+          "mappedType": "array"
         }
       },
       "name": "user_settings",

src/db/migrations/Migration20231229214215.ts

@@ -0,0 +1,13 @@
+import { Migration } from '@mikro-orm/migrations';
+
+export class Migration20231229214215 extends Migration {
+
+  async up(): Promise<void> {
+    this.addSql('alter table "user_settings" add column "proxy_urls" text[] null;');
+  }
+
+  async down(): Promise<void> {
+    this.addSql('alter table "user_settings" drop column "proxy_urls";');
+  }
+
+}

src/db/models/UserSettings.ts

@@ -1,4 +1,4 @@
-import { Entity, PrimaryKey, Property } from '@mikro-orm/core';
+import { ArrayType, Entity, PrimaryKey, Property } from '@mikro-orm/core';
 
 @Entity({ tableName: 'user_settings' })
 export class UserSettings {
@@ -13,6 +13,9 @@ export class UserSettings {
 
   @Property({ name: 'default_subtitle_language', nullable: true })
   defaultSubtitleLanguage?: string | null;
+
+  @Property({ name: 'proxy_urls', type: ArrayType, nullable: true })
+  proxyUrls?: string[] | null;
 }
 
 export interface UserSettingsDTO {
@@ -20,6 +23,7 @@ export interface UserSettingsDTO {
   applicationTheme?: string | null;
   applicationLanguage?: string | null;
   defaultSubtitleLanguage?: string | null;
+  proxyUrls?: string[] | null;
 }
 
 export function formatUserSettings(
@@ -30,5 +34,6 @@ export function formatUserSettings(
     applicationTheme: userSettings.applicationTheme,
     applicationLanguage: userSettings.applicationLanguage,
     defaultSubtitleLanguage: userSettings.defaultSubtitleLanguage,
+    proxyUrls: userSettings.proxyUrls,
   };
 }

src/mikro-orm.config.ts

@@ -1,4 +1,4 @@
 import { ormConf } from '@/config/orm';
 import { makeOrmConfig } from '@/modules/mikro/orm';
 
-export default makeOrmConfig(ormConf.postgres.connection);
+export default makeOrmConfig(ormConf.postgres.connection, ormConf.postgres.ssl);

src/modules/fastify/routes.ts

@@ -1,3 +1,4 @@
+import { indexRouter } from '@/routes';
 import { loginAuthRouter } from '@/routes/auth/login';
 import { manageAuthRouter } from '@/routes/auth/manage';
 import { metaRouter } from '@/routes/meta';
@@ -25,4 +26,5 @@ export async function setupRoutes(app: FastifyInstance) {
   await app.register(userSettingsRouter.register);
   await app.register(userGetRouter.register);
   await app.register(metricsRouter.register);
+  await app.register(indexRouter.register);
 }

src/modules/metrics/index.ts

@@ -13,6 +13,7 @@ export type Metrics = {
   providerHostnames: Counter<'hostname'>;
   providerStatuses: Counter<'provider_id' | 'status'>;
   watchMetrics: Counter<'title' | 'tmdb_full_id' | 'provider_id' | 'success'>;
+  toolMetrics: Counter<'tool'>;
 };
 
 let metrics: null | Metrics = null;
@@ -59,6 +60,11 @@ export async function setupMetrics(app: FastifyInstance) {
       help: 'mw_media_watch_count',
       labelNames: ['title', 'tmdb_full_id', 'provider_id', 'success'],
     }),
+    toolMetrics: new Counter({
+      name: 'mw_provider_tool_count',
+      help: 'mw_provider_tool_count',
+      labelNames: ['tool'],
+    }),
   };
 
   const promClient = app.metrics.client;
@@ -67,6 +73,8 @@ export async function setupMetrics(app: FastifyInstance) {
   promClient.register.registerMetric(metrics.providerHostnames);
   promClient.register.registerMetric(metrics.providerStatuses);
   promClient.register.registerMetric(metrics.watchMetrics);
+  promClient.register.registerMetric(metrics.captchaSolves);
+  promClient.register.registerMetric(metrics.toolMetrics);
 
   const orm = getORM();
   const em = orm.em.fork();

src/modules/mikro/index.ts

@@ -18,6 +18,7 @@ export async function setupMikroORM() {
     conf.postgres.connection,
     conf.postgres.debugLogging,
     (msg) => log.info(msg),
+    conf.postgres.ssl,
   );
 
   if (conf.postgres.syncSchema) {

src/modules/mikro/orm.ts

@@ -2,7 +2,10 @@ import { Options } from '@mikro-orm/core';
 import { MikroORM, PostgreSqlDriver } from '@mikro-orm/postgresql';
 import path from 'path';
 
-export function makeOrmConfig(url: string): Options<PostgreSqlDriver> {
+export function makeOrmConfig(
+  url: string,
+  ssl: boolean,
+): Options<PostgreSqlDriver> {
   return {
     type: 'postgresql',
     clientUrl: url,
@@ -13,6 +16,11 @@ export function makeOrmConfig(url: string): Options<PostgreSqlDriver> {
       pathTs: './migrations',
       path: './migrations',
     },
+    driverOptions: {
+      connection: {
+        ssl,
+      },
+    },
   };
 }
 
@@ -20,9 +28,10 @@ export async function createORM(
   url: string,
   debug: boolean,
   log: (msg: string) => void,
+  ssl: boolean,
 ) {
   return await MikroORM.init<PostgreSqlDriver>({
-    ...makeOrmConfig(url),
+    ...makeOrmConfig(url, ssl),
     logger: log,
     debug,
   });

src/routes/index.ts

@@ -0,0 +1,14 @@
+import { version } from '@/config';
+import { handle } from '@/services/handler';
+import { makeRouter } from '@/services/router';
+
+export const indexRouter = makeRouter((app) => {
+  app.get(
+    '/',
+    handle(async () => {
+      return {
+        message: `Backend is working as expected (${version})`,
+      };
+    }),
+  );
+});

src/routes/metrics.ts

@@ -19,6 +19,7 @@ const metricsProviderSchema = z.object({
 
 const metricsProviderInputSchema = z.object({
   items: z.array(metricsProviderSchema).max(10).min(1),
+  tool: z.string().optional(),
 });
 
 export const metricsRouter = makeRouter((app) => {
@@ -65,6 +66,12 @@ export const metricsRouter = makeRouter((app) => {
         });
       }
 
+      if (body.tool) {
+        getMetrics().toolMetrics.inc({
+          tool: body.tool,
+        });
+      }
+
       return true;
     }),
   );

src/routes/users/settings.ts

@@ -41,6 +41,7 @@ export const userSettingsRouter = makeRouter((app) => {
           applicationLanguage: z.string().nullable().optional(),
           applicationTheme: z.string().nullable().optional(),
           defaultSubtitleLanguage: z.string().nullable().optional(),
+          proxyUrls: z.string().array().nullable().optional(),
         }),
       },
     },
@@ -64,6 +65,7 @@ export const userSettingsRouter = makeRouter((app) => {
         settings.defaultSubtitleLanguage = body.defaultSubtitleLanguage;
       if (body.applicationTheme !== undefined)
         settings.applicationTheme = body.applicationTheme;
+      if (body.proxyUrls !== undefined) settings.proxyUrls = body.proxyUrls;
 
       await em.persistAndFlush(settings);
       return formatUserSettings(settings);

src/services/captcha.ts

@@ -4,16 +4,14 @@ import { StatusError } from '@/services/error';
 export async function isValidCaptcha(token: string): Promise<boolean> {
   if (!conf.captcha.secret)
     throw new Error('isValidCaptcha() is called but no secret set');
+  const formData = new URLSearchParams();
+  formData.append('secret', conf.captcha.secret);
+  formData.append('response', token);
   const res = await fetch('https://www.google.com/recaptcha/api/siteverify', {
     method: 'POST',
-    body: JSON.stringify({
+    body: formData,
-      secret: conf.captcha.secret,
-      response: token,
-    }),
-    headers: {
-      'content-type': 'application/json',
-    },
   });
+
   const json = await res.json();
   return !!json.success;
 }