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

ci: Display performance measurement results as custom metrics #3491

Merged
merged 34 commits into from
Nov 19, 2024

Conversation

k2tzumi
Copy link
Contributor

@k2tzumi k2tzumi commented Oct 5, 2024

The author should do the following, if applicable

  • Add tests
  • Run tests
  • bun run format:fix && bun run lint:fix to format the code
  • Add TSDoc/JSDoc to document the code

What's this all about?

This will be an improvement in type checking performance monitoring added by the following Pull Request.
#3406

In conjunction with octocov, type checking performance will be displayed as Pull Request comments and CI summary as follows

  • Pull Request comments
    image
    note: The bundle size is not shown as a diff since it is the first time, but it will be shown after the main branch is updated.
    Looks like the diff showed up just fine!

  • CI summary
    image

Copy link

codecov bot commented Oct 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.70%. Comparing base (f5bad77) to head (8ba2da0).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3491   +/-   ##
=======================================
  Coverage   91.70%   91.70%           
=======================================
  Files         159      159           
  Lines       10145    10145           
  Branches     2863     2896   +33     
=======================================
  Hits         9303     9303           
  Misses        840      840           
  Partials        2        2           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

@yusukebe
Copy link
Member

Hi @k2tzumi

Sorry for the late reply. This is great! But please wait a bit for the discussion in PR #3443 to be finished.

@k2tzumi
Copy link
Contributor Author

k2tzumi commented Nov 2, 2024

@yusukebe

There is a discussion going on for #3443, is there anything we should address in our PR here?

@k2tzumi
Copy link
Contributor Author

k2tzumi commented Nov 13, 2024

If this PR is taken in, additional action may be needed.

@EdamAme-x
Copy link
Contributor

EdamAme-x commented Nov 13, 2024

Hi @k2tzumi
Thanks for nice work.
As you said, if #3661 is merged, I think we should add custom metrics. (or before it's merged)

@k2tzumi
Copy link
Contributor Author

k2tzumi commented Nov 13, 2024

@EdamAme-x
Thanks for the comment! Once #3661 is merged, I’d like to add the bundle size to the custom metrics!

@flipvh
Copy link

flipvh commented Nov 13, 2024

Thank you all, these are nice improvements! Type performance is the only thing I mildly warn about when recommending hono to everyone! I love seeing how hono and its ecosystem is improving every week and hoping to contribute back with our own OS projects. Keep up the great work.

@k2tzumi k2tzumi mentioned this pull request Nov 13, 2024
4 tasks
@yusukebe
Copy link
Member

@k2tzumi

I merged #3661!

@k2tzumi k2tzumi marked this pull request as ready for review November 17, 2024 03:36
.github/workflows/ci.yml Outdated Show resolved Hide resolved
.github/workflows/ci.yml Outdated Show resolved Hide resolved
.github/workflows/ci.yml Show resolved Hide resolved
.github/workflows/ci.yml Show resolved Hide resolved
perf-measures/bundle-check/scripts/process-results.ts Outdated Show resolved Hide resolved
Copy link
Contributor Author

@k2tzumi k2tzumi left a comment

Choose a reason for hiding this comment

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

@yusukebe @EdamAme-x
Hi, I added the bundle size support. Can you take a look?

perf-measures/bundle-check/scripts/process-results.ts Outdated Show resolved Hide resolved
perf-measures/bundle-check/scripts/process-results.ts Outdated Show resolved Hide resolved
@yusukebe
Copy link
Member

yusukebe commented Nov 18, 2024

Hi @k2tzumi

I realized that the codes in perf-measures are not formatted. I've created the PR and merged it into the main: #3683

Can you apply this change (merge main into this PR)?

Copy link
Contributor Author

@k2tzumi k2tzumi left a comment

Choose a reason for hiding this comment

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

Hi. @yusukebe

Merged #3683. Some minor tweaks were made along with.

@yusukebe
Copy link
Member

@k2tzumi

Sorry! I forgot to add a linter for the perf-measures directory. I've added it to this PR: #3686

Could you update this PR?

@yusukebe
Copy link
Member

Hi @EdamAme-x

Also, can you review this?

@k2tzumi
Copy link
Contributor Author

k2tzumi commented Nov 18, 2024

I was not able to verify the execution of jobs in perf-measures-type-and-bundle-check-on-main, so I tried it and found several problems, so I fixed them.
I've reflected the results in the Issue comment, so please check it out.

Copy link
Member

@yusukebe yusukebe left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Contributor

@EdamAme-x EdamAme-x left a comment

Choose a reason for hiding this comment

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

Great work!
(I had a Ureteral stone that knocked me down, so my review was late confirming it. My apologies lol.)

It would be a good idea to show both B and KB on custom metrics (but I don't think there's any rush to implement it now).
At any rate, let's try it out and see if there is any inconvenience in actually using it.

@yusukebe
Copy link
Member

@k2tzumi @EdamAme-x

Thank you! Let's land it!

@yusukebe yusukebe merged commit 163657a into honojs:main Nov 19, 2024
16 checks passed
@yusukebe
Copy link
Member

Wooow, super cool!
#3666 (comment)

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.

5 participants