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

chore(tasks): Benchmark tests #8578

Merged
merged 11 commits into from
Sep 7, 2023
Merged

Conversation

Josh-Walker-GM
Copy link
Collaborator

@Josh-Walker-GM Josh-Walker-GM commented Jun 9, 2023

Adds yarn benchmark which runs a series of k6 tests against the api server (api serve).

This local tool should make it easier to catch failures or bad performance which show only when under load. If you've refactored api side code then you can run this task against main and then against your branch to check for any obvious performance or correctness regressions.

This essentially does the following:

  • Creates a new temp. redwood project like e2e testing
  • Sets up a specific state of the project as defined by various setup scripts
  • Runs a series of k6 tests in those specifically setup environments

What this doesn't do:

  • Handle testing different serving both dev, serve, etc.

Ideally in the future this can be adapted for use in CI too so that PR's are automatically tested. This will also allow us to identify trends in performance.

@Josh-Walker-GM Josh-Walker-GM added the release:chore This PR is a chore (means nothing for users) label Jun 9, 2023
@Josh-Walker-GM Josh-Walker-GM added this to the chore milestone Aug 14, 2023
@Josh-Walker-GM Josh-Walker-GM marked this pull request as ready for review August 30, 2023 23:49
@Josh-Walker-GM
Copy link
Collaborator Author

@dthyresson Let me know if this roughly matched what you thought it would be. Definitely local tool only for the time being but it can become something that can work in CI too in the future.

Copy link
Contributor

@dthyresson dthyresson left a comment

Choose a reason for hiding this comment

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

LGTM. Next steps are to work with @jtoar or others and consider how to run in CI.

@Josh-Walker-GM Josh-Walker-GM enabled auto-merge (squash) September 7, 2023 14:12
@Josh-Walker-GM Josh-Walker-GM merged commit 6340990 into main Sep 7, 2023
29 checks passed
@Josh-Walker-GM Josh-Walker-GM deleted the jgmw-tasks/benchmark-test branch September 7, 2023 15:13
jtoar pushed a commit that referenced this pull request Nov 2, 2023
Adds `yarn benchmark` which runs a series of k6 tests against the api
server (api serve).

This local tool should make it easier to catch failures or bad
performance which show only when under load. If you've refactored api
side code then you can run this task against main and then against your
branch to check for any obvious performance or correctness regressions.

This essentially does the following:
* Creates a new temp. redwood project like e2e testing
* Sets up a specific state of the project as defined by various setup
scripts
* Runs a series of k6 tests in those specifically setup environments

What this doesn't do:
* Handle testing different serving both dev, serve, etc.

Ideally in the future this can be adapted for use in CI too so that PR's
are automatically tested. This will also allow us to identify trends in
performance.
@Josh-Walker-GM Josh-Walker-GM modified the milestones: chore, v8.0.0 Sep 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release:chore This PR is a chore (means nothing for users)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants