-
-
Notifications
You must be signed in to change notification settings - Fork 921
feat(XMarkdown): streaming markdown benchmark #1314
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
base: feature
Are you sure you want to change the base?
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Summary of ChangesHello @Div627, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces a new, standardized performance benchmark for streaming Markdown rendering. It utilizes Playwright Component Testing to automate the measurement of various Markdown libraries, including Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces a comprehensive performance benchmark for streaming Markdown rendering using Playwright, which is a valuable addition for evaluating and comparing different rendering libraries. The overall implementation is solid. My review focuses on improving code quality, maintainability, and the robustness of the testing setup. I've included suggestions for using proper TypeScript types, avoiding hardcoded values, ensuring test failures are correctly reported, and optimizing component rendering logic within the benchmark.
packages/x-markdown/src/XMarkdown/__benchmark__/components/MarkdownRenderer.tsx
Show resolved
Hide resolved
packages/x-markdown/src/XMarkdown/__benchmark__/tests/performance.spec.tsx
Show resolved
Hide resolved
packages/x-markdown/src/XMarkdown/__benchmark__/tests/performance.spec.tsx
Show resolved
Hide resolved
|
|
||
| await page.context().tracing.start({ | ||
| screenshots: true, | ||
| title: `XMarkdown_Stream_Perf_${browserName}`, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The trace title is not unique per renderer. When running multiple benchmark tests, this can make it harder to distinguish between traces. Including the renderer name in the title will make each trace uniquely identifiable.
| title: `XMarkdown_Stream_Perf_${browserName}`, | |
| title: `XMarkdown_Stream_Perf_${name}_${browserName}`, |
Bundle ReportChanges will increase total bundle size by 1.21MB (35.83%) ⬆️
Affected Assets, Files, and Routes:view changes for bundle: antdx-array-pushAssets Changed:
|
size-limit report 📦
|
Deploying ant-design-x with
|
| Latest commit: |
c450fbe
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://31ae82be.ant-design-x.pages.dev |
| Branch Preview URL: | https://feature-markdown-benchmark.ant-design-x.pages.dev |
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## feature #1314 +/- ##
===========================================
- Coverage 94.54% 89.50% -5.05%
===========================================
Files 136 140 +4
Lines 3816 4031 +215
Branches 1085 1135 +50
===========================================
Hits 3608 3608
- Misses 205 420 +215
Partials 3 3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|

中文版模板 / Chinese template
🤔 This is a ...
🔗 Related Issues
This PR implements the benchmark proposed in the RFC:
💡 Background and Solution
📝 Change Log