fix: make entity dump filename windows compatible #5145
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- windows doesn't allow colons (':') in filenames
- so far the filename included the timestamp in format YYYY-MM-DDTHH:MM:SS.MSZ, e.g. 2023-09-28T17:01:31.685172Z-entityDump.json
- now colons will be replaced by dashes ('-')
jdrueckert
added
Type: Bug
soloturn
reviewed
Oct 5, 2023
| @@ -479,7 +479,7 @@ public String dumpEntities(@CommandParam(value = "componentNames", required = fa | |||
| PrefabSerializer prefabSerializer = | |||
| new PrefabSerializer(engineEntityManager.getComponentLibrary(), engineEntityManager.getTypeSerializerLibrary()); | |||
| WorldDumper worldDumper = new WorldDumper(engineEntityManager, prefabSerializer); | |||
| Path outFile = PathManager.getInstance().getHomePath().resolve(Instant.now() + "-entityDump.json"); | |||
| Path outFile = PathManager.getInstance().getHomePath().resolve(Instant.now().toString().replaceAll(":", "-") + "-entityDump.json"); | |||
There was a problem hiding this comment.
would it not be cleaner to use the iso-8601 basic format in general, and not the extended format? see:
https://stackoverflow.com/questions/27725408/alternative-to-colon-in-a-time-format
BenjaminAmos
approved these changes
Oct 5, 2023
There was a problem hiding this comment.
I can confirm that using the dumpEntities commmand does not crash on Windows when testing this pull request.
Windows sometimes makes use of colons in file names for an obscure NTFS feature called file streams. Using that feature usually isn't what you'd want, since it makes the data invisible to most normal programs. There are other special filenames that you should't use but those are just obscure edge-cases that we're unlikely to run into.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Contains
How to test
dumpEntitiesOutstanding before merging
Fixes #5144