chore: Migrate useSelfHostedUserList to TS Query V5 #3575

nicholas-codecov · 2024-12-12T16:04:58Z

Description

This PR migrates the useSelfHostedUserList to the infiniteQueryOptions setup from TS Query V5 to SelfHostedUserListQueryOpts

Ticket: codecov/engineering-team#2961

Notable Changes

Migrate useSelfHostedUserList to SelfHostedUserListQueryOpts
Update usage in MemberTable

codecov-staging · 2024-12-12T16:07:34Z

Bundle Report

Changes will increase total bundle size by 431 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes

Bundle name	Size	Change
gazebo-staging-system-esm	6.05MB	223 bytes (0.0%) ⬆️
gazebo-staging-system	6.0MB	208 bytes (0.0%) ⬆️

codecov · 2024-12-12T16:08:18Z

Bundle Report

Changes will increase total bundle size by 431 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes

Bundle name	Size	Change
gazebo-production-system	6.0MB	208 bytes (0.0%) ⬆️
gazebo-production-system-esm	6.05MB	223 bytes (0.0%) ⬆️

codecov · 2024-12-12T16:08:34Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.99%. Comparing base (92c721b) to head (7636bf9).
Report is 1 commits behind head on main.

✅ All tests successful. No failed tests found.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3575   +/-   ##
=======================================
  Coverage   98.99%   98.99%           
=======================================
  Files         810      810           
  Lines       14567    14569    +2     
  Branches     4157     4149    -8     
=======================================
+ Hits        14420    14422    +2     
  Misses        140      140           
  Partials        7        7

Files with missing lines	Coverage Δ
...inSettings/AdminMembers/MemberList/MemberTable.tsx	`100.00% <100.00%> (ø)`
...services/selfHosted/SelfHostedUserListQueryOpts.ts	`100.00% <100.00%> (ø)`

Components	Coverage Δ
Assets	`100.00% <ø> (ø)`
Layouts	`99.71% <ø> (ø)`
Pages	`98.73% <100.00%> (+<0.01%)`	⬆️
Services	`99.36% <100.00%> (-0.01%)`	⬇️
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 92c721b...7636bf9. Read the comment docs.

codecov-notifications · 2024-12-12T16:08:35Z

Codecov Report

All modified and coverable lines are covered by tests ✅

✅ All tests successful. No failed tests found.

@@           Coverage Diff           @@
##             main    #3575   +/-   ##
=======================================
  Coverage   98.99%   98.99%           
=======================================
  Files         810      810           
  Lines       14567    14569    +2     
  Branches     4157     4149    -8     
=======================================
+ Hits        14420    14422    +2     
  Misses        140      140           
  Partials        7        7

Files with missing lines	Coverage Δ
...inSettings/AdminMembers/MemberList/MemberTable.tsx	`100.00% <100.00%> (ø)`
...services/selfHosted/SelfHostedUserListQueryOpts.ts	`100.00% <100.00%> (ø)`

Components	Coverage Δ
Assets	`100.00% <ø> (ø)`
Layouts	`99.71% <ø> (ø)`
Pages	`98.73% <100.00%> (+<0.01%)`	⬆️
Services	`99.36% <100.00%> (-0.01%)`	⬇️
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 92c721b...7636bf9. Read the comment docs.

codecov-public-qa · 2024-12-12T16:08:39Z

❌ 1 Tests Failed:

Tests completed	Failed	Passed	Skipped
4169	1	4168	0

View the top 1 failed tests by shortest run time

src/pages/PlanPage/subRoutes/UpgradePlanPage/UpgradeForm/Controllers/TeamPlanController/BillingOptions/BillingOptions.test.tsx > BillingOptions > when rendered > planString is set to annual plan > renders annual button as "selected"

Stack Traces | 0.237s run time

Error: expect(element).toHaveClass("bg-ds-primary-base")

Expected the element to have class:
  bg-ds-primary-base
Received:
  flex-1 py-1 px-2 text-sm cursor-pointer whitespace-nowrap disabled:text-ds-gray-quaternary disabled:border-ds-gray-tertiary disabled:bg-ds-gray-primary rounded-l
 ❯ .../TeamPlanController/BillingOptions/BillingOptions.test.tsx:132:27

To view more test analytics, go to the Test Analytics Dashboard
📢 Thoughts on this report? Let us know!

codecov-releaser · 2024-12-12T16:11:01Z

✅ Deploy preview for gazebo ready!

Previews expire after 1 month automatically.

Storybook

Commit	Created	Cloud	Enterprise
`5fcab61`	Thu, 12 Dec 2024 16:11:01 GMT	Expired	Expired
`522581a`	Mon, 23 Dec 2024 11:42:34 GMT	Expired	Expired
`7636bf9`	Mon, 23 Dec 2024 18:06:18 GMT	Cloud	Enterprise

codecov-qa · 2024-12-12T16:11:16Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.99%. Comparing base (92c721b) to head (7636bf9).
Report is 1 commits behind head on main.

✅ All tests successful. No failed tests found.

