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

Jbl/1020721 preserve order in attachmentsdirectory #68

Merged

Conversation

ptahmose
Copy link
Contributor

@ptahmose ptahmose commented Oct 12, 2023

Description

The order of the items in the attachment-directory used to be undefined (when writing a CZI with libCZI). As far as I can tell, this is fine and the order is not relevant by any means (as per file-format). However, it turned out, that some applications made (unjustified!) assumptions about this order.
With the changes in this PR, the order in the attachments-directory will retain the order in which they were added. This allows to work around the flaw in other applications.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

locally

Checklist:

  • I followed the Contributing Guidelines.
  • I did a self-review.
  • I commented my code, particularly in hard-to-understand areas.
  • I updated the documentation.
  • I updated the version of libCZI following Versioning of libCZI depending on the type of change
    • Bug fix -> PATCH
    • New feature -> MINOR
    • Breaking change -> MAJOR
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.

@ptahmose ptahmose requested review from soyers and FelixS90 October 12, 2023 14:01
@ptahmose ptahmose added the cla Contributor License Agreement sent to Admin label Oct 12, 2023
@codecov
Copy link

codecov bot commented Oct 12, 2023

Codecov Report

Merging #68 (9db4052) into main (3581f6b) will increase coverage by 0.08%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main      #68      +/-   ##
==========================================
+ Coverage   63.90%   63.98%   +0.08%     
==========================================
  Files          75       75              
  Lines       10117    10085      -32     
==========================================
- Hits         6465     6453      -12     
+ Misses       3652     3632      -20     
Flag Coverage Δ
windows-latest 63.98% <100.00%> (+0.08%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
Src/libCZI/CziAttachmentsDirectory.cpp 83.67% <100.00%> (+10.16%) ⬆️
Src/libCZI/CziAttachmentsDirectory.h 100.00% <ø> (ø)
Src/libCZI/CziWriter.cpp 84.88% <ø> (ø)

... and 2 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@ptahmose ptahmose marked this pull request as ready for review October 16, 2023 08:56
@ptahmose ptahmose requested a review from chriwiz October 19, 2023 22:27
@ptahmose ptahmose merged commit 31bf4cc into ZEISS:main Oct 20, 2023
15 checks passed
@ptahmose ptahmose deleted the jbl/1020721-preserve_order_in_attachmentsdirectory branch November 3, 2023 22:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla Contributor License Agreement sent to Admin
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants