@studiometa/forge-cli 0.5.3 → 0.5.4

package/README.md

@@ -158,7 +158,8 @@ forge sites apply --file site.json          # Make the site match the file
   "env": { "APP_ENV": "production" },
   "nginx": "nginx.conf",
   "workers": [{ "command": "php artisan queue:work database --queue=default", "processes": 4 }],
-  "schedule": [{ "command": "php artisan schedule:run", "frequency": "minutely" }]
+  "schedule": [{ "command": "php artisan schedule:run", "frequency": "minutely" }],
+  "loadBalancer": { "server": "lb-1", "port": 80 }
 }
 ```
 
@@ -172,6 +173,7 @@ forge sites apply --file site.json          # Make the site match the file
 | `nginx`                                     | Nginx file, relative to the site file, with Forge template variables. Rendered for the site and written when it differs from Forge (see below)                                         |
 | `workers`                                   | Forge background processes of the site. Create the missing ones, delete the ones of the site that the file does not declare. The directory defaults to the site root                   |
 | `schedule`                                  | Forge scheduled jobs of the site (`minutely`, `hourly`, `nightly`, `weekly`, `monthly`, `reboot`, or `custom` with `cron`). A relative `artisan` becomes the absolute path of the site |
+| `loadBalancer`                              | Set the nodes of the site on the load balancer to `server` only, on `port` (default `80`), with round robin and weight 1. The site of the load balancer must exist (see below)         |
 
 For an application that does not read the Laravel names, `database.env` maps the database name, the user and the password to other `.env` keys. Each key is optional and defaults to the Laravel name. Other values, such as the host, go in `env`:
 
@@ -216,6 +218,8 @@ A worker or a scheduled job matches the file when its command, directory, proces
 - Without the `workers` key, no worker is read or deleted. With `"workers": []`, all the workers of the site are deleted. The same applies to `schedule`.
 - The site, its aliases, its database and its `.env` keys are never deleted.
 
+`loadBalancer` sends the traffic of the load balancer to the server of the file. The site of the load balancer is the one named `domain` or one of the `aliases`. When no site matches, `--check` and `apply` exit `3` before any change. When two sites match, they exit `3` too. The Forge API cannot create a site on a load balancer: create it in Forge (New site on the load balancer), with its certificate. To move a site to another server, change `server`: `apply` creates the site there, then moves the node, with no DNS change. It does not delete the site on the old server.
+
 With `--check`, `apply` prints the plan and changes nothing. It exits `0` when Forge matches the file, `1` when it differs, and another code on an error (`3` for an invalid file). Every deletion shows its ID and full command. The plan gives `.env` key names only, never values, and shows a generated password as `<generated>`. With `--format json`, it prints `{ "inSync": false, "changes": [...], "warnings": [...] }`.
 
 Run `--check` in merge request pipelines and `apply` on the main branch:

package/dist/cli.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 import { C as isOutputFormat, _ as setToken, a as runCommand, c as OutputFormatter, d as createConfigStore$1, f as deleteToken, g as setOrganizationSlug, h as getToken$1, l as colors, m as getOrganizationSlug, n as exitWithError, o as createContext, r as exitWithValidationError, t as ExitCode, u as setColorEnabled, v as ApiError, x as ValidationError, y as CliError } from "./error-handler-s-BOJ1-h.js";
 import { STORAGE_PROVIDER_TYPES } from "@studiometa/forge-api";
-import { PHP_CONFIG_TYPES, RESTARTABLE_SERVICES, activateCertificate, createAuditLogger, createBackupConfig, createCommand, createDaemon, createDatabase, createDatabaseUser, createDomain, createMonitor, createNginxTemplate, createRedirectRule, createScheduledJob, createSecurityRule, createServer, createSite, createSshKey, createStorageProvider, deleteBackupConfig, deleteDaemon, deleteDatabaseUser, deleteMonitor, deleteNginxTemplate, deleteRedirectRule, deleteScheduledJob, deleteSecurityRule, deleteSshKey, deleteStorageProvider, deploySiteAndWait, disablePhpOpcache, enablePhpOpcache, getBackupConfig, getCertificate, getCommand, getDaemon, getDaemonLog, getDatabase, getDatabaseUser, getDeploymentLog, getDeploymentScript, getEnv, getFirewallRule, getMonitor, getNginxConfig, getNginxTemplate, getPhpConfig, getPhpMaxExecutionTime, getPhpMaxUploadSize, getPhpOpcache, getRecipe, getRedirectRule, getScheduledJob, getSecurityRule, getServer, getSite, getSshKey, getStorageProvider, getUser, listBackupConfigs, listCommands, listDaemons, listDatabaseUsers, listDatabases, listDeployments, listFirewallRules, listMonitors, listNginxTemplates, listPhpVersions, listRecipes, listRedirectRules, listScheduledJobs, listSecurityRules, listServers, listServices, listSites, listSshKeys, listStorageProviders, matchByName, rebootServer, restartDaemon, restartService, runRecipe, updateBackupConfig, updateDaemon, updateDatabaseUser, updateDeploymentScript, updateEnv, updateNginxConfig, updateNginxTemplate, updatePhpConfig, updatePhpMaxExecutionTime, updatePhpMaxUploadSize, updateRecipe, updateSecurityRule, updateSite } from "@studiometa/forge-core";
+import { PHP_CONFIG_TYPES, RESTARTABLE_SERVICES, activateCertificate, createAuditLogger, createBackupConfig, createCommand, createDaemon, createDatabase, createDatabaseUser, createDomain, createMonitor, createNginxTemplate, createRedirectRule, createScheduledJob, createSecurityRule, createServer, createSite, createSshKey, createStorageProvider, deleteBackupConfig, deleteDaemon, deleteDatabaseUser, deleteMonitor, deleteNginxTemplate, deleteRedirectRule, deleteScheduledJob, deleteSecurityRule, deleteSshKey, deleteStorageProvider, deploySiteAndWait, disablePhpOpcache, enablePhpOpcache, getBackupConfig, getCertificate, getCommand, getDaemon, getDaemonLog, getDatabase, getDatabaseUser, getDeploymentLog, getDeploymentScript, getEnv, getFirewallRule, getMonitor, getNginxConfig, getNginxTemplate, getPhpConfig, getPhpMaxExecutionTime, getPhpMaxUploadSize, getPhpOpcache, getRecipe, getRedirectRule, getScheduledJob, getSecurityRule, getServer, getSite, getSshKey, getStorageProvider, getUser, listBackupConfigs, listCommands, listDaemons, listDatabaseUsers, listDatabases, listDeployments, listFirewallRules, listLoadBalancingNodes, listMonitors, listNginxTemplates, listPhpVersions, listRecipes, listRedirectRules, listScheduledJobs, listSecurityRules, listServers, listServices, listSites, listSshKeys, listStorageProviders, matchByName, rebootServer, restartDaemon, restartService, runRecipe, updateBackupConfig, updateDaemon, updateDatabaseUser, updateDeploymentScript, updateEnv, updateLoadBalancingNodes, updateNginxConfig, updateNginxTemplate, updatePhpConfig, updatePhpMaxExecutionTime, updatePhpMaxUploadSize, updateRecipe, updateSecurityRule, updateSite } from "@studiometa/forge-core";
 import { mkdirSync, readFileSync, writeFileSync } from "node:fs";
 import { homedir } from "node:os";
 import { dirname, join, posix, resolve } from "node:path";
@@ -5069,6 +5069,29 @@ function planSchedule(file, state, changes, warnings) {
 	else warnings.push(`Kept scheduled job ${job.id} (${job.command}): not declared, but ${describeOwnership(ownership)}.`);
 }
 /**
+* Plan the nodes of the site on the load balancer: one node, the server of the site file, with
+* the default weight. Any other node is replaced.
+*/
+function planLoadBalancer(file, state, changes) {
+	const balancer = state.loadBalancer;
+	if (!file.loadBalancer || !balancer?.site) return;
+	const to = {
+		server_id: balancer.target,
+		port: file.loadBalancer.port
+	};
+	const [node, ...others] = balancer.nodes;
+	if (node !== void 0 && others.length === 0 && node.server_id === to.server_id && node.port === to.port && node.weight === 1 && !node.backup && !node.down) return;
+	changes.push({
+		action: "update-load-balancer",
+		site: balancer.site.name,
+		from: balancer.nodes.map(({ server_id, port }) => ({
+			server_id,
+			port
+		})),
+		to
+	});
+}
+/**
 * Compare the site file with the state of Forge. Keys that the file does not have are not
 * compared. The plan creates and updates what differs, and deletes only the workers and
 * scheduled jobs that surely belong to the site and that the file does not declare.
@@ -5083,6 +5106,7 @@ function buildPlan(file, state) {
 	planNginx(file, state, changes);
 	planWorkers(file, state, changes, warnings);
 	planSchedule(file, state, changes, warnings);
+	planLoadBalancer(file, state, changes);
 	return {
 		changes,
 		warnings
@@ -5109,6 +5133,11 @@ function describeChange(change) {
 		case "create-worker": return `+ create worker: ${change.command} (directory: ${change.directory}, processes: ${change.processes})`;
 		case "delete-worker": return `- delete worker ${change.id}: ${change.command} (directory: ${quoted(change.directory)}, processes: ${change.processes})`;
 		case "create-job": return `+ create scheduled job: ${change.command} (${change.frequency}${change.cron ? ` ${change.cron}` : ""})`;
+		case "update-load-balancer": {
+			const node = ({ server_id, port }) => `server ${server_id}:${port}`;
+			const from = change.from.length > 0 ? change.from.map(node).join(", ") : "(none)";
+			return `~ update load balancer site ${change.site}: ${from} → ${node(change.to)}`;
+		}
 		case "delete-job": return `- delete scheduled job ${change.id}: ${change.command} (${change.frequency.toLowerCase()} ${change.cron})`;
 	}
 }
@@ -5213,6 +5242,24 @@ function findSite(sites, domain) {
 	return sites.find((site) => site.name.toLowerCase() === domain.toLowerCase()) ?? null;
 }
 /**
+* The site of the load balancer named `domain` or one of the aliases, compared without case.
+* Its name can be any of them, e.g. the domain without `www`. Two matches are an error: a guess
+* could send the traffic of another site.
+*/
+function findLoadBalancerSite(sites, names) {
+	const wanted = new Set(names.map((name) => name.toLowerCase()));
+	const matches = sites.filter((site) => wanted.has(site.name.toLowerCase()));
+	if (matches.length > 1) throw new ValidationError(`Several sites of the load balancer match the site file: ${matches.map((site) => site.name).join(", ")}`, "loadBalancer", ["Keep one site for the domain and its aliases on the load balancer"]);
+	return matches[0] ?? null;
+}
+/**
+* Exit with a validation error when the load balancer has no site for the site file: the Forge
+* API cannot create a site on a load balancer.
+*/
+function assertLoadBalancerSite(file, state) {
+	if (file.loadBalancer && !state.loadBalancer?.site) throw new ValidationError(`The load balancer ${file.loadBalancer.server} has no site for ${file.domain}`, "loadBalancer", [`In Forge, create the site ${file.domain} on the load balancer (New site), then run apply again`, "Check the domain, the aliases and the server of the load balancer"]);
+}
+/**
 * Read from Forge what the site file manages, and nothing else.
 */
 async function readRemoteState(file, serverId, ctx) {
@@ -5248,6 +5295,20 @@ async function readRemoteState(file, serverId, ctx) {
 		state.jobs = [...siteJobs, ...serverJobs];
 		state.siteJobIds = new Set(siteJobs.map((job) => job.id));
 	}
+	if (file.loadBalancer) {
+		const balancerId = await resolveApplyServer(file.loadBalancer.server, ctx);
+		const balancerSites = (await listSites({ server_id: balancerId }, ctx)).data;
+		const balancerSite = findLoadBalancerSite(balancerSites, [file.domain, ...file.aliases ?? []]);
+		state.loadBalancer = {
+			serverId: balancerId,
+			site: balancerSite,
+			nodes: balancerSite ? (await listLoadBalancingNodes({
+				server_id: balancerId,
+				site_id: String(balancerSite.id)
+			}, ctx)).data : [],
+			target: Number(serverId)
+		};
+	}
 	return state;
 }
 /**
@@ -5457,6 +5518,20 @@ async function applyChanges(file, plan, state, serverId, site, generatedEnv, ctx
 			...change.cron ? { cron: change.cron } : {}
 		}, ctx);
 	}
+	const balancer = state.loadBalancer;
+	const balancing = plan.changes.find((change) => change.action === "update-load-balancer");
+	if (balancing?.action === "update-load-balancer" && balancer?.site) {
+		options.onChange?.(balancing);
+		await updateLoadBalancingNodes({
+			server_id: balancer.serverId,
+			site_id: String(balancer.site.id),
+			balancer_method: "round_robin",
+			balancing: [{
+				...balancing.to,
+				weight: 1
+			}]
+		}, ctx);
+	}
 	for (const change of deletions) {
 		options.onChange?.(change);
 		if (change.action === "delete-worker") await deleteDaemon({
@@ -5476,6 +5551,7 @@ async function applyChanges(file, plan, state, serverId, site, generatedEnv, ctx
 */
 async function applySiteFile(file, serverId, ctx, options = {}) {
 	let state = await readRemoteState(file, serverId, ctx);
+	assertLoadBalancerSite(file, state);
 	const firstPlan = buildPlan(file, state);
 	let plan = firstPlan;
 	let generatedEnv = /* @__PURE__ */ new Map();
@@ -5513,6 +5589,8 @@ async function applySiteFile(file, serverId, ctx, options = {}) {
 * A key that is absent is not managed; only `server` and `domain` are required.
 */
 var text = v.pipe(v.string(), v.trim(), v.nonEmpty());
+/** A server name (exact match) or ID. */
+var serverRef = v.union([text, v.pipe(v.number(), v.integer(), v.minValue(1))]);
 var SITE_TYPES = [
 	"laravel",
 	"symfony",
@@ -5563,9 +5641,14 @@ var DatabaseEnvSchema = v.pipe(v.strictObject({
 	env.user ?? "DB_USERNAME",
 	env.password ?? "DB_PASSWORD"
 ])).size === 3, "the .env keys of the database must be different"));
+/** The load balancer that sends the traffic of the site to its server. */
+var LoadBalancerSchema = v.strictObject({
+	server: serverRef,
+	port: v.optional(v.pipe(v.number(), v.integer(), v.minValue(1), v.maxValue(65535)), 80)
+});
 var SiteFileSchema = v.strictObject({
 	$schema: v.optional(v.string()),
-	server: v.union([text, v.pipe(v.number(), v.integer(), v.minValue(1))]),
+	server: serverRef,
 	domain: text,
 	aliases: v.optional(v.array(text)),
 	type: v.optional(v.picklist(SITE_TYPES)),
@@ -5588,7 +5671,8 @@ var SiteFileSchema = v.strictObject({
 	]))),
 	nginx: v.optional(text),
 	workers: v.optional(v.array(WorkerSchema)),
-	schedule: v.optional(v.array(ScheduledJobSchema))
+	schedule: v.optional(v.array(ScheduledJobSchema)),
+	loadBalancer: v.optional(LoadBalancerSchema)
 });
 /**
 * Validate parsed JSON as a site file. Throws a ValidationError that lists every issue.
@@ -5651,6 +5735,7 @@ async function sitesApply(ctx, applyOptions = {}) {
 		if (check) {
 			const state = await readRemoteState(file, server_id, execCtx);
 			assertCanCreateSite(file, state);
+			assertLoadBalancerSite(file, state);
 			const plan = buildPlan(file, state);
 			const inSync = plan.changes.length === 0;
 			if (ctx.formatter.isJson()) ctx.formatter.output({
@@ -6711,7 +6796,7 @@ function isVersionRequest({ command, options }) {
 }
 //#endregion
 //#region src/cli.ts
-var VERSION = "0.5.3";
+var VERSION = "0.5.4";
 function showHelp() {
 	console.log(`
 ${colors.bold("forge")} v${VERSION}