Merge remote-tracking branch 'upstream/main'

README.md

@@ -31,8 +31,6 @@
     </p>
 </p>
 
-> 🗣️🔈 Sorry the latest release is broken, fixing ASAP
-
 <p align="center">
     <i>Ultimately this build tool generates a Keycloak theme <a href="https://www.keycloakify.dev">Learn more</a></i>
     <img src="https://user-images.githubusercontent.com/6702424/110260457-a1c3d380-7fac-11eb-853a-80459b65626b.png">

package.json

@@ -1,6 +1,6 @@
 {
     "name": "keycloakify",
-    "version": "7.6.4",
+    "version": "7.6.6",
     "description": "Create Keycloak themes using React",
     "repository": {
         "type": "git",

src/bin/keycloakify/BuildOptions.ts

@@ -13,7 +13,7 @@ export type BuildOptions = BuildOptions.Standalone | BuildOptions.ExternalAssets
 export namespace BuildOptions {
     export type Common = {
         isSilent: boolean;
-        version: string;
+        themeVersion: string;
         themeName: string;
         extraLoginPages: string[] | undefined;
         extraAccountPages: string[] | undefined;
@@ -149,7 +149,7 @@ export function readBuildOptions(params: { projectDirPath: string; isExternalAss
                               .join(".") ?? fallbackGroupId) + ".keycloak"
                 );
             })(),
-            "version": process.env.KEYCLOAKIFY_VERSION ?? version,
+            "themeVersion": process.env.KEYCLOAKIFY_THEME_VERSION ?? process.env.KEYCLOAKIFY_VERSION ?? version ?? "0.0.0",
             "extraLoginPages": [...(extraPages ?? []), ...(extraLoginPages ?? [])],
             extraAccountPages,
             extraThemeProperties,

src/bin/keycloakify/generateFtl/ftl_object_to_js_code_declaring_an_object.ftl

@@ -1,4 +1,5 @@
 <script>const _= 
+<#assign pageId="PAGE_ID_xIgLsPgGId9D8e">
 (()=>{
 
     const out = ${ftl_object_to_js_code_declaring_an_object(.data_model, [])?no_esc};
@@ -118,8 +119,9 @@
         };
     </#if>
 
-    out["pageId"] = "PAGE_ID_xIgLsPgGId9D8e";
     out["keycloakifyVersion"] = "KEYCLOAKIFY_VERSION_xEdKd3xEdr";
+    out["themeVersion"] = "KEYCLOAKIFY_THEME_VERSION_sIgKd3xEdr3dx";
+    out["pageId"] = "${pageId}";
 
     return out;
 

src/bin/keycloakify/generateFtl/generateFtl.ts

@@ -18,6 +18,7 @@ export type BuildOptionsLike = BuildOptionsLike.Standalone | BuildOptionsLike.Ex
 export namespace BuildOptionsLike {
     export type Common = {
         customUserAttributes: string[];
+        themeVersion: string;
     };
 
     export type Standalone = Common & {
@@ -130,7 +131,8 @@ export function generateFtlFilesCodeFactory(params: {
                 "CUSTOM_USER_ATTRIBUTES_eKsIY4ZsZ4xeM",
                 buildOptions.customUserAttributes.length === 0 ? "" : ", " + buildOptions.customUserAttributes.map(name => `"${name}"`).join(", ")
             )
-            .replace("KEYCLOAKIFY_VERSION_xEdKd3xEdr", keycloakifyVersion),
+            .replace("KEYCLOAKIFY_VERSION_xEdKd3xEdr", keycloakifyVersion)
+            .replace("KEYCLOAKIFY_THEME_VERSION_sIgKd3xEdr3dx", buildOptions.themeVersion),
         "<!-- xIdLqMeOedErIdLsPdNdI9dSlxI -->": [
             "<#if scripts??>",
             "    <#list scripts as script>",

src/bin/keycloakify/generateJavaStackFiles.ts

@@ -9,7 +9,7 @@ export type BuildOptionsLike = {
     themeName: string;
     groupId: string;
     artifactId?: string;
-    version: string;
+    themeVersion: string;
 };
 
 {
@@ -26,7 +26,7 @@ export function generateJavaStackFiles(params: {
     jarFilePath: string;
 } {
     const {
-        buildOptions: { groupId, themeName, version, artifactId },
+        buildOptions: { groupId, themeName, themeVersion, artifactId },
         keycloakThemeBuildingDirPath,
         doBundlesEmailTemplate
     } = params;
@@ -43,7 +43,7 @@ export function generateJavaStackFiles(params: {
                 `	<modelVersion>4.0.0</modelVersion>`,
                 `	<groupId>${groupId}</groupId>`,
                 `	<artifactId>${artifactId}</artifactId>`,
-                `	<version>${version}</version>`,
+                `	<version>${themeVersion}</version>`,
                 `	<name>${artifactId}</name>`,
                 `	<description />`,
                 `</project>`
@@ -83,6 +83,6 @@ export function generateJavaStackFiles(params: {
     }
 
     return {
-        "jarFilePath": pathJoin(keycloakThemeBuildingDirPath, "target", `${artifactId}-${version}.jar`)
+        "jarFilePath": pathJoin(keycloakThemeBuildingDirPath, "target", `${artifactId}-${themeVersion}.jar`)
     };
 }

src/bin/keycloakify/generateKeycloakThemeResources.ts

@@ -20,6 +20,7 @@ export namespace BuildOptionsLike {
         extraThemeProperties?: string[];
         isSilent: boolean;
         customUserAttributes: string[];
+        themeVersion: string;
     };
 
     export type Standalone = Common & {

src/bin/keycloakify/keycloakify.ts

@@ -68,7 +68,7 @@ export async function main() {
             logger.log("🫶 Let keycloakify do its thang");
             await jar({
                 "rootPath": pathJoin(buildOptions.keycloakifyBuildDirPath, "src", "main", "resources"),
-                "version": buildOptions.version,
+                "version": buildOptions.themeVersion,
                 "groupId": buildOptions.groupId,
                 "artifactId": buildOptions.artifactId,
                 "targetPath": jarFilePath

src/bin/keycloakify/parsedPackageJson.ts

@@ -8,7 +8,7 @@ export const bundlers = ["mvn", "keycloakify", "none"] as const;
 export type Bundler = (typeof bundlers)[number];
 export type ParsedPackageJson = {
     name: string;
-    version: string;
+    version?: string;
     homepage?: string;
     keycloakify?: {
         /** @deprecated: use extraLoginPages instead */
@@ -31,7 +31,7 @@ export type ParsedPackageJson = {
 
 export const zParsedPackageJson = z.object({
     "name": z.string(),
-    "version": z.string(),
+    "version": z.string().optional(),
     "homepage": z.string().optional(),
     "keycloakify": z
         .object({

src/bin/tools/jar.ts

@@ -48,7 +48,7 @@ export async function jarStream({ groupId, artifactId, version, asyncPathGenerat
     for await (const entry of asyncPathGeneratorFn()) {
         if ("buffer" in entry) {
             zipFile.addBuffer(entry.buffer, entry.zipPath);
-        } else if ("fsPath" in entry && entry.fsPath.endsWith(sep)) {
+        } else if ("fsPath" in entry && !entry.fsPath.endsWith(sep)) {
             zipFile.addFile(entry.fsPath, entry.zipPath);
         }
     }

src/bin/tools/walk.ts

@@ -1,9 +1,9 @@
 import { readdir } from "fs/promises";
-import { resolve } from "path";
+import { resolve, sep } from "path";
 
 /**
  * Asynchronously and recursively walk a directory tree, yielding every file and directory
- * found
+ * found. Directory paths will _always_ end with a path separator.
  *
  * @param root the starting directory
  * @returns AsyncGenerator
@@ -12,8 +12,8 @@ export default async function* walk(root: string): AsyncGenerator<string, void,
     for (const entry of await readdir(root, { withFileTypes: true })) {
         const absolutePath = resolve(root, entry.name);
         if (entry.isDirectory()) {
-            yield absolutePath;
+            yield absolutePath.endsWith(sep) ? absolutePath : absolutePath + sep;
             yield* walk(absolutePath);
-        } else yield absolutePath;
+        } else yield absolutePath.endsWith(sep) ? absolutePath.substring(0, absolutePath.length - 1) : absolutePath;
     }
 }

test/bin/jar.spec.ts

@@ -1,7 +1,12 @@
-import { jarStream, type ZipEntryGenerator } from "keycloakify/bin/tools/jar";
+import jar, { jarStream, type ZipEntryGenerator } from "keycloakify/bin/tools/jar";
 import { fromBuffer, Entry, ZipFile } from "yauzl";
-import { it, describe, assert } from "vitest";
+import { it, describe, assert, afterAll } from "vitest";
 import { Readable } from "stream";
+import { tmpdir } from "os";
+import { mkdtemp, cp, mkdir, rm } from "fs/promises";
+import path from "path";
+import { createReadStream } from "fs";
+import walk from "keycloakify/bin/tools/walk";
 
 type AsyncIterable<T> = {
     [Symbol.asyncIterator](): AsyncIterableIterator<T>;
@@ -17,7 +22,7 @@ async function readToBuffer(stream: NodeJS.ReadableStream) {
     return Buffer.concat(await arrayFromAsync(stream as AsyncIterable<Buffer>));
 }
 
-function unzip(buffer: Buffer) {
+function unzipBuffer(buffer: Buffer) {
     return new Promise<ZipFile>((resolve, reject) =>
         fromBuffer(buffer, { lazyEntries: true }, (err, zipFile) => {
             if (err !== null) {
@@ -57,15 +62,22 @@ function readAll(zipFile: ZipFile): Promise<Map<string, Buffer>> {
 }
 
 describe("jar", () => {
+    const coords = { artifactId: "someArtifactId", groupId: "someGroupId", version: "1.2.3" };
+
+    const tmpDirs: string[] = [];
+
+    afterAll(async () => {
+        await Promise.all(tmpDirs.map(dir => rm(dir, { force: true, recursive: true })));
+    });
+
     it("creates jar artifacts without error", async () => {
         async function* mockFiles(): ZipEntryGenerator {
             yield { zipPath: "foo", buffer: Buffer.from("foo") };
         }
 
-        const opts = { artifactId: "someArtifactId", groupId: "someGroupId", version: "1.2.3", asyncPathGeneratorFn: mockFiles };
+        const zipped = await jarStream({ ...coords, asyncPathGeneratorFn: mockFiles });
-        const zipped = await jarStream(opts);
         const buffered = await readToBuffer(zipped.outputStream);
-        const unzipped = await unzip(buffered);
+        const unzipped = await unzipBuffer(buffered);
         const entries = await readAll(unzipped);
 
         assert.equal(entries.size, 3);
@@ -83,4 +95,31 @@ describe("jar", () => {
         assert.isOk(pomProperties?.includes("someGroupId"));
         assert.isOk(pomProperties?.includes("someArtifactId"));
     });
+
+    it("creates a jar from _real_ files without error", async () => {
+        const tmp = await mkdtemp(path.join(tmpdir(), "kc-jar-test-"));
+        tmpDirs.push(tmp);
+        const rootPath = path.join(tmp, "src");
+        const targetPath = path.join(tmp, "jar.jar");
+        await mkdir(rootPath);
+
+        await cp(path.dirname(__dirname), rootPath, { recursive: true });
+
+        await jar({ ...coords, rootPath, targetPath });
+
+        const buffered = await readToBuffer(createReadStream(targetPath));
+        const unzipped = await unzipBuffer(buffered);
+        const entries = await readAll(unzipped);
+        const zipPaths = Array.from(entries.keys());
+
+        assert.isOk(entries.has("META-INF/MANIFEST.MF"));
+        assert.isOk(entries.has("META-INF/maven/someGroupId/someArtifactId/pom.properties"));
+
+        for await (const fsPath of walk(rootPath)) {
+            if (!fsPath.endsWith(path.sep)) {
+                const rel = path.relative(rootPath, fsPath).replace(path.sep === "/" ? /\//g : /\\/g, "/");
+                assert.isOk(zipPaths.includes(rel), `missing ${rel} (${rel}, ${zipPaths.join(", ")})`);
+            }
+        }
+    });
 });