chore: profiling is a noop in prod

Author: puppybits

package.json

@@ -30,7 +30,7 @@
     "lint": "eslint src test",
     "lint:fix": "npm run lint -- --fix",
     "format": "prettier --write \"src/**/*.js\" \"test/**/*.js\"",
-    "postinstall": "npm run build",
+    "prepare": "npm run clean && npm run build",
     "prepublish": "npm run clean && npm run build",
     "pre-push": "npm run lint"
   },

src/reducers/cacheReducer.js

@@ -20,7 +20,7 @@ import {
 } from 'lodash';
 import { actionTypes } from '../constants';
 import { getBaseQueryName } from '../utils/query';
-import mark from '../utils/perfmarks';
+import mark from '../utils/profiling';
 
 const info = debug('rrf:cache');
 
@@ -204,7 +204,7 @@ const populateTransducer = (collection, populates) =>
     // Notice: by it's nature populate is O(2^n)/exponential.
     // In large data sets, every populate will add substantial time.
 
-    mark(`populate.${collection}`);
+    const done = mark(`populate.${collection}`);
 
     // pre-grab collection and remove empty populations
     const lookups = (Array.isArray(populates[0]) ? populates : [populates])
@@ -241,7 +241,7 @@ const populateTransducer = (collection, populates) =>
       return draft;
     }, createDraft(raw));
 
-    mark(`populate.${collection}`, true);
+    done();
 
     return { database: { [collection]: finishDraft(collectionById) } };
   });
