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

Remove ReactMarkdown in Inputs/Outputs #504

Merged
merged 3 commits into from
Jun 24, 2024
Merged

Conversation

jhlee-mitre
Copy link
Contributor

@jhlee-mitre jhlee-mitre commented Jun 14, 2024

Summary

Original issue: inferno-framework/bulk-data-test-kit#24

Problem: contents in Inputs and Outputs are converted to markdown. Though it's useful for styles, can cause problems when strings like URLs are broken by that.

Fix: removed React Markdown in the HTML.

Testing Guidance

  1. Run Inferno core
  2. Try markdown contents in entry (e.g. bearer_token: ~~SAMPLE_TOKEN~~)
  3. In the results, contents SHOULD NOT be converted into markdown.

Consideration

react-markdown is being used as below. Further investigation needs to figure out whether markdown is being used unnecessarily.

Screenshot 2024-06-21 at 2 00 08 PM

Copy link

codecov bot commented Jun 14, 2024

Codecov Report

Attention: Patch coverage is 50.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 79.46%. Comparing base (3a489d0) to head (c8cb6f8).

Files Patch % Lines
.../TestSuiteDetails/TestListItem/InputOutputList.tsx 50.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #504      +/-   ##
==========================================
- Coverage   79.47%   79.46%   -0.01%     
==========================================
  Files         242      242              
  Lines       12080    12078       -2     
  Branches     1185     1185              
==========================================
- Hits         9600     9598       -2     
  Misses       1815     1815              
  Partials      665      665              
Flag Coverage Δ
backend 91.26% <ø> (ø)
frontend 73.98% <50.00%> (-0.01%) ⬇️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jhlee-mitre jhlee-mitre marked this pull request as ready for review June 21, 2024 18:36
Copy link
Collaborator

@AlyssaWang AlyssaWang left a comment

Choose a reason for hiding this comment

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

Looks good, I would probably also double check the other instances of ReactMarkdown to see if they're also running into this issue and address accordingly but this is mergeable now.

LGTM

@jhlee-mitre
Copy link
Contributor Author

Looks good, I would probably also double check the other instances of ReactMarkdown to see if they're also running into this issue and address accordingly but this is mergeable now.

LGTM

Thanks. A newbie question; I assigned three reviewers, should all of the three approve, or one approval out of three is good to merge?

@AlyssaWang
Copy link
Collaborator

Thanks. A newbie question; I assigned three reviewers, should all of the three approve, or one approval out of three is good to merge?

One is usually sufficient unless there is a reason to want approval from specific people!

@jhlee-mitre jhlee-mitre merged commit c897fb5 into main Jun 24, 2024
9 of 10 checks passed
@rpassas rpassas mentioned this pull request Jun 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Inferno renders bulk download links poorly
2 participants