Update the test:setup script to configure firestore settings

README.md

@@ -66,21 +66,26 @@ $ yarn
 A production project is required to test the Firebase JS SDK. You can create a
 new project by visiting the [Firebase Console](https://console.firebase.google.com/).
 
+#### Firestore Support
+
+Visit the database section of the console and enable the Cloud Firestore Beta.
+You can select either of the default permissions settings as we will overwrite
+them below.
+
+#### Authentication Support
+
+Visit the authentication config in your project and enable the `Anonymous` 
+sign-in provider to complete your project config.
+
 #### Automated Setup
 
-Most of the test setup can be done by running the following command at the root
-of the package:
+The remainder of the test setup can be done by running the following command at
+the root of the package:
 
 ```bash
 yarn test:setup
 ```
 
-#### Authentication Support
-
-This is the only piece of config that must be done manually. Visit the 
-authentication config in your project and enable the `Anonymous` sign-in
-provider to complete your project config.
-
 ### Running the tests
 
 Each of the directories in the `integration` directory as well as the `packages`

config/firebase.json

@@ -1,5 +1,9 @@
 {
   "database": {
     "rules": "database.rules.json"
+  },
+  "firestore": {
+    "rules": "firestore.rules",
+    "indexes": "firestore.indexes.json"
   }
-}
+}

config/firestore.indexes.json

@@ -0,0 +1,3 @@
+{
+  "indexes": []
+}

config/firestore.rules

@@ -0,0 +1,7 @@
+service cloud.firestore {
+  match /databases/{database}/documents {
+    match /{document=**} {
+      allow read, write;
+    }
+  }
+}

packages/messaging/test/controller-deleteToken.test.ts

@@ -41,10 +41,7 @@ describe('Firebase Messaging > *Controller.deleteToken()', function() {
   });
 
   const configureRegistrationMocks = (ServiceClass, fakeReg) => {
-    sandbox.stub(
-      ServiceClass.prototype,
-      'getSWRegistration_'
-    ).callsFake(() => {
+    sandbox.stub(ServiceClass.prototype, 'getSWRegistration_').callsFake(() => {
       return fakeReg;
     });
   };
@@ -59,7 +56,7 @@ describe('Firebase Messaging > *Controller.deleteToken()', function() {
           }
 
           return getSubResult;
-        },
+        }
       }
     });
     return Promise.resolve(registration);
