Add twenty sdk server upgrade command (#20158)

##
The command pulls the image, compares it against the one the container
was created from, and only recreates the container if the image actually
changed. Your data volumes are preserved — only the container is
replaced.

packages/twenty-sdk/src/cli/operations/index.ts

@@ -27,7 +27,19 @@ export type { FunctionExecuteOptions } from './execute';
 // Server
 export { serverStart } from './server-start';
 export type { ServerStartOptions, ServerStartResult } from './server-start';
+export { serverUpgrade } from './server-upgrade';
+export type {
+  ServerUpgradeOptions,
+  ServerUpgradeResult,
+} from './server-upgrade';
 export { detectLocalServer } from '@/cli/utilities/server/detect-local-server';
+export {
+  checkDockerRunning,
+  containerExists,
+  getContainerDigest,
+  getImageDigest,
+  getImageForVersion,
+} from '@/cli/utilities/server/docker-container';
 
 // Config
 export { ConfigService } from '@/cli/utilities/config/config-service';

packages/twenty-sdk/src/cli/operations/server-upgrade.ts

@@ -0,0 +1,144 @@
+import { SERVER_ERROR_CODES, type CommandResult } from '@/cli/types';
+import { runSafe } from '@/cli/utilities/run-safe';
+import {
+  checkDockerRunning,
+  CONTAINER_NAME,
+  containerExists,
+  getContainerDigest,
+  getContainerPort,
+  getImageDigest,
+  getImageForVersion,
+  TEST_CONTAINER_NAME,
+} from '@/cli/utilities/server/docker-container';
+import { execSync, spawnSync } from 'node:child_process';
+
+export type ServerUpgradeOptions = {
+  version?: string;
+  test?: boolean;
+  onProgress?: (message: string) => void;
+};
+
+export type ServerUpgradeResult = {
+  image: string;
+  imageUpdated: boolean;
+  containerRecreated: boolean;
+};
+
+const innerServerUpgrade = async (
+  options: ServerUpgradeOptions = {},
+): Promise<CommandResult<ServerUpgradeResult>> => {
+  const { version = 'latest', test: isTest, onProgress } = options;
+
+  if (!checkDockerRunning()) {
+    return {
+      success: false,
+      error: {
+        code: SERVER_ERROR_CODES.DOCKER_NOT_RUNNING,
+        message: 'Docker is not running. Please start Docker and try again.',
+      },
+    };
+  }
+
+  const containerName = isTest ? TEST_CONTAINER_NAME : CONTAINER_NAME;
+  const image = getImageForVersion(version);
+  const hasContainer = containerExists(containerName);
+  const previousDigest = hasContainer
+    ? getContainerDigest(containerName)
+    : null;
+
+  onProgress?.(`Pulling ${image}...`);
+
+  const pullResult = spawnSync('docker', ['pull', image], {
+    stdio: 'inherit',
+  });
+
+  if (pullResult.status !== 0) {
+    return {
+      success: false,
+      error: {
+        code: SERVER_ERROR_CODES.IMAGE_UPGRADE_FAILED,
+        message: `Failed to pull image ${image}. Check that the version exists.`,
+      },
+    };
+  }
+
+  const pulledDigest = getImageDigest(image);
+  const imageUpdated = !previousDigest || previousDigest !== pulledDigest;
+
+  if (!hasContainer) {
+    onProgress?.('Image pulled. No existing container to upgrade.');
+
+    return {
+      success: true,
+      data: { image, imageUpdated, containerRecreated: false },
+    };
+  }
+
+  if (!imageUpdated) {
+    onProgress?.('Already up to date.');
+
+    return {
+      success: true,
+      data: { image, imageUpdated: false, containerRecreated: false },
+    };
+  }
+
+  const port = getContainerPort(containerName);
+
+  onProgress?.('Removing existing container...');
+  execSync(`docker rm -f ${containerName}`, { stdio: 'ignore' });
+
+  const volumeData = isTest
+    ? 'twenty-app-dev-test-data'
+    : 'twenty-app-dev-data';
+  const volumeStorage = isTest
+    ? 'twenty-app-dev-test-storage'
+    : 'twenty-app-dev-storage';
+
+  onProgress?.('Starting container with new image...');
+
+  const runResult = spawnSync(
+    'docker',
+    [
+      'run',
+      '-d',
+      '--name',
+      containerName,
+      '-p',
+      `${port}:${port}`,
+      '-e',
+      `NODE_PORT=${port}`,
+      '-e',
+      `SERVER_URL=http://localhost:${port}`,
+      '-v',
+      `${volumeData}:/data/postgres`,
+      '-v',
+      `${volumeStorage}:/app/packages/twenty-server/.local-storage`,
+      image,
+    ],
+    { stdio: 'inherit' },
+  );
+
+  if (runResult.status !== 0) {
+    return {
+      success: false,
+      error: {
+        code: SERVER_ERROR_CODES.IMAGE_UPGRADE_FAILED,
+        message: 'Failed to start container with new image.',
+      },
+    };
+  }
+
+  return {
+    success: true,
+    data: { image, imageUpdated: true, containerRecreated: true },
+  };
+};
+
+export const serverUpgrade = (
+  options?: ServerUpgradeOptions,
+): Promise<CommandResult<ServerUpgradeResult>> =>
+  runSafe(
+    () => innerServerUpgrade(options),
+    SERVER_ERROR_CODES.IMAGE_UPGRADE_FAILED,
+  );