Firebase Analytics + Sentry error logging #54

wangannie · 2020-04-25T07:21:05Z

What's new in this PR

Integrated Firebase Analytics (new compatibility with Expo SDK 37 from v1.1.1 Release + misc fixes #52 ) as a free alternative to FullStory. Getting a clear view of how clerks navigate the app can hopefully assist with remote user testing and expose bugs or points of confusion in the UX.
Added Analytics logging for the following events:
- ClerkLogOut
- GoBackApplyRewards
- ConfirmTransaction
- ClerkLogin
- CustomerFound
- SelectTrainingMode
- ConfirmQuantity
- OpenQuantityModal
- OpenRewardsModal
- ConfirmApplyRewards
Added Sentry error logging in all try/catch blocks

Relevant Links

Online sources

Firebase setup
Expo Firebase Analytics

Related PRs

Analogous to calblueprint/dccentralkitchen#88

How to review

~~In App.js set Analytics.setAnalyticsCollectionEnabled(false) to true.~~
Log into the Firebase console (shared with [email protected] , credentials pinned in Slack)
In the console, go to StreamView under Analytics in the menu on the left
Click around the app -- complete test transactions, clerk login, clerk training mode etc and see if the events are properly logged. You may need to refresh the Firebase console a few times for events to start showing up.
Look through the Events and various parameters and make sure everything is accurate. Look out for anything that's marked undefined.
Make sure the event names and parameters all make sense

Next steps

Possibly clean up the event logging into functions in logUtils like Sentry. This might be difficult to standardize since the parameters attached to each event vary so much, but
More extensive event logging--look into tracking each transaction process as a session instead of individual events

Tests Performed, Edge Cases

Tested several transactions/combinations etc.

Screenshots

Successful event logging in the Firebase Console

CC: @anniero98

annieyro · 2020-04-30T02:06:08Z

I keep getting

Possible Unhandled Promise Rejection (id 3): Error: The method or property expo-firebase-analytics.setAnalyticsEnabled is not available on ios, are you sure you've linked all the native dependencies properly?

(this is testing on iPad btw) nothing seems wrong, but I also installed packages yarn complained about just in case. Anyway unable to test it because of that 😅

annieyro · 2020-05-05T07:32:40Z

I'm getting a new error logging into A&S with 1111 ):

Possible Unhandled Promise Rejection (id 0): Error: Invalid user-property value specified. Value should be a string of up to 36 characters long.

tommypoa

This PR looks so clean and overall pretty good 😍Left a nit on naming, and some additional ones below:

Logging: All my actions are logging onto Firebase fine! I have one thing about logs that I couldn't quite figure out/wrap my head around – why are some of the events within screen_view while others are not? See pic below.
Additional Events: Noticed that most of the events logged are successful ones – think there might be some value in capturing events that are failure cases? That's unless there are plans to log with Sentry. Left an example above, but others I can think of:
- When customer is not found
- Clerk fail to log in?
Redundant events: Unless there are specific functions for logging certain actions, thought that there are a lot of things being logged right now - maybe consider removing some that are less helpful? Mostly concerned that it might slow down the app.

screens/CheckoutScreen.js

tommypoa · 2020-05-05T15:47:14Z

screens/modals/QuantityModal.js

+    Analytics.logEvent('ConfirmQuantity', {
+      name: 'Apply product quantity',
+      function: 'handleUpdateCart',
+      screen: 'QuantityModal',


It might be confusing to have screen as an event property since screen_name is captured with the Analytics too. Perhaps component?

Good idea! Thanks Tommy

annieyro

Looks good! I added Sentry logging to all the catch blocks we currently have since one already got added. Remember to add documentation for Firebase ! Because we have two projects and both have to be shared to the HC team if they aren't yet; wondering if we should share all the accounts to their team email or make one for them (since I have two sites deployed also under my accounts)

annieyro · 2020-05-11T05:33:23Z

screens/StoreLookupScreen.js

@@ -69,6 +70,11 @@ export default class StoreLookupScreen extends React.Component {
  handleNavigate = async () => {
    // Clerk training: set `trainingMode` to "true" in AsyncStorage
    if (this.state.store.storeName === 'CLERK TRAINING') {
+      await Analytics.logEvent('SelectTrainingMode', {


Does Analytics.logEvent returns a promise? Googled a bit and it doesn't seem like it. If it does, we'll have to add try/catch blocks because that means there are unhandled promise rejections. Otherwise, using await here is a bit misleading

Yeah you're right. I removed the awaits

annieyro · 2020-05-11T05:33:50Z

screens/CustomerLookupScreen.js

@@ -41,6 +42,13 @@ export default class CustomerLookupScreen extends React.Component {

  _asyncCustomerFound = async (customerRecord) => {
    await AsyncStorage.setItem('customerId', customerRecord.id);
+    await Analytics.logEvent('CustomerFound', {


await used here

screens/CheckoutScreen.js

annieyro · 2020-05-11T05:58:42Z

screens/ClerkLoginScreen.js

+          component: 'ClerkLoginScreen',
+          clerk_id: clerkRecord.id,
+          clerk_name: clerkRecord.clerkName,
+          store_name: clerkRecord.storeName[0],


Out of curiosity why did this fix it? Do lookup type records always return arrays from Airtable :o I was not aware

Yeah apparently they do return arrays. Not sure if there's a better way to do this, since clerks should only ever be connected to a single store?

…entralkitchen-clerks into AnnieW/firebase

…chen-clerks into AnnieW/firebase

wangannie added 5 commits April 24, 2020 23:40

Base analytics configuration

44ee889

Log screen changes in navigation

3808f37

Added analytics logging in Rewards

ccc63d5

Added analytics to checkout, auth, drawer

adbfa59

Disable analytics in development mode

5eb0090

wangannie requested review from annieyro and tommypoa April 25, 2020 07:21

annieyro added 3 commits April 29, 2020 19:01

Update env template to fallback to process.NODE_ENV

62be8f3

Install missing packages

c29a917

Set to false (lol)

d8e7779

Removed disable firebase in dev

f118bf0

tommypoa reviewed May 5, 2020

View reviewed changes

wangannie and others added 4 commits May 10, 2020 22:07

Added transaction error log to Sentry

f2a9bcf

Changed 'screen' event param to 'component'

2ef6b26

Fixed invalid user property promise rejection

2ae6c45

Add Sentry logging to all .catch blocks, fix typo

107b690

annieyro approved these changes May 11, 2020

View reviewed changes

wangannie added 2 commits May 11, 2020 08:18

Removed await

268e408

Merge branch 'AnnieW/firebase' of https://github.com/calblueprint/dcc…

9a0fede

…entralkitchen-clerks into AnnieW/firebase

wangannie changed the title ~~Firebase Analytics~~ Firebase Analytics + Sentry error logging May 11, 2020

Merge branch 'master' of https://github.com/calblueprint/dccentralkit…

e923fe9

…chen-clerks into AnnieW/firebase

wangannie merged commit c0c9862 into master May 11, 2020

wangannie deleted the AnnieW/firebase branch May 11, 2020 16:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Firebase Analytics + Sentry error logging #54

Firebase Analytics + Sentry error logging #54

wangannie commented Apr 25, 2020 •

edited

Loading

annieyro commented Apr 30, 2020

annieyro commented May 5, 2020

tommypoa left a comment

tommypoa May 5, 2020

wangannie May 11, 2020

annieyro left a comment

annieyro May 11, 2020

wangannie May 11, 2020

annieyro May 11, 2020

annieyro May 11, 2020

wangannie May 11, 2020

Firebase Analytics + Sentry error logging #54

Firebase Analytics + Sentry error logging #54

Conversation

wangannie commented Apr 25, 2020 • edited Loading

What's new in this PR

Relevant Links

Online sources

Related PRs

How to review

Next steps

Tests Performed, Edge Cases

Screenshots

annieyro commented Apr 30, 2020

annieyro commented May 5, 2020

tommypoa left a comment

Choose a reason for hiding this comment

tommypoa May 5, 2020

Choose a reason for hiding this comment

wangannie May 11, 2020

Choose a reason for hiding this comment

annieyro left a comment

Choose a reason for hiding this comment

annieyro May 11, 2020

Choose a reason for hiding this comment

wangannie May 11, 2020

Choose a reason for hiding this comment

annieyro May 11, 2020

Choose a reason for hiding this comment

annieyro May 11, 2020

Choose a reason for hiding this comment

wangannie May 11, 2020

Choose a reason for hiding this comment

wangannie commented Apr 25, 2020 •

edited

Loading