[EPIC] Feature discoverability - Beamer #3515

DiogoSoaress · 2022-02-15T15:19:02Z

What it solves

Part of Problem Statement safe-global/safe-pm#26
Resolves #3413

Related tasks

How this PR fixes it

Integrates Beamer as a 3rd party solution

How to test it

Opting on/off in the "Community support & updates" cookies enables/disables Beamer loading as a sliding section for feature discoverability and announcements.

Analytics changes

Screenshots

* feat: Add whats new button in sidebar, include beamer script * Use src branch dependency and continue customizing beamer * style: notifications badge * Load Beamer from the CookieBanner preferences * update beamer config object on close * chore: Bump version on components package * chore: Add beamer type to global window type and remove ts-nocheck * fix: useRef for beamer script tag to remove * fix: Add Beamer params and methods type definitions * refactor: Pass generic to loadFromCookie * fix: pass value as Generic instead of the whole Record<string, T> type * fix: PR feedback Co-authored-by: Usame Algan <usame.algan@gnosis.pm>

github-actions · 2022-02-15T15:19:21Z

CLA Assistant Lite All Contributors have signed the CLA.

github-actions · 2022-02-15T15:28:07Z

ESLint Summary View Full Report

Annotations are provided inline on the Files Changed tab. You can also see all annotations that were generated on the annotations page.

Type	Occurrences	Fixable
Errors	0	0
Warnings	0	0
Ignored	0	N/A

Result: ✅ success
Annotations: 0 total

^{Report generated by eslint-plus-action}

github-actions · 2022-02-15T15:33:03Z

Deployment links

🟠 Rinkeby	⚪ Mainnet	🟣 Polygon	🟡 BSC	⚫ Arbitrum	🟢 Gnosis Chain

coveralls · 2022-02-15T15:33:19Z

Pull Request Test Coverage Report for Build 1928659583

18 of 132 (13.64%) changed or added relevant lines in 15 files are covered.
16 unchanged lines in 5 files lost coverage.
Overall coverage decreased (-0.5%) to 34.89%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
src/logic/cookies/store/selectors/index.ts	0	1	0.0%
src/components/List/index.tsx	0	2	0.0%
src/logic/cookies/store/reducer/cookies.ts	1	3	33.33%
src/logic/cookies/utils/index.ts	4	7	57.14%
src/utils/googleAnalytics.ts	4	7	57.14%
src/utils/storage/Storage.ts	1	4	25.0%
src/utils/intercom.ts	0	5	0.0%
src/components/AppLayout/Sidebar/index.tsx	0	10	0.0%
src/utils/beamer.ts	0	27	0.0%
src/components/CookiesBanner/index.tsx	0	58	0.0%

Files with Coverage Reduction	New Missed Lines	%
src/components/AppLayout/Footer/index.tsx	1	90.91%
src/components/AppLayout/Sidebar/index.tsx	3	0%
src/components/CookiesBanner/index.tsx	3	0%
src/utils/intercom.ts	3	0%
src/logic/hooks/useSafeAppUrl.tsx	6	0%

Totals
Change from base Build 1927052380:	-0.5%
Covered Lines:	3366
Relevant Lines:	8719

💛 - Coveralls

github-actions · 2022-02-15T15:40:12Z

E2E Tests Failed
Check the results here: https://github.com/gnosis/safe-react-e2e-tests/actions/runs/1928705166

Failed tests:

❌ Read-only transaction creation and review Read-only transaction creation and review
❌ Safe Apps List Safe Apps List

* feat: link Beamer with the analytics cookies. Display different CookieBanner warning messages. * refactor: extract to an object cookie warning messages * refactor: clean up cookies reducer Co-authored-by: Aaron Cook <iamacook@users.noreply.github.com> * fix: update Beamer cookie alert copy * fix: handle Beamer with update cookies Co-authored-by: Aaron Cook <iamacook@users.noreply.github.com>

iamacook

Loving the TypeScript 😉

