SSR benchmark script #1555

wyattades · 2023-07-15T18:43:53Z

Summary

Add some instructions and a script to perform performance benchmarking on some server-side-rendering routes. The goal is to test the performance of different ExecJS runtimes in a real react_on_rails application.

Things to-do before merging. I'd appreciate some guidance to get them working:

fix the nodejs runtime
fix hitting the React routes on the dummy app

Anecdotal results:

I ran this against a route on my app with very expensive React SSR.
This is the total roundtrip duration of the request, so it also includes some database IO.
Device: M1 Macbook Pro 2021

alaska:
- first call: 800ms
- subsequent calls: 62ms
nodejs 18:
- first call: 600ms
- subsequent calls: 300ms
mini_racer:
- first call: 260ms
- subsequent calls: 70ms

Pull Request checklist

Add/update test to cover these changes
Update documentation
Update CHANGELOG file
Add the CHANGELOG entry at the top of the file.

Other Information

This change is

wyattades · 2023-07-15T21:20:29Z

Gemfile.development_dependencies

@@ -2,7 +2,7 @@

 gem "shakapacker", "6.5.1"
 gem "bootsnap", require: false
-gem "rails", "~> 7.0"
+gem "rails", "~> 7.0", ">= 7.0.1"


for compatibility with Ruby 3.2.1

justin808 · 2023-07-17T08:34:05Z

spec/dummy/package.json

@@ -24,6 +24,7 @@
    "css-minimizer-webpack-plugin": "^3.1.3",
    "eslint-plugin-prettier": "^3.1.0",
    "expose-loader": "^1.0.3",
+    "fast-text-encoding": "^1.0.6",


what does this have to do with SSR?

justin808 · 2023-07-17T08:34:09Z

spec/dummy/package.json

@@ -51,6 +52,7 @@
    "sass-loader": "^12.3.0",
    "sass-resources-loader": "^2.1.0",
    "shakapacker": "6.5.1",
+    "stream-browserify": "^3.0.0",


what does this have to do with SSR?

justin808 · 2023-07-17T08:34:44Z

spec/dummy/config/webpack/serverWebpackConfig.js

