refactor(cli): create-key (#14501)

Author: florian-lefebvre

packages/astro/src/cli/create-key/core/create-key.ts

@@ -0,0 +1,18 @@
+import type { Logger } from '../../../core/logger/core.js';
+import type { KeyGenerator } from '../definitions.js';
+
+interface CreateKeyOptions {
+	logger: Logger;
+	keyGenerator: KeyGenerator;
+}
+
+export async function createKey({ logger, keyGenerator }: CreateKeyOptions) {
+	const key = await keyGenerator.generate();
+
+	logger.info(
+		'crypto',
+		`Generated a key to encrypt props passed to server islands. To reuse the same key across builds, set this value as ASTRO_KEY in an environment variable on your build server.
+
+ASTRO_KEY=${key}`,
+	);
+}

packages/astro/src/cli/create-key/definitions.ts

@@ -0,0 +1,3 @@
+export interface KeyGenerator {
+	generate: () => Promise<string>;
+}

packages/astro/src/cli/create-key/index.ts

@@ -0,0 +1,12 @@
+import { createKey, encodeKey } from '../../../core/encryption.js';
+import type { KeyGenerator } from '../definitions.js';
+
+export function createCryptoKeyGenerator(): KeyGenerator {
+	return {
+		async generate() {
+			const key = await createKey();
+			const encoded = await encodeKey(key);
+			return encoded;
+		},
+	};
+}

packages/astro/src/cli/create-key/infra/crypto-key-generator.ts

@@ -109,9 +109,16 @@ async function runCommand(cmd: string, flags: yargs.Arguments) {
 			return;
 		}
 		case 'create-key': {
-			const { createKey } = await import('./create-key/index.js');
-			const exitCode = await createKey({ flags });
-			return process.exit(exitCode);
+			const [{ createKey }, { createLoggerFromFlags }, { createCryptoKeyGenerator }] =
+				await Promise.all([
+					import('./create-key/core/create-key.js'),
+					import('./flags.js'),
+					import('./create-key/infra/crypto-key-generator.js'),
+				]);
+			const logger = createLoggerFromFlags(flags);
+			const keyGenerator = createCryptoKeyGenerator();
+			await createKey({ logger, keyGenerator });
+			return;
 		}
 		case 'docs': {
 			const { docs } = await import('./docs/index.js');

packages/astro/src/cli/index.ts

@@ -20,9 +20,8 @@ import { createBuildUrlProxyHashResolver } from '../../../../dist/assets/fonts/i
 import { createDevUrlResolver } from '../../../../dist/assets/fonts/implementations/url-resolver.js';
 import { orchestrate } from '../../../../dist/assets/fonts/orchestrate.js';
 import { defineAstroFontProvider } from '../../../../dist/assets/fonts/providers/index.js';
-import { defaultLogger } from '../../test-utils.js';
+import { createSpyLogger, defaultLogger } from '../../test-utils.js';
 import {
-	createSpyLogger,
 	createSpyStorage,
 	fakeFontMetricsResolver,
 	fakeHasher,

packages/astro/test/units/assets/fonts/orchestrate.test.js

@@ -83,31 +83,6 @@ export const fakeFontMetricsResolver = {
 	},
 };
 
-export function createSpyLogger() {
-	/** @type {Array<{ type: string; label: string | null; message: string }>} */
-	const logs = [];
-
-	/** @type {import('../../../../dist/core/logger/core').Logger} */
-	const logger = {
-		debug: (label, ...messages) => {
-			logs.push(...messages.map((message) => ({ type: 'debug', label, message })));
-		},
-		error: (label, message) => {
-			logs.push({ type: 'error', label, message });
-		},
-		info: (label, message) => {
-			logs.push({ type: 'info', label, message });
-		},
-		warn: (label, message) => {
-			logs.push({ type: 'warn', label, message });
-		},
-	};
-	return {
-		logs,
-		logger,
-	};
-}
-
 /**
  * @param {string} input
  */

packages/astro/test/units/assets/fonts/utils.js

@@ -0,0 +1,26 @@
+// @ts-check
+import assert from 'node:assert/strict';
+import { describe, it } from 'node:test';
+import { createKey } from '../../../dist/cli/create-key/core/create-key.js';
+import { createSpyLogger } from '../test-utils.js';
+
+describe('CLI create-key', () => {
+	describe('core', () => {
+		describe('create-key', () => {
+			it('logs the generated key', async () => {
+				const { logger, logs } = createSpyLogger();
+
+				await createKey({
+					logger,
+					keyGenerator: {
+						generate: async () => 'FOO',
+					},
+				});
+
+				assert.equal(logs[0].type, 'info');
+				assert.equal(logs[0].label, 'crypto');
+				assert.match(logs[0].message, /ASTRO_KEY=FOO/);
+			});
+		});
+	});
+});

packages/astro/test/units/cli/create-key.test.js

@@ -7,7 +7,7 @@ import { getDefaultClientDirectives } from '../../dist/core/client-directive/ind
 import { resolveConfig } from '../../dist/core/config/index.js';
 import { createBaseSettings } from '../../dist/core/config/settings.js';
 import { createContainer } from '../../dist/core/dev/container.js';
-import { Logger } from '../../dist/core/logger/core.js';
+import { AstroIntegrationLogger, Logger } from '../../dist/core/logger/core.js';
 import { nodeLogDestination } from '../../dist/core/logger/node.js';
 import { NOOP_MIDDLEWARE_FN } from '../../dist/core/middleware/noop-middleware.js';
 import { Pipeline } from '../../dist/core/render/index.js';
@@ -167,3 +167,39 @@ export async function runInContainer(options = {}, callback) {
 		await container.close();
 	}
 }
+
+export function createSpyLogger() {
+	/** @type {Array<{ type: string; label: string | null; message: string }>} */
+	const logs = [];
+
+	/** @type {import('../../dist/core/logger/core').Logger} */
+	const logger = {
+		debug: (label, ...messages) => {
+			logs.push(...messages.map((message) => ({ type: 'debug', label, message })));
+		},
+		error: (label, message) => {
+			logs.push({ type: 'error', label, message });
+		},
+		info: (label, message) => {
+			logs.push({ type: 'info', label, message });
+		},
+		warn: (label, message) => {
+			logs.push({ type: 'warn', label, message });
+		},
+		options: {
+			dest: {
+				write: () => true,
+			},
+			level: 'silent',
+		},
+		level: () => 'silent',
+		forkIntegrationLogger(label) {
+			return new AstroIntegrationLogger(this.options, label);
+		},
+	};
+
+	return {
+		logs,
+		logger,
+	};
+}