[feat] Add rate limit messaging on repo list page #3025

rohitvinnakota-codecov · 2024-07-17T14:57:03Z

Description

The resync job may not fetch latest repo data if the logged in owner is rate limited by github. We show some messaging in that case to give users an explanation as to why.

Legal Boilerplate

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. In 2022 this entity acquired Codecov and as result Sentry is going to need some rights from me in order to utilize my contributions in this PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

codecov-qa · 2024-07-17T15:00:18Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.28%. Comparing base (89da81a) to head (c8a2e3a).

✅ All tests successful. No failed tests found.

@@           Coverage Diff           @@
##             main    #3025   +/-   ##
=======================================
  Coverage   98.28%   98.28%           
=======================================
  Files         928      929    +1     
  Lines       13937    13957   +20     
  Branches     3778     3807   +29     
=======================================
+ Hits        13698    13718   +20     
  Misses        235      235           
  Partials        4        4

Files	Coverage Δ
src/services/user/useOwnerRateLimitStatus.tsx	`100.00% <100.00%> (ø)`
...rgControlTable/RepoOrgNotFound/RepoOrgNotFound.tsx	`100.00% <100.00%> (ø)`

Components	Coverage Δ
Assets	`53.84% <ø> (ø)`
Layouts	`97.75% <ø> (ø)`
Pages	`99.03% <ø> (ø)`
Services	`99.51% <100.00%> (+<0.01%)`	⬆️
Shared	`99.69% <100.00%> (+<0.01%)`	⬆️
UI	`93.99% <ø> (ø)`

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 89da81a...c8a2e3a. Read the comment docs.

codecov-public-qa · 2024-07-17T15:00:49Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.28%. Comparing base (89da81a) to head (c8a2e3a).

✅ All tests successful. No failed tests found.

@@           Coverage Diff           @@
##             main    #3025   +/-   ##
=======================================
  Coverage   98.28%   98.28%           
=======================================
  Files         928      929    +1     
  Lines       13937    13957   +20     
  Branches     3778     3807   +29     
=======================================
+ Hits        13698    13718   +20     
  Misses        235      235           
  Partials        4        4

Files	Coverage Δ
src/services/user/useOwnerRateLimitStatus.tsx	`100.00% <100.00%> (ø)`
...rgControlTable/RepoOrgNotFound/RepoOrgNotFound.tsx	`100.00% <100.00%> (ø)`

Components	Coverage Δ
Assets	`53.84% <ø> (ø)`
Layouts	`97.75% <ø> (ø)`
Pages	`99.03% <ø> (ø)`
Services	`99.51% <100.00%> (+<0.01%)`	⬆️
Shared	`99.69% <100.00%> (+<0.01%)`	⬆️
UI	`93.99% <ø> (ø)`

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 89da81a...c8a2e3a. Read the comment docs.

codecov-notifications · 2024-07-17T15:00:54Z

Codecov Report

All modified and coverable lines are covered by tests ✅

✅ All tests successful. No failed tests found.

@@           Coverage Diff           @@
##             main    #3025   +/-   ##
=======================================
  Coverage   98.28%   98.28%           
=======================================
  Files         928      929    +1     
  Lines       13937    13957   +20     
  Branches     3802     3783   -19     
=======================================
+ Hits        13698    13718   +20     
  Misses        235      235           
  Partials        4        4

Files	Coverage Δ
src/services/user/useOwnerRateLimitStatus.tsx	`100.00% <100.00%> (ø)`
...rgControlTable/RepoOrgNotFound/RepoOrgNotFound.tsx	`100.00% <100.00%> (ø)`

Components	Coverage Δ
Assets	`53.84% <ø> (ø)`
Layouts	`97.75% <ø> (ø)`
Pages	`99.03% <ø> (ø)`
Services	`99.51% <100.00%> (+<0.01%)`	⬆️
Shared	`99.69% <100.00%> (+<0.01%)`	⬆️
UI	`93.99% <ø> (ø)`

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 89da81a...c8a2e3a. Read the comment docs.

codecov-staging · 2024-07-17T15:02:09Z

Bundle Report

Changes will increase total bundle size by 1.27kB ⬆️

Bundle name	Size	Change
gazebo-staging-array-push	5.84MB	1.27kB ⬆️

codecov · 2024-07-17T15:02:41Z

Bundle Report

Changes will increase total bundle size by 1.27kB ⬆️

Bundle name	Size	Change
gazebo-production-array-push	5.84MB	1.27kB ⬆️

codecov · 2024-07-17T15:03:41Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.28%. Comparing base (89da81a) to head (c8a2e3a).

