Merge pull request #185 from CleverTap/develop

Service worker release

.github/workflows/sw_build.yml

@@ -0,0 +1,34 @@
+name: Build SW Webpush
+on:
+  push:
+    branches:
+      - master
+      - develop
+  pull_request:
+    branches:
+      - master
+      - develop
+    types: [opened, synchronize, reopened]
+jobs:
+  build:
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use node.js version 10.x
+        uses: actions/[email protected]
+        with:
+          node-version: '10.x'
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+      - uses: actions/cache@v2
+        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
+        with:
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+      - name: Install packages
+        run: yarn
+      - name: Build package
+        run: yarn run build_sw

.github/workflows/sw_release.yml

@@ -0,0 +1,36 @@
+name: Release sw_webpush.min.js to s3
+on:
+  release:
+    types: [published]
+jobs:
+  build:
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use node.js version 10.x
+        uses: actions/[email protected]
+        with:
+          node-version: '10.x'
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+      - uses: actions/cache@v2
+        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
+        with:
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+      - name: Install packages
+        run: yarn
+      - name: Build package
+        run: yarn run build_sw
+      - name: Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v1
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: ${{ secrets.AWS_REGION }}
+      - name: Copy file to S3
+        run: |
+          aws s3 cp sw_webpush.min.js s3://${{ secrets.S3_BUCKET_PATH }} 

package.json

@@ -5,6 +5,7 @@
   "main": "clevertap.js",
   "scripts": {
     "build": "rollup --config rollup.config.js",
+    "build_sw": "rollup --config sw_rollup.config.js",
     "test": "eslint --fix test && jest",
     "test:coverage": "rm -rf coverage && jest --coverage"
   },

sw_rollup.config.js

@@ -0,0 +1,35 @@
+import resolve from '@rollup/plugin-node-resolve'
+import babel from '@rollup/plugin-babel'
+import replace from '@rollup/plugin-replace'
+import { eslint } from 'rollup-plugin-eslint'
+import { terser } from 'rollup-plugin-terser'
+import { version } from './package.json'
+import sourcemaps from 'rollup-plugin-sourcemaps'
+
+export default {
+  input: 'sw_webpush.js',
+  output: [
+    {
+      name: 'sw_webpush',
+      file: 'sw_webpush.min.js',
+      format: 'umd',
+      plugins: [terser()]
+    }
+  ],
+  plugins: [
+    resolve(),
+    sourcemaps(),
+    eslint({
+      fix: true,
+      throwOnError: true
+    }),
+    replace({
+      preventAssignment: true,
+      delimiters: ['', ''],
+      $$PACKAGE_VERSION$$: version
+    }),
+    babel({
+      babelHelpers: 'bundled'
+    })
+  ]
+}

sw_webpush.js