@@ -537,7 +537,7 @@ export default function cacheReducer(state = {}, action) {
     switch (action.type) {
       case actionTypes.GET_SUCCESS:
       case actionTypes.LISTENER_RESPONSE:
-        mark(`cache.${actionTypes.LISTENER_RESPONSE}`);
+        const done = mark(`cache.LISTENER_RESPONSE`);
         if (!draft.database) {
           set(draft, ['database'], {});
           set(draft, ['databaseOverrides'], {});
@@ -563,11 +563,11 @@ export default function cacheReducer(state = {}, action) {
         // append docs field to query
         updateCollectionQueries(draft, path);
 
-        mark(`cache.${actionTypes.LISTENER_RESPONSE}`, true);
+        done();
         return draft;
 
       case actionTypes.UNSET_LISTENER:
-        mark(`cache.${actionTypes.UNSET_LISTENER}`);
+        const unsetDone = mark(`cache.UNSET_LISTENER`);
         if (draft[key]) {
           // all ids for the collection type, except query to be unset
           const activeIds = Object.keys(draft).reduce((inUse, dbKey) => {
@@ -592,12 +592,12 @@ export default function cacheReducer(state = {}, action) {
           updateCollectionQueries(draft, path);
         }
 
-        mark(`cache.${actionTypes.UNSET_LISTENER}`, true);
+        unsetDone();
         return draft;
 
       case actionTypes.DOCUMENT_ADDED:
       case actionTypes.DOCUMENT_MODIFIED:
-        mark(`cache.${actionTypes.DOCUMENT_MODIFIED}`);
+        const addDone = mark(`cache.DOCUMENT_MODIFIED`);
         setWith(
           draft,
           ['database', path, action.meta.doc],
@@ -628,7 +628,7 @@ export default function cacheReducer(state = {}, action) {
 
         updateCollectionQueries(draft, path);
 
-        mark(`cache.${actionTypes.DOCUMENT_MODIFIED}`, true);
+        addDone();
         return draft;
 
       case actionTypes.DELETE_SUCCESS:
@@ -637,7 +637,7 @@ export default function cacheReducer(state = {}, action) {
         }
       // eslint-disable-next-line no-fallthrough
       case actionTypes.DOCUMENT_REMOVED:
-        mark(`cache.${actionTypes.DOCUMENT_REMOVED}`);
+        const removeDone = mark(`cache.DOCUMENT_REMOVED`);
         if (draft.databaseOverrides && draft.databaseOverrides[path]) {
           unset(draft, ['databaseOverrides', path, action.meta.doc]);
         }
@@ -651,7 +651,7 @@ export default function cacheReducer(state = {}, action) {
         // reprocess
         updateCollectionQueries(draft, path);
 
-        mark(`cache.${actionTypes.DOCUMENT_REMOVED}`, true);
+        removeDone();
         return draft;
 
       case actionTypes.OPTIMISTIC_ADDED:
@@ -676,7 +676,7 @@ export default function cacheReducer(state = {}, action) {
       case actionTypes.UPDATE_FAILURE:
       case actionTypes.SET_FAILURE:
       case actionTypes.ADD_FAILURE:
-        mark(`cache.${actionTypes.MUTATE_FAILURE}`);
+        const failureDone = mark(`cache.MUTATE_FAILURE`);
         // All failures remove overrides
         if (action.payload.data || action.payload.args) {
           const write = action.payload.data
@@ -704,11 +704,11 @@ export default function cacheReducer(state = {}, action) {
           }
         }
 
-        mark(`cache.${actionTypes.MUTATE_FAILURE}`, true);
+        failureDone();
         return draft;
 
       case actionTypes.MUTATE_START:
-        mark(`cache.${actionTypes.MUTATE_START}`);
+        const startDone = mark(`cache.MUTATE_START`);
         if (action.payload && action.payload.data) {
           const optimisiticUpdates =
             translateMutationToOverrides(action, draft.database) || [];
@@ -731,7 +731,7 @@ export default function cacheReducer(state = {}, action) {
           });
         }
 
-        mark(`cache.${actionTypes.MUTATE_START}`, true);
+        startDone();
         return draft;
 
       default:

src/reducers/dataReducer.js

@@ -2,7 +2,7 @@ import { get } from 'lodash';
 import { setWith } from 'lodash/fp';
 import { actionTypes } from '../constants';
 import { pathFromMeta, preserveValuesFromState } from '../utils/reducers';
-import mark from '../utils/perfmarks';
+import mark from '../utils/profiling';
 
 const {
   CLEAR_DATA,
@@ -32,7 +32,7 @@ export default function dataReducer(state = {}, action) {
   switch (action.type) {
     case GET_SUCCESS:
     case LISTENER_RESPONSE:
-      mark(`data.${LISTENER_RESPONSE}`);
+      const done = mark(`data.LISTENER_RESPONSE`);
       const { meta, payload } = action;
       // Return state if payload are invalid
       if (!payload || payload.data === undefined) {
@@ -61,7 +61,7 @@ export default function dataReducer(state = {}, action) {
           state,
         );
       }
-      mark(`data.${LISTENER_RESPONSE}`, true);
+      done();
       // Set data to state (with merge) immutabily (lodash/fp's setWith creates copy)
       return setWith(
         Object,

src/utils/mutate.js

@@ -1,7 +1,7 @@
 import { chunk, cloneDeep, flatten, isFunction, mapValues } from 'lodash';
 import debug from 'debug';
 import { firestoreRef } from './query';
-import mark from './perfmarks';
+import mark from './profiling';
 
 const info = debug('rrf:mutate');
 
@@ -164,9 +164,9 @@ function write(firebase, operation = {}, writer = null) {
  * @returns {Promise}
  */
 function writeSingle(firebase, operations) {
-  mark('mutate.writeSingle');
+  const done = mark('mutate.writeSingle');
   const promise = write(firebase, operations);
-  mark('mutate.writeSingle', true);
+  done();
   return promise;
 }
 
@@ -178,7 +178,7 @@ const MAX_BATCH_COUNT = 500;
  * @returns {Promise}
  */
 async function writeInBatch(firebase, operations) {
-  mark('mutate.writeInBatch');
+  const done = mark('mutate.writeInBatch');
   const committedBatchesPromised = chunk(operations, MAX_BATCH_COUNT).map(
     (operationsChunk) => {
       const batch = firebase.firestore().batch();
@@ -190,7 +190,7 @@ async function writeInBatch(firebase, operations) {
     },
   );
 
-  mark('mutate.writeInBatch', true);
+  done();
   return Promise.all(committedBatchesPromised).then(flatten);
 }
 
@@ -210,7 +210,7 @@ async function writeInTransaction(firebase, operations) {
       return transaction.get(ref);
     };
 
-    mark('mutate.writeInTransaction:reads');
+    const done = mark('mutate.writeInTransaction:reads');
     const readsPromised = mapValues(operations.reads, (read) => {
       if (isDocRead(read)) {
         const doc = firestoreRef(firebase, read);
@@ -230,13 +230,13 @@ async function writeInTransaction(firebase, operations) {
         .then((docs) => docs.map(serialize));
     });
 
-    mark('mutate.writeInTransaction:reads', true);
+    done();
     const reads = await promiseAllObject(readsPromised);
 
     const writes = [];
 
     operations.writes.forEach((writeFnc) => {
-      mark('mutate.writeInTransaction:writes', true);
+      const complete = mark('mutate.writeInTransaction:writes');
       const operation = isFunction(writeFnc) ? writeFnc(reads) : writeFnc;
 
       if (Array.isArray(operation)) {
@@ -246,7 +246,7 @@ async function writeInTransaction(firebase, operations) {
         writes.push(write(firebase, operation, transaction));
       }
 
-      mark('mutate.writeInTransaction:writes', true);
+      complete();
     });
 
     // Firestore Transaction return null.

src/utils/perfmarks.js

@@ -0,0 +1,35 @@
+import { noop } from 'lodash';
+
+// webpack eternal removes
+let win = require('perf_hooks');
+
+const isDev =
+  !process.env.NODE_ENV ||
+  process.env.NODE_ENV === 'development' ||
+  process.env.NODE_ENV === 'test';
+
+try {
+  win = window;
+} catch (e) {}
+const perf = win && win.performance;
+/**
+ *
+ * @param {*} marker
+ * @param {*} isDone
+ * @returns {Function}
+ */
+export default function mark(marker) {
+  if (!isDev || !perf) return noop;
+
+  try {
+    const now = perf.now();
+    const start = `@rrf/${marker}-${now}`;
+    perf.mark(start);
+    return () => {
+      perf.measure(`@rrf/${marker}`, start);
+    };
+  } catch (err) {
+    // ensure timings never impact the user
+    return noop;
+  }
+}

src/utils/profiling.js

@@ -1,5 +1,6 @@
 const path = require('path');
 const TerserPlugin = require('terser-webpack-plugin');
+const webpack = require('webpack');
 
 const libraryName = 'redux-firestore';
 const isProduction = process.env.NODE_ENV === 'production';
@@ -16,7 +17,7 @@ const config = {
     libraryTarget: 'umd',
     umdNamedDefine: true,
   },
-  externals: [],
+  externals: { perf_hooks: 'var {}' },
   optimization: {
     minimize: isProduction,
     minimizer: isProduction ? [new TerserPlugin()] : [],
@@ -30,7 +31,7 @@ const config = {
       },
     ],
   },
-  plugins: [],
+  plugins: [new webpack.IgnorePlugin(/perf_hooks/)],
 };
 
 module.exports = config;