Botonic Plugin Google Analytics

.github/workflows/botonic-plugin-google-analytics-tests.yml

@@ -0,0 +1,28 @@
+name: Botonic plugin-google-analytics tests
+
+on: [push]
+
+jobs:
+  botonic-plugin-google-analytics-tests:
+    name: Botonic plugin-google-analytics tests
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checking out to current branch (Step 1 of 6)
+      uses: actions/checkout@v1
+    - name: Setting up node (Step 2 of 6)
+      uses: actions/setup-node@v1
+      with:
+        node-version: '12'
+    - name: Setting up cache (Step 3 of 6)
+      uses: actions/cache@v1
+      with:
+        path: ~/.npm
+        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+        restore-keys: |
+          ${{ runner.os }}-node-
+    - name: Install botonic-plugin-google-analytics (Step 4 of 6)
+      run: (cd ./packages/botonic-plugin-google-analytics && npm install -D)
+    - name: Install common packages dependencies (Step 5 of 6)
+      run: npm install -D
+    - name: Verify lint botonic-plugin-google-analytics (Step 6 of 6)
+      run: (cd ./packages/botonic-plugin-google-analytics && npm run lint_ci)

.pre-commit-config.yaml

@@ -75,3 +75,9 @@ repos:
         language: system
         files: ^packages/botonic-react/
 
+      - id: google-analytics
+        name: google-analytics
+        entry: scripts/qa/lint-package.sh packages/botonic-plugin-google-analytics
+        language: system
+        files: ^packages/botonic-plugin-google-analytics/
+

packages/botonic-plugin-google-analytics/README.md

@@ -0,0 +1,57 @@
+# Botonic Plugin Google Analytics
+
+## What Does This Plugin Do?
+
+With this plugin you can track the user interaction with the bot or the bot's behaviour sending the information to [Google Analytics](https://analytics.google.com/). 
+
+## Setup
+
+1. Run `npm install --save @botonic/plugin-google-analytics` to install the plugin.
+2. Add it to the `src/plugins.js` file:
+
+**src/plugins.js**
+```javascript
+export const plugins = [
+  {
+    id: 'google_analytics',
+    resolve: require('@botonic/plugin-google-analytics'),
+    options: {
+      trackingId: 'UA-XXXXXXXX-Y', // Your Google Analytics tracking ID
+      userId: ({session}) => session.user.extra_data.analyticsUserId, //Optional. Method that returns a unique user ID as string
+      userTraits: ({session}) => { userName: session.user.extra_data.analyticsUserName, userEmail: session.user.extra_data.analyticsUserEmail }, //Optional. Method that returns an object with the user Traits
+      automaticTracking: true, //Optional. Indicates if an automatic tracking will be executed on every user interaction (true by default)
+      eventFields: () => ({category: 'bot', action: 'user_interaction'}) //Optional. Set custom event fields to track if automatic tracking is enabled
+    }
+  }
+]
+```
+If no `userId` is set, the plugin will use the bot's user ID (taken from the bot's session).  
+If no `userTraits` is set, the plugin will use as user traits some information about bot's user information (`username`, `provider` and `provider_id`).  
+If `automaticTracking` is set to false, the plugin will not track automatically in every user interaction.
+If no `eventFields` is set, the plugin will send a default set of fields to the automatic tracking. This option is used only if `automaticTracking` is not set or is set to true.  
+
+## Use
+
+This plugin can also be used to track manually.  
+The tracking must be done inside the `botonicInit` method and make sure to call it with the `await` keyword to ensure its execution.
+For every tracking, the user will be identified with the `userId` and `userTraits` defined in the plugin's options or with its default values.
+
+`eventFields` contains these Google Analytic [event tracking fields](https://developers.google.com/analytics/devguides/collection/analyticsjs/events#event_fields)  :
+- `category`: eventCategory in Google Analytics (string, required)
+- `action`: eventAction in Google Analytics (string, required)
+- `label`: eventLabel in Google Analytics (string, optional)
+- `value`: eventValue in Google Analytics (numeric, optional)
+```javascript
+static async botonicInit({ input, session, params, lastRoutePath, plugins }) {
+    const ga = plugins.google_analytics
+
+    const eventFields = {
+      category: 'chatbot',
+      action: 'user_message_sent',
+      label: 'rating',
+      value: 4
+    }
+
+    await ga.track({ session, eventFields })
+}
+```