Compare commits
15 Commits
chore/ms22
...
fix/csrf-b
| Author | SHA1 | Date | |
|---|---|---|---|
| 97b14edbaa | |||
| 559c6b3831 | |||
| 631e5010b5 | |||
| 09e377ecd7 | |||
| deafcdc84b | |||
| 66d401461c | |||
| 01ae164b61 | |||
| 029c190c05 | |||
| 477d0c8fdf | |||
| 03af39def9 | |||
| dc7e0c805c | |||
| 2b010fadda | |||
| c25e753f35 | |||
| d3c8b8cadd | |||
| a3a0d7afca |
@@ -36,6 +36,7 @@
|
||||
"@nestjs/mapped-types": "^2.1.0",
|
||||
"@nestjs/platform-express": "^11.1.12",
|
||||
"@nestjs/platform-socket.io": "^11.1.12",
|
||||
"@nestjs/schedule": "^6.1.1",
|
||||
"@nestjs/throttler": "^6.5.0",
|
||||
"@nestjs/websockets": "^11.1.12",
|
||||
"@opentelemetry/api": "^1.9.0",
|
||||
@@ -59,6 +60,7 @@
|
||||
"class-validator": "^0.14.3",
|
||||
"cookie-parser": "^1.4.7",
|
||||
"discord.js": "^14.25.1",
|
||||
"dockerode": "^4.0.9",
|
||||
"gray-matter": "^4.0.3",
|
||||
"highlight.js": "^11.11.1",
|
||||
"ioredis": "^5.9.2",
|
||||
@@ -88,6 +90,7 @@
|
||||
"@types/archiver": "^7.0.0",
|
||||
"@types/bcryptjs": "^3.0.0",
|
||||
"@types/cookie-parser": "^1.4.10",
|
||||
"@types/dockerode": "^3.3.47",
|
||||
"@types/express": "^5.0.1",
|
||||
"@types/highlight.js": "^10.1.0",
|
||||
"@types/node": "^22.13.4",
|
||||
|
||||
40
apps/api/src/agent-config/agent-config.controller.ts
Normal file
40
apps/api/src/agent-config/agent-config.controller.ts
Normal file
@@ -0,0 +1,40 @@
|
||||
import {
|
||||
Controller,
|
||||
ForbiddenException,
|
||||
Get,
|
||||
Param,
|
||||
Req,
|
||||
UnauthorizedException,
|
||||
UseGuards,
|
||||
} from "@nestjs/common";
|
||||
import { AgentConfigService } from "./agent-config.service";
|
||||
import { AgentConfigGuard, type AgentConfigRequest } from "./agent-config.guard";
|
||||
|
||||
@Controller("internal")
|
||||
@UseGuards(AgentConfigGuard)
|
||||
export class AgentConfigController {
|
||||
constructor(private readonly agentConfigService: AgentConfigService) {}
|
||||
|
||||
// GET /api/internal/agent-config/:id
|
||||
// Auth: Bearer token (validated against UserContainer.gatewayToken or SystemContainer.gatewayToken)
|
||||
// Returns: assembled openclaw.json
|
||||
//
|
||||
// The :id param is the container record ID (cuid)
|
||||
// Token must match the container requesting its own config
|
||||
@Get("agent-config/:id")
|
||||
async getAgentConfig(
|
||||
@Param("id") id: string,
|
||||
@Req() request: AgentConfigRequest
|
||||
): Promise<object> {
|
||||
const containerAuth = request.containerAuth;
|
||||
if (!containerAuth) {
|
||||
throw new UnauthorizedException("Missing container authentication context");
|
||||
}
|
||||
|
||||
if (containerAuth.id !== id) {
|
||||
throw new ForbiddenException("Token is not authorized for the requested container");
|
||||
}
|
||||
|
||||
return this.agentConfigService.generateConfigForContainer(containerAuth.type, id);
|
||||
}
|
||||
}
|
||||
43
apps/api/src/agent-config/agent-config.guard.ts
Normal file
43
apps/api/src/agent-config/agent-config.guard.ts
Normal file
@@ -0,0 +1,43 @@
|
||||
import { CanActivate, ExecutionContext, Injectable, UnauthorizedException } from "@nestjs/common";
|
||||
import type { Request } from "express";
|
||||
import { AgentConfigService, type ContainerTokenValidation } from "./agent-config.service";
|
||||
|
||||
export interface AgentConfigRequest extends Request {
|
||||
containerAuth?: ContainerTokenValidation;
|
||||
}
|
||||
|
||||
@Injectable()
|
||||
export class AgentConfigGuard implements CanActivate {
|
||||
constructor(private readonly agentConfigService: AgentConfigService) {}
|
||||
|
||||
async canActivate(context: ExecutionContext): Promise<boolean> {
|
||||
const request = context.switchToHttp().getRequest<AgentConfigRequest>();
|
||||
const token = this.extractBearerToken(request.headers.authorization);
|
||||
|
||||
if (!token) {
|
||||
throw new UnauthorizedException("Missing Bearer token");
|
||||
}
|
||||
|
||||
const containerAuth = await this.agentConfigService.validateContainerToken(token);
|
||||
if (!containerAuth) {
|
||||
throw new UnauthorizedException("Invalid container token");
|
||||
}
|
||||
|
||||
request.containerAuth = containerAuth;
|
||||
return true;
|
||||
}
|
||||
|
||||
private extractBearerToken(headerValue: string | string[] | undefined): string | null {
|
||||
const normalizedHeader = Array.isArray(headerValue) ? headerValue[0] : headerValue;
|
||||
if (!normalizedHeader) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const [scheme, token] = normalizedHeader.split(" ");
|
||||
if (!scheme || !token || scheme.toLowerCase() !== "bearer") {
|
||||
return null;
|
||||
}
|
||||
|
||||
return token;
|
||||
}
|
||||
}
|
||||
14
apps/api/src/agent-config/agent-config.module.ts
Normal file
14
apps/api/src/agent-config/agent-config.module.ts
Normal file
@@ -0,0 +1,14 @@
|
||||
import { Module } from "@nestjs/common";
|
||||
import { PrismaModule } from "../prisma/prisma.module";
|
||||
import { CryptoModule } from "../crypto/crypto.module";
|
||||
import { AgentConfigController } from "./agent-config.controller";
|
||||
import { AgentConfigService } from "./agent-config.service";
|
||||
import { AgentConfigGuard } from "./agent-config.guard";
|
||||
|
||||
@Module({
|
||||
imports: [PrismaModule, CryptoModule],
|
||||
controllers: [AgentConfigController],
|
||||
providers: [AgentConfigService, AgentConfigGuard],
|
||||
exports: [AgentConfigService],
|
||||
})
|
||||
export class AgentConfigModule {}
|
||||
215
apps/api/src/agent-config/agent-config.service.spec.ts
Normal file
215
apps/api/src/agent-config/agent-config.service.spec.ts
Normal file
@@ -0,0 +1,215 @@
|
||||
import { beforeEach, describe, expect, it, vi } from "vitest";
|
||||
import { AgentConfigService } from "./agent-config.service";
|
||||
import { PrismaService } from "../prisma/prisma.service";
|
||||
import { CryptoService } from "../crypto/crypto.service";
|
||||
|
||||
describe("AgentConfigService", () => {
|
||||
let service: AgentConfigService;
|
||||
|
||||
const mockPrismaService = {
|
||||
userAgentConfig: {
|
||||
findUnique: vi.fn(),
|
||||
},
|
||||
llmProvider: {
|
||||
findMany: vi.fn(),
|
||||
},
|
||||
userContainer: {
|
||||
findUnique: vi.fn(),
|
||||
findMany: vi.fn(),
|
||||
},
|
||||
systemContainer: {
|
||||
findUnique: vi.fn(),
|
||||
findMany: vi.fn(),
|
||||
},
|
||||
};
|
||||
|
||||
const mockCryptoService = {
|
||||
isEncrypted: vi.fn((value: string) => value.startsWith("enc:")),
|
||||
decrypt: vi.fn((value: string) => value.replace(/^enc:/, "")),
|
||||
};
|
||||
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
|
||||
service = new AgentConfigService(
|
||||
mockPrismaService as unknown as PrismaService,
|
||||
mockCryptoService as unknown as CryptoService
|
||||
);
|
||||
});
|
||||
|
||||
it("generateUserConfig returns valid openclaw.json structure", async () => {
|
||||
mockPrismaService.userAgentConfig.findUnique.mockResolvedValue({
|
||||
id: "cfg-1",
|
||||
userId: "user-1",
|
||||
primaryModel: "my-zai/glm-5",
|
||||
});
|
||||
|
||||
mockPrismaService.userContainer.findUnique.mockResolvedValue({
|
||||
id: "container-1",
|
||||
userId: "user-1",
|
||||
gatewayPort: 19001,
|
||||
});
|
||||
|
||||
mockPrismaService.llmProvider.findMany.mockResolvedValue([
|
||||
{
|
||||
id: "provider-1",
|
||||
userId: "user-1",
|
||||
name: "my-zai",
|
||||
displayName: "Z.ai",
|
||||
type: "zai",
|
||||
baseUrl: "https://api.z.ai/v1",
|
||||
apiKey: "enc:secret-zai-key",
|
||||
apiType: "openai-completions",
|
||||
models: [{ id: "glm-5" }],
|
||||
isActive: true,
|
||||
createdAt: new Date(),
|
||||
updatedAt: new Date(),
|
||||
},
|
||||
]);
|
||||
|
||||
const result = await service.generateUserConfig("user-1");
|
||||
|
||||
expect(result).toEqual({
|
||||
gateway: {
|
||||
mode: "local",
|
||||
port: 19001,
|
||||
bind: "lan",
|
||||
auth: { mode: "token" },
|
||||
http: {
|
||||
endpoints: {
|
||||
chatCompletions: { enabled: true },
|
||||
},
|
||||
},
|
||||
},
|
||||
agents: {
|
||||
defaults: {
|
||||
model: {
|
||||
primary: "my-zai/glm-5",
|
||||
},
|
||||
},
|
||||
},
|
||||
models: {
|
||||
providers: {
|
||||
"my-zai": {
|
||||
apiKey: "secret-zai-key",
|
||||
baseUrl: "https://api.z.ai/v1",
|
||||
models: {
|
||||
"glm-5": {},
|
||||
},
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
it("generateUserConfig decrypts API keys correctly", async () => {
|
||||
mockPrismaService.userAgentConfig.findUnique.mockResolvedValue({
|
||||
id: "cfg-1",
|
||||
userId: "user-1",
|
||||
primaryModel: "openai-work/gpt-4.1",
|
||||
});
|
||||
|
||||
mockPrismaService.userContainer.findUnique.mockResolvedValue({
|
||||
id: "container-1",
|
||||
userId: "user-1",
|
||||
gatewayPort: 18789,
|
||||
});
|
||||
|
||||
mockPrismaService.llmProvider.findMany.mockResolvedValue([
|
||||
{
|
||||
id: "provider-1",
|
||||
userId: "user-1",
|
||||
name: "openai-work",
|
||||
displayName: "OpenAI Work",
|
||||
type: "openai",
|
||||
baseUrl: "https://api.openai.com/v1",
|
||||
apiKey: "enc:encrypted-openai-key",
|
||||
apiType: "openai-completions",
|
||||
models: [{ id: "gpt-4.1" }],
|
||||
isActive: true,
|
||||
createdAt: new Date(),
|
||||
updatedAt: new Date(),
|
||||
},
|
||||
]);
|
||||
|
||||
const result = await service.generateUserConfig("user-1");
|
||||
|
||||
expect(mockCryptoService.decrypt).toHaveBeenCalledWith("enc:encrypted-openai-key");
|
||||
expect(result.models.providers["openai-work"]?.apiKey).toBe("encrypted-openai-key");
|
||||
});
|
||||
|
||||
it("generateUserConfig handles user with no providers", async () => {
|
||||
mockPrismaService.userAgentConfig.findUnique.mockResolvedValue({
|
||||
id: "cfg-1",
|
||||
userId: "user-2",
|
||||
primaryModel: "openai/gpt-4o-mini",
|
||||
});
|
||||
|
||||
mockPrismaService.userContainer.findUnique.mockResolvedValue({
|
||||
id: "container-2",
|
||||
userId: "user-2",
|
||||
gatewayPort: null,
|
||||
});
|
||||
|
||||
mockPrismaService.llmProvider.findMany.mockResolvedValue([]);
|
||||
|
||||
const result = await service.generateUserConfig("user-2");
|
||||
|
||||
expect(result.models.providers).toEqual({});
|
||||
expect(result.gateway.port).toBe(18789);
|
||||
});
|
||||
|
||||
it("validateContainerToken returns correct type for user container", async () => {
|
||||
mockPrismaService.userContainer.findMany.mockResolvedValue([
|
||||
{
|
||||
id: "user-container-1",
|
||||
gatewayToken: "enc:user-token-1",
|
||||
},
|
||||
]);
|
||||
mockPrismaService.systemContainer.findMany.mockResolvedValue([]);
|
||||
|
||||
const result = await service.validateContainerToken("user-token-1");
|
||||
|
||||
expect(result).toEqual({
|
||||
type: "user",
|
||||
id: "user-container-1",
|
||||
});
|
||||
});
|
||||
|
||||
it("validateContainerToken returns correct type for system container", async () => {
|
||||
mockPrismaService.userContainer.findMany.mockResolvedValue([]);
|
||||
mockPrismaService.systemContainer.findMany.mockResolvedValue([
|
||||
{
|
||||
id: "system-container-1",
|
||||
gatewayToken: "enc:system-token-1",
|
||||
},
|
||||
]);
|
||||
|
||||
const result = await service.validateContainerToken("system-token-1");
|
||||
|
||||
expect(result).toEqual({
|
||||
type: "system",
|
||||
id: "system-container-1",
|
||||
});
|
||||
});
|
||||
|
||||
it("validateContainerToken returns null for invalid token", async () => {
|
||||
mockPrismaService.userContainer.findMany.mockResolvedValue([
|
||||
{
|
||||
id: "user-container-1",
|
||||
gatewayToken: "enc:user-token-1",
|
||||
},
|
||||
]);
|
||||
|
||||
mockPrismaService.systemContainer.findMany.mockResolvedValue([
|
||||
{
|
||||
id: "system-container-1",
|
||||
gatewayToken: "enc:system-token-1",
|
||||
},
|
||||
]);
|
||||
|
||||
const result = await service.validateContainerToken("no-match");
|
||||
|
||||
expect(result).toBeNull();
|
||||
});
|
||||
});
|
||||
288
apps/api/src/agent-config/agent-config.service.ts
Normal file
288
apps/api/src/agent-config/agent-config.service.ts
Normal file
@@ -0,0 +1,288 @@
|
||||
import { Injectable, NotFoundException } from "@nestjs/common";
|
||||
import type { LlmProvider } from "@prisma/client";
|
||||
import { timingSafeEqual } from "node:crypto";
|
||||
import { PrismaService } from "../prisma/prisma.service";
|
||||
import { CryptoService } from "../crypto/crypto.service";
|
||||
|
||||
const DEFAULT_GATEWAY_PORT = 18789;
|
||||
const DEFAULT_PRIMARY_MODEL = "openai/gpt-4o-mini";
|
||||
|
||||
type ContainerType = "user" | "system";
|
||||
|
||||
export interface ContainerTokenValidation {
|
||||
type: ContainerType;
|
||||
id: string;
|
||||
}
|
||||
|
||||
type OpenClawModelMap = Record<string, Record<string, never>>;
|
||||
|
||||
interface OpenClawProviderConfig {
|
||||
apiKey?: string;
|
||||
baseUrl?: string;
|
||||
models: OpenClawModelMap;
|
||||
}
|
||||
|
||||
interface OpenClawConfig {
|
||||
gateway: {
|
||||
mode: "local";
|
||||
port: number;
|
||||
bind: "lan";
|
||||
auth: { mode: "token" };
|
||||
http: {
|
||||
endpoints: {
|
||||
chatCompletions: { enabled: true };
|
||||
};
|
||||
};
|
||||
};
|
||||
agents: {
|
||||
defaults: {
|
||||
model: {
|
||||
primary: string;
|
||||
};
|
||||
};
|
||||
};
|
||||
models: {
|
||||
providers: Record<string, OpenClawProviderConfig>;
|
||||
};
|
||||
}
|
||||
|
||||
@Injectable()
|
||||
export class AgentConfigService {
|
||||
constructor(
|
||||
private readonly prisma: PrismaService,
|
||||
private readonly crypto: CryptoService
|
||||
) {}
|
||||
|
||||
// Generate complete openclaw.json for a user container
|
||||
async generateUserConfig(userId: string): Promise<OpenClawConfig> {
|
||||
const [userAgentConfig, providers, userContainer] = await Promise.all([
|
||||
this.prisma.userAgentConfig.findUnique({
|
||||
where: { userId },
|
||||
}),
|
||||
this.prisma.llmProvider.findMany({
|
||||
where: {
|
||||
userId,
|
||||
isActive: true,
|
||||
},
|
||||
orderBy: {
|
||||
createdAt: "asc",
|
||||
},
|
||||
}),
|
||||
this.prisma.userContainer.findUnique({
|
||||
where: { userId },
|
||||
}),
|
||||
]);
|
||||
|
||||
if (!userContainer) {
|
||||
throw new NotFoundException(`User container not found for user ${userId}`);
|
||||
}
|
||||
|
||||
const primaryModel =
|
||||
userAgentConfig?.primaryModel ??
|
||||
this.resolvePrimaryModelFromProviders(providers) ??
|
||||
DEFAULT_PRIMARY_MODEL;
|
||||
|
||||
return this.buildOpenClawConfig(primaryModel, userContainer.gatewayPort, providers);
|
||||
}
|
||||
|
||||
// Generate config for a system container
|
||||
async generateSystemConfig(containerId: string): Promise<OpenClawConfig> {
|
||||
const systemContainer = await this.prisma.systemContainer.findUnique({
|
||||
where: { id: containerId },
|
||||
});
|
||||
|
||||
if (!systemContainer) {
|
||||
throw new NotFoundException(`System container ${containerId} not found`);
|
||||
}
|
||||
|
||||
return this.buildOpenClawConfig(
|
||||
systemContainer.primaryModel || DEFAULT_PRIMARY_MODEL,
|
||||
systemContainer.gatewayPort,
|
||||
[]
|
||||
);
|
||||
}
|
||||
|
||||
async generateConfigForContainer(
|
||||
type: ContainerType,
|
||||
containerId: string
|
||||
): Promise<OpenClawConfig> {
|
||||
if (type === "system") {
|
||||
return this.generateSystemConfig(containerId);
|
||||
}
|
||||
|
||||
const userContainer = await this.prisma.userContainer.findUnique({
|
||||
where: { id: containerId },
|
||||
select: { userId: true },
|
||||
});
|
||||
|
||||
if (!userContainer) {
|
||||
throw new NotFoundException(`User container ${containerId} not found`);
|
||||
}
|
||||
|
||||
return this.generateUserConfig(userContainer.userId);
|
||||
}
|
||||
|
||||
// Validate a container's bearer token
|
||||
async validateContainerToken(token: string): Promise<ContainerTokenValidation | null> {
|
||||
if (!token) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const [userContainers, systemContainers] = await Promise.all([
|
||||
this.prisma.userContainer.findMany({
|
||||
select: {
|
||||
id: true,
|
||||
gatewayToken: true,
|
||||
},
|
||||
}),
|
||||
this.prisma.systemContainer.findMany({
|
||||
select: {
|
||||
id: true,
|
||||
gatewayToken: true,
|
||||
},
|
||||
}),
|
||||
]);
|
||||
|
||||
for (const container of userContainers) {
|
||||
const storedToken = this.decryptContainerToken(container.gatewayToken);
|
||||
if (storedToken && this.tokensEqual(storedToken, token)) {
|
||||
return { type: "user", id: container.id };
|
||||
}
|
||||
}
|
||||
|
||||
for (const container of systemContainers) {
|
||||
const storedToken = this.decryptContainerToken(container.gatewayToken);
|
||||
if (storedToken && this.tokensEqual(storedToken, token)) {
|
||||
return { type: "system", id: container.id };
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
private buildOpenClawConfig(
|
||||
primaryModel: string,
|
||||
gatewayPort: number | null,
|
||||
providers: LlmProvider[]
|
||||
): OpenClawConfig {
|
||||
return {
|
||||
gateway: {
|
||||
mode: "local",
|
||||
port: gatewayPort ?? DEFAULT_GATEWAY_PORT,
|
||||
bind: "lan",
|
||||
auth: { mode: "token" },
|
||||
http: {
|
||||
endpoints: {
|
||||
chatCompletions: { enabled: true },
|
||||
},
|
||||
},
|
||||
},
|
||||
agents: {
|
||||
defaults: {
|
||||
model: {
|
||||
primary: primaryModel,
|
||||
},
|
||||
},
|
||||
},
|
||||
models: {
|
||||
providers: this.buildProviderConfig(providers),
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
private buildProviderConfig(providers: LlmProvider[]): Record<string, OpenClawProviderConfig> {
|
||||
const providerConfig: Record<string, OpenClawProviderConfig> = {};
|
||||
|
||||
for (const provider of providers) {
|
||||
const config: OpenClawProviderConfig = {
|
||||
models: this.extractModels(provider.models),
|
||||
};
|
||||
|
||||
const apiKey = this.decryptIfNeeded(provider.apiKey);
|
||||
if (apiKey) {
|
||||
config.apiKey = apiKey;
|
||||
}
|
||||
|
||||
if (provider.baseUrl) {
|
||||
config.baseUrl = provider.baseUrl;
|
||||
}
|
||||
|
||||
providerConfig[provider.name] = config;
|
||||
}
|
||||
|
||||
return providerConfig;
|
||||
}
|
||||
|
||||
private extractModels(models: unknown): OpenClawModelMap {
|
||||
const modelMap: OpenClawModelMap = {};
|
||||
|
||||
if (!Array.isArray(models)) {
|
||||
return modelMap;
|
||||
}
|
||||
|
||||
for (const modelEntry of models) {
|
||||
if (typeof modelEntry === "string") {
|
||||
modelMap[modelEntry] = {};
|
||||
continue;
|
||||
}
|
||||
|
||||
if (this.hasModelId(modelEntry)) {
|
||||
modelMap[modelEntry.id] = {};
|
||||
}
|
||||
}
|
||||
|
||||
return modelMap;
|
||||
}
|
||||
|
||||
private resolvePrimaryModelFromProviders(providers: LlmProvider[]): string | null {
|
||||
for (const provider of providers) {
|
||||
const modelIds = Object.keys(this.extractModels(provider.models));
|
||||
const firstModelId = modelIds[0];
|
||||
|
||||
if (firstModelId) {
|
||||
return `${provider.name}/${firstModelId}`;
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
private decryptIfNeeded(value: string | null | undefined): string | undefined {
|
||||
if (!value) {
|
||||
return undefined;
|
||||
}
|
||||
|
||||
if (this.crypto.isEncrypted(value)) {
|
||||
return this.crypto.decrypt(value);
|
||||
}
|
||||
|
||||
return value;
|
||||
}
|
||||
|
||||
private decryptContainerToken(value: string): string | null {
|
||||
try {
|
||||
return this.decryptIfNeeded(value) ?? null;
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
private tokensEqual(left: string, right: string): boolean {
|
||||
const leftBuffer = Buffer.from(left, "utf8");
|
||||
const rightBuffer = Buffer.from(right, "utf8");
|
||||
|
||||
if (leftBuffer.length !== rightBuffer.length) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return timingSafeEqual(leftBuffer, rightBuffer);
|
||||
}
|
||||
|
||||
private hasModelId(modelEntry: unknown): modelEntry is { id: string } {
|
||||
if (typeof modelEntry !== "object" || modelEntry === null || !("id" in modelEntry)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
return typeof (modelEntry as { id?: unknown }).id === "string";
|
||||
}
|
||||
}
|
||||
@@ -2,6 +2,7 @@ import { Module } from "@nestjs/common";
|
||||
import { APP_INTERCEPTOR, APP_GUARD } from "@nestjs/core";
|
||||
import { ThrottlerModule } from "@nestjs/throttler";
|
||||
import { BullModule } from "@nestjs/bullmq";
|
||||
import { ScheduleModule } from "@nestjs/schedule";
|
||||
import { ThrottlerValkeyStorageService, ThrottlerApiKeyGuard } from "./common/throttler";
|
||||
import { CsrfGuard } from "./common/guards/csrf.guard";
|
||||
import { CsrfService } from "./common/services/csrf.service";
|
||||
@@ -51,6 +52,12 @@ import { TeamsModule } from "./teams/teams.module";
|
||||
import { ImportModule } from "./import/import.module";
|
||||
import { ConversationArchiveModule } from "./conversation-archive/conversation-archive.module";
|
||||
import { RlsContextInterceptor } from "./common/interceptors/rls-context.interceptor";
|
||||
import { AgentConfigModule } from "./agent-config/agent-config.module";
|
||||
import { ContainerLifecycleModule } from "./container-lifecycle/container-lifecycle.module";
|
||||
import { ContainerReaperModule } from "./container-reaper/container-reaper.module";
|
||||
import { FleetSettingsModule } from "./fleet-settings/fleet-settings.module";
|
||||
import { OnboardingModule } from "./onboarding/onboarding.module";
|
||||
import { ChatProxyModule } from "./chat-proxy/chat-proxy.module";
|
||||
|
||||
@Module({
|
||||
imports: [
|
||||
@@ -81,6 +88,7 @@ import { RlsContextInterceptor } from "./common/interceptors/rls-context.interce
|
||||
};
|
||||
})(),
|
||||
}),
|
||||
ScheduleModule.forRoot(),
|
||||
TelemetryModule,
|
||||
PrismaModule,
|
||||
DatabaseModule,
|
||||
@@ -123,6 +131,12 @@ import { RlsContextInterceptor } from "./common/interceptors/rls-context.interce
|
||||
TeamsModule,
|
||||
ImportModule,
|
||||
ConversationArchiveModule,
|
||||
AgentConfigModule,
|
||||
ContainerLifecycleModule,
|
||||
ContainerReaperModule,
|
||||
FleetSettingsModule,
|
||||
OnboardingModule,
|
||||
ChatProxyModule,
|
||||
],
|
||||
controllers: [AppController, CsrfController],
|
||||
providers: [
|
||||
|
||||
72
apps/api/src/chat-proxy/chat-proxy.controller.ts
Normal file
72
apps/api/src/chat-proxy/chat-proxy.controller.ts
Normal file
@@ -0,0 +1,72 @@
|
||||
import { Body, Controller, Post, Req, Res, UnauthorizedException, UseGuards } from "@nestjs/common";
|
||||
import type { Response } from "express";
|
||||
import { AuthGuard } from "../auth/guards/auth.guard";
|
||||
import type { MaybeAuthenticatedRequest } from "../auth/types/better-auth-request.interface";
|
||||
import { ChatStreamDto } from "./chat-proxy.dto";
|
||||
import { ChatProxyService } from "./chat-proxy.service";
|
||||
|
||||
@Controller("chat")
|
||||
@UseGuards(AuthGuard)
|
||||
export class ChatProxyController {
|
||||
constructor(private readonly chatProxyService: ChatProxyService) {}
|
||||
|
||||
// POST /api/chat/stream
|
||||
// Request: { messages: Array<{role, content}> }
|
||||
// Response: SSE stream of chat completion events
|
||||
@Post("stream")
|
||||
async streamChat(
|
||||
@Body() body: ChatStreamDto,
|
||||
@Req() req: MaybeAuthenticatedRequest,
|
||||
@Res() res: Response
|
||||
): Promise<void> {
|
||||
const userId = req.user?.id;
|
||||
if (!userId) {
|
||||
throw new UnauthorizedException("No authenticated user found on request");
|
||||
}
|
||||
|
||||
const abortController = new AbortController();
|
||||
req.once("close", () => {
|
||||
abortController.abort();
|
||||
});
|
||||
|
||||
res.setHeader("Content-Type", "text/event-stream");
|
||||
res.setHeader("Cache-Control", "no-cache");
|
||||
res.setHeader("Connection", "keep-alive");
|
||||
res.setHeader("X-Accel-Buffering", "no");
|
||||
|
||||
try {
|
||||
const upstreamResponse = await this.chatProxyService.proxyChat(
|
||||
userId,
|
||||
body.messages,
|
||||
abortController.signal
|
||||
);
|
||||
|
||||
const upstreamContentType = upstreamResponse.headers.get("content-type");
|
||||
if (upstreamContentType) {
|
||||
res.setHeader("Content-Type", upstreamContentType);
|
||||
}
|
||||
|
||||
if (!upstreamResponse.body) {
|
||||
throw new Error("OpenClaw response did not include a stream body");
|
||||
}
|
||||
|
||||
for await (const chunk of upstreamResponse.body as unknown as AsyncIterable<Uint8Array>) {
|
||||
if (res.writableEnded || res.destroyed) {
|
||||
break;
|
||||
}
|
||||
|
||||
res.write(Buffer.from(chunk));
|
||||
}
|
||||
} catch (error: unknown) {
|
||||
if (!res.writableEnded && !res.destroyed) {
|
||||
const message = error instanceof Error ? error.message : String(error);
|
||||
res.write("event: error\n");
|
||||
res.write(`data: ${JSON.stringify({ error: message })}\n\n`);
|
||||
}
|
||||
} finally {
|
||||
if (!res.writableEnded && !res.destroyed) {
|
||||
res.end();
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
25
apps/api/src/chat-proxy/chat-proxy.dto.ts
Normal file
25
apps/api/src/chat-proxy/chat-proxy.dto.ts
Normal file
@@ -0,0 +1,25 @@
|
||||
import { Type } from "class-transformer";
|
||||
import { ArrayMinSize, IsArray, IsNotEmpty, IsString, ValidateNested } from "class-validator";
|
||||
|
||||
export interface ChatMessage {
|
||||
role: string;
|
||||
content: string;
|
||||
}
|
||||
|
||||
export class ChatMessageDto implements ChatMessage {
|
||||
@IsString({ message: "role must be a string" })
|
||||
@IsNotEmpty({ message: "role is required" })
|
||||
role!: string;
|
||||
|
||||
@IsString({ message: "content must be a string" })
|
||||
@IsNotEmpty({ message: "content is required" })
|
||||
content!: string;
|
||||
}
|
||||
|
||||
export class ChatStreamDto {
|
||||
@IsArray({ message: "messages must be an array" })
|
||||
@ArrayMinSize(1, { message: "messages must contain at least one message" })
|
||||
@ValidateNested({ each: true })
|
||||
@Type(() => ChatMessageDto)
|
||||
messages!: ChatMessageDto[];
|
||||
}
|
||||
15
apps/api/src/chat-proxy/chat-proxy.module.ts
Normal file
15
apps/api/src/chat-proxy/chat-proxy.module.ts
Normal file
@@ -0,0 +1,15 @@
|
||||
import { Module } from "@nestjs/common";
|
||||
import { AuthModule } from "../auth/auth.module";
|
||||
import { AgentConfigModule } from "../agent-config/agent-config.module";
|
||||
import { ContainerLifecycleModule } from "../container-lifecycle/container-lifecycle.module";
|
||||
import { PrismaModule } from "../prisma/prisma.module";
|
||||
import { ChatProxyController } from "./chat-proxy.controller";
|
||||
import { ChatProxyService } from "./chat-proxy.service";
|
||||
|
||||
@Module({
|
||||
imports: [AuthModule, PrismaModule, ContainerLifecycleModule, AgentConfigModule],
|
||||
controllers: [ChatProxyController],
|
||||
providers: [ChatProxyService],
|
||||
exports: [ChatProxyService],
|
||||
})
|
||||
export class ChatProxyModule {}
|
||||
107
apps/api/src/chat-proxy/chat-proxy.service.spec.ts
Normal file
107
apps/api/src/chat-proxy/chat-proxy.service.spec.ts
Normal file
@@ -0,0 +1,107 @@
|
||||
import { ServiceUnavailableException } from "@nestjs/common";
|
||||
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
|
||||
import { ChatProxyService } from "./chat-proxy.service";
|
||||
|
||||
describe("ChatProxyService", () => {
|
||||
const userId = "user-123";
|
||||
|
||||
const prisma = {
|
||||
userAgentConfig: {
|
||||
findUnique: vi.fn(),
|
||||
},
|
||||
};
|
||||
|
||||
const containerLifecycle = {
|
||||
ensureRunning: vi.fn(),
|
||||
touch: vi.fn(),
|
||||
};
|
||||
|
||||
let service: ChatProxyService;
|
||||
let fetchMock: ReturnType<typeof vi.fn>;
|
||||
|
||||
beforeEach(() => {
|
||||
fetchMock = vi.fn();
|
||||
vi.stubGlobal("fetch", fetchMock);
|
||||
service = new ChatProxyService(prisma as never, containerLifecycle as never);
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
vi.unstubAllGlobals();
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
|
||||
describe("getContainerUrl", () => {
|
||||
it("calls ensureRunning and touch for the user", async () => {
|
||||
containerLifecycle.ensureRunning.mockResolvedValue({
|
||||
url: "http://mosaic-user-user-123:19000",
|
||||
token: "gateway-token",
|
||||
});
|
||||
containerLifecycle.touch.mockResolvedValue(undefined);
|
||||
|
||||
const url = await service.getContainerUrl(userId);
|
||||
|
||||
expect(url).toBe("http://mosaic-user-user-123:19000");
|
||||
expect(containerLifecycle.ensureRunning).toHaveBeenCalledWith(userId);
|
||||
expect(containerLifecycle.touch).toHaveBeenCalledWith(userId);
|
||||
});
|
||||
});
|
||||
|
||||
describe("proxyChat", () => {
|
||||
it("forwards the request to the user's OpenClaw container", async () => {
|
||||
containerLifecycle.ensureRunning.mockResolvedValue({
|
||||
url: "http://mosaic-user-user-123:19000",
|
||||
token: "gateway-token",
|
||||
});
|
||||
containerLifecycle.touch.mockResolvedValue(undefined);
|
||||
fetchMock.mockResolvedValue(new Response("event: token\ndata: hello\n\n"));
|
||||
|
||||
const messages = [{ role: "user", content: "Hello from Mosaic" }];
|
||||
const response = await service.proxyChat(userId, messages);
|
||||
|
||||
expect(response).toBeInstanceOf(Response);
|
||||
expect(fetchMock).toHaveBeenCalledWith(
|
||||
"http://mosaic-user-user-123:19000/v1/chat/completions",
|
||||
expect.objectContaining({
|
||||
method: "POST",
|
||||
headers: {
|
||||
"Content-Type": "application/json",
|
||||
},
|
||||
})
|
||||
);
|
||||
|
||||
const [, request] = fetchMock.mock.calls[0] as [string, RequestInit];
|
||||
const parsedBody = JSON.parse(String(request.body));
|
||||
expect(parsedBody).toEqual({
|
||||
messages,
|
||||
model: "openclaw:default",
|
||||
stream: true,
|
||||
});
|
||||
});
|
||||
|
||||
it("throws ServiceUnavailableException on connection refused errors", async () => {
|
||||
containerLifecycle.ensureRunning.mockResolvedValue({
|
||||
url: "http://mosaic-user-user-123:19000",
|
||||
token: "gateway-token",
|
||||
});
|
||||
containerLifecycle.touch.mockResolvedValue(undefined);
|
||||
fetchMock.mockRejectedValue(new Error("connect ECONNREFUSED 127.0.0.1:19000"));
|
||||
|
||||
await expect(service.proxyChat(userId, [])).rejects.toBeInstanceOf(
|
||||
ServiceUnavailableException
|
||||
);
|
||||
});
|
||||
|
||||
it("throws ServiceUnavailableException on timeout errors", async () => {
|
||||
containerLifecycle.ensureRunning.mockResolvedValue({
|
||||
url: "http://mosaic-user-user-123:19000",
|
||||
token: "gateway-token",
|
||||
});
|
||||
containerLifecycle.touch.mockResolvedValue(undefined);
|
||||
fetchMock.mockRejectedValue(new Error("The operation was aborted due to timeout"));
|
||||
|
||||
await expect(service.proxyChat(userId, [])).rejects.toBeInstanceOf(
|
||||
ServiceUnavailableException
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
89
apps/api/src/chat-proxy/chat-proxy.service.ts
Normal file
89
apps/api/src/chat-proxy/chat-proxy.service.ts
Normal file
@@ -0,0 +1,89 @@
|
||||
import { BadGatewayException, Injectable, ServiceUnavailableException } from "@nestjs/common";
|
||||
import { ContainerLifecycleService } from "../container-lifecycle/container-lifecycle.service";
|
||||
import { PrismaService } from "../prisma/prisma.service";
|
||||
import type { ChatMessage } from "./chat-proxy.dto";
|
||||
|
||||
const DEFAULT_OPENCLAW_MODEL = "openclaw:default";
|
||||
|
||||
@Injectable()
|
||||
export class ChatProxyService {
|
||||
constructor(
|
||||
private readonly prisma: PrismaService,
|
||||
private readonly containerLifecycle: ContainerLifecycleService
|
||||
) {}
|
||||
|
||||
// Get the user's OpenClaw container URL and mark it active.
|
||||
async getContainerUrl(userId: string): Promise<string> {
|
||||
const { url } = await this.containerLifecycle.ensureRunning(userId);
|
||||
await this.containerLifecycle.touch(userId);
|
||||
return url;
|
||||
}
|
||||
|
||||
// Proxy chat request to OpenClaw.
|
||||
async proxyChat(
|
||||
userId: string,
|
||||
messages: ChatMessage[],
|
||||
signal?: AbortSignal
|
||||
): Promise<Response> {
|
||||
const containerUrl = await this.getContainerUrl(userId);
|
||||
const model = await this.getPreferredModel(userId);
|
||||
const requestInit: RequestInit = {
|
||||
method: "POST",
|
||||
headers: { "Content-Type": "application/json" },
|
||||
body: JSON.stringify({
|
||||
messages,
|
||||
model,
|
||||
stream: true,
|
||||
}),
|
||||
};
|
||||
|
||||
if (signal) {
|
||||
requestInit.signal = signal;
|
||||
}
|
||||
|
||||
try {
|
||||
const response = await fetch(`${containerUrl}/v1/chat/completions`, requestInit);
|
||||
|
||||
if (!response.ok) {
|
||||
const detail = await this.readResponseText(response);
|
||||
const status = `${String(response.status)} ${response.statusText}`.trim();
|
||||
const message = detail
|
||||
? `OpenClaw returned ${status}: ${detail}`
|
||||
: `OpenClaw returned ${status}`;
|
||||
throw new BadGatewayException(message);
|
||||
}
|
||||
|
||||
return response;
|
||||
} catch (error: unknown) {
|
||||
if (error instanceof BadGatewayException) {
|
||||
throw error;
|
||||
}
|
||||
|
||||
const message = error instanceof Error ? error.message : String(error);
|
||||
throw new ServiceUnavailableException(`Failed to proxy chat to OpenClaw: ${message}`);
|
||||
}
|
||||
}
|
||||
|
||||
private async getPreferredModel(userId: string): Promise<string> {
|
||||
const config = await this.prisma.userAgentConfig.findUnique({
|
||||
where: { userId },
|
||||
select: { primaryModel: true },
|
||||
});
|
||||
|
||||
const primaryModel = config?.primaryModel?.trim();
|
||||
if (!primaryModel) {
|
||||
return DEFAULT_OPENCLAW_MODEL;
|
||||
}
|
||||
|
||||
return primaryModel;
|
||||
}
|
||||
|
||||
private async readResponseText(response: Response): Promise<string | null> {
|
||||
try {
|
||||
const text = (await response.text()).trim();
|
||||
return text.length > 0 ? text : null;
|
||||
} catch {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -87,6 +87,17 @@ describe("CsrfGuard", () => {
|
||||
});
|
||||
|
||||
describe("State-changing methods requiring CSRF", () => {
|
||||
it("should allow POST with Bearer auth without CSRF token", () => {
|
||||
const context = createContext(
|
||||
"POST",
|
||||
{},
|
||||
{ authorization: "Bearer api-token" },
|
||||
false,
|
||||
"user-123"
|
||||
);
|
||||
expect(guard.canActivate(context)).toBe(true);
|
||||
});
|
||||
|
||||
it("should reject POST without CSRF token", () => {
|
||||
const context = createContext("POST", {}, {}, false, "user-123");
|
||||
expect(() => guard.canActivate(context)).toThrow(ForbiddenException);
|
||||
|
||||
@@ -57,6 +57,11 @@ export class CsrfGuard implements CanActivate {
|
||||
return true;
|
||||
}
|
||||
|
||||
const authHeader = request.headers.authorization;
|
||||
if (typeof authHeader === "string" && authHeader.startsWith("Bearer ")) {
|
||||
return true;
|
||||
}
|
||||
|
||||
// Get CSRF token from cookie and header
|
||||
const cookies = request.cookies as Record<string, string> | undefined;
|
||||
const cookieToken = cookies?.["csrf-token"];
|
||||
|
||||
@@ -0,0 +1,12 @@
|
||||
import { Module } from "@nestjs/common";
|
||||
import { ConfigModule } from "@nestjs/config";
|
||||
import { PrismaModule } from "../prisma/prisma.module";
|
||||
import { CryptoModule } from "../crypto/crypto.module";
|
||||
import { ContainerLifecycleService } from "./container-lifecycle.service";
|
||||
|
||||
@Module({
|
||||
imports: [ConfigModule, PrismaModule, CryptoModule],
|
||||
providers: [ContainerLifecycleService],
|
||||
exports: [ContainerLifecycleService],
|
||||
})
|
||||
export class ContainerLifecycleModule {}
|
||||
@@ -0,0 +1,593 @@
|
||||
import { beforeEach, describe, expect, it, vi } from "vitest";
|
||||
import type { ConfigService } from "@nestjs/config";
|
||||
import type { PrismaService } from "../prisma/prisma.service";
|
||||
import type { CryptoService } from "../crypto/crypto.service";
|
||||
|
||||
interface MockUserContainerRecord {
|
||||
id: string;
|
||||
userId: string;
|
||||
containerId: string | null;
|
||||
containerName: string;
|
||||
gatewayPort: number | null;
|
||||
gatewayToken: string;
|
||||
status: string;
|
||||
lastActiveAt: Date | null;
|
||||
idleTimeoutMin: number;
|
||||
config: Record<string, unknown>;
|
||||
createdAt: Date;
|
||||
updatedAt: Date;
|
||||
}
|
||||
|
||||
const dockerMock = vi.hoisted(() => {
|
||||
interface MockDockerContainerState {
|
||||
id: string;
|
||||
name: string;
|
||||
running: boolean;
|
||||
port: number;
|
||||
}
|
||||
|
||||
const containers = new Map<string, MockDockerContainerState>();
|
||||
const handles = new Map<
|
||||
string,
|
||||
{
|
||||
inspect: ReturnType<typeof vi.fn>;
|
||||
start: ReturnType<typeof vi.fn>;
|
||||
stop: ReturnType<typeof vi.fn>;
|
||||
}
|
||||
>();
|
||||
|
||||
const ensureHandle = (id: string) => {
|
||||
const existing = handles.get(id);
|
||||
if (existing) {
|
||||
return existing;
|
||||
}
|
||||
|
||||
const handle = {
|
||||
inspect: vi.fn(async () => {
|
||||
const container = containers.get(id);
|
||||
if (!container) {
|
||||
throw { statusCode: 404 };
|
||||
}
|
||||
|
||||
return {
|
||||
Id: container.id,
|
||||
State: {
|
||||
Running: container.running,
|
||||
},
|
||||
NetworkSettings: {
|
||||
Ports: {
|
||||
"18789/tcp": [{ HostPort: String(container.port) }],
|
||||
},
|
||||
},
|
||||
};
|
||||
}),
|
||||
start: vi.fn(async () => {
|
||||
const container = containers.get(id);
|
||||
if (!container) {
|
||||
throw { statusCode: 404 };
|
||||
}
|
||||
container.running = true;
|
||||
}),
|
||||
stop: vi.fn(async () => {
|
||||
const container = containers.get(id);
|
||||
if (!container) {
|
||||
throw { statusCode: 404 };
|
||||
}
|
||||
container.running = false;
|
||||
}),
|
||||
};
|
||||
|
||||
handles.set(id, handle);
|
||||
return handle;
|
||||
};
|
||||
|
||||
const listContainers = vi.fn(
|
||||
async (options?: { all?: boolean; filters?: { name?: string[] } }) => {
|
||||
const nameFilter = options?.filters?.name?.[0];
|
||||
return [...containers.values()]
|
||||
.filter((container) => (nameFilter ? container.name.includes(nameFilter) : true))
|
||||
.map((container) => ({
|
||||
Id: container.id,
|
||||
Names: [`/${container.name}`],
|
||||
}));
|
||||
}
|
||||
);
|
||||
|
||||
const getContainer = vi.fn((id: string) => ensureHandle(id));
|
||||
|
||||
const createContainer = vi.fn(
|
||||
async (options: {
|
||||
name?: string;
|
||||
HostConfig?: { PortBindings?: Record<string, Array<{ HostPort?: string }>> };
|
||||
}) => {
|
||||
const id = `ctr-${containers.size + 1}`;
|
||||
const name = options.name ?? id;
|
||||
const hostPort = options.HostConfig?.PortBindings?.["18789/tcp"]?.[0]?.HostPort;
|
||||
const port = hostPort ? Number.parseInt(hostPort, 10) : 0;
|
||||
|
||||
containers.set(id, {
|
||||
id,
|
||||
name,
|
||||
running: false,
|
||||
port,
|
||||
});
|
||||
|
||||
return ensureHandle(id);
|
||||
}
|
||||
);
|
||||
|
||||
const dockerInstance = {
|
||||
listContainers,
|
||||
getContainer,
|
||||
createContainer,
|
||||
};
|
||||
|
||||
const constructorSpy = vi.fn();
|
||||
class DockerConstructorMock {
|
||||
constructor(options?: unknown) {
|
||||
constructorSpy(options);
|
||||
return dockerInstance;
|
||||
}
|
||||
}
|
||||
|
||||
const registerContainer = (container: MockDockerContainerState) => {
|
||||
containers.set(container.id, { ...container });
|
||||
ensureHandle(container.id);
|
||||
};
|
||||
|
||||
const reset = () => {
|
||||
containers.clear();
|
||||
handles.clear();
|
||||
constructorSpy.mockClear();
|
||||
listContainers.mockClear();
|
||||
getContainer.mockClear();
|
||||
createContainer.mockClear();
|
||||
};
|
||||
|
||||
return {
|
||||
DockerConstructorMock,
|
||||
constructorSpy,
|
||||
createContainer,
|
||||
handles,
|
||||
registerContainer,
|
||||
reset,
|
||||
};
|
||||
});
|
||||
|
||||
vi.mock("dockerode", () => ({
|
||||
default: dockerMock.DockerConstructorMock,
|
||||
}));
|
||||
|
||||
import { ContainerLifecycleService } from "./container-lifecycle.service";
|
||||
|
||||
function createConfigMock(values: Record<string, string> = {}) {
|
||||
return {
|
||||
get: vi.fn((key: string) => values[key]),
|
||||
};
|
||||
}
|
||||
|
||||
function createCryptoMock() {
|
||||
return {
|
||||
generateToken: vi.fn(() => "generated-token"),
|
||||
encrypt: vi.fn((value: string) => `enc:${value}`),
|
||||
decrypt: vi.fn((value: string) => value.replace(/^enc:/, "")),
|
||||
isEncrypted: vi.fn((value: string) => value.startsWith("enc:")),
|
||||
};
|
||||
}
|
||||
|
||||
function projectRecord(
|
||||
record: MockUserContainerRecord,
|
||||
select?: Record<string, boolean>
|
||||
): Partial<MockUserContainerRecord> {
|
||||
if (!select) {
|
||||
return { ...record };
|
||||
}
|
||||
|
||||
const projection: Partial<MockUserContainerRecord> = {};
|
||||
for (const [field, enabled] of Object.entries(select)) {
|
||||
if (enabled) {
|
||||
const key = field as keyof MockUserContainerRecord;
|
||||
projection[key] = record[key];
|
||||
}
|
||||
}
|
||||
|
||||
return projection;
|
||||
}
|
||||
|
||||
function createPrismaMock(initialRecords: MockUserContainerRecord[] = []) {
|
||||
const records = new Map<string, MockUserContainerRecord>();
|
||||
for (const record of initialRecords) {
|
||||
records.set(record.userId, { ...record });
|
||||
}
|
||||
|
||||
const userContainer = {
|
||||
findUnique: vi.fn(
|
||||
async (args: {
|
||||
where: { userId?: string; id?: string };
|
||||
select?: Record<string, boolean>;
|
||||
}) => {
|
||||
let record: MockUserContainerRecord | undefined;
|
||||
if (args.where.userId) {
|
||||
record = records.get(args.where.userId);
|
||||
} else if (args.where.id) {
|
||||
record = [...records.values()].find((entry) => entry.id === args.where.id);
|
||||
}
|
||||
|
||||
if (!record) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return projectRecord(record, args.select);
|
||||
}
|
||||
),
|
||||
create: vi.fn(
|
||||
async (args: {
|
||||
data: Partial<MockUserContainerRecord> & {
|
||||
userId: string;
|
||||
containerName: string;
|
||||
gatewayToken: string;
|
||||
};
|
||||
}) => {
|
||||
const now = new Date();
|
||||
const next: MockUserContainerRecord = {
|
||||
id: args.data.id ?? `uc-${records.size + 1}`,
|
||||
userId: args.data.userId,
|
||||
containerId: args.data.containerId ?? null,
|
||||
containerName: args.data.containerName,
|
||||
gatewayPort: args.data.gatewayPort ?? null,
|
||||
gatewayToken: args.data.gatewayToken,
|
||||
status: args.data.status ?? "stopped",
|
||||
lastActiveAt: args.data.lastActiveAt ?? null,
|
||||
idleTimeoutMin: args.data.idleTimeoutMin ?? 30,
|
||||
config: args.data.config ?? {},
|
||||
createdAt: now,
|
||||
updatedAt: now,
|
||||
};
|
||||
|
||||
records.set(next.userId, next);
|
||||
return { ...next };
|
||||
}
|
||||
),
|
||||
update: vi.fn(
|
||||
async (args: { where: { userId: string }; data: Partial<MockUserContainerRecord> }) => {
|
||||
const record = records.get(args.where.userId);
|
||||
if (!record) {
|
||||
throw new Error(`Record ${args.where.userId} not found`);
|
||||
}
|
||||
|
||||
const updated: MockUserContainerRecord = {
|
||||
...record,
|
||||
...args.data,
|
||||
updatedAt: new Date(),
|
||||
};
|
||||
records.set(updated.userId, updated);
|
||||
return { ...updated };
|
||||
}
|
||||
),
|
||||
updateMany: vi.fn(
|
||||
async (args: { where: { userId: string }; data: Partial<MockUserContainerRecord> }) => {
|
||||
const record = records.get(args.where.userId);
|
||||
if (!record) {
|
||||
return { count: 0 };
|
||||
}
|
||||
|
||||
const updated: MockUserContainerRecord = {
|
||||
...record,
|
||||
...args.data,
|
||||
updatedAt: new Date(),
|
||||
};
|
||||
records.set(updated.userId, updated);
|
||||
return { count: 1 };
|
||||
}
|
||||
),
|
||||
findMany: vi.fn(
|
||||
async (args?: {
|
||||
where?: {
|
||||
status?: string;
|
||||
lastActiveAt?: { not: null };
|
||||
gatewayPort?: { not: null };
|
||||
};
|
||||
select?: Record<string, boolean>;
|
||||
}) => {
|
||||
let rows = [...records.values()];
|
||||
|
||||
if (args?.where?.status) {
|
||||
rows = rows.filter((record) => record.status === args.where?.status);
|
||||
}
|
||||
|
||||
if (args?.where?.lastActiveAt?.not === null) {
|
||||
rows = rows.filter((record) => record.lastActiveAt !== null);
|
||||
}
|
||||
|
||||
if (args?.where?.gatewayPort?.not === null) {
|
||||
rows = rows.filter((record) => record.gatewayPort !== null);
|
||||
}
|
||||
|
||||
return rows.map((record) => projectRecord(record, args?.select));
|
||||
}
|
||||
),
|
||||
};
|
||||
|
||||
return {
|
||||
prisma: {
|
||||
userContainer,
|
||||
},
|
||||
records,
|
||||
};
|
||||
}
|
||||
|
||||
function createRecord(overrides: Partial<MockUserContainerRecord>): MockUserContainerRecord {
|
||||
const now = new Date();
|
||||
return {
|
||||
id: overrides.id ?? "uc-default",
|
||||
userId: overrides.userId ?? "user-default",
|
||||
containerId: overrides.containerId ?? null,
|
||||
containerName: overrides.containerName ?? "mosaic-user-user-default",
|
||||
gatewayPort: overrides.gatewayPort ?? null,
|
||||
gatewayToken: overrides.gatewayToken ?? "enc:token-default",
|
||||
status: overrides.status ?? "stopped",
|
||||
lastActiveAt: overrides.lastActiveAt ?? null,
|
||||
idleTimeoutMin: overrides.idleTimeoutMin ?? 30,
|
||||
config: overrides.config ?? {},
|
||||
createdAt: overrides.createdAt ?? now,
|
||||
updatedAt: overrides.updatedAt ?? now,
|
||||
};
|
||||
}
|
||||
|
||||
describe("ContainerLifecycleService", () => {
|
||||
beforeEach(() => {
|
||||
dockerMock.reset();
|
||||
});
|
||||
|
||||
it("ensureRunning creates container when none exists", async () => {
|
||||
const { prisma, records } = createPrismaMock();
|
||||
const crypto = createCryptoMock();
|
||||
const config = createConfigMock();
|
||||
const service = new ContainerLifecycleService(
|
||||
prisma as unknown as PrismaService,
|
||||
crypto as unknown as CryptoService,
|
||||
config as unknown as ConfigService
|
||||
);
|
||||
|
||||
const result = await service.ensureRunning("user-1");
|
||||
|
||||
expect(result).toEqual({
|
||||
url: "http://mosaic-user-user-1:19000",
|
||||
token: "generated-token",
|
||||
});
|
||||
|
||||
const updatedRecord = records.get("user-1");
|
||||
expect(updatedRecord?.status).toBe("running");
|
||||
expect(updatedRecord?.containerId).toBe("ctr-1");
|
||||
expect(updatedRecord?.gatewayPort).toBe(19000);
|
||||
expect(updatedRecord?.gatewayToken).toBe("enc:generated-token");
|
||||
|
||||
expect(dockerMock.createContainer).toHaveBeenCalledTimes(1);
|
||||
const [createCall] = dockerMock.createContainer.mock.calls[0] as [
|
||||
{
|
||||
name: string;
|
||||
Image: string;
|
||||
Env: string[];
|
||||
HostConfig: { Binds: string[]; NetworkMode: string };
|
||||
},
|
||||
];
|
||||
expect(createCall.name).toBe("mosaic-user-user-1");
|
||||
expect(createCall.Image).toBe("alpine/openclaw:latest");
|
||||
expect(createCall.HostConfig.Binds).toEqual(["mosaic-user-user-1-state:/home/node/.openclaw"]);
|
||||
expect(createCall.HostConfig.NetworkMode).toBe("mosaic-internal");
|
||||
expect(createCall.Env).toContain("AGENT_TOKEN=generated-token");
|
||||
});
|
||||
|
||||
it("ensureRunning starts existing stopped container", async () => {
|
||||
const { prisma, records } = createPrismaMock([
|
||||
createRecord({
|
||||
id: "uc-1",
|
||||
userId: "user-2",
|
||||
containerId: "ctr-stopped",
|
||||
containerName: "mosaic-user-user-2",
|
||||
gatewayToken: "enc:existing-token",
|
||||
status: "stopped",
|
||||
}),
|
||||
]);
|
||||
const crypto = createCryptoMock();
|
||||
const config = createConfigMock();
|
||||
const service = new ContainerLifecycleService(
|
||||
prisma as unknown as PrismaService,
|
||||
crypto as unknown as CryptoService,
|
||||
config as unknown as ConfigService
|
||||
);
|
||||
|
||||
dockerMock.registerContainer({
|
||||
id: "ctr-stopped",
|
||||
name: "mosaic-user-user-2",
|
||||
running: false,
|
||||
port: 19042,
|
||||
});
|
||||
|
||||
const result = await service.ensureRunning("user-2");
|
||||
|
||||
expect(result).toEqual({
|
||||
url: "http://mosaic-user-user-2:19042",
|
||||
token: "existing-token",
|
||||
});
|
||||
|
||||
const handle = dockerMock.handles.get("ctr-stopped");
|
||||
expect(handle?.start).toHaveBeenCalledTimes(1);
|
||||
expect(records.get("user-2")?.status).toBe("running");
|
||||
expect(records.get("user-2")?.gatewayPort).toBe(19042);
|
||||
});
|
||||
|
||||
it("ensureRunning returns existing running container", async () => {
|
||||
const { prisma } = createPrismaMock([
|
||||
createRecord({
|
||||
id: "uc-2",
|
||||
userId: "user-3",
|
||||
containerId: "ctr-running",
|
||||
containerName: "mosaic-user-user-3",
|
||||
gatewayPort: 19043,
|
||||
gatewayToken: "enc:running-token",
|
||||
status: "running",
|
||||
}),
|
||||
]);
|
||||
const crypto = createCryptoMock();
|
||||
const config = createConfigMock();
|
||||
const service = new ContainerLifecycleService(
|
||||
prisma as unknown as PrismaService,
|
||||
crypto as unknown as CryptoService,
|
||||
config as unknown as ConfigService
|
||||
);
|
||||
|
||||
dockerMock.registerContainer({
|
||||
id: "ctr-running",
|
||||
name: "mosaic-user-user-3",
|
||||
running: true,
|
||||
port: 19043,
|
||||
});
|
||||
|
||||
const result = await service.ensureRunning("user-3");
|
||||
|
||||
expect(result).toEqual({
|
||||
url: "http://mosaic-user-user-3:19043",
|
||||
token: "running-token",
|
||||
});
|
||||
|
||||
expect(dockerMock.createContainer).not.toHaveBeenCalled();
|
||||
const handle = dockerMock.handles.get("ctr-running");
|
||||
expect(handle?.start).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("stop gracefully stops container and updates DB", async () => {
|
||||
const { prisma, records } = createPrismaMock([
|
||||
createRecord({
|
||||
id: "uc-stop",
|
||||
userId: "user-stop",
|
||||
containerId: "ctr-stop",
|
||||
containerName: "mosaic-user-user-stop",
|
||||
gatewayPort: 19044,
|
||||
status: "running",
|
||||
}),
|
||||
]);
|
||||
const crypto = createCryptoMock();
|
||||
const config = createConfigMock();
|
||||
const service = new ContainerLifecycleService(
|
||||
prisma as unknown as PrismaService,
|
||||
crypto as unknown as CryptoService,
|
||||
config as unknown as ConfigService
|
||||
);
|
||||
|
||||
dockerMock.registerContainer({
|
||||
id: "ctr-stop",
|
||||
name: "mosaic-user-user-stop",
|
||||
running: true,
|
||||
port: 19044,
|
||||
});
|
||||
|
||||
await service.stop("user-stop");
|
||||
|
||||
const handle = dockerMock.handles.get("ctr-stop");
|
||||
expect(handle?.stop).toHaveBeenCalledWith({ t: 10 });
|
||||
|
||||
const updatedRecord = records.get("user-stop");
|
||||
expect(updatedRecord?.status).toBe("stopped");
|
||||
expect(updatedRecord?.containerId).toBeNull();
|
||||
expect(updatedRecord?.gatewayPort).toBeNull();
|
||||
});
|
||||
|
||||
it("reapIdle stops only containers past their idle timeout", async () => {
|
||||
const now = Date.now();
|
||||
const { prisma, records } = createPrismaMock([
|
||||
createRecord({
|
||||
id: "uc-old",
|
||||
userId: "user-old",
|
||||
containerId: "ctr-old",
|
||||
containerName: "mosaic-user-user-old",
|
||||
gatewayPort: 19045,
|
||||
status: "running",
|
||||
lastActiveAt: new Date(now - 60 * 60 * 1000),
|
||||
idleTimeoutMin: 30,
|
||||
}),
|
||||
createRecord({
|
||||
id: "uc-fresh",
|
||||
userId: "user-fresh",
|
||||
containerId: "ctr-fresh",
|
||||
containerName: "mosaic-user-user-fresh",
|
||||
gatewayPort: 19046,
|
||||
status: "running",
|
||||
lastActiveAt: new Date(now - 5 * 60 * 1000),
|
||||
idleTimeoutMin: 30,
|
||||
}),
|
||||
]);
|
||||
const crypto = createCryptoMock();
|
||||
const config = createConfigMock();
|
||||
const service = new ContainerLifecycleService(
|
||||
prisma as unknown as PrismaService,
|
||||
crypto as unknown as CryptoService,
|
||||
config as unknown as ConfigService
|
||||
);
|
||||
|
||||
dockerMock.registerContainer({
|
||||
id: "ctr-old",
|
||||
name: "mosaic-user-user-old",
|
||||
running: true,
|
||||
port: 19045,
|
||||
});
|
||||
dockerMock.registerContainer({
|
||||
id: "ctr-fresh",
|
||||
name: "mosaic-user-user-fresh",
|
||||
running: true,
|
||||
port: 19046,
|
||||
});
|
||||
|
||||
const result = await service.reapIdle();
|
||||
|
||||
expect(result).toEqual({
|
||||
stopped: ["user-old"],
|
||||
});
|
||||
|
||||
expect(records.get("user-old")?.status).toBe("stopped");
|
||||
expect(records.get("user-fresh")?.status).toBe("running");
|
||||
|
||||
const oldHandle = dockerMock.handles.get("ctr-old");
|
||||
const freshHandle = dockerMock.handles.get("ctr-fresh");
|
||||
expect(oldHandle?.stop).toHaveBeenCalledTimes(1);
|
||||
expect(freshHandle?.stop).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("touch updates lastActiveAt", async () => {
|
||||
const { prisma, records } = createPrismaMock([
|
||||
createRecord({
|
||||
id: "uc-touch",
|
||||
userId: "user-touch",
|
||||
containerName: "mosaic-user-user-touch",
|
||||
lastActiveAt: null,
|
||||
}),
|
||||
]);
|
||||
const crypto = createCryptoMock();
|
||||
const config = createConfigMock();
|
||||
const service = new ContainerLifecycleService(
|
||||
prisma as unknown as PrismaService,
|
||||
crypto as unknown as CryptoService,
|
||||
config as unknown as ConfigService
|
||||
);
|
||||
|
||||
await service.touch("user-touch");
|
||||
|
||||
const updatedRecord = records.get("user-touch");
|
||||
expect(updatedRecord?.lastActiveAt).toBeInstanceOf(Date);
|
||||
});
|
||||
|
||||
it("getStatus returns null for unknown user", async () => {
|
||||
const { prisma } = createPrismaMock();
|
||||
const crypto = createCryptoMock();
|
||||
const config = createConfigMock();
|
||||
const service = new ContainerLifecycleService(
|
||||
prisma as unknown as PrismaService,
|
||||
crypto as unknown as CryptoService,
|
||||
config as unknown as ConfigService
|
||||
);
|
||||
|
||||
const status = await service.getStatus("missing-user");
|
||||
|
||||
expect(status).toBeNull();
|
||||
});
|
||||
});
|
||||
532
apps/api/src/container-lifecycle/container-lifecycle.service.ts
Normal file
532
apps/api/src/container-lifecycle/container-lifecycle.service.ts
Normal file
@@ -0,0 +1,532 @@
|
||||
import { Injectable, Logger } from "@nestjs/common";
|
||||
import { ConfigService } from "@nestjs/config";
|
||||
import Docker from "dockerode";
|
||||
import { PrismaService } from "../prisma/prisma.service";
|
||||
import { CryptoService } from "../crypto/crypto.service";
|
||||
|
||||
const DEFAULT_DOCKER_SOCKET_PATH = "/var/run/docker.sock";
|
||||
const DEFAULT_DOCKER_TCP_PORT = 2375;
|
||||
const DEFAULT_OPENCLAW_IMAGE = "alpine/openclaw:latest";
|
||||
const DEFAULT_OPENCLAW_NETWORK = "mosaic-internal";
|
||||
const DEFAULT_OPENCLAW_PORT_RANGE_START = 19000;
|
||||
const DEFAULT_MOSAIC_API_URL = "http://mosaic-api:3000/api";
|
||||
const OPENCLAW_GATEWAY_PORT_KEY = "18789/tcp";
|
||||
const OPENCLAW_STATE_PATH = "/home/node/.openclaw";
|
||||
const CONTAINER_STOP_TIMEOUT_SECONDS = 10;
|
||||
|
||||
interface ContainerHandle {
|
||||
inspect(): Promise<DockerInspect>;
|
||||
start(): Promise<void>;
|
||||
stop(options?: { t?: number }): Promise<void>;
|
||||
}
|
||||
|
||||
interface DockerInspect {
|
||||
Id?: string;
|
||||
State?: {
|
||||
Running?: boolean;
|
||||
Health?: {
|
||||
Status?: string;
|
||||
};
|
||||
};
|
||||
NetworkSettings?: {
|
||||
Ports?: Record<string, { HostPort?: string }[] | null>;
|
||||
};
|
||||
HostConfig?: {
|
||||
PortBindings?: Record<string, { HostPort?: string }[] | null>;
|
||||
};
|
||||
}
|
||||
|
||||
interface UserContainerRecord {
|
||||
id: string;
|
||||
userId: string;
|
||||
containerId: string | null;
|
||||
containerName: string;
|
||||
gatewayPort: number | null;
|
||||
gatewayToken: string;
|
||||
status: string;
|
||||
lastActiveAt: Date | null;
|
||||
idleTimeoutMin: number;
|
||||
}
|
||||
|
||||
interface ContainerLookup {
|
||||
containerId: string | null;
|
||||
containerName: string;
|
||||
}
|
||||
|
||||
@Injectable()
|
||||
export class ContainerLifecycleService {
|
||||
private readonly logger = new Logger(ContainerLifecycleService.name);
|
||||
private readonly docker: Docker;
|
||||
|
||||
constructor(
|
||||
private readonly prisma: PrismaService,
|
||||
private readonly crypto: CryptoService,
|
||||
private readonly config: ConfigService
|
||||
) {
|
||||
const dockerHost = this.config.get<string>("DOCKER_HOST");
|
||||
this.docker = this.createDockerClient(dockerHost);
|
||||
}
|
||||
|
||||
// Ensure a user's container is running. Creates if needed, starts if stopped.
|
||||
// Returns the container's internal URL and gateway token.
|
||||
async ensureRunning(userId: string): Promise<{ url: string; token: string }> {
|
||||
const containerRecord = await this.getOrCreateContainerRecord(userId);
|
||||
const token = this.getGatewayToken(containerRecord.gatewayToken);
|
||||
const existingContainer = await this.resolveContainer(containerRecord);
|
||||
|
||||
let container: ContainerHandle;
|
||||
if (existingContainer) {
|
||||
container = existingContainer;
|
||||
const inspect = await container.inspect();
|
||||
if (!inspect.State?.Running) {
|
||||
await container.start();
|
||||
}
|
||||
} else {
|
||||
const port = await this.findAvailableGatewayPort();
|
||||
container = await this.createContainer(containerRecord, token, port);
|
||||
await container.start();
|
||||
}
|
||||
|
||||
const inspect = await container.inspect();
|
||||
const containerId = inspect.Id;
|
||||
if (!containerId) {
|
||||
throw new Error(
|
||||
`Docker inspect did not return container ID for ${containerRecord.containerName}`
|
||||
);
|
||||
}
|
||||
|
||||
const gatewayPort = this.extractGatewayPort(inspect);
|
||||
if (!gatewayPort) {
|
||||
throw new Error(`Could not determine gateway port for ${containerRecord.containerName}`);
|
||||
}
|
||||
|
||||
const now = new Date();
|
||||
await this.prisma.userContainer.update({
|
||||
where: { userId },
|
||||
data: {
|
||||
containerId,
|
||||
gatewayPort,
|
||||
status: "running",
|
||||
lastActiveAt: now,
|
||||
},
|
||||
});
|
||||
|
||||
return {
|
||||
url: `http://${containerRecord.containerName}:${String(gatewayPort)}`,
|
||||
token,
|
||||
};
|
||||
}
|
||||
|
||||
// Stop a user's container
|
||||
async stop(userId: string): Promise<void> {
|
||||
const containerRecord = await this.prisma.userContainer.findUnique({
|
||||
where: { userId },
|
||||
});
|
||||
|
||||
if (!containerRecord) {
|
||||
return;
|
||||
}
|
||||
|
||||
const container = await this.resolveContainer(containerRecord);
|
||||
if (container) {
|
||||
try {
|
||||
await container.stop({ t: CONTAINER_STOP_TIMEOUT_SECONDS });
|
||||
} catch (error) {
|
||||
if (!this.isDockerNotFound(error) && !this.isAlreadyStopped(error)) {
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
await this.prisma.userContainer.update({
|
||||
where: { userId },
|
||||
data: {
|
||||
status: "stopped",
|
||||
containerId: null,
|
||||
gatewayPort: null,
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
// Stop idle containers (called by cron/scheduler)
|
||||
async reapIdle(): Promise<{ stopped: string[] }> {
|
||||
const now = Date.now();
|
||||
const runningContainers = await this.prisma.userContainer.findMany({
|
||||
where: {
|
||||
status: "running",
|
||||
lastActiveAt: { not: null },
|
||||
},
|
||||
select: {
|
||||
userId: true,
|
||||
lastActiveAt: true,
|
||||
idleTimeoutMin: true,
|
||||
},
|
||||
});
|
||||
|
||||
const stopped: string[] = [];
|
||||
for (const container of runningContainers) {
|
||||
const lastActiveAt = container.lastActiveAt;
|
||||
if (!lastActiveAt) {
|
||||
continue;
|
||||
}
|
||||
|
||||
const idleLimitMs = container.idleTimeoutMin * 60 * 1000;
|
||||
if (now - lastActiveAt.getTime() < idleLimitMs) {
|
||||
continue;
|
||||
}
|
||||
|
||||
try {
|
||||
await this.stop(container.userId);
|
||||
stopped.push(container.userId);
|
||||
} catch (error) {
|
||||
this.logger.warn(
|
||||
`Failed to stop idle container for user ${container.userId}: ${this.getErrorMessage(error)}`
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
return { stopped };
|
||||
}
|
||||
|
||||
// Health check all running containers
|
||||
async healthCheckAll(): Promise<{ userId: string; healthy: boolean; error?: string }[]> {
|
||||
const runningContainers = await this.prisma.userContainer.findMany({
|
||||
where: {
|
||||
status: "running",
|
||||
},
|
||||
select: {
|
||||
userId: true,
|
||||
containerId: true,
|
||||
containerName: true,
|
||||
},
|
||||
});
|
||||
|
||||
const results: { userId: string; healthy: boolean; error?: string }[] = [];
|
||||
for (const containerRecord of runningContainers) {
|
||||
const container = await this.resolveContainer(containerRecord);
|
||||
if (!container) {
|
||||
results.push({
|
||||
userId: containerRecord.userId,
|
||||
healthy: false,
|
||||
error: "Container not found",
|
||||
});
|
||||
continue;
|
||||
}
|
||||
|
||||
try {
|
||||
const inspect = await container.inspect();
|
||||
const isRunning = inspect.State?.Running === true;
|
||||
const healthState = inspect.State?.Health?.Status;
|
||||
const healthy = isRunning && healthState !== "unhealthy";
|
||||
|
||||
if (healthy) {
|
||||
results.push({
|
||||
userId: containerRecord.userId,
|
||||
healthy: true,
|
||||
});
|
||||
continue;
|
||||
}
|
||||
|
||||
results.push({
|
||||
userId: containerRecord.userId,
|
||||
healthy: false,
|
||||
error:
|
||||
healthState === "unhealthy" ? "Container healthcheck failed" : "Container not running",
|
||||
});
|
||||
} catch (error) {
|
||||
results.push({
|
||||
userId: containerRecord.userId,
|
||||
healthy: false,
|
||||
error: this.getErrorMessage(error),
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
return results;
|
||||
}
|
||||
|
||||
// Restart a container with fresh config (for config updates)
|
||||
async restart(userId: string): Promise<void> {
|
||||
await this.stop(userId);
|
||||
await this.ensureRunning(userId);
|
||||
}
|
||||
|
||||
// Update lastActiveAt timestamp (called on each chat request)
|
||||
async touch(userId: string): Promise<void> {
|
||||
await this.prisma.userContainer.updateMany({
|
||||
where: { userId },
|
||||
data: {
|
||||
lastActiveAt: new Date(),
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
// Get container status for a user
|
||||
async getStatus(
|
||||
userId: string
|
||||
): Promise<{ status: string; port?: number; lastActive?: Date } | null> {
|
||||
const container = await this.prisma.userContainer.findUnique({
|
||||
where: { userId },
|
||||
select: {
|
||||
status: true,
|
||||
gatewayPort: true,
|
||||
lastActiveAt: true,
|
||||
},
|
||||
});
|
||||
|
||||
if (!container) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const status: { status: string; port?: number; lastActive?: Date } = {
|
||||
status: container.status,
|
||||
};
|
||||
|
||||
if (container.gatewayPort !== null) {
|
||||
status.port = container.gatewayPort;
|
||||
}
|
||||
|
||||
if (container.lastActiveAt !== null) {
|
||||
status.lastActive = container.lastActiveAt;
|
||||
}
|
||||
|
||||
return status;
|
||||
}
|
||||
|
||||
private createDockerClient(dockerHost?: string): Docker {
|
||||
if (!dockerHost || dockerHost.trim().length === 0) {
|
||||
return new Docker({ socketPath: DEFAULT_DOCKER_SOCKET_PATH });
|
||||
}
|
||||
|
||||
if (dockerHost.startsWith("unix://")) {
|
||||
return new Docker({ socketPath: dockerHost.slice("unix://".length) });
|
||||
}
|
||||
|
||||
if (dockerHost.startsWith("tcp://")) {
|
||||
const parsed = new URL(dockerHost.replace("tcp://", "http://"));
|
||||
return new Docker({
|
||||
host: parsed.hostname,
|
||||
port: this.parseInteger(parsed.port, DEFAULT_DOCKER_TCP_PORT),
|
||||
protocol: "http",
|
||||
});
|
||||
}
|
||||
|
||||
if (dockerHost.startsWith("http://") || dockerHost.startsWith("https://")) {
|
||||
const parsed = new URL(dockerHost);
|
||||
const protocol = parsed.protocol.replace(":", "");
|
||||
return new Docker({
|
||||
host: parsed.hostname,
|
||||
port: this.parseInteger(parsed.port, DEFAULT_DOCKER_TCP_PORT),
|
||||
protocol: protocol === "https" ? "https" : "http",
|
||||
});
|
||||
}
|
||||
|
||||
return new Docker({ socketPath: dockerHost });
|
||||
}
|
||||
|
||||
private async getOrCreateContainerRecord(userId: string): Promise<UserContainerRecord> {
|
||||
const existingContainer = await this.prisma.userContainer.findUnique({
|
||||
where: { userId },
|
||||
});
|
||||
|
||||
if (existingContainer) {
|
||||
return existingContainer;
|
||||
}
|
||||
|
||||
const token = this.crypto.generateToken();
|
||||
const containerName = this.getContainerName(userId);
|
||||
return this.prisma.userContainer.create({
|
||||
data: {
|
||||
userId,
|
||||
containerName,
|
||||
gatewayToken: this.crypto.encrypt(token),
|
||||
status: "stopped",
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
private getContainerName(userId: string): string {
|
||||
return `mosaic-user-${userId}`;
|
||||
}
|
||||
|
||||
private getVolumeName(userId: string): string {
|
||||
return `mosaic-user-${userId}-state`;
|
||||
}
|
||||
|
||||
private getOpenClawImage(): string {
|
||||
return this.config.get<string>("OPENCLAW_IMAGE") ?? DEFAULT_OPENCLAW_IMAGE;
|
||||
}
|
||||
|
||||
private getOpenClawNetwork(): string {
|
||||
return this.config.get<string>("OPENCLAW_NETWORK") ?? DEFAULT_OPENCLAW_NETWORK;
|
||||
}
|
||||
|
||||
private getMosaicApiUrl(): string {
|
||||
return this.config.get<string>("MOSAIC_API_URL") ?? DEFAULT_MOSAIC_API_URL;
|
||||
}
|
||||
|
||||
private getPortRangeStart(): number {
|
||||
return this.parseInteger(
|
||||
this.config.get<string>("OPENCLAW_PORT_RANGE_START"),
|
||||
DEFAULT_OPENCLAW_PORT_RANGE_START
|
||||
);
|
||||
}
|
||||
|
||||
private async resolveContainer(record: ContainerLookup): Promise<ContainerHandle | null> {
|
||||
if (record.containerId) {
|
||||
const byId = this.docker.getContainer(record.containerId) as unknown as ContainerHandle;
|
||||
if (await this.containerExists(byId)) {
|
||||
return byId;
|
||||
}
|
||||
}
|
||||
|
||||
const byName = await this.findContainerByName(record.containerName);
|
||||
if (byName) {
|
||||
return byName;
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
private async findContainerByName(containerName: string): Promise<ContainerHandle | null> {
|
||||
const containers = await this.docker.listContainers({
|
||||
all: true,
|
||||
filters: {
|
||||
name: [containerName],
|
||||
},
|
||||
});
|
||||
|
||||
const match = containers.find((container) => {
|
||||
const names = container.Names;
|
||||
return names.some((name) => name === `/${containerName}` || name.includes(containerName));
|
||||
});
|
||||
|
||||
if (!match?.Id) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return this.docker.getContainer(match.Id) as unknown as ContainerHandle;
|
||||
}
|
||||
|
||||
private async containerExists(container: ContainerHandle): Promise<boolean> {
|
||||
try {
|
||||
await container.inspect();
|
||||
return true;
|
||||
} catch (error) {
|
||||
if (this.isDockerNotFound(error)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
private async createContainer(
|
||||
containerRecord: UserContainerRecord,
|
||||
token: string,
|
||||
gatewayPort: number
|
||||
): Promise<ContainerHandle> {
|
||||
const container = await this.docker.createContainer({
|
||||
name: containerRecord.containerName,
|
||||
Image: this.getOpenClawImage(),
|
||||
Env: [
|
||||
`MOSAIC_API_URL=${this.getMosaicApiUrl()}`,
|
||||
`AGENT_TOKEN=${token}`,
|
||||
`AGENT_ID=${containerRecord.id}`,
|
||||
],
|
||||
ExposedPorts: {
|
||||
[OPENCLAW_GATEWAY_PORT_KEY]: {},
|
||||
},
|
||||
HostConfig: {
|
||||
Binds: [`${this.getVolumeName(containerRecord.userId)}:${OPENCLAW_STATE_PATH}`],
|
||||
PortBindings: {
|
||||
[OPENCLAW_GATEWAY_PORT_KEY]: [{ HostPort: String(gatewayPort) }],
|
||||
},
|
||||
NetworkMode: this.getOpenClawNetwork(),
|
||||
},
|
||||
});
|
||||
|
||||
return container as unknown as ContainerHandle;
|
||||
}
|
||||
|
||||
private extractGatewayPort(inspect: DockerInspect): number | null {
|
||||
const networkPort = inspect.NetworkSettings?.Ports?.[OPENCLAW_GATEWAY_PORT_KEY]?.[0]?.HostPort;
|
||||
if (networkPort) {
|
||||
return this.parseInteger(networkPort, 0) || null;
|
||||
}
|
||||
|
||||
const hostPort = inspect.HostConfig?.PortBindings?.[OPENCLAW_GATEWAY_PORT_KEY]?.[0]?.HostPort;
|
||||
if (hostPort) {
|
||||
return this.parseInteger(hostPort, 0) || null;
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
private async findAvailableGatewayPort(): Promise<number> {
|
||||
const usedPorts = await this.prisma.userContainer.findMany({
|
||||
where: {
|
||||
gatewayPort: { not: null },
|
||||
},
|
||||
select: {
|
||||
gatewayPort: true,
|
||||
},
|
||||
});
|
||||
|
||||
const takenPorts = new Set<number>();
|
||||
for (const entry of usedPorts) {
|
||||
if (entry.gatewayPort !== null) {
|
||||
takenPorts.add(entry.gatewayPort);
|
||||
}
|
||||
}
|
||||
|
||||
let candidate = this.getPortRangeStart();
|
||||
while (takenPorts.has(candidate)) {
|
||||
candidate += 1;
|
||||
}
|
||||
|
||||
return candidate;
|
||||
}
|
||||
|
||||
private getGatewayToken(storedToken: string): string {
|
||||
if (this.crypto.isEncrypted(storedToken)) {
|
||||
return this.crypto.decrypt(storedToken);
|
||||
}
|
||||
|
||||
return storedToken;
|
||||
}
|
||||
|
||||
private parseInteger(value: string | undefined, fallback: number): number {
|
||||
if (!value) {
|
||||
return fallback;
|
||||
}
|
||||
|
||||
const parsed = Number.parseInt(value, 10);
|
||||
return Number.isFinite(parsed) ? parsed : fallback;
|
||||
}
|
||||
|
||||
private isDockerNotFound(error: unknown): boolean {
|
||||
return this.getDockerStatusCode(error) === 404;
|
||||
}
|
||||
|
||||
private isAlreadyStopped(error: unknown): boolean {
|
||||
return this.getDockerStatusCode(error) === 304;
|
||||
}
|
||||
|
||||
private getDockerStatusCode(error: unknown): number | null {
|
||||
if (typeof error !== "object" || error === null || !("statusCode" in error)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const statusCode = error.statusCode;
|
||||
return typeof statusCode === "number" ? statusCode : null;
|
||||
}
|
||||
|
||||
private getErrorMessage(error: unknown): string {
|
||||
if (error instanceof Error) {
|
||||
return error.message;
|
||||
}
|
||||
|
||||
return "Unknown error";
|
||||
}
|
||||
}
|
||||
10
apps/api/src/container-reaper/container-reaper.module.ts
Normal file
10
apps/api/src/container-reaper/container-reaper.module.ts
Normal file
@@ -0,0 +1,10 @@
|
||||
import { Module } from "@nestjs/common";
|
||||
import { ScheduleModule } from "@nestjs/schedule";
|
||||
import { ContainerLifecycleModule } from "../container-lifecycle/container-lifecycle.module";
|
||||
import { ContainerReaperService } from "./container-reaper.service";
|
||||
|
||||
@Module({
|
||||
imports: [ScheduleModule, ContainerLifecycleModule],
|
||||
providers: [ContainerReaperService],
|
||||
})
|
||||
export class ContainerReaperModule {}
|
||||
@@ -0,0 +1,45 @@
|
||||
import { beforeEach, describe, expect, it, vi } from "vitest";
|
||||
import type { ContainerLifecycleService } from "../container-lifecycle/container-lifecycle.service";
|
||||
import { ContainerReaperService } from "./container-reaper.service";
|
||||
|
||||
describe("ContainerReaperService", () => {
|
||||
let service: ContainerReaperService;
|
||||
let containerLifecycle: Pick<ContainerLifecycleService, "reapIdle">;
|
||||
|
||||
beforeEach(() => {
|
||||
containerLifecycle = {
|
||||
reapIdle: vi.fn(),
|
||||
};
|
||||
service = new ContainerReaperService(containerLifecycle as ContainerLifecycleService);
|
||||
});
|
||||
|
||||
it("reapIdleContainers calls containerLifecycle.reapIdle()", async () => {
|
||||
vi.mocked(containerLifecycle.reapIdle).mockResolvedValue({ stopped: [] });
|
||||
|
||||
await service.reapIdleContainers();
|
||||
|
||||
expect(containerLifecycle.reapIdle).toHaveBeenCalledTimes(1);
|
||||
});
|
||||
|
||||
it("reapIdleContainers handles errors gracefully", async () => {
|
||||
const error = new Error("reap failure");
|
||||
vi.mocked(containerLifecycle.reapIdle).mockRejectedValue(error);
|
||||
const loggerError = vi.spyOn(service["logger"], "error").mockImplementation(() => {});
|
||||
|
||||
await expect(service.reapIdleContainers()).resolves.toBeUndefined();
|
||||
|
||||
expect(loggerError).toHaveBeenCalledWith(
|
||||
"Failed to reap idle containers",
|
||||
expect.stringContaining("reap failure")
|
||||
);
|
||||
});
|
||||
|
||||
it("reapIdleContainers logs stopped container count", async () => {
|
||||
vi.mocked(containerLifecycle.reapIdle).mockResolvedValue({ stopped: ["user-1", "user-2"] });
|
||||
const loggerLog = vi.spyOn(service["logger"], "log").mockImplementation(() => {});
|
||||
|
||||
await service.reapIdleContainers();
|
||||
|
||||
expect(loggerLog).toHaveBeenCalledWith("Stopped 2 idle containers: user-1, user-2");
|
||||
});
|
||||
});
|
||||
30
apps/api/src/container-reaper/container-reaper.service.ts
Normal file
30
apps/api/src/container-reaper/container-reaper.service.ts
Normal file
@@ -0,0 +1,30 @@
|
||||
import { Injectable, Logger } from "@nestjs/common";
|
||||
import { Cron, CronExpression } from "@nestjs/schedule";
|
||||
import { ContainerLifecycleService } from "../container-lifecycle/container-lifecycle.service";
|
||||
|
||||
@Injectable()
|
||||
export class ContainerReaperService {
|
||||
private readonly logger = new Logger(ContainerReaperService.name);
|
||||
|
||||
constructor(private readonly containerLifecycle: ContainerLifecycleService) {}
|
||||
|
||||
@Cron(CronExpression.EVERY_5_MINUTES)
|
||||
async reapIdleContainers(): Promise<void> {
|
||||
this.logger.log("Running idle container reap cycle...");
|
||||
try {
|
||||
const result = await this.containerLifecycle.reapIdle();
|
||||
if (result.stopped.length > 0) {
|
||||
this.logger.log(
|
||||
`Stopped ${String(result.stopped.length)} idle containers: ${result.stopped.join(", ")}`
|
||||
);
|
||||
} else {
|
||||
this.logger.debug("No idle containers to stop");
|
||||
}
|
||||
} catch (error) {
|
||||
this.logger.error(
|
||||
"Failed to reap idle containers",
|
||||
error instanceof Error ? error.stack : String(error)
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
115
apps/api/src/fleet-settings/fleet-settings.controller.ts
Normal file
115
apps/api/src/fleet-settings/fleet-settings.controller.ts
Normal file
@@ -0,0 +1,115 @@
|
||||
import {
|
||||
Body,
|
||||
Controller,
|
||||
Delete,
|
||||
Get,
|
||||
HttpCode,
|
||||
HttpStatus,
|
||||
Param,
|
||||
Patch,
|
||||
Post,
|
||||
Put,
|
||||
UseGuards,
|
||||
} from "@nestjs/common";
|
||||
import type { AuthUser } from "@mosaic/shared";
|
||||
import { CurrentUser } from "../auth/decorators/current-user.decorator";
|
||||
import { AdminGuard } from "../auth/guards/admin.guard";
|
||||
import { AuthGuard } from "../auth/guards/auth.guard";
|
||||
import type {
|
||||
CreateProviderDto,
|
||||
ResetPasswordDto,
|
||||
UpdateAgentConfigDto,
|
||||
UpdateOidcDto,
|
||||
UpdateProviderDto,
|
||||
} from "./fleet-settings.dto";
|
||||
import { FleetSettingsService } from "./fleet-settings.service";
|
||||
|
||||
@Controller("fleet-settings")
|
||||
@UseGuards(AuthGuard)
|
||||
export class FleetSettingsController {
|
||||
constructor(private readonly fleetSettingsService: FleetSettingsService) {}
|
||||
|
||||
// --- Provider endpoints (user-scoped) ---
|
||||
// GET /api/fleet-settings/providers — list user's providers
|
||||
@Get("providers")
|
||||
async listProviders(@CurrentUser() user: AuthUser) {
|
||||
return this.fleetSettingsService.listProviders(user.id);
|
||||
}
|
||||
|
||||
// GET /api/fleet-settings/providers/:id — get single provider
|
||||
@Get("providers/:id")
|
||||
async getProvider(@CurrentUser() user: AuthUser, @Param("id") id: string) {
|
||||
return this.fleetSettingsService.getProvider(user.id, id);
|
||||
}
|
||||
|
||||
// POST /api/fleet-settings/providers — create provider
|
||||
@Post("providers")
|
||||
async createProvider(@CurrentUser() user: AuthUser, @Body() dto: CreateProviderDto) {
|
||||
return this.fleetSettingsService.createProvider(user.id, dto);
|
||||
}
|
||||
|
||||
// PATCH /api/fleet-settings/providers/:id — update provider
|
||||
@Patch("providers/:id")
|
||||
@HttpCode(HttpStatus.NO_CONTENT)
|
||||
async updateProvider(
|
||||
@CurrentUser() user: AuthUser,
|
||||
@Param("id") id: string,
|
||||
@Body() dto: UpdateProviderDto
|
||||
) {
|
||||
await this.fleetSettingsService.updateProvider(user.id, id, dto);
|
||||
}
|
||||
|
||||
// DELETE /api/fleet-settings/providers/:id — delete provider
|
||||
@Delete("providers/:id")
|
||||
@HttpCode(HttpStatus.NO_CONTENT)
|
||||
async deleteProvider(@CurrentUser() user: AuthUser, @Param("id") id: string) {
|
||||
await this.fleetSettingsService.deleteProvider(user.id, id);
|
||||
}
|
||||
|
||||
// --- Agent config endpoints (user-scoped) ---
|
||||
// GET /api/fleet-settings/agent-config — get user's agent config
|
||||
@Get("agent-config")
|
||||
async getAgentConfig(@CurrentUser() user: AuthUser) {
|
||||
return this.fleetSettingsService.getAgentConfig(user.id);
|
||||
}
|
||||
|
||||
// PATCH /api/fleet-settings/agent-config — update user's agent config
|
||||
@Patch("agent-config")
|
||||
@HttpCode(HttpStatus.NO_CONTENT)
|
||||
async updateAgentConfig(@CurrentUser() user: AuthUser, @Body() dto: UpdateAgentConfigDto) {
|
||||
await this.fleetSettingsService.updateAgentConfig(user.id, dto);
|
||||
}
|
||||
|
||||
// --- OIDC endpoints (admin only — use AdminGuard) ---
|
||||
// GET /api/fleet-settings/oidc — get OIDC config
|
||||
@Get("oidc")
|
||||
@UseGuards(AdminGuard)
|
||||
async getOidcConfig() {
|
||||
return this.fleetSettingsService.getOidcConfig();
|
||||
}
|
||||
|
||||
// PUT /api/fleet-settings/oidc — update OIDC config
|
||||
@Put("oidc")
|
||||
@UseGuards(AdminGuard)
|
||||
@HttpCode(HttpStatus.NO_CONTENT)
|
||||
async updateOidcConfig(@Body() dto: UpdateOidcDto) {
|
||||
await this.fleetSettingsService.updateOidcConfig(dto);
|
||||
}
|
||||
|
||||
// DELETE /api/fleet-settings/oidc — remove OIDC config
|
||||
@Delete("oidc")
|
||||
@UseGuards(AdminGuard)
|
||||
@HttpCode(HttpStatus.NO_CONTENT)
|
||||
async deleteOidcConfig() {
|
||||
await this.fleetSettingsService.deleteOidcConfig();
|
||||
}
|
||||
|
||||
// --- Breakglass endpoints (admin only) ---
|
||||
// POST /api/fleet-settings/breakglass/reset-password — reset admin password
|
||||
@Post("breakglass/reset-password")
|
||||
@UseGuards(AdminGuard)
|
||||
@HttpCode(HttpStatus.NO_CONTENT)
|
||||
async resetBreakglassPassword(@Body() dto: ResetPasswordDto) {
|
||||
await this.fleetSettingsService.resetBreakglassPassword(dto.username, dto.newPassword);
|
||||
}
|
||||
}
|
||||
122
apps/api/src/fleet-settings/fleet-settings.dto.ts
Normal file
122
apps/api/src/fleet-settings/fleet-settings.dto.ts
Normal file
@@ -0,0 +1,122 @@
|
||||
import {
|
||||
ArrayNotEmpty,
|
||||
IsArray,
|
||||
IsBoolean,
|
||||
IsNotEmpty,
|
||||
IsObject,
|
||||
IsOptional,
|
||||
IsString,
|
||||
IsUrl,
|
||||
MaxLength,
|
||||
MinLength,
|
||||
} from "class-validator";
|
||||
|
||||
export class CreateProviderDto {
|
||||
@IsString({ message: "name must be a string" })
|
||||
@IsNotEmpty({ message: "name is required" })
|
||||
@MaxLength(100, { message: "name must not exceed 100 characters" })
|
||||
name!: string;
|
||||
|
||||
@IsString({ message: "displayName must be a string" })
|
||||
@IsNotEmpty({ message: "displayName is required" })
|
||||
@MaxLength(255, { message: "displayName must not exceed 255 characters" })
|
||||
displayName!: string;
|
||||
|
||||
@IsString({ message: "type must be a string" })
|
||||
@IsNotEmpty({ message: "type is required" })
|
||||
@MaxLength(100, { message: "type must not exceed 100 characters" })
|
||||
type!: string;
|
||||
|
||||
@IsOptional()
|
||||
@IsUrl(
|
||||
{ require_tld: false },
|
||||
{ message: "baseUrl must be a valid URL (for example: https://api.example.com/v1)" }
|
||||
)
|
||||
baseUrl?: string;
|
||||
|
||||
@IsOptional()
|
||||
@IsString({ message: "apiKey must be a string" })
|
||||
apiKey?: string;
|
||||
|
||||
@IsOptional()
|
||||
@IsString({ message: "apiType must be a string" })
|
||||
@MaxLength(100, { message: "apiType must not exceed 100 characters" })
|
||||
apiType?: string;
|
||||
|
||||
@IsOptional()
|
||||
@IsArray({ message: "models must be an array" })
|
||||
@IsObject({ each: true, message: "each model must be an object" })
|
||||
models?: Record<string, unknown>[];
|
||||
}
|
||||
|
||||
export class UpdateProviderDto {
|
||||
@IsOptional()
|
||||
@IsString({ message: "displayName must be a string" })
|
||||
@MaxLength(255, { message: "displayName must not exceed 255 characters" })
|
||||
displayName?: string;
|
||||
|
||||
@IsOptional()
|
||||
@IsUrl(
|
||||
{ require_tld: false },
|
||||
{ message: "baseUrl must be a valid URL (for example: https://api.example.com/v1)" }
|
||||
)
|
||||
baseUrl?: string;
|
||||
|
||||
@IsOptional()
|
||||
@IsString({ message: "apiKey must be a string" })
|
||||
apiKey?: string;
|
||||
|
||||
@IsOptional()
|
||||
@IsBoolean({ message: "isActive must be a boolean" })
|
||||
isActive?: boolean;
|
||||
|
||||
@IsOptional()
|
||||
@IsArray({ message: "models must be an array" })
|
||||
@IsObject({ each: true, message: "each model must be an object" })
|
||||
models?: Record<string, unknown>[];
|
||||
}
|
||||
|
||||
export class UpdateAgentConfigDto {
|
||||
@IsOptional()
|
||||
@IsString({ message: "primaryModel must be a string" })
|
||||
@MaxLength(255, { message: "primaryModel must not exceed 255 characters" })
|
||||
primaryModel?: string;
|
||||
|
||||
@IsOptional()
|
||||
@IsArray({ message: "fallbackModels must be an array" })
|
||||
@ArrayNotEmpty({ message: "fallbackModels cannot be empty" })
|
||||
@IsString({ each: true, message: "each fallback model must be a string" })
|
||||
fallbackModels?: string[];
|
||||
|
||||
@IsOptional()
|
||||
@IsString({ message: "personality must be a string" })
|
||||
personality?: string;
|
||||
}
|
||||
|
||||
export class UpdateOidcDto {
|
||||
@IsString({ message: "issuerUrl must be a string" })
|
||||
@IsNotEmpty({ message: "issuerUrl is required" })
|
||||
@IsUrl(
|
||||
{ require_tld: false },
|
||||
{ message: "issuerUrl must be a valid URL (for example: https://issuer.example.com)" }
|
||||
)
|
||||
issuerUrl!: string;
|
||||
|
||||
@IsString({ message: "clientId must be a string" })
|
||||
@IsNotEmpty({ message: "clientId is required" })
|
||||
clientId!: string;
|
||||
|
||||
@IsString({ message: "clientSecret must be a string" })
|
||||
@IsNotEmpty({ message: "clientSecret is required" })
|
||||
clientSecret!: string;
|
||||
}
|
||||
|
||||
export class ResetPasswordDto {
|
||||
@IsString({ message: "username must be a string" })
|
||||
@IsNotEmpty({ message: "username is required" })
|
||||
username!: string;
|
||||
|
||||
@IsString({ message: "newPassword must be a string" })
|
||||
@MinLength(8, { message: "newPassword must be at least 8 characters" })
|
||||
newPassword!: string;
|
||||
}
|
||||
14
apps/api/src/fleet-settings/fleet-settings.module.ts
Normal file
14
apps/api/src/fleet-settings/fleet-settings.module.ts
Normal file
@@ -0,0 +1,14 @@
|
||||
import { Module } from "@nestjs/common";
|
||||
import { AuthModule } from "../auth/auth.module";
|
||||
import { PrismaModule } from "../prisma/prisma.module";
|
||||
import { CryptoModule } from "../crypto/crypto.module";
|
||||
import { FleetSettingsController } from "./fleet-settings.controller";
|
||||
import { FleetSettingsService } from "./fleet-settings.service";
|
||||
|
||||
@Module({
|
||||
imports: [AuthModule, PrismaModule, CryptoModule],
|
||||
controllers: [FleetSettingsController],
|
||||
providers: [FleetSettingsService],
|
||||
exports: [FleetSettingsService],
|
||||
})
|
||||
export class FleetSettingsModule {}
|
||||
200
apps/api/src/fleet-settings/fleet-settings.service.spec.ts
Normal file
200
apps/api/src/fleet-settings/fleet-settings.service.spec.ts
Normal file
@@ -0,0 +1,200 @@
|
||||
import { NotFoundException } from "@nestjs/common";
|
||||
import { compare } from "bcryptjs";
|
||||
import { beforeEach, describe, expect, it, vi } from "vitest";
|
||||
import { FleetSettingsService } from "./fleet-settings.service";
|
||||
import type { PrismaService } from "../prisma/prisma.service";
|
||||
import type { CryptoService } from "../crypto/crypto.service";
|
||||
|
||||
describe("FleetSettingsService", () => {
|
||||
let service: FleetSettingsService;
|
||||
|
||||
const mockPrisma = {
|
||||
llmProvider: {
|
||||
findMany: vi.fn(),
|
||||
findFirst: vi.fn(),
|
||||
findUnique: vi.fn(),
|
||||
create: vi.fn(),
|
||||
update: vi.fn(),
|
||||
delete: vi.fn(),
|
||||
},
|
||||
userAgentConfig: {
|
||||
findUnique: vi.fn(),
|
||||
upsert: vi.fn(),
|
||||
},
|
||||
systemConfig: {
|
||||
findMany: vi.fn(),
|
||||
upsert: vi.fn(),
|
||||
deleteMany: vi.fn(),
|
||||
},
|
||||
breakglassUser: {
|
||||
findUnique: vi.fn(),
|
||||
update: vi.fn(),
|
||||
},
|
||||
};
|
||||
|
||||
const mockCrypto = {
|
||||
encrypt: vi.fn((value: string) => `enc:${value}`),
|
||||
};
|
||||
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
service = new FleetSettingsService(
|
||||
mockPrisma as unknown as PrismaService,
|
||||
mockCrypto as unknown as CryptoService
|
||||
);
|
||||
});
|
||||
|
||||
it("listProviders returns only providers for the given userId", async () => {
|
||||
mockPrisma.llmProvider.findMany.mockResolvedValue([
|
||||
{
|
||||
id: "prov-1",
|
||||
name: "openai-main",
|
||||
displayName: "OpenAI",
|
||||
type: "openai",
|
||||
baseUrl: "https://api.openai.com/v1",
|
||||
isActive: true,
|
||||
models: [{ id: "gpt-4.1" }],
|
||||
},
|
||||
]);
|
||||
|
||||
const result = await service.listProviders("user-1");
|
||||
|
||||
expect(mockPrisma.llmProvider.findMany).toHaveBeenCalledWith({
|
||||
where: { userId: "user-1" },
|
||||
select: {
|
||||
id: true,
|
||||
name: true,
|
||||
displayName: true,
|
||||
type: true,
|
||||
baseUrl: true,
|
||||
isActive: true,
|
||||
models: true,
|
||||
},
|
||||
orderBy: { createdAt: "asc" },
|
||||
});
|
||||
expect(result).toEqual([
|
||||
{
|
||||
id: "prov-1",
|
||||
name: "openai-main",
|
||||
displayName: "OpenAI",
|
||||
type: "openai",
|
||||
baseUrl: "https://api.openai.com/v1",
|
||||
isActive: true,
|
||||
models: [{ id: "gpt-4.1" }],
|
||||
},
|
||||
]);
|
||||
});
|
||||
|
||||
it("createProvider encrypts apiKey", async () => {
|
||||
mockPrisma.llmProvider.create.mockResolvedValue({
|
||||
id: "prov-2",
|
||||
});
|
||||
|
||||
const result = await service.createProvider("user-1", {
|
||||
name: "zai-main",
|
||||
displayName: "Z.ai",
|
||||
type: "zai",
|
||||
apiKey: "plaintext-key",
|
||||
models: [],
|
||||
});
|
||||
|
||||
expect(mockCrypto.encrypt).toHaveBeenCalledWith("plaintext-key");
|
||||
expect(mockPrisma.llmProvider.create).toHaveBeenCalledWith({
|
||||
data: {
|
||||
userId: "user-1",
|
||||
name: "zai-main",
|
||||
displayName: "Z.ai",
|
||||
type: "zai",
|
||||
baseUrl: null,
|
||||
apiKey: "enc:plaintext-key",
|
||||
apiType: "openai-completions",
|
||||
models: [],
|
||||
},
|
||||
select: {
|
||||
id: true,
|
||||
},
|
||||
});
|
||||
expect(result).toEqual({ id: "prov-2" });
|
||||
});
|
||||
|
||||
it("updateProvider rejects if not owned by user", async () => {
|
||||
mockPrisma.llmProvider.findFirst.mockResolvedValue(null);
|
||||
|
||||
await expect(
|
||||
service.updateProvider("user-1", "provider-1", {
|
||||
displayName: "New Name",
|
||||
})
|
||||
).rejects.toBeInstanceOf(NotFoundException);
|
||||
|
||||
expect(mockPrisma.llmProvider.update).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("deleteProvider rejects if not owned by user", async () => {
|
||||
mockPrisma.llmProvider.findFirst.mockResolvedValue(null);
|
||||
|
||||
await expect(service.deleteProvider("user-1", "provider-1")).rejects.toBeInstanceOf(
|
||||
NotFoundException
|
||||
);
|
||||
|
||||
expect(mockPrisma.llmProvider.delete).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("getOidcConfig never returns clientSecret", async () => {
|
||||
mockPrisma.systemConfig.findMany.mockResolvedValue([
|
||||
{
|
||||
key: "oidc.issuerUrl",
|
||||
value: "https://issuer.example.com",
|
||||
},
|
||||
{
|
||||
key: "oidc.clientId",
|
||||
value: "client-id-1",
|
||||
},
|
||||
{
|
||||
key: "oidc.clientSecret",
|
||||
value: "enc:very-secret",
|
||||
},
|
||||
]);
|
||||
|
||||
const result = await service.getOidcConfig();
|
||||
|
||||
expect(result).toEqual({
|
||||
issuerUrl: "https://issuer.example.com",
|
||||
clientId: "client-id-1",
|
||||
configured: true,
|
||||
});
|
||||
expect(result).not.toHaveProperty("clientSecret");
|
||||
});
|
||||
|
||||
it("updateOidcConfig encrypts clientSecret", async () => {
|
||||
await service.updateOidcConfig({
|
||||
issuerUrl: "https://issuer.example.com",
|
||||
clientId: "client-id-1",
|
||||
clientSecret: "super-secret",
|
||||
});
|
||||
|
||||
expect(mockCrypto.encrypt).toHaveBeenCalledWith("super-secret");
|
||||
expect(mockPrisma.systemConfig.upsert).toHaveBeenCalledTimes(3);
|
||||
expect(mockPrisma.systemConfig.upsert).toHaveBeenCalledWith({
|
||||
where: { key: "oidc.clientSecret" },
|
||||
update: { value: "enc:super-secret", encrypted: true },
|
||||
create: { key: "oidc.clientSecret", value: "enc:super-secret", encrypted: true },
|
||||
});
|
||||
});
|
||||
|
||||
it("resetBreakglassPassword hashes new password", async () => {
|
||||
mockPrisma.breakglassUser.findUnique.mockResolvedValue({
|
||||
id: "bg-1",
|
||||
username: "admin",
|
||||
passwordHash: "old-hash",
|
||||
});
|
||||
|
||||
await service.resetBreakglassPassword("admin", "new-password-123");
|
||||
|
||||
expect(mockPrisma.breakglassUser.update).toHaveBeenCalledOnce();
|
||||
const updateCall = mockPrisma.breakglassUser.update.mock.calls[0]?.[0];
|
||||
const newHash = updateCall?.data?.passwordHash;
|
||||
expect(newHash).toBeTypeOf("string");
|
||||
expect(newHash).not.toBe("new-password-123");
|
||||
expect(await compare("new-password-123", newHash as string)).toBe(true);
|
||||
});
|
||||
});
|
||||
296
apps/api/src/fleet-settings/fleet-settings.service.ts
Normal file
296
apps/api/src/fleet-settings/fleet-settings.service.ts
Normal file
@@ -0,0 +1,296 @@
|
||||
import { Injectable, NotFoundException } from "@nestjs/common";
|
||||
import { hash } from "bcryptjs";
|
||||
import type { Prisma } from "@prisma/client";
|
||||
import { PrismaService } from "../prisma/prisma.service";
|
||||
import { CryptoService } from "../crypto/crypto.service";
|
||||
import type {
|
||||
CreateProviderDto,
|
||||
ResetPasswordDto,
|
||||
UpdateAgentConfigDto,
|
||||
UpdateOidcDto,
|
||||
UpdateProviderDto,
|
||||
} from "./fleet-settings.dto";
|
||||
|
||||
const BCRYPT_ROUNDS = 12;
|
||||
const DEFAULT_PROVIDER_API_TYPE = "openai-completions";
|
||||
const OIDC_ISSUER_KEY = "oidc.issuerUrl";
|
||||
const OIDC_CLIENT_ID_KEY = "oidc.clientId";
|
||||
const OIDC_CLIENT_SECRET_KEY = "oidc.clientSecret";
|
||||
const OIDC_KEYS = [OIDC_ISSUER_KEY, OIDC_CLIENT_ID_KEY, OIDC_CLIENT_SECRET_KEY] as const;
|
||||
|
||||
export interface FleetProviderResponse {
|
||||
id: string;
|
||||
name: string;
|
||||
displayName: string;
|
||||
type: string;
|
||||
baseUrl: string | null;
|
||||
isActive: boolean;
|
||||
models: unknown;
|
||||
}
|
||||
|
||||
export interface FleetAgentConfigResponse {
|
||||
primaryModel: string | null;
|
||||
fallbackModels: unknown[];
|
||||
personality: string | null;
|
||||
}
|
||||
|
||||
export interface OidcConfigResponse {
|
||||
issuerUrl?: string;
|
||||
clientId?: string;
|
||||
configured: boolean;
|
||||
}
|
||||
|
||||
@Injectable()
|
||||
export class FleetSettingsService {
|
||||
constructor(
|
||||
private readonly prisma: PrismaService,
|
||||
private readonly crypto: CryptoService
|
||||
) {}
|
||||
|
||||
// --- LLM Provider CRUD (per-user scoped) ---
|
||||
|
||||
async listProviders(userId: string): Promise<FleetProviderResponse[]> {
|
||||
return this.prisma.llmProvider.findMany({
|
||||
where: { userId },
|
||||
select: {
|
||||
id: true,
|
||||
name: true,
|
||||
displayName: true,
|
||||
type: true,
|
||||
baseUrl: true,
|
||||
isActive: true,
|
||||
models: true,
|
||||
},
|
||||
orderBy: { createdAt: "asc" },
|
||||
});
|
||||
}
|
||||
|
||||
async getProvider(userId: string, providerId: string): Promise<FleetProviderResponse> {
|
||||
const provider = await this.prisma.llmProvider.findFirst({
|
||||
where: {
|
||||
id: providerId,
|
||||
userId,
|
||||
},
|
||||
select: {
|
||||
id: true,
|
||||
name: true,
|
||||
displayName: true,
|
||||
type: true,
|
||||
baseUrl: true,
|
||||
isActive: true,
|
||||
models: true,
|
||||
},
|
||||
});
|
||||
|
||||
if (!provider) {
|
||||
throw new NotFoundException(`Provider ${providerId} not found`);
|
||||
}
|
||||
|
||||
return provider;
|
||||
}
|
||||
|
||||
async createProvider(userId: string, data: CreateProviderDto): Promise<{ id: string }> {
|
||||
const provider = await this.prisma.llmProvider.create({
|
||||
data: {
|
||||
userId,
|
||||
name: data.name,
|
||||
displayName: data.displayName,
|
||||
type: data.type,
|
||||
baseUrl: data.baseUrl ?? null,
|
||||
apiKey: data.apiKey ? this.crypto.encrypt(data.apiKey) : null,
|
||||
apiType: data.apiType ?? DEFAULT_PROVIDER_API_TYPE,
|
||||
models: (data.models ?? []) as Prisma.InputJsonValue,
|
||||
},
|
||||
select: {
|
||||
id: true,
|
||||
},
|
||||
});
|
||||
|
||||
return provider;
|
||||
}
|
||||
|
||||
async updateProvider(userId: string, providerId: string, data: UpdateProviderDto): Promise<void> {
|
||||
await this.assertProviderOwnership(userId, providerId);
|
||||
|
||||
const updateData: Prisma.LlmProviderUpdateInput = {};
|
||||
if (data.displayName !== undefined) {
|
||||
updateData.displayName = data.displayName;
|
||||
}
|
||||
if (data.baseUrl !== undefined) {
|
||||
updateData.baseUrl = data.baseUrl;
|
||||
}
|
||||
if (data.isActive !== undefined) {
|
||||
updateData.isActive = data.isActive;
|
||||
}
|
||||
if (data.models !== undefined) {
|
||||
updateData.models = data.models as Prisma.InputJsonValue;
|
||||
}
|
||||
if (data.apiKey !== undefined) {
|
||||
updateData.apiKey = data.apiKey.length > 0 ? this.crypto.encrypt(data.apiKey) : null;
|
||||
}
|
||||
|
||||
await this.prisma.llmProvider.update({
|
||||
where: { id: providerId },
|
||||
data: updateData,
|
||||
});
|
||||
}
|
||||
|
||||
async deleteProvider(userId: string, providerId: string): Promise<void> {
|
||||
await this.assertProviderOwnership(userId, providerId);
|
||||
|
||||
await this.prisma.llmProvider.delete({
|
||||
where: { id: providerId },
|
||||
});
|
||||
}
|
||||
|
||||
// --- User Agent Config ---
|
||||
|
||||
async getAgentConfig(userId: string): Promise<FleetAgentConfigResponse> {
|
||||
const config = await this.prisma.userAgentConfig.findUnique({
|
||||
where: { userId },
|
||||
select: {
|
||||
primaryModel: true,
|
||||
fallbackModels: true,
|
||||
personality: true,
|
||||
},
|
||||
});
|
||||
|
||||
if (!config) {
|
||||
return {
|
||||
primaryModel: null,
|
||||
fallbackModels: [],
|
||||
personality: null,
|
||||
};
|
||||
}
|
||||
|
||||
return {
|
||||
primaryModel: config.primaryModel,
|
||||
fallbackModels: this.normalizeJsonArray(config.fallbackModels),
|
||||
personality: config.personality,
|
||||
};
|
||||
}
|
||||
|
||||
async updateAgentConfig(userId: string, data: UpdateAgentConfigDto): Promise<void> {
|
||||
const updateData: Prisma.UserAgentConfigUpdateInput = {};
|
||||
if (data.primaryModel !== undefined) {
|
||||
updateData.primaryModel = data.primaryModel;
|
||||
}
|
||||
if (data.personality !== undefined) {
|
||||
updateData.personality = data.personality;
|
||||
}
|
||||
if (data.fallbackModels !== undefined) {
|
||||
updateData.fallbackModels = data.fallbackModels as Prisma.InputJsonValue;
|
||||
}
|
||||
|
||||
const createData: Prisma.UserAgentConfigCreateInput = {
|
||||
userId,
|
||||
fallbackModels: (data.fallbackModels ?? []) as Prisma.InputJsonValue,
|
||||
...(data.primaryModel !== undefined ? { primaryModel: data.primaryModel } : {}),
|
||||
...(data.personality !== undefined ? { personality: data.personality } : {}),
|
||||
};
|
||||
|
||||
await this.prisma.userAgentConfig.upsert({
|
||||
where: { userId },
|
||||
create: createData,
|
||||
update: updateData,
|
||||
});
|
||||
}
|
||||
|
||||
// --- OIDC Config (admin only) ---
|
||||
|
||||
async getOidcConfig(): Promise<OidcConfigResponse> {
|
||||
const entries = await this.prisma.systemConfig.findMany({
|
||||
where: {
|
||||
key: {
|
||||
in: [...OIDC_KEYS],
|
||||
},
|
||||
},
|
||||
select: {
|
||||
key: true,
|
||||
value: true,
|
||||
},
|
||||
});
|
||||
|
||||
const byKey = new Map(entries.map((entry) => [entry.key, entry.value]));
|
||||
const issuerUrl = byKey.get(OIDC_ISSUER_KEY);
|
||||
const clientId = byKey.get(OIDC_CLIENT_ID_KEY);
|
||||
const hasSecret = byKey.has(OIDC_CLIENT_SECRET_KEY);
|
||||
|
||||
return {
|
||||
...(issuerUrl ? { issuerUrl } : {}),
|
||||
...(clientId ? { clientId } : {}),
|
||||
configured: Boolean(issuerUrl && clientId && hasSecret),
|
||||
};
|
||||
}
|
||||
|
||||
async updateOidcConfig(data: UpdateOidcDto): Promise<void> {
|
||||
const encryptedSecret = this.crypto.encrypt(data.clientSecret);
|
||||
|
||||
await Promise.all([
|
||||
this.upsertSystemConfig(OIDC_ISSUER_KEY, data.issuerUrl, false),
|
||||
this.upsertSystemConfig(OIDC_CLIENT_ID_KEY, data.clientId, false),
|
||||
this.upsertSystemConfig(OIDC_CLIENT_SECRET_KEY, encryptedSecret, true),
|
||||
]);
|
||||
}
|
||||
|
||||
async deleteOidcConfig(): Promise<void> {
|
||||
await this.prisma.systemConfig.deleteMany({
|
||||
where: {
|
||||
key: {
|
||||
in: [...OIDC_KEYS],
|
||||
},
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
// --- Breakglass (admin only) ---
|
||||
|
||||
async resetBreakglassPassword(
|
||||
username: ResetPasswordDto["username"],
|
||||
newPassword: ResetPasswordDto["newPassword"]
|
||||
): Promise<void> {
|
||||
const user = await this.prisma.breakglassUser.findUnique({
|
||||
where: { username },
|
||||
select: { id: true },
|
||||
});
|
||||
|
||||
if (!user) {
|
||||
throw new NotFoundException(`Breakglass user ${username} not found`);
|
||||
}
|
||||
|
||||
const passwordHash = await hash(newPassword, BCRYPT_ROUNDS);
|
||||
|
||||
await this.prisma.breakglassUser.update({
|
||||
where: { id: user.id },
|
||||
data: { passwordHash },
|
||||
});
|
||||
}
|
||||
|
||||
private async assertProviderOwnership(userId: string, providerId: string): Promise<void> {
|
||||
const provider = await this.prisma.llmProvider.findFirst({
|
||||
where: {
|
||||
id: providerId,
|
||||
userId,
|
||||
},
|
||||
select: {
|
||||
id: true,
|
||||
},
|
||||
});
|
||||
|
||||
if (!provider) {
|
||||
throw new NotFoundException(`Provider ${providerId} not found`);
|
||||
}
|
||||
}
|
||||
|
||||
private async upsertSystemConfig(key: string, value: string, encrypted: boolean): Promise<void> {
|
||||
await this.prisma.systemConfig.upsert({
|
||||
where: { key },
|
||||
update: { value, encrypted },
|
||||
create: { key, value, encrypted },
|
||||
});
|
||||
}
|
||||
|
||||
private normalizeJsonArray(value: unknown): unknown[] {
|
||||
return Array.isArray(value) ? value : [];
|
||||
}
|
||||
}
|
||||
63
apps/api/src/onboarding/onboarding.controller.ts
Normal file
63
apps/api/src/onboarding/onboarding.controller.ts
Normal file
@@ -0,0 +1,63 @@
|
||||
import { Body, Controller, Get, HttpCode, HttpStatus, Post, UseGuards } from "@nestjs/common";
|
||||
import {
|
||||
AddProviderDto,
|
||||
ConfigureOidcDto,
|
||||
CreateBreakglassDto,
|
||||
TestProviderDto,
|
||||
} from "./onboarding.dto";
|
||||
import { OnboardingGuard } from "./onboarding.guard";
|
||||
import { OnboardingService } from "./onboarding.service";
|
||||
|
||||
@Controller("onboarding")
|
||||
export class OnboardingController {
|
||||
constructor(private readonly onboardingService: OnboardingService) {}
|
||||
|
||||
// GET /api/onboarding/status — returns { completed: boolean }
|
||||
@Get("status")
|
||||
async status(): Promise<{ completed: boolean }> {
|
||||
return {
|
||||
completed: await this.onboardingService.isCompleted(),
|
||||
};
|
||||
}
|
||||
|
||||
// POST /api/onboarding/breakglass — body: { username, password } → create admin
|
||||
@Post("breakglass")
|
||||
@UseGuards(OnboardingGuard)
|
||||
async createBreakglass(
|
||||
@Body() body: CreateBreakglassDto
|
||||
): Promise<{ id: string; username: string }> {
|
||||
return this.onboardingService.createBreakglassUser(body.username, body.password);
|
||||
}
|
||||
|
||||
// POST /api/onboarding/oidc — body: { issuerUrl, clientId, clientSecret } → save OIDC
|
||||
@Post("oidc")
|
||||
@UseGuards(OnboardingGuard)
|
||||
@HttpCode(HttpStatus.NO_CONTENT)
|
||||
async configureOidc(@Body() body: ConfigureOidcDto): Promise<void> {
|
||||
await this.onboardingService.configureOidc(body.issuerUrl, body.clientId, body.clientSecret);
|
||||
}
|
||||
|
||||
// POST /api/onboarding/provider — body: { name, displayName, type, baseUrl?, apiKey?, models? } → add provider
|
||||
@Post("provider")
|
||||
@UseGuards(OnboardingGuard)
|
||||
async addProvider(@Body() body: AddProviderDto): Promise<{ id: string }> {
|
||||
const userId = await this.onboardingService.getBreakglassUserId();
|
||||
|
||||
return this.onboardingService.addProvider(userId, body);
|
||||
}
|
||||
|
||||
// POST /api/onboarding/provider/test — body: { type, baseUrl?, apiKey? } → test connection
|
||||
@Post("provider/test")
|
||||
@UseGuards(OnboardingGuard)
|
||||
async testProvider(@Body() body: TestProviderDto): Promise<{ success: boolean; error?: string }> {
|
||||
return this.onboardingService.testProvider(body.type, body.baseUrl, body.apiKey);
|
||||
}
|
||||
|
||||
// POST /api/onboarding/complete — mark done
|
||||
@Post("complete")
|
||||
@UseGuards(OnboardingGuard)
|
||||
@HttpCode(HttpStatus.NO_CONTENT)
|
||||
async complete(): Promise<void> {
|
||||
await this.onboardingService.complete();
|
||||
}
|
||||
}
|
||||
71
apps/api/src/onboarding/onboarding.dto.ts
Normal file
71
apps/api/src/onboarding/onboarding.dto.ts
Normal file
@@ -0,0 +1,71 @@
|
||||
import { Type } from "class-transformer";
|
||||
import { IsArray, IsOptional, IsString, IsUrl, MinLength, ValidateNested } from "class-validator";
|
||||
|
||||
export class CreateBreakglassDto {
|
||||
@IsString()
|
||||
@MinLength(3)
|
||||
username!: string;
|
||||
|
||||
@IsString()
|
||||
@MinLength(8)
|
||||
password!: string;
|
||||
}
|
||||
|
||||
export class ConfigureOidcDto {
|
||||
@IsString()
|
||||
@IsUrl({ require_tld: false })
|
||||
issuerUrl!: string;
|
||||
|
||||
@IsString()
|
||||
clientId!: string;
|
||||
|
||||
@IsString()
|
||||
clientSecret!: string;
|
||||
}
|
||||
|
||||
export class ProviderModelDto {
|
||||
@IsString()
|
||||
id!: string;
|
||||
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
name?: string;
|
||||
}
|
||||
|
||||
export class AddProviderDto {
|
||||
@IsString()
|
||||
name!: string;
|
||||
|
||||
@IsString()
|
||||
displayName!: string;
|
||||
|
||||
@IsString()
|
||||
type!: string;
|
||||
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
baseUrl?: string;
|
||||
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
apiKey?: string;
|
||||
|
||||
@IsOptional()
|
||||
@IsArray()
|
||||
@ValidateNested({ each: true })
|
||||
@Type(() => ProviderModelDto)
|
||||
models?: ProviderModelDto[];
|
||||
}
|
||||
|
||||
export class TestProviderDto {
|
||||
@IsString()
|
||||
type!: string;
|
||||
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
baseUrl?: string;
|
||||
|
||||
@IsOptional()
|
||||
@IsString()
|
||||
apiKey?: string;
|
||||
}
|
||||
17
apps/api/src/onboarding/onboarding.guard.ts
Normal file
17
apps/api/src/onboarding/onboarding.guard.ts
Normal file
@@ -0,0 +1,17 @@
|
||||
import { CanActivate, ExecutionContext, ForbiddenException, Injectable } from "@nestjs/common";
|
||||
import { OnboardingService } from "./onboarding.service";
|
||||
|
||||
@Injectable()
|
||||
export class OnboardingGuard implements CanActivate {
|
||||
constructor(private readonly onboardingService: OnboardingService) {}
|
||||
|
||||
async canActivate(_context: ExecutionContext): Promise<boolean> {
|
||||
const completed = await this.onboardingService.isCompleted();
|
||||
|
||||
if (completed) {
|
||||
throw new ForbiddenException("Onboarding already completed");
|
||||
}
|
||||
|
||||
return true;
|
||||
}
|
||||
}
|
||||
15
apps/api/src/onboarding/onboarding.module.ts
Normal file
15
apps/api/src/onboarding/onboarding.module.ts
Normal file
@@ -0,0 +1,15 @@
|
||||
import { Module } from "@nestjs/common";
|
||||
import { ConfigModule } from "@nestjs/config";
|
||||
import { PrismaModule } from "../prisma/prisma.module";
|
||||
import { CryptoModule } from "../crypto/crypto.module";
|
||||
import { OnboardingController } from "./onboarding.controller";
|
||||
import { OnboardingService } from "./onboarding.service";
|
||||
import { OnboardingGuard } from "./onboarding.guard";
|
||||
|
||||
@Module({
|
||||
imports: [PrismaModule, CryptoModule, ConfigModule],
|
||||
controllers: [OnboardingController],
|
||||
providers: [OnboardingService, OnboardingGuard],
|
||||
exports: [OnboardingService],
|
||||
})
|
||||
export class OnboardingModule {}
|
||||
206
apps/api/src/onboarding/onboarding.service.spec.ts
Normal file
206
apps/api/src/onboarding/onboarding.service.spec.ts
Normal file
@@ -0,0 +1,206 @@
|
||||
import { beforeEach, describe, expect, it, vi } from "vitest";
|
||||
import { hash } from "bcryptjs";
|
||||
import { OnboardingService } from "./onboarding.service";
|
||||
import { PrismaService } from "../prisma/prisma.service";
|
||||
import { CryptoService } from "../crypto/crypto.service";
|
||||
|
||||
vi.mock("bcryptjs", () => ({
|
||||
hash: vi.fn(),
|
||||
}));
|
||||
|
||||
describe("OnboardingService", () => {
|
||||
let service: OnboardingService;
|
||||
|
||||
const mockPrismaService = {
|
||||
systemConfig: {
|
||||
findUnique: vi.fn(),
|
||||
upsert: vi.fn(),
|
||||
},
|
||||
breakglassUser: {
|
||||
count: vi.fn(),
|
||||
create: vi.fn(),
|
||||
findFirst: vi.fn(),
|
||||
},
|
||||
llmProvider: {
|
||||
create: vi.fn(),
|
||||
},
|
||||
};
|
||||
|
||||
const mockCryptoService = {
|
||||
encrypt: vi.fn(),
|
||||
};
|
||||
|
||||
beforeEach(() => {
|
||||
vi.clearAllMocks();
|
||||
|
||||
service = new OnboardingService(
|
||||
mockPrismaService as unknown as PrismaService,
|
||||
mockCryptoService as unknown as CryptoService
|
||||
);
|
||||
});
|
||||
|
||||
it("isCompleted returns false when no config exists", async () => {
|
||||
mockPrismaService.systemConfig.findUnique.mockResolvedValue(null);
|
||||
|
||||
await expect(service.isCompleted()).resolves.toBe(false);
|
||||
expect(mockPrismaService.systemConfig.findUnique).toHaveBeenCalledWith({
|
||||
where: { key: "onboarding.completed" },
|
||||
});
|
||||
});
|
||||
|
||||
it("isCompleted returns true when completed", async () => {
|
||||
mockPrismaService.systemConfig.findUnique.mockResolvedValue({
|
||||
id: "cfg-1",
|
||||
key: "onboarding.completed",
|
||||
value: "true",
|
||||
encrypted: false,
|
||||
updatedAt: new Date(),
|
||||
});
|
||||
|
||||
await expect(service.isCompleted()).resolves.toBe(true);
|
||||
});
|
||||
|
||||
it("createBreakglassUser hashes password and creates record", async () => {
|
||||
const mockedHash = vi.mocked(hash);
|
||||
mockedHash.mockResolvedValue("hashed-password");
|
||||
|
||||
mockPrismaService.breakglassUser.count.mockResolvedValue(0);
|
||||
mockPrismaService.breakglassUser.create.mockResolvedValue({
|
||||
id: "breakglass-1",
|
||||
username: "admin",
|
||||
});
|
||||
|
||||
const result = await service.createBreakglassUser("admin", "supersecret123");
|
||||
|
||||
expect(mockedHash).toHaveBeenCalledWith("supersecret123", 12);
|
||||
expect(mockPrismaService.breakglassUser.create).toHaveBeenCalledWith({
|
||||
data: {
|
||||
username: "admin",
|
||||
passwordHash: "hashed-password",
|
||||
},
|
||||
select: {
|
||||
id: true,
|
||||
username: true,
|
||||
},
|
||||
});
|
||||
expect(result).toEqual({ id: "breakglass-1", username: "admin" });
|
||||
});
|
||||
|
||||
it("createBreakglassUser rejects if user already exists", async () => {
|
||||
mockPrismaService.breakglassUser.count.mockResolvedValue(1);
|
||||
|
||||
await expect(service.createBreakglassUser("admin", "supersecret123")).rejects.toThrow(
|
||||
"Breakglass user already exists"
|
||||
);
|
||||
});
|
||||
|
||||
it("configureOidc encrypts secret and saves to SystemConfig", async () => {
|
||||
mockCryptoService.encrypt.mockReturnValue("enc:oidc-secret");
|
||||
mockPrismaService.systemConfig.upsert.mockResolvedValue({
|
||||
id: "cfg",
|
||||
key: "oidc.clientSecret",
|
||||
value: "enc:oidc-secret",
|
||||
encrypted: true,
|
||||
updatedAt: new Date(),
|
||||
});
|
||||
|
||||
await service.configureOidc("https://auth.example.com", "client-id", "client-secret");
|
||||
|
||||
expect(mockCryptoService.encrypt).toHaveBeenCalledWith("client-secret");
|
||||
expect(mockPrismaService.systemConfig.upsert).toHaveBeenCalledTimes(3);
|
||||
expect(mockPrismaService.systemConfig.upsert).toHaveBeenCalledWith({
|
||||
where: { key: "oidc.issuerUrl" },
|
||||
create: {
|
||||
key: "oidc.issuerUrl",
|
||||
value: "https://auth.example.com",
|
||||
encrypted: false,
|
||||
},
|
||||
update: {
|
||||
value: "https://auth.example.com",
|
||||
encrypted: false,
|
||||
},
|
||||
});
|
||||
expect(mockPrismaService.systemConfig.upsert).toHaveBeenCalledWith({
|
||||
where: { key: "oidc.clientId" },
|
||||
create: {
|
||||
key: "oidc.clientId",
|
||||
value: "client-id",
|
||||
encrypted: false,
|
||||
},
|
||||
update: {
|
||||
value: "client-id",
|
||||
encrypted: false,
|
||||
},
|
||||
});
|
||||
expect(mockPrismaService.systemConfig.upsert).toHaveBeenCalledWith({
|
||||
where: { key: "oidc.clientSecret" },
|
||||
create: {
|
||||
key: "oidc.clientSecret",
|
||||
value: "enc:oidc-secret",
|
||||
encrypted: true,
|
||||
},
|
||||
update: {
|
||||
value: "enc:oidc-secret",
|
||||
encrypted: true,
|
||||
},
|
||||
});
|
||||
});
|
||||
|
||||
it("addProvider encrypts apiKey and creates LlmProvider", async () => {
|
||||
mockCryptoService.encrypt.mockReturnValue("enc:api-key");
|
||||
mockPrismaService.llmProvider.create.mockResolvedValue({
|
||||
id: "provider-1",
|
||||
});
|
||||
|
||||
const result = await service.addProvider("breakglass-1", {
|
||||
name: "my-openai",
|
||||
displayName: "OpenAI",
|
||||
type: "openai",
|
||||
baseUrl: "https://api.openai.com/v1",
|
||||
apiKey: "sk-test",
|
||||
models: [{ id: "gpt-4o-mini", name: "GPT-4o Mini" }],
|
||||
});
|
||||
|
||||
expect(mockCryptoService.encrypt).toHaveBeenCalledWith("sk-test");
|
||||
expect(mockPrismaService.llmProvider.create).toHaveBeenCalledWith({
|
||||
data: {
|
||||
userId: "breakglass-1",
|
||||
name: "my-openai",
|
||||
displayName: "OpenAI",
|
||||
type: "openai",
|
||||
baseUrl: "https://api.openai.com/v1",
|
||||
apiKey: "enc:api-key",
|
||||
models: [{ id: "gpt-4o-mini", name: "GPT-4o Mini" }],
|
||||
},
|
||||
select: {
|
||||
id: true,
|
||||
},
|
||||
});
|
||||
expect(result).toEqual({ id: "provider-1" });
|
||||
});
|
||||
|
||||
it("complete sets SystemConfig flag", async () => {
|
||||
mockPrismaService.systemConfig.upsert.mockResolvedValue({
|
||||
id: "cfg-1",
|
||||
key: "onboarding.completed",
|
||||
value: "true",
|
||||
encrypted: false,
|
||||
updatedAt: new Date(),
|
||||
});
|
||||
|
||||
await service.complete();
|
||||
|
||||
expect(mockPrismaService.systemConfig.upsert).toHaveBeenCalledWith({
|
||||
where: { key: "onboarding.completed" },
|
||||
create: {
|
||||
key: "onboarding.completed",
|
||||
value: "true",
|
||||
encrypted: false,
|
||||
},
|
||||
update: {
|
||||
value: "true",
|
||||
encrypted: false,
|
||||
},
|
||||
});
|
||||
});
|
||||
});
|
||||
191
apps/api/src/onboarding/onboarding.service.ts
Normal file
191
apps/api/src/onboarding/onboarding.service.ts
Normal file
@@ -0,0 +1,191 @@
|
||||
import { BadRequestException, ConflictException, Injectable } from "@nestjs/common";
|
||||
import type { InputJsonValue } from "@prisma/client/runtime/library";
|
||||
import { hash } from "bcryptjs";
|
||||
import { PrismaService } from "../prisma/prisma.service";
|
||||
import { CryptoService } from "../crypto/crypto.service";
|
||||
|
||||
const BCRYPT_ROUNDS = 12;
|
||||
const TEST_PROVIDER_TIMEOUT_MS = 8000;
|
||||
|
||||
const ONBOARDING_COMPLETED_KEY = "onboarding.completed";
|
||||
const OIDC_ISSUER_URL_KEY = "oidc.issuerUrl";
|
||||
const OIDC_CLIENT_ID_KEY = "oidc.clientId";
|
||||
const OIDC_CLIENT_SECRET_KEY = "oidc.clientSecret";
|
||||
|
||||
interface ProviderModelInput {
|
||||
id: string;
|
||||
name?: string;
|
||||
}
|
||||
|
||||
interface AddProviderInput {
|
||||
name: string;
|
||||
displayName: string;
|
||||
type: string;
|
||||
baseUrl?: string;
|
||||
apiKey?: string;
|
||||
models?: ProviderModelInput[];
|
||||
}
|
||||
|
||||
@Injectable()
|
||||
export class OnboardingService {
|
||||
constructor(
|
||||
private readonly prisma: PrismaService,
|
||||
private readonly crypto: CryptoService
|
||||
) {}
|
||||
|
||||
// Check if onboarding is completed
|
||||
async isCompleted(): Promise<boolean> {
|
||||
const completedFlag = await this.prisma.systemConfig.findUnique({
|
||||
where: { key: ONBOARDING_COMPLETED_KEY },
|
||||
});
|
||||
|
||||
return completedFlag?.value === "true";
|
||||
}
|
||||
|
||||
// Step 1: Create breakglass admin user
|
||||
async createBreakglassUser(
|
||||
username: string,
|
||||
password: string
|
||||
): Promise<{ id: string; username: string }> {
|
||||
const breakglassCount = await this.prisma.breakglassUser.count();
|
||||
if (breakglassCount > 0) {
|
||||
throw new ConflictException("Breakglass user already exists");
|
||||
}
|
||||
|
||||
const passwordHash = await hash(password, BCRYPT_ROUNDS);
|
||||
|
||||
return this.prisma.breakglassUser.create({
|
||||
data: {
|
||||
username,
|
||||
passwordHash,
|
||||
},
|
||||
select: {
|
||||
id: true,
|
||||
username: true,
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
// Step 2: Configure OIDC provider (optional)
|
||||
async configureOidc(issuerUrl: string, clientId: string, clientSecret: string): Promise<void> {
|
||||
const encryptedSecret = this.crypto.encrypt(clientSecret);
|
||||
|
||||
await Promise.all([
|
||||
this.upsertSystemConfig(OIDC_ISSUER_URL_KEY, issuerUrl, false),
|
||||
this.upsertSystemConfig(OIDC_CLIENT_ID_KEY, clientId, false),
|
||||
this.upsertSystemConfig(OIDC_CLIENT_SECRET_KEY, encryptedSecret, true),
|
||||
]);
|
||||
}
|
||||
|
||||
// Step 3: Add first LLM provider
|
||||
async addProvider(userId: string, data: AddProviderInput): Promise<{ id: string }> {
|
||||
const encryptedApiKey = data.apiKey ? this.crypto.encrypt(data.apiKey) : undefined;
|
||||
|
||||
return this.prisma.llmProvider.create({
|
||||
data: {
|
||||
userId,
|
||||
name: data.name,
|
||||
displayName: data.displayName,
|
||||
type: data.type,
|
||||
baseUrl: data.baseUrl ?? null,
|
||||
apiKey: encryptedApiKey ?? null,
|
||||
models: (data.models ?? []) as unknown as InputJsonValue,
|
||||
},
|
||||
select: {
|
||||
id: true,
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
// Step 3b: Test LLM provider connection
|
||||
async testProvider(
|
||||
type: string,
|
||||
baseUrl?: string,
|
||||
apiKey?: string
|
||||
): Promise<{ success: boolean; error?: string }> {
|
||||
const normalizedType = type.trim().toLowerCase();
|
||||
if (!normalizedType) {
|
||||
return { success: false, error: "Provider type is required" };
|
||||
}
|
||||
|
||||
let probeUrl: string;
|
||||
try {
|
||||
probeUrl = this.buildProbeUrl(normalizedType, baseUrl);
|
||||
} catch (error: unknown) {
|
||||
const message = error instanceof Error ? error.message : String(error);
|
||||
return { success: false, error: message };
|
||||
}
|
||||
|
||||
const headers: Record<string, string> = {
|
||||
Accept: "application/json",
|
||||
};
|
||||
if (apiKey) {
|
||||
headers.Authorization = `Bearer ${apiKey}`;
|
||||
}
|
||||
|
||||
try {
|
||||
const response = await fetch(probeUrl, {
|
||||
method: "GET",
|
||||
headers,
|
||||
signal: AbortSignal.timeout(TEST_PROVIDER_TIMEOUT_MS),
|
||||
});
|
||||
|
||||
if (!response.ok) {
|
||||
return {
|
||||
success: false,
|
||||
error: `Provider returned ${String(response.status)} ${response.statusText}`.trim(),
|
||||
};
|
||||
}
|
||||
|
||||
return { success: true };
|
||||
} catch (error: unknown) {
|
||||
const message = error instanceof Error ? error.message : String(error);
|
||||
return { success: false, error: message };
|
||||
}
|
||||
}
|
||||
|
||||
// Step 4: Mark onboarding complete
|
||||
async complete(): Promise<void> {
|
||||
await this.upsertSystemConfig(ONBOARDING_COMPLETED_KEY, "true", false);
|
||||
}
|
||||
|
||||
async getBreakglassUserId(): Promise<string> {
|
||||
const user = await this.prisma.breakglassUser.findFirst({
|
||||
where: { isActive: true },
|
||||
orderBy: { createdAt: "asc" },
|
||||
select: { id: true },
|
||||
});
|
||||
|
||||
if (!user) {
|
||||
throw new BadRequestException("Create a breakglass user before adding a provider");
|
||||
}
|
||||
|
||||
return user.id;
|
||||
}
|
||||
|
||||
private async upsertSystemConfig(key: string, value: string, encrypted: boolean): Promise<void> {
|
||||
await this.prisma.systemConfig.upsert({
|
||||
where: { key },
|
||||
create: { key, value, encrypted },
|
||||
update: { value, encrypted },
|
||||
});
|
||||
}
|
||||
|
||||
private buildProbeUrl(type: string, baseUrl?: string): string {
|
||||
const resolvedBaseUrl = baseUrl ?? this.getDefaultProviderBaseUrl(type);
|
||||
const normalizedBaseUrl = resolvedBaseUrl.endsWith("/")
|
||||
? resolvedBaseUrl
|
||||
: `${resolvedBaseUrl}/`;
|
||||
const endpointPath = type === "ollama" ? "api/tags" : "models";
|
||||
|
||||
return new URL(endpointPath, normalizedBaseUrl).toString();
|
||||
}
|
||||
|
||||
private getDefaultProviderBaseUrl(type: string): string {
|
||||
if (type === "ollama") {
|
||||
return "http://localhost:11434";
|
||||
}
|
||||
|
||||
return "https://api.openai.com/v1";
|
||||
}
|
||||
}
|
||||
356
apps/web/src/app/(authenticated)/settings/agent-config/page.tsx
Normal file
356
apps/web/src/app/(authenticated)/settings/agent-config/page.tsx
Normal file
@@ -0,0 +1,356 @@
|
||||
"use client";
|
||||
|
||||
import {
|
||||
useCallback,
|
||||
useEffect,
|
||||
useMemo,
|
||||
useState,
|
||||
type ChangeEvent,
|
||||
type ReactElement,
|
||||
type SyntheticEvent,
|
||||
} from "react";
|
||||
import { FleetSettingsNav } from "@/components/settings/FleetSettingsNav";
|
||||
import { Badge } from "@/components/ui/badge";
|
||||
import { Button } from "@/components/ui/button";
|
||||
import { Card, CardContent, CardDescription, CardHeader, CardTitle } from "@/components/ui/card";
|
||||
import { Label } from "@/components/ui/label";
|
||||
import {
|
||||
Select,
|
||||
SelectContent,
|
||||
SelectItem,
|
||||
SelectTrigger,
|
||||
SelectValue,
|
||||
} from "@/components/ui/select";
|
||||
import { Textarea } from "@/components/ui/textarea";
|
||||
import {
|
||||
fetchFleetAgentConfig,
|
||||
fetchFleetProviders,
|
||||
updateFleetAgentConfig,
|
||||
type FleetProvider,
|
||||
type FleetProviderModel,
|
||||
type UpdateFleetAgentConfigRequest,
|
||||
} from "@/lib/api/fleet-settings";
|
||||
|
||||
function getErrorMessage(error: unknown, fallback: string): string {
|
||||
if (error instanceof Error && error.message.trim().length > 0) {
|
||||
return error.message;
|
||||
}
|
||||
|
||||
return fallback;
|
||||
}
|
||||
|
||||
function normalizeProviderModels(models: unknown): FleetProviderModel[] {
|
||||
if (!Array.isArray(models)) {
|
||||
return [];
|
||||
}
|
||||
|
||||
const parsed: FleetProviderModel[] = [];
|
||||
|
||||
models.forEach((entry) => {
|
||||
if (typeof entry === "string" && entry.trim().length > 0) {
|
||||
parsed.push({ id: entry.trim(), name: entry.trim() });
|
||||
return;
|
||||
}
|
||||
|
||||
if (entry && typeof entry === "object") {
|
||||
const record = entry as Record<string, unknown>;
|
||||
const id =
|
||||
typeof record.id === "string"
|
||||
? record.id.trim()
|
||||
: typeof record.name === "string"
|
||||
? record.name.trim()
|
||||
: "";
|
||||
|
||||
if (id.length > 0) {
|
||||
parsed.push({ id, name: id });
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
const seen = new Set<string>();
|
||||
return parsed.filter((model) => {
|
||||
if (seen.has(model.id)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
seen.add(model.id);
|
||||
return true;
|
||||
});
|
||||
}
|
||||
|
||||
function parseModelList(value: string): string[] {
|
||||
const seen = new Set<string>();
|
||||
|
||||
return value
|
||||
.split(/\n|,/g)
|
||||
.map((segment) => segment.trim())
|
||||
.filter((segment) => segment.length > 0)
|
||||
.filter((segment) => {
|
||||
if (seen.has(segment)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
seen.add(segment);
|
||||
return true;
|
||||
});
|
||||
}
|
||||
|
||||
function deriveAvailableModels(providers: FleetProvider[]): string[] {
|
||||
const seen = new Set<string>();
|
||||
const models: string[] = [];
|
||||
|
||||
providers.forEach((provider) => {
|
||||
normalizeProviderModels(provider.models).forEach((model) => {
|
||||
if (seen.has(model.id)) {
|
||||
return;
|
||||
}
|
||||
|
||||
seen.add(model.id);
|
||||
models.push(model.id);
|
||||
});
|
||||
});
|
||||
|
||||
return models.sort((left, right) => left.localeCompare(right));
|
||||
}
|
||||
|
||||
export default function AgentConfigSettingsPage(): ReactElement {
|
||||
const [providers, setProviders] = useState<FleetProvider[]>([]);
|
||||
const [primaryModel, setPrimaryModel] = useState<string>("");
|
||||
const [fallbackModelsText, setFallbackModelsText] = useState<string>("");
|
||||
const [personality, setPersonality] = useState<string>("");
|
||||
|
||||
const [isLoading, setIsLoading] = useState<boolean>(true);
|
||||
const [isSaving, setIsSaving] = useState<boolean>(false);
|
||||
const [error, setError] = useState<string | null>(null);
|
||||
const [successMessage, setSuccessMessage] = useState<string | null>(null);
|
||||
|
||||
const availableModels = useMemo(() => deriveAvailableModels(providers), [providers]);
|
||||
const fallbackModels = useMemo(() => parseModelList(fallbackModelsText), [fallbackModelsText]);
|
||||
|
||||
const modelSelectOptions = useMemo(() => {
|
||||
if (primaryModel.length > 0 && !availableModels.includes(primaryModel)) {
|
||||
return [primaryModel, ...availableModels];
|
||||
}
|
||||
|
||||
return availableModels;
|
||||
}, [availableModels, primaryModel]);
|
||||
|
||||
const loadSettings = useCallback(async (): Promise<void> => {
|
||||
setIsLoading(true);
|
||||
|
||||
try {
|
||||
const [providerData, agentConfig] = await Promise.all([
|
||||
fetchFleetProviders(),
|
||||
fetchFleetAgentConfig(),
|
||||
]);
|
||||
setProviders(providerData);
|
||||
setPrimaryModel(agentConfig.primaryModel ?? "");
|
||||
setFallbackModelsText(agentConfig.fallbackModels.join("\n"));
|
||||
setPersonality(agentConfig.personality ?? "");
|
||||
setError(null);
|
||||
} catch (loadError: unknown) {
|
||||
setError(getErrorMessage(loadError, "Failed to load agent configuration."));
|
||||
} finally {
|
||||
setIsLoading(false);
|
||||
}
|
||||
}, []);
|
||||
|
||||
useEffect(() => {
|
||||
void loadSettings();
|
||||
}, [loadSettings]);
|
||||
|
||||
function appendFallbackModel(model: string): void {
|
||||
const current = parseModelList(fallbackModelsText);
|
||||
if (current.includes(model)) {
|
||||
return;
|
||||
}
|
||||
|
||||
const next = [...current, model];
|
||||
setFallbackModelsText(next.join("\n"));
|
||||
}
|
||||
|
||||
async function handleSave(event: SyntheticEvent): Promise<void> {
|
||||
event.preventDefault();
|
||||
setError(null);
|
||||
setSuccessMessage(null);
|
||||
|
||||
const updatePayload: UpdateFleetAgentConfigRequest = {
|
||||
personality: personality.trim(),
|
||||
};
|
||||
|
||||
if (primaryModel.trim().length > 0) {
|
||||
updatePayload.primaryModel = primaryModel.trim();
|
||||
}
|
||||
|
||||
const parsedFallbacks = parseModelList(fallbackModelsText).filter(
|
||||
(model) => model !== primaryModel.trim()
|
||||
);
|
||||
if (parsedFallbacks.length > 0) {
|
||||
updatePayload.fallbackModels = parsedFallbacks;
|
||||
}
|
||||
|
||||
try {
|
||||
setIsSaving(true);
|
||||
await updateFleetAgentConfig(updatePayload);
|
||||
setSuccessMessage("Agent configuration saved.");
|
||||
await loadSettings();
|
||||
} catch (saveError: unknown) {
|
||||
setError(getErrorMessage(saveError, "Failed to save agent configuration."));
|
||||
} finally {
|
||||
setIsSaving(false);
|
||||
}
|
||||
}
|
||||
|
||||
return (
|
||||
<div className="max-w-6xl mx-auto p-6 space-y-6">
|
||||
<div className="space-y-4">
|
||||
<div>
|
||||
<h1 className="text-3xl font-bold">Agent Configuration</h1>
|
||||
<p className="text-muted-foreground mt-1">
|
||||
Assign primary and fallback models for your agent runtime behavior.
|
||||
</p>
|
||||
</div>
|
||||
<FleetSettingsNav />
|
||||
</div>
|
||||
|
||||
<Card>
|
||||
<CardHeader>
|
||||
<CardTitle>Current Assignment</CardTitle>
|
||||
<CardDescription>
|
||||
Snapshot of your currently saved model routing configuration.
|
||||
</CardDescription>
|
||||
</CardHeader>
|
||||
<CardContent className="space-y-4">
|
||||
{isLoading ? (
|
||||
<p className="text-sm text-muted-foreground">Loading configuration...</p>
|
||||
) : (
|
||||
<>
|
||||
<div>
|
||||
<p className="text-sm font-medium">Primary Model</p>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
{primaryModel.length > 0 ? primaryModel : "No primary model configured"}
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<p className="text-sm font-medium">Fallback Models</p>
|
||||
{fallbackModels.length === 0 ? (
|
||||
<p className="text-sm text-muted-foreground">No fallback models configured</p>
|
||||
) : (
|
||||
<div className="flex flex-wrap gap-2 mt-2">
|
||||
{fallbackModels.map((model) => (
|
||||
<Badge key={`current-${model}`} variant="outline">
|
||||
{model}
|
||||
</Badge>
|
||||
))}
|
||||
</div>
|
||||
)}
|
||||
</div>
|
||||
</>
|
||||
)}
|
||||
</CardContent>
|
||||
</Card>
|
||||
|
||||
<Card>
|
||||
<CardHeader>
|
||||
<CardTitle>Update Agent Config</CardTitle>
|
||||
<CardDescription>
|
||||
Select a primary model and define fallback ordering. Models come from your provider
|
||||
settings.
|
||||
</CardDescription>
|
||||
</CardHeader>
|
||||
<CardContent>
|
||||
<form onSubmit={(event) => void handleSave(event)} className="space-y-5">
|
||||
<div className="space-y-2">
|
||||
<Label htmlFor="primary-model">Primary Model</Label>
|
||||
<Select
|
||||
value={primaryModel.length > 0 ? primaryModel : "__none__"}
|
||||
onValueChange={(value) => {
|
||||
setPrimaryModel(value === "__none__" ? "" : value);
|
||||
}}
|
||||
disabled={isLoading || isSaving}
|
||||
>
|
||||
<SelectTrigger id="primary-model">
|
||||
<SelectValue placeholder="Select a primary model" />
|
||||
</SelectTrigger>
|
||||
<SelectContent>
|
||||
<SelectItem value="__none__">No primary model selected</SelectItem>
|
||||
{modelSelectOptions.map((model) => (
|
||||
<SelectItem key={model} value={model}>
|
||||
{model}
|
||||
</SelectItem>
|
||||
))}
|
||||
</SelectContent>
|
||||
</Select>
|
||||
{availableModels.length === 0 ? (
|
||||
<p className="text-xs text-muted-foreground">
|
||||
No models available yet. Add provider models first in Providers settings.
|
||||
</p>
|
||||
) : null}
|
||||
</div>
|
||||
|
||||
<div className="space-y-2">
|
||||
<Label htmlFor="fallback-models">Fallback Models</Label>
|
||||
<Textarea
|
||||
id="fallback-models"
|
||||
value={fallbackModelsText}
|
||||
onChange={(event: ChangeEvent<HTMLTextAreaElement>) => {
|
||||
setFallbackModelsText(event.target.value);
|
||||
}}
|
||||
rows={4}
|
||||
placeholder={"One model per line\nExample: gpt-4.1-mini"}
|
||||
disabled={isLoading || isSaving}
|
||||
/>
|
||||
{availableModels.length > 0 ? (
|
||||
<div className="flex flex-wrap gap-2">
|
||||
{availableModels
|
||||
.filter((model) => model !== primaryModel)
|
||||
.map((model) => (
|
||||
<Button
|
||||
key={`suggest-${model}`}
|
||||
type="button"
|
||||
variant="outline"
|
||||
size="sm"
|
||||
onClick={() => {
|
||||
appendFallbackModel(model);
|
||||
}}
|
||||
disabled={fallbackModels.includes(model) || isSaving}
|
||||
>
|
||||
{fallbackModels.includes(model) ? `Added: ${model}` : `Add ${model}`}
|
||||
</Button>
|
||||
))}
|
||||
</div>
|
||||
) : null}
|
||||
</div>
|
||||
|
||||
<div className="space-y-2">
|
||||
<Label htmlFor="agent-personality">Personality / SOUL</Label>
|
||||
<Textarea
|
||||
id="agent-personality"
|
||||
value={personality}
|
||||
onChange={(event: ChangeEvent<HTMLTextAreaElement>) => {
|
||||
setPersonality(event.target.value);
|
||||
}}
|
||||
rows={8}
|
||||
placeholder="Optional system personality instructions..."
|
||||
disabled={isLoading || isSaving}
|
||||
/>
|
||||
</div>
|
||||
|
||||
{error ? (
|
||||
<p className="text-sm text-destructive" role="alert">
|
||||
{error}
|
||||
</p>
|
||||
) : null}
|
||||
|
||||
{successMessage ? <p className="text-sm text-emerald-600">{successMessage}</p> : null}
|
||||
|
||||
<Button type="submit" disabled={isLoading || isSaving}>
|
||||
{isSaving ? "Saving..." : "Save Agent Config"}
|
||||
</Button>
|
||||
</form>
|
||||
</CardContent>
|
||||
</Card>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
492
apps/web/src/app/(authenticated)/settings/auth/page.tsx
Normal file
492
apps/web/src/app/(authenticated)/settings/auth/page.tsx
Normal file
@@ -0,0 +1,492 @@
|
||||
"use client";
|
||||
|
||||
import {
|
||||
useCallback,
|
||||
useEffect,
|
||||
useState,
|
||||
type ChangeEvent,
|
||||
type ReactElement,
|
||||
type SyntheticEvent,
|
||||
} from "react";
|
||||
import { FleetSettingsNav } from "@/components/settings/FleetSettingsNav";
|
||||
import { SettingsAccessDenied } from "@/components/settings/SettingsAccessDenied";
|
||||
import { Badge } from "@/components/ui/badge";
|
||||
import { Button } from "@/components/ui/button";
|
||||
import { Card, CardContent, CardDescription, CardHeader, CardTitle } from "@/components/ui/card";
|
||||
import {
|
||||
AlertDialog,
|
||||
AlertDialogAction,
|
||||
AlertDialogCancel,
|
||||
AlertDialogContent,
|
||||
AlertDialogDescription,
|
||||
AlertDialogFooter,
|
||||
AlertDialogHeader,
|
||||
AlertDialogTitle,
|
||||
} from "@/components/ui/alert-dialog";
|
||||
import { Input } from "@/components/ui/input";
|
||||
import { Label } from "@/components/ui/label";
|
||||
import {
|
||||
deleteFleetOidcConfig,
|
||||
fetchFleetOidcConfig,
|
||||
resetBreakglassAdminPassword,
|
||||
updateFleetOidcConfig,
|
||||
type FleetOidcConfig,
|
||||
} from "@/lib/api/fleet-settings";
|
||||
import { fetchOnboardingStatus } from "@/lib/api/onboarding";
|
||||
|
||||
interface OidcFormState {
|
||||
issuerUrl: string;
|
||||
clientId: string;
|
||||
clientSecret: string;
|
||||
}
|
||||
|
||||
interface BreakglassFormState {
|
||||
username: string;
|
||||
currentPassword: string;
|
||||
newPassword: string;
|
||||
confirmPassword: string;
|
||||
}
|
||||
|
||||
const INITIAL_OIDC_FORM: OidcFormState = {
|
||||
issuerUrl: "",
|
||||
clientId: "",
|
||||
clientSecret: "",
|
||||
};
|
||||
|
||||
const INITIAL_BREAKGLASS_FORM: BreakglassFormState = {
|
||||
username: "",
|
||||
currentPassword: "",
|
||||
newPassword: "",
|
||||
confirmPassword: "",
|
||||
};
|
||||
|
||||
function getErrorMessage(error: unknown, fallback: string): string {
|
||||
if (error instanceof Error && error.message.trim().length > 0) {
|
||||
return error.message;
|
||||
}
|
||||
|
||||
return fallback;
|
||||
}
|
||||
|
||||
function isAdminGuardError(error: unknown): boolean {
|
||||
if (!(error instanceof Error)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const normalized = error.message.toLowerCase();
|
||||
return (
|
||||
normalized.includes("requires system administrator") ||
|
||||
normalized.includes("forbidden") ||
|
||||
normalized.includes("403")
|
||||
);
|
||||
}
|
||||
|
||||
export default function AuthSettingsPage(): ReactElement {
|
||||
const [oidcConfig, setOidcConfig] = useState<FleetOidcConfig | null>(null);
|
||||
const [oidcForm, setOidcForm] = useState<OidcFormState>(INITIAL_OIDC_FORM);
|
||||
const [isLoading, setIsLoading] = useState<boolean>(true);
|
||||
const [isSavingOidc, setIsSavingOidc] = useState<boolean>(false);
|
||||
const [isDeletingOidc, setIsDeletingOidc] = useState<boolean>(false);
|
||||
const [oidcError, setOidcError] = useState<string | null>(null);
|
||||
const [oidcSuccessMessage, setOidcSuccessMessage] = useState<string | null>(null);
|
||||
const [showRemoveOidcDialog, setShowRemoveOidcDialog] = useState<boolean>(false);
|
||||
|
||||
const [breakglassForm, setBreakglassForm] =
|
||||
useState<BreakglassFormState>(INITIAL_BREAKGLASS_FORM);
|
||||
const [breakglassStatus, setBreakglassStatus] = useState<"active" | "inactive">("inactive");
|
||||
const [isResettingPassword, setIsResettingPassword] = useState<boolean>(false);
|
||||
const [breakglassError, setBreakglassError] = useState<string | null>(null);
|
||||
const [breakglassSuccessMessage, setBreakglassSuccessMessage] = useState<string | null>(null);
|
||||
|
||||
const [isAccessDenied, setIsAccessDenied] = useState<boolean>(false);
|
||||
|
||||
const loadAuthSettings = useCallback(async (): Promise<void> => {
|
||||
setIsLoading(true);
|
||||
|
||||
try {
|
||||
const [oidcResponse, onboardingStatus] = await Promise.all([
|
||||
fetchFleetOidcConfig(),
|
||||
fetchOnboardingStatus().catch(() => ({ completed: false })),
|
||||
]);
|
||||
|
||||
setOidcConfig(oidcResponse);
|
||||
setOidcForm({
|
||||
issuerUrl: oidcResponse.issuerUrl ?? "",
|
||||
clientId: oidcResponse.clientId ?? "",
|
||||
clientSecret: "",
|
||||
});
|
||||
setBreakglassStatus(onboardingStatus.completed ? "active" : "inactive");
|
||||
setIsAccessDenied(false);
|
||||
setOidcError(null);
|
||||
} catch (loadError: unknown) {
|
||||
if (isAdminGuardError(loadError)) {
|
||||
setIsAccessDenied(true);
|
||||
return;
|
||||
}
|
||||
|
||||
setOidcError(getErrorMessage(loadError, "Failed to load authentication settings."));
|
||||
} finally {
|
||||
setIsLoading(false);
|
||||
}
|
||||
}, []);
|
||||
|
||||
useEffect(() => {
|
||||
void loadAuthSettings();
|
||||
}, [loadAuthSettings]);
|
||||
|
||||
async function handleSaveOidc(event: SyntheticEvent): Promise<void> {
|
||||
event.preventDefault();
|
||||
setOidcError(null);
|
||||
setOidcSuccessMessage(null);
|
||||
|
||||
const issuerUrl = oidcForm.issuerUrl.trim();
|
||||
const clientId = oidcForm.clientId.trim();
|
||||
const clientSecret = oidcForm.clientSecret.trim();
|
||||
|
||||
if (issuerUrl.length === 0 || clientId.length === 0 || clientSecret.length === 0) {
|
||||
setOidcError("Issuer URL, client ID, and client secret are required.");
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
setIsSavingOidc(true);
|
||||
await updateFleetOidcConfig({
|
||||
issuerUrl,
|
||||
clientId,
|
||||
clientSecret,
|
||||
});
|
||||
setOidcSuccessMessage("OIDC configuration updated.");
|
||||
await loadAuthSettings();
|
||||
} catch (saveError: unknown) {
|
||||
setOidcError(getErrorMessage(saveError, "Failed to update OIDC configuration."));
|
||||
} finally {
|
||||
setIsSavingOidc(false);
|
||||
}
|
||||
}
|
||||
|
||||
async function handleRemoveOidc(): Promise<void> {
|
||||
try {
|
||||
setIsDeletingOidc(true);
|
||||
await deleteFleetOidcConfig();
|
||||
setOidcSuccessMessage("OIDC configuration removed.");
|
||||
setShowRemoveOidcDialog(false);
|
||||
await loadAuthSettings();
|
||||
} catch (deleteError: unknown) {
|
||||
setOidcError(getErrorMessage(deleteError, "Failed to remove OIDC configuration."));
|
||||
} finally {
|
||||
setIsDeletingOidc(false);
|
||||
}
|
||||
}
|
||||
|
||||
async function handleResetBreakglassPassword(event: SyntheticEvent): Promise<void> {
|
||||
event.preventDefault();
|
||||
setBreakglassError(null);
|
||||
setBreakglassSuccessMessage(null);
|
||||
|
||||
const username = breakglassForm.username.trim();
|
||||
const newPassword = breakglassForm.newPassword;
|
||||
const confirmPassword = breakglassForm.confirmPassword;
|
||||
|
||||
if (username.length === 0) {
|
||||
setBreakglassError("Username is required.");
|
||||
return;
|
||||
}
|
||||
|
||||
if (newPassword.length < 8) {
|
||||
setBreakglassError("New password must be at least 8 characters.");
|
||||
return;
|
||||
}
|
||||
|
||||
if (newPassword !== confirmPassword) {
|
||||
setBreakglassError("Password confirmation does not match.");
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
setIsResettingPassword(true);
|
||||
await resetBreakglassAdminPassword({
|
||||
username,
|
||||
newPassword,
|
||||
});
|
||||
setBreakglassSuccessMessage(`Password reset for "${username}".`);
|
||||
setBreakglassStatus("active");
|
||||
setBreakglassForm((previous) => ({
|
||||
...previous,
|
||||
currentPassword: "",
|
||||
newPassword: "",
|
||||
confirmPassword: "",
|
||||
}));
|
||||
} catch (resetError: unknown) {
|
||||
setBreakglassError(getErrorMessage(resetError, "Failed to reset breakglass password."));
|
||||
} finally {
|
||||
setIsResettingPassword(false);
|
||||
}
|
||||
}
|
||||
|
||||
return (
|
||||
<div className="max-w-6xl mx-auto p-6 space-y-6">
|
||||
<div className="space-y-4">
|
||||
<div>
|
||||
<h1 className="text-3xl font-bold">Authentication Settings</h1>
|
||||
<p className="text-muted-foreground mt-1">
|
||||
Configure OIDC and breakglass admin recovery credentials.
|
||||
</p>
|
||||
</div>
|
||||
<FleetSettingsNav />
|
||||
</div>
|
||||
|
||||
{isLoading ? (
|
||||
<Card>
|
||||
<CardContent className="py-8 text-sm text-muted-foreground">
|
||||
Loading authentication settings...
|
||||
</CardContent>
|
||||
</Card>
|
||||
) : null}
|
||||
|
||||
{!isLoading && isAccessDenied ? (
|
||||
<SettingsAccessDenied message="Authentication settings require system administrator privileges." />
|
||||
) : null}
|
||||
|
||||
{!isLoading && !isAccessDenied ? (
|
||||
<>
|
||||
<Card>
|
||||
<CardHeader>
|
||||
<CardTitle>OIDC Provider</CardTitle>
|
||||
<CardDescription>
|
||||
Manage your OpenID Connect issuer and OAuth client credentials.
|
||||
</CardDescription>
|
||||
</CardHeader>
|
||||
<CardContent className="space-y-5">
|
||||
<div className="rounded-lg border p-4 space-y-2">
|
||||
<div className="flex items-center gap-2">
|
||||
<p className="font-medium">Configured</p>
|
||||
<Badge variant={oidcConfig?.configured ? "default" : "secondary"}>
|
||||
{oidcConfig?.configured ? "Yes" : "No"}
|
||||
</Badge>
|
||||
</div>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
Issuer URL: {oidcConfig?.issuerUrl ?? "Not configured"}
|
||||
</p>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
Client ID: {oidcConfig?.clientId ?? "Not configured"}
|
||||
</p>
|
||||
<p className="text-sm text-muted-foreground">Client secret: hidden</p>
|
||||
</div>
|
||||
|
||||
<form onSubmit={(event) => void handleSaveOidc(event)} className="space-y-4">
|
||||
<div className="space-y-2">
|
||||
<Label htmlFor="oidc-issuer-url">Issuer URL</Label>
|
||||
<Input
|
||||
id="oidc-issuer-url"
|
||||
value={oidcForm.issuerUrl}
|
||||
onChange={(event: ChangeEvent<HTMLInputElement>) => {
|
||||
setOidcForm((previous) => ({ ...previous, issuerUrl: event.target.value }));
|
||||
}}
|
||||
placeholder="https://issuer.example.com"
|
||||
disabled={isSavingOidc}
|
||||
required
|
||||
/>
|
||||
</div>
|
||||
|
||||
<div className="space-y-2">
|
||||
<Label htmlFor="oidc-client-id">Client ID</Label>
|
||||
<Input
|
||||
id="oidc-client-id"
|
||||
value={oidcForm.clientId}
|
||||
onChange={(event: ChangeEvent<HTMLInputElement>) => {
|
||||
setOidcForm((previous) => ({ ...previous, clientId: event.target.value }));
|
||||
}}
|
||||
placeholder="mosaic-web"
|
||||
disabled={isSavingOidc}
|
||||
required
|
||||
/>
|
||||
</div>
|
||||
|
||||
<div className="space-y-2">
|
||||
<Label htmlFor="oidc-client-secret">Client Secret</Label>
|
||||
<Input
|
||||
id="oidc-client-secret"
|
||||
type="password"
|
||||
value={oidcForm.clientSecret}
|
||||
onChange={(event: ChangeEvent<HTMLInputElement>) => {
|
||||
setOidcForm((previous) => ({
|
||||
...previous,
|
||||
clientSecret: event.target.value,
|
||||
}));
|
||||
}}
|
||||
placeholder="Enter new secret"
|
||||
autoComplete="new-password"
|
||||
disabled={isSavingOidc}
|
||||
required
|
||||
/>
|
||||
<p className="text-xs text-muted-foreground">
|
||||
The secret is encrypted on save and never returned to the UI.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
{oidcError ? (
|
||||
<p className="text-sm text-destructive" role="alert">
|
||||
{oidcError}
|
||||
</p>
|
||||
) : null}
|
||||
|
||||
{oidcSuccessMessage ? (
|
||||
<p className="text-sm text-emerald-600">{oidcSuccessMessage}</p>
|
||||
) : null}
|
||||
|
||||
<div className="flex items-center gap-2">
|
||||
<Button type="submit" disabled={isSavingOidc}>
|
||||
{isSavingOidc ? "Saving..." : "Save OIDC"}
|
||||
</Button>
|
||||
<Button
|
||||
type="button"
|
||||
variant="destructive"
|
||||
onClick={() => {
|
||||
setShowRemoveOidcDialog(true);
|
||||
}}
|
||||
disabled={isDeletingOidc || !oidcConfig?.configured}
|
||||
>
|
||||
Remove OIDC
|
||||
</Button>
|
||||
</div>
|
||||
</form>
|
||||
</CardContent>
|
||||
</Card>
|
||||
|
||||
<Card>
|
||||
<CardHeader>
|
||||
<CardTitle>Breakglass Admin</CardTitle>
|
||||
<CardDescription>
|
||||
Reset breakglass credentials for emergency local access.
|
||||
</CardDescription>
|
||||
</CardHeader>
|
||||
<CardContent className="space-y-5">
|
||||
<div className="flex items-center gap-2">
|
||||
<p className="font-medium">Status</p>
|
||||
<Badge variant={breakglassStatus === "active" ? "default" : "secondary"}>
|
||||
{breakglassStatus}
|
||||
</Badge>
|
||||
</div>
|
||||
|
||||
<form
|
||||
onSubmit={(event) => void handleResetBreakglassPassword(event)}
|
||||
className="space-y-4"
|
||||
>
|
||||
<div className="space-y-2">
|
||||
<Label htmlFor="breakglass-username">Username</Label>
|
||||
<Input
|
||||
id="breakglass-username"
|
||||
value={breakglassForm.username}
|
||||
onChange={(event: ChangeEvent<HTMLInputElement>) => {
|
||||
setBreakglassForm((previous) => ({
|
||||
...previous,
|
||||
username: event.target.value,
|
||||
}));
|
||||
}}
|
||||
placeholder="admin"
|
||||
disabled={isResettingPassword}
|
||||
required
|
||||
/>
|
||||
</div>
|
||||
|
||||
<div className="space-y-2">
|
||||
<Label htmlFor="breakglass-current-password">Current Password (optional)</Label>
|
||||
<Input
|
||||
id="breakglass-current-password"
|
||||
type="password"
|
||||
value={breakglassForm.currentPassword}
|
||||
onChange={(event: ChangeEvent<HTMLInputElement>) => {
|
||||
setBreakglassForm((previous) => ({
|
||||
...previous,
|
||||
currentPassword: event.target.value,
|
||||
}));
|
||||
}}
|
||||
placeholder="Optional operator confirmation"
|
||||
autoComplete="current-password"
|
||||
disabled={isResettingPassword}
|
||||
/>
|
||||
</div>
|
||||
|
||||
<div className="space-y-2">
|
||||
<Label htmlFor="breakglass-new-password">New Password</Label>
|
||||
<Input
|
||||
id="breakglass-new-password"
|
||||
type="password"
|
||||
value={breakglassForm.newPassword}
|
||||
onChange={(event: ChangeEvent<HTMLInputElement>) => {
|
||||
setBreakglassForm((previous) => ({
|
||||
...previous,
|
||||
newPassword: event.target.value,
|
||||
}));
|
||||
}}
|
||||
placeholder="At least 8 characters"
|
||||
autoComplete="new-password"
|
||||
disabled={isResettingPassword}
|
||||
required
|
||||
/>
|
||||
</div>
|
||||
|
||||
<div className="space-y-2">
|
||||
<Label htmlFor="breakglass-confirm-password">Confirm Password</Label>
|
||||
<Input
|
||||
id="breakglass-confirm-password"
|
||||
type="password"
|
||||
value={breakglassForm.confirmPassword}
|
||||
onChange={(event: ChangeEvent<HTMLInputElement>) => {
|
||||
setBreakglassForm((previous) => ({
|
||||
...previous,
|
||||
confirmPassword: event.target.value,
|
||||
}));
|
||||
}}
|
||||
placeholder="Re-enter password"
|
||||
autoComplete="new-password"
|
||||
disabled={isResettingPassword}
|
||||
required
|
||||
/>
|
||||
</div>
|
||||
|
||||
{breakglassError ? (
|
||||
<p className="text-sm text-destructive" role="alert">
|
||||
{breakglassError}
|
||||
</p>
|
||||
) : null}
|
||||
|
||||
{breakglassSuccessMessage ? (
|
||||
<p className="text-sm text-emerald-600">{breakglassSuccessMessage}</p>
|
||||
) : null}
|
||||
|
||||
<Button type="submit" disabled={isResettingPassword}>
|
||||
{isResettingPassword ? "Resetting..." : "Reset Password"}
|
||||
</Button>
|
||||
</form>
|
||||
</CardContent>
|
||||
</Card>
|
||||
</>
|
||||
) : null}
|
||||
|
||||
<AlertDialog
|
||||
open={showRemoveOidcDialog}
|
||||
onOpenChange={(open) => {
|
||||
if (!open && !isDeletingOidc) {
|
||||
setShowRemoveOidcDialog(false);
|
||||
}
|
||||
}}
|
||||
>
|
||||
<AlertDialogContent>
|
||||
<AlertDialogHeader>
|
||||
<AlertDialogTitle>Remove OIDC Configuration</AlertDialogTitle>
|
||||
<AlertDialogDescription>
|
||||
This will remove issuer URL, client ID, and client secret from system configuration.
|
||||
</AlertDialogDescription>
|
||||
</AlertDialogHeader>
|
||||
<AlertDialogFooter>
|
||||
<AlertDialogCancel disabled={isDeletingOidc}>Cancel</AlertDialogCancel>
|
||||
<AlertDialogAction onClick={handleRemoveOidc} disabled={isDeletingOidc}>
|
||||
{isDeletingOidc ? "Removing..." : "Remove OIDC"}
|
||||
</AlertDialogAction>
|
||||
</AlertDialogFooter>
|
||||
</AlertDialogContent>
|
||||
</AlertDialog>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
@@ -200,6 +200,82 @@ const categories: CategoryConfig[] = [
|
||||
</svg>
|
||||
),
|
||||
},
|
||||
{
|
||||
title: "LLM Providers",
|
||||
description:
|
||||
"Add and manage LLM providers, encrypted API keys, base URLs, and model inventories.",
|
||||
href: "/settings/providers",
|
||||
accent: "var(--ms-blue-400)",
|
||||
iconBg: "rgba(47, 128, 255, 0.12)",
|
||||
icon: (
|
||||
<svg
|
||||
width="20"
|
||||
height="20"
|
||||
viewBox="0 0 20 20"
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
strokeWidth="1.5"
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
aria-hidden="true"
|
||||
>
|
||||
<rect x="2.5" y="4" width="15" height="12" rx="2" />
|
||||
<path d="M2.5 8h15" />
|
||||
<circle cx="6" cy="12" r="1" />
|
||||
<circle cx="10" cy="12" r="1" />
|
||||
<circle cx="14" cy="12" r="1" />
|
||||
</svg>
|
||||
),
|
||||
},
|
||||
{
|
||||
title: "Agent Config",
|
||||
description: "Choose primary and fallback models, plus optional personality/SOUL instructions.",
|
||||
href: "/settings/agent-config",
|
||||
accent: "var(--ms-teal-400)",
|
||||
iconBg: "rgba(20, 184, 166, 0.12)",
|
||||
icon: (
|
||||
<svg
|
||||
width="20"
|
||||
height="20"
|
||||
viewBox="0 0 20 20"
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
strokeWidth="1.5"
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
aria-hidden="true"
|
||||
>
|
||||
<path d="M4 5h12" />
|
||||
<path d="M4 10h12" />
|
||||
<path d="M4 15h7" />
|
||||
<circle cx="14.5" cy="15" r="1.5" />
|
||||
</svg>
|
||||
),
|
||||
},
|
||||
{
|
||||
title: "Authentication",
|
||||
description: "Manage OIDC provider settings and breakglass admin password recovery.",
|
||||
href: "/settings/auth",
|
||||
accent: "var(--ms-amber-400)",
|
||||
iconBg: "rgba(245, 158, 11, 0.12)",
|
||||
icon: (
|
||||
<svg
|
||||
width="20"
|
||||
height="20"
|
||||
viewBox="0 0 20 20"
|
||||
fill="none"
|
||||
stroke="currentColor"
|
||||
strokeWidth="1.5"
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
aria-hidden="true"
|
||||
>
|
||||
<rect x="5" y="8" width="10" height="8" rx="1.5" />
|
||||
<path d="M7 8V6a3 3 0 0 1 6 0v2" />
|
||||
<circle cx="10" cy="12" r="1" />
|
||||
</svg>
|
||||
),
|
||||
},
|
||||
{
|
||||
title: "Users",
|
||||
description: "Invite, manage roles, and deactivate users across your workspaces.",
|
||||
|
||||
631
apps/web/src/app/(authenticated)/settings/providers/page.tsx
Normal file
631
apps/web/src/app/(authenticated)/settings/providers/page.tsx
Normal file
@@ -0,0 +1,631 @@
|
||||
"use client";
|
||||
|
||||
import {
|
||||
useCallback,
|
||||
useEffect,
|
||||
useMemo,
|
||||
useState,
|
||||
type ChangeEvent,
|
||||
type ReactElement,
|
||||
type SyntheticEvent,
|
||||
} from "react";
|
||||
import { Settings, Trash2 } from "lucide-react";
|
||||
import { FleetSettingsNav } from "@/components/settings/FleetSettingsNav";
|
||||
import { Badge } from "@/components/ui/badge";
|
||||
import { Button } from "@/components/ui/button";
|
||||
import { Card, CardContent, CardDescription, CardHeader, CardTitle } from "@/components/ui/card";
|
||||
import {
|
||||
AlertDialog,
|
||||
AlertDialogAction,
|
||||
AlertDialogCancel,
|
||||
AlertDialogContent,
|
||||
AlertDialogDescription,
|
||||
AlertDialogFooter,
|
||||
AlertDialogHeader,
|
||||
AlertDialogTitle,
|
||||
} from "@/components/ui/alert-dialog";
|
||||
import {
|
||||
Dialog,
|
||||
DialogContent,
|
||||
DialogDescription,
|
||||
DialogFooter,
|
||||
DialogHeader,
|
||||
DialogTitle,
|
||||
} from "@/components/ui/dialog";
|
||||
import { Input } from "@/components/ui/input";
|
||||
import { Label } from "@/components/ui/label";
|
||||
import {
|
||||
Select,
|
||||
SelectContent,
|
||||
SelectItem,
|
||||
SelectTrigger,
|
||||
SelectValue,
|
||||
} from "@/components/ui/select";
|
||||
import { Switch } from "@/components/ui/switch";
|
||||
import { Textarea } from "@/components/ui/textarea";
|
||||
import {
|
||||
createFleetProvider,
|
||||
deleteFleetProvider,
|
||||
fetchFleetProviders,
|
||||
updateFleetProvider,
|
||||
type CreateFleetProviderRequest,
|
||||
type FleetProvider,
|
||||
type FleetProviderModel,
|
||||
type UpdateFleetProviderRequest,
|
||||
} from "@/lib/api/fleet-settings";
|
||||
|
||||
interface ProviderTypeOption {
|
||||
value: string;
|
||||
label: string;
|
||||
}
|
||||
|
||||
interface ProviderFormState {
|
||||
type: string;
|
||||
displayName: string;
|
||||
apiKey: string;
|
||||
baseUrl: string;
|
||||
modelsText: string;
|
||||
isActive: boolean;
|
||||
}
|
||||
|
||||
const PROVIDER_TYPE_OPTIONS: ProviderTypeOption[] = [
|
||||
{ value: "openai", label: "OpenAI Compatible" },
|
||||
{ value: "claude", label: "Claude / Anthropic" },
|
||||
{ value: "ollama", label: "Ollama" },
|
||||
{ value: "zai", label: "Z.ai" },
|
||||
{ value: "custom", label: "Custom" },
|
||||
];
|
||||
|
||||
const INITIAL_FORM: ProviderFormState = {
|
||||
type: "openai",
|
||||
displayName: "",
|
||||
apiKey: "",
|
||||
baseUrl: "",
|
||||
modelsText: "",
|
||||
isActive: true,
|
||||
};
|
||||
|
||||
function getErrorMessage(error: unknown, fallback: string): string {
|
||||
if (error instanceof Error && error.message.trim().length > 0) {
|
||||
return error.message;
|
||||
}
|
||||
|
||||
return fallback;
|
||||
}
|
||||
|
||||
function buildProviderName(displayName: string, type: string): string {
|
||||
const slug = displayName
|
||||
.trim()
|
||||
.toLowerCase()
|
||||
.replace(/[^a-z0-9]+/g, "-")
|
||||
.replace(/^-+/, "")
|
||||
.replace(/-+$/, "");
|
||||
|
||||
const candidate = `${type}-${slug.length > 0 ? slug : "provider"}`;
|
||||
return candidate.slice(0, 100);
|
||||
}
|
||||
|
||||
function normalizeProviderModels(models: unknown): FleetProviderModel[] {
|
||||
if (!Array.isArray(models)) {
|
||||
return [];
|
||||
}
|
||||
|
||||
const normalized: FleetProviderModel[] = [];
|
||||
|
||||
models.forEach((entry) => {
|
||||
if (typeof entry === "string" && entry.trim().length > 0) {
|
||||
normalized.push({ id: entry.trim(), name: entry.trim() });
|
||||
return;
|
||||
}
|
||||
|
||||
if (entry && typeof entry === "object") {
|
||||
const record = entry as Record<string, unknown>;
|
||||
const id =
|
||||
typeof record.id === "string"
|
||||
? record.id.trim()
|
||||
: typeof record.name === "string"
|
||||
? record.name.trim()
|
||||
: "";
|
||||
|
||||
if (id.length > 0) {
|
||||
const name =
|
||||
typeof record.name === "string" && record.name.trim().length > 0
|
||||
? record.name.trim()
|
||||
: id;
|
||||
normalized.push({ id, name });
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
const seen = new Set<string>();
|
||||
return normalized.filter((model) => {
|
||||
if (seen.has(model.id)) {
|
||||
return false;
|
||||
}
|
||||
seen.add(model.id);
|
||||
return true;
|
||||
});
|
||||
}
|
||||
|
||||
function modelsToEditorText(models: unknown): string {
|
||||
return normalizeProviderModels(models)
|
||||
.map((model) => model.id)
|
||||
.join("\n");
|
||||
}
|
||||
|
||||
function parseModelsText(value: string): FleetProviderModel[] {
|
||||
const seen = new Set<string>();
|
||||
|
||||
return value
|
||||
.split(/\n|,/g)
|
||||
.map((segment) => segment.trim())
|
||||
.filter((segment) => segment.length > 0)
|
||||
.filter((segment) => {
|
||||
if (seen.has(segment)) {
|
||||
return false;
|
||||
}
|
||||
seen.add(segment);
|
||||
return true;
|
||||
})
|
||||
.map((id) => ({ id, name: id }));
|
||||
}
|
||||
|
||||
function maskApiKey(value: string): string {
|
||||
if (value.length === 0) {
|
||||
return "Not set";
|
||||
}
|
||||
|
||||
if (value.length <= 7) {
|
||||
return "*".repeat(Math.max(4, value.length));
|
||||
}
|
||||
|
||||
return `${value.slice(0, 3)}****...${value.slice(-4)}`;
|
||||
}
|
||||
|
||||
export default function ProvidersSettingsPage(): ReactElement {
|
||||
const [providers, setProviders] = useState<FleetProvider[]>([]);
|
||||
const [isLoading, setIsLoading] = useState<boolean>(true);
|
||||
const [isRefreshing, setIsRefreshing] = useState<boolean>(false);
|
||||
const [error, setError] = useState<string | null>(null);
|
||||
const [successMessage, setSuccessMessage] = useState<string | null>(null);
|
||||
|
||||
const [isDialogOpen, setIsDialogOpen] = useState<boolean>(false);
|
||||
const [editingProvider, setEditingProvider] = useState<FleetProvider | null>(null);
|
||||
const [form, setForm] = useState<ProviderFormState>(INITIAL_FORM);
|
||||
const [formError, setFormError] = useState<string | null>(null);
|
||||
const [isSaving, setIsSaving] = useState<boolean>(false);
|
||||
|
||||
const [deleteTarget, setDeleteTarget] = useState<FleetProvider | null>(null);
|
||||
const [isDeleting, setIsDeleting] = useState<boolean>(false);
|
||||
|
||||
const loadProviders = useCallback(async (showLoadingState: boolean): Promise<void> => {
|
||||
if (showLoadingState) {
|
||||
setIsLoading(true);
|
||||
} else {
|
||||
setIsRefreshing(true);
|
||||
}
|
||||
|
||||
try {
|
||||
const data = await fetchFleetProviders();
|
||||
setProviders(data);
|
||||
setError(null);
|
||||
} catch (loadError: unknown) {
|
||||
setError(getErrorMessage(loadError, "Failed to load providers."));
|
||||
} finally {
|
||||
setIsLoading(false);
|
||||
setIsRefreshing(false);
|
||||
}
|
||||
}, []);
|
||||
|
||||
useEffect(() => {
|
||||
void loadProviders(true);
|
||||
}, [loadProviders]);
|
||||
|
||||
const apiKeyHint = useMemo(() => {
|
||||
const enteredKey = form.apiKey.trim();
|
||||
|
||||
if (enteredKey.length > 0) {
|
||||
return `Masked preview: ${maskApiKey(enteredKey)}`;
|
||||
}
|
||||
|
||||
if (editingProvider) {
|
||||
return "Stored API key remains encrypted and hidden. Enter a new key only when rotating.";
|
||||
}
|
||||
|
||||
return "API keys are never shown decrypted. Only masked previews are displayed while typing.";
|
||||
}, [editingProvider, form.apiKey]);
|
||||
|
||||
function openCreateDialog(): void {
|
||||
setEditingProvider(null);
|
||||
setForm(INITIAL_FORM);
|
||||
setFormError(null);
|
||||
setIsDialogOpen(true);
|
||||
}
|
||||
|
||||
function openEditDialog(provider: FleetProvider): void {
|
||||
setEditingProvider(provider);
|
||||
setForm({
|
||||
type: provider.type,
|
||||
displayName: provider.displayName,
|
||||
apiKey: "",
|
||||
baseUrl: provider.baseUrl ?? "",
|
||||
modelsText: modelsToEditorText(provider.models),
|
||||
isActive: provider.isActive,
|
||||
});
|
||||
setFormError(null);
|
||||
setIsDialogOpen(true);
|
||||
}
|
||||
|
||||
function closeDialog(): void {
|
||||
if (isSaving) {
|
||||
return;
|
||||
}
|
||||
|
||||
setIsDialogOpen(false);
|
||||
setEditingProvider(null);
|
||||
setForm(INITIAL_FORM);
|
||||
setFormError(null);
|
||||
}
|
||||
|
||||
async function handleSubmit(event: SyntheticEvent): Promise<void> {
|
||||
event.preventDefault();
|
||||
setFormError(null);
|
||||
setSuccessMessage(null);
|
||||
|
||||
const displayName = form.displayName.trim();
|
||||
if (displayName.length === 0) {
|
||||
setFormError("Display name is required.");
|
||||
return;
|
||||
}
|
||||
|
||||
const models = parseModelsText(form.modelsText);
|
||||
const baseUrl = form.baseUrl.trim();
|
||||
const apiKey = form.apiKey.trim();
|
||||
|
||||
try {
|
||||
setIsSaving(true);
|
||||
|
||||
if (editingProvider) {
|
||||
const updatePayload: UpdateFleetProviderRequest = {
|
||||
displayName,
|
||||
isActive: form.isActive,
|
||||
models,
|
||||
};
|
||||
|
||||
if (baseUrl.length > 0) {
|
||||
updatePayload.baseUrl = baseUrl;
|
||||
}
|
||||
|
||||
if (apiKey.length > 0) {
|
||||
updatePayload.apiKey = apiKey;
|
||||
}
|
||||
|
||||
await updateFleetProvider(editingProvider.id, updatePayload);
|
||||
setSuccessMessage(`Updated provider "${displayName}".`);
|
||||
} else {
|
||||
const createPayload: CreateFleetProviderRequest = {
|
||||
name: buildProviderName(displayName, form.type),
|
||||
displayName,
|
||||
type: form.type,
|
||||
models,
|
||||
};
|
||||
|
||||
if (baseUrl.length > 0) {
|
||||
createPayload.baseUrl = baseUrl;
|
||||
}
|
||||
|
||||
if (apiKey.length > 0) {
|
||||
createPayload.apiKey = apiKey;
|
||||
}
|
||||
|
||||
await createFleetProvider(createPayload);
|
||||
setSuccessMessage(`Added provider "${displayName}".`);
|
||||
}
|
||||
|
||||
setIsDialogOpen(false);
|
||||
setEditingProvider(null);
|
||||
setForm(INITIAL_FORM);
|
||||
await loadProviders(false);
|
||||
} catch (saveError: unknown) {
|
||||
setFormError(getErrorMessage(saveError, "Unable to save provider."));
|
||||
} finally {
|
||||
setIsSaving(false);
|
||||
}
|
||||
}
|
||||
|
||||
async function handleDeleteProvider(): Promise<void> {
|
||||
if (!deleteTarget) {
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
setIsDeleting(true);
|
||||
await deleteFleetProvider(deleteTarget.id);
|
||||
setSuccessMessage(`Deleted provider "${deleteTarget.displayName}".`);
|
||||
setDeleteTarget(null);
|
||||
await loadProviders(false);
|
||||
} catch (deleteError: unknown) {
|
||||
setError(getErrorMessage(deleteError, "Failed to delete provider."));
|
||||
} finally {
|
||||
setIsDeleting(false);
|
||||
}
|
||||
}
|
||||
|
||||
return (
|
||||
<div className="max-w-6xl mx-auto p-6 space-y-6">
|
||||
<div className="space-y-4">
|
||||
<div>
|
||||
<h1 className="text-3xl font-bold">LLM Providers</h1>
|
||||
<p className="text-muted-foreground mt-1">
|
||||
Manage provider endpoints, model inventories, and encrypted API credentials.
|
||||
</p>
|
||||
</div>
|
||||
<FleetSettingsNav />
|
||||
</div>
|
||||
|
||||
<Card>
|
||||
<CardHeader className="flex flex-col gap-3 sm:flex-row sm:items-center sm:justify-between">
|
||||
<div>
|
||||
<CardTitle>Provider Directory</CardTitle>
|
||||
<CardDescription>
|
||||
API keys are always encrypted in storage and never displayed in plaintext.
|
||||
</CardDescription>
|
||||
</div>
|
||||
<div className="flex items-center gap-2">
|
||||
<Button
|
||||
variant="outline"
|
||||
onClick={() => {
|
||||
void loadProviders(false);
|
||||
}}
|
||||
disabled={isLoading || isRefreshing}
|
||||
>
|
||||
{isRefreshing ? "Refreshing..." : "Refresh"}
|
||||
</Button>
|
||||
<Button onClick={openCreateDialog}>Add Provider</Button>
|
||||
</div>
|
||||
</CardHeader>
|
||||
<CardContent className="space-y-3">
|
||||
{error ? (
|
||||
<p className="text-sm text-destructive" role="alert">
|
||||
{error}
|
||||
</p>
|
||||
) : null}
|
||||
|
||||
{successMessage ? <p className="text-sm text-emerald-600">{successMessage}</p> : null}
|
||||
|
||||
{isLoading ? (
|
||||
<p className="text-sm text-muted-foreground">Loading providers...</p>
|
||||
) : providers.length === 0 ? (
|
||||
<p className="text-sm text-muted-foreground">
|
||||
No providers configured yet. Add one to make models available for agent assignment.
|
||||
</p>
|
||||
) : (
|
||||
providers.map((provider) => {
|
||||
const providerModels = normalizeProviderModels(provider.models);
|
||||
|
||||
return (
|
||||
<div
|
||||
key={provider.id}
|
||||
className="rounded-lg border p-4 flex flex-col gap-4 md:flex-row md:items-start md:justify-between"
|
||||
>
|
||||
<div className="space-y-2 min-w-0">
|
||||
<div className="flex items-center gap-2 flex-wrap">
|
||||
<p className="font-semibold truncate">{provider.displayName}</p>
|
||||
<Badge variant={provider.isActive ? "default" : "secondary"}>
|
||||
{provider.isActive ? "Active" : "Inactive"}
|
||||
</Badge>
|
||||
<Badge variant="outline">{provider.type}</Badge>
|
||||
</div>
|
||||
<p className="text-sm text-muted-foreground">Name: {provider.name}</p>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
Base URL: {provider.baseUrl ?? "Provider default"}
|
||||
</p>
|
||||
<p className="text-sm text-muted-foreground">
|
||||
API Key: encrypted and hidden (never returned decrypted)
|
||||
</p>
|
||||
<div className="flex flex-wrap gap-2">
|
||||
{providerModels.length === 0 ? (
|
||||
<Badge variant="secondary">No models configured</Badge>
|
||||
) : (
|
||||
providerModels.map((model) => (
|
||||
<Badge key={`${provider.id}-${model.id}`} variant="outline">
|
||||
{model.id}
|
||||
</Badge>
|
||||
))
|
||||
)}
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div className="flex items-center gap-2">
|
||||
<Button
|
||||
variant="outline"
|
||||
size="sm"
|
||||
onClick={() => {
|
||||
openEditDialog(provider);
|
||||
}}
|
||||
>
|
||||
<Settings className="h-4 w-4 mr-2" />
|
||||
Edit
|
||||
</Button>
|
||||
<Button
|
||||
variant="destructive"
|
||||
size="sm"
|
||||
onClick={() => {
|
||||
setDeleteTarget(provider);
|
||||
}}
|
||||
>
|
||||
<Trash2 className="h-4 w-4 mr-2" />
|
||||
Delete
|
||||
</Button>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
})
|
||||
)}
|
||||
</CardContent>
|
||||
</Card>
|
||||
|
||||
<Dialog
|
||||
open={isDialogOpen}
|
||||
onOpenChange={(nextOpen) => {
|
||||
if (!nextOpen) {
|
||||
closeDialog();
|
||||
return;
|
||||
}
|
||||
|
||||
setIsDialogOpen(true);
|
||||
}}
|
||||
>
|
||||
<DialogContent>
|
||||
<DialogHeader>
|
||||
<DialogTitle>{editingProvider ? "Edit Provider" : "Add Provider"}</DialogTitle>
|
||||
<DialogDescription>
|
||||
Configure connection details and model IDs. API keys are masked in the UI.
|
||||
</DialogDescription>
|
||||
</DialogHeader>
|
||||
|
||||
<form onSubmit={(event) => void handleSubmit(event)} className="space-y-4">
|
||||
<div className="space-y-2">
|
||||
<Label htmlFor="provider-type">Type</Label>
|
||||
<Select
|
||||
value={form.type}
|
||||
onValueChange={(value) => {
|
||||
setForm((previous) => ({ ...previous, type: value }));
|
||||
}}
|
||||
disabled={Boolean(editingProvider)}
|
||||
>
|
||||
<SelectTrigger id="provider-type">
|
||||
<SelectValue placeholder="Select provider type" />
|
||||
</SelectTrigger>
|
||||
<SelectContent>
|
||||
{PROVIDER_TYPE_OPTIONS.map((option) => (
|
||||
<SelectItem key={option.value} value={option.value}>
|
||||
{option.label}
|
||||
</SelectItem>
|
||||
))}
|
||||
</SelectContent>
|
||||
</Select>
|
||||
</div>
|
||||
|
||||
<div className="space-y-2">
|
||||
<Label htmlFor="provider-display-name">Display Name</Label>
|
||||
<Input
|
||||
id="provider-display-name"
|
||||
value={form.displayName}
|
||||
onChange={(event: ChangeEvent<HTMLInputElement>) => {
|
||||
setForm((previous) => ({ ...previous, displayName: event.target.value }));
|
||||
}}
|
||||
placeholder="OpenAI Primary"
|
||||
maxLength={255}
|
||||
disabled={isSaving}
|
||||
required
|
||||
/>
|
||||
</div>
|
||||
|
||||
<div className="space-y-2">
|
||||
<Label htmlFor="provider-api-key">API Key</Label>
|
||||
<Input
|
||||
id="provider-api-key"
|
||||
type="password"
|
||||
value={form.apiKey}
|
||||
onChange={(event: ChangeEvent<HTMLInputElement>) => {
|
||||
setForm((previous) => ({ ...previous, apiKey: event.target.value }));
|
||||
}}
|
||||
placeholder={editingProvider ? "Enter new key to rotate" : "sk-..."}
|
||||
autoComplete="new-password"
|
||||
disabled={isSaving}
|
||||
/>
|
||||
<p className="text-xs text-muted-foreground">{apiKeyHint}</p>
|
||||
</div>
|
||||
|
||||
<div className="space-y-2">
|
||||
<Label htmlFor="provider-base-url">Base URL</Label>
|
||||
<Input
|
||||
id="provider-base-url"
|
||||
value={form.baseUrl}
|
||||
onChange={(event: ChangeEvent<HTMLInputElement>) => {
|
||||
setForm((previous) => ({ ...previous, baseUrl: event.target.value }));
|
||||
}}
|
||||
placeholder="https://api.provider.com/v1"
|
||||
disabled={isSaving}
|
||||
/>
|
||||
</div>
|
||||
|
||||
<div className="space-y-2">
|
||||
<Label htmlFor="provider-models">Models</Label>
|
||||
<Textarea
|
||||
id="provider-models"
|
||||
value={form.modelsText}
|
||||
onChange={(event: ChangeEvent<HTMLTextAreaElement>) => {
|
||||
setForm((previous) => ({ ...previous, modelsText: event.target.value }));
|
||||
}}
|
||||
placeholder={"One model ID per line\nExample: gpt-4.1-mini"}
|
||||
rows={5}
|
||||
disabled={isSaving}
|
||||
/>
|
||||
</div>
|
||||
|
||||
{editingProvider ? (
|
||||
<div className="flex items-center justify-between rounded-md border px-3 py-2">
|
||||
<div>
|
||||
<Label htmlFor="provider-active">Provider Status</Label>
|
||||
<p className="text-xs text-muted-foreground">
|
||||
Disable to keep configuration without using this provider.
|
||||
</p>
|
||||
</div>
|
||||
<Switch
|
||||
id="provider-active"
|
||||
checked={form.isActive}
|
||||
onCheckedChange={(checked) => {
|
||||
setForm((previous) => ({ ...previous, isActive: checked }));
|
||||
}}
|
||||
disabled={isSaving}
|
||||
/>
|
||||
</div>
|
||||
) : null}
|
||||
|
||||
{formError ? (
|
||||
<p className="text-sm text-destructive" role="alert">
|
||||
{formError}
|
||||
</p>
|
||||
) : null}
|
||||
|
||||
<DialogFooter>
|
||||
<Button type="button" variant="outline" onClick={closeDialog} disabled={isSaving}>
|
||||
Cancel
|
||||
</Button>
|
||||
<Button type="submit" disabled={isSaving}>
|
||||
{isSaving ? "Saving..." : editingProvider ? "Save Changes" : "Create Provider"}
|
||||
</Button>
|
||||
</DialogFooter>
|
||||
</form>
|
||||
</DialogContent>
|
||||
</Dialog>
|
||||
|
||||
<AlertDialog
|
||||
open={deleteTarget !== null}
|
||||
onOpenChange={(open) => {
|
||||
if (!open && !isDeleting) {
|
||||
setDeleteTarget(null);
|
||||
}
|
||||
}}
|
||||
>
|
||||
<AlertDialogContent>
|
||||
<AlertDialogHeader>
|
||||
<AlertDialogTitle>Delete Provider</AlertDialogTitle>
|
||||
<AlertDialogDescription>
|
||||
Delete provider "{deleteTarget?.displayName}"? This removes its configuration and
|
||||
model mappings.
|
||||
</AlertDialogDescription>
|
||||
</AlertDialogHeader>
|
||||
<AlertDialogFooter>
|
||||
<AlertDialogCancel disabled={isDeleting}>Cancel</AlertDialogCancel>
|
||||
<AlertDialogAction onClick={handleDeleteProvider} disabled={isDeleting}>
|
||||
{isDeleting ? "Deleting..." : "Delete Provider"}
|
||||
</AlertDialogAction>
|
||||
</AlertDialogFooter>
|
||||
</AlertDialogContent>
|
||||
</AlertDialog>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
9
apps/web/src/app/onboarding/layout.tsx
Normal file
9
apps/web/src/app/onboarding/layout.tsx
Normal file
@@ -0,0 +1,9 @@
|
||||
import type { ReactNode } from "react";
|
||||
|
||||
export default function OnboardingLayout({ children }: { children: ReactNode }): React.JSX.Element {
|
||||
return (
|
||||
<main className="flex min-h-screen items-center justify-center bg-gradient-to-b from-slate-50 to-white p-4 sm:p-6">
|
||||
<div className="w-full max-w-3xl">{children}</div>
|
||||
</main>
|
||||
);
|
||||
}
|
||||
36
apps/web/src/app/onboarding/page.tsx
Normal file
36
apps/web/src/app/onboarding/page.tsx
Normal file
@@ -0,0 +1,36 @@
|
||||
import { redirect } from "next/navigation";
|
||||
import { OnboardingWizard } from "@/components/onboarding/OnboardingWizard";
|
||||
import { API_BASE_URL } from "@/lib/config";
|
||||
|
||||
export const dynamic = "force-dynamic";
|
||||
|
||||
interface OnboardingStatusResponse {
|
||||
completed: boolean;
|
||||
}
|
||||
|
||||
async function getOnboardingStatus(): Promise<OnboardingStatusResponse> {
|
||||
try {
|
||||
const response = await fetch(`${API_BASE_URL}/api/onboarding/status`, {
|
||||
method: "GET",
|
||||
cache: "no-store",
|
||||
});
|
||||
|
||||
if (!response.ok) {
|
||||
return { completed: false };
|
||||
}
|
||||
|
||||
return (await response.json()) as OnboardingStatusResponse;
|
||||
} catch {
|
||||
return { completed: false };
|
||||
}
|
||||
}
|
||||
|
||||
export default async function OnboardingPage(): Promise<React.JSX.Element> {
|
||||
const status = await getOnboardingStatus();
|
||||
|
||||
if (status.completed) {
|
||||
redirect("/");
|
||||
}
|
||||
|
||||
return <OnboardingWizard />;
|
||||
}
|
||||
106
apps/web/src/components/onboarding/OnboardingWizard.test.tsx
Normal file
106
apps/web/src/components/onboarding/OnboardingWizard.test.tsx
Normal file
@@ -0,0 +1,106 @@
|
||||
import { beforeEach, describe, expect, it, vi } from "vitest";
|
||||
import { render, screen, waitFor } from "@testing-library/react";
|
||||
import userEvent from "@testing-library/user-event";
|
||||
import { OnboardingWizard } from "./OnboardingWizard";
|
||||
|
||||
const mockPush = vi.fn();
|
||||
const mockGetStatus = vi.fn();
|
||||
const mockCreateBreakglass = vi.fn();
|
||||
const mockConfigureOidc = vi.fn();
|
||||
const mockTestProvider = vi.fn();
|
||||
const mockAddProvider = vi.fn();
|
||||
const mockCompleteOnboarding = vi.fn();
|
||||
|
||||
vi.mock("next/navigation", () => ({
|
||||
useRouter: (): { push: typeof mockPush } => ({
|
||||
push: mockPush,
|
||||
}),
|
||||
}));
|
||||
|
||||
vi.mock("@/lib/api/onboarding", () => ({
|
||||
fetchOnboardingStatus: (): ReturnType<typeof mockGetStatus> => mockGetStatus(),
|
||||
createBreakglassAdmin: (...args: unknown[]): ReturnType<typeof mockCreateBreakglass> =>
|
||||
mockCreateBreakglass(...args),
|
||||
configureOidcProvider: (...args: unknown[]): ReturnType<typeof mockConfigureOidc> =>
|
||||
mockConfigureOidc(...args),
|
||||
testOnboardingProvider: (...args: unknown[]): ReturnType<typeof mockTestProvider> =>
|
||||
mockTestProvider(...args),
|
||||
addOnboardingProvider: (...args: unknown[]): ReturnType<typeof mockAddProvider> =>
|
||||
mockAddProvider(...args),
|
||||
completeOnboarding: (): ReturnType<typeof mockCompleteOnboarding> => mockCompleteOnboarding(),
|
||||
}));
|
||||
|
||||
describe("OnboardingWizard", () => {
|
||||
beforeEach(() => {
|
||||
mockPush.mockReset();
|
||||
mockGetStatus.mockReset();
|
||||
mockCreateBreakglass.mockReset();
|
||||
mockConfigureOidc.mockReset();
|
||||
mockTestProvider.mockReset();
|
||||
mockAddProvider.mockReset();
|
||||
mockCompleteOnboarding.mockReset();
|
||||
|
||||
mockGetStatus.mockResolvedValue({ completed: false });
|
||||
mockCreateBreakglass.mockResolvedValue({ id: "bg-1", username: "admin" });
|
||||
mockConfigureOidc.mockResolvedValue(undefined);
|
||||
mockTestProvider.mockResolvedValue({ success: true });
|
||||
mockAddProvider.mockResolvedValue({ id: "provider-1" });
|
||||
mockCompleteOnboarding.mockResolvedValue(undefined);
|
||||
});
|
||||
|
||||
it("renders the first step with admin setup fields", async () => {
|
||||
render(<OnboardingWizard />);
|
||||
|
||||
expect(
|
||||
await screen.findByText("Welcome to Mosaic Stack. Let's get you set up.")
|
||||
).toBeInTheDocument();
|
||||
expect(screen.getByLabelText("Username")).toBeInTheDocument();
|
||||
expect(screen.getByLabelText("Password")).toBeInTheDocument();
|
||||
expect(screen.getByLabelText("Confirm Password")).toBeInTheDocument();
|
||||
expect(screen.getByText("1. Admin")).toBeInTheDocument();
|
||||
});
|
||||
|
||||
it("validates admin form fields before submit", async () => {
|
||||
const user = userEvent.setup();
|
||||
render(<OnboardingWizard />);
|
||||
|
||||
await screen.findByText("Welcome to Mosaic Stack. Let's get you set up.");
|
||||
await user.click(screen.getByRole("button", { name: "Create Admin" }));
|
||||
|
||||
expect(screen.getByText("Username must be at least 3 characters.")).toBeInTheDocument();
|
||||
expect(mockCreateBreakglass).not.toHaveBeenCalled();
|
||||
});
|
||||
|
||||
it("supports happy path with OIDC skipped", async () => {
|
||||
const user = userEvent.setup();
|
||||
render(<OnboardingWizard />);
|
||||
|
||||
await screen.findByText("Welcome to Mosaic Stack. Let's get you set up.");
|
||||
|
||||
await user.type(screen.getByLabelText("Username"), "admin");
|
||||
await user.type(screen.getByLabelText("Password"), "verysecurepassword");
|
||||
await user.type(screen.getByLabelText("Confirm Password"), "verysecurepassword");
|
||||
await user.click(screen.getByRole("button", { name: "Create Admin" }));
|
||||
|
||||
await screen.findByText("Configure OIDC Provider (Optional)");
|
||||
await user.click(screen.getByRole("button", { name: "Skip" }));
|
||||
|
||||
await screen.findByText("Add Your First LLM Provider");
|
||||
await user.type(screen.getByLabelText("Display Name"), "My OpenAI");
|
||||
await user.type(screen.getByLabelText("API Key"), "sk-test-key");
|
||||
|
||||
await user.click(screen.getByRole("button", { name: "Test Connection" }));
|
||||
await screen.findByText("Connection successful.");
|
||||
|
||||
const addProviderButton = screen.getByRole("button", { name: "Add Provider" });
|
||||
expect(addProviderButton).toBeEnabled();
|
||||
await user.click(addProviderButton);
|
||||
|
||||
await screen.findByText("You're all set");
|
||||
await user.click(screen.getByRole("button", { name: "Launch Mosaic Stack" }));
|
||||
|
||||
await waitFor(() => {
|
||||
expect(mockPush).toHaveBeenCalledWith("/");
|
||||
});
|
||||
});
|
||||
});
|
||||
791
apps/web/src/components/onboarding/OnboardingWizard.tsx
Normal file
791
apps/web/src/components/onboarding/OnboardingWizard.tsx
Normal file
@@ -0,0 +1,791 @@
|
||||
"use client";
|
||||
|
||||
import { useEffect, useMemo, useState } from "react";
|
||||
import { Check, Loader2 } from "lucide-react";
|
||||
import { useRouter } from "next/navigation";
|
||||
import { Button } from "@/components/ui/button";
|
||||
import { Card, CardContent, CardDescription, CardHeader, CardTitle } from "@/components/ui/card";
|
||||
import { Input } from "@/components/ui/input";
|
||||
import { Label } from "@/components/ui/label";
|
||||
import {
|
||||
Select,
|
||||
SelectContent,
|
||||
SelectItem,
|
||||
SelectTrigger,
|
||||
SelectValue,
|
||||
} from "@/components/ui/select";
|
||||
import {
|
||||
addOnboardingProvider,
|
||||
completeOnboarding,
|
||||
configureOidcProvider,
|
||||
createBreakglassAdmin,
|
||||
fetchOnboardingStatus,
|
||||
testOnboardingProvider,
|
||||
} from "@/lib/api/onboarding";
|
||||
|
||||
type WizardStep = 1 | 2 | 3 | 4;
|
||||
type ProviderType = "openai" | "anthropic" | "zai" | "ollama" | "custom";
|
||||
|
||||
interface StepDefinition {
|
||||
id: WizardStep;
|
||||
label: string;
|
||||
}
|
||||
|
||||
interface ProviderOption {
|
||||
value: ProviderType;
|
||||
label: string;
|
||||
}
|
||||
|
||||
const STEPS: StepDefinition[] = [
|
||||
{ id: 1, label: "1. Admin" },
|
||||
{ id: 2, label: "2. Auth" },
|
||||
{ id: 3, label: "3. Provider" },
|
||||
{ id: 4, label: "4. Launch" },
|
||||
];
|
||||
|
||||
const PROVIDER_OPTIONS: ProviderOption[] = [
|
||||
{ value: "openai", label: "OpenAI" },
|
||||
{ value: "anthropic", label: "Anthropic" },
|
||||
{ value: "zai", label: "Z.ai" },
|
||||
{ value: "ollama", label: "Ollama" },
|
||||
{ value: "custom", label: "Custom" },
|
||||
];
|
||||
|
||||
const CLOUD_PROVIDER_TYPES = new Set<ProviderType>(["openai", "anthropic", "zai"]);
|
||||
const BASE_URL_PROVIDER_TYPES = new Set<ProviderType>(["ollama", "custom"]);
|
||||
|
||||
function getErrorMessage(error: unknown, fallback: string): string {
|
||||
if (error instanceof Error && error.message.trim().length > 0) {
|
||||
return error.message;
|
||||
}
|
||||
|
||||
return fallback;
|
||||
}
|
||||
|
||||
function isValidHttpUrl(value: string): boolean {
|
||||
try {
|
||||
const parsed = new URL(value);
|
||||
return parsed.protocol === "http:" || parsed.protocol === "https:";
|
||||
} catch {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
function mapProviderTypeToApi(type: ProviderType): string {
|
||||
switch (type) {
|
||||
case "anthropic":
|
||||
return "claude";
|
||||
case "zai":
|
||||
return "openai";
|
||||
case "custom":
|
||||
return "openai";
|
||||
default:
|
||||
return type;
|
||||
}
|
||||
}
|
||||
|
||||
function getProviderDefaultBaseUrl(type: ProviderType): string | undefined {
|
||||
switch (type) {
|
||||
case "ollama":
|
||||
return "http://localhost:11434";
|
||||
case "anthropic":
|
||||
return "https://api.anthropic.com/v1";
|
||||
case "zai":
|
||||
return "https://api.z.ai/v1";
|
||||
default:
|
||||
return undefined;
|
||||
}
|
||||
}
|
||||
|
||||
function buildProviderName(displayName: string, type: ProviderType): string {
|
||||
const slug = displayName
|
||||
.trim()
|
||||
.toLowerCase()
|
||||
.replace(/[^a-z0-9]+/g, "-")
|
||||
.replace(/^-+/, "")
|
||||
.replace(/-+$/, "");
|
||||
|
||||
if (slug.length > 0) {
|
||||
return slug;
|
||||
}
|
||||
|
||||
return `${type}-provider`;
|
||||
}
|
||||
|
||||
function constantTimeEquals(left: string, right: string): boolean {
|
||||
if (left.length !== right.length) {
|
||||
return false;
|
||||
}
|
||||
|
||||
let mismatch = 0;
|
||||
for (let index = 0; index < left.length; index += 1) {
|
||||
mismatch |= left.charCodeAt(index) ^ right.charCodeAt(index);
|
||||
}
|
||||
|
||||
return mismatch === 0;
|
||||
}
|
||||
|
||||
export function OnboardingWizard(): React.JSX.Element {
|
||||
const router = useRouter();
|
||||
|
||||
const [currentStep, setCurrentStep] = useState<WizardStep>(1);
|
||||
const [isCheckingStatus, setIsCheckingStatus] = useState(true);
|
||||
|
||||
const [username, setUsername] = useState("");
|
||||
const [password, setPassword] = useState("");
|
||||
const [confirmPassword, setConfirmPassword] = useState("");
|
||||
const [isCreatingAdmin, setIsCreatingAdmin] = useState(false);
|
||||
const [configuredUsername, setConfiguredUsername] = useState<string | null>(null);
|
||||
|
||||
const [issuerUrl, setIssuerUrl] = useState("");
|
||||
const [clientId, setClientId] = useState("");
|
||||
const [clientSecret, setClientSecret] = useState("");
|
||||
const [isConfiguringOidc, setIsConfiguringOidc] = useState(false);
|
||||
const [oidcConfigured, setOidcConfigured] = useState(false);
|
||||
|
||||
const [providerType, setProviderType] = useState<ProviderType>("openai");
|
||||
const [displayName, setDisplayName] = useState("");
|
||||
const [providerApiKey, setProviderApiKey] = useState("");
|
||||
const [providerBaseUrl, setProviderBaseUrl] = useState("");
|
||||
const [isTestingProvider, setIsTestingProvider] = useState(false);
|
||||
const [isAddingProvider, setIsAddingProvider] = useState(false);
|
||||
const [providerConfigured, setProviderConfigured] = useState<{
|
||||
displayName: string;
|
||||
type: ProviderType;
|
||||
} | null>(null);
|
||||
const [providerTestMessage, setProviderTestMessage] = useState<string | null>(null);
|
||||
const [providerTestSucceeded, setProviderTestSucceeded] = useState(false);
|
||||
const [testedProviderSignature, setTestedProviderSignature] = useState<string | null>(null);
|
||||
|
||||
const [isCompleting, setIsCompleting] = useState(false);
|
||||
const [errorMessage, setErrorMessage] = useState<string | null>(null);
|
||||
|
||||
const requiresApiKey = CLOUD_PROVIDER_TYPES.has(providerType);
|
||||
const requiresBaseUrl = BASE_URL_PROVIDER_TYPES.has(providerType);
|
||||
const apiProviderType = mapProviderTypeToApi(providerType);
|
||||
const resolvedProviderBaseUrl =
|
||||
requiresBaseUrl && providerBaseUrl.trim().length > 0
|
||||
? providerBaseUrl.trim()
|
||||
: getProviderDefaultBaseUrl(providerType);
|
||||
|
||||
const providerTestPayload = useMemo(() => {
|
||||
const payload: { type: string; baseUrl?: string; apiKey?: string } = {
|
||||
type: apiProviderType,
|
||||
};
|
||||
|
||||
if (resolvedProviderBaseUrl !== undefined && resolvedProviderBaseUrl.length > 0) {
|
||||
payload.baseUrl = resolvedProviderBaseUrl;
|
||||
}
|
||||
|
||||
const trimmedApiKey = providerApiKey.trim();
|
||||
if (requiresApiKey && trimmedApiKey.length > 0) {
|
||||
payload.apiKey = trimmedApiKey;
|
||||
}
|
||||
|
||||
return payload;
|
||||
}, [apiProviderType, providerApiKey, requiresApiKey, resolvedProviderBaseUrl]);
|
||||
|
||||
const providerPayloadSignature = useMemo(
|
||||
() => JSON.stringify(providerTestPayload),
|
||||
[providerTestPayload]
|
||||
);
|
||||
|
||||
const canAddProvider =
|
||||
providerTestSucceeded &&
|
||||
testedProviderSignature === providerPayloadSignature &&
|
||||
!isTestingProvider &&
|
||||
!isAddingProvider;
|
||||
|
||||
useEffect(() => {
|
||||
let cancelled = false;
|
||||
|
||||
async function loadStatus(): Promise<void> {
|
||||
try {
|
||||
const status = await fetchOnboardingStatus();
|
||||
if (!cancelled && status.completed) {
|
||||
router.push("/");
|
||||
return;
|
||||
}
|
||||
} catch {
|
||||
// Status check failure should not block setup UI.
|
||||
} finally {
|
||||
if (!cancelled) {
|
||||
setIsCheckingStatus(false);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void loadStatus();
|
||||
|
||||
return (): void => {
|
||||
cancelled = true;
|
||||
};
|
||||
}, [router]);
|
||||
|
||||
const resetProviderVerification = (): void => {
|
||||
setProviderTestSucceeded(false);
|
||||
setTestedProviderSignature(null);
|
||||
setProviderTestMessage(null);
|
||||
};
|
||||
|
||||
const validateAdminStep = (): boolean => {
|
||||
if (username.trim().length < 3) {
|
||||
setErrorMessage("Username must be at least 3 characters.");
|
||||
return false;
|
||||
}
|
||||
|
||||
if (password.length < 8) {
|
||||
setErrorMessage("Password must be at least 8 characters.");
|
||||
return false;
|
||||
}
|
||||
|
||||
if (!constantTimeEquals(password, confirmPassword)) {
|
||||
setErrorMessage("Passwords do not match.");
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
};
|
||||
|
||||
const validateOidcStep = (): boolean => {
|
||||
if (issuerUrl.trim().length === 0 || !isValidHttpUrl(issuerUrl.trim())) {
|
||||
setErrorMessage("Issuer URL must be a valid URL.");
|
||||
return false;
|
||||
}
|
||||
|
||||
if (clientId.trim().length === 0) {
|
||||
setErrorMessage("Client ID is required.");
|
||||
return false;
|
||||
}
|
||||
|
||||
if (clientSecret.trim().length === 0) {
|
||||
setErrorMessage("Client secret is required.");
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
};
|
||||
|
||||
const validateProviderStep = (): boolean => {
|
||||
if (displayName.trim().length === 0) {
|
||||
setErrorMessage("Display name is required.");
|
||||
return false;
|
||||
}
|
||||
|
||||
if (requiresApiKey && providerApiKey.trim().length === 0) {
|
||||
setErrorMessage("API key is required for this provider.");
|
||||
return false;
|
||||
}
|
||||
|
||||
if (requiresBaseUrl && providerBaseUrl.trim().length === 0) {
|
||||
setErrorMessage("Base URL is required for this provider.");
|
||||
return false;
|
||||
}
|
||||
|
||||
if (requiresBaseUrl && !isValidHttpUrl(providerBaseUrl.trim())) {
|
||||
setErrorMessage("Base URL must be a valid URL.");
|
||||
return false;
|
||||
}
|
||||
|
||||
return true;
|
||||
};
|
||||
|
||||
const handleCreateAdmin = async (event: React.SyntheticEvent<HTMLFormElement>): Promise<void> => {
|
||||
event.preventDefault();
|
||||
|
||||
setErrorMessage(null);
|
||||
if (!validateAdminStep()) {
|
||||
return;
|
||||
}
|
||||
|
||||
setIsCreatingAdmin(true);
|
||||
try {
|
||||
const result = await createBreakglassAdmin({
|
||||
username: username.trim(),
|
||||
password,
|
||||
});
|
||||
setConfiguredUsername(result.username);
|
||||
setCurrentStep(2);
|
||||
} catch (error) {
|
||||
setErrorMessage(getErrorMessage(error, "Failed to create admin account."));
|
||||
} finally {
|
||||
setIsCreatingAdmin(false);
|
||||
}
|
||||
};
|
||||
|
||||
const handleConfigureOidc = async (
|
||||
event: React.SyntheticEvent<HTMLFormElement>
|
||||
): Promise<void> => {
|
||||
event.preventDefault();
|
||||
|
||||
setErrorMessage(null);
|
||||
if (!validateOidcStep()) {
|
||||
return;
|
||||
}
|
||||
|
||||
setIsConfiguringOidc(true);
|
||||
try {
|
||||
await configureOidcProvider({
|
||||
issuerUrl: issuerUrl.trim(),
|
||||
clientId: clientId.trim(),
|
||||
clientSecret: clientSecret.trim(),
|
||||
});
|
||||
setOidcConfigured(true);
|
||||
setCurrentStep(3);
|
||||
} catch (error) {
|
||||
setErrorMessage(getErrorMessage(error, "Failed to configure OIDC provider."));
|
||||
} finally {
|
||||
setIsConfiguringOidc(false);
|
||||
}
|
||||
};
|
||||
|
||||
const handleSkipOidc = (): void => {
|
||||
setErrorMessage(null);
|
||||
setOidcConfigured(false);
|
||||
setCurrentStep(3);
|
||||
};
|
||||
|
||||
const handleTestProvider = async (): Promise<void> => {
|
||||
setErrorMessage(null);
|
||||
setProviderTestMessage(null);
|
||||
if (!validateProviderStep()) {
|
||||
return;
|
||||
}
|
||||
|
||||
setIsTestingProvider(true);
|
||||
try {
|
||||
const response = await testOnboardingProvider(providerTestPayload);
|
||||
if (!response.success) {
|
||||
setProviderTestSucceeded(false);
|
||||
setTestedProviderSignature(null);
|
||||
setErrorMessage(response.error ?? "Connection test failed.");
|
||||
return;
|
||||
}
|
||||
|
||||
setProviderTestSucceeded(true);
|
||||
setTestedProviderSignature(providerPayloadSignature);
|
||||
setProviderTestMessage("Connection successful.");
|
||||
} catch (error) {
|
||||
setProviderTestSucceeded(false);
|
||||
setTestedProviderSignature(null);
|
||||
setErrorMessage(getErrorMessage(error, "Connection test failed."));
|
||||
} finally {
|
||||
setIsTestingProvider(false);
|
||||
}
|
||||
};
|
||||
|
||||
const handleAddProvider = async (): Promise<void> => {
|
||||
setErrorMessage(null);
|
||||
if (!validateProviderStep()) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (!canAddProvider) {
|
||||
setErrorMessage("Test connection successfully before adding the provider.");
|
||||
return;
|
||||
}
|
||||
|
||||
setIsAddingProvider(true);
|
||||
try {
|
||||
const trimmedDisplayName = displayName.trim();
|
||||
const payload: {
|
||||
name: string;
|
||||
displayName: string;
|
||||
type: string;
|
||||
baseUrl?: string;
|
||||
apiKey?: string;
|
||||
} = {
|
||||
name: buildProviderName(trimmedDisplayName, providerType),
|
||||
displayName: trimmedDisplayName,
|
||||
type: apiProviderType,
|
||||
};
|
||||
|
||||
if (resolvedProviderBaseUrl !== undefined && resolvedProviderBaseUrl.length > 0) {
|
||||
payload.baseUrl = resolvedProviderBaseUrl;
|
||||
}
|
||||
|
||||
const trimmedApiKey = providerApiKey.trim();
|
||||
if (requiresApiKey && trimmedApiKey.length > 0) {
|
||||
payload.apiKey = trimmedApiKey;
|
||||
}
|
||||
|
||||
await addOnboardingProvider(payload);
|
||||
|
||||
setProviderConfigured({ displayName: trimmedDisplayName, type: providerType });
|
||||
setCurrentStep(4);
|
||||
} catch (error) {
|
||||
setErrorMessage(getErrorMessage(error, "Failed to add provider."));
|
||||
} finally {
|
||||
setIsAddingProvider(false);
|
||||
}
|
||||
};
|
||||
|
||||
const handleCompleteOnboarding = async (): Promise<void> => {
|
||||
setErrorMessage(null);
|
||||
setIsCompleting(true);
|
||||
try {
|
||||
await completeOnboarding();
|
||||
router.push("/");
|
||||
} catch (error) {
|
||||
setErrorMessage(getErrorMessage(error, "Failed to complete onboarding."));
|
||||
} finally {
|
||||
setIsCompleting(false);
|
||||
}
|
||||
};
|
||||
|
||||
const providerLabel =
|
||||
PROVIDER_OPTIONS.find((option) => option.value === providerConfigured?.type)?.label ??
|
||||
providerConfigured?.type ??
|
||||
"Unknown";
|
||||
|
||||
return (
|
||||
<Card className="mx-auto w-full max-w-2xl shadow-sm">
|
||||
<CardHeader>
|
||||
<CardTitle>First-boot onboarding</CardTitle>
|
||||
<CardDescription>Set up your admin access, auth, and first provider.</CardDescription>
|
||||
</CardHeader>
|
||||
<CardContent className="space-y-6">
|
||||
<div className="grid grid-cols-2 gap-2 sm:grid-cols-4">
|
||||
{STEPS.map((step) => {
|
||||
const isActive = currentStep === step.id;
|
||||
const isComplete = currentStep > step.id;
|
||||
const badgeClass = isComplete
|
||||
? "bg-emerald-100 text-emerald-700 border-emerald-200"
|
||||
: isActive
|
||||
? "bg-blue-100 text-blue-700 border-blue-200"
|
||||
: "bg-gray-100 text-gray-500 border-gray-200";
|
||||
|
||||
return (
|
||||
<div
|
||||
key={step.id}
|
||||
className={`rounded-md border px-3 py-2 text-sm ${badgeClass}`}
|
||||
aria-current={isActive ? "step" : undefined}
|
||||
>
|
||||
<div className="flex items-center gap-2 font-medium">
|
||||
<span className="inline-flex h-5 w-5 items-center justify-center rounded-full border border-current text-xs">
|
||||
{isComplete ? <Check className="h-3.5 w-3.5" aria-hidden="true" /> : step.id}
|
||||
</span>
|
||||
<span>{step.label}</span>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
})}
|
||||
</div>
|
||||
|
||||
{isCheckingStatus ? (
|
||||
<div className="flex items-center gap-2 text-sm text-gray-600">
|
||||
<Loader2 className="h-4 w-4 animate-spin" aria-hidden="true" />
|
||||
<span>Checking onboarding status...</span>
|
||||
</div>
|
||||
) : (
|
||||
<>
|
||||
{currentStep === 1 && (
|
||||
<form onSubmit={handleCreateAdmin} className="space-y-4" noValidate>
|
||||
<div className="space-y-1">
|
||||
<h2 className="text-xl font-semibold">
|
||||
Welcome to Mosaic Stack. Let's get you set up.
|
||||
</h2>
|
||||
<p className="text-sm text-gray-600">
|
||||
Create a breakglass admin account for emergency access.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div className="grid gap-2">
|
||||
<Label htmlFor="onboarding-username">Username</Label>
|
||||
<Input
|
||||
id="onboarding-username"
|
||||
value={username}
|
||||
onChange={(event: React.ChangeEvent<HTMLInputElement>) => {
|
||||
setUsername(event.target.value);
|
||||
}}
|
||||
disabled={isCreatingAdmin}
|
||||
autoComplete="username"
|
||||
/>
|
||||
</div>
|
||||
|
||||
<div className="grid gap-2">
|
||||
<Label htmlFor="onboarding-password">Password</Label>
|
||||
<Input
|
||||
id="onboarding-password"
|
||||
type="password"
|
||||
value={password}
|
||||
onChange={(event: React.ChangeEvent<HTMLInputElement>) => {
|
||||
setPassword(event.target.value);
|
||||
}}
|
||||
disabled={isCreatingAdmin}
|
||||
autoComplete="new-password"
|
||||
/>
|
||||
</div>
|
||||
|
||||
<div className="grid gap-2">
|
||||
<Label htmlFor="onboarding-confirm-password">Confirm Password</Label>
|
||||
<Input
|
||||
id="onboarding-confirm-password"
|
||||
type="password"
|
||||
value={confirmPassword}
|
||||
onChange={(event: React.ChangeEvent<HTMLInputElement>) => {
|
||||
setConfirmPassword(event.target.value);
|
||||
}}
|
||||
disabled={isCreatingAdmin}
|
||||
autoComplete="new-password"
|
||||
/>
|
||||
</div>
|
||||
|
||||
<Button type="submit" disabled={isCreatingAdmin}>
|
||||
{isCreatingAdmin && (
|
||||
<Loader2 className="mr-2 h-4 w-4 animate-spin" aria-hidden="true" />
|
||||
)}
|
||||
<span>Create Admin</span>
|
||||
</Button>
|
||||
</form>
|
||||
)}
|
||||
|
||||
{currentStep === 2 && (
|
||||
<form onSubmit={handleConfigureOidc} className="space-y-4" noValidate>
|
||||
<div className="space-y-1">
|
||||
<h2 className="text-xl font-semibold">Configure OIDC Provider (Optional)</h2>
|
||||
<p className="text-sm text-gray-600">
|
||||
You can skip this for now and continue with breakglass-only authentication.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div className="grid gap-2">
|
||||
<Label htmlFor="onboarding-issuer-url">OIDC Issuer URL</Label>
|
||||
<Input
|
||||
id="onboarding-issuer-url"
|
||||
value={issuerUrl}
|
||||
onChange={(event: React.ChangeEvent<HTMLInputElement>) => {
|
||||
setIssuerUrl(event.target.value);
|
||||
}}
|
||||
disabled={isConfiguringOidc}
|
||||
placeholder="https://auth.example.com/application/o/mosaic/"
|
||||
autoComplete="url"
|
||||
/>
|
||||
</div>
|
||||
|
||||
<div className="grid gap-2">
|
||||
<Label htmlFor="onboarding-client-id">Client ID</Label>
|
||||
<Input
|
||||
id="onboarding-client-id"
|
||||
value={clientId}
|
||||
onChange={(event: React.ChangeEvent<HTMLInputElement>) => {
|
||||
setClientId(event.target.value);
|
||||
}}
|
||||
disabled={isConfiguringOidc}
|
||||
/>
|
||||
</div>
|
||||
|
||||
<div className="grid gap-2">
|
||||
<Label htmlFor="onboarding-client-secret">Client Secret</Label>
|
||||
<Input
|
||||
id="onboarding-client-secret"
|
||||
type="password"
|
||||
value={clientSecret}
|
||||
onChange={(event: React.ChangeEvent<HTMLInputElement>) => {
|
||||
setClientSecret(event.target.value);
|
||||
}}
|
||||
disabled={isConfiguringOidc}
|
||||
autoComplete="off"
|
||||
/>
|
||||
</div>
|
||||
|
||||
<div className="flex flex-wrap gap-2">
|
||||
<Button type="submit" disabled={isConfiguringOidc}>
|
||||
{isConfiguringOidc && (
|
||||
<Loader2 className="mr-2 h-4 w-4 animate-spin" aria-hidden="true" />
|
||||
)}
|
||||
<span>Configure OIDC</span>
|
||||
</Button>
|
||||
<Button
|
||||
type="button"
|
||||
variant="outline"
|
||||
onClick={handleSkipOidc}
|
||||
disabled={isConfiguringOidc}
|
||||
>
|
||||
Skip
|
||||
</Button>
|
||||
</div>
|
||||
</form>
|
||||
)}
|
||||
|
||||
{currentStep === 3 && (
|
||||
<div className="space-y-4">
|
||||
<div className="space-y-1">
|
||||
<h2 className="text-xl font-semibold">Add Your First LLM Provider</h2>
|
||||
<p className="text-sm text-gray-600">
|
||||
Test the connection before adding your provider.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div className="grid gap-2">
|
||||
<Label htmlFor="onboarding-provider-type">Provider Type</Label>
|
||||
<Select
|
||||
value={providerType}
|
||||
onValueChange={(value) => {
|
||||
const nextType = value as ProviderType;
|
||||
setProviderType(nextType);
|
||||
setProviderApiKey("");
|
||||
setProviderBaseUrl(
|
||||
BASE_URL_PROVIDER_TYPES.has(nextType)
|
||||
? (getProviderDefaultBaseUrl(nextType) ?? "")
|
||||
: ""
|
||||
);
|
||||
resetProviderVerification();
|
||||
setErrorMessage(null);
|
||||
}}
|
||||
disabled={isTestingProvider || isAddingProvider}
|
||||
>
|
||||
<SelectTrigger id="onboarding-provider-type">
|
||||
<SelectValue placeholder="Select provider type" />
|
||||
</SelectTrigger>
|
||||
<SelectContent>
|
||||
{PROVIDER_OPTIONS.map((option) => (
|
||||
<SelectItem key={option.value} value={option.value}>
|
||||
{option.label}
|
||||
</SelectItem>
|
||||
))}
|
||||
</SelectContent>
|
||||
</Select>
|
||||
</div>
|
||||
|
||||
<div className="grid gap-2">
|
||||
<Label htmlFor="onboarding-provider-display-name">Display Name</Label>
|
||||
<Input
|
||||
id="onboarding-provider-display-name"
|
||||
value={displayName}
|
||||
onChange={(event: React.ChangeEvent<HTMLInputElement>) => {
|
||||
setDisplayName(event.target.value);
|
||||
resetProviderVerification();
|
||||
setErrorMessage(null);
|
||||
}}
|
||||
disabled={isTestingProvider || isAddingProvider}
|
||||
placeholder="My OpenAI Provider"
|
||||
/>
|
||||
</div>
|
||||
|
||||
{requiresApiKey && (
|
||||
<div className="grid gap-2">
|
||||
<Label htmlFor="onboarding-provider-api-key">API Key</Label>
|
||||
<Input
|
||||
id="onboarding-provider-api-key"
|
||||
type="password"
|
||||
value={providerApiKey}
|
||||
onChange={(event: React.ChangeEvent<HTMLInputElement>) => {
|
||||
setProviderApiKey(event.target.value);
|
||||
resetProviderVerification();
|
||||
setErrorMessage(null);
|
||||
}}
|
||||
disabled={isTestingProvider || isAddingProvider}
|
||||
autoComplete="off"
|
||||
/>
|
||||
</div>
|
||||
)}
|
||||
|
||||
{requiresBaseUrl && (
|
||||
<div className="grid gap-2">
|
||||
<Label htmlFor="onboarding-provider-base-url">Base URL</Label>
|
||||
<Input
|
||||
id="onboarding-provider-base-url"
|
||||
value={providerBaseUrl}
|
||||
onChange={(event: React.ChangeEvent<HTMLInputElement>) => {
|
||||
setProviderBaseUrl(event.target.value);
|
||||
resetProviderVerification();
|
||||
setErrorMessage(null);
|
||||
}}
|
||||
disabled={isTestingProvider || isAddingProvider}
|
||||
placeholder="http://localhost:11434"
|
||||
autoComplete="url"
|
||||
/>
|
||||
</div>
|
||||
)}
|
||||
|
||||
{providerTestMessage && (
|
||||
<p className="text-sm text-emerald-700" role="status">
|
||||
{providerTestMessage}
|
||||
</p>
|
||||
)}
|
||||
|
||||
<div className="flex flex-wrap gap-2">
|
||||
<Button
|
||||
type="button"
|
||||
variant="outline"
|
||||
onClick={() => {
|
||||
void handleTestProvider();
|
||||
}}
|
||||
disabled={isTestingProvider || isAddingProvider}
|
||||
>
|
||||
{isTestingProvider && (
|
||||
<Loader2 className="mr-2 h-4 w-4 animate-spin" aria-hidden="true" />
|
||||
)}
|
||||
<span>Test Connection</span>
|
||||
</Button>
|
||||
<Button
|
||||
type="button"
|
||||
onClick={() => {
|
||||
void handleAddProvider();
|
||||
}}
|
||||
disabled={!canAddProvider}
|
||||
>
|
||||
{isAddingProvider && (
|
||||
<Loader2 className="mr-2 h-4 w-4 animate-spin" aria-hidden="true" />
|
||||
)}
|
||||
<span>Add Provider</span>
|
||||
</Button>
|
||||
</div>
|
||||
</div>
|
||||
)}
|
||||
|
||||
{currentStep === 4 && (
|
||||
<div className="space-y-4">
|
||||
<div className="space-y-1">
|
||||
<h2 className="text-xl font-semibold">You're all set</h2>
|
||||
<p className="text-sm text-gray-600">
|
||||
Review the setup summary and launch Mosaic Stack.
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<div className="rounded-md border bg-gray-50 p-4">
|
||||
<ul className="space-y-2 text-sm">
|
||||
<li>
|
||||
<span className="font-medium">Admin:</span>{" "}
|
||||
{configuredUsername ? `${configuredUsername} configured` : "Not configured"}
|
||||
</li>
|
||||
<li>
|
||||
<span className="font-medium">OIDC:</span>{" "}
|
||||
{oidcConfigured ? "Configured" : "Skipped for now"}
|
||||
</li>
|
||||
<li>
|
||||
<span className="font-medium">LLM Provider:</span>{" "}
|
||||
{providerConfigured
|
||||
? `${providerConfigured.displayName} (${providerLabel})`
|
||||
: "Not configured"}
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<Button
|
||||
type="button"
|
||||
onClick={() => void handleCompleteOnboarding()}
|
||||
disabled={isCompleting}
|
||||
>
|
||||
{isCompleting && (
|
||||
<Loader2 className="mr-2 h-4 w-4 animate-spin" aria-hidden="true" />
|
||||
)}
|
||||
<span>Launch Mosaic Stack</span>
|
||||
</Button>
|
||||
</div>
|
||||
)}
|
||||
</>
|
||||
)}
|
||||
|
||||
{errorMessage && (
|
||||
<p className="text-sm text-red-600" role="alert">
|
||||
{errorMessage}
|
||||
</p>
|
||||
)}
|
||||
</CardContent>
|
||||
</Card>
|
||||
);
|
||||
}
|
||||
|
||||
export default OnboardingWizard;
|
||||
51
apps/web/src/components/settings/FleetSettingsNav.tsx
Normal file
51
apps/web/src/components/settings/FleetSettingsNav.tsx
Normal file
@@ -0,0 +1,51 @@
|
||||
"use client";
|
||||
|
||||
import Link from "next/link";
|
||||
import { usePathname } from "next/navigation";
|
||||
import { Card, CardContent } from "@/components/ui/card";
|
||||
|
||||
interface FleetSettingsLink {
|
||||
href: string;
|
||||
label: string;
|
||||
}
|
||||
|
||||
const FLEET_SETTINGS_LINKS: FleetSettingsLink[] = [
|
||||
{ href: "/settings/providers", label: "Providers" },
|
||||
{ href: "/settings/agent-config", label: "Agent Config" },
|
||||
{ href: "/settings/auth", label: "Authentication" },
|
||||
];
|
||||
|
||||
export function FleetSettingsNav(): React.JSX.Element {
|
||||
const pathname = usePathname();
|
||||
|
||||
return (
|
||||
<Card>
|
||||
<CardContent className="px-4 py-3 flex flex-wrap items-center gap-2">
|
||||
<Link
|
||||
href="/settings"
|
||||
className="inline-flex h-9 items-center rounded-md px-3 text-sm font-medium text-muted-foreground hover:text-foreground hover:bg-muted transition-colors"
|
||||
>
|
||||
All Settings
|
||||
</Link>
|
||||
|
||||
{FLEET_SETTINGS_LINKS.map((link) => {
|
||||
const isActive = pathname === link.href;
|
||||
|
||||
return (
|
||||
<Link
|
||||
key={link.href}
|
||||
href={link.href}
|
||||
className={`inline-flex h-9 items-center rounded-md px-3 text-sm font-medium transition-colors ${
|
||||
isActive
|
||||
? "bg-primary text-primary-foreground"
|
||||
: "text-muted-foreground hover:text-foreground hover:bg-muted"
|
||||
}`}
|
||||
>
|
||||
{link.label}
|
||||
</Link>
|
||||
);
|
||||
})}
|
||||
</CardContent>
|
||||
</Card>
|
||||
);
|
||||
}
|
||||
162
apps/web/src/lib/api/fleet-settings.test.ts
Normal file
162
apps/web/src/lib/api/fleet-settings.test.ts
Normal file
@@ -0,0 +1,162 @@
|
||||
import { beforeEach, describe, expect, it, vi } from "vitest";
|
||||
import * as client from "./client";
|
||||
import {
|
||||
createFleetProvider,
|
||||
deleteFleetOidcConfig,
|
||||
deleteFleetProvider,
|
||||
fetchFleetAgentConfig,
|
||||
fetchFleetOidcConfig,
|
||||
fetchFleetProviders,
|
||||
resetBreakglassAdminPassword,
|
||||
updateFleetAgentConfig,
|
||||
updateFleetOidcConfig,
|
||||
updateFleetProvider,
|
||||
} from "./fleet-settings";
|
||||
|
||||
vi.mock("./client");
|
||||
|
||||
beforeEach((): void => {
|
||||
vi.clearAllMocks();
|
||||
});
|
||||
|
||||
describe("fetchFleetProviders", (): void => {
|
||||
it("calls providers list endpoint", async (): Promise<void> => {
|
||||
vi.mocked(client.apiGet).mockResolvedValueOnce([] as never);
|
||||
|
||||
await fetchFleetProviders();
|
||||
|
||||
expect(client.apiGet).toHaveBeenCalledWith("/api/fleet-settings/providers");
|
||||
});
|
||||
});
|
||||
|
||||
describe("createFleetProvider", (): void => {
|
||||
it("posts provider payload", async (): Promise<void> => {
|
||||
vi.mocked(client.apiPost).mockResolvedValueOnce({ id: "provider-1" } as never);
|
||||
|
||||
await createFleetProvider({
|
||||
name: "openai-main",
|
||||
displayName: "OpenAI Main",
|
||||
type: "openai",
|
||||
apiKey: "sk-test",
|
||||
});
|
||||
|
||||
expect(client.apiPost).toHaveBeenCalledWith("/api/fleet-settings/providers", {
|
||||
name: "openai-main",
|
||||
displayName: "OpenAI Main",
|
||||
type: "openai",
|
||||
apiKey: "sk-test",
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("updateFleetProvider", (): void => {
|
||||
it("patches provider endpoint with updates", async (): Promise<void> => {
|
||||
vi.mocked(client.apiPatch).mockResolvedValueOnce(undefined as never);
|
||||
|
||||
await updateFleetProvider("provider-1", { displayName: "OpenAI Updated", isActive: true });
|
||||
|
||||
expect(client.apiPatch).toHaveBeenCalledWith("/api/fleet-settings/providers/provider-1", {
|
||||
displayName: "OpenAI Updated",
|
||||
isActive: true,
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("deleteFleetProvider", (): void => {
|
||||
it("deletes provider endpoint", async (): Promise<void> => {
|
||||
vi.mocked(client.apiDelete).mockResolvedValueOnce(undefined as never);
|
||||
|
||||
await deleteFleetProvider("provider-1");
|
||||
|
||||
expect(client.apiDelete).toHaveBeenCalledWith("/api/fleet-settings/providers/provider-1");
|
||||
});
|
||||
});
|
||||
|
||||
describe("fetchFleetAgentConfig", (): void => {
|
||||
it("calls agent config endpoint", async (): Promise<void> => {
|
||||
vi.mocked(client.apiGet).mockResolvedValueOnce({
|
||||
primaryModel: null,
|
||||
fallbackModels: [],
|
||||
personality: null,
|
||||
} as never);
|
||||
|
||||
await fetchFleetAgentConfig();
|
||||
|
||||
expect(client.apiGet).toHaveBeenCalledWith("/api/fleet-settings/agent-config");
|
||||
});
|
||||
});
|
||||
|
||||
describe("updateFleetAgentConfig", (): void => {
|
||||
it("patches agent config", async (): Promise<void> => {
|
||||
vi.mocked(client.apiPatch).mockResolvedValueOnce(undefined as never);
|
||||
|
||||
await updateFleetAgentConfig({
|
||||
primaryModel: "openai:gpt-4o-mini",
|
||||
fallbackModels: ["openai:gpt-4.1-mini"],
|
||||
personality: "System behavior",
|
||||
});
|
||||
|
||||
expect(client.apiPatch).toHaveBeenCalledWith("/api/fleet-settings/agent-config", {
|
||||
primaryModel: "openai:gpt-4o-mini",
|
||||
fallbackModels: ["openai:gpt-4.1-mini"],
|
||||
personality: "System behavior",
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("fetchFleetOidcConfig", (): void => {
|
||||
it("calls oidc endpoint", async (): Promise<void> => {
|
||||
vi.mocked(client.apiGet).mockResolvedValueOnce({ configured: false } as never);
|
||||
|
||||
await fetchFleetOidcConfig();
|
||||
|
||||
expect(client.apiGet).toHaveBeenCalledWith("/api/fleet-settings/oidc");
|
||||
});
|
||||
});
|
||||
|
||||
describe("updateFleetOidcConfig", (): void => {
|
||||
it("issues a PUT request with payload", async (): Promise<void> => {
|
||||
vi.mocked(client.apiRequest).mockResolvedValueOnce(undefined as never);
|
||||
|
||||
await updateFleetOidcConfig({
|
||||
issuerUrl: "https://issuer.example.com",
|
||||
clientId: "mosaic-client",
|
||||
clientSecret: "top-secret",
|
||||
});
|
||||
|
||||
expect(client.apiRequest).toHaveBeenCalledWith("/api/fleet-settings/oidc", {
|
||||
method: "PUT",
|
||||
body: JSON.stringify({
|
||||
issuerUrl: "https://issuer.example.com",
|
||||
clientId: "mosaic-client",
|
||||
clientSecret: "top-secret",
|
||||
}),
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("deleteFleetOidcConfig", (): void => {
|
||||
it("deletes oidc endpoint", async (): Promise<void> => {
|
||||
vi.mocked(client.apiDelete).mockResolvedValueOnce(undefined as never);
|
||||
|
||||
await deleteFleetOidcConfig();
|
||||
|
||||
expect(client.apiDelete).toHaveBeenCalledWith("/api/fleet-settings/oidc");
|
||||
});
|
||||
});
|
||||
|
||||
describe("resetBreakglassAdminPassword", (): void => {
|
||||
it("posts breakglass reset payload", async (): Promise<void> => {
|
||||
vi.mocked(client.apiPost).mockResolvedValueOnce(undefined as never);
|
||||
|
||||
await resetBreakglassAdminPassword({
|
||||
username: "admin",
|
||||
newPassword: "new-password-123",
|
||||
});
|
||||
|
||||
expect(client.apiPost).toHaveBeenCalledWith("/api/fleet-settings/breakglass/reset-password", {
|
||||
username: "admin",
|
||||
newPassword: "new-password-123",
|
||||
});
|
||||
});
|
||||
});
|
||||
129
apps/web/src/lib/api/fleet-settings.ts
Normal file
129
apps/web/src/lib/api/fleet-settings.ts
Normal file
@@ -0,0 +1,129 @@
|
||||
import { apiDelete, apiGet, apiPatch, apiPost, apiRequest } from "./client";
|
||||
|
||||
export interface FleetProviderModel {
|
||||
id: string;
|
||||
name?: string;
|
||||
}
|
||||
|
||||
export interface FleetProvider {
|
||||
id: string;
|
||||
name: string;
|
||||
displayName: string;
|
||||
type: string;
|
||||
baseUrl: string | null;
|
||||
isActive: boolean;
|
||||
models: unknown;
|
||||
}
|
||||
|
||||
export interface CreateFleetProviderRequest {
|
||||
name: string;
|
||||
displayName: string;
|
||||
type: string;
|
||||
baseUrl?: string;
|
||||
apiKey?: string;
|
||||
apiType?: string;
|
||||
models?: FleetProviderModel[];
|
||||
}
|
||||
|
||||
export interface UpdateFleetProviderRequest {
|
||||
displayName?: string;
|
||||
baseUrl?: string;
|
||||
apiKey?: string;
|
||||
isActive?: boolean;
|
||||
models?: FleetProviderModel[];
|
||||
}
|
||||
|
||||
export interface FleetAgentConfig {
|
||||
primaryModel: string | null;
|
||||
fallbackModels: string[];
|
||||
personality: string | null;
|
||||
}
|
||||
|
||||
interface FleetAgentConfigResponse {
|
||||
primaryModel: string | null;
|
||||
fallbackModels: unknown[];
|
||||
personality: string | null;
|
||||
}
|
||||
|
||||
export interface UpdateFleetAgentConfigRequest {
|
||||
primaryModel?: string;
|
||||
fallbackModels?: string[];
|
||||
personality?: string;
|
||||
}
|
||||
|
||||
export interface FleetOidcConfig {
|
||||
issuerUrl?: string;
|
||||
clientId?: string;
|
||||
configured: boolean;
|
||||
}
|
||||
|
||||
export interface UpdateFleetOidcConfigRequest {
|
||||
issuerUrl: string;
|
||||
clientId: string;
|
||||
clientSecret: string;
|
||||
}
|
||||
|
||||
export interface ResetBreakglassAdminPasswordRequest {
|
||||
username: string;
|
||||
newPassword: string;
|
||||
}
|
||||
|
||||
function normalizeStringArray(value: unknown[]): string[] {
|
||||
return value.filter((item): item is string => typeof item === "string");
|
||||
}
|
||||
|
||||
export async function fetchFleetProviders(): Promise<FleetProvider[]> {
|
||||
return apiGet<FleetProvider[]>("/api/fleet-settings/providers");
|
||||
}
|
||||
|
||||
export async function createFleetProvider(
|
||||
data: CreateFleetProviderRequest
|
||||
): Promise<{ id: string }> {
|
||||
return apiPost<{ id: string }>("/api/fleet-settings/providers", data);
|
||||
}
|
||||
|
||||
export async function updateFleetProvider(
|
||||
providerId: string,
|
||||
data: UpdateFleetProviderRequest
|
||||
): Promise<void> {
|
||||
await apiPatch<unknown>(`/api/fleet-settings/providers/${providerId}`, data);
|
||||
}
|
||||
|
||||
export async function deleteFleetProvider(providerId: string): Promise<void> {
|
||||
await apiDelete<unknown>(`/api/fleet-settings/providers/${providerId}`);
|
||||
}
|
||||
|
||||
export async function fetchFleetAgentConfig(): Promise<FleetAgentConfig> {
|
||||
const response = await apiGet<FleetAgentConfigResponse>("/api/fleet-settings/agent-config");
|
||||
|
||||
return {
|
||||
primaryModel: response.primaryModel,
|
||||
fallbackModels: normalizeStringArray(response.fallbackModels),
|
||||
personality: response.personality,
|
||||
};
|
||||
}
|
||||
|
||||
export async function updateFleetAgentConfig(data: UpdateFleetAgentConfigRequest): Promise<void> {
|
||||
await apiPatch<unknown>("/api/fleet-settings/agent-config", data);
|
||||
}
|
||||
|
||||
export async function fetchFleetOidcConfig(): Promise<FleetOidcConfig> {
|
||||
return apiGet<FleetOidcConfig>("/api/fleet-settings/oidc");
|
||||
}
|
||||
|
||||
export async function updateFleetOidcConfig(data: UpdateFleetOidcConfigRequest): Promise<void> {
|
||||
await apiRequest<unknown>("/api/fleet-settings/oidc", {
|
||||
method: "PUT",
|
||||
body: JSON.stringify(data),
|
||||
});
|
||||
}
|
||||
|
||||
export async function deleteFleetOidcConfig(): Promise<void> {
|
||||
await apiDelete<unknown>("/api/fleet-settings/oidc");
|
||||
}
|
||||
|
||||
export async function resetBreakglassAdminPassword(
|
||||
data: ResetBreakglassAdminPasswordRequest
|
||||
): Promise<void> {
|
||||
await apiPost<unknown>("/api/fleet-settings/breakglass/reset-password", data);
|
||||
}
|
||||
@@ -17,3 +17,4 @@ export * from "./dashboard";
|
||||
export * from "./projects";
|
||||
export * from "./workspaces";
|
||||
export * from "./admin";
|
||||
export * from "./fleet-settings";
|
||||
|
||||
80
apps/web/src/lib/api/onboarding.ts
Normal file
80
apps/web/src/lib/api/onboarding.ts
Normal file
@@ -0,0 +1,80 @@
|
||||
import { apiGet, apiPost } from "./client";
|
||||
|
||||
export interface OnboardingStatus {
|
||||
completed: boolean;
|
||||
}
|
||||
|
||||
export interface BreakglassAdminRequest {
|
||||
username: string;
|
||||
password: string;
|
||||
}
|
||||
|
||||
export interface BreakglassAdminResponse {
|
||||
id: string;
|
||||
username: string;
|
||||
}
|
||||
|
||||
export interface ConfigureOidcRequest {
|
||||
issuerUrl: string;
|
||||
clientId: string;
|
||||
clientSecret: string;
|
||||
}
|
||||
|
||||
export interface ProviderModel {
|
||||
id: string;
|
||||
name?: string;
|
||||
}
|
||||
|
||||
export interface AddOnboardingProviderRequest {
|
||||
name: string;
|
||||
displayName: string;
|
||||
type: string;
|
||||
baseUrl?: string;
|
||||
apiKey?: string;
|
||||
models?: ProviderModel[];
|
||||
}
|
||||
|
||||
export interface AddOnboardingProviderResponse {
|
||||
id: string;
|
||||
}
|
||||
|
||||
export interface TestOnboardingProviderRequest {
|
||||
type: string;
|
||||
baseUrl?: string;
|
||||
apiKey?: string;
|
||||
}
|
||||
|
||||
export interface TestOnboardingProviderResponse {
|
||||
success: boolean;
|
||||
error?: string;
|
||||
}
|
||||
|
||||
export async function fetchOnboardingStatus(): Promise<OnboardingStatus> {
|
||||
return apiGet<OnboardingStatus>("/api/onboarding/status");
|
||||
}
|
||||
|
||||
export async function createBreakglassAdmin(
|
||||
request: BreakglassAdminRequest
|
||||
): Promise<BreakglassAdminResponse> {
|
||||
return apiPost<BreakglassAdminResponse>("/api/onboarding/breakglass", request);
|
||||
}
|
||||
|
||||
export async function configureOidcProvider(request: ConfigureOidcRequest): Promise<void> {
|
||||
await apiPost<unknown>("/api/onboarding/oidc", request);
|
||||
}
|
||||
|
||||
export async function addOnboardingProvider(
|
||||
request: AddOnboardingProviderRequest
|
||||
): Promise<AddOnboardingProviderResponse> {
|
||||
return apiPost<AddOnboardingProviderResponse>("/api/onboarding/provider", request);
|
||||
}
|
||||
|
||||
export async function testOnboardingProvider(
|
||||
request: TestOnboardingProviderRequest
|
||||
): Promise<TestOnboardingProviderResponse> {
|
||||
return apiPost<TestOnboardingProviderResponse>("/api/onboarding/provider/test", request);
|
||||
}
|
||||
|
||||
export async function completeOnboarding(): Promise<void> {
|
||||
await apiPost<unknown>("/api/onboarding/complete");
|
||||
}
|
||||
@@ -121,6 +121,10 @@ services:
|
||||
OLLAMA_ENDPOINT: ${OLLAMA_ENDPOINT}
|
||||
OPENBAO_ADDR: ${OPENBAO_ADDR}
|
||||
ENCRYPTION_KEY: ${ENCRYPTION_KEY}
|
||||
# MS22: fleet encryption key (AES-256-GCM for provider API keys, agent tokens)
|
||||
MOSAIC_SECRET_KEY: ${MOSAIC_SECRET_KEY}
|
||||
# MS22: Docker socket for per-user container lifecycle (optional: set DOCKER_HOST for TCP)
|
||||
DOCKER_HOST: ${DOCKER_HOST:-}
|
||||
# Matrix bridge (optional — configure after Synapse is running)
|
||||
MATRIX_HOMESERVER_URL: ${MATRIX_HOMESERVER_URL:-http://synapse:8008}
|
||||
MATRIX_ACCESS_TOKEN: ${MATRIX_ACCESS_TOKEN:-}
|
||||
@@ -142,6 +146,8 @@ services:
|
||||
NEXT_PUBLIC_APP_URL: ${NEXT_PUBLIC_APP_URL}
|
||||
NEXT_PUBLIC_API_URL: ${NEXT_PUBLIC_API_URL}
|
||||
TRUSTED_ORIGINS: ${TRUSTED_ORIGINS:-}
|
||||
volumes:
|
||||
- /var/run/docker.sock:/var/run/docker.sock:ro
|
||||
healthcheck:
|
||||
test:
|
||||
[
|
||||
|
||||
3
docker/.env.example
Normal file
3
docker/.env.example
Normal file
@@ -0,0 +1,3 @@
|
||||
DATABASE_URL=postgresql://mosaic:changeme@postgres:5432/mosaic
|
||||
DATABASE_PASSWORD=changeme
|
||||
MOSAIC_SECRET_KEY=your-secret-key-at-least-32-characters-long
|
||||
40
docker/README.md
Normal file
40
docker/README.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Mosaic Docker (Core Services)
|
||||
|
||||
This folder includes the Compose stack for **core Mosaic services only**:
|
||||
|
||||
- `mosaic-api`
|
||||
- `mosaic-web`
|
||||
- `postgres`
|
||||
|
||||
User OpenClaw containers are **not** defined in Compose. They are created and managed dynamically by the API's `ContainerLifecycleService` through Docker socket access.
|
||||
|
||||
## Start the stack
|
||||
|
||||
```bash
|
||||
docker compose -f docker/mosaic-compose.yml up -d
|
||||
```
|
||||
|
||||
## Required environment variables
|
||||
|
||||
- `DATABASE_URL`
|
||||
- `MOSAIC_SECRET_KEY`
|
||||
- `DATABASE_PASSWORD`
|
||||
|
||||
Use [`docker/.env.example`](./.env.example) as a starting point.
|
||||
|
||||
## Architecture overview
|
||||
|
||||
See the design doc: [`docs/design/MS22-DB-CENTRIC-ARCHITECTURE.md`](../docs/design/MS22-DB-CENTRIC-ARCHITECTURE.md)
|
||||
|
||||
`mosaic-agents` is an internal-only bridge network reserved for dynamically created user containers.
|
||||
|
||||
## OpenClaw entrypoint behavior
|
||||
|
||||
`docker/openclaw-entrypoint.sh` is intended for dynamically created user OpenClaw containers:
|
||||
|
||||
1. Validates required env vars (`MOSAIC_API_URL`, `AGENT_TOKEN`, `AGENT_ID`).
|
||||
2. Fetches agent-specific OpenClaw config from Mosaic API internal endpoint.
|
||||
3. Writes the config to `/tmp/openclaw.json`.
|
||||
4. Starts OpenClaw gateway with `OPENCLAW_CONFIG_PATH=/tmp/openclaw.json`.
|
||||
|
||||
`docker/openclaw-healthcheck.sh` probes `http://localhost:18789/health` for container health.
|
||||
53
docker/mosaic-compose.yml
Normal file
53
docker/mosaic-compose.yml
Normal file
@@ -0,0 +1,53 @@
|
||||
services:
|
||||
mosaic-api:
|
||||
image: mosaic/api:latest
|
||||
environment:
|
||||
DATABASE_URL: ${DATABASE_URL}
|
||||
MOSAIC_SECRET_KEY: ${MOSAIC_SECRET_KEY}
|
||||
volumes:
|
||||
- /var/run/docker.sock:/var/run/docker.sock
|
||||
networks:
|
||||
- internal
|
||||
healthcheck:
|
||||
test: ["CMD", "curl", "-f", "http://localhost:4000/api/health"]
|
||||
interval: 30s
|
||||
timeout: 10s
|
||||
retries: 3
|
||||
|
||||
mosaic-web:
|
||||
image: mosaic/web:latest
|
||||
environment:
|
||||
NEXT_PUBLIC_API_URL: http://mosaic-api:4000
|
||||
ports:
|
||||
- "3000:3000"
|
||||
networks:
|
||||
- internal
|
||||
depends_on:
|
||||
mosaic-api:
|
||||
condition: service_healthy
|
||||
|
||||
postgres:
|
||||
image: postgres:17-alpine
|
||||
environment:
|
||||
POSTGRES_DB: mosaic
|
||||
POSTGRES_USER: mosaic
|
||||
POSTGRES_PASSWORD: ${DATABASE_PASSWORD}
|
||||
volumes:
|
||||
- postgres-data:/var/lib/postgresql/data
|
||||
networks:
|
||||
- internal
|
||||
healthcheck:
|
||||
test: ["CMD-SHELL", "pg_isready -U mosaic"]
|
||||
interval: 10s
|
||||
timeout: 5s
|
||||
retries: 5
|
||||
|
||||
networks:
|
||||
internal:
|
||||
driver: bridge
|
||||
mosaic-agents:
|
||||
driver: bridge
|
||||
internal: true
|
||||
|
||||
volumes:
|
||||
postgres-data:
|
||||
20
docker/openclaw-entrypoint.sh
Executable file
20
docker/openclaw-entrypoint.sh
Executable file
@@ -0,0 +1,20 @@
|
||||
#!/bin/sh
|
||||
set -e
|
||||
: "${MOSAIC_API_URL:?MOSAIC_API_URL is required}"
|
||||
: "${AGENT_TOKEN:?AGENT_TOKEN is required}"
|
||||
: "${AGENT_ID:?AGENT_ID is required}"
|
||||
|
||||
echo "[entrypoint] Fetching config for agent ${AGENT_ID}..."
|
||||
HTTP_CODE=$(curl -sf -w "%{http_code}" \
|
||||
"${MOSAIC_API_URL}/api/internal/agent-config/${AGENT_ID}" \
|
||||
-H "Authorization: Bearer ${AGENT_TOKEN}" \
|
||||
-o /tmp/openclaw.json)
|
||||
|
||||
if [ "$HTTP_CODE" != "200" ]; then
|
||||
echo "[entrypoint] ERROR: Config fetch failed with HTTP ${HTTP_CODE}"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "[entrypoint] Config loaded. Starting OpenClaw gateway..."
|
||||
export OPENCLAW_CONFIG_PATH=/tmp/openclaw.json
|
||||
exec openclaw gateway run --bind lan --auth token
|
||||
2
docker/openclaw-healthcheck.sh
Executable file
2
docker/openclaw-healthcheck.sh
Executable file
@@ -0,0 +1,2 @@
|
||||
#!/bin/sh
|
||||
curl -sf http://localhost:18789/health || exit 1
|
||||
114
docs/PRD-MS22.md
Normal file
114
docs/PRD-MS22.md
Normal file
@@ -0,0 +1,114 @@
|
||||
# PRD: MS22 — Fleet Evolution (DB-Centric Agent Architecture)
|
||||
|
||||
## Metadata
|
||||
|
||||
- Owner: Jason Woltje
|
||||
- Date: 2026-03-01
|
||||
- Status: in-progress
|
||||
- Design Doc: `docs/design/MS22-DB-CENTRIC-ARCHITECTURE.md`
|
||||
|
||||
## Problem Statement
|
||||
|
||||
Mosaic Stack needs a multi-user agent fleet where each user gets their own isolated OpenClaw instance with their own LLM provider credentials and agent config. The system must be Docker-first with minimal environment variables and all configuration managed through the WebUI.
|
||||
|
||||
## Objectives
|
||||
|
||||
1. **Minimal bootstrap** — 2 env vars (`DATABASE_URL`, `MOSAIC_SECRET_KEY`) to start the entire stack
|
||||
2. **DB-centric config** — All runtime config in Postgres, managed via WebUI
|
||||
3. **Per-user isolation** — Each user gets their own OpenClaw container with own API keys, memory, sessions
|
||||
4. **Onboarding wizard** — First-boot experience: breakglass admin → OIDC → LLM provider → agent config
|
||||
5. **Settings UI** — Runtime management of providers, agents, and auth config
|
||||
6. **Mosaic as gatekeeper** — Users never talk to OpenClaw directly; Mosaic proxies all requests
|
||||
7. **Zero cross-user access** — Full container, volume, and DB isolation between users
|
||||
|
||||
## Security Requirements
|
||||
|
||||
- User A cannot access User B's API keys, chat history, or agent memory
|
||||
- All API keys stored encrypted (AES-256-GCM) in database
|
||||
- Breakglass admin always works as OIDC fallback
|
||||
- OIDC config stored in DB (not env vars) — configured via settings UI
|
||||
- Container-to-container communication blocked by default
|
||||
- Admin cannot decrypt other users' API keys
|
||||
|
||||
## Phase 0: Knowledge Layer — COMPLETE
|
||||
|
||||
- Findings API (pgvector, CRUD, similarity search)
|
||||
- AgentMemory API (key/value store)
|
||||
- ConversationArchive API (pgvector, ingest, search)
|
||||
- OpenClaw mosaic skill
|
||||
- Session log ingestion pipeline
|
||||
|
||||
## Phase 1: DB-Centric Agent Fleet
|
||||
|
||||
### Phase 1a: DB Schema — COMPLETE
|
||||
|
||||
- SystemConfig, BreakglassUser, LlmProvider, UserContainer, SystemContainer, UserAgentConfig tables
|
||||
|
||||
### Phase 1b: Encryption Service — COMPLETE
|
||||
|
||||
- CryptoService (AES-256-GCM using MOSAIC_SECRET_KEY)
|
||||
|
||||
### Phase 1c: Internal Config API
|
||||
|
||||
- `GET /api/internal/agent-config/:id` — assembles openclaw.json from DB
|
||||
- Auth: bearer token (container's own gateway token)
|
||||
- Returns complete openclaw.json with decrypted provider credentials
|
||||
|
||||
### Phase 1d: Container Lifecycle Manager
|
||||
|
||||
- Docker API integration via `dockerode` npm package
|
||||
- Start/stop/health-check/reap user containers
|
||||
- Auto-generate gateway tokens, assign ports
|
||||
- Docker socket access required (`/var/run/docker.sock`)
|
||||
|
||||
### Phase 1e: Onboarding API
|
||||
|
||||
- First-boot detection (`SystemConfig.onboarding.completed`)
|
||||
- `POST /api/onboarding/breakglass` — create admin user
|
||||
- `POST /api/onboarding/oidc` — save OIDC provider config
|
||||
- `POST /api/onboarding/provider` — add LLM provider + test connection
|
||||
- `POST /api/onboarding/complete` — mark done
|
||||
|
||||
### Phase 1f: Onboarding Wizard UI
|
||||
|
||||
- Multi-step wizard component
|
||||
- Skip-able OIDC step
|
||||
- LLM provider connection test
|
||||
|
||||
### Phase 1g: Settings API
|
||||
|
||||
- CRUD: LLM providers (per-user scoped)
|
||||
- CRUD: Agent config (model assignments, personalities)
|
||||
- CRUD: OIDC config (admin only)
|
||||
- Breakglass password reset (admin only)
|
||||
|
||||
### Phase 1h: Settings UI
|
||||
|
||||
- Settings/Providers page
|
||||
- Settings/Agent Config page
|
||||
- Settings/Auth page (OIDC + breakglass)
|
||||
|
||||
### Phase 1i: Chat Proxy
|
||||
|
||||
- Route WebUI chat to user's OpenClaw container
|
||||
- SSE streaming pass-through
|
||||
- Ensure container is running before proxying (auto-start)
|
||||
|
||||
### Phase 1j: Docker Compose + Entrypoint
|
||||
|
||||
- Simplified compose (core services only — user containers are dynamic)
|
||||
- Entrypoint: fetch config from API, write openclaw.json, start gateway
|
||||
- Health check integration
|
||||
|
||||
### Phase 1k: Idle Reaper
|
||||
|
||||
- Cron job to stop inactive user containers
|
||||
- Configurable idle timeout (default 30min)
|
||||
- Preserve state volumes
|
||||
|
||||
## Future Phases (out of scope)
|
||||
|
||||
- Phase 2: Agent fleet standup (predefined agent roles)
|
||||
- Phase 3: WebUI chat + task management integration
|
||||
- Phase 4: Multi-LLM provider management UI (advanced)
|
||||
- Team workspaces (shared agent contexts) — explicitly out of scope
|
||||
@@ -76,16 +76,16 @@ Remaining estimate: ~143K tokens (Codex budget).
|
||||
|
||||
Design doc: `docs/design/MS22-DB-CENTRIC-ARCHITECTURE.md`
|
||||
|
||||
| Task ID | Status | Phase | Description | Issue | Scope | Branch | Depends On | Blocks | Assigned Worker | Started | Completed | Est Tokens | Act Tokens | Notes |
|
||||
| -------- | ----------- | -------- | --------------------------------------------------------------------------------------------------------------------- | ----- | ------- | ---------------------------- | ---------- | --------------- | --------------- | ------- | --------- | ---------- | ---------- | ----- |
|
||||
| MS22-P1a | not-started | phase-1a | Prisma schema: SystemConfig, BreakglassUser, LlmProvider, UserContainer, SystemContainer, UserAgentConfig + migration | — | api | feat/ms22-p1a-schema | — | P1b,P1c,P1d,P1e | — | — | — | 20K | — | |
|
||||
| MS22-P1b | not-started | phase-1b | Encryption service (AES-256-GCM) for API keys and tokens | — | api | feat/ms22-p1b-crypto | — | P1c,P1e,P1g | — | — | — | 15K | — | |
|
||||
| MS22-P1c | not-started | phase-1c | Internal config endpoint: assemble openclaw.json from DB | — | api | feat/ms22-p1c-config-api | P1a,P1b | P1i,P1j | — | — | — | 20K | — | |
|
||||
| MS22-P1d | not-started | phase-1d | ContainerLifecycleService: Docker API (dockerode) start/stop/health/reap | — | api | feat/ms22-p1d-container-mgr | P1a | P1i,P1k | — | — | — | 25K | — | |
|
||||
| MS22-P1e | not-started | phase-1e | Onboarding API: breakglass, OIDC, provider, agents, complete | — | api | feat/ms22-p1e-onboarding-api | P1a,P1b | P1f | — | — | — | 20K | — | |
|
||||
| MS22-P1f | not-started | phase-1f | Onboarding wizard WebUI (multi-step form) | — | web | feat/ms22-p1f-onboarding-ui | P1e | — | — | — | — | 25K | — | |
|
||||
| MS22-P1g | not-started | phase-1g | Settings API: CRUD providers, agent config, OIDC, breakglass | — | api | feat/ms22-p1g-settings-api | P1a,P1b | P1h | — | — | — | 20K | — | |
|
||||
| MS22-P1h | not-started | phase-1h | Settings UI: Providers, Agent Config, Auth pages | — | web | feat/ms22-p1h-settings-ui | P1g | — | — | — | — | 25K | — | |
|
||||
| MS22-P1i | not-started | phase-1i | Chat proxy: route WebUI chat to user's OpenClaw container (SSE) | — | api+web | feat/ms22-p1i-chat-proxy | P1c,P1d | — | — | — | — | 20K | — | |
|
||||
| MS22-P1j | not-started | phase-1j | Docker entrypoint + health checks + core compose | — | docker | feat/ms22-p1j-docker | P1c | — | — | — | — | 10K | — | |
|
||||
| MS22-P1k | not-started | phase-1k | Idle reaper cron: stop inactive user containers | — | api | feat/ms22-p1k-idle-reaper | P1d | — | — | — | — | 10K | — | |
|
||||
| Task ID | Status | Phase | Description | Issue | Scope | Branch | Depends On | Blocks | Assigned Worker | Started | Completed | Est Tokens | Act Tokens | Notes |
|
||||
| -------- | ------ | -------- | --------------------------------------------------------------------------------------------------------------------- | ----- | ------- | ---------------------------- | ---------- | --------------- | --------------- | ------- | --------- | ---------- | ---------- | ----- |
|
||||
| MS22-P1a | done | phase-1a | Prisma schema: SystemConfig, BreakglassUser, LlmProvider, UserContainer, SystemContainer, UserAgentConfig + migration | — | api | feat/ms22-p1a-schema | — | P1b,P1c,P1d,P1e | — | — | — | 20K | — | |
|
||||
| MS22-P1b | done | phase-1b | Encryption service (AES-256-GCM) for API keys and tokens | — | api | feat/ms22-p1b-crypto | — | P1c,P1e,P1g | — | — | — | 15K | — | |
|
||||
| MS22-P1c | done | phase-1c | Internal config endpoint: assemble openclaw.json from DB | — | api | feat/ms22-p1c-config-api | P1a,P1b | P1i,P1j | — | — | — | 20K | — | |
|
||||
| MS22-P1d | done | phase-1d | ContainerLifecycleService: Docker API (dockerode) start/stop/health/reap | — | api | feat/ms22-p1d-container-mgr | P1a | P1i,P1k | — | — | — | 25K | — | |
|
||||
| MS22-P1e | done | phase-1e | Onboarding API: breakglass, OIDC, provider, agents, complete | — | api | feat/ms22-p1e-onboarding-api | P1a,P1b | P1f | — | — | — | 20K | — | |
|
||||
| MS22-P1f | done | phase-1f | Onboarding wizard WebUI (multi-step form) | — | web | feat/ms22-p1f-onboarding-ui | P1e | — | — | — | — | 25K | — | |
|
||||
| MS22-P1g | done | phase-1g | Settings API: CRUD providers, agent config, OIDC, breakglass | — | api | feat/ms22-p1g-settings-api | P1a,P1b | P1h | — | — | — | 20K | — | |
|
||||
| MS22-P1h | done | phase-1h | Settings UI: Providers, Agent Config, Auth pages | — | web | feat/ms22-p1h-settings-ui | P1g | — | — | — | — | 25K | — | |
|
||||
| MS22-P1i | done | phase-1i | Chat proxy: route WebUI chat to user's OpenClaw container (SSE) | — | api+web | feat/ms22-p1i-chat-proxy | P1c,P1d | — | — | — | — | 20K | — | |
|
||||
| MS22-P1j | done | phase-1j | Docker entrypoint + health checks + core compose | — | docker | feat/ms22-p1j-docker | P1c | — | — | — | — | 10K | — | |
|
||||
| MS22-P1k | done | phase-1k | Idle reaper cron: stop inactive user containers | — | api | feat/ms22-p1k-idle-reaper | P1d | — | — | — | — | 10K | — | |
|
||||
|
||||
36
pnpm-lock.yaml
generated
36
pnpm-lock.yaml
generated
@@ -102,6 +102,9 @@ importers:
|
||||
'@nestjs/platform-socket.io':
|
||||
specifier: ^11.1.12
|
||||
version: 11.1.12(@nestjs/common@11.1.12(class-transformer@0.5.1)(class-validator@0.14.3)(reflect-metadata@0.2.2)(rxjs@7.8.2))(@nestjs/websockets@11.1.12)(rxjs@7.8.2)
|
||||
'@nestjs/schedule':
|
||||
specifier: ^6.1.1
|
||||
version: 6.1.1(@nestjs/common@11.1.12(class-transformer@0.5.1)(class-validator@0.14.3)(reflect-metadata@0.2.2)(rxjs@7.8.2))(@nestjs/core@11.1.12)
|
||||
'@nestjs/throttler':
|
||||
specifier: ^6.5.0
|
||||
version: 6.5.0(@nestjs/common@11.1.12(class-transformer@0.5.1)(class-validator@0.14.3)(reflect-metadata@0.2.2)(rxjs@7.8.2))(@nestjs/core@11.1.12)(reflect-metadata@0.2.2)
|
||||
@@ -171,6 +174,9 @@ importers:
|
||||
discord.js:
|
||||
specifier: ^14.25.1
|
||||
version: 14.25.1
|
||||
dockerode:
|
||||
specifier: ^4.0.9
|
||||
version: 4.0.9
|
||||
gray-matter:
|
||||
specifier: ^4.0.3
|
||||
version: 4.0.3
|
||||
@@ -253,6 +259,9 @@ importers:
|
||||
'@types/cookie-parser':
|
||||
specifier: ^1.4.10
|
||||
version: 1.4.10(@types/express@5.0.6)
|
||||
'@types/dockerode':
|
||||
specifier: ^3.3.47
|
||||
version: 3.3.47
|
||||
'@types/express':
|
||||
specifier: ^5.0.1
|
||||
version: 5.0.6
|
||||
@@ -1604,7 +1613,6 @@ packages:
|
||||
|
||||
'@mosaicstack/telemetry-client@0.1.1':
|
||||
resolution: {integrity: sha512-1udg6p4cs8rhQgQ2pKCfi7EpRlJieRRhA5CIqthRQ6HQZLgQ0wH+632jEulov3rlHSM1iplIQ+AAe5DWrvSkEA==, tarball: https://git.mosaicstack.dev/api/packages/mosaic/npm/%40mosaicstack%2Ftelemetry-client/-/0.1.1/telemetry-client-0.1.1.tgz}
|
||||
engines: {node: '>=18'}
|
||||
|
||||
'@mrleebo/prisma-ast@0.13.1':
|
||||
resolution: {integrity: sha512-XyroGQXcHrZdvmrGJvsA9KNeOOgGMg1Vg9OlheUsBOSKznLMDl+YChxbkboRHvtFYJEMRYmlV3uoo/njCw05iw==}
|
||||
@@ -1736,6 +1744,12 @@ packages:
|
||||
'@nestjs/websockets': ^11.0.0
|
||||
rxjs: ^7.1.0
|
||||
|
||||
'@nestjs/schedule@6.1.1':
|
||||
resolution: {integrity: sha512-kQl1RRgi02GJ0uaUGCrXHCcwISsCsJDciCKe38ykJZgnAeeoeVWs8luWtBo4AqAAXm4nS5K8RlV0smHUJ4+2FA==}
|
||||
peerDependencies:
|
||||
'@nestjs/common': ^10.0.0 || ^11.0.0
|
||||
'@nestjs/core': ^10.0.0 || ^11.0.0
|
||||
|
||||
'@nestjs/schematics@11.0.9':
|
||||
resolution: {integrity: sha512-0NfPbPlEaGwIT8/TCThxLzrlz3yzDNkfRNpbL7FiplKq3w4qXpJg0JYwqgMEJnLQZm3L/L/5XjoyfJHUO3qX9g==}
|
||||
peerDependencies:
|
||||
@@ -3236,6 +3250,9 @@ packages:
|
||||
'@types/linkify-it@5.0.0':
|
||||
resolution: {integrity: sha512-sVDA58zAw4eWAffKOaQH5/5j3XeayukzDk+ewSsnv3p4yJEZHCCzMDiZM8e0OUrRvmpGZ85jf4yDHkHsgBNr9Q==}
|
||||
|
||||
'@types/luxon@3.7.1':
|
||||
resolution: {integrity: sha512-H3iskjFIAn5SlJU7OuxUmTEpebK6TKB8rxZShDslBMZJ5u9S//KM1sbdAisiSrqwLQncVjnpi2OK2J51h+4lsg==}
|
||||
|
||||
'@types/markdown-it@13.0.9':
|
||||
resolution: {integrity: sha512-1XPwR0+MgXLWfTn9gCsZ55AHOKW1WN+P9vr0PaQh5aerR9LLQXUbjfEAFhjmEmyoYFWAyuN2Mqkn40MZ4ukjBw==}
|
||||
|
||||
@@ -4246,6 +4263,10 @@ packages:
|
||||
resolution: {integrity: sha512-p0SaNjrHOnQeR8/VnfGbmg9te2kfyYSQ7Sc/j/6DtPL3JQvKxmjO9TSjNFpujqV3vEYYBvNNvXSxzyksBWAx1Q==}
|
||||
engines: {node: '>=12.0.0'}
|
||||
|
||||
cron@4.4.0:
|
||||
resolution: {integrity: sha512-fkdfq+b+AHI4cKdhZlppHveI/mgz2qpiYxcm+t5E5TsxX7QrLS1VE0+7GENEk9z0EeGPcpSciGv6ez24duWhwQ==}
|
||||
engines: {node: '>=18.x'}
|
||||
|
||||
cross-spawn@7.0.6:
|
||||
resolution: {integrity: sha512-uV2QOWP2nWzsy2aMp8aRibhi9dlzF5Hgh5SHaB9OiTGEyDTiJJyx0uy51QXdyWbtAHNua4XJzUKca3OzKUd3vA==}
|
||||
engines: {node: '>= 8'}
|
||||
@@ -8858,6 +8879,12 @@ snapshots:
|
||||
- supports-color
|
||||
- utf-8-validate
|
||||
|
||||
'@nestjs/schedule@6.1.1(@nestjs/common@11.1.12(class-transformer@0.5.1)(class-validator@0.14.3)(reflect-metadata@0.2.2)(rxjs@7.8.2))(@nestjs/core@11.1.12)':
|
||||
dependencies:
|
||||
'@nestjs/common': 11.1.12(class-transformer@0.5.1)(class-validator@0.14.3)(reflect-metadata@0.2.2)(rxjs@7.8.2)
|
||||
'@nestjs/core': 11.1.12(@nestjs/common@11.1.12(class-transformer@0.5.1)(class-validator@0.14.3)(reflect-metadata@0.2.2)(rxjs@7.8.2))(@nestjs/platform-express@11.1.12)(@nestjs/websockets@11.1.12)(reflect-metadata@0.2.2)(rxjs@7.8.2)
|
||||
cron: 4.4.0
|
||||
|
||||
'@nestjs/schematics@11.0.9(chokidar@4.0.3)(typescript@5.9.3)':
|
||||
dependencies:
|
||||
'@angular-devkit/core': 19.2.17(chokidar@4.0.3)
|
||||
@@ -10588,6 +10615,8 @@ snapshots:
|
||||
|
||||
'@types/linkify-it@5.0.0': {}
|
||||
|
||||
'@types/luxon@3.7.1': {}
|
||||
|
||||
'@types/markdown-it@13.0.9':
|
||||
dependencies:
|
||||
'@types/linkify-it': 3.0.5
|
||||
@@ -11782,6 +11811,11 @@ snapshots:
|
||||
dependencies:
|
||||
luxon: 3.7.2
|
||||
|
||||
cron@4.4.0:
|
||||
dependencies:
|
||||
'@types/luxon': 3.7.1
|
||||
luxon: 3.7.2
|
||||
|
||||
cross-spawn@7.0.6:
|
||||
dependencies:
|
||||
path-key: 3.1.1
|
||||
|
||||
Reference in New Issue
Block a user