✅ All tests successful. No failed tests found.

Additional details and impacted files

@@             Coverage Diff             @@
##               main      #3025   +/-   ##
===========================================
  Coverage   98.28000   98.28000           
===========================================
  Files           928        929    +1     
  Lines         13937      13957   +20     
  Branches       3802       3807    +5     
===========================================
+ Hits          13698      13718   +20     
  Misses          235        235           
  Partials          4          4

Files	Coverage Δ
src/services/user/useOwnerRateLimitStatus.tsx	`100.00% <100.00%> (ø)`
...rgControlTable/RepoOrgNotFound/RepoOrgNotFound.tsx	`100.00% <100.00%> (ø)`

Components	Coverage Δ
Assets	`53.84% <ø> (ø)`
Layouts	`97.75% <ø> (ø)`
Pages	`99.03% <ø> (ø)`
Services	`99.51% <100.00%> (+<0.01%)`	⬆️
Shared	`99.69% <100.00%> (+<0.01%)`	⬆️
UI	`93.99% <ø> (ø)`

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 89da81a...c8a2e3a. Read the comment docs.

codecov-releaser · 2024-07-17T15:08:44Z

✅ Deploy preview for gazebo ready!

Previews expire after 1 month automatically.

Storybook

Commit	Created	Cloud	Enterprise
`78d7a04`	Wed, 17 Jul 2024 15:08:43 GMT	Expired	Expired
`78d7a04`	Wed, 17 Jul 2024 15:19:13 GMT	Expired	Expired
`3b9fcd9`	Wed, 17 Jul 2024 19:25:18 GMT	Expired	Expired
`3b9fcd9`	Wed, 17 Jul 2024 19:29:24 GMT	Expired	Expired
`3b9fcd9`	Wed, 17 Jul 2024 19:40:04 GMT	Expired	Expired
`84aa81d`	Thu, 18 Jul 2024 15:36:51 GMT	Expired	Expired
`5dec827`	Thu, 18 Jul 2024 15:58:13 GMT	Expired	Expired
`759dc92`	Thu, 18 Jul 2024 16:52:58 GMT	Expired	Expired
`d226b5a`	Thu, 18 Jul 2024 17:15:31 GMT	Expired	Expired
`837c7a2`	Thu, 18 Jul 2024 17:28:28 GMT	Expired	Expired
`c8a2e3a`	Tue, 30 Jul 2024 13:18:06 GMT	Cloud	Enterprise

…/github.com/codecov/gazebo into rvinnakota/update-resync-message-rate-limit

nicholas-codecov

Couple of comments to peak at

nicholas-codecov · 2024-07-18T13:42:06Z

src/services/user/useOwnerRateLimitStatus.tsx

+      .nullish(),
+  })
+  .nullish()


m: We want to move these to be nullable() instead of nullish() as GQL cannot return undefined fields, so that's adding some extra burden on our end to handle cases that cannot occur.

nicholas-codecov · 2024-07-18T13:43:35Z

src/services/user/useOwnerRateLimitStatus.tsx

