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

Add UUID to the ScubaResults.json file name #600

Open
5 tasks
adhilto opened this issue Feb 13, 2025 · 1 comment
Open
5 tasks

Add UUID to the ScubaResults.json file name #600

adhilto opened this issue Feb 13, 2025 · 1 comment
Milestone

Comments

@adhilto
Copy link
Collaborator

adhilto commented Feb 13, 2025

💡 Summary

Add UUID to the ScubaResults.json file name, as is done on ScubaGear.

Motivation and context

  • Consistency with ScubaGear
  • To ensure each ScubaResults.json has a unique file name.

Implementation notes

Unfortunately, this isn't as straightforward as it could be.

  • By default, only the first 18 characters of the UUID should be included in the file name. For example: ScubaResults_334a2e69-e073-42ad.json.
  • The number of characters included in the file name should be configurable. On ScubaGear, there is a "NumberOfUUIDCharactersToTruncate" parameter, which defaults to 18, but accepts the following values:

Image

  • Care will need to be taken to avoid breaking "cached mode" (see ScubaGoggles parameters runcached and skipexport).
  • The smoke test will need to be modified to account for this change, including but not limited to:
    results_path = output_path / f'{default_file_names.json_output_name}.json'
  • Documentation will need to be updated giving the info users will need, such as what the new parameter does and what they can expect their output file to be named.

Acceptance criteria

  • Truncated UUID is included in the ScubaResults*.json file name
  • The number of characters to truncate is configurable
  • Cached mode still works
  • Smoke test still passes
  • Documentation has been updated to reflect the change
@adhilto adhilto added this to the Eel milestone Feb 13, 2025
@adhilto
Copy link
Collaborator Author

adhilto commented Feb 13, 2025

Wait until #575 is merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant