refactor(web): use queries for dealing with software by dgdavid · Pull Request #1483 · agama-project/agama

dgdavid · 2024-07-18T14:36:47Z

Similar to #1439, #1452, and #1470, this set of changes aims to replace the client/software with TanStack queries.

Note that was not possible to fully drop the software client. It has to wait until migration of WithStatus and WithProgress mixins too.

Which allows to move some business logic from the UI to the queries, helping to simplify the SoftwarePatternsSelection component.

Based on a query and as a replacement of client.software.onSelectedPatternsChange.

Otherwise does not work as expected. This changes, however, will force to export all types in the file which was not the case until now. Something to learn about and change or improve.

To avoid TS complaints after exporting the SelectedBy enum. Something to re-check.

To avoid complaint about > Property 'toBeChecked' does not exist on type 'Matchers<void, Element>' See testing-library/jest-dom#442 (comment) and https://github.com/testing-library/jest-dom/releases/tag/v6.2.0

web/src/components/software/SoftwarePage.tsx

By using the useQueryClient hook instead of creating a new QueryClient instance. Needed to make it work better when invalidating queries.

To make the export explicit but using the same approach as it is already in use in JS files: exporting things at the end of file.

To avoid below error when running tests for tsx components > Cannot read properties of undefined (reading 'createElement') To know more see * https://dev.to/kkazala/jest-errors-1in7 * https://www.typescriptlang.org/tsconfig/#esModuleInterop

Needed to make tests works as expected. See https://stackoverflow.com/a/61636112

Along with other small changes detected while resurrecting such tests.

Adapted the UI using TanStack query instead of route loaders and useEffect hooks. --- Related to #1439, #1452, #1470, and #1483

imobachgs

In general it looks good, just some minor things.

web/src/components/software/SoftwarePage.test.tsx

web/src/components/software/SoftwarePatternsSelection.tsx

web/src/queries/software.ts

It was not invalidating software product query nor triggering the probing when changing the selected product.

dgdavid · 2024-07-23T12:40:55Z

@imobachgs,

I have no idea why the src/components/users/RootAuthMethods.test.jsx test is failing now in CI. I have run it locally and, as expected, it pass.

PASS  src/components/users/RootAuthMethods.test.jsx (12.938 s)
...
Test Suites: 1 passed, 1 total
Tests:       21 passed, 21 total

dgdavid · 2024-07-23T13:15:49Z

@imobachgs,

I have no idea why the src/components/users/RootAuthMethods.test.jsx test is failing now in CI. I have run it locally and, as expected, it pass.
...

#1493 should fix the issue.

web/src/components/overview/SoftwareSection.tsx

#1483 didn't drop dead software client methods that were replaced by queries. Let's do it now.

Defined types now live at types/software. Related to #1483 and #1496.

At this moment, the code for working with product registration is not used. Moreover, it has to be migrated to a TanStack Query approach because reasons stated at #1439 Thus, we've agreed to drop it meanwhile in order to have less dead/unused/pending to adapt code. Please, note that changes were done on top of #1498, reason why would be nice to merge this after it. Additionally, it includes a removal of software typedef comments that were forgotten at #1483 and #1496.

By mistake, #1483 introduced a tiny bug in the `useProductChanges` query hook by checking the `event.type` against an empty string instead of the exepected `ProductChanged` event. https://github.com/openSUSE/agama/pull/1483/files#diff-e671c06f4a1cefe3bef4af838681c780f2ba41356d44f72f5ce97be1b6eead66R172-R185 This PR fixes it for properly performs the software config query invalidation.

Prepare for releasing Agama 10· * #1263 * #1330 * #1407 * #1408 * #1410 * #1411 * #1412 * #1416 * #1417 * #1419 * #1420 * #1421 * #1422 * #1423 * #1424 * #1425 * #1428 * #1429 * #1430 * #1431 * #1432 * #1433 * #1436 * #1437 * #1438 * #1439 * #1440 * #1441 * #1443 * #1444 * #1445 * #1449 * #1450 * #1451 * #1452 * #1453 * #1454 * #1455 * #1456 * #1457 * #1459 * #1460 * #1462 * #1464 * #1465 * #1466 * #1467 * #1468 * #1469 * #1470 * #1471 * #1472 * #1473 * #1475 * #1476 * #1477 * #1478 * #1479 * #1480 * #1481 * #1482 * #1483 * #1484 * #1485 * #1486 * #1487 * #1488 * #1489 * #1491 * #1492 * #1493 * #1494 * #1496 * #1497 * #1498 * #1499 * #1500 * #1501 * #1502 * #1503 * #1504 * #1505 * #1506 * #1507 * #1508 * #1510 * #1511 * #1512 * #1513 * #1514 * #1515 * #1516 * #1517 * #1518 * #1519 * #1520 * #1522 * #1523 * #1524 * #1525 * #1526 * #1527 * #1528 * #1529 * #1530 * #1531 * #1532 * #1533 * #1534 * #1535 * #1536 * #1537 * #1540 * #1541 * #1543 * #1544 * #1545 * #1546 * #1547 * #1548 * #1549 * #1550 * #1552 * #1553 * #1554 * #1555 * #1556 * #1557 * #1558 * #1559 * #1560 * #1562 * #1563 * #1565 * #1566 * #1567 * #1568 * #1569 * #1570 * #1571 * #1572 * #1573 * #1574 * #1575 * #1576 * #1577 * #1578 * #1579 * #1580 * #1581 * #1583 * #1584 * #1585 * #1586 * #1587 * #1588 * #1589 * #1590 * #1591 * #1592 * #1593 * #1596 * #1597 * #1598 * #1600 * #1602 * #1605 * #1606 * #1607 * #1608 * #1610 * #1611 * #1612 * #1613 * #1614 * #1619 * #1620 * #1621

