chore: Migrate useSelfHostedSettings to TS Query V5 #3574

nicholas-codecov · 2024-12-12T13:38:32Z

Description

This PR focuses on updating useSelfHostedSettings to the TS Query V5 queryOptions API version SelfHostedSettingsQueryOpts, as well as some TS refactors.

Ticket: codecov/engineering-team#2961

Notable Changes

Migrate useSelfHostedSettings to SelfHostedSettingsQueryOpts
Update how useUpdateSlefHostedSettings invalidates SelfHostedSettingsQueryOpts
Update usage of new hook, and refactor to TS ActivationInfo
Update usage of new hook, and refactor to TS ActivationCount
- Update usage of new hook, and refactor to TS AutoActivateMembers
- Update usage of new hook MemberTable

…QueryOpts

codecov-staging · 2024-12-12T13:41:06Z

Bundle Report

Changes will increase total bundle size by 1.19kB (0.01%) ⬆️. This is within the configured threshold ✅

Detailed changes

Bundle name	Size	Change
gazebo-staging-system-esm	6.05MB	544 bytes (0.01%) ⬆️
gazebo-staging-system	6.0MB	648 bytes (0.01%) ⬆️

codecov · 2024-12-12T13:41:11Z

Bundle Report

Changes will increase total bundle size by 1.19kB (0.01%) ⬆️. This is within the configured threshold ✅

Detailed changes

Bundle name	Size	Change
gazebo-production-system	6.0MB	648 bytes (0.01%) ⬆️
gazebo-production-system-esm	6.05MB	544 bytes (0.01%) ⬆️

codecov-notifications · 2024-12-12T13:42:00Z

Codecov Report

All modified and coverable lines are covered by tests ✅

✅ All tests successful. No failed tests found.

@@            Coverage Diff             @@
##             main    #3574      +/-   ##
==========================================
- Coverage   99.00%   98.99%   -0.02%     
==========================================
  Files         810      810              
  Lines       14563    14567       +4     
  Branches     4157     4157              
==========================================
+ Hits        14418    14420       +2     
- Misses        138      140       +2     
  Partials        7        7

Files with missing lines	Coverage Δ
...ActivationInfo/ActivationCount/ActivationCount.tsx	`100.00% <100.00%> (ø)`
...ngs/AdminMembers/ActivationInfo/ActivationInfo.tsx	`100.00% <100.00%> (ø)`
...onInfo/AutoActivateMembers/AutoActivateMembers.tsx	`81.81% <100.00%> (ø)`
...inSettings/AdminMembers/MemberList/MemberTable.tsx	`100.00% <100.00%> (ø)`
...c/services/account/useUpdateSelfHostedSettings.tsx	`95.00% <100.00%> (ø)`
...ervices/selfHosted/SelfHostedSettingsQueryOpts.tsx	`100.00% <100.00%> (ø)`

Components	Coverage Δ
Assets	`100.00% <ø> (ø)`
Layouts	`99.71% <ø> (ø)`
Pages	`98.73% <100.00%> (-0.03%)`	⬇️
Services	`99.36% <100.00%> (ø)`
Shared	`99.32% <ø> (ø)`
UI	`99.14% <ø> (ø)`

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 3c674b5...78f45e8. Read the comment docs.

codecov-qa · 2024-12-12T13:42:00Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.99%. Comparing base (3c674b5) to head (78f45e8).
Report is 1 commits behind head on main.

✅ All tests successful. No failed tests found.

@@            Coverage Diff             @@
##             main    #3574      +/-   ##
==========================================
- Coverage   99.00%   98.99%   -0.02%     
==========================================
  Files         810      810              
  Lines       14563    14567       +4     
  Branches     4157     4157              
==========================================
+ Hits        14418    14420       +2     
- Misses        138      140       +2     
  Partials        7        7

Files with missing lines	Coverage Δ
...ActivationInfo/ActivationCount/ActivationCount.tsx	`100.00% <100.00%> (ø)`
...ngs/AdminMembers/ActivationInfo/ActivationInfo.tsx	`100.00% <100.00%> (ø)`
...onInfo/AutoActivateMembers/AutoActivateMembers.tsx	`81.81% <100.00%> (ø)`
...inSettings/AdminMembers/MemberList/MemberTable.tsx	`100.00% <100.00%> (ø)`
...c/services/account/useUpdateSelfHostedSettings.tsx	`95.00% <100.00%> (ø)`
...ervices/selfHosted/SelfHostedSettingsQueryOpts.tsx	`100.00% <100.00%> (ø)`

Components	Coverage Δ
Assets	`100.00% <ø> (ø)`
Layouts	`99.71% <ø> (ø)`
Pages	`98.73% <100.00%> (-0.03%)`	⬇️
Services	`99.36% <100.00%> (ø)`
Shared	`99.32% <ø> (ø)`
UI	`99.14% <ø> (ø)`

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 3c674b5...78f45e8. Read the comment docs.

