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

refactor: remove markdown builder #461

Merged
merged 4 commits into from
Feb 21, 2024

Conversation

mdjastrzebski
Copy link
Member

Summary

Replaces unmaintained markdown-builder with internal helper functions.

Resolves: #451.

Test plan

Copy link

changeset-bot bot commented Feb 21, 2024

🦋 Changeset detected

Latest commit: f6c7d9c

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages
Name Type
@callstack/reassure-compare Patch
@callstack/reassure-cli Patch
reassure Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Contributor

github-actions bot commented Feb 21, 2024

Performance Comparison Report

  • Current: 31908ba - 2024-02-21 15:05:59Z
  • Baseline: main (3258abb) - 2024-02-21 15:05:08Z

Significant Changes To Duration

Name Type Duration Count
fib 32 function 234.9 ms → 244.2 ms (+9.3 ms, +3.9%) 1 → 1
fib 30 function 87.2 ms → 92.4 ms (+5.2 ms, +6.0%) 🔴 1 → 1
Other Component 20 render 118.4 ms → 122.8 ms (+4.4 ms, +3.8%) 4 → 4
Other Component 10 legacy scenario render 119.5 ms → 123.8 ms (+4.3 ms, +3.6%) 4 → 4
fib 31 function 160.4 ms → 151.6 ms (-8.9 ms, -5.5%) 🟢 1 → 1
Show details
Name Type Duration Count
fib 32 function Baseline
Mean: 234.9 ms
Stdev: 6.3 ms (2.7%)
Runs: 244.4 243.4 238.3 238.2 235.7 233.9 231.5 230.5 227.3 226.0

Current
Mean: 244.2 ms
Stdev: 2.6 ms (1.1%)
Runs: 251.6 244.0 243.7 243.7 243.7 243.2 243.2 243.1 243.0 242.8
Baseline
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1

Current
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1
fib 30 function Baseline
Mean: 87.2 ms
Stdev: 0.7 ms (0.9%)
Runs: 88.6 88.3 87.6 87.3 86.8 86.8 86.7 86.6 86.6 86.5

Current
Mean: 92.4 ms
Stdev: 1.2 ms (1.3%)
Runs: 95.3 93.0 92.9 92.4 92.0 92.0 91.8 91.7 91.4 91.3
Baseline
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1

Current
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1
Other Component 20 render Baseline
Mean: 118.4 ms
Stdev: 7.3 ms (6.2%)
Runs: 133 129 127 126 122 121 121 121 120 120 119 118 117 116 115 110 110 110 109 104

Current
Mean: 122.8 ms
Stdev: 8.6 ms (7.0%)
Runs: 146 142 129 129 125 125 124 123 122 121 120 120 120 120 117 117 116 114 114 113
Baseline
Mean: 4
Stdev: 0 (0.0%)
Runs: 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4

Current
Mean: 4
Stdev: 0 (0.0%)
Runs: 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4 4
Other Component 10 legacy scenario render Baseline
Mean: 119.5 ms
Stdev: 4.2 ms (3.5%)
Runs: 126 123 121 120 120 120 120 118 117 110

Current
Mean: 123.8 ms
Stdev: 4.3 ms (3.4%)
Runs: 133 128 125 125 124 122 122 120 120 119
Baseline
Mean: 4
Stdev: 0 (0.0%)
Runs: 4 4 4 4 4 4 4 4 4 4

Current
Mean: 4
Stdev: 0 (0.0%)
Runs: 4 4 4 4 4 4 4 4 4 4
fib 31 function Baseline
Mean: 160.4 ms
Stdev: 2.5 ms (1.6%)
Runs: 162.5 162.5 162.1 162.1 162.1 162.0 160.8 157.1 156.8 156.7

Current
Mean: 151.6 ms
Stdev: 0.4 ms (0.3%)
Runs: 152.3 152.0 151.9 151.7 151.5 151.5 151.4 151.2 151.1 150.9
Baseline
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1

Current
Mean: 1
Stdev: 0 (0.0%)
Runs: 1 1 1 1 1 1 1 1 1 1

Meaningless Changes To Duration

Show entries
Name Type Duration Count
Async Component render 196.3 ms → 198.8 ms (+2.5 ms, +1.3%) 7 → 7
Other Component 10 render 119.8 ms → 123.5 ms (+3.7 ms, +3.1%) 4 → 4
Show details
Name Type Duration Count
Async Component render Baseline
Mean: 196.3 ms
Stdev: 4.3 ms (2.2%)
Runs: 203 201 201 198 197 194 194 193 191 191

Current
Mean: 198.8 ms
Stdev: 8.8 ms (4.4%)
Runs: 210 208 205 202 202 200 196 196 186 183
Baseline
Mean: 7
Stdev: 0 (0.0%)
Runs: 7 7 7 7 7 7 7 7 7 7

Current
Mean: 7
Stdev: 0 (0.0%)
Runs: 7 7 7 7 7 7 7 7 7 7
Other Component 10 render Baseline
Mean: 119.8 ms
Stdev: 7.2 ms (6.0%)
Runs: 129 128 127 123 122 118 116 116 111 108

Current
Mean: 123.5 ms
Stdev: 3.8 ms (3.1%)
Runs: 128 127 126 126 125 123 122 122 121 115
Baseline
Mean: 4
Stdev: 0 (0.0%)
Runs: 4 4 4 4 4 4 4 4 4 4

Current
Mean: 4
Stdev: 0 (0.0%)
Runs: 4 4 4 4 4 4 4 4 4 4

Changes To Count

There are no entries

Added Scenarios

There are no entries

Removed Scenarios

There are no entries

Generated by 🚫 dangerJS against f6c7d9c

@mdjastrzebski mdjastrzebski merged commit bb2046a into main Feb 21, 2024
2 checks passed
@mdjastrzebski mdjastrzebski deleted the refactor/remove-markdown-builder branch February 21, 2024 15:09
Comment on lines +1 to +11
export function header1(text: string) {
return `# ${text}\n`;
}

export function header2(text: string) {
return `## ${text}\n`;
}

export function header3(text: string) {
return `### ${text}\n`;
}
Copy link

Choose a reason for hiding this comment

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

These seem to rely on the result being prefixed with a newline. Fortunately that appears to be the case everywhere it's currently used, but that probably at least deserves a comment if not a more robust implementation.

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.

[Improvement] replace the unmaintained markdown-builder package
2 participants