Use random port for dev server

src/bin/keycloakify/generateFtl/generateFtl.ts

@@ -11,7 +11,11 @@ import * as fs from "fs";
 import { join as pathJoin } from "path";
 import type { BuildContext } from "../../shared/buildContext";
 import { assert } from "tsafe/assert";
-import { type ThemeType, WELL_KNOWN_DIRECTORY_BASE_NAME } from "../../shared/constants";
+import {
+    type ThemeType,
+    WELL_KNOWN_DIRECTORY_BASE_NAME,
+    KEYCLOAKIFY_SPA_DEV_SERVER_PORT
+} from "../../shared/constants";
 import { getThisCodebaseRootDirPath } from "../../tools/getThisCodebaseRootDirPath";
 
 export type BuildContextLike = BuildContextLike_replaceImportsInJsCode &
@@ -116,6 +120,7 @@ export function generateFtlFilesCodeFactory(params: {
         .replace("{{themeVersion}}", buildContext.themeVersion)
         .replace("{{fieldNames}}", fieldNames.map(name => `"${name}"`).join(", "))
         .replace("{{RESOURCES_COMMON}}", WELL_KNOWN_DIRECTORY_BASE_NAME.RESOURCES_COMMON)
+        .replace("{{KEYCLOAKIFY_SPA_DEV_SERVER_PORT}}", KEYCLOAKIFY_SPA_DEV_SERVER_PORT)
         .replace(
             "{{userDefinedExclusions}}",
             buildContext.kcContextExclusionsFtlCode ?? ""

src/bin/keycloakify/generateFtl/kcContextDeclarationTemplate.ftl

@@ -101,7 +101,7 @@ redirect_to_dev_server: {
             break redirect_to_dev_server;
     }
 
-    const devSeverPort = kcContext.properties.KEYCLOAKIFY_SPA_DEV_SERVER_PORT;
+    const devSeverPort = kcContext.properties.{{KEYCLOAKIFY_SPA_DEV_SERVER_PORT}};
 
     if( !devSeverPort ){
         break redirect_to_dev_server;
@@ -115,7 +115,7 @@ redirect_to_dev_server: {
 
     console.log(kcContext);
 
-    redirectUrl.searchParams.set("kcContext", encodeURIComponent(JSON.stringify(kcContext)) );
+    redirectUrl.searchParams.set("kcContext", encodeURIComponent(JSON.stringify(kcContext)));
 
     window.location.href = redirectUrl.toString();
 

src/bin/start-keycloak/start-keycloak.ts

@@ -380,14 +380,14 @@ export async function command(params: {
     const port =
         cliCommandOptions.port ?? buildContext.startKeycloakOptions.port ?? DEFAULT_PORT;
 
-    const devServerPort = (() => {
+    const doStartDevServer = (() => {
         const hasSpaUi =
             buildContext.implementedThemeTypes.admin.isImplemented ||
             (buildContext.implementedThemeTypes.account.isImplemented &&
                 buildContext.implementedThemeTypes.account.type === "Single-Page");
 
         if (!hasSpaUi) {
-            return undefined;
+            return false;
         }
 
         if (buildContext.bundler !== "vite") {
@@ -401,7 +401,7 @@ export async function command(params: {
                 )
             );
 
-            return undefined;
+            return false;
         }
 
         if (keycloakMajorVersionNumber < 25) {
@@ -415,17 +415,18 @@ export async function command(params: {
                 )
             );
 
-            return undefined;
+            return false;
         }
 
-        return port + 1;
+        return true;
     })();
 
-    if (devServerPort !== undefined) {
+    let devServerPort: number | undefined = undefined;
-        startViteDevServer({
+
-            buildContext,
+    if (doStartDevServer) {
-            port: devServerPort
+        const { port } = await startViteDevServer({ buildContext });
-        });
+
+        devServerPort = port;
     }
 
     const SPACE_PLACEHOLDER = "SPACE_PLACEHOLDER_xKLmdPd";

src/bin/start-keycloak/startViteDevServer.ts

@@ -3,6 +3,7 @@ import { assert } from "tsafe/assert";
 import type { BuildContext } from "../shared/buildContext";
 import chalk from "chalk";
 import { VITE_PLUGIN_SUB_SCRIPTS_ENV_NAMES } from "../shared/constants";
+import { Deferred } from "evt/tools/Deferred";
 
 export type BuildContextLike = {
     projectDirPath: string;
@@ -12,13 +13,12 @@ assert<BuildContext extends BuildContextLike ? true : false>();
 
 export function startViteDevServer(params: {
     buildContext: BuildContextLike;
-    port: number;
+}): Promise<{ port: number }> {
-}): void {
+    const { buildContext } = params;
-    const { buildContext, port } = params;
 
-    console.log(chalk.blue(`$ npx vite dev --port ${port}`));
+    console.log(chalk.blue(`$ npx vite dev`));
 
-    const child = child_process.spawn("npx", ["vite", "dev", "--port", `${port}`], {
+    const child = child_process.spawn("npx", ["vite", "dev"], {
         cwd: buildContext.projectDirPath,
         env: {
             ...process.env,
@@ -36,4 +36,31 @@ export function startViteDevServer(params: {
     });
 
     child.stderr.on("data", data => process.stderr.write(data));
+
+    const dPort = new Deferred<number>();
+
+    {
+        const onData = (data: Buffer) => {
+            //Local:   http://localhost:8083/
+            const match = data
+                .toString("utf8")
+                .match(/Local:\s*http:\/\/(?:localhost|127\.0\.0\.1):(\d+)\//);
+
+            if (match === null) {
+                return;
+            }
+
+            child.stdout.off("data", onData);
+
+            const port = parseInt(match[1]);
+
+            assert(!isNaN(port));
+
+            dPort.resolve(port);
+        };
+
+        child.stdout.on("data", onData);
+    }
+
+    return dPort.pr.then(port => ({ port }));
 }