Implement enableSubmodules feature across various Git provider components and update database schema. This change introduces a new boolean field enableSubmodules to control submodule behavior in Git operations, replacing the previous recurseSubmodules field. Updates include modifications to the UI components, API routers, and database schema to accommodate this new feature.

2025-06-26 18:27:59 +00:00 · 2025-04-26 16:35:02 -06:00
parent 1911b5b674
commit ceb16ae9f7
22 changed files with 11000 additions and 97 deletions
--- a/packages/server/src/db/schema/application.ts
+++ b/packages/server/src/db/schema/application.ts
@@ -182,6 +182,7 @@ export const applications = pgTable("application", {
 			onDelete: "set null",
 		},
 	),
+	enableSubmodules: boolean("enableSubmodules").notNull().default(false),
 	dockerfile: text("dockerfile"),
 	dockerContextPath: text("dockerContextPath"),
 	dockerBuildStage: text("dockerBuildStage"),
@@ -470,6 +471,7 @@ export const apiSaveGithubProvider = createSchema
 		buildPath: true,
 		githubId: true,
 		watchPaths: true,
+		enableSubmodules: true,
 	})
 	.required();

@@ -484,6 +486,7 @@ export const apiSaveGitlabProvider = createSchema
 		gitlabProjectId: true,
 		gitlabPathNamespace: true,
 		watchPaths: true,
+		enableSubmodules: true,
 	})
 	.required();

@@ -496,6 +499,7 @@ export const apiSaveBitbucketProvider = createSchema
 		bitbucketId: true,
 		applicationId: true,
 		watchPaths: true,
+		enableSubmodules: true,
 	})
 	.required();

@@ -508,6 +512,7 @@ export const apiSaveGiteaProvider = createSchema
 		giteaRepository: true,
 		giteaId: true,
 		watchPaths: true,
+		enableSubmodules: true,
 	})
 	.required();

@@ -528,6 +533,7 @@ export const apiSaveGitProvider = createSchema
 		customGitBuildPath: true,
 		customGitUrl: true,
 		watchPaths: true,
+		enableSubmodules: true,
 	})
 	.required()
 	.merge(
--- a/packages/server/src/db/schema/compose.ts
+++ b/packages/server/src/db/schema/compose.ts
@@ -72,6 +72,7 @@ export const compose = pgTable("compose", {
 	),
 	command: text("command").notNull().default(""),
 	//
+	enableSubmodules: boolean("enableSubmodules").notNull().default(false),
 	composePath: text("composePath").notNull().default("./docker-compose.yml"),
 	suffix: text("suffix").notNull().default(""),
 	randomize: boolean("randomize").notNull().default(false),
--- a/packages/server/src/services/compose.ts
+++ b/packages/server/src/services/compose.ts
@@ -356,6 +356,7 @@ export const deployRemoteCompose = async ({
 					deployment.logPath,
 					true,
 				);
+				console.log(command);
 			} else if (compose.sourceType === "raw") {
 				command += getCreateComposeFileCommand(compose, deployment.logPath);
 			} else if (compose.sourceType === "gitea") {
--- a/packages/server/src/utils/providers/bitbucket.ts
+++ b/packages/server/src/utils/providers/bitbucket.ts
@@ -37,7 +37,7 @@ export const cloneBitbucketRepository = async (
 		bitbucketBranch,
 		bitbucketId,
 		bitbucket,
-		recurseSubmodules = true,
+		enableSubmodules,
 	} = entity;

 	if (!bitbucketId) {
@@ -60,13 +60,12 @@ export const cloneBitbucketRepository = async (
 			bitbucketBranch!,
 			"--depth",
 			"1",
+			...(enableSubmodules ? ["--recurse-submodules"] : []),
 			cloneUrl,
 			outputPath,
 			"--progress",
 		];
-		if (recurseSubmodules) {
-			cloneArgs.splice(4, 0, "--recurse-submodules");
-		}
+
 		await spawnAsync("git", cloneArgs, (data) => {
 			if (writeStream.writable) {
 				writeStream.write(data);
@@ -89,7 +88,7 @@ export const cloneRawBitbucketRepository = async (entity: Compose) => {
 		bitbucketOwner,
 		bitbucketBranch,
 		bitbucketId,
-		recurseSubmodules = true,
+		enableSubmodules,
 	} = entity;

 	if (!bitbucketId) {
@@ -113,13 +112,12 @@ export const cloneRawBitbucketRepository = async (entity: Compose) => {
 			bitbucketBranch!,
 			"--depth",
 			"1",
+			...(enableSubmodules ? ["--recurse-submodules"] : []),
 			cloneUrl,
 			outputPath,
 			"--progress",
 		];
-		if (recurseSubmodules) {
-			cloneArgs.splice(4, 0, "--recurse-submodules");
-		}
+
 		await spawnAsync("git", cloneArgs);
 	} catch (error) {
 		throw error;
@@ -135,7 +133,7 @@ export const cloneRawBitbucketRepositoryRemote = async (compose: Compose) => {
 		bitbucketBranch,
 		bitbucketId,
 		serverId,
-		recurseSubmodules = true,
+		enableSubmodules,
 	} = compose;

 	if (!serverId) {
@@ -160,7 +158,7 @@ export const cloneRawBitbucketRepositoryRemote = async (compose: Compose) => {
 	try {
 		const cloneCommand = `
 			rm -rf ${outputPath};
-			git clone --branch ${bitbucketBranch} --depth 1 ${recurseSubmodules ? "--recurse-submodules" : ""} ${cloneUrl} ${outputPath}
+			git clone --branch ${bitbucketBranch} --depth 1 ${enableSubmodules ? "--recurse-submodules" : ""} ${cloneUrl} ${outputPath}
 		`;
 		await execAsyncRemote(serverId, cloneCommand);
 	} catch (error) {
@@ -181,7 +179,7 @@ export const getBitbucketCloneCommand = async (
 		bitbucketBranch,
 		bitbucketId,
 		serverId,
-		recurseSubmodules = true,
+		enableSubmodules,
 	} = entity;

 	if (!serverId) {
@@ -213,7 +211,7 @@ export const getBitbucketCloneCommand = async (
 	const cloneCommand = `
 rm -rf ${outputPath};
 mkdir -p ${outputPath};
-if ! git clone --branch ${bitbucketBranch} --depth 1 ${recurseSubmodules ? "--recurse-submodules" : ""} --progress ${cloneUrl} ${outputPath} >> ${logPath} 2>&1; then
+if ! git clone --branch ${bitbucketBranch} --depth 1 ${enableSubmodules ? "--recurse-submodules" : ""} --progress ${cloneUrl} ${outputPath} >> ${logPath} 2>&1; then
 	echo "❌ [ERROR] Fail to clone the repository ${repoclone}" >> ${logPath};
 	exit 1;
 fi
--- a/packages/server/src/utils/providers/git.ts
+++ b/packages/server/src/utils/providers/git.ts
@@ -17,7 +17,7 @@ export const cloneGitRepository = async (
 		customGitUrl?: string | null;
 		customGitBranch?: string | null;
 		customGitSSHKeyId?: string | null;
-		recurseSubmodules?: boolean;
+		enableSubmodules?: boolean;
 	},
 	logPath: string,
 	isCompose = false,
@@ -28,7 +28,7 @@ export const cloneGitRepository = async (
 		customGitUrl,
 		customGitBranch,
 		customGitSSHKeyId,
-		recurseSubmodules = true,
+		enableSubmodules,
 	} = entity;

 	if (!customGitUrl || !customGitBranch) {
@@ -83,13 +83,12 @@ export const cloneGitRepository = async (
 			customGitBranch,
 			"--depth",
 			"1",
+			...(enableSubmodules ? ["--recurse-submodules"] : []),
 			customGitUrl,
 			outputPath,
 			"--progress",
 		];
-		if (recurseSubmodules) {
-			cloneArgs.splice(4, 0, "--recurse-submodules");
-		}
+
 		await spawnAsync(
 			"git",
 			cloneArgs,
@@ -124,7 +123,7 @@ export const getCustomGitCloneCommand = async (
 		customGitBranch?: string | null;
 		customGitSSHKeyId?: string | null;
 		serverId: string | null;
-		recurseSubmodules?: boolean;
+		enableSubmodules: boolean;
 	},
 	logPath: string,
 	isCompose = false,
@@ -136,7 +135,7 @@ export const getCustomGitCloneCommand = async (
 		customGitBranch,
 		customGitSSHKeyId,
 		serverId,
-		recurseSubmodules = true,
+		enableSubmodules,
 	} = entity;

 	if (!customGitUrl || !customGitBranch) {
@@ -193,7 +192,7 @@ export const getCustomGitCloneCommand = async (
 		}

 		command.push(
-			`if ! git clone --branch ${customGitBranch} --depth 1 ${recurseSubmodules ? "--recurse-submodules" : ""} --progress ${customGitUrl} ${outputPath} >> ${logPath} 2>&1; then
+			`if ! git clone --branch ${customGitBranch} --depth 1 ${enableSubmodules ? "--recurse-submodules" : ""} --progress ${customGitUrl} ${outputPath} >> ${logPath} 2>&1; then
 				echo "❌ [ERROR] Fail to clone the repository ${customGitUrl}" >> ${logPath};
 				exit 1;
 			fi
@@ -273,14 +272,14 @@ export const cloneGitRawRepository = async (entity: {
 	customGitUrl?: string | null;
 	customGitBranch?: string | null;
 	customGitSSHKeyId?: string | null;
-	recurseSubmodules?: boolean;
+	enableSubmodules?: boolean;
 }) => {
 	const {
 		appName,
 		customGitUrl,
 		customGitBranch,
 		customGitSSHKeyId,
-		recurseSubmodules = true,
+		enableSubmodules,
 	} = entity;

 	if (!customGitUrl || !customGitBranch) {
@@ -332,13 +331,12 @@ export const cloneGitRawRepository = async (entity: {
 			customGitBranch,
 			"--depth",
 			"1",
+			...(enableSubmodules ? ["--recurse-submodules"] : []),
 			customGitUrl,
 			outputPath,
 			"--progress",
 		];
-		if (recurseSubmodules) {
-			cloneArgs.splice(4, 0, "--recurse-submodules");
-		}
+
 		await spawnAsync("git", cloneArgs, (_data) => {}, {
 			env: {
 				...process.env,
@@ -359,7 +357,7 @@ export const cloneRawGitRepositoryRemote = async (compose: Compose) => {
 		customGitUrl,
 		customGitSSHKeyId,
 		serverId,
-		recurseSubmodules = true,
+		enableSubmodules,
 	} = compose;

 	if (!serverId) {
@@ -414,7 +412,7 @@ export const cloneRawGitRepositoryRemote = async (compose: Compose) => {
 		}

 		command.push(
-			`if ! git clone --branch ${customGitBranch} --depth 1 ${recurseSubmodules ? "--recurse-submodules" : ""} --progress ${customGitUrl} ${outputPath} ; then
+			`if ! git clone --branch ${customGitBranch} --depth 1 ${enableSubmodules ? "--recurse-submodules" : ""} --progress ${customGitUrl} ${outputPath} ; then
 				echo "[ERROR] Fail to clone the repository ";
 				exit 1;
 			fi
--- a/packages/server/src/utils/providers/gitea.ts
+++ b/packages/server/src/utils/providers/gitea.ts
@@ -119,6 +119,7 @@ export const getGiteaCloneCommand = async (
 		giteaRepository,
 		serverId,
 		gitea,
+		enableSubmodules,
 	} = entity;

 	if (!serverId) {
@@ -155,7 +156,7 @@ export const getGiteaCloneCommand = async (
    rm -rf ${outputPath};
    mkdir -p ${outputPath};
    
-    if ! git clone --branch ${giteaBranch} --depth 1 --recurse-submodules ${cloneUrl} ${outputPath} >> ${logPath} 2>&1; then
+    if ! git clone --branch ${giteaBranch} --depth 1 ${enableSubmodules ? "--recurse-submodules" : ""} ${cloneUrl} ${outputPath} >> ${logPath} 2>&1; then
      echo "❌ [ERROR] Failed to clone the repository ${repoClone}" >> ${logPath};
      exit 1;
    fi
@@ -174,7 +175,14 @@ export const cloneGiteaRepository = async (
 	const { APPLICATIONS_PATH, COMPOSE_PATH } = paths();

 	const writeStream = createWriteStream(logPath, { flags: "a" });
-	const { appName, giteaBranch, giteaId, giteaOwner, giteaRepository } = entity;
+	const {
+		appName,
+		giteaBranch,
+		giteaId,
+		giteaOwner,
+		giteaRepository,
+		enableSubmodules,
+	} = entity;

 	if (!giteaId) {
 		throw new TRPCError({
@@ -211,7 +219,7 @@ export const cloneGiteaRepository = async (
 				giteaBranch!,
 				"--depth",
 				"1",
-				"--recurse-submodules",
+				...(enableSubmodules ? ["--recurse-submodules"] : []),
 				cloneUrl,
 				outputPath,
 				"--progress",
@@ -232,7 +240,14 @@ export const cloneGiteaRepository = async (
 };

 export const cloneRawGiteaRepository = async (entity: Compose) => {
-	const { appName, giteaRepository, giteaOwner, giteaBranch, giteaId } = entity;
+	const {
+		appName,
+		giteaRepository,
+		giteaOwner,
+		giteaBranch,
+		giteaId,
+		enableSubmodules,
+	} = entity;
 	const { COMPOSE_PATH } = paths();

 	if (!giteaId) {
@@ -265,7 +280,7 @@ export const cloneRawGiteaRepository = async (entity: Compose) => {
 			giteaBranch!,
 			"--depth",
 			"1",
-			"--recurse-submodules",
+			...(enableSubmodules ? ["--recurse-submodules"] : []),
 			cloneUrl,
 			outputPath,
 			"--progress",
@@ -283,6 +298,7 @@ export const cloneRawGiteaRepositoryRemote = async (compose: Compose) => {
 		giteaBranch,
 		giteaId,
 		serverId,
+		enableSubmodules,
 	} = compose;

 	if (!serverId) {
@@ -307,7 +323,7 @@ export const cloneRawGiteaRepositoryRemote = async (compose: Compose) => {
 	try {
 		const command = `
 			rm -rf ${outputPath};
-			git clone --branch ${giteaBranch} --depth 1 ${cloneUrl} ${outputPath}
+			git clone --branch ${giteaBranch} --depth 1 ${enableSubmodules ? "--recurse-submodules" : ""} ${cloneUrl} ${outputPath}
 		`;
 		await execAsyncRemote(serverId, command);
 	} catch (error) {
--- a/packages/server/src/utils/providers/github.ts
+++ b/packages/server/src/utils/providers/github.ts
@@ -83,18 +83,18 @@ interface CloneGithubRepository {
 	repository: string | null;
 	logPath: string;
 	type?: "application" | "compose";
-	recurseSubmodules?: boolean;
+	enableSubmodules: boolean;
 }
 export const cloneGithubRepository = async ({
 	logPath,
 	type = "application",
-	recurseSubmodules = true,
 	...entity
 }: CloneGithubRepository) => {
 	const isCompose = type === "compose";
 	const { APPLICATIONS_PATH, COMPOSE_PATH } = paths();
 	const writeStream = createWriteStream(logPath, { flags: "a" });
-	const { appName, repository, owner, branch, githubId } = entity;
+	const { appName, repository, owner, branch, githubId, enableSubmodules } =
+		entity;

 	if (!githubId) {
 		throw new TRPCError({
@@ -136,13 +136,12 @@ export const cloneGithubRepository = async ({
 			branch!,
 			"--depth",
 			"1",
+			...(enableSubmodules ? ["--recurse-submodules"] : []),
 			cloneUrl,
 			outputPath,
 			"--progress",
 		];
-		if (recurseSubmodules) {
-			cloneArgs.splice(4, 0, "--recurse-submodules");
-		}
+
 		await spawnAsync("git", cloneArgs, (data) => {
 			if (writeStream.writable) {
 				writeStream.write(data);
@@ -160,10 +159,17 @@ export const cloneGithubRepository = async ({
 export const getGithubCloneCommand = async ({
 	logPath,
 	type = "application",
-	recurseSubmodules = true,
 	...entity
 }: CloneGithubRepository & { serverId: string }) => {
-	const { appName, repository, owner, branch, githubId, serverId } = entity;
+	const {
+		appName,
+		repository,
+		owner,
+		branch,
+		githubId,
+		serverId,
+		enableSubmodules,
+	} = entity;
 	const isCompose = type === "compose";
 	if (!serverId) {
 		throw new TRPCError({
@@ -218,7 +224,7 @@ export const getGithubCloneCommand = async ({
 	const cloneCommand = `
 rm -rf ${outputPath};
 mkdir -p ${outputPath};
-if ! git clone --branch ${branch} --depth 1 ${recurseSubmodules ? "--recurse-submodules" : ""} --progress ${cloneUrl} ${outputPath} >> ${logPath} 2>&1; then
+if ! git clone --branch ${branch} --depth 1 ${enableSubmodules ? "--recurse-submodules" : ""} --progress ${cloneUrl} ${outputPath} >> ${logPath} 2>&1; then
 	echo "❌ [ERROR] Fail to clone repository ${repoclone}" >> ${logPath};
 	exit 1;
 fi
@@ -229,14 +235,8 @@ echo "Cloned ${repoclone} to ${outputPath}: ✅" >> ${logPath};
 };

 export const cloneRawGithubRepository = async (entity: Compose) => {
-	const {
-		appName,
-		repository,
-		owner,
-		branch,
-		githubId,
-		recurseSubmodules = true,
-	} = entity;
+	const { appName, repository, owner, branch, githubId, enableSubmodules } =
+		entity;

 	if (!githubId) {
 		throw new TRPCError({
@@ -260,13 +260,11 @@ export const cloneRawGithubRepository = async (entity: Compose) => {
 			branch!,
 			"--depth",
 			"1",
+			...(enableSubmodules ? ["--recurse-submodules"] : []),
 			cloneUrl,
 			outputPath,
 			"--progress",
 		];
-		if (recurseSubmodules) {
-			cloneArgs.splice(4, 0, "--recurse-submodules");
-		}
 		await spawnAsync("git", cloneArgs);
 	} catch (error) {
 		throw error;
@@ -281,7 +279,7 @@ export const cloneRawGithubRepositoryRemote = async (compose: Compose) => {
 		branch,
 		githubId,
 		serverId,
-		recurseSubmodules = true,
+		enableSubmodules,
 	} = compose;

 	if (!serverId) {
@@ -308,7 +306,7 @@ export const cloneRawGithubRepositoryRemote = async (compose: Compose) => {
 	try {
 		const command = `
 			rm -rf ${outputPath};
-			git clone --branch ${branch} --depth 1 ${recurseSubmodules ? "--recurse-submodules" : ""} ${cloneUrl} ${outputPath}
+			git clone --branch ${branch} --depth 1 ${enableSubmodules ? "--recurse-submodules" : ""} ${cloneUrl} ${outputPath}
 		`;
 		await execAsyncRemote(serverId, command);
 	} catch (error) {
--- a/packages/server/src/utils/providers/gitlab.ts
+++ b/packages/server/src/utils/providers/gitlab.ts
@@ -96,7 +96,7 @@ export const cloneGitlabRepository = async (
 		gitlabId,
 		gitlab,
 		gitlabPathNamespace,
-		recurseSubmodules = true,
+		enableSubmodules,
 	} = entity;

 	if (!gitlabId) {
@@ -139,13 +139,12 @@ export const cloneGitlabRepository = async (
 			gitlabBranch!,
 			"--depth",
 			"1",
+			...(enableSubmodules ? ["--recurse-submodules"] : []),
 			cloneUrl,
 			outputPath,
 			"--progress",
 		];
-		if (recurseSubmodules) {
-			cloneArgs.splice(4, 0, "--recurse-submodules");
-		}
+
 		await spawnAsync("git", cloneArgs, (data) => {
 			if (writeStream.writable) {
 				writeStream.write(data);
@@ -172,7 +171,7 @@ export const getGitlabCloneCommand = async (
 		gitlabId,
 		serverId,
 		gitlab,
-		recurseSubmodules = true,
+		enableSubmodules,
 	} = entity;

 	if (!serverId) {
@@ -228,7 +227,7 @@ export const getGitlabCloneCommand = async (
 	const cloneCommand = `
 rm -rf ${outputPath};
 mkdir -p ${outputPath};
-if ! git clone --branch ${gitlabBranch} --depth 1 ${recurseSubmodules ? "--recurse-submodules" : ""} --progress ${cloneUrl} ${outputPath} >> ${logPath} 2>&1; then
+if ! git clone --branch ${gitlabBranch} --depth 1 ${enableSubmodules ? "--recurse-submodules" : ""} --progress ${cloneUrl} ${outputPath} >> ${logPath} 2>&1; then
 	echo "❌ [ERROR] Fail to clone the repository ${repoclone}" >> ${logPath};
 	exit 1;
 fi
@@ -341,7 +340,7 @@ export const cloneRawGitlabRepository = async (entity: Compose) => {
 		gitlabBranch,
 		gitlabId,
 		gitlabPathNamespace,
-		recurseSubmodules = true,
+		enableSubmodules,
 	} = entity;

 	if (!gitlabId) {
@@ -369,13 +368,11 @@ export const cloneRawGitlabRepository = async (entity: Compose) => {
 			gitlabBranch!,
 			"--depth",
 			"1",
+			...(enableSubmodules ? ["--recurse-submodules"] : []),
 			cloneUrl,
 			outputPath,
 			"--progress",
 		];
-		if (recurseSubmodules) {
-			cloneArgs.splice(4, 0, "--recurse-submodules");
-		}
 		await spawnAsync("git", cloneArgs);
 	} catch (error) {
 		throw error;
@@ -389,7 +386,7 @@ export const cloneRawGitlabRepositoryRemote = async (compose: Compose) => {
 		branch,
 		gitlabId,
 		serverId,
-		recurseSubmodules = true,
+		enableSubmodules,
 	} = compose;

 	if (!serverId) {
@@ -414,7 +411,7 @@ export const cloneRawGitlabRepositoryRemote = async (compose: Compose) => {
 	try {
 		const command = `
 			rm -rf ${outputPath};
-			git clone --branch ${branch} --depth 1 ${recurseSubmodules ? "--recurse-submodules" : ""} ${cloneUrl} ${outputPath}
+			git clone --branch ${branch} --depth 1 ${enableSubmodules ? "--recurse-submodules" : ""} ${cloneUrl} ${outputPath}
 		`;
 		await execAsyncRemote(serverId, command);
 	} catch (error) {