@@ -109,6 +111,31 @@ const configureServer = () => {
  // If using the React on Rails Pro node server renderer, uncomment the next line
  // serverWebpackConfig.target = 'node'

+  // MiniRacer specific config
+  if (process.env.EXECJS_RUNTIME === 'MiniRacer') {


Where did you get these from?

Miniracer needs a couple polyfills for some Node.js modules that are used in React 18 SSR. Here's my original post:
#1457 (comment)
AFAIK this isn't documented anywhere

justin808 · 2023-07-17T08:35:45Z

@wyattades Ping me on Slack. I'd like you to test out https://www.shakacode.com/react-on-rails-pro/ vs execjs.

Here's an invite

wyattades · 2023-07-24T15:27:10Z

spec/dummy/bin/benchmark

+run_benchmarks Alaska /render_js
+
+# FIXME: all others SSR endpoints are broken with this setup
+#   e.g. Hitting /server_side_hello_world gives error: "ActionView::Template::Error (Shakapacker can't find generated/HelloWorld.js in manifest.json"


Here are the 2 FIXMEs ^ that I can't figure out. I'm unfamiliar with the generated/* files, can someone give me some advice here?

That's if you're using the auto bundles, so that you just use react_component and the bundle is included on the page automatically

https://github.com/shakacode/react_on_rails/blob/master/docs/guides/file-system-based-automated-bundle-generation.md

How do I enable the generated routes on the dummy app?

@wyattades you'l want to run bundle exec rake react_on_rails:generate_packs as part of the setup.

wyattades · 2023-07-24T15:28:07Z

spec/dummy/config/webpack/serverWebpackConfig.js

@@ -109,6 +111,31 @@ const configureServer = () => {
  // If using the React on Rails Pro node server renderer, uncomment the next line
  // serverWebpackConfig.target = 'node'

+  // MiniRacer specific config
+  if (process.env.EXECJS_RUNTIME === 'MiniRacer') {


Suggested change

if (process.env.EXECJS_RUNTIME === 'MiniRacer') {

if (process.env.MANUAL_EXECJS_RUNTIME === 'MiniRacer') {

I have no idea what this change is about.

See:
https://github.com/search?q=repo%3Arails%2Fexecjs%20EXECJS_RUNTIME&type=code

I explained this webpack code in the github comment above:

Miniracer needs a couple polyfills for some Node.js modules that are used in React 18 SSR

Also, EXECJS_RUNTIME doesn't work (we're using some different name, MANUAL_EXECJS_RUNTIME) because it breaks when trying to autoload the Alaska gem

justin808 · 2023-07-25T08:06:10Z

@wyattades what's left? you have this PR as draft.

Judahmeek · 2023-08-18T01:47:35Z

spec/dummy/bin/benchmark

+
+echo "Benchmarking server-side rendering..."
+
+# run_benchmarks Node /render_js # FIXME: Node runtime is broken with this setup, it stalls infinitely.


Weird.

Because if you uninstall MiniRacer, then ExecJS should use NodeJS by default & that seems to work correctly.

justin808 · 2023-11-17T00:57:23Z

@Judahmeek @ahangarha any good reason this was NEVER FINISHED?

justin808 · 2024-06-25T02:55:02Z

@AbanoubGhadban @Judahmeek should we close?

justin808 · 2024-08-21T00:12:30Z

@alexeyr-ci1 @alexeyr-ci Please advise on the next step for this:

Update and merge?
Close?
What else?

alexeyr-ci · 2024-10-27T17:42:43Z

@justin808

Please advise on the next step for this:

In my opinion:

this particular PR should be closed;
we should have a benchmark script
1. without adding new runtimes, but ideally so it can easily be applied to them in a branch/fork or in RoRP.
2. use a tool like Hey or K6 (we'll need HTTP/2 support) instead of doing it manually https://grafana.com/blog/2020/03/03/open-source-load-testing-tool-review/#scriptable-tools-vs-non-scriptable-ones

justin808 · 2024-11-21T00:25:22Z

@alexeyr-ci close this after opening issues for your suggestions.

coderabbitai · 2024-11-21T00:25:37Z

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

alexeyr-ci · 2024-11-21T12:30:04Z

The new issue: #1658.

SSR benchmark script

f933381

wyattades force-pushed the wa/ssr-benchmark-script branch from 4e654ba to f933381 Compare July 15, 2023 18:49

wyattades mentioned this pull request Jul 15, 2023

remove extra js eval call #1544

Merged

3 tasks

wyattades commented Jul 15, 2023

View reviewed changes

justin808 reviewed Jul 17, 2023

View reviewed changes

wyattades commented Jul 24, 2023

View reviewed changes

Judahmeek reviewed Aug 18, 2023

View reviewed changes

justin808 added the wontfix label Nov 21, 2024

alexeyr-ci mentioned this pull request Nov 21, 2024

Create load tests and add them to CI #1658

Open

alexeyr-ci closed this Nov 21, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SSR benchmark script #1555

SSR benchmark script #1555

wyattades commented Jul 15, 2023 •

edited

Loading

wyattades Jul 15, 2023

justin808 Jul 17, 2023

justin808 Jul 17, 2023

justin808 Jul 17, 2023

wyattades Jul 24, 2023

justin808 commented Jul 17, 2023 •

edited

Loading

wyattades Jul 24, 2023

justin808 Jul 25, 2023

wyattades Jul 25, 2023 •

edited

Loading

Judahmeek Aug 18, 2023

wyattades Jul 24, 2023

justin808 Jul 25, 2023

wyattades Jul 25, 2023

justin808 commented Jul 25, 2023

Judahmeek Aug 18, 2023

justin808 commented Nov 17, 2023

justin808 commented Jun 25, 2024

justin808 commented Aug 21, 2024

alexeyr-ci commented Oct 27, 2024

justin808 commented Nov 21, 2024

coderabbitai bot commented Nov 21, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

alexeyr-ci commented Nov 21, 2024

	if (process.env.EXECJS_RUNTIME === 'MiniRacer') {
	if (process.env.MANUAL_EXECJS_RUNTIME === 'MiniRacer') {


		echo "Benchmarking server-side rendering..."

		# run_benchmarks Node /render_js # FIXME: Node runtime is broken with this setup, it stalls infinitely.

SSR benchmark script #1555

SSR benchmark script #1555

Conversation

wyattades commented Jul 15, 2023 • edited Loading

Summary

Anecdotal results:

Pull Request checklist

Other Information

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

justin808 commented Jul 17, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wyattades Jul 25, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

justin808 commented Jul 25, 2023

Choose a reason for hiding this comment

justin808 commented Nov 17, 2023

justin808 commented Jun 25, 2024

justin808 commented Aug 21, 2024

alexeyr-ci commented Oct 27, 2024

justin808 commented Nov 21, 2024

coderabbitai bot commented Nov 21, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

alexeyr-ci commented Nov 21, 2024

wyattades commented Jul 15, 2023 •

edited

Loading

justin808 commented Jul 17, 2023 •

edited

Loading

wyattades Jul 25, 2023 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)