+        const data = parsedData.data
+
+        return {
+          isGithubRateLimited: data?.owner?.isGithubRateLimited,


l: Thoughts on assigning this a default value data?.owner?.isGithubRateLimited ?? true | false just to be a bit more explicit on the return type?

nicholas-codecov · 2024-07-18T13:47:02Z

src/services/user/useOwnerRateLimitStatus.tsx

+          return Promise.reject({
+            status: 404,
+            data: {},
+          })


l: Can you add in something along these lines so that we have better debugging messages in case this is thrown.

codecovdesign · 2024-07-18T14:02:16Z

if we know the user is rate limited (via the hook), why do we still allow the user to resync?

@rohitvinnakota-codecov suggestion is we cut the syncing action/copy in this circumstance and clarify the rate limit issue:

Cant’t find your repo? It may be due to GitHub rate limits

Unless this is confirmed below, then perhaps we keep?

fallback logic for some endpoints that uses a public bot token so it may work

nicholas-codecov

LGTM

…/github.com/codecov/gazebo into rvinnakota/update-resync-message-rate-limit

initial commit

dc95b4a

fix link

78d7a04

Merge branch 'main' into rvinnakota/update-resync-message-rate-limit

ecbe2fe

rohitvinnakota-codecov marked this pull request as ready for review July 17, 2024 18:50

rohitvinnakota-codecov changed the title ~~[draft] Add rate limit messaging on repo list page~~ [feat] Add rate limit messaging on repo list page Jul 17, 2024

rohitvinnakota-codecov added 3 commits July 17, 2024 15:03

Add test

e3d20dd

Merge branch 'rvinnakota/update-resync-message-rate-limit' of https:/…

913179d

…/github.com/codecov/gazebo into rvinnakota/update-resync-message-rate-limit

fix

3b9fcd9

nicholas-codecov reviewed Jul 18, 2024

View reviewed changes

rohitvinnakota-codecov mentioned this pull request Jul 18, 2024

[Gazebo] Add rate limit messaging to the resync button on the owner page codecov/engineering-team#2110

Closed

rohitvinnakota-codecov added 2 commits July 18, 2024 11:24

Update

84aa81d

Update schema

5dec827

nicholas-codecov approved these changes Jul 18, 2024

View reviewed changes

rohitvinnakota-codecov and others added 4 commits July 18, 2024 12:45

Merge branch 'main' into rvinnakota/update-resync-message-rate-limit

759dc92

Update

9416d78

Merge branch 'rvinnakota/update-resync-message-rate-limit' of https:/…

d226b5a

…/github.com/codecov/gazebo into rvinnakota/update-resync-message-rate-limit

Update test

837c7a2

rohitvinnakota-codecov added this pull request to the merge queue Jul 30, 2024

github-merge-queue bot pushed a commit that referenced this pull request Jul 30, 2024

[feat] Add rate limit messaging on repo list page (#3025)

1b8f451

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jul 30, 2024

Merge branch 'main' into rvinnakota/update-resync-message-rate-limit

c8a2e3a

rohitvinnakota-codecov added this pull request to the merge queue Jul 30, 2024

Merged via the queue into main with commit dc77b3d Jul 30, 2024
61 checks passed

rohitvinnakota-codecov deleted the rvinnakota/update-resync-message-rate-limit branch July 30, 2024 13:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[feat] Add rate limit messaging on repo list page #3025

[feat] Add rate limit messaging on repo list page #3025

rohitvinnakota-codecov commented Jul 17, 2024 •

edited

Loading

codecov-qa bot commented Jul 17, 2024 •

edited

Loading

codecov-public-qa bot commented Jul 17, 2024 •

edited

Loading

codecov-notifications bot commented Jul 17, 2024 •

edited

Loading

codecov-staging bot commented Jul 17, 2024 •

edited

Loading

codecov bot commented Jul 17, 2024 •

edited

Loading

codecov bot commented Jul 17, 2024 •

edited

Loading

codecov-releaser commented Jul 17, 2024 •

edited

Loading

nicholas-codecov left a comment

nicholas-codecov Jul 18, 2024

nicholas-codecov Jul 18, 2024

nicholas-codecov Jul 18, 2024

codecovdesign commented Jul 18, 2024 •

edited

Loading

nicholas-codecov left a comment

[feat] Add rate limit messaging on repo list page #3025

[feat] Add rate limit messaging on repo list page #3025

Conversation

rohitvinnakota-codecov commented Jul 17, 2024 • edited Loading

Description

Legal Boilerplate

codecov-qa bot commented Jul 17, 2024 • edited Loading

Codecov Report

codecov-public-qa bot commented Jul 17, 2024 • edited Loading

Codecov Report

codecov-notifications bot commented Jul 17, 2024 • edited Loading

Codecov Report

codecov-staging bot commented Jul 17, 2024 • edited Loading

Bundle Report

codecov bot commented Jul 17, 2024 • edited Loading

Bundle Report

codecov bot commented Jul 17, 2024 • edited Loading

Codecov Report

codecov-releaser commented Jul 17, 2024 • edited Loading

✅ Deploy preview for gazebo ready!

nicholas-codecov left a comment

Choose a reason for hiding this comment

nicholas-codecov Jul 18, 2024

Choose a reason for hiding this comment

nicholas-codecov Jul 18, 2024

Choose a reason for hiding this comment

nicholas-codecov Jul 18, 2024

Choose a reason for hiding this comment

codecovdesign commented Jul 18, 2024 • edited Loading

nicholas-codecov left a comment

Choose a reason for hiding this comment

rohitvinnakota-codecov commented Jul 17, 2024 •

edited

Loading

codecov-qa bot commented Jul 17, 2024 •

edited

Loading

codecov-public-qa bot commented Jul 17, 2024 •

edited

Loading

codecov-notifications bot commented Jul 17, 2024 •

edited

Loading

codecov-staging bot commented Jul 17, 2024 •

edited

Loading

codecov bot commented Jul 17, 2024 •

edited

Loading

codecov bot commented Jul 17, 2024 •

edited

Loading

codecov-releaser commented Jul 17, 2024 •

edited

Loading

codecovdesign commented Jul 18, 2024 •

edited

Loading