dgdavid added 7 commits July 18, 2024 15:29

feat(web): Use queries for patterns selection

74654d4

Which allows to move some business logic from the UI to the queries, helping to simplify the SoftwarePatternsSelection component.

refactor(web): migrate software queries to TypeScript

6d763b7

refactor(web): add useProposalChanges hook

8df2c4d

Based on a query and as a replacement of client.software.onSelectedPatternsChange.

fix(web): export SelectedBy enum

479395d

Otherwise does not work as expected. This changes, however, will force to export all types in the file which was not the case until now. Something to learn about and change or improve.

fix(web): export all software types

30ed16c

To avoid TS complaints after exporting the SelectedBy enum. Something to re-check.

chore(web): update @testing-library/jest-dom

a7d1f5a

To avoid complaint about > Property 'toBeChecked' does not exist on type 'Matchers<void, Element>' See testing-library/jest-dom#442 (comment) and https://github.com/testing-library/jest-dom/releases/tag/v6.2.0

refactor(web) Migrate components/software to TypeScript

cc16b83

dgdavid commented Jul 18, 2024

View reviewed changes

web/src/components/software/SoftwarePage.tsx Show resolved Hide resolved

dgdavid added 8 commits July 22, 2024 12:27

fix(web): use same queryClient at software queries

aa457fa

By using the useQueryClient hook instead of creating a new QueryClient instance. Needed to make it work better when invalidating queries.

refactor(web): change how types are exported

b348db0

To make the export explicit but using the same approach as it is already in use in JS files: exporting things at the end of file.

refactor(web): improve typing in software components

5f9bd2e

fix(web): add esModuleInterop to tsconfig

1896c03

To avoid below error when running tests for tsx components > Cannot read properties of undefined (reading 'createElement') To know more see * https://dev.to/kkazala/jest-errors-1in7 * https://www.typescriptlang.org/tsconfig/#esModuleInterop

fix(web): more tsconfig adjustments

5f484e1

Needed to make tests works as expected. See https://stackoverflow.com/a/61636112

fix(web) bring back software tests

9de8dc3

Along with other small changes detected while resurrecting such tests.

fix(web) move registration types to their own file

c394a05

fix(web) drop ActionResult type from software.ts

3706d25

dgdavid force-pushed the software-queries branch from 2b535d7 to 3706d25 Compare July 22, 2024 15:52

dgdavid marked this pull request as ready for review July 22, 2024 16:03

dgdavid requested a review from imobachgs July 22, 2024 16:03

dgdavid mentioned this pull request Jul 23, 2024

Move network to TanStack query #1489

Merged

teclator added a commit that referenced this pull request Jul 23, 2024

Move network to TanStack query (#1489)

55afa6e

Adapted the UI using TanStack query instead of route loaders and useEffect hooks. --- Related to #1439, #1452, #1470, and #1483

imobachgs reviewed Jul 23, 2024

View reviewed changes

web/src/components/software/SoftwarePage.test.tsx Outdated Show resolved Hide resolved

web/src/components/software/SoftwarePatternsSelection.tsx Show resolved Hide resolved

web/src/queries/software.ts Show resolved Hide resolved

fix(web): move internal type

ac594f7

dgdavid force-pushed the software-queries branch from 6aa1a2b to ac594f7 Compare July 23, 2024 11:24

dgdavid added 6 commits July 23, 2024 12:55

refactor(web) adapt overview SoftwareSection to queries

03e024e

refactor(web) move overview SoftwareSection to TypeScript

9e037c5

fix(web) improve software config mutation

04c5d36

It was not invalidating software product query nor triggering the probing when changing the selected product.

fix(web) updates from code review

e7c4c82

fix(web) do not test query changes from component

f69c3ef

fix(web) drop dead code in software client

3d320e3

imobachgs approved these changes Jul 23, 2024

View reviewed changes

web/src/components/overview/SoftwareSection.tsx Show resolved Hide resolved

dgdavid merged commit 22d0125 into master Jul 23, 2024

dgdavid deleted the software-queries branch July 23, 2024 14:00

dgdavid mentioned this pull request Jul 24, 2024

fix(web): drop software client leftovers #1496

Merged

dgdavid added a commit that referenced this pull request Jul 24, 2024

fix(web): drop software client leftovers (#1496)

9139262

#1483 didn't drop dead software client methods that were replaced by queries. Let's do it now.

dgdavid added a commit that referenced this pull request Jul 24, 2024

fix(web): drop dead typedef comments

93de748

Defined types now live at types/software. Related to #1483 and #1496.

dgdavid mentioned this pull request Jul 24, 2024

refactor(web): drop product registration code #1499

Merged

dgdavid mentioned this pull request Aug 2, 2024

fix(web): make useProductChanges work as expected #1526

Merged

imobachgs mentioned this pull request Sep 20, 2024

Update to release 10 #1622

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(web): use queries for dealing with software #1483

refactor(web): use queries for dealing with software #1483
dgdavid merged 22 commits intomasterfrom
software-queries

dgdavid commented Jul 18, 2024 •

edited

Loading

Uh oh!

Uh oh!

imobachgs left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dgdavid commented Jul 23, 2024

Uh oh!

dgdavid commented Jul 23, 2024

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

dgdavid commented Jul 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

imobachgs left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dgdavid commented Jul 23, 2024

Uh oh!

dgdavid commented Jul 23, 2024

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

dgdavid commented Jul 18, 2024 •

edited

Loading