@@           Coverage Diff           @@
##             main    #3575   +/-   ##
=======================================
  Coverage   98.99%   98.99%           
=======================================
  Files         810      810           
  Lines       14567    14569    +2     
  Branches     4150     4149    -1     
=======================================
+ Hits        14420    14422    +2     
  Misses        140      140           
  Partials        7        7

Files with missing lines	Coverage Δ
...inSettings/AdminMembers/MemberList/MemberTable.tsx	`100.00% <100.00%> (ø)`
...services/selfHosted/SelfHostedUserListQueryOpts.ts	`100.00% <100.00%> (ø)`

Components	Coverage Δ
Assets	`100.00% <ø> (ø)`
Layouts	`99.71% <ø> (ø)`
Pages	`98.73% <100.00%> (+<0.01%)`	⬆️
Services	`99.36% <100.00%> (-0.01%)`	⬇️
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 92c721b...7636bf9. Read the comment docs.

ajay-sentry · 2024-12-17T16:36:55Z

src/pages/AdminSettings/AdminMembers/MemberList/MemberTable.tsx

+  )
+
+  return {
+    ...rest,


any chance we can avoid using ...rest here? Do we really need everything coming back from this query call?

sure, we can remove it

src/services/selfHosted/SelfHostedUserListQueryOpts.test.tsx

ajay-sentry · 2024-12-17T16:39:51Z

src/pages/AdminSettings/AdminMembers/MemberList/MemberTable.tsx

+  isAdmin?: boolean
+}
+
+const useQueryMembersList = (params: Params) => {


Im also kinda curious why we pulled the memo out of the query and into this new query in the component itself

Beforehand the service query was a custom hook so we're okay to use a useMemo in there, whereas now with the queryOptions factory function it is no longer a custom hook, so we're not able to use a hook inside of the function.

makes sense!

ajay-sentry · 2024-12-23T17:23:09Z

src/services/selfHosted/SelfHostedUserListQueryOpts.ts

        return parsedData.data
      })
    },
-    suspense: false,
+    initialPageParam: '1',


is this not defaulted to 1 already?

It is not, you have to explicitly define it in V5

See: initialPageParam (2nd required option) https://tanstack.com/query/latest/docs/framework/react/reference/useInfiniteQuery

ajay-sentry

1 small question, approved otherwise

ajay-sentry reviewed Dec 17, 2024

View reviewed changes

src/services/selfHosted/SelfHostedUserListQueryOpts.test.tsx Outdated Show resolved Hide resolved

ajay-sentry reviewed Dec 17, 2024

View reviewed changes

ajay-sentry reviewed Dec 23, 2024

View reviewed changes

ajay-sentry approved these changes Dec 23, 2024

View reviewed changes

nicholas-codecov added 4 commits December 23, 2024 13:58

migrate useSelfHostedUserList to SelfHostedUserListQueryOpts

43420a7

update usage in MemberTable

b87cfb8

fix typo

331c544

remove spread operation

7636bf9

nicholas-codecov force-pushed the gh-eng-2961-chore-migrate-useSelfHostedUserList-to-tsqv5 branch from 522581a to 7636bf9 Compare December 23, 2024 18:00

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

Merged via the queue into main with commit 753f06c Dec 23, 2024
62 checks passed

nicholas-codecov deleted the gh-eng-2961-chore-migrate-useSelfHostedUserList-to-tsqv5 branch December 23, 2024 18:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Migrate useSelfHostedUserList to TS Query V5 #3575

chore: Migrate useSelfHostedUserList to TS Query V5 #3575

nicholas-codecov commented Dec 12, 2024

codecov-staging bot commented Dec 12, 2024 •

edited

Loading

codecov 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-public-qa bot commented Dec 12, 2024 •

edited

Loading

codecov-releaser commented Dec 12, 2024 •

edited

Loading

codecov-qa bot commented Dec 12, 2024 •

edited

Loading

ajay-sentry Dec 17, 2024

nicholas-codecov Dec 23, 2024

ajay-sentry Dec 17, 2024

nicholas-codecov Dec 23, 2024

ajay-sentry Dec 23, 2024

ajay-sentry Dec 23, 2024

nicholas-codecov Dec 23, 2024

nicholas-codecov Dec 23, 2024

ajay-sentry left a comment

chore: Migrate useSelfHostedUserList to TS Query V5 #3575

chore: Migrate useSelfHostedUserList to TS Query V5 #3575

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 bot commented Dec 12, 2024 • edited Loading

Codecov Report

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

Codecov Report

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

❌ 1 Tests Failed:

codecov-releaser commented Dec 12, 2024 • edited Loading

✅ Deploy preview for gazebo ready!

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

Codecov Report

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

ajay-sentry left a comment

Choose a reason for hiding this comment

codecov-staging bot commented Dec 12, 2024 •

edited

Loading

codecov 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-public-qa bot commented Dec 12, 2024 •

edited

Loading

codecov-releaser commented Dec 12, 2024 •

edited

Loading

codecov-qa bot commented Dec 12, 2024 •

edited

Loading