inferno-framework / inferno-core

Core library for the Inferno Framework
https://inferno-framework.github.io/
Apache License 2.0
26 stars 5 forks source link

Remove ReactMarkdown in Inputs/Outputs #504

Closed jhlee-mitre closed 4 months ago

jhlee-mitre commented 5 months ago

Summary

Original issue: https://github.com/inferno-framework/bulk-data-test-kit/issues/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
codecov[bot] commented 5 months ago

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 :warning:
Additional details and impacted files ```diff @@ 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](https://app.codecov.io/gh/inferno-framework/inferno-core/pull/504/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=inferno-framework) | Coverage Δ | | |---|---|---| | [backend](https://app.codecov.io/gh/inferno-framework/inferno-core/pull/504/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=inferno-framework) | `91.26% <ø> (ø)` | | | [frontend](https://app.codecov.io/gh/inferno-framework/inferno-core/pull/504/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=inferno-framework) | `73.98% <50.00%> (-0.01%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=inferno-framework#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

jhlee-mitre commented 4 months ago

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 commented 4 months ago

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!