v1.2.0 (#123)

* feat(core): support command namespacing with `commandNames` option - #122
* feat(tests): add tests for `commandNames` option - #122
* feat(commands): ability to check auth user from cy command (`cy.getAuthUser`) - #15
* fix(ci): remove duplicate build happening in size check step
* chore(tests): add retries to firestore get action test to solve flakiness in CI

Author: prescottprue

.github/workflows/publish.yml

@@ -14,37 +14,42 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v2
 
-      - name: Check package version
-        uses: technote-space/package-version-check-action@v1
-        with:
-          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+      - name: Check if version has been updated
+        id: check
+        uses: EndBug/version-check@v1
 
       - name: Use Node 12
+        if: steps.check.outputs.changed == 'true'
         uses: actions/setup-node@v1
         with:
           node-version: 12
           registry-url: https://registry.npmjs.org/
 
       - name: Get yarn cache
+        if: steps.check.outputs.changed == 'true'
         id: yarn-cache
         run: echo "::set-output name=dir::$(yarn cache dir)"
 
       - uses: actions/cache@v1
+        if: steps.check.outputs.changed == 'true'
         with:
           path: ${{ steps.yarn-cache.outputs.dir }}
           key: ${{ runner.os }}-yarn-${{ hashFiles('yarn.lock') }}
 
       - name: Install Dependencies
+        if: steps.check.outputs.changed == 'true'
         env:
           CI: true
         run: yarn install --frozen-lockfile
 
       - name: Check For Lint
+        if: steps.check.outputs.changed == 'true'
         env:
           CI: true
         run: yarn lint
 
       - name: Expose Test Environment Variables
+        if: steps.check.outputs.changed == 'true'
         env:
           SERVICE_ACCOUNT: ${{ secrets.SERVICE_ACCOUNT }}
           GITHUB_HEAD_REF: ${{ github.head_ref }}
@@ -56,12 +61,14 @@ jobs:
           echo "::set-env name=GOOGLE_APPLICATION_CREDENTIALS::$HOME/serviceAccount.json"
 
       - name: Run Unit Tests + Coverage
+        if: steps.check.outputs.changed == 'true'
         env:
           CI: true
           CODE_CLIMATE: ${{ secrets.CODE_CLIMATE }}
-        run: yarn test:cov && yarn codecov
+        run: yarn test:cov
 
       - name: Run Build
+        if: steps.check.outputs.changed == 'true'
         run: yarn build
 
       # Skipped since yarn isn't supported
@@ -73,9 +80,11 @@ jobs:
       #     github_token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Size Check
-        run: yarn size
+        if: steps.check.outputs.changed == 'true'
+        run: $(yarn bin)/size-limit
 
       - name: Publish
+        if: steps.check.outputs.changed == 'true'
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
           GITHUB_REF: ${{ github.ref }}
@@ -85,14 +94,14 @@ jobs:
           npm publish $PUBLISH_FLAG
 
       - name: Archive Build Artifact
+        if: steps.check.outputs.changed == 'true'
         uses: actions/upload-artifact@master
-        if: success()
         with:
           name: build
           path: lib
 
       - name: Upload Coverage
-        if: success()
+        if: steps.check.outputs.changed == 'true'
         env:
           CI: true
           CODE_COV: ${{ secrets.CODE_COV }}

.github/workflows/verify.yml

@@ -63,7 +63,7 @@ jobs:
       #     github_token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Size Check
-        run: yarn size
+        run: $(yarn bin)/size-limit
 
       - name: Upload Coverage
         if: success()

README.md

@@ -437,6 +437,26 @@ NOTE: You can also use `firebase serve`:
 1. Run `firebase login:ci` to generate a CI token for `firebase-tools` (this will give your `cy.callRtdb` and `cy.callFirestore` commands admin access to the DB)
 1. Set `FIREBASE_TOKEN` within CI environment variables
 
+### Changing Custom Command Names
+
+Pass `commandNames` in the `options` object to `attachCustomCommands`:
+
+```js
+const options = {
+  // Key is current command name, value is new command name
+  commandNames: {
+    login: 'newNameForLogin',
+    logout: 'newNameForLogout',
+    callRtdb: 'newNameForCallRtdb',
+    callFirestore: 'newNameForCallFirestore',
+    getAuthUser: 'newNameForGetAuthUser',
+  }
+}
+attachCustomCommands({ Cypress, cy, firebase }, options);
+```
+
+For more information about this feature, please see the [original feature request](https://github.com/prescottprue/cypress-firebase/issues/15).
+
 ### Webpack File Preprocessing
 
 If you are using a file preprocessor which is building for the browser environment, such as Webpack, you will need to make sure usage of `fs` is handled since it is used within the cypress-firebase plugin. To do this with webpack, add the following to your config:

examples/basic/package.json

@@ -10,8 +10,8 @@
     "lint": "eslint src/**.js",
     "lint:fix": "yarn lint --fix",
     "emulate": "firebase emulators:start --only database,firestore",
-    "test": "cross-env CYPRESS_baseUrl=http://localhost:3000 cypress run",
-    "test:open": "cross-env CYPRESS_baseUrl=http://localhost:3000 cypress open",
+    "test": "cross-env GCLOUD_PROJECT=redux-firebasev3 CYPRESS_baseUrl=http://localhost:3000 cypress run",
+    "test:open": "cross-env GCLOUD_PROJECT=redux-firebasev3 CYPRESS_baseUrl=http://localhost:3000 cypress open",
     "test:emulate": "cross-env FIREBASE_DATABASE_EMULATOR_HOST=\"localhost:$(cat firebase.json | jq .emulators.database.port)\" FIRESTORE_EMULATOR_HOST=\"localhost:$(cat firebase.json | jq .emulators.firestore.port)\" yarn test:open"
   },
   "dependencies": {
@@ -22,7 +22,7 @@
   },
   "devDependencies": {
     "cross-env": "^7.0.2",
-    "cypress": "^4.4.1",
+    "cypress": "^4.5.0",
     "cypress-firebase": "^1.1.0",
     "eslint-plugin-chai-friendly": "^0.5.0",
     "eslint-plugin-cypress": "^2.10.3",

examples/basic/yarn.lock

@@ -4843,10 +4843,10 @@ cypress-firebase@^1.1.0:
   resolved "https://registry.yarnpkg.com/cypress-firebase/-/cypress-firebase-1.1.0.tgz#87a2dcfedd740270a7b7020982d240ee88f2b922"
   integrity sha512-TWBy7Syi2xWxHswJPP5ys+iGGF1hHOE0b6arnQvMplCrkoj0YUMTe3fpyLiFlYsqYLzczEYTX6gd4aploMI8oA==
 
-cypress@^4.4.1:
-  version "4.4.1"
-  resolved "https://registry.yarnpkg.com/cypress/-/cypress-4.4.1.tgz#f5aa1aa5f328f1299bff328103f7cbad89e80f29"
-  integrity sha512-LcskZ/PXRG9XTlEeeenKqz/KddT1x+7O7dqXsdKWPII01LxLNmNHIvHnlUqApchVbinJ5vir6J255CkELSeL0A==
+cypress@^4.5.0:
+  version "4.5.0"
+  resolved "https://registry.yarnpkg.com/cypress/-/cypress-4.5.0.tgz#01940d085f6429cec3c87d290daa47bb976a7c7b"
+  integrity sha512-2A4g5FW5d2fHzq8HKUGAMVTnW6P8nlWYQALiCoGN4bqBLvgwhYM/oG9oKc2CS6LnvgHFiKivKzpm9sfk3uU3zQ==
   dependencies:
     "@cypress/listr-verbose-renderer" "0.4.1"
     "@cypress/request" "2.88.5"

examples/react-redux-firebase/package.json

@@ -8,9 +8,9 @@
     "eject": "react-scripts eject",
     "lint": "eslint src/**.js",
     "lint:fix": "yarn lint --fix",
-    "test": "cross-env CYPRESS_baseUrl=http://localhost:3000 cypress run",
-    "test:open": "cross-env CYPRESS_baseUrl=http://localhost:3000 cypress open",
-    "test:emulate": "cross-env FIREBASE_DATABASE_EMULATOR_HOST=\"localhost:$(cat firebase.json | jq .emulators.database.port)\" FIRESTORE_EMULATOR_HOST=\"localhost:$(cat firebase.json | jq .emulators.firestore.port)\" yarn test:open"
+    "test": "cross-env GCLOUD_PROJECT=redux-firebasev3 CYPRESS_baseUrl=http://localhost:3000 cypress run",
+    "test:open": "cross-env GCLOUD_PROJECT=redux-firebasev3 CYPRESS_baseUrl=http://localhost:3000 cypress open",
+    "test:emulate": "cross-env GCLOUD_PROJECT=redux-firebasev3 FIREBASE_DATABASE_EMULATOR_HOST=\"localhost:$(cat firebase.json | jq .emulators.database.port)\" FIRESTORE_EMULATOR_HOST=\"localhost:$(cat firebase.json | jq .emulators.firestore.port)\" yarn test:open"
   },
   "dependencies": {
     "firebase": "^7.14.1",
@@ -22,7 +22,7 @@
     "redux": "^4.0.1"
   },
   "devDependencies": {
-    "cross-env": "^5.2.0",
+    "cross-env": "^7.0.2",
     "cypress": "^3.1.5",
     "cypress-firebase": "*",
     "eslint-plugin-cypress": "^2.10.3",

examples/react-redux-firebase/yarn.lock

@@ -4552,13 +4552,20 @@ create-hmac@^1.1.0, create-hmac@^1.1.2, create-hmac@^1.1.4:
     safe-buffer "^5.0.1"
     sha.js "^2.4.8"
 
-cross-env@^5.1.3, cross-env@^5.2.0:
+cross-env@^5.1.3:
   version "5.2.0"
   resolved "https://registry.yarnpkg.com/cross-env/-/cross-env-5.2.0.tgz#6ecd4c015d5773e614039ee529076669b9d126f2"
   dependencies:
     cross-spawn "^6.0.5"
     is-windows "^1.0.0"
 
+cross-env@^7.0.2:
+  version "7.0.2"
+  resolved "https://registry.yarnpkg.com/cross-env/-/cross-env-7.0.2.tgz#bd5ed31339a93a3418ac4f3ca9ca3403082ae5f9"
+  integrity sha512-KZP/bMEOJEDCkDQAyRhu3RL2ZO/SUVrxQVI0G3YEQ+OLbRA3c6zgixe8Mq8a/z7+HKlNEjo8oiLUs8iRijY2Rw==
+  dependencies:
+    cross-spawn "^7.0.1"
+
 [email protected]:
   version "7.0.1"
   resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-7.0.1.tgz#0ab56286e0f7c24e153d04cc2aa027e43a9a5d14"
@@ -4594,6 +4601,15 @@ cross-spawn@^6.0.0, cross-spawn@^6.0.5:
     shebang-command "^1.2.0"
     which "^1.2.9"
 
+cross-spawn@^7.0.1:
+  version "7.0.2"
+  resolved "https://registry.yarnpkg.com/cross-spawn/-/cross-spawn-7.0.2.tgz#d0d7dcfa74e89115c7619f4f721a94e1fdb716d6"
+  integrity sha512-PD6G8QG3S4FK/XCGFbEQrDqO2AnMMsy0meR7lerlIOHAAbkuavGU/pOqprrlvfTNjvowivTeBsjebAL0NSoMxw==
+  dependencies:
+    path-key "^3.1.0"
+    shebang-command "^2.0.0"
+    which "^2.0.1"
+
 [email protected]:
   version "2.0.5"
   resolved "https://registry.yarnpkg.com/cryptiles/-/cryptiles-2.0.5.tgz#3bdfecdc608147c1c67202fa291e7dca59eaa3b8"

examples/typescript/cypress/plugins/index.js

@@ -1,23 +1,6 @@
 const fs = require('fs')
-const cypressTypeScriptPreprocessor = require('./cy-ts-preprocessor')
 const cypressFirebasePlugin = require('cypress-firebase').plugin
 
 module.exports = (on, config) => {
-  on('file:preprocessor', (file) => {
-    // console.log(`preprocessor invoked with ${JSON.stringify(file)}`); // uncomment for debugging webpack crashes
-    return cypressTypeScriptPreprocessor(file).then((results) => {
-      // console.log(`preprocessor returned ${JSON.stringify(results)}`); // uncomment for debugging webpack crashes
-
-      if (!fs.existsSync(file.outputPath)) {
-        console.error(`Output file does not exist on the filesystem: ${JSON.stringify(file)}`);
-        throw new Error(`Output file does not exist on the filesystem: ${JSON.stringify(file)}`);
-      }
-      return results;
-    }).catch((err) => {
-      console.error(`Error occurred running preprocessor`, err);
-      throw err;
-    });
-  })
-
   return cypressFirebasePlugin(config)
 }

examples/typescript/cypress/support/commands.ts

@@ -23,7 +23,7 @@
 //
 // -- This is will overwrite an existing command --
 // Cypress.Commands.overwrite("visit", (originalFn, url, options) => { ... })
-import attachCustomCommands from 'cypress-firebase/lib/attachCustomCommands'
+import { attachCustomCommands } from 'cypress-firebase'
 import * as firebase from 'firebase/app'
 import 'firebase/auth'
 import 'firebase/database'

examples/typescript/package.json

@@ -5,9 +5,8 @@
   "scripts": {
     "start": "react-scripts start",
     "build": "react-scripts build",
-    "test": "yarn cypress:run",
-    "cypress:run": "cypress run",
-    "cypress:open": "cypress open",
+    "test": "cross-env GCLOUD_PROJECT=redux-firebasev3 cypress run",
+    "test:open": "cross-env GCLOUD_PROJECT=redux-firebasev3 cypress open",
     "lint": "eslint ./src/*.js cypress/**/*.ts --ext .ts,js",
     "lint:fix": "yarn lint --fix"
   },
@@ -23,10 +22,11 @@
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "^2.29.0",
     "@typescript-eslint/parser": "^2.29.0",
-    "cypress": "^4.4.1",
+    "cross-env": "^7.0.2",
+    "cypress": "^4.5.0",
     "eslint": "^6.8.0",
     "eslint-config-prettier": "^6.11.0",
-    "eslint-plugin-chai-friendly": "^0.5.0",
+    "eslint-plugin-chai-friendly": "^0.6.0",
     "eslint-plugin-cypress": "^2.10.3",
     "eslint-plugin-prettier": "^3.1.3",
     "prettier": "^2.0.5",