A4A > Feedback: Logical implementation of in-product feedback mechanism

[yashwin]

Related to https://github.com/Automattic/automattic-for-agencies-dev/issues/1246

Proposed Changes

This PR makes the logical implementation of the in-product feedback mechanism.

Why are these changes being made?

• To show the feedback form after specific actions are performed:

• Sending a referral
• Adding a team member
• Filling out partner directory information

NOTE: The UI is not yet integrated with the API endpoint, as it is in progress.

Testing Instructions

• Open the A4A live link
• Append the URL with ?flags=-a4a-product-feedback, perform the below actions and verify no feedback form is shown. Please ensure you don't refresh the page, as it will add the feature flag back.

• Sending a referral (/marketplace/products > Toggle the refer mode on and send a referral)
• Adding a team member (/team/invite > Send invite)
• Filling out partner directory information (/partner-directory/agency-details > Save public profile)

• Remove the feature flag > Refresh the page and perform the below actions and verify the feedback is shown as displayed below. Submitting or skipping the form should hide it and not show again when performing the same action. You can verify it by visiting the page manually with #feedback appended, you can find the URLs below.

• Sending a referral (/marketplace/products > Toggle the refer mode on and send a referral)

Manual testing URL: /referrals/dashboard#feedback

• Adding a team member (/team/invite > Send invite)

Manual testing URL: /team/invite#feedback

• Filling out partner directory information (/partner-directory/agency-details > Save public profile)

Manual testing URL: /partner-directory/agency-details#feedback

How the preferences are stored:

Preferences can be reset from staging

Pre-merge Checklist

• Has the general commit checklist been followed? (PCYsg-hS-p2)
• Have you written new tests for your changes?
• Have you tested the feature in Simple (P9HQHe-k8-p2), Atomic (P9HQHe-jW-p2), and self-hosted Jetpack sites (PCYsg-g6b-p2)?
• Have you checked for TypeScript, React or other console errors?
• Have you used memoizing on expensive computations? More info in Memoizing with create-selector and Using memoizing selectors and Our Approach to Data
• Have we added the "[Status] String Freeze" label as soon as any new strings were ready for translation (p4TIVU-5Jq-p2)?
  • For UI changes, have we tested the change in various languages (for example, ES, PT, FR, or DE)? The length of text and words vary significantly between languages.
• For changes affecting Jetpack: Have we added the "[Status] Needs Privacy Updates" label if this pull request changes what data or activity we track or use (p4TIVU-aUh-p2)?

[github-actions]

Calypso Live (direct link)

https://calypso.live?image=registry.a8c.com/calypso/app:build-126587

Jetpack Cloud live (direct link)

https://calypso.live?image=registry.a8c.com/calypso/app:build-126587&env=jetpack

Automattic for Agencies live (direct link)

https://calypso.live?image=registry.a8c.com/calypso/app:build-126587&env=a8c-for-agencies

[matticbot]

Here is how your PR affects size of JS and CSS bundles shipped to the user's browser:

App Entrypoints (~12 bytes removed 📉 [gzipped])

name           parsed_size           gzip_size
entry-stepper        +55 B  (+0.0%)      -12 B  (-0.0%)
entry-main           +55 B  (+0.0%)      -12 B  (-0.0%)

Common code that is always downloaded and parsed every time the app is loaded, no matter which route is used.

Sections (~4700 bytes added 📈 [gzipped])

name                                parsed_size           gzip_size
a8c-for-agencies-team                  +40104 B  (+4.3%)   +12402 B  (+4.9%)
a8c-for-agencies-partner-directory     +39866 B  (+8.5%)   +11730 B  (+7.9%)
a8c-for-agencies-marketplace            +3364 B  (+0.4%)     +837 B  (+0.3%)
a8c-for-agencies-client                 +3364 B  (+0.3%)     +980 B  (+0.3%)
a8c-for-agencies-referrals              +1331 B  (+0.1%)     +319 B  (+0.1%)

Sections contain code specific for a given set of routes. Is downloaded and parsed only when a particular route is navigated to.

Legend

What is parsed and gzip size?

Parsed Size: Uncompressed size of the JS and CSS files. This much code needs to be parsed and stored in memory.
Gzip Size: Compressed size of the JS and CSS files. This much data needs to be downloaded over network.

Generated by performance advisor bot at iscalypsofastyet.com.

[cleacos]

Side note: During our initial exploration, I suggested using the feedback data returned from one of our endpoints and not storing it in the app when the feedback form was sent. I mean, the backend would send to the app when the feedback forms were sent. That way, we are storing the information at the account level instead of the browser level. No matter the browser or computer the user uses, if the user already sent the form, it won't show it again.

The show/hide logic is executed in the app, but the information about it is provided inside one of the existing endpoints (i.e. agency). Something like agency.feedback.forms['the_feedback_reference'].sent_at.

[yashwin]

@cleacos: Thanks for the feedback!

During our initial exploration, I suggested using the feedback data returned from one of our endpoints and not storing it in the app when the feedback form was sent. I mean, the backend would send to the app when the feedback forms were sent. That way, we are storing the information at the account level instead of the browser level. No matter the browser or computer the user uses, if the user already sent the form, it won't show it again.

We are not storing the data at the browser/app level. We are using the https://public-api.wordpress.com/rest/v1.1/me/preferences API endpoint to store. This is stored at the user level. So, no matter the browser the user uses, it will be shown only once. We already use this in multiple places.

[cleacos]

We are not storing the data at the browser/app level. We are using the https://public-api.wordpress.com/rest/v1.1/me/preferences

Nice! I was thinking in the app preferences :)

[travisw]

Makes sense and works well 🚀

[travisw]

This should be safe to deploy as it's behind a feature flag. I'll go ahead and deploy.