@@ -0,0 +1,136 @@
+/* eslint-disable handle-callback-err */
+/* eslint-disable no-use-before-define */
+/* eslint-disable no-undef */
+/**
+ * Author: Jashan Shewakramani
+ * Last updated: 27 June 2016
+ * Description: Service worker for handling chrome push notifications
+ *
+ * NOTES:
+ * -> "self" refers to the global ServiceWorker Object
+ * -> This script is registered to the browser from a.js
+ * -> We're only handling notification clicks; "delivered" is handled by NB
+ * -> Use Google's closure compiler on http://closure-compiler.appspot.com/ for minifying
+ */
+
+importScripts('https://d2r1yp2w7bby2u.cloudfront.net/js/localforage.min.js')
+// var CACHE_VERSION = 3;
+// var CURRENT_CACHES = {
+//     prefetch: 'prefetch-cache-v' + CACHE_VERSION
+// };
+
+if (typeof globalRedirectPath === 'undefined') {
+  // set up some variables we need gobally
+  var globalNotificationData
+  // global redirect path for backward compatibility
+  var globalRedirectPath // when showing thr url; we need to log to LC before opening up the deep link
+}
+
+self.addEventListener('install', function (event) {
+  // force this service worker to become the active service worker; removes any previous implementations or migrations
+  self.skipWaiting()
+  console.log('CT Service worker installed')
+})
+
+self.addEventListener('activate', function (event) {
+  console.log('CT Service worker activated')
+})
+
+self.addEventListener('push', function (event) {
+  console.log('Push event: ', event)
+  // get all the notification data
+  var notificationData = JSON.parse(event.data.text())
+  var title = notificationData.title
+  var notificationOptions = notificationData.notificationOptions
+  var data = notificationOptions.data
+  var key
+  if (typeof data !== 'undefined') {
+    key = data.wzrk_id
+  }
+  if (typeof key === 'undefined') {
+    key = title
+  }
+  localforage.setItem(key, event.data.text()).then(function (value) {
+    // console.log("persisted");
+  }).catch(function (err) {
+    // This code runs if there were any errors
+    console.log('Error in persisting')
+  })
+
+  // two global variables for backward compatibility
+  globalRedirectPath = notificationData.redirectPath
+  globalNotificationData = notificationData
+
+  var raiseNotificationViewedPath = notificationData.raiseNotificationViewedPath
+  if (typeof raiseNotificationViewedPath !== 'undefined') {
+    // raise notification viewed event
+    fetch(raiseNotificationViewedPath, { mode: 'no-cors' }) // ignore the response
+  }
+  event.waitUntil(self.registration.showNotification(title, notificationOptions))
+})
+
+function onClick (event, redirectPath, notificationData) {
+  var finalDeepLink = redirectPath
+  var silentRequest = true // are opening up a new window or sending a quiet get request from here?
+  if (event.action === 'action1') {
+    // button 1 was clicked
+    if (typeof notificationData.notificationOptions.actions[0].deepLink !== 'undefined') {
+      finalDeepLink += '&r=' + encodeURIComponent(notificationData.notificationOptions.actions[0].deepLink)
+      silentRequest = false
+    }
+    finalDeepLink += '&b=' + encodeURIComponent('button1')
+  } else if (event.action === 'action2') {
+    // the second button was clicked
+    if (typeof notificationData.notificationOptions.actions[1].deepLink !== 'undefined') {
+      finalDeepLink += '&r=' + encodeURIComponent(notificationData.notificationOptions.actions[1].deepLink)
+      silentRequest = false
+    }
+    finalDeepLink += '&b=' + encodeURIComponent('button2')
+  } else {
+    // general click
+    if (typeof notificationData.deepLink !== 'undefined') {
+      finalDeepLink += '&r=' + encodeURIComponent(notificationData.deepLink)
+      silentRequest = false
+    }
+
+    finalDeepLink += '&b=' + encodeURIComponent('button0')
+  }
+
+  if (silentRequest) {
+    fireSilentRequest(finalDeepLink)
+  } else {
+    clients.openWindow(finalDeepLink)
+  }
+  event.notification.close()
+}
+
+self.addEventListener('notificationclick', function (event) {
+  var notification = event.notification
+  var data = notification.data
+  var key
+  if (typeof data !== 'undefined' && data !== null) {
+    key = data.wzrk_id
+  }
+  if (typeof key === 'undefined') {
+    key = notification.title
+  }
+  var promise = localforage.getItem(key).then(function (value) {
+    var notificationData = JSON.parse(value)
+    var redirectPath = notificationData.redirectPath
+    onClick(event, redirectPath, notificationData)
+  }).catch(function (err) {
+    // This code runs if there were any errors
+    // onClick below for backward compatibility
+    onClick(event, globalRedirectPath, globalNotificationData)
+    console.log(err)
+  })
+  event.waitUntil(promise)
+})
+
+var fireSilentRequest = function (url) {
+  // add the silent parameter to the deeplink so that LC knows not to raise an error
+  url += '&s=true'
+
+  // use the fetch API to make a silent request (we don't care about the response here)
+  fetch(url, { mode: 'no-cors' })
+}