Skip to content

docs(generator): log file path collision warnings with detailed message #24951

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wing328 merged 1 commit into from
Sep 17, 2026
+7 −1
Merged

docs(generator): log file path collision warnings with detailed message #24951

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,10 @@

@SuppressWarnings("rawtypes")
public class DefaultGenerator implements Generator {
private static final String FILE_PATH_COLLISION_LOG = "FILEPATH_COLLISION";
private static final String FILE_PATH_COLLISION_LOG_MESSAGE =
FILE_PATH_COLLISION_LOG + ": File path collision detected. Files may be overwritten by later-processed collisions. " +
"Use 'modelNameMappings' or another name mapping to resolve file name collisions.";
private static final String METADATA_DIR = ".openapi-generator";
protected final Logger LOGGER = LoggerFactory.getLogger(DefaultGenerator.class);
private final boolean dryRun;
Expand Down Expand Up @@ -1461,7 +1465,9 @@ private File processTemplateToFile(Map<String, Object> templateData, String temp

// O(1) case-insensitive duplicate check via a pre-lowercased shadow set
if (!seenFilesLower.add(absoluteTarget.toString().toLowerCase(Locale.ROOT))) {
LOGGER.warn("Duplicate file path detected. Not all operating systems can handle case sensitive file paths. path={}", absoluteTarget);
once(LOGGER).warn(FILE_PATH_COLLISION_LOG_MESSAGE);

@cubic-dev-ai cubic-dev-ai Bot Sep 15, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2: Using once() to emit the single primary warning does not reliably produce one warning per run. OnceLogger's cache is JVM-global and expires after 2 seconds (default), so in a generation that runs longer than 2s the primary message is re-emitted whenever a new collision appears, and in a JVM that runs several generators it is suppressed entirely after the first one while every later collision still logs 'see log FILEPATH_COLLISION' pointing at a primary that may not be present. Consider replacing once() with an instance-level flag so the primary is emitted exactly once per DefaultGenerator run.

Prompt for AI agents 
Check if this issue is valid — if so, understand the root cause and fix it. At modules/openapi-generator/src/main/java/org/openapitools/codegen/DefaultGenerator.java, line 1468:

<comment>Using `once()` to emit the single primary warning does not reliably produce one warning per run. OnceLogger's cache is JVM-global and expires after 2 seconds (default), so in a generation that runs longer than 2s the primary message is re-emitted whenever a new collision appears, and in a JVM that runs several generators it is suppressed entirely after the first one while every later collision still logs 'see log FILEPATH_COLLISION' pointing at a primary that may not be present. Consider replacing `once()` with an instance-level flag so the primary is emitted exactly once per DefaultGenerator run.</comment>

<file context>
@@ -1461,7 +1465,9 @@ private File processTemplateToFile(Map<String, Object> templateData, String temp
                 // O(1) case-insensitive duplicate check via a pre-lowercased shadow set
                 if (!seenFilesLower.add(absoluteTarget.toString().toLowerCase(Locale.ROOT))) {
-                    LOGGER.warn("Duplicate file path detected. Not all operating systems can handle case sensitive file paths. path={}", absoluteTarget);
+                    once(LOGGER).warn(FILE_PATH_COLLISION_LOG_MESSAGE);
+                    LOGGER.warn("Duplicate file path detected. Not all operating systems can handle case sensitive file paths, see log '{}' for more information. path={}",
+                            FILE_PATH_COLLISION_LOG, absoluteTarget);
</file context>

@Mattias-Sehlstedt Mattias-Sehlstedt Sep 15, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The once() call is currently the preferred way of forwarding information to the client in a less noisy way. Having it bound to an instance-level flag comes with its own flaws, and leaves us to reason about whether the Generator should become stateful and to what degree processTemplateToFile is to be invoked.

Having it tied to once() is better currently in my opinion, and an accidental omission of FILEPATH_COLLISION in uniquely executed workflows is still a better pointer than nothing.

LOGGER.warn("Duplicate file path detected. Not all operating systems can handle case sensitive file paths, see log '{}' for more information. path={}",
FILE_PATH_COLLISION_LOG, absoluteTarget);
}
return this.templateProcessor.write(templateData, templateName, target);
} else {
Expand Down
Loading