#587 round trip support mainly working. Needs more testing.

davetcc · davetcc · commit ae8fa31a5f08 · 2026-06-27T23:57:11.000+01:00
diff --git a/web-designer/tcmenu-web-generator/src/main/java/com/thecoderscorner/menu/web/controller/GenerateCodeController.java b/web-designer/tcmenu-web-generator/src/main/java/com/thecoderscorner/menu/web/controller/GenerateCodeController.java
@@ -34,6 +34,7 @@
 import org.springframework.http.ResponseEntity;
 import org.springframework.util.FileSystemUtils;
 import org.springframework.util.ObjectUtils;
+import org.springframework.util.StringUtils;
 import org.springframework.web.bind.MethodArgumentNotValidException;
 import org.springframework.web.bind.annotation.*;
 import org.springframework.web.client.HttpClientErrorException;
@@ -212,7 +213,13 @@ public GenerationResponse generateCode(@RequestBody String requestData, HttpServ
         Path tempDir = null;
         try {
             tempDir = Files.createTempDirectory("tcmenu-gen");
-            var fileName = VariableNameGenerator.makeNameFromVariable(menuWithOptions.getOptions().getApplicationName());
+            String fileName = request.getProjectOverrideDir();
+            if(!StringUtils.hasLength(fileName)) {
+                fileName = VariableNameGenerator.makeNameFromVariable(menuWithOptions.getOptions().getApplicationName());
+                logger.info("Generating project dir from name as: " + fileName);
+            } else {
+                logger.info("Using project override directory: " +  fileName);
+            }
             if(fileName.contains("..") || fileName.contains("/") || fileName.contains("\\")) {
                 throw new IllegalArgumentException("Invalid filename - directory traversal not allowed");
             }
@@ -248,7 +255,7 @@ public GenerationResponse generateCode(@RequestBody String requestData, HttpServ
 
             var howLong = Duration.ofMillis(System.currentTimeMillis() - millisStart);
             logger.info("Thank you for choosing TcMenu. Task completed in %02d.%03d seconds".formatted(howLong.toSecondsPart(), howLong.toMillisPart()));
-            var response = GenerationResponse.okResponse(logger.filesInOutput, logger.logEntries, buildUuid);
+            var response = GenerationResponse.okResponse(logger.filesInOutput, logger.logEntries, buildUuid, projectPath);
             codeBuildCache.put(buildUuid.toString(), new CodeBuildInfo(buildUuid.toString(), uuid, LocalDateTime.now(), response, tempDir));
             return response;
         } catch(Exception ex) {
diff --git a/web-designer/tcmenu-web-generator/src/main/java/com/thecoderscorner/menu/web/domain/GenerateCodeRequest.java b/web-designer/tcmenu-web-generator/src/main/java/com/thecoderscorner/menu/web/domain/GenerateCodeRequest.java
@@ -14,6 +14,7 @@
 @Data
 public class GenerateCodeRequest {
     private PersistedProject project;
+    private String projectOverrideDir;
     private List<CreatorProperty> existingProperties;
     private List<GeneratedFile> requiredFiles;
 }
diff --git a/web-designer/tcmenu-web-generator/src/main/java/com/thecoderscorner/menu/web/domain/GenerationResponse.java b/web-designer/tcmenu-web-generator/src/main/java/com/thecoderscorner/menu/web/domain/GenerationResponse.java
@@ -20,13 +20,14 @@ public static GenerationResponse badResponse(List<LogEntry> logs) {
         return new GenerationResponse(false, List.of(), logs, null);
     }
 
-    public static GenerationResponse okResponse(List<GeneratedFile> files, List<LogEntry> logs, UUID buildId) {
-        return new GenerationResponse(true, sanitiseFilesInOutput(files), logs, buildId.toString());
+    public static GenerationResponse okResponse(List<GeneratedFile> files, List<LogEntry> logs, UUID buildId, Path basePath) {
+        return new GenerationResponse(true, sanitiseFilesInOutput(files, basePath), logs, buildId.toString());
     }
 
-    private static List<GeneratedFile> sanitiseFilesInOutput(List<GeneratedFile> files) {
+    private static List<GeneratedFile> sanitiseFilesInOutput(List<GeneratedFile> files, Path basePath) {
         return files.stream()
-                .map(gf -> new GeneratedFile(Path.of(gf.getFileName()).getFileName().toString(), gf.getContent(), gf.isAlwaysOverwrite()))
+                .map(gf -> new GeneratedFile(basePath.relativize(Path.of(gf.getFileName())).toString(),
+                        gf.getContent(), gf.isAlwaysOverwrite()))
                 .toList();
     }
 
diff --git a/web-designer/tcmenugen/src/App.tsx b/web-designer/tcmenugen/src/App.tsx
@@ -30,9 +30,9 @@ export function getDirectoryHandle(): FileSystemDirectoryHandle|null {
     return globalDirectoryHandle;
 }
 
-export const findFileWithExtension = async (directoryHandle: any, ext1: string, ext2: string = "undef"): Promise<any | null> => {
+export const findFileWithExtension = async (directoryHandle: any, ext1: string, ext2: string = ".undef"): Promise<any | null> => {
     for await (const entry of directoryHandle.values()) {
-        if (entry.kind === 'file' && (entry.name.endsWith('.' + ext1) || entry.name.endsWith('.' + ext2))) {
+        if (entry.kind === 'file' && (entry.name.endsWith(ext1) || entry.name.endsWith(ext2))) {
             return entry;
         }
     }
diff --git a/web-designer/tcmenugen/src/generator/FilePatcher.ts b/web-designer/tcmenugen/src/generator/FilePatcher.ts
@@ -0,0 +1,76 @@
+import {GeneratedFile} from "./TcCodeGeneration";
+import {MenuTreeWithCodeOptions, RoundTripMode} from "../domain/ProjectStruct";
+import {getDirectoryHandle} from "../App";
+
+export async function filePatcher(files: GeneratedFile[], project: MenuTreeWithCodeOptions) {
+    if(project.roundTripMode !== RoundTripMode.DIRECTORY_IN_BROWSER) {
+        throw new Error("Round trip mode must be enabled for file patching");
+    }
+
+    const rootDirectory = getDirectoryHandle();
+    if(rootDirectory == null) {
+        throw new Error("The project directory is not resolvable. Please use the zip and patch manually");
+    }
+
+    const permission = await (rootDirectory as any).queryPermission({ mode: "readwrite" });
+    if(permission !== "granted") {
+        const requestedPermission = await (rootDirectory as any).requestPermission({ mode: "readwrite" });
+        if(requestedPermission !== "granted") {
+            throw new Error("Write permission was not granted. Please use the zip and patch manually");
+        }
+    }
+
+    const resolvedFiles = files.map(file => {
+        const pathSegments = file.fileName.split("/");
+
+        if(
+            file.fileName.startsWith("/") ||
+            file.fileName.includes("\\") ||
+            pathSegments.some(segment => segment === "" || segment === "." || segment === "..")
+        ) {
+            throw new Error("Invalid generated file path: " + file.fileName);
+        }
+
+        const directorySegments = pathSegments.slice(0, -1);
+        const fileName = pathSegments[pathSegments.length - 1];
+
+        if(directorySegments.length > 3) {
+            throw new Error("Too many levels in the returned zip. Path=" + file.fileName);
+        }
+
+        return {
+            file,
+            directorySegments,
+            fileName
+        };
+    });
+
+    for(const resolvedFile of resolvedFiles) {
+        let directoryHandle = rootDirectory;
+
+        for(const segment of resolvedFile.directorySegments) {
+            directoryHandle = await directoryHandle.getDirectoryHandle(segment, { create: true });
+        }
+
+        if(!resolvedFile.file.alwaysOverwrite) {
+            try {
+                await directoryHandle.getFileHandle(resolvedFile.fileName, { create: false });
+                console.log(`File ${resolvedFile.fileName} is not overwritable and already exists, skipping`);
+                continue;
+            } catch(error) {
+                console.log(`File ${resolvedFile.fileName} does not exist, creating`);
+            }
+        } else {
+            console.log(`File ${resolvedFile.fileName} will be written out`);
+        }
+
+        const fileHandle = await directoryHandle.getFileHandle(resolvedFile.fileName, { create: true });
+        const writable = await (fileHandle as any).createWritable();
+
+        try {
+            await writable.write(resolvedFile.file.content);
+        } finally {
+            await writable.close();
+        }
+    }
+}
diff --git a/web-designer/tcmenugen/src/generator/GenerateCodeView.tsx b/web-designer/tcmenugen/src/generator/GenerateCodeView.tsx
@@ -329,7 +329,7 @@ export function GenerateCodeView() {
         if(project.roundTripMode === RoundTripMode.DIRECTORY_IN_BROWSER) {
             const dir = getDirectoryHandle();
             if(dir == null) throw new Error("No directory handle");
-            const inoFile = await findFileWithExtension(dir, 'ino', 'cpp');
+            const inoFile = await findFileWithExtension(dir, '.ino', '_main.cpp');
             if(inoFile !== null) {
                 const inoActFile = await inoFile.getFile();
                 ret.push({fileName: inoFile.name, content: await inoActFile.text(), alwaysOverwrite: true});
@@ -382,14 +382,10 @@ export function GenerateCodeView() {
 
         if(!project) return;
 
-        runGenerateCode(project, await requiredFilesForBuild()).then(response => {
+        const possibleDir = getDirectoryHandle()?.name ?? null;
+        runGenerateCode(project, await requiredFilesForBuild(), possibleDir).then(response => {
             console.log("Success:", response.successful);
             console.log("Generated files:", response.generatedFiles ? response.generatedFiles.length : 0);
-            if (response.generatedFiles) {
-                for(const f of response.generatedFiles) {
-                    console.log(f.fileName);
-                }
-            }
             setGenerationResponse(response);
         }).catch(err => {
             console.error("Generation failed", err);
@@ -427,7 +423,7 @@ export function GenerateCodeView() {
     }
 
     if (generationResponse) {
-        return <GeneratorLogView response={generationResponse} onDismiss={() => setGenerationResponse(null)} />;
+        return <GeneratorLogView response={generationResponse} menuProject={project} onDismiss={() => setGenerationResponse(null)} />;
     }
 
     return (
diff --git a/web-designer/tcmenugen/src/generator/GeneratorLogView.tsx b/web-designer/tcmenugen/src/generator/GeneratorLogView.tsx
@@ -1,13 +1,16 @@
 import React from "react";
 import {GenerationResponse, LogEntry} from "./TcCodeGeneration";
 import "./GeneratorLogView.css";
+import {MenuTreeWithCodeOptions, RoundTripMode} from "../domain/ProjectStruct";
+import {filePatcher} from "./FilePatcher";
 
 export interface CodeGeneratedProperties {
     response: GenerationResponse;
     onDismiss: () => void;
+    menuProject: MenuTreeWithCodeOptions;
 }
 
-export const GeneratorLogView: React.FC<CodeGeneratedProperties> = ({response, onDismiss})  => {
+export const GeneratorLogView: React.FC<CodeGeneratedProperties> = ({response, onDismiss, menuProject})  => {
     const getLevelClass = (level: string) => {
         switch (level.toUpperCase()) {
             case 'ERROR': return 'log-level-error';
@@ -19,6 +22,15 @@ export const GeneratorLogView: React.FC<CodeGeneratedProperties> = ({response, o
         }
     };
 
+    async function onPatchFiles() {
+        try {
+            await filePatcher(response.generatedFiles, menuProject);
+            alert("All files patched successfully!");
+        } catch (error) {
+            alert("Failed to patch files: " + error);
+        }
+    }
+
     return (
         <div className="generator-log-container">
             <h3>We need your feedback on where to take things next!</h3>
@@ -41,6 +53,8 @@ export const GeneratorLogView: React.FC<CodeGeneratedProperties> = ({response, o
                             Download Zip
                         </a>
                     )}
+                    {response.successful && menuProject.roundTripMode === RoundTripMode.DIRECTORY_IN_BROWSER &&
+                    <button type="button" className="download-button" style={{fontSize: "100%"}} onClick={onPatchFiles}>Apply Directly</button>}
                     <button type="button" className="dismiss-button" onClick={onDismiss}>Dismiss</button>
                 </div>
             </div>
diff --git a/web-designer/tcmenugen/src/generator/TcCodeGeneration.ts b/web-designer/tcmenugen/src/generator/TcCodeGeneration.ts
@@ -139,9 +139,10 @@ export async function getActiveProfile(): Promise<string> {
     return "noenv";
 }
 
-function jsonifyGenerationRequest(project: MenuTreeWithCodeOptions, requiredFiles: GeneratedFile[]): string {
+function jsonifyGenerationRequest(project: MenuTreeWithCodeOptions, requiredFiles: GeneratedFile[], projectOverrideDir: string|null): string {
     return JSON.stringify({
         project: projectToPersistedJson(project),
+        projectOverrideDir: projectOverrideDir,
         existingProperties: project.options.lastProperties.map(p => ({
             name: p.name,
             subsystem: SubSystem[p.subsystem],
@@ -151,10 +152,12 @@ function jsonifyGenerationRequest(project: MenuTreeWithCodeOptions, requiredFile
     });
 }
 
-export async function runGenerateCode(request: MenuTreeWithCodeOptions, requiredFile: GeneratedFile[]): Promise<GenerationResponse> {
+export async function runGenerateCode(request: MenuTreeWithCodeOptions,
+                                      requiredFile: GeneratedFile[],
+                                      projectOverrideDir: string|null = null): Promise<GenerationResponse> {
     let req = await fetch("/api/v1/generator/generate", {
         method: "POST",  headers: {"Content-Type": "application/json", "Accept": "application/json"},
-        body: jsonifyGenerationRequest(request, requiredFile)
+        body: jsonifyGenerationRequest(request, requiredFile, projectOverrideDir)
     });
     if (!req.ok) {
         throw new Error(`Unable to generate code, status was ${req.status}`);

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@`
`14`	`14`	`@Data`
`15`	`15`	`public class GenerateCodeRequest {`
`16`	`16`	`private PersistedProject project;`
	`17`	`+ private String projectOverrideDir;`
`17`	`18`	`private List<CreatorProperty> existingProperties;`
`18`	`19`	`private List<GeneratedFile> requiredFiles;`
`19`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -20,13 +20,14 @@ public static GenerationResponse badResponse(List<LogEntry> logs) {`
`20`	`20`	`return new GenerationResponse(false, List.of(), logs, null);`
`21`	`21`	`}`
`22`	`22`
`23`		`- public static GenerationResponse okResponse(List<GeneratedFile> files, List<LogEntry> logs, UUID buildId) {`
`24`		`- return new GenerationResponse(true, sanitiseFilesInOutput(files), logs, buildId.toString());`
	`23`	`+ public static GenerationResponse okResponse(List<GeneratedFile> files, List<LogEntry> logs, UUID buildId, Path basePath) {`
	`24`	`+ return new GenerationResponse(true, sanitiseFilesInOutput(files, basePath), logs, buildId.toString());`
`25`	`25`	`}`
`26`	`26`
`27`		`- private static List<GeneratedFile> sanitiseFilesInOutput(List<GeneratedFile> files) {`
	`27`	`+ private static List<GeneratedFile> sanitiseFilesInOutput(List<GeneratedFile> files, Path basePath) {`
`28`	`28`	`return files.stream()`
`29`		`- .map(gf -> new GeneratedFile(Path.of(gf.getFileName()).getFileName().toString(), gf.getContent(), gf.isAlwaysOverwrite()))`
	`29`	`+ .map(gf -> new GeneratedFile(basePath.relativize(Path.of(gf.getFileName())).toString(),`
	`30`	`+ gf.getContent(), gf.isAlwaysOverwrite()))`
`30`	`31`	`.toList();`
`31`	`32`	`}`
`32`	`33`
Original file line number	Diff line number	Diff line change
`@@ -30,9 +30,9 @@ export function getDirectoryHandle(): FileSystemDirectoryHandle\|null {`
`30`	`30`	`return globalDirectoryHandle;`
`31`	`31`	`}`
`32`	`32`
`33`		`-export const findFileWithExtension = async (directoryHandle: any, ext1: string, ext2: string = "undef"): Promise<any \| null> => {`
	`33`	`+export const findFileWithExtension = async (directoryHandle: any, ext1: string, ext2: string = ".undef"): Promise<any \| null> => {`
`34`	`34`	`for await (const entry of directoryHandle.values()) {`
`35`		`- if (entry.kind === 'file' && (entry.name.endsWith('.' + ext1) \|\| entry.name.endsWith('.' + ext2))) {`
	`35`	`+ if (entry.kind === 'file' && (entry.name.endsWith(ext1) \|\| entry.name.endsWith(ext2))) {`
`36`	`36`	`return entry;`
`37`	`37`	`}`
`38`	`38`	`}`