@@ -75,8 +72,8 @@ describe('Firebase Messaging > *Controller.deleteToken()', function() {
     }
     return Promise.all(deletePromises)
       .then(() => deleteDatabase(TokenManager.DB_NAME))
-      .then(() => globalMessagingService = null);
-  }
+      .then(() => (globalMessagingService = null));
+  };
 
   beforeEach(function() {
     return cleanUp();
@@ -88,8 +85,7 @@ describe('Firebase Messaging > *Controller.deleteToken()', function() {
 
   it('should handle no token to delete', function() {
     globalMessagingService = new WindowController(app);
-    return globalMessagingService.deleteToken()
-    .then(
+    return globalMessagingService.deleteToken().then(
       () => {
         throw new Error('Expected error to be thrown.');
       },
@@ -105,15 +101,15 @@ describe('Firebase Messaging > *Controller.deleteToken()', function() {
   it('should handle no registration', function() {
     configureRegistrationMocks(WindowController, Promise.resolve(null));
 
-    return dbTMHelper.addObjectToIndexDB(EXAMPLE_TOKEN_SAVE)
-    .then(() => {
+    return dbTMHelper.addObjectToIndexDB(EXAMPLE_TOKEN_SAVE).then(() => {
       globalMessagingService = new WindowController(app);
       return globalMessagingService.deleteToken(EXAMPLE_TOKEN_SAVE.fcmToken);
     });
   });
 
   it('should handle get subscription error', function() {
-    configureRegistrationMocks(WindowController,
+    configureRegistrationMocks(
+      WindowController,
       generateFakeReg(() => Promise.reject(new Error('Unknown error')))
     );
 
@@ -130,12 +126,14 @@ describe('Firebase Messaging > *Controller.deleteToken()', function() {
     );
   });
 
-  [WindowController, SWController].forEach((ServiceClass) => {
+  [WindowController, SWController].forEach(ServiceClass => {
     it(`should handle null getSubscription() ${ServiceClass.name}`, function() {
-      configureRegistrationMocks(ServiceClass, generateFakeReg(Promise.resolve(null)));
+      configureRegistrationMocks(
+        ServiceClass,
+        generateFakeReg(Promise.resolve(null))
+      );
 
-      return dbTMHelper.addObjectToIndexDB(EXAMPLE_TOKEN_SAVE)
-      .then(() => {
+      return dbTMHelper.addObjectToIndexDB(EXAMPLE_TOKEN_SAVE).then(() => {
         globalMessagingService = new ServiceClass(app);
         return globalMessagingService.deleteToken(EXAMPLE_TOKEN_SAVE.fcmToken);
       });
@@ -153,18 +151,18 @@ describe('Firebase Messaging > *Controller.deleteToken()', function() {
         generateFakeReg(Promise.resolve(fakeSubscription))
       );
 
-      return dbTMHelper.addObjectToIndexDB(EXAMPLE_TOKEN_SAVE)
-      .then(() => {
+      return dbTMHelper.addObjectToIndexDB(EXAMPLE_TOKEN_SAVE).then(() => {
         globalMessagingService = new ServiceClass(app);
-        return globalMessagingService.deleteToken(EXAMPLE_TOKEN_SAVE.fcmToken)
-        .then(
-          () => {
-            throw new Error('Expected this to reject');
-          },
-          err => {
-            assert.equal(errorMsg, err.message);
-          }
-        );
+        return globalMessagingService
+          .deleteToken(EXAMPLE_TOKEN_SAVE.fcmToken)
+          .then(
+            () => {
+              throw new Error('Expected this to reject');
+            },
+            err => {
+              assert.equal(errorMsg, err.message);
+            }
+          );
       });
     });
 
@@ -179,8 +177,7 @@ describe('Firebase Messaging > *Controller.deleteToken()', function() {
         generateFakeReg(Promise.resolve(fakeSubscription))
       );
 
-      return dbTMHelper.addObjectToIndexDB(EXAMPLE_TOKEN_SAVE)
-      .then(() => {
+      return dbTMHelper.addObjectToIndexDB(EXAMPLE_TOKEN_SAVE).then(() => {
         globalMessagingService = new ServiceClass(app);
         return globalMessagingService.deleteToken(EXAMPLE_TOKEN_SAVE.fcmToken);
       });

packages/messaging/test/get-sw-reg.test.ts

@@ -32,7 +32,8 @@ describe('Firebase Messaging > *Controller.getSWReg_()', function() {
   const sandbox = sinon.sandbox.create();
 
   const mockWindowRegistration = registration => {
-    sandbox.stub(navigator.serviceWorker, 'register')
+    sandbox
+      .stub(navigator.serviceWorker, 'register')
       .callsFake(() => Promise.resolve(registration));
   };
 
@@ -42,7 +43,7 @@ describe('Firebase Messaging > *Controller.getSWReg_()', function() {
 
   beforeEach(function() {
     return cleanUp();
-  })
+  });
 
   after(function() {
     return cleanUp();
@@ -111,7 +112,10 @@ describe('Firebase Messaging > *Controller.getSWReg_()', function() {
 
   it('should make registration error available to developer', function() {
     const errorMsg = 'test-reg-error-1234567890';
-    const mockRegisterMethod = sandbox.stub(navigator.serviceWorker, 'register');
+    const mockRegisterMethod = sandbox.stub(
+      navigator.serviceWorker,
+      'register'
+    );
     mockRegisterMethod.callsFake(() => Promise.reject(new Error(errorMsg)));
 
     const messagingService = new WindowController(app);

packages/messaging/test/get-token.test.ts

@@ -38,11 +38,9 @@ describe('Firebase Messaging > *Controller.getToken()', function() {
 
   const mockGetReg = fakeReg => {
     servicesToTest.forEach(serviceClass => {
-      sandbox.stub(
-        serviceClass.prototype,
-        'getSWRegistration_'
-      )
-      .callsFake(() => fakeReg);
+      sandbox
+        .stub(serviceClass.prototype, 'getSWRegistration_')
+        .callsFake(() => fakeReg);
     });
   };
 
@@ -52,18 +50,16 @@ describe('Firebase Messaging > *Controller.getToken()', function() {
 
   beforeEach(function() {
     return cleanUp();
-  })
+  });
 
   after(function() {
     return cleanUp();
   });
 
   it('should throw on unsupported browsers', function() {
-    sandbox.stub(
-      WindowController.prototype,
-      'isSupported_'
-    )
-    .callsFake(() => false);
+    sandbox
+      .stub(WindowController.prototype, 'isSupported_')
+      .callsFake(() => false);
 
     const messagingService = new WindowController(app);
     return messagingService.getToken().then(
@@ -77,14 +73,13 @@ describe('Firebase Messaging > *Controller.getToken()', function() {
   });
 
   it('should handle a failure to get registration', function() {
-    sandbox.stub(
-      ControllerInterface.prototype,
-      'getNotificationPermission_'
-    )
-    .callsFake(() => NotificationPermission.granted);
+    sandbox
+      .stub(ControllerInterface.prototype, 'getNotificationPermission_')
+      .callsFake(() => NotificationPermission.granted);
 
-    sandbox.stub(navigator.serviceWorker, 'register')
-    .callsFake(() => Promise.reject('No Service Worker'));
+    sandbox
+      .stub(navigator.serviceWorker, 'register')
+      .callsFake(() => Promise.reject('No Service Worker'));
 
     const messagingService = new WindowController(app);
     return messagingService
@@ -144,16 +139,15 @@ describe('Firebase Messaging > *Controller.getToken()', function() {
   it('should get saved token', function() {
     const registration = makeFakeSWReg();
 
-    sandbox.stub(
-      ControllerInterface.prototype,
-      'getNotificationPermission_'
-    )
-    .callsFake(() => NotificationPermission.granted);
+    sandbox
+      .stub(ControllerInterface.prototype, 'getNotificationPermission_')
+      .callsFake(() => NotificationPermission.granted);
 
     mockGetReg(Promise.resolve(registration));
 
-    sandbox.stub(TokenManager.prototype, 'getSavedToken')
-    .callsFake(() => Promise.resolve(EXAMPLE_FCM_TOKEN));
+    sandbox
+      .stub(TokenManager.prototype, 'getSavedToken')
+      .callsFake(() => Promise.resolve(EXAMPLE_FCM_TOKEN));
 
     return Promise.all(
       servicesToTest.map(ServiceClass => {
@@ -168,19 +162,19 @@ describe('Firebase Messaging > *Controller.getToken()', function() {
   it('should get a new token', function() {
     const registration = makeFakeSWReg();
 
-    sandbox.stub(
-      ControllerInterface.prototype,
-      'getNotificationPermission_'
-    )
-    .callsFake(() => NotificationPermission.granted);
+    sandbox
+      .stub(ControllerInterface.prototype, 'getNotificationPermission_')
+      .callsFake(() => NotificationPermission.granted);
 
     mockGetReg(Promise.resolve(registration));
 
-    sandbox.stub(TokenManager.prototype, 'getSavedToken')
-    .callsFake(() => Promise.resolve(null));
+    sandbox
+      .stub(TokenManager.prototype, 'getSavedToken')
+      .callsFake(() => Promise.resolve(null));
 
-    sandbox.stub(TokenManager.prototype, 'createToken')
-    .callsFake(() => Promise.resolve(EXAMPLE_FCM_TOKEN));
+    sandbox
+      .stub(TokenManager.prototype, 'createToken')
+      .callsFake(() => Promise.resolve(EXAMPLE_FCM_TOKEN));
 
     return Promise.all(
       servicesToTest.map(ServiceClass => {

packages/messaging/test/testing-utils/db-helper.ts

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-const deleteDatabase = (dbName) => {
+const deleteDatabase = dbName => {
   return new Promise((resolve, reject) => {
     const request = indexedDB.deleteDatabase(dbName);
     request.onerror = event => {
@@ -26,5 +26,5 @@ const deleteDatabase = (dbName) => {
       console.warn('deleteDb blocked.');
     };
   });
-}
+};
 export { deleteDatabase };

packages/messaging/test/testing-utils/db-token-manager.ts

@@ -80,5 +80,5 @@ export default {
         };
       });
     });
-  },
+  }
 };

packages/messaging/test/tokenDetailsModel-deleteToken.test.ts

@@ -43,8 +43,8 @@ describe('Firebase Messaging > TokenDetailsModel.deleteToken()', function() {
 
     return Promise.all(promises)
       .then(() => deleteDatabase(TokenDetailsModel.dbName))
-      .then(() => globalTokenModel = null);
-  }
+      .then(() => (globalTokenModel = null));
+  };
 
   beforeEach(function() {
     return cleanUp();
@@ -56,8 +56,7 @@ describe('Firebase Messaging > TokenDetailsModel.deleteToken()', function() {
 
   it('should handle no input', function() {
     globalTokenModel = new TokenDetailsModel();
-    return globalTokenModel.deleteToken()
-    .then(
+    return globalTokenModel.deleteToken().then(
       () => {
         throw new Error('Expected this to throw an error due to no token');
       },
@@ -72,8 +71,7 @@ describe('Firebase Messaging > TokenDetailsModel.deleteToken()', function() {
 
   it('should handle empty string', function() {
     globalTokenModel = new TokenDetailsModel();
-    return globalTokenModel.deleteToken('')
-    .then(
+    return globalTokenModel.deleteToken('').then(
       () => {
         throw new Error('Expected this to throw an error due to no token');
       },
@@ -115,7 +113,9 @@ describe('Firebase Messaging > TokenDetailsModel.deleteToken()', function() {
           assert.equal(details[keyName], EXAMPLE_INPUT[keyName]);
         });
 
-        return globalTokenModel.getTokenDetailsFromToken(EXAMPLE_INPUT.fcmToken);
+        return globalTokenModel.getTokenDetailsFromToken(
+          EXAMPLE_INPUT.fcmToken
+        );
       })
       .then(tokenDetails => {
         assert.equal(null, tokenDetails);