Refactor how we update META-INF and how we read what theme types are implemented

src/bin/keycloakify/buildJars/buildJar.ts

@@ -16,7 +16,7 @@ import { readFileSync } from "fs";
 import { isInside } from "../../tools/isInside";
 import child_process from "child_process";
 import { rmSync } from "../../tools/fs.rmSync";
-import { getMetaInfKeycloakThemesJsonFilePath } from "../../shared/metaInfKeycloakThemes";
+import { writeMetaInfKeycloakThemes } from "../../shared/metaInfKeycloakThemes";
 
 export type BuildContextLike = BuildContextLike_generatePom & {
     keycloakifyBuildDirPath: string;
@@ -50,9 +50,16 @@ export async function buildJar(params: {
 
     rmSync(keycloakifyBuildTmpDirPath, { recursive: true, force: true });
 
+    const tmpResourcesDirPath = pathJoin(
+        keycloakifyBuildTmpDirPath,
+        "src",
+        "main",
+        "resources"
+    );
+
     transformCodebase({
         srcDirPath: resourcesDirPath,
-        destDirPath: pathJoin(keycloakifyBuildTmpDirPath, "src", "main", "resources"),
+        destDirPath: tmpResourcesDirPath,
         transformSourceCode:
             keycloakAccountV1Version !== null
                 ? undefined
@@ -71,31 +78,6 @@ export async function buildJar(params: {
                           return undefined;
                       }
 
-                      if (
-                          fileRelativePath ===
-                          getMetaInfKeycloakThemesJsonFilePath({
-                              resourcesDirPath: "."
-                          })
-                      ) {
-                          const keycloakThemesJsonParsed = JSON.parse(
-                              sourceCode.toString("utf8")
-                          ) as {
-                              themes: { name: string; types: string[] }[];
-                          };
-
-                          keycloakThemesJsonParsed.themes =
-                              keycloakThemesJsonParsed.themes.filter(
-                                  ({ name }) => name !== accountV1ThemeName
-                              );
-
-                          return {
-                              modifiedSourceCode: Buffer.from(
-                                  JSON.stringify(keycloakThemesJsonParsed, null, 2),
-                                  "utf8"
-                              )
-                          };
-                      }
-
                       for (const themeName of buildContext.themeNames) {
                           if (
                               fileRelativePath ===
@@ -123,6 +105,21 @@ export async function buildJar(params: {
                   }
     });
 
+    if (keycloakAccountV1Version === null) {
+        writeMetaInfKeycloakThemes({
+            resourcesDirPath: tmpResourcesDirPath,
+            getNewMetaInfKeycloakTheme: ({ metaInfKeycloakTheme }) => {
+                assert(metaInfKeycloakTheme !== undefined);
+
+                metaInfKeycloakTheme.themes = metaInfKeycloakTheme.themes.filter(
+                    ({ name }) => name !== accountV1ThemeName
+                );
+
+                return metaInfKeycloakTheme;
+            }
+        });
+    }
+
     route_legacy_pages: {
         // NOTE: If there's no account theme there is no special target for keycloak 24 and up so we create
         // the pages anyway. If there is an account pages, since we know that account-v1 is only support keycloak

src/bin/keycloakify/buildJars/buildJars.ts

@@ -8,10 +8,10 @@ import { getKeycloakVersionRangeForJar } from "./getKeycloakVersionRangeForJar";
 import { buildJar, BuildContextLike as BuildContextLike_buildJar } from "./buildJar";
 import type { BuildContext } from "../../shared/buildContext";
 import { getJarFileBasename } from "../../shared/getJarFileBasename";
-import { readMetaInfKeycloakThemes_fromResourcesDirPath } from "../../shared/metaInfKeycloakThemes";
-import { accountV1ThemeName } from "../../shared/constants";
+import { getImplementedThemeTypes } from "../../shared/getImplementedThemeTypes";
 
 export type BuildContextLike = BuildContextLike_buildJar & {
+    projectDirPath: string;
     keycloakifyBuildDirPath: string;
 };
 
@@ -24,9 +24,9 @@ export async function buildJars(params: {
 }): Promise<void> {
     const { onlyBuildJarFileBasename, resourcesDirPath, buildContext } = params;
 
-    const doesImplementAccountTheme = readMetaInfKeycloakThemes_fromResourcesDirPath({
-        resourcesDirPath
-    }).themes.some(({ name }) => name === accountV1ThemeName);
+    const doesImplementAccountTheme = getImplementedThemeTypes({
+        projectDirPath: buildContext.projectDirPath
+    }).implementedThemeTypes.account;
 
     await Promise.all(
         keycloakAccountV1Versions

src/bin/keycloakify/generateResources/generateResourcesForMainTheme.ts

@@ -1,6 +1,6 @@
 import { transformCodebase } from "../../tools/transformCodebase";
 import * as fs from "fs";
-import { join as pathJoin, resolve as pathResolve } from "path";
+import { join as pathJoin, resolve as pathResolve, relative as pathRelative } from "path";
 import { replaceImportsInJsCode } from "../replacers/replaceImportsInJsCode";
 import { replaceImportsInCssCode } from "../replacers/replaceImportsInCssCode";
 import {
@@ -16,7 +16,6 @@ import {
     loginThemePageIds,
     accountThemePageIds
 } from "../../shared/constants";
-import { isInside } from "../../tools/isInside";
 import type { BuildContext } from "../../shared/buildContext";
 import { assert, type Equals } from "tsafe/assert";
 import {
@@ -39,6 +38,7 @@ import {
 } from "../../shared/metaInfKeycloakThemes";
 import { objectEntries } from "tsafe/objectEntries";
 import { escapeStringForPropertiesFile } from "../../tools/escapeStringForPropertiesFile";
+import { getImplementedThemeTypes } from "../../shared/getImplementedThemeTypes";
 
 export type BuildContextLike = BuildContextLike_kcContextExclusionsFtlCode &
     BuildContextLike_downloadKeycloakStaticResources &
@@ -63,6 +63,10 @@ export async function generateResourcesForMainTheme(params: {
         projectDirPath: buildContext.projectDirPath
     });
 
+    const { implementedThemeTypes } = getImplementedThemeTypes({
+        projectDirPath: buildContext.projectDirPath
+    });
+
     const getThemeTypeDirPath = (params: { themeType: ThemeType | "email" }) => {
         const { themeType } = params;
         return pathJoin(resourcesDirPath, "theme", themeName, themeType);
@@ -70,19 +74,11 @@ export async function generateResourcesForMainTheme(params: {
 
     const cssGlobalsToDefine: Record<string, string> = {};
 
-    const implementedThemeTypes: Record<ThemeType | "email", boolean> = {
-        login: false,
-        account: false,
-        email: false
-    };
-
     for (const themeType of ["login", "account"] as const) {
-        if (!fs.existsSync(pathJoin(themeSrcDirPath, themeType))) {
+        if (!implementedThemeTypes[themeType]) {
             continue;
         }
 
-        implementedThemeTypes[themeType] = true;
-
         const themeTypeDirPath = getThemeTypeDirPath({ themeType });
 
         apply_replacers_and_move_to_theme_resources: {
@@ -112,25 +108,32 @@ export async function generateResourcesForMainTheme(params: {
                 break apply_replacers_and_move_to_theme_resources;
             }
 
+            {
+                const dirPath = pathJoin(
+                    buildContext.projectBuildDirPath,
+                    keycloak_resources
+                );
+
+                if (fs.existsSync(dirPath)) {
+                    assert(buildContext.bundler === "webpack");
+
+                    throw new Error(
+                        [
+                            `Keycloakify build error: The ${keycloak_resources} directory shouldn't exist in your build directory.`,
+                            `(${pathRelative(process.cwd(), dirPath)}).\n`,
+                            `Theses assets are only required for local development with Storybook.",
+                            "Please remove this directory as an additional step of your command.\n`,
+                            `For example: \`"build": "... && rimraf ${pathRelative(buildContext.projectDirPath, dirPath)}"\``
+                        ].join(" ")
+                    );
+                }
+            }
+
             transformCodebase({
                 srcDirPath: buildContext.projectBuildDirPath,
                 destDirPath,
                 transformSourceCode: ({ filePath, sourceCode }) => {
-                    //NOTE: Prevent cycles, excludes the folder we generated for debug in public/
-                    // This should not happen if users follow the new instruction setup but we keep it for retrocompatibility.
-                    if (
-                        isInside({
-                            dirPath: pathJoin(
-                                buildContext.projectBuildDirPath,
-                                keycloak_resources
-                            ),
-                            filePath
-                        })
-                    ) {
-                        return undefined;
-                    }
-
-                    if (/\.css?$/i.test(filePath)) {
+                    if (filePath.endsWith(".css")) {
                         const {
                             cssGlobalsToDefine: cssGlobalsToDefineForThisFile,
                             fixedCssCode
@@ -149,7 +152,7 @@ export async function generateResourcesForMainTheme(params: {
                         };
                     }
 
-                    if (/\.js?$/i.test(filePath)) {
+                    if (filePath.endsWith(".js")) {
                         const { fixedJsCode } = replaceImportsInJsCode({
                             jsCode: sourceCode.toString("utf8"),
                             buildContext
@@ -262,13 +265,11 @@ export async function generateResourcesForMainTheme(params: {
     }
 
     email: {
-        const emailThemeSrcDirPath = pathJoin(themeSrcDirPath, "email");
-
-        if (!fs.existsSync(emailThemeSrcDirPath)) {
+        if (!implementedThemeTypes.email) {
             break email;
         }
 
-        implementedThemeTypes.email = true;
+        const emailThemeSrcDirPath = pathJoin(themeSrcDirPath, "email");
 
         transformCodebase({
             srcDirPath: emailThemeSrcDirPath,
@@ -302,7 +303,7 @@ export async function generateResourcesForMainTheme(params: {
 
         writeMetaInfKeycloakThemes({
             resourcesDirPath,
-            metaInfKeycloakThemes
+            getNewMetaInfKeycloakTheme: () => metaInfKeycloakThemes
         });
     }
 }

src/bin/keycloakify/generateResources/generateResourcesForThemeVariant.ts

@@ -1,10 +1,7 @@
 import { join as pathJoin, extname as pathExtname, sep as pathSep } from "path";
 import { transformCodebase } from "../../tools/transformCodebase";
 import type { BuildContext } from "../../shared/buildContext";
-import {
-    readMetaInfKeycloakThemes_fromResourcesDirPath,
-    writeMetaInfKeycloakThemes
-} from "../../shared/metaInfKeycloakThemes";
+import { writeMetaInfKeycloakThemes } from "../../shared/metaInfKeycloakThemes";
 import { assert } from "tsafe/assert";
 
 export type BuildContextLike = {
@@ -34,8 +31,8 @@ export function generateResourcesForThemeVariant(params: {
                     Buffer.from(sourceCode)
                         .toString("utf-8")
                         .replace(
-                            `out["themeName"] = "${themeName}";`,
-                            `out["themeName"] = "${themeVariantName}";`
+                            `kcContext.themeName = "${themeName}";`,
+                            `kcContext.themeName = "${themeVariantName}";`
                         ),
                     "utf8"
                 );
@@ -49,26 +46,25 @@ export function generateResourcesForThemeVariant(params: {
         }
     });
 
-    {
-        const updatedMetaInfKeycloakThemes =
-            readMetaInfKeycloakThemes_fromResourcesDirPath({
-                resourcesDirPath
+    writeMetaInfKeycloakThemes({
+        resourcesDirPath,
+        getNewMetaInfKeycloakTheme: ({ metaInfKeycloakTheme }) => {
+            assert(metaInfKeycloakTheme !== undefined);
+
+            const newMetaInfKeycloakTheme = metaInfKeycloakTheme;
+
+            newMetaInfKeycloakTheme.themes.push({
+                name: themeVariantName,
+                types: (() => {
+                    const theme = newMetaInfKeycloakTheme.themes.find(
+                        ({ name }) => name === themeName
+                    );
+                    assert(theme !== undefined);
+                    return theme.types;
+                })()
             });
 
-        updatedMetaInfKeycloakThemes.themes.push({
-            name: themeVariantName,
-            types: (() => {
-                const theme = updatedMetaInfKeycloakThemes.themes.find(
-                    ({ name }) => name === themeName
-                );
-                assert(theme !== undefined);
-                return theme.types;
-            })()
-        });
-
-        writeMetaInfKeycloakThemes({
-            resourcesDirPath,
-            metaInfKeycloakThemes: updatedMetaInfKeycloakThemes
-        });
-    }
+            return newMetaInfKeycloakTheme;
+        }
+    });
 }