It won't let me comment on it as it's legacy, but on line 258 in src/components/CookiesBanner/index.tsx you can simplify it to `onClick={closeCookiesBannerHandler}.

iamacook · 2022-02-17T10:57:13Z

src/components/AppLayout/Sidebar/index.tsx

+  const handleClick = async () => {
+    const cookiesState = await loadFromCookie<BannerCookiesType>(COOKIES_KEY)
+    if (!cookiesState) {
+      dispatch(openCookieBanner({ cookieBannerOpen: true }))


It's possible to simplify this action even more. If openCookieBanner is dispatched, you need not send { cookieBannerOpen: true } in the payload at all.

iamacook · 2022-02-17T10:58:32Z

src/components/AppLayout/Sidebar/index.tsx

+            <StyledListItemText>What&apos;s new</StyledListItemText>
+          </StyledListItem>
+
+          <HelpCenterLink href="https://help.gnosis-safe.io/en/" target="_blank" title="Help Center of Gnosis Safe">


Probably out of scope, but have we considered treating links as CONSTANTS and/or centralising them? Would help in the future if need to update any. Maybe worth creating a new issue? cc @katspaugh

iamacook · 2022-02-17T10:59:20Z

src/components/CookiesBanner/index.tsx

@@ -156,55 +158,57 @@ const CookiesBanner = (): ReactElement => {
      }
    }
    fetchCookiesFromStorage()
-  }, [showAnalytics, showIntercom])
+  }, [dispatch, showAnalytics, showIntercom])

  const acceptCookiesHandler = async () => {
    const newState = {


You could add the types to these newState objects. Not necessary though.

DiogoSoaress · 2022-02-17T11:20:51Z

The last commit aims to allow QA to test the production styles.

Will be reverted after testing.

* fix: Remove Beamer cookies on consent withdraw, extract removeCookies function * refactor: Rename domain variable

github-actions · 2022-03-03T09:19:00Z

ESLint Summary View Full Report

Annotations are provided inline on the Files Changed tab. You can also see all annotations that were generated on the annotations page.

Type	Occurrences	Fixable
Errors	0	0
Warnings	0	0
Ignored	2	N/A

Result: ✅ success
Annotations: 0 total

^{Report generated by eslint-plus-action}

francovenica · 2022-03-03T12:57:30Z

I'll report this here since the 3610 was already merged, but this issue also happens in the 3610.

There is 1 beamer cookie that is not being removed when you withdraw consent on the settings preferences.
"_BEAMER_BOOSTED_ANNOUNCEMENT_DATE_ehlRMhQi41258"

Just check the checkbox in the preferences and reload the page to see all the cookies, Then uncheck the checkbox, reload the page and you will see that there is 1 cookie that is not going away

iamacook · 2022-03-03T13:15:09Z

There is 1 beamer cookie that is not being removed when you withdraw consent on the settings preferences.

This should be covered by #3615.

* Refactor CookieBanner * Hide What's New in desktop app * Remove unrelated test from footer tests

francovenica · 2022-03-03T15:06:27Z

Yeah, the 3615 was merged and solves the issue with that cookie.
The "_BEAMER_BOOSTED_ANNOUNCEMENT_DATE_ehlRMhQi41258" is now removed.

Looks good

Merge branch 'dev' into feature-discoverability

60449bd

DiogoSoaress mentioned this pull request Feb 16, 2022

Extend Privacy Policy for new cookies that are used #3473

Closed

2 tasks

DiogoSoaress and others added 2 commits February 17, 2022 10:14

style: Overwrite inline beamer badge color (#3521)

e38ef2f

usame-algan force-pushed the feature-discoverability branch from c32acb2 to e38ef2f Compare February 17, 2022 10:39

DiogoSoaress marked this pull request as ready for review February 17, 2022 10:49

usame-algan requested review from iamacook, katspaugh and liliiaorlenko February 17, 2022 10:49

usame-algan mentioned this pull request Feb 17, 2022

Update Privacy Policy Cookie table 5afe/safe-landing-page#14

Closed

iamacook reviewed Feb 17, 2022

View reviewed changes

chore: change the fallback BEAMER_ID for QA tests

85511d5

francovenica mentioned this pull request Mar 2, 2022

Beamer - Delete cookies when opting out in the preferences settings #3608

Closed

fix: Remove Beamer cookies on consent withdraw (#3610)

26484ee

* fix: Remove Beamer cookies on consent withdraw, extract removeCookies function * refactor: Rename domain variable

katspaugh temporarily deployed to Manual March 3, 2022 09:15 Inactive

Merge branch 'dev' into feature-discoverability

3d51fd0

katspaugh force-pushed the feature-discoverability branch from 606b723 to 3d51fd0 Compare March 3, 2022 09:25

katspaugh temporarily deployed to Manual March 3, 2022 09:25 Inactive

fix: Remove additional beamer cookie on consent withdraw

27929f3

usame-algan temporarily deployed to Manual March 3, 2022 09:38 Inactive

Fix: remove Beamer LS + refactor CookieBanner (#3615)

b80d196

* Refactor CookieBanner * Hide What's New in desktop app * Remove unrelated test from footer tests

katspaugh temporarily deployed to Manual March 3, 2022 14:48 Inactive

katspaugh approved these changes Mar 3, 2022

View reviewed changes

katspaugh merged commit 7e05fc3 into dev Mar 3, 2022

katspaugh deleted the feature-discoverability branch March 3, 2022 15:24

github-actions bot locked and limited conversation to collaborators Mar 3, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[EPIC] Feature discoverability - Beamer #3515

[EPIC] Feature discoverability - Beamer #3515

DiogoSoaress commented Feb 15, 2022 •

edited by francovenica

Loading

github-actions bot commented Feb 15, 2022

github-actions bot commented Feb 15, 2022 •

edited

Loading

github-actions bot commented Feb 15, 2022

coveralls commented Feb 15, 2022 •

edited

Loading

github-actions bot commented Feb 15, 2022 •

edited

Loading

iamacook left a comment

iamacook Feb 17, 2022

iamacook Feb 17, 2022

iamacook Feb 17, 2022

DiogoSoaress commented Feb 17, 2022

github-actions bot commented Mar 3, 2022 •

edited

Loading

francovenica commented Mar 3, 2022

iamacook commented Mar 3, 2022

francovenica commented Mar 3, 2022

[EPIC] Feature discoverability - Beamer #3515

[EPIC] Feature discoverability - Beamer #3515

Conversation

DiogoSoaress commented Feb 15, 2022 • edited by francovenica Loading

What it solves

Related tasks

How this PR fixes it

How to test it

Analytics changes

Screenshots

github-actions bot commented Feb 15, 2022

github-actions bot commented Feb 15, 2022 • edited Loading

ESLint Summary View Full Report

github-actions bot commented Feb 15, 2022

Deployment links

coveralls commented Feb 15, 2022 • edited Loading

Pull Request Test Coverage Report for Build 1928659583

💛 - Coveralls

github-actions bot commented Feb 15, 2022 • edited Loading

iamacook left a comment

Choose a reason for hiding this comment

iamacook Feb 17, 2022

Choose a reason for hiding this comment

iamacook Feb 17, 2022

Choose a reason for hiding this comment

iamacook Feb 17, 2022

Choose a reason for hiding this comment

DiogoSoaress commented Feb 17, 2022

github-actions bot commented Mar 3, 2022 • edited Loading

ESLint Summary View Full Report

francovenica commented Mar 3, 2022

iamacook commented Mar 3, 2022

francovenica commented Mar 3, 2022

DiogoSoaress commented Feb 15, 2022 •

edited by francovenica

Loading

github-actions bot commented Feb 15, 2022 •

edited

Loading

coveralls commented Feb 15, 2022 •

edited

Loading

github-actions bot commented Feb 15, 2022 •

edited

Loading

github-actions bot commented Mar 3, 2022 •

edited

Loading