Exit early for unsupported browsers

Removes the Promise polyfill for IE11 and instead exits the SDK early if the browser environment is not one known to support push. This is something I think we should have been doing from the beginning, instead of checking whether push notifications were supported inside individual methods.
OneSignal · Jan 26, 2017 · d790181 · d790181
1 parent 373e2b2
commit d790181
Show file tree

Hide file tree

Showing 11 changed files with 33 additions and 54 deletions.
diff --git a/gulpfile.js b/gulpfile.js
@@ -10,6 +10,7 @@ var oneSignalProjectRoot = HOME_PATH + "/code/OneSignal";
 var oneSignalSdksDirName = 'sdks';
 var publicAssetsTargetPath = oneSignalProjectRoot + "/public/";
 var sdksTargetPath = publicAssetsTargetPath + oneSignalSdksDirName;
+var IS_ES5 = process.argv.indexOf('--es5') >= 0;
 var IS_ES6 = process.argv.indexOf('--es6') >= 0;
 var IS_PROD = process.argv.indexOf('--prod') >= 0 || process.argv.indexOf('--production') >= 0 || false;
 var IS_STAGING = process.argv.indexOf('--staging') >= 0 || false;
@@ -51,7 +52,8 @@ gulp.task("transpile-javascript", shell.task([
   (IS_TEST ? '--test' : '') + ' ' +
   (IS_STAGING ? '--staging' : '') + ' ' +
   (SIZE_STATS ? '--stats' : '') +
-  (IS_ES6 ? '--es6' : '')
+  (IS_ES6 ? '--es6' : '') +
+  (IS_ES5 ? '--es5' : '')
 ]));
 
 function copyFile(prefix) {

diff --git a/src/OneSignal.ts b/src/OneSignal.ts
@@ -9,7 +9,7 @@ import * as Cookie from 'js-cookie';
 import Database from './Database';
 import * as Browser from 'bowser';
 import {
-  isPushNotificationsSupported, logMethodCall, isValidEmail, awaitOneSignalInitAndSupported, getConsoleStyle,
+  logMethodCall, isValidEmail, awaitOneSignalInitAndSupported, getConsoleStyle,
   contains, unsubscribeFromPush, decodeHtmlEntities, getUrlQueryParam, executeAndTimeoutPromiseAfter,
   wipeLocalIndexedDb, prepareEmailForHashing, executeCallback, once, md5, sha1, awaitSdkEvent
 } from './utils';
@@ -106,7 +106,7 @@ export default class OneSignal {
    */
   static isPushNotificationsSupported() {
     logMethodCall('isPushNotificationsSupported');
-    return isPushNotificationsSupported();
+    return true;
   }
 
   /**
@@ -128,11 +128,6 @@ export default class OneSignal {
       path: '/'
     }, options);
 
-    if (!isPushNotificationsSupported()) {
-      log.warn('OneSignal: Push notifications are not supported.');
-      return;
-    }
-
     if (Browser.safari && !OneSignal.config.safari_web_id) {
       log.warn("OneSignal: Required parameter %csafari_web_id", getConsoleStyle('code'), 'was not passed to OneSignal.init(), skipping SDK initialization.');
       return;
@@ -310,10 +305,6 @@ export default class OneSignal {
    * @PublicApi
    */
   static registerForPushNotifications(options) {
-    if (!isPushNotificationsSupported()) {
-      log.debug('OneSignal: Push notifications are not supported.');
-    }
-
     // WARNING: Do NOT add callbacks that have to fire to get from here to window.open in _sessionInit.
     //          Otherwise the pop-up to ask for push permission on HTTP connections will be blocked by Chrome.
     function __registerForPushNotifications() {

diff --git a/src/bell/Bell.ts b/src/bell/Bell.ts
@@ -1,5 +1,5 @@
 import {
-  isPushNotificationsSupported, removeDomElement, addDomElement, addCssClass, delay, nothing, contains,
+  removeDomElement, addDomElement, addCssClass, delay, nothing, contains,
   decodeHtmlEntities, once
 } from '../utils';
 import * as log from 'loglevel';
@@ -361,9 +361,6 @@ export default class Bell {
   }
 
   create() {
-    if (!isPushNotificationsSupported())
-      return;
-
     if (!this.options.enable)
       return;
 

diff --git a/src/entry.ts b/src/entry.ts
@@ -1,28 +1,29 @@
-require('es6-promise').polyfill();
-
 import Environment from './Environment';
-import { getSdkLoadCount, incrementSdkLoadCount } from './utils';
+import { getSdkLoadCount, incrementSdkLoadCount, isPushNotificationsSupported } from './utils';
 import * as log from 'loglevel';
 
-
 if (Environment.isBrowser()) {
-  incrementSdkLoadCount();
-  if (getSdkLoadCount() > 1) {
-    log.warn(`OneSignal: The web push SDK is included more than once. For optimal performance, please include our ` +
-      `SDK only once on your page.`);
-    log.debug(`OneSignal: Exiting from SDK initialization to prevent double-initialization errors. ` +
-      `Occurred ${getSdkLoadCount()} times.`);
-  } else {
-    // We're running in the host page, iFrame of the host page, or popup window
-    // Load OneSignal's web SDK
-    if (typeof OneSignal !== "undefined")
-      var predefinedOneSignalPushes = OneSignal;
+  if (isPushNotificationsSupported()) {
+    incrementSdkLoadCount();
+    if (getSdkLoadCount() > 1) {
+      log.warn(`OneSignal: The web push SDK is included more than once. For optimal performance, please include our ` +
+               `SDK only once on your page.`);
+      log.debug(`OneSignal: Exiting from SDK initialization to prevent double-initialization errors. ` +
+                `Occurred ${getSdkLoadCount()} times.`);
+    } else {
+      // We're running in the host page, iFrame of the host page, or popup window
+      // Load OneSignal's web SDK
+      if (typeof OneSignal !== "undefined")
+        var predefinedOneSignalPushes = OneSignal;
 
-    require("expose?OneSignal!./OneSignal.ts");
+      require("expose?OneSignal!./OneSignal.ts");
 
-    if (predefinedOneSignalPushes)
-      for (var i = 0; i < predefinedOneSignalPushes.length; i++)
-        OneSignal.push(predefinedOneSignalPushes[i]);
+      if (predefinedOneSignalPushes)
+        for (var i = 0; i < predefinedOneSignalPushes.length; i++)
+          OneSignal.push(predefinedOneSignalPushes[i]);
+    }
+  } else {
+    log.debug('OneSignal: Push notifications are not supported. The SDK will not be initialized.');
   }
 }
 else if (Environment.isServiceWorker()) {

diff --git a/src/helpers/EventHelper.ts b/src/helpers/EventHelper.ts
@@ -6,7 +6,7 @@ import Database from '../Database';
 import * as Browser from 'bowser';
 import {
   getConsoleStyle, contains, normalizeSubdomain, getDeviceTypeForBrowser, capitalize,
-  isPushNotificationsSupported, getUrlQueryParam, executeAndTimeoutPromiseAfter, wipeLocalIndexedDb,
+  getUrlQueryParam, executeAndTimeoutPromiseAfter, wipeLocalIndexedDb,
   unsubscribeFromPush, decodeHtmlEntities, logMethodCall
 } from '../utils';
 import MainHelper from "./MainHelper";

diff --git a/src/helpers/HttpHelper.ts b/src/helpers/HttpHelper.ts
@@ -8,7 +8,7 @@ import Database from '../Database';
 import * as Browser from 'bowser';
 import {
   getConsoleStyle, contains, normalizeSubdomain, getDeviceTypeForBrowser, capitalize,
-  isPushNotificationsSupported, getUrlQueryParam, executeAndTimeoutPromiseAfter, wipeLocalIndexedDb, unsubscribeFromPush
+  getUrlQueryParam, executeAndTimeoutPromiseAfter, wipeLocalIndexedDb, unsubscribeFromPush
 } from '../utils';
 import * as objectAssign from 'object-assign';
 import * as EventEmitter from 'wolfy87-eventemitter';
@@ -47,11 +47,6 @@ export default class HttpHelper {
   static initHttp(options) {
     log.debug(`Called %cinitHttp(${JSON.stringify(options, null, 4)})`, getConsoleStyle('code'));
 
-    if (!isPushNotificationsSupported()) {
-      log.warn('OneSignal: Push notifications are not supported.');
-      return;
-    }
-
     ServiceWorkerHelper.applyServiceWorkerEnvPrefixes();
 
     var creator = window.opener || window.parent;

diff --git a/src/helpers/InitHelper.ts b/src/helpers/InitHelper.ts
@@ -8,7 +8,7 @@ import Database from '../Database';
 import * as Browser from 'bowser';
 import {
   getConsoleStyle, contains, normalizeSubdomain, getDeviceTypeForBrowser, capitalize, once,
-  isPushNotificationsSupported, getUrlQueryParam, wipeLocalIndexedDb, unsubscribeFromPush
+  getUrlQueryParam, wipeLocalIndexedDb, unsubscribeFromPush
 } from '../utils';
 import * as objectAssign from 'object-assign';
 import * as EventEmitter from 'wolfy87-eventemitter';

diff --git a/src/helpers/ServiceWorkerHelper.ts b/src/helpers/ServiceWorkerHelper.ts
@@ -7,8 +7,7 @@ import Event from "../Event";
 import Database from '../Database';
 import * as Browser from 'bowser';
 import {
-  getConsoleStyle, contains, normalizeSubdomain, getDeviceTypeForBrowser, capitalize,
-  isPushNotificationsSupported
+  getConsoleStyle, contains, normalizeSubdomain, getDeviceTypeForBrowser, capitalize
 } from '../utils';
 import * as objectAssign from 'object-assign';
 import * as EventEmitter from 'wolfy87-eventemitter';
@@ -152,9 +151,6 @@ export default class ServiceWorkerHelper {
   }
 
   static isServiceWorkerActive(callback?) {
-    if (!isPushNotificationsSupported()) {
-      return;
-    }
     if (!('serviceWorker' in navigator)) {
       return false;
     }

diff --git a/src/service-worker/ServiceWorker.ts b/src/service-worker/ServiceWorker.ts
@@ -4,7 +4,7 @@ import Environment from '../Environment'
 import OneSignalApi from '../OneSignalApi';
 import * as log from 'loglevel';
 import Database from '../Database';
-import { isPushNotificationsSupported, getConsoleStyle, contains, trimUndefined, getDeviceTypeForBrowser, substringAfter, isValidUuid, capitalize } from '../utils';
+import { getConsoleStyle, contains, trimUndefined, getDeviceTypeForBrowser, substringAfter, isValidUuid, capitalize } from '../utils';
 import * as objectAssign from 'object-assign';
 import * as swivel from 'swivel';
 import * as Browser from 'bowser';

diff --git a/src/utils.ts b/src/utils.ts
@@ -77,10 +77,6 @@ export function removeDomElement(selector) {
  */
 export function awaitOneSignalInitAndSupported() {
   return new Promise((resolve, reject) => {
-    if (!isPushNotificationsSupported()) {
-      throw new PushNotSupportedError();
-    }
-
     if (!OneSignal.initialized) {
       OneSignal.once(OneSignal.EVENTS.SDK_INITIALIZED, resolve);
     } else {

diff --git a/webpack.config.js b/webpack.config.js
@@ -5,6 +5,7 @@ var BundleAnalyzerPlugin = require('webpack-bundle-analyzer').BundleAnalyzerPlug
 
 var IS_PROD = process.argv.indexOf('--prod') >= 0 || process.argv.indexOf('--production') >= 0;
 var IS_ES6 = process.argv.indexOf('--es6') >= 0;
+var IS_ES5 = process.argv.indexOf('--es5') >= 0;
 var IS_STAGING = process.argv.indexOf('--staging') >= 0;
 var IS_TEST = process.argv.indexOf('--test') >= 0;
 var IS_DEV = !IS_PROD && !IS_STAGING;
@@ -143,7 +144,7 @@ if (SIZE_STATS) {
 }
 
 function getAwesomeTypescriptLoaderTsconfigPath() {
-  if (IS_DEV || IS_ES6) {
+  if ((IS_DEV || IS_ES6) && !IS_ES5) {
     return '?tsconfig=./tsconfig.es6.json';
   } else {
     return '?tsconfig=./tsconfig.es5.json';