feat(custom-client): replace Nexus with GitHub Actions-based custom client builder

src/app.module.ts

@@ -24,7 +24,7 @@ import { LdapModule } from './modules/ldap/ldap.module';
 import { StrategyModule } from './modules/strategy/strategy.module';
 import { SystemUpdateModule } from './modules/system-update/system-update.module';
 import { UpdateCheckModule } from './modules/update-check/update-check.module';
-import { NexusModule } from './modules/nexus/nexus.module';
+import { CustomClientModule } from './modules/custom-client/custom-client.module';
 import { UserGroupModule } from './modules/user-group/user-group.module';
 import { RbacModule } from './modules/rbac/rbac.module';
 import { RbacGuard } from './modules/rbac/guards/rbac.guard';
@@ -98,7 +98,7 @@ import { WebClientModule } from './modules/web-client/web-client.module';
     StrategyModule,
     UpdateCheckModule,
     SystemUpdateModule,
-    NexusModule,
+    CustomClientModule,
     UserGroupModule,
     RbacModule,
     ServerManagementModule,

src/common/utils/data-dir.util.ts

@@ -2,7 +2,7 @@ import * as path from 'path';
 
 const DEFAULT_DATA_DIR = './data';
 const DB_FILENAME = 'rustdesk-console.db';
-const NEXUS_BUILD_SUBDIR = 'nexus-builds';
+const CUSTOM_CLIENT_BUILD_SUBDIR = 'custom-client-builds';
 const AVATAR_SUBDIR = 'avatars';
 
 export type DbType = 'sqlite' | 'mysql';
@@ -38,10 +38,10 @@ export function getDbPath(): string {
 }
 
 /**
- * Get the Nexus build artifact storage directory.
+ * Get the custom client build artifact storage directory.
  */