codecov · 2024-12-12T13:42:08Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.99%. Comparing base (3c674b5) to head (78f45e8).
Report is 1 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3574      +/-   ##
==========================================
- Coverage   99.00%   98.99%   -0.02%     
==========================================
  Files         810      810              
  Lines       14563    14567       +4     
  Branches     4150     4150              
==========================================
+ Hits        14418    14420       +2     
- Misses        138      140       +2     
  Partials        7        7

Files with missing lines	Coverage Δ
...ActivationInfo/ActivationCount/ActivationCount.tsx	`100.00% <100.00%> (ø)`
...ngs/AdminMembers/ActivationInfo/ActivationInfo.tsx	`100.00% <100.00%> (ø)`
...onInfo/AutoActivateMembers/AutoActivateMembers.tsx	`81.81% <100.00%> (ø)`
...inSettings/AdminMembers/MemberList/MemberTable.tsx	`100.00% <100.00%> (ø)`
...c/services/account/useUpdateSelfHostedSettings.tsx	`95.00% <100.00%> (ø)`
...ervices/selfHosted/SelfHostedSettingsQueryOpts.tsx	`100.00% <100.00%> (ø)`

Components	Coverage Δ
Assets	`100.00% <ø> (ø)`
Layouts	`99.71% <ø> (ø)`
Pages	`98.73% <100.00%> (-0.03%)`	⬇️
Services	`99.36% <100.00%> (ø)`
Shared	`99.32% <ø> (ø)`
UI	`99.14% <ø> (ø)`

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 3c674b5...78f45e8. Read the comment docs.

codecov-releaser · 2024-12-12T13:44:29Z

✅ Deploy preview for gazebo ready!

Previews expire after 1 month automatically.

Storybook

Commit	Created	Cloud	Enterprise
`7ebc2f7`	Thu, 12 Dec 2024 13:44:29 GMT	Expired	Expired
`178a5a0`	Mon, 23 Dec 2024 11:51:04 GMT	Expired	Expired
`1bb1f80`	Mon, 23 Dec 2024 17:14:53 GMT	Expired	Expired
`78f45e8`	Mon, 23 Dec 2024 17:50:18 GMT	Cloud	Enterprise

ajay-sentry · 2024-12-17T16:24:05Z

src/pages/AdminSettings/AdminMembers/MemberList/MemberTable.test.jsx

  queryClient.clear()
+  queryClientV5.clear()


I see we've made a deliberate effort in these suites to modify the ordering of the "clear" statements with the server statement being the last to clear -- jw what the intent was behind this change if any

That is the typical flow for the vast majority of our tests so I like the consistency as well as the alphabet, there's no technical reason

cool cool, thanks for the context ✅

ajay-sentry · 2024-12-17T16:24:49Z

src/pages/AdminSettings/AdminMembers/ActivationInfo/AutoActivateMembers/AutoActivateMembers.tsx

