datahub: Favorite star bug on page change #533

cmoinier · 2023-07-13T13:54:02Z

Thanks Tobias and Florent for the help!

JIRA ISSUE

https://jira.camptocamp.com/browse/GSHDF-679

DESCRIPTION

Permettre d'ajouter/supprimer un record des favoris
Permettre de garder ce favori en changeant d'onglet
Permettre de garder ce favori en allant sur la page du record

github-actions · 2023-07-13T13:55:52Z

Affected libs: feature-search, feature-record, feature-router, feature-map, feature-dataviz,
Affected apps: metadata-editor, datahub, demo, webcomponents, search, map-viewer,

🚀 Build and deploy storybook and demo on GitHub Pages
📦 Build and push affected docker images

fgravin

Great work thanks.
I have made some comments to make the logic clearer about what we are doing.

Also, I don't think that you properly test the new behavior.
You should add a couple of tests where the modifiedFavorites$ ticks

contains the component record
does not contain the component record

libs/feature/search/src/lib/favorites/favorite-star/favorite-star.component.ts

fgravin · 2023-07-13T14:56:19Z

libs/feature/search/src/lib/favorites/favorite-star/favorite-star.component.ts

+          }
+        })
+        editedDs = []
+      })
  }

  ngOnDestroy(): void {
    this.subscription.unsubscribe()


Usually, one subscription is enough, you could use subscription.add() to all subscribes that you want to unsubscribe from.

Yes, I did try that. For some reason the subscription isn't working (as in, nothing happens, no update on directly clicked record nor on the other page) unless it's in its own subscription. I agree this is not the best way.

It should work, what did you try ?

Tried the normal way : this.subscription.add() on this.favoritesService.myFavoritesUuid$.pipe() ......

libs/feature/search/src/lib/favorites/favorite-star/favorite-star.component.ts

…tar.component.ts refactor pairwise function Co-authored-by: Florent Gravin <[email protected]>

libs/feature/search/src/lib/favorites/favorite-star/favorite-star.component.spec.ts

fgravin

It works well like that thanks.
The test should be modified though, to play the new scenario, and test all the possibilities.

Thanks !

libs/feature/search/src/lib/favorites/favorite-star/favorite-star.component.ts

libs/feature/search/src/lib/favorites/favorite-star/favorite-star.component.spec.ts

…tar.component.ts refactor pairwise logic Co-authored-by: Florent Gravin <[email protected]>

libs/feature/search/src/lib/favorites/favorite-star/favorite-star.component.spec.ts

fgravin · 2023-07-24T10:10:29Z

libs/feature/search/src/lib/favorites/favorite-star/favorite-star.component.spec.ts

+            )
+          })
+          it('adds the record to myFavoritesUuid$', async () => {
+            await expect(favoritesService.myFavoritesUuid$['_value'][0]).toBe(


I don't understand what does this test actually test.
BTW, Observables are a flow and should not be tested as an instantaneous value (which is hacky cause it's not the public API).

It tests if the record is present in the myFavoriteUuid after the user clicks on the star. It's important especially when it ticks from another component.

Okay, so how do I test if myFavoriteUuid properly recorded that the record is in the user's favorite? I didn't have any other idea

component.record.uuid = 'a'

myFavoriteUuid$.next(['b']) => nothing happens

myFavoriteUuid$.next(['a']) => the component is updated

It tests if the record is present in the myFavoriteUuid after the user clicks on the star. It's important especially when it ticks from another component.

yes but you did the myFavoritesUuid$.next([component.record.uuid]) in the beforeEach, which is exactly what you test in there.

fgravin · 2023-07-24T11:02:54Z

libs/feature/search/src/lib/favorites/favorite-star/favorite-star.component.spec.ts

+            ])
+            expect(favoritesService.removeFromFavorites).not.toHaveBeenCalled()
+          })
+          it('increase record favorite count by one', () => {


Damn I forgot to commit one comment

While this test is a consequence of myFavoritesUuid$ tick.
Both things are decorrelated and should be tested separatly.

When I click on the star => here you test that the functions have been called

When the record is already in favorite

When the record is not in favorites
When favorites has been updated => here you test that the amount is correct

My record have been updated

My record haven't been updated

fgravin · 2023-07-28T09:54:54Z

@cmoinier all the tests were there, thanks !
I have reworked the whole scenario to make it clearer, what we test and how.
There was a lot of useless statements in the beforeEach() as well

cmoinier · 2023-07-28T12:37:11Z

Thanks for the rework @fgravin :)

Looks good to me, merging now.

cmoinier added 2 commits July 13, 2023 15:48

(fix): favorite star bug on page change

537c423

(chore): format:write

8cf81bd

fgravin requested changes Jul 13, 2023

View reviewed changes

fgravin changed the title ~~GSHDF-679 : Favorite star bug on page change~~ datahub: Favorite star bug on page change Jul 13, 2023

fgravin assigned cmoinier Jul 13, 2023

cmoinier and others added 2 commits July 17, 2023 09:45

Update libs/feature/search/src/lib/favorites/favorite-star/favorite-s…

42b4921

…tar.component.ts refactor pairwise function Co-authored-by: Florent Gravin <[email protected]>

(fix): refactor after reviews + add tests

d60f240

cmoinier requested a review from fgravin July 17, 2023 09:39

cmoinier assigned fgravin and unassigned cmoinier Jul 17, 2023

fgravin reviewed Jul 17, 2023

View reviewed changes

libs/feature/search/src/lib/favorites/favorite-star/favorite-star.component.spec.ts Outdated Show resolved Hide resolved

fgravin requested changes Jul 17, 2023

View reviewed changes

libs/feature/search/src/lib/favorites/favorite-star/favorite-star.component.ts Outdated Show resolved Hide resolved

libs/feature/search/src/lib/favorites/favorite-star/favorite-star.component.spec.ts Outdated Show resolved Hide resolved

fgravin assigned cmoinier and unassigned fgravin Jul 17, 2023

cmoinier and others added 2 commits July 17, 2023 18:50

Update libs/feature/search/src/lib/favorites/favorite-star/favorite-s…

8f954ae

…tar.component.ts refactor pairwise logic Co-authored-by: Florent Gravin <[email protected]>

(fix): tests

2a1ec01

fgravin requested changes Jul 24, 2023

View reviewed changes

fgravin reviewed Jul 24, 2023

View reviewed changes

fgravin linked an issue Jul 26, 2023 that may be closed by this pull request

[Datahub]: Favorites de-synchronization #547

Closed

fgravin added this to the 1.1.0 milestone Jul 27, 2023

fgravin added the bug Something isn't working label Jul 27, 2023

fgravin assigned fgravin and unassigned cmoinier Jul 27, 2023

cmoinier and others added 3 commits July 27, 2023 17:25

(tests): edit tests

97b99a8

test(favorite): work scenario

e12d662

chore(prettier): exclude /docs cache & lint

60ed20f

fgravin self-requested a review July 28, 2023 10:08

fgravin approved these changes Jul 28, 2023

View reviewed changes

cmoinier merged commit ba4b049 into main Jul 28, 2023
5 checks passed

jahow deleted the favorite-star-toggle branch August 14, 2023 14:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

datahub: Favorite star bug on page change #533

datahub: Favorite star bug on page change #533

cmoinier commented Jul 13, 2023 •

edited

Loading

github-actions bot commented Jul 13, 2023 •

edited

Loading

fgravin left a comment

fgravin Jul 13, 2023

cmoinier Jul 17, 2023

fgravin Jul 17, 2023

cmoinier Jul 27, 2023

fgravin left a comment

fgravin Jul 24, 2023

cmoinier Jul 24, 2023

cmoinier Jul 24, 2023

fgravin Jul 24, 2023

fgravin Jul 24, 2023

fgravin Jul 24, 2023

fgravin commented Jul 28, 2023

cmoinier commented Jul 28, 2023

datahub: Favorite star bug on page change #533

datahub: Favorite star bug on page change #533

Conversation

cmoinier commented Jul 13, 2023 • edited Loading

JIRA ISSUE

DESCRIPTION

github-actions bot commented Jul 13, 2023 • edited Loading

fgravin left a 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

fgravin left a 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

fgravin commented Jul 28, 2023

cmoinier commented Jul 28, 2023

cmoinier commented Jul 13, 2023 •

edited

Loading

github-actions bot commented Jul 13, 2023 •

edited

Loading