Merge pull request #3327 from Dokploy/refactor/separate-settings-from-users-table

refactor(settings): migrate user settings to webServerSettings schema…

Author: Siumauricio

apps/dokploy/__test__/traefik/server/update-server-config.test.ts

@@ -5,21 +5,27 @@ vi.mock("node:fs", () => ({
 	default: fs,
 }));
 
-import type { FileConfig, User } from "@dokploy/server";
+import type { FileConfig } from "@dokploy/server";
 import {
 	createDefaultServerTraefikConfig,
 	loadOrCreateConfig,
 	updateServerTraefik,
 } from "@dokploy/server";
+import type { webServerSettings } from "@dokploy/server/db/schema";
 import { beforeEach, expect, test, vi } from "vitest";
 
-const baseAdmin: User = {
+type WebServerSettings = typeof webServerSettings.$inferSelect;
+
+const baseSettings: WebServerSettings = {
+	id: "",
 	https: false,
-	enablePaidFeatures: false,
-	allowImpersonation: false,
-	role: "user",
-	firstName: "",
-	lastName: "",
+	certificateType: "none",
+	host: null,
+	serverIp: null,
+	letsEncryptEmail: null,
+	sshPrivateKey: null,
+	enableDockerCleanup: false,
+	logCleanupCron: null,
 	metricsConfig: {
 		containers: {
 			refreshRate: 20,
@@ -45,29 +51,8 @@ const baseAdmin: User = {
 	cleanupCacheApplications: false,
 	cleanupCacheOnCompose: false,
 	cleanupCacheOnPreviews: false,
-	createdAt: new Date(),
-	serverIp: null,
-	certificateType: "none",
-	host: null,
-	letsEncryptEmail: null,
-	sshPrivateKey: null,
-	enableDockerCleanup: false,
-	logCleanupCron: null,
-	serversQuantity: 0,
-	stripeCustomerId: "",
-	stripeSubscriptionId: "",
-	banExpires: new Date(),
-	banned: true,
-	banReason: "",
-	email: "",
-	expirationDate: "",
-	id: "",
-	isRegistered: false,
-	createdAt2: new Date().toISOString(),
-	emailVerified: false,
-	image: "",
+	createdAt: null,
 	updatedAt: new Date(),
-	twoFactorEnabled: false,
 };
 
 beforeEach(() => {
@@ -85,7 +70,7 @@ test("Should read the configuration file", () => {
 test("Should apply redirect-to-https", () => {
 	updateServerTraefik(
 		{
-			...baseAdmin,
+			...baseSettings,
 			https: true,
 			certificateType: "letsencrypt",
 		},
@@ -100,7 +85,7 @@ test("Should apply redirect-to-https", () => {
 });
 
 test("Should change only host when no certificate", () => {
-	updateServerTraefik(baseAdmin, "example.com");
+	updateServerTraefik(baseSettings, "example.com");
 
 	const config: FileConfig = loadOrCreateConfig("dokploy");
 
@@ -110,7 +95,7 @@ test("Should change only host when no certificate", () => {
 test("Should not touch config without host", () => {
 	const originalConfig: FileConfig = loadOrCreateConfig("dokploy");
 
-	updateServerTraefik(baseAdmin, null);
+	updateServerTraefik(baseSettings, null);
 
 	const config: FileConfig = loadOrCreateConfig("dokploy");
 
@@ -119,11 +104,14 @@ test("Should not touch config without host", () => {
 
 test("Should remove websecure if https rollback to http", () => {
 	updateServerTraefik(
-		{ ...baseAdmin, certificateType: "letsencrypt" },
+		{ ...baseSettings, certificateType: "letsencrypt" },
 		"example.com",
 	);
 
-	updateServerTraefik({ ...baseAdmin, certificateType: "none" }, "example.com");
+	updateServerTraefik(
+		{ ...baseSettings, certificateType: "none" },
+		"example.com",
+	);
 
 	const config: FileConfig = loadOrCreateConfig("dokploy");
 

apps/dokploy/components/dashboard/settings/servers/actions/toggle-docker-cleanup.tsx

@@ -7,9 +7,12 @@ interface Props {
 	serverId?: string;
 }
 export const ToggleDockerCleanup = ({ serverId }: Props) => {
-	const { data, refetch } = api.user.get.useQuery(undefined, {
-		enabled: !serverId,
-	});
+	const { data, refetch } = api.settings.getWebServerSettings.useQuery(
+		undefined,
+		{
+			enabled: !serverId,
+		},
+	);
 
 	const { data: server, refetch: refetchServer } = api.server.one.useQuery(
 		{
@@ -22,15 +25,18 @@ export const ToggleDockerCleanup = ({ serverId }: Props) => {
 
 	const enabled = serverId
 		? server?.enableDockerCleanup
-		: data?.user.enableDockerCleanup;
+		: data?.enableDockerCleanup;
 
 	const { mutateAsync } = api.settings.updateDockerCleanup.useMutation();
 
 	const handleToggle = async (checked: boolean) => {
 		try {
 			await mutateAsync({
 				enableDockerCleanup: checked,
-				serverId: serverId,
+				...(serverId && { serverId }),
+			} as {
+				enableDockerCleanup: boolean;
+				serverId?: string;
 			});
 			if (serverId) {
 				await refetchServer();

apps/dokploy/components/dashboard/settings/servers/setup-monitoring.tsx

@@ -80,7 +80,7 @@ const Schema = z.object({
 type Schema = z.infer<typeof Schema>;
 
 export const SetupMonitoring = ({ serverId }: Props) => {
-	const { data } = serverId
+	const { data: serverData } = serverId
 		? api.server.one.useQuery(
 				{
 					serverId: serverId || "",
@@ -89,7 +89,14 @@ export const SetupMonitoring = ({ serverId }: Props) => {
 					enabled: !!serverId,
 				},
 			)
-		: api.user.getServerMetrics.useQuery();
+		: { data: null };
+
+	const { data: webServerSettings } =
+		api.settings.getWebServerSettings.useQuery(undefined, {
+			enabled: !serverId,
+		});
+
+	const data = serverId ? serverData : webServerSettings;
 
 	const url = useUrl();
 

apps/dokploy/components/dashboard/settings/web-domain.tsx

@@ -67,7 +67,7 @@ type AddServerDomain = z.infer<typeof addServerDomain>;
 
 export const WebDomain = () => {
 	const { t } = useTranslation("settings");
-	const { data, refetch } = api.user.get.useQuery();
+	const { data, refetch } = api.settings.getWebServerSettings.useQuery();
 	const { mutateAsync, isLoading } =
 		api.settings.assignDomainServer.useMutation();
 
@@ -82,15 +82,15 @@ export const WebDomain = () => {
 	});
 	const https = form.watch("https");
 	const domain = form.watch("domain") || "";
-	const host = data?.user?.host || "";
+	const host = data?.host || "";
 	const hasChanged = domain !== host;
 	useEffect(() => {
 		if (data) {
 			form.reset({
-				domain: data?.user?.host || "",
-				certificateType: data?.user?.certificateType,
-				letsEncryptEmail: data?.user?.letsEncryptEmail || "",
-				https: data?.user?.https || false,
+				domain: data?.host || "",
+				certificateType: data?.certificateType || "none",
+				letsEncryptEmail: data?.letsEncryptEmail || "",
+				https: data?.https || false,
 			});
 		}
 	}, [form, form.reset, data]);

apps/dokploy/components/dashboard/settings/web-server.tsx

@@ -16,7 +16,8 @@ import { UpdateServer } from "./web-server/update-server";
 
 export const WebServer = () => {
 	const { t } = useTranslation("settings");
-	const { data } = api.user.get.useQuery();
+	const { data: webServerSettings } =
+		api.settings.getWebServerSettings.useQuery();
 
 	const { data: dokployVersion } = api.settings.getDokployVersion.useQuery();
 
@@ -53,7 +54,7 @@ export const WebServer = () => {
 
 						<div className="flex items-center flex-wrap justify-between gap-4">
 							<span className="text-sm text-muted-foreground">
-								Server IP: {data?.user.serverIp}
+								Server IP: {webServerSettings?.serverIp}
 							</span>
 							<span className="text-sm text-muted-foreground">
 								Version: {dokployVersion}

apps/dokploy/components/dashboard/settings/web-server/update-server-ip.tsx

@@ -46,29 +46,27 @@ interface Props {
 export const UpdateServerIp = ({ children }: Props) => {
 	const [isOpen, setIsOpen] = useState(false);
 
-	const { data } = api.user.get.useQuery();
+	const { data, refetch } = api.settings.getWebServerSettings.useQuery();
 	const { data: ip } = api.server.publicIp.useQuery();
 
 	const { mutateAsync, isLoading, error, isError } =
-		api.user.update.useMutation();
+		api.settings.updateServerIp.useMutation();
 
 	const form = useForm<Schema>({
 		defaultValues: {
-			serverIp: data?.user.serverIp || "",
+			serverIp: data?.serverIp || "",
 		},
 		resolver: zodResolver(schema),
 	});
 
 	useEffect(() => {
 		if (data) {
 			form.reset({
-				serverIp: data.user.serverIp || "",
+				serverIp: data.serverIp || "",
 			});
 		}
 	}, [form, form.reset, data]);
 
-	const utils = api.useUtils();
-
 	const setCurrentIp = () => {
 		if (!ip) return;
 		form.setValue("serverIp", ip);
@@ -80,7 +78,7 @@ export const UpdateServerIp = ({ children }: Props) => {
 		})
 			.then(async () => {
 				toast.success("Server IP Updated");
-				await utils.user.get.invalidate();
+				await refetch();
 				setIsOpen(false);
 			})
 			.catch(() => {

apps/dokploy/drizzle/0133_striped_the_order.sql

@@ -0,0 +1,114 @@
+CREATE TABLE "webServerSettings" (
+	"id" text PRIMARY KEY NOT NULL,
+	"serverIp" text,
+	"certificateType" "certificateType" DEFAULT 'none' NOT NULL,
+	"https" boolean DEFAULT false NOT NULL,
+	"host" text,
+	"letsEncryptEmail" text,
+	"sshPrivateKey" text,
+	"enableDockerCleanup" boolean DEFAULT true NOT NULL,
+	"logCleanupCron" text DEFAULT '0 0 * * *',
+	"metricsConfig" jsonb DEFAULT '{"server":{"type":"Dokploy","refreshRate":60,"port":4500,"token":"","retentionDays":2,"cronJob":"","urlCallback":"","thresholds":{"cpu":0,"memory":0}},"containers":{"refreshRate":60,"services":{"include":[],"exclude":[]}}}'::jsonb NOT NULL,
+	"cleanupCacheApplications" boolean DEFAULT false NOT NULL,
+	"cleanupCacheOnPreviews" boolean DEFAULT false NOT NULL,
+	"cleanupCacheOnCompose" boolean DEFAULT false NOT NULL,
+	"created_at" timestamp DEFAULT now(),
+	"updated_at" timestamp DEFAULT now() NOT NULL
+);
+
+-- Migrate data from user table to webServerSettings
+-- Get the owner user's data and insert into webServerSettings
+INSERT INTO "webServerSettings" (
+	"id",
+	"serverIp",
+	"certificateType",
+	"https",
+	"host",
+	"letsEncryptEmail",
+	"sshPrivateKey",
+	"enableDockerCleanup",
+	"logCleanupCron",
+	"metricsConfig",
+	"cleanupCacheApplications",
+	"cleanupCacheOnPreviews",
+	"cleanupCacheOnCompose",
+	"created_at",
+	"updated_at"
+)
+SELECT 
+	gen_random_uuid()::text as "id",
+	u."serverIp",
+	COALESCE(u."certificateType", 'none') as "certificateType",
+	COALESCE(u."https", false) as "https",
+	u."host",
+	u."letsEncryptEmail",
+	u."sshPrivateKey",
+	COALESCE(u."enableDockerCleanup", true) as "enableDockerCleanup",
+	COALESCE(u."logCleanupCron", '0 0 * * *') as "logCleanupCron",
+	COALESCE(
+		u."metricsConfig",
+		'{"server":{"type":"Dokploy","refreshRate":60,"port":4500,"token":"","retentionDays":2,"cronJob":"","urlCallback":"","thresholds":{"cpu":0,"memory":0}},"containers":{"refreshRate":60,"services":{"include":[],"exclude":[]}}}'::jsonb
+	) as "metricsConfig",
+	COALESCE(u."cleanupCacheApplications", false) as "cleanupCacheApplications",
+	COALESCE(u."cleanupCacheOnPreviews", false) as "cleanupCacheOnPreviews",
+	COALESCE(u."cleanupCacheOnCompose", false) as "cleanupCacheOnCompose",
+	NOW() as "created_at",
+	NOW() as "updated_at"
+FROM "user" u
+INNER JOIN "member" m ON u."id" = m."user_id"
+WHERE m."role" = 'owner'
+ORDER BY m."created_at" ASC
+LIMIT 1;
+
+-- If no owner found, create a default entry
+INSERT INTO "webServerSettings" (
+	"id",
+	"serverIp",
+	"certificateType",
+	"https",
+	"host",
+	"letsEncryptEmail",
+	"sshPrivateKey",
+	"enableDockerCleanup",
+	"logCleanupCron",
+	"metricsConfig",
+	"cleanupCacheApplications",
+	"cleanupCacheOnPreviews",
+	"cleanupCacheOnCompose",
+	"created_at",
+	"updated_at"
+)
+SELECT 
+	gen_random_uuid()::text as "id",
+	NULL as "serverIp",
+	'none' as "certificateType",
+	false as "https",
+	NULL as "host",
+	NULL as "letsEncryptEmail",
+	NULL as "sshPrivateKey",
+	true as "enableDockerCleanup",
+	'0 0 * * *' as "logCleanupCron",
+	'{"server":{"type":"Dokploy","refreshRate":60,"port":4500,"token":"","retentionDays":2,"cronJob":"","urlCallback":"","thresholds":{"cpu":0,"memory":0}},"containers":{"refreshRate":60,"services":{"include":[],"exclude":[]}}}'::jsonb as "metricsConfig",
+	false as "cleanupCacheApplications",
+	false as "cleanupCacheOnPreviews",
+	false as "cleanupCacheOnCompose",
+	NOW() as "created_at",
+	NOW() as "updated_at"
+WHERE NOT EXISTS (
+	SELECT 1 FROM "webServerSettings"
+);
+
+
+--> statement-breakpoint
+ALTER TABLE "user" DROP COLUMN "serverIp";--> statement-breakpoint
+ALTER TABLE "user" DROP COLUMN "certificateType";--> statement-breakpoint
+ALTER TABLE "user" DROP COLUMN "https";--> statement-breakpoint
+ALTER TABLE "user" DROP COLUMN "host";--> statement-breakpoint
+ALTER TABLE "user" DROP COLUMN "letsEncryptEmail";--> statement-breakpoint
+ALTER TABLE "user" DROP COLUMN "sshPrivateKey";--> statement-breakpoint
+ALTER TABLE "user" DROP COLUMN "enableDockerCleanup";--> statement-breakpoint
+ALTER TABLE "user" DROP COLUMN "logCleanupCron";--> statement-breakpoint
+ALTER TABLE "user" DROP COLUMN "metricsConfig";--> statement-breakpoint
+ALTER TABLE "user" DROP COLUMN "cleanupCacheApplications";--> statement-breakpoint
+ALTER TABLE "user" DROP COLUMN "cleanupCacheOnPreviews";--> statement-breakpoint
+ALTER TABLE "user" DROP COLUMN "cleanupCacheOnCompose";