@@ -24,7 +35,7 @@ function AutoActivateMembers() {
        <Toggle
          dataMarketing="auto-acitvate-members"
          label={data?.planAutoActivate ? 'On' : 'Off'}
-          value={data?.planAutoActivate}
+          value={!!data?.planAutoActivate}


Do we need the boolean cast for a certain reason?

Yep, we need this here because data?.planAutoActivate is of type boolean | null and value only accepts booleans

got it makes sense!

src/pages/AdminSettings/AdminMembers/ActivationInfo/AutoActivateMembers/AutoActivateMembers.tsx

ajay-sentry · 2024-12-17T16:26:47Z

src/pages/AdminSettings/AdminMembers/ActivationInfo/ActivationCount/ActivationCount.test.tsx

 describe('ActivationCount', () => {
-  function setup() {
+  function setup({ seatsLimit, seatsUsed }: SetupArgs) {


curious why we wanted to refactor this to have setup args when it looks like the args are the same throughout

oh nvm I see seatsUsed as 10 in a later test, I dig it ✔️

codecov-public-qa · 2024-12-23T11:48:58Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.99%. Comparing base (8844168) to head (1bb1f80).
Report is 1 commits behind head on main.

✅ All tests successful. No failed tests found.

@@            Coverage Diff             @@
##             main    #3574      +/-   ##
==========================================
- Coverage   99.00%   98.99%   -0.02%     
==========================================
  Files         810      810              
  Lines       14569    14573       +4     
  Branches     4161     4154       -7     
==========================================
+ Hits        14424    14426       +2     
- Misses        138      140       +2     
  Partials        7        7

Files with missing lines	Coverage Δ
...ActivationInfo/ActivationCount/ActivationCount.tsx	`100.00% <100.00%> (ø)`
...ngs/AdminMembers/ActivationInfo/ActivationInfo.tsx	`100.00% <100.00%> (ø)`
...onInfo/AutoActivateMembers/AutoActivateMembers.tsx	`81.81% <100.00%> (ø)`
...inSettings/AdminMembers/MemberList/MemberTable.tsx	`100.00% <100.00%> (ø)`
...c/services/account/useUpdateSelfHostedSettings.tsx	`95.00% <100.00%> (ø)`
...ervices/selfHosted/SelfHostedSettingsQueryOpts.tsx	`100.00% <100.00%> (ø)`

Components	Coverage Δ
Assets	`100.00% <ø> (ø)`
Layouts	`99.71% <ø> (ø)`
Pages	`98.73% <100.00%> (-0.03%)`	⬇️
Services	`99.36% <100.00%> (ø)`
Shared	`99.32% <ø> (ø)`
UI	`99.14% <ø> (ø)`

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 8844168...1bb1f80. Read the comment docs.

…ngs-to-tsqv5

nicholas-codecov added 7 commits December 12, 2024 08:27

migrate useSelfHostedSettings to SelfHostedSettingsQueryOpts

7f1f652

update how useUpdateSelfHostedSettings invalidates SelfHostedSettings…

049bf0b

…QueryOpts

refactor to ts and migrate usage of updated hook in ActuvationInfo

cec828d

refactor to ts and migrate usage of updated hook in ActivationCount

301766e

refactor to ts and migrate usage of updated hook in AutoActivateMembers

d32c2bc

update usage in MemberTable

aa9b094

remove index barrel files

7ebc2f7

ajay-sentry reviewed Dec 17, 2024

View reviewed changes

src/pages/AdminSettings/AdminMembers/ActivationInfo/AutoActivateMembers/AutoActivateMembers.tsx Outdated Show resolved Hide resolved

ajay-sentry reviewed Dec 17, 2024

View reviewed changes

use Provider type

178a5a0

ajay-sentry approved these changes Dec 23, 2024

View reviewed changes

nicholas-codecov added 2 commits December 23, 2024 12:08

Merge branch 'main' into gh-eng-2961-chore-migrate-useSelfHostedSetti…

1bb1f80

…ngs-to-tsqv5

Merge branch 'main' into gh-eng-2961-chore-migrate-useSelfHostedSetti…

78f45e8

…ngs-to-tsqv5

nicholas-codecov added this pull request to the merge queue Dec 23, 2024

Merged via the queue into main with commit 92c721b Dec 23, 2024
58 of 62 checks passed

nicholas-codecov deleted the gh-eng-2961-chore-migrate-useSelfHostedSettings-to-tsqv5 branch December 23, 2024 17:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Migrate useSelfHostedSettings to TS Query V5 #3574

chore: Migrate useSelfHostedSettings to TS Query V5 #3574

nicholas-codecov commented Dec 12, 2024

codecov-staging bot commented Dec 12, 2024 •

edited

Loading

codecov bot commented Dec 12, 2024 •

edited

Loading

codecov-notifications bot commented Dec 12, 2024 •

edited

Loading

codecov-qa bot commented Dec 12, 2024 •

edited

Loading

codecov bot commented Dec 12, 2024 •

edited

Loading

codecov-releaser commented Dec 12, 2024 •

edited

Loading

ajay-sentry Dec 17, 2024

nicholas-codecov Dec 23, 2024

ajay-sentry Dec 23, 2024

ajay-sentry Dec 17, 2024

nicholas-codecov Dec 23, 2024

ajay-sentry Dec 23, 2024

ajay-sentry Dec 17, 2024

ajay-sentry Dec 17, 2024

codecov-public-qa bot commented Dec 23, 2024 •

edited

Loading

chore: Migrate useSelfHostedSettings to TS Query V5 #3574

chore: Migrate useSelfHostedSettings to TS Query V5 #3574

Conversation

nicholas-codecov commented Dec 12, 2024

Description

Notable Changes

codecov-staging bot commented Dec 12, 2024 • edited Loading

Bundle Report

codecov bot commented Dec 12, 2024 • edited Loading

Bundle Report

codecov-notifications bot commented Dec 12, 2024 • edited Loading

Codecov Report

codecov-qa bot commented Dec 12, 2024 • edited Loading

Codecov Report

codecov bot commented Dec 12, 2024 • edited Loading

Codecov Report

codecov-releaser commented Dec 12, 2024 • edited Loading

✅ Deploy preview for gazebo ready!

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-public-qa bot commented Dec 23, 2024 • edited Loading

Codecov Report

codecov-staging bot commented Dec 12, 2024 •

edited

Loading

codecov bot commented Dec 12, 2024 •

edited

Loading

codecov-notifications bot commented Dec 12, 2024 •

edited

Loading

codecov-qa bot commented Dec 12, 2024 •

edited

Loading

codecov bot commented Dec 12, 2024 •

edited

Loading

codecov-releaser commented Dec 12, 2024 •

edited

Loading

codecov-public-qa bot commented Dec 23, 2024 •

edited

Loading