-export function getNexusStoragePath(): string {
-  return path.join(getDataDir(), NEXUS_BUILD_SUBDIR);
+export function getCustomClientStoragePath(): string {
+  return path.join(getDataDir(), CUSTOM_CLIENT_BUILD_SUBDIR);
 }
 
 /**

src/database/data-source-options.ts

@@ -6,6 +6,7 @@ import { FixMySqlDefaultUserGroupIndex1790985600001 } from '../migrations/179098
 import { AddPasswordResetTokens1790985600002 } from '../migrations/1790985600002-AddPasswordResetTokens';
 import { AddDeviceTombstones1791040000000 } from '../migrations/1791040000000-AddDeviceTombstones';
 import { AddDeviceTombstoneReleaseTracking1791126400000 } from '../migrations/1791126400000-AddDeviceTombstoneReleaseTracking';
+import { ReplaceNexusWithCustomClientBuilds1791212800000 } from '../migrations/1791212800000-ReplaceNexusWithCustomClientBuilds';
 
 export function createDataSourceOptions(): DataSourceOptions {
   const common = {
@@ -16,6 +17,7 @@ export function createDataSourceOptions(): DataSourceOptions {
       AddPasswordResetTokens1790985600002,
       AddDeviceTombstones1791040000000,
       AddDeviceTombstoneReleaseTracking1791126400000,
+      ReplaceNexusWithCustomClientBuilds1791212800000,
     ],
     migrationsRun: false,
     synchronize: false,

src/database/entities.ts

@@ -22,8 +22,7 @@ import { PasswordResetToken } from '../modules/auth/entities/password-reset-toke
 import { SystemSetting } from '../modules/settings/entities/system-setting.entity';
 import { ActiveConnection } from '../modules/heartbeat/entities/active-connection.entity';
 import { Strategy } from '../modules/strategy/entities/strategy.entity';
-import { NexusToken } from '../modules/nexus/entities/nexus-token.entity';
-import { NexusBuild } from '../modules/nexus/entities/nexus-build.entity';
+import { CustomClientBuild } from '../modules/custom-client/entities/custom-client-build.entity';
 import { UserGroup } from '../modules/user-group/entities/user-group.entity';
 import { Role } from '../modules/rbac/entities/role.entity';
 import { RolePermission } from '../modules/rbac/entities/role-permission.entity';
@@ -58,8 +57,7 @@ export const DATABASE_ENTITIES = [
   SystemSetting,
   ActiveConnection,
   Strategy,
-  NexusToken,
-  NexusBuild,
+  CustomClientBuild,
   UserGroup,
   Role,
   RolePermission,

src/database/migration-manager.spec.ts

@@ -9,6 +9,7 @@ import { FixMySqlDefaultUserGroupIndex1790985600001 } from '../migrations/179098
 import { AddPasswordResetTokens1790985600002 } from '../migrations/1790985600002-AddPasswordResetTokens';
 import { AddDeviceTombstones1791040000000 } from '../migrations/1791040000000-AddDeviceTombstones';
 import { AddDeviceTombstoneReleaseTracking1791126400000 } from '../migrations/1791126400000-AddDeviceTombstoneReleaseTracking';
+import { ReplaceNexusWithCustomClientBuilds1791212800000 } from '../migrations/1791212800000-ReplaceNexusWithCustomClientBuilds';
 import { AddressBookPeer } from '../modules/address-book/entities/address-book-peer.entity';
 import { migrateDatabase } from './migration-manager';
 
@@ -32,6 +33,7 @@ describe('database migrations', () => {
         AddPasswordResetTokens1790985600002,
         AddDeviceTombstones1791040000000,
         AddDeviceTombstoneReleaseTracking1791126400000,
+        ReplaceNexusWithCustomClientBuilds1791212800000,
       ],
       synchronize,
     });
@@ -55,7 +57,7 @@ describe('database migrations', () => {
       ).toHaveLength(0);
       expect(
         await dataSource.query('SELECT name FROM migrations'),
-      ).toHaveLength(5);
+      ).toHaveLength(6);
       await dataSource.query(
         "INSERT INTO address_books (guid, owner) VALUES ('book', 'owner')",
       );
@@ -98,7 +100,7 @@ describe('database migrations', () => {
       ).toEqual([{ name: 'retained' }]);
       expect(
         await dataSource.query('SELECT name FROM migrations'),
-      ).toHaveLength(5);
+      ).toHaveLength(6);
     } finally {
       await dataSource.destroy();
     }
@@ -117,7 +119,7 @@ describe('database migrations', () => {
       ).toHaveLength(0);
       expect(
         await dataSource.query('SELECT name FROM migrations'),
-      ).toHaveLength(5);
+      ).toHaveLength(6);
     } finally {
       await dataSource.destroy();
     }
@@ -154,7 +156,7 @@ describe('database migrations', () => {
       ).toHaveLength(0);
       expect(
         await dataSource.query('SELECT name FROM migrations'),
-      ).toHaveLength(5);
+      ).toHaveLength(6);
       const indexes = await dataSource.query(
         "SELECT name, sql FROM sqlite_master WHERE type = 'index' AND tbl_name = 'strategies' AND sql IS NOT NULL",
       );

src/database/mysql-migration.integration.spec.ts

@@ -6,6 +6,7 @@ import { FixMySqlDefaultUserGroupIndex1790985600001 } from '../migrations/179098
 import { AddPasswordResetTokens1790985600002 } from '../migrations/1790985600002-AddPasswordResetTokens';
 import { AddDeviceTombstones1791040000000 } from '../migrations/1791040000000-AddDeviceTombstones';
 import { AddDeviceTombstoneReleaseTracking1791126400000 } from '../migrations/1791126400000-AddDeviceTombstoneReleaseTracking';
+import { ReplaceNexusWithCustomClientBuilds1791212800000 } from '../migrations/1791212800000-ReplaceNexusWithCustomClientBuilds';
 import { migrateDatabase } from './migration-manager';
 
 const describeMysql = process.env.RUN_MYSQL_MIGRATION_TESTS
@@ -26,6 +27,7 @@ describeMysql('MySQL database migrations', () => {
       AddPasswordResetTokens1790985600002,
       AddDeviceTombstones1791040000000,
       AddDeviceTombstoneReleaseTracking1791126400000,
+      ReplaceNexusWithCustomClientBuilds1791212800000,
     ],
   };
   const databases = [
@@ -80,7 +82,7 @@ describeMysql('MySQL database migrations', () => {
       ).toHaveLength(0);
       expect(
         await dataSource.query('SELECT name FROM migrations'),
-      ).toHaveLength(5);
+      ).toHaveLength(6);
       await dataSource.query(
         "INSERT INTO user_groups (guid, name, normalizedName, isDefault) VALUES ('a', 'A', 'a', 0), ('b', 'B', 'b', 0), ('d', 'D', 'd', 1)",
       );
@@ -117,7 +119,7 @@ describeMysql('MySQL database migrations', () => {
       ).toEqual([{ name: 'retained' }]);
       expect(
         await dataSource.query('SELECT name FROM migrations'),
-      ).toHaveLength(5);
+      ).toHaveLength(6);
       await dataSource.query(
         "INSERT INTO user_groups (guid, name, normalizedName, isDefault) VALUES ('a', 'A', 'a', 0), ('b', 'B', 'b', 0)",
       );
@@ -149,6 +151,7 @@ describeMysql('MySQL database migrations', () => {
       'user_user_permissions',
       'nexus_tokens',
       'nexus_builds',
+      'custom_client_builds',
     ]) {
       await legacy.query(`DROP TABLE IF EXISTS \`${table}\``);
     }
@@ -172,7 +175,7 @@ describeMysql('MySQL database migrations', () => {
       ).toHaveLength(0);
       expect(
         await dataSource.query('SELECT name FROM migrations'),
-      ).toHaveLength(5);
+      ).toHaveLength(6);
     } finally {
       await dataSource.destroy();
     }

src/migrations/1791212800000-ReplaceNexusWithCustomClientBuilds.ts

@@ -0,0 +1,49 @@
+import { MigrationInterface, QueryRunner } from 'typeorm';
+
+export class ReplaceNexusWithCustomClientBuilds1791212800000 implements MigrationInterface {
+  name = 'ReplaceNexusWithCustomClientBuilds1791212800000';
+
+  async up(queryRunner: QueryRunner): Promise<void> {
+    const type = queryRunner.connection.options.type;
+
+    // Drop legacy Nexus tables (replaced by the custom-client module).
+    if (await queryRunner.hasTable('nexus_tokens')) {
+      await queryRunner.dropTable('nexus_tokens');
+    }
+    if (await queryRunner.hasTable('nexus_builds')) {
+      await queryRunner.dropTable('nexus_builds');
+    }
+
+    if (await queryRunner.hasTable('custom_client_builds')) {
+      return;
+    }
+
+    if (type === 'sqlite') {
+      await queryRunner.query(
+        `CREATE TABLE "custom_client_builds" ("uuid" varchar PRIMARY KEY NOT NULL, "userGuid" varchar NOT NULL, "os" varchar NOT NULL, "arch" varchar NOT NULL, "custom" text, "status" varchar NOT NULL DEFAULT ('pending'), "message" text, "files" text, "callbackToken" varchar NOT NULL, "githubRunId" varchar, "createdAt" datetime NOT NULL DEFAULT (datetime('now')), "updatedAt" datetime NOT NULL DEFAULT (datetime('now')))`,
+      );
+      await queryRunner.query(
+        `CREATE INDEX "IDX_custom_client_builds_userGuid" ON "custom_client_builds" ("userGuid") `,
+      );
+      await queryRunner.query(
+        `CREATE INDEX "IDX_custom_client_builds_status" ON "custom_client_builds" ("status") `,
+      );
+      return;
+    }
+
+    if (type === 'mysql') {
+      await queryRunner.query(
+        `CREATE TABLE \`custom_client_builds\` (\`uuid\` varchar(255) NOT NULL, \`userGuid\` varchar(255) NOT NULL, \`os\` varchar(255) NOT NULL, \`arch\` varchar(255) NOT NULL, \`custom\` text NULL, \`status\` varchar(255) NOT NULL DEFAULT 'pending', \`message\` text NULL, \`files\` text NULL, \`callbackToken\` varchar(255) NOT NULL, \`githubRunId\` varchar(255) NULL, \`createdAt\` datetime(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6), \`updatedAt\` datetime(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6) ON UPDATE CURRENT_TIMESTAMP(6), INDEX \`IDX_custom_client_builds_userGuid\` (\`userGuid\`), INDEX \`IDX_custom_client_builds_status\` (\`status\`), PRIMARY KEY (\`uuid\`)) ENGINE=InnoDB`,
+      );
+      return;
+    }
+
+    throw new Error(`Unsupported database type: ${type}`);
+  }
+
+  async down(queryRunner: QueryRunner): Promise<void> {
+    if (await queryRunner.hasTable('custom_client_builds')) {
+      await queryRunner.dropTable('custom_client_builds');
+    }
+  }
+}

src/modules/custom-client/custom-client.controller.ts

@@ -0,0 +1,139 @@
+import {
+  Controller,
+  Get,
+  Post,
+  Put,
+  Delete,
+  Body,
+  Param,
+  Res,
+  Req,
+  HttpCode,
+  HttpStatus,
+  NotFoundException,
+  UseGuards,
+  UseInterceptors,
+  UploadedFiles,
+} from '@nestjs/common';
+import { FilesInterceptor } from '@nestjs/platform-express';
+import type { Request, Response } from 'express';
+import { createReadStream, existsSync, statSync } from 'fs';
+import { basename } from 'path';
+import { CustomClientService } from './custom-client.service';
+import { CustomClientSettingsService } from './services/custom-client-settings.service';
+import { SubmitBuildDto } from './dto/custom-client-build.dto';
+import { UpdateCustomClientSettingsDto } from './dto/custom-client-settings.dto';
+import { CurrentUser } from '../auth/decorators/current-user.decorator';
+import { Public } from '../auth/decorators/public.decorator';
+import { AdminGuard } from '../../common/guards/admin.guard';
+
+@Controller('custom-client')
+export class CustomClientController {
+  constructor(
+    private readonly customClientService: CustomClientService,
+    private readonly settingsService: CustomClientSettingsService,
+  ) {}
+
+  @Post('builds')
+  @HttpCode(HttpStatus.CREATED)
+  async createBuild(
+    @CurrentUser('id') userGuid: string,
+    @Body() dto: SubmitBuildDto,
+  ) {
+    return this.customClientService.submitBuild(userGuid, dto);
+  }
+
+  @Get('builds')
+  async listBuilds(@CurrentUser('id') userGuid: string) {
+    return this.customClientService.listBuilds(userGuid);
+  }
+
+  @Delete('builds/:uuid')
+  @HttpCode(HttpStatus.NO_CONTENT)
+  async deleteBuild(
+    @CurrentUser('id') userGuid: string,
+    @Param('uuid') uuid: string,
+  ) {
+    await this.customClientService.deleteBuild(userGuid, uuid);
+  }
+
+  @Get('builds/:uuid/files')
+  async listBuildFiles(
+    @CurrentUser('id') userGuid: string,
+    @Param('uuid') uuid: string,
+  ) {
+    return this.customClientService.listBuildFiles(uuid, userGuid);
+  }
+
+  @Get('builds/:uuid/files/:filename')
+  async downloadBuildFile(
+    @CurrentUser('id') userGuid: string,
+    @Param('uuid') uuid: string,
+    @Param('filename') filename: string,
+    @Res() res: Response,
+  ) {
+    const filePath = await this.customClientService.getLocalFilePath(
+      uuid,
+      filename,
+      userGuid,
+    );
+    if (!existsSync(filePath)) {
+      throw new NotFoundException('File not found');
+    }
+    const stat = statSync(filePath);
+    res.setHeader('Content-Type', 'application/octet-stream');
+    res.setHeader(
+      'Content-Disposition',
+      `attachment; filename="${basename(filePath)}"`,
+    );
+    res.setHeader('Content-Length', stat.size);
+    const stream = createReadStream(filePath);
+    stream.pipe(res);
+  }
+
+  @Get('builds/:uuid/progress')
+  async getBuildProgress(
+    @CurrentUser('id') userGuid: string,
+    @Param('uuid') uuid: string,
+  ) {
+    return this.customClientService.getBuildProgress(uuid, userGuid);
+  }
+
+  @Post('builds/:uuid/callback')
+  @Public()
+  @UseInterceptors(
+    FilesInterceptor('files', 10, {
+      limits: { fileSize: 200 * 1024 * 1024, files: 10 },
+    }),
+  )
+  @HttpCode(HttpStatus.OK)
+  async handleCallback(
+    @Param('uuid') uuid: string,
+    @Req() req: Request,
+    @Body() body: { status?: string; message?: string },
+    @UploadedFiles() files: Express.Multer.File[],
+  ) {
+    const callbackToken = String(req.headers['x-callback-token'] ?? '');
+    await this.customClientService.handleCallback(
+      uuid,
+      callbackToken,
+      body?.status ?? 'completed',
+      body?.message,
+      files ?? [],
+    );
+    return { message: 'Callback processed' };
+  }
+
+  @Get('settings')
+  @UseGuards(AdminGuard)
+  async getSettings() {
+    return this.settingsService.getSettings();
+  }
+
+  @Put('settings')
+  @UseGuards(AdminGuard)
+  @HttpCode(HttpStatus.OK)
+  async updateSettings(@Body() dto: UpdateCustomClientSettingsDto) {
+    return this.settingsService.updateSettings(dto);
+  }
+}

src/modules/custom-client/custom-client.module.ts

@@ -0,0 +1,19 @@
+import { Module } from '@nestjs/common';
+import { TypeOrmModule } from '@nestjs/typeorm';
+import { CustomClientController } from './custom-client.controller';
+import { CustomClientService } from './custom-client.service';
+import { CustomClientBuild } from './entities/custom-client-build.entity';
+import { CustomClientSettingsService } from './services/custom-client-settings.service';
+import { SystemSetting } from '../settings/entities/system-setting.entity';
+import { SettingsModule } from '../settings/settings.module';
+
+@Module({
+  imports: [
+    TypeOrmModule.forFeature([CustomClientBuild, SystemSetting]),
+    SettingsModule,
+  ],
+  controllers: [CustomClientController],
+  providers: [CustomClientService, CustomClientSettingsService],
+  exports: [CustomClientService, CustomClientSettingsService],
+})
+export class CustomClientModule {}