Skip to content
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.

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

fix(core): system-independent relative path sorting for FILES output #19726

Merged
merged 1 commit into from
Oct 3, 2024

Conversation

joscha
Copy link
Contributor

@joscha joscha commented Sep 30, 2024

Fixes #19616 (comment)

The problem is that in the code previously, sorting was done on the platform-specific paths with the platform-specific separator. \ and / sort in different places, hence the order changes.

This pull request does not sort on the file objects, but on the relative, platform-independent path. I wasn't able to use org.apache.commons.io.comparator.PathFileComparator directly, as it expects a File object, but thankfully the implementation is trivial and we have lambdas :)

Tested on Windows here: #19616 (comment)

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

cc @macjohnny

}
});

Collections.sort(relativePaths, (a, b) -> IOCase.SENSITIVE.checkCompareTo(a,b));
Copy link
Contributor Author

Choose a reason for hiding this comment

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

sort the relative path strings, after they've been made platform-independent in

relativePath = relativePath.replace(File.separator, "/");

@macjohnny macjohnny requested a review from wing328 September 30, 2024 16:13
@joscha joscha changed the title fix(core): relative path sorting fix(core): relative path sorting for FILES output Oct 1, 2024
@joscha joscha changed the title fix(core): relative path sorting for FILES output fix(core): system-independent relative path sorting for FILES output Oct 1, 2024
@wing328
Copy link
Member

wing328 commented Oct 3, 2024

looks good to me

thanks for the PR

fyi @OpenAPITools/generator-core-team

@wing328 wing328 merged commit 0371799 into OpenAPITools:master Oct 3, 2024
15 checks passed
@wing328 wing328 added this to the 7.9.0 milestone Oct 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants