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

Base64 encode string literals in JsonFormatter #2261

Merged
merged 3 commits into from
Oct 7, 2023

Conversation

badeball
Copy link
Member

@badeball badeball commented Mar 20, 2023

🤔 What's changed?

This fixes #2260.

This ensures that all embeddings in JSON reports are base64-encoded. This is also how cucumber-json-formatter interprets IDENTITY strings.

⚡️ What's your motivation?

In the JSON output, it's currently impossible to differentiate between strings that were attached as literals vs. those that were base64-encoded to begin with.

🏷️ What kind of change is this?

  • 🐛 Bug fix (non-breaking change which fixes a defect)

📋 Checklist:

  • I agree to respect and uphold the Cucumber Community Code of Conduct
  • I've changed the behaviour of the code
    • I have added/updated tests to cover my changes.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.
  • Users should know about my change
    • I have added an entry to the "Unreleased" section of the CHANGELOG, linking to this pull request.

This text was originally generated from a template, then edited by hand. You can modify the template here.

@coveralls
Copy link

coveralls commented Mar 20, 2023

Coverage Status

coverage: 98.474%. remained the same when pulling ee9a1b8 on base64-encode-literals into 188d644 on main.

@davidjgoss davidjgoss added the 💔 breaking change This will require a major release label Mar 25, 2023
@davidjgoss davidjgoss added this to the 10.0.0 milestone Mar 25, 2023
@davidjgoss davidjgoss merged commit 26431b1 into main Oct 7, 2023
6 checks passed
@davidjgoss davidjgoss deleted the base64-encode-literals branch October 7, 2023 17:12
badeball added a commit to badeball/cypress-cucumber-preprocessor that referenced this pull request Nov 2, 2023
This in particular contains a fix for attachments [1].

[1] cucumber/cucumber-js#2261
badeball added a commit to badeball/cypress-cucumber-preprocessor that referenced this pull request Nov 2, 2023
* Nearly all, except some packages that have migrated to ESM and are
  more diffult to update, in addition to prettier, for which the
  associated extension remains behind [1]

This in particular contains a fix for attachments [2].

[1] prettier/prettier-vscode@ad1d008
[2] cucumber/cucumber-js#2261
badeball added a commit to badeball/cypress-cucumber-preprocessor that referenced this pull request Nov 2, 2023
* Nearly all, except some packages that have migrated to ESM and are
  more diffult to update, in addition to prettier, for which the
  associated extension remains behind [1].

This in particular contains a fix for attachments [2].

[1] prettier/prettier-vscode@ad1d008
[2] cucumber/cucumber-js#2261
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💔 breaking change This will require a major release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing content encoding for attachments in JSON reports
3 participants