Separate window/sw context check

Deprecating #4446 in favor of this PR

Author: zwu52

packages-exp/messaging-exp/src/api.ts

@@ -15,19 +15,15 @@
  * limitations under the License.
  */
 
-import {
-  FirebaseMessaging,
-  MessagePayload,
-  NextFn,
-  Observer,
-  Unsubscribe
-} from './interfaces/public-types';
+import { FirebaseApp, _getProvider } from '@firebase/app-exp';
+import { FirebaseMessaging, MessagePayload } from './interfaces/public-types';
+import { NextFn, Observer, Unsubscribe } from '@firebase/util';
 
 import { MessagingService } from './messaging-service';
 import { Provider } from '@firebase/component';
 import { deleteToken as _deleteToken } from './api/deleteToken';
-import { _getProvider, FirebaseApp } from '@firebase/app-exp';
 import { getToken as _getToken } from './api/getToken';
+import { isSupported as _isSupported } from './api/isSupported';
 import { onBackgroundMessage as _onBackgroundMessage } from './api/onBackgroundMessage';
 import { onMessage as _onMessage } from './api/onMessage';
 import { getModularInstance } from '@firebase/util';
@@ -131,7 +127,7 @@ export function onMessage(
  *
  * @returns To stop listening for messages execute this returned function
  *
- * make it internal to hide it from the browser entrypoint
+ * make it internal to hide it from the browser entry point.
  * @internal
  */
 export function onBackgroundMessage(
@@ -141,3 +137,10 @@ export function onBackgroundMessage(
   messaging = getModularInstance(messaging);
   return _onBackgroundMessage(messaging as MessagingService, nextOrObserver);
 }
+
+/**
+ * Checks if the current browser is supported.
+ */
+export async function isSupported(): Promise<boolean> {
+  return _isSupported();
+}

packages-exp/messaging-exp/src/api/isSupported.ts

@@ -0,0 +1,28 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { isSwSupported, isWindowSupported } from '../helpers/check-browser-env';
+
+export async function isSupported(): Promise<boolean> {
+  if (self && 'ServiceWorkerGlobalScope' in self) {
+    // Running in ServiceWorker context
+    return isWindowSupported();
+  } else {
+    // Assume we are in the window context.
+    return isSwSupported();
+  }
+}

packages-exp/messaging-exp/src/helpers/isSupported.ts renamed to packages-exp/messaging-exp/src/helpers/check-browser-env.ts

@@ -15,20 +15,10 @@
  * limitations under the License.
  */
 
-export function isSupported(): boolean {
-  if (self && 'ServiceWorkerGlobalScope' in self) {
-    // Running in ServiceWorker context
-    return isSWControllerSupported();
-  } else {
-    // Assume we are in the window context.
-    return isWindowControllerSupported();
-  }
-}
-
 /**
  * Checks to see if the required APIs exist.
  */
-function isWindowControllerSupported(): boolean {
+export function isWindowSupported(): boolean {
   return (
     'indexedDB' in window &&
     indexedDB !== null &&
@@ -45,7 +35,7 @@ function isWindowControllerSupported(): boolean {
 /**
  * Checks to see if the required APIs exist within SW Context.
  */
-function isSWControllerSupported(): boolean {
+export function isSwSupported(): boolean {
   return (
     'indexedDB' in self &&
     indexedDB !== null &&

packages-exp/messaging-exp/src/helpers/register.ts

@@ -21,19 +21,13 @@ import {
   ComponentType,
   InstanceFactory
 } from '@firebase/component';
-import { ERROR_FACTORY, ErrorCode } from '../util/errors';
 
 import { MessagingService } from '../messaging-service';
 import { _registerComponent } from '@firebase/app-exp';
-import { isSupported } from './isSupported';
 
 const messagingFactory: InstanceFactory<'messaging-exp'> = (
   container: ComponentContainer
 ) => {
-  if (!isSupported()) {
-    throw ERROR_FACTORY.create(ErrorCode.UNSUPPORTED_BROWSER);
-  }
-
   return new MessagingService(
     container.getProvider('app-exp').getImmediate(),
     container.getProvider('installations-exp-internal').getImmediate(),

packages-exp/messaging-exp/src/index.sw.ts

@@ -15,16 +15,24 @@
  * limitations under the License.
  */
 
+import '@firebase/installations-exp';
+
+import { ERROR_FACTORY, ErrorCode } from './util/errors';
+
 import { FirebaseMessaging } from './interfaces/public-types';
+import { isSwSupported } from './helpers/check-browser-env';
 import { registerMessaging } from './helpers/register';
-import '@firebase/installations-exp';
 
-export { onBackgroundMessage, getMessaging } from './api';
+export { onBackgroundMessage, getMessaging, isSupported } from './api';
 
 declare module '@firebase/component' {
   interface NameServiceMapping {
     'messaging-exp': FirebaseMessaging;
   }
 }
 
+if (!isSwSupported()) {
+  throw ERROR_FACTORY.create(ErrorCode.UNSUPPORTED_BROWSER);
+}
+
 registerMessaging();

packages-exp/messaging-exp/src/index.ts

@@ -15,16 +15,21 @@
  * limitations under the License.
  */
 
+import '@firebase/installations-exp';
+
+import { ERROR_FACTORY, ErrorCode } from './util/errors';
+
 import { FirebaseMessaging } from './interfaces/public-types';
+import { isWindowSupported } from './helpers/check-browser-env';
 import { registerMessaging } from './helpers/register';
-import '@firebase/installations-exp';
 
 export {
   getToken,
   deleteToken,
   onMessage,
   getMessaging,
-  onBackgroundMessage
+  onBackgroundMessage,
+  isSupported
 } from './api';
 export * from './interfaces/public-types';
 
@@ -34,4 +39,8 @@ declare module '@firebase/component' {
   }
 }
 
+if (!isWindowSupported()) {
+  throw ERROR_FACTORY.create(ErrorCode.UNSUPPORTED_BROWSER);
+}
+
 registerMessaging();