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

[24.0] Fix history export with missing dataset hids #18052

Conversation

davelopez
Copy link
Contributor

@davelopez davelopez commented Apr 25, 2024

Fixes #18032

Replaces the dataset hid with the encoded_id for generating filenames.

How to test the changes?

  • I've included appropriate automated tests.
  • This is a refactoring of components with existing test coverage.
  • Instructions for manual testing are as follows:
    1. [add testing steps and prerequisites here if you didn't write automated tests covering all your changes]

License

  • I agree to license these and all my past contributions to the core galaxy codebase under the MIT license.

@davelopez davelopez added this to the 24.0 milestone Apr 25, 2024
@davelopez davelopez marked this pull request as ready for review April 25, 2024 10:50
@davelopez
Copy link
Contributor Author

The rest of the test failures seem unrelated.

Copy link
Member

@dannon dannon left a comment

Choose a reason for hiding this comment

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

I think this is good as-is, and inspected archives before and after and they look good to me.

I think for consistency it probably makes sense to do it across the board as you have done it here, but to toss it out for consideration -- did you think about continuing to use the hid primarily, only utilizing encoded_id when there isn't one? Is there any utility retained there in being able to see the expected ordering by hid at a glance in the filenames?

@davelopez
Copy link
Contributor Author

did you think about continuing to use the hid primarily, only utilizing encoded_id when there isn't one? Is there any utility retained there in being able to see the expected ordering by hid at a glance in the filenames?

That is a good point. I didn't think about it when I made the change. But it felt (to me) like the hid was more a way of making sure there were no collisions when writing the files.

If you open/extract the archive to inspect the contents I don't know how useful it is to know in which order they were created unless all the files have a similar name and in that case it would probably help to have the hid as prefix and not as suffix so you can sort by name 🤔 But I'm not a Galaxy user, so I don't know how valuable is that 😅

I slightly prefer the consistency too, but I'm happy to leave it with the hid and fallback to the encoded_id if it is missing. Should I?

@dannon
Copy link
Member

dannon commented Apr 26, 2024

@davelopez Well, since both of us have the slight preference for consistency, let's stick with that! :) I just wanted to make sure it was considered.

@mvdbeek mvdbeek requested a review from jmchilton April 29, 2024 14:04
@jdavcs jdavcs merged commit 7d1da18 into galaxyproject:release_24.0 Apr 29, 2024
52 of 54 checks passed
@davelopez davelopez deleted the 24.0_fix_missing_hid_history_export branch April 29, 2024 21:43
@bernt-matthias
Copy link
Contributor

One more question here. My instance is on 23.2. Do you think that it's a good idea to use these commits on my instance if I want to archive histories?

@davelopez
Copy link
Contributor Author

I guess we can backport this to 23.2. I will open a PR.

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.

5 participants