@serverkgg/bridge 0.1.4 → 0.1.5

package/src/bot/detect/detect.test.ts

@@ -68,10 +68,13 @@ describe("detect on the templates", () => {
 				command: "npm ci",
 				source: "package-lock.json",
 			},
+			build: null,
 			start: {
 				command: "node index.js",
 				source: "package.json",
 			},
+			nodeVersion: null,
+			pythonVersion: null,
 			env: [
 				{
 					key: "DISCORD_TOKEN",
@@ -93,13 +96,16 @@ describe("detect on the templates", () => {
 			framework: BotFramework.PythonTelegramBot,
 			platform: BotPlatform.Telegram,
 			install: {
-				command: "pip install -r requirements.txt",
+				command: "uv pip install -r requirements.txt",
 				source: "requirements.txt",
 			},
+			build: null,
 			start: {
 				command: "python main.py",
 				source: "main.py",
 			},
+			nodeVersion: null,
+			pythonVersion: null,
 			env: [
 				{
 					key: "TELEGRAM_TOKEN",
@@ -113,7 +119,7 @@ describe("detect on the templates", () => {
 		} satisfies DetectResult);
 	});
 
-	it("reads the lockfile a pnpm or yarn project ships", () => {
+	it("reads the lockfile a pnpm, yarn or bun project ships, frozen", () => {
 		expect(
 			project(DISCORD_NODE, [
 				"pnpm-lock.yaml",
@@ -125,8 +131,290 @@ describe("detect on the templates", () => {
 		expect(
 			project(DISCORD_NODE, [
 				"yarn.lock",
+			]).install,
+		).toEqual({
+			command: "corepack yarn install --frozen-lockfile",
+			source: "yarn.lock",
+		});
+		expect(
+			project(DISCORD_NODE, [
+				"yarn.lock",
+				".yarnrc.yml",
+			]).install,
+		).toEqual({
+			command: "corepack yarn install --immutable",
+			source: "yarn.lock",
+		});
+		expect(
+			project(DISCORD_NODE, [
+				"bun.lockb",
+			]).install,
+		).toEqual({
+			command: "bun install --frozen-lockfile",
+			source: "bun.lockb",
+		});
+		expect(
+			project(DISCORD_NODE, [
+				"bun.lock",
+			]).packageManager,
+		).toBe(BotPackageManager.Bun);
+	});
+
+	it("lets the packageManager field and the engines name the manager before any lockfile", () => {
+		const withField = (packageManager: string, engines?: Record<string, string>) => {
+			return JSON.stringify({
+				...JSON.parse(DISCORD_NODE["package.json"]),
+				packageManager,
+				engines,
+			});
+		};
+
+		expect(
+			project(
+				{
+					...DISCORD_NODE,
+					"package.json": withField("pnpm@9.1.0"),
+				},
+				[
+					"package-lock.json",
+				],
+			).install,
+		).toEqual({
+			command: "corepack pnpm install",
+			source: "package.json",
+		});
+		expect(
+			project(
+				{
+					...DISCORD_NODE,
+					"package.json": withField("yarn@4.1.0"),
+				},
+				[
+					"yarn.lock",
+				],
+			).install?.command,
+		).toBe("corepack yarn install --immutable");
+		expect(
+			project(
+				{
+					...DISCORD_NODE,
+					"package.json": withField("yarn@1.22.0"),
+				},
+				[
+					"yarn.lock",
+				],
+			).install?.command,
+		).toBe("corepack yarn install --frozen-lockfile");
+		expect(
+			project({
+				...DISCORD_NODE,
+				"package.json": JSON.stringify({
+					...JSON.parse(DISCORD_NODE["package.json"]),
+					engines: {
+						bun: ">=1.1",
+					},
+				}),
+			}).install,
+		).toEqual({
+			command: "bun install",
+			source: "package.json",
+		});
+		expect(
+			project(DISCORD_NODE, [
+				"package-lock.json",
+				"yarn.lock",
 			]).packageManager,
 		).toBe(BotPackageManager.Yarn);
+		expect(
+			project(DISCORD_NODE, [
+				"package-lock.json",
+				".yarnrc.yml",
+			]).install,
+		).toEqual({
+			command: "corepack yarn install --no-immutable",
+			source: ".yarnrc.yml",
+		});
+		expect(
+			project(
+				{
+					...DISCORD_NODE,
+					"package.json": JSON.stringify({
+						...JSON.parse(DISCORD_NODE["package.json"]),
+						engines: {
+							pnpm: ">=9",
+						},
+					}),
+				},
+				[
+					"package-lock.json",
+				],
+			).install,
+		).toEqual({
+			command: "corepack pnpm install",
+			source: "package.json",
+		});
+	});
+
+	it("runs the build script with the detected manager, and serverk.json overrides it", () => {
+		const built = {
+			...DISCORD_NODE,
+			"package.json": JSON.stringify({
+				...JSON.parse(DISCORD_NODE["package.json"]),
+				scripts: {
+					build: "tsc",
+					start: "node dist/index.js",
+				},
+			}),
+		};
+
+		expect(
+			project(built, [
+				"pnpm-lock.yaml",
+			]).build,
+		).toEqual({
+			command: "corepack pnpm run build",
+			source: "package.json",
+		});
+		expect(project(DISCORD_NODE).build).toBeNull();
+		expect(
+			project({
+				...built,
+				"serverk.json": JSON.stringify({
+					build: "npm run compile",
+				}),
+			}).build,
+		).toEqual({
+			command: "npm run compile",
+			source: "serverk.json",
+		});
+	});
+
+	it("reads the Node version the code asks for and warns when the image cannot meet it", () => {
+		const engines = (node: string) => {
+			return {
+				...DISCORD_NODE,
+				"package.json": JSON.stringify({
+					...JSON.parse(DISCORD_NODE["package.json"]),
+					engines: {
+						node,
+					},
+				}),
+			};
+		};
+
+		expect(project(engines(">=18")).nodeVersion).toBe("18");
+		expect(project(engines(">=18")).warnings).not.toContain(BotInspectWarning.NodeVersionUnmet);
+		expect(project(engines("^20.10.0")).warnings).toContain(BotInspectWarning.NodeVersionUnmet);
+		expect(project(engines("18.x || >=22")).warnings).not.toContain(BotInspectWarning.NodeVersionUnmet);
+		expect(project(engines(">=18 <21")).nodeVersion).toBe("18");
+		expect(project(engines(">=18 <21")).warnings).toContain(BotInspectWarning.NodeVersionUnmet);
+		expect(project(engines("18 - 20")).nodeVersion).toBe("18");
+		expect(project(engines("18 - 20")).warnings).toContain(BotInspectWarning.NodeVersionUnmet);
+		expect(project(engines(">24")).warnings).toContain(BotInspectWarning.NodeVersionUnmet);
+		expect(project(engines(">24.0.0")).warnings).not.toContain(BotInspectWarning.NodeVersionUnmet);
+		expect(project(engines("<21")).nodeVersion).toBe("20");
+		expect(project(engines("<21")).warnings).toContain(BotInspectWarning.NodeVersionUnmet);
+		expect(project(engines("<=20")).nodeVersion).toBe("20");
+		expect(project(engines("*")).warnings).not.toContain(BotInspectWarning.NodeVersionUnmet);
+		expect(
+			project({
+				...DISCORD_NODE,
+				".nvmrc": "v20.11.1\n",
+			}).nodeVersion,
+		).toBe("20");
+		expect(
+			project({
+				...DISCORD_NODE,
+				".nvmrc": "lts/*\n",
+			}).nodeVersion,
+		).toBeNull();
+		expect(
+			project({
+				...DISCORD_NODE,
+				".tool-versions": "python 3.12.1\nnodejs 22.3.0\n",
+			}).nodeVersion,
+		).toBe("22");
+		expect(
+			project({
+				...DISCORD_NODE,
+				".node-version": "24\n",
+			}).warnings,
+		).not.toContain(BotInspectWarning.NodeVersionUnmet);
+	});
+
+	it("reads the Python version from the version files, in order", () => {
+		expect(
+			project({
+				...TELEGRAM_PYTHON,
+				".python-version": "3.11.4\n",
+				"runtime.txt": "python-3.10.2\n",
+			}).pythonVersion,
+		).toBe("3.11");
+		expect(
+			project({
+				...TELEGRAM_PYTHON,
+				"runtime.txt": "python-3.10.2\n",
+			}).pythonVersion,
+		).toBe("3.10");
+		expect(
+			project({
+				...TELEGRAM_PYTHON,
+				Pipfile: '[requires]\npython_version = "3.9"\n',
+			}).pythonVersion,
+		).toBe("3.9");
+		expect(
+			project({
+				...TELEGRAM_PYTHON,
+				".tool-versions": "nodejs 22.3.0\npython 3.13.0\n",
+			}).pythonVersion,
+		).toBe("3.13");
+		expect(project(TELEGRAM_PYTHON).pythonVersion).toBeNull();
+	});
+
+	it("installs from the Python lockfiles, honouring uv and warning about the rest", () => {
+		const locked = (lockfile: string) => {
+			return project(
+				{
+					"pyproject.toml": '[project]\nname = "bot"\ndependencies = [\n  "discord.py>=2.4",\n]\n',
+					"bot.py": 'import discord\nimport os\nos.getenv("DISCORD_TOKEN")\n',
+				},
+				[
+					lockfile,
+				],
+			);
+		};
+
+		expect(locked("uv.lock").install).toEqual({
+			command: "uv sync --locked --no-dev",
+			source: "uv.lock",
+		});
+		expect(locked("uv.lock").packageManager).toBe(BotPackageManager.Uv);
+		expect(locked("uv.lock").warnings).not.toContain(BotInspectWarning.LockfileNotHonoured);
+		expect(locked("poetry.lock").install).toEqual({
+			command: "uv pip install .",
+			source: "poetry.lock",
+		});
+		expect(locked("poetry.lock").packageManager).toBe(BotPackageManager.Pip);
+		expect(locked("poetry.lock").warnings).toContain(BotInspectWarning.LockfileNotHonoured);
+		expect(locked("pdm.lock").warnings).toContain(BotInspectWarning.LockfileNotHonoured);
+		expect(
+			project({
+				Pipfile: '[packages]\ndiscord-py = "*"\n\n[requires]\npython_version = "3.11"\n',
+				"bot.py": "import discord\n",
+			}),
+		).toMatchObject({
+			packageManager: BotPackageManager.Pipenv,
+			install: {
+				command: "pipenv install",
+				source: "Pipfile",
+			},
+			pythonVersion: "3.11",
+		});
+		expect(
+			project(TELEGRAM_PYTHON, [
+				"uv.lock",
+			]).install?.source,
+		).toBe("requirements.txt");
 	});
 
 	it("installs a pyproject project with pip", () => {
@@ -136,7 +424,7 @@ describe("detect on the templates", () => {
 		});
 
 		expect(result.install).toEqual({
-			command: "pip install .",
+			command: "uv pip install .",
 			source: "pyproject.toml",
 		});
 		expect(result.framework).toBe(BotFramework.DiscordPy);
@@ -148,7 +436,7 @@ describe("detect on the templates", () => {
 });
 
 describe("detect start commands", () => {
-	it("follows the launcher's order: start script, main, known files, then the Procfile", () => {
+	it("follows the launcher's order: the Procfile, the start script, main, then the known files", () => {
 		expect(
 			project({
 				"package.json": JSON.stringify({
@@ -172,16 +460,71 @@ describe("detect start commands", () => {
 		});
 		expect(
 			project({
-				"package.json": "{}",
+				"package.json": JSON.stringify({
+					scripts: {
+						start: "node index.js",
+					},
+				}),
+				"index.js": "",
 				Procfile: "web: node server.js\nworker: node worker.js\n",
 			}).start,
 		).toEqual({
 			command: "node worker.js",
 			source: "Procfile",
 		});
+		expect(
+			project({
+				"requirements.txt": "python-telegram-bot==21.11.1\n",
+				"main.py": "",
+				Procfile: "bot: python -m bot\n",
+			}).start,
+		).toEqual({
+			command: "python -m bot",
+			source: "Procfile",
+		});
+	});
+
+	it("starts the one Python package that has a __main__ module when no start file exists", () => {
+		expect(
+			project(
+				{
+					"requirements.txt": "python-telegram-bot==21.11.1\n",
+				},
+				[
+					"bot/__init__.py",
+					"bot/__main__.py",
+					"bot/handlers.py",
+					"tests/__main__.py",
+				],
+			).start,
+		).toEqual({
+			command: "python -m bot",
+			source: "bot/__main__.py",
+		});
+		expect(
+			project(
+				{
+					"requirements.txt": "python-telegram-bot==21.11.1\n",
+				},
+				[
+					"bot/__main__.py",
+					"worker/__main__.py",
+				],
+			).start,
+		).toBeNull();
+		expect(
+			project(
+				{
+					"requirements.txt": "python-telegram-bot==21.11.1\n",
+				},
+				[
+					".venv/lib/__main__.py",
+				],
+			).start,
+		).toBeNull();
 	});
 
-	it("warns when nothing starts and when node would run TypeScript directly", () => {
+	it("warns when nothing starts, and no longer about a TypeScript entry", () => {
 		expect(
 			project({
 				"package.json": "{}",
@@ -192,16 +535,9 @@ describe("detect start commands", () => {
 				"package.json": "{}",
 				"index.ts": "",
 			}).warnings,
-		).toContain(BotInspectWarning.TypescriptEntry);
-		expect(
-			project({
-				"package.json": JSON.stringify({
-					scripts: {
-						start: "tsx src/index.ts",
-					},
-				}),
-			}).warnings,
-		).not.toContain(BotInspectWarning.TypescriptEntry);
+		).toEqual([
+			BotInspectWarning.NoLockfile,
+		]);
 	});
 });
 
@@ -240,7 +576,7 @@ describe("detect warnings", () => {
 		]);
 	});
 
-	it("flags committed secrets and dependency folders but not the templates for them", () => {
+	it("flags committed secrets, dependency folders and database files but not the templates for them", () => {
 		expect(
 			project(DISCORD_NODE, [
 				"package-lock.json",
@@ -250,11 +586,21 @@ describe("detect warnings", () => {
 				"node_modules/some/.env",
 				".venv/pyvenv.cfg",
 				".env.sample",
+				"data/bot.sqlite",
 			]).warnings,
 		).toEqual([
 			BotInspectWarning.EnvCommitted,
 			BotInspectWarning.NodeModulesCommitted,
 			BotInspectWarning.VenvCommitted,
+			BotInspectWarning.DatabaseCommitted,
+		]);
+		expect(
+			project(DISCORD_NODE, [
+				"package-lock.json",
+				"node_modules/sqlite3/test/fixture.db",
+			]).warnings,
+		).toEqual([
+			BotInspectWarning.NodeModulesCommitted,
 		]);
 	});
 
@@ -438,6 +784,57 @@ describe("detect env suggestions", () => {
 		]);
 	});
 
+	it("suggests the keys of a skipped .env after the example files, never its values", () => {
+		const result = detect({
+			files: [
+				{
+					path: "requirements.txt",
+				},
+				{
+					path: "main.py",
+				},
+				{
+					path: ".env.example",
+				},
+			],
+			contents: {
+				"requirements.txt": "discord.py==2.7.1\n",
+				"main.py": 'import os\nimport discord\nos.getenv("LOG_CHANNEL")\n',
+				".env.example": "PREFIX=!\n",
+			},
+			skippedEnv: "PREFIX=?\nMY_BOT_TOKEN=abc.def\nOWNER_ID=1234\nTZ=Asia/Riyadh\nLOG_CHANNEL=42\n",
+		});
+
+		expect(result.env).toEqual([
+			{
+				key: "PREFIX",
+				sensitive: false,
+				source: ".env.example",
+				example: "!",
+			},
+			{
+				key: "MY_BOT_TOKEN",
+				sensitive: true,
+				source: ".env",
+				example: null,
+			},
+			{
+				key: "OWNER_ID",
+				sensitive: false,
+				source: ".env",
+				example: null,
+			},
+			{
+				key: "LOG_CHANNEL",
+				sensitive: false,
+				source: ".env",
+				example: null,
+			},
+		]);
+		expect(result.tokenKey).toBe("MY_BOT_TOKEN");
+		expect(result.warnings).not.toContain(BotInspectWarning.EnvCommitted);
+	});
+
 	it("names the token key the code reads for its platform", () => {
 		const result = project({
 			"requirements.txt": "discord.py==2.7.1\n",