No unguarded window (#17)

* Adding rule for no-unguarded-window. Also upgraded no-unguarded-document and added tests for both to catch common use cases. Added yarn test-server to start tests in watch mode.

Author: scalvert

guides/rules/no-unguarded-document.md renamed to guides/rules/linkedin/no-unguarded-document.md

@@ -0,0 +1,24 @@
+# No Unguarded Window References (LinkedIn specific)
+
+**TL;DR: Ensure that all window references are guarded inside an if block with the condition `environment.isBrowser()`**
+
+Unguarded window references will break when used with FastBoot. This is due to the Node environment
+not having a global `window` object. 
+
+To protect against errors during server side rendering, you should ensure you're guarding the usages
+of `window` with a check to `environment.isBrowser()`.
+
+Example:
+
+```js
+import Ember from 'ember';
+import environment from 'ember-stdlib/utils/environment';
+
+Ember.Component.extend({
+  init() {
+    if (environment.isBrowser()) {
+      this.location = window.location;
+    }
+  }
+});
+```

guides/rules/linkedin/no-unguarded-window.md

@@ -0,0 +1,42 @@
+const { get } = require('../../utils/get');
+const { isBrowser, isEnvironmentBrowser, getEnvironmentImportBinding } = require('../../utils/linkedin/bpr');
+const { isInActions, isInteractive } = require('../../utils/interactive');
+const { collectObjectPatternBindings } = require('../../utils/destructed-binding');
+
+const MESSAGE = 'Do not use unguarded document references. Please see the following guide for more infromation: http://github.com/chadhietala/ember-best-practices/files/guides/no-unguarded-document.md';
+
+function isDocumentReference(node) {
+  return get(node, 'callee.object.name') === 'document';
+}
+
+module.exports = {
+  meta: {
+    message: MESSAGE
+  },
+  create(context) {
+    let environmentImportBinding;
+    let destructuredBindings = [];
+
+    return {
+      ObjectPattern(node) {
+        if (environmentImportBinding) {
+          destructuredBindings = destructuredBindings.concat(collectObjectPatternBindings(node, {
+            [environmentImportBinding]: ['isBrowser']
+          }));
+        }
+      },
+
+      ImportDefaultSpecifier(node) {
+        environmentImportBinding = getEnvironmentImportBinding(node);
+      },
+
+      CallExpression(node) {
+        if (isDocumentReference(node)) {
+          if (!isInActions(node) && !isInteractive(node) && !isBrowser(node) && !isEnvironmentBrowser(node)) {
+            context.report(node, MESSAGE);
+          }
+        }
+      }
+    };
+  }
+};

lib/rules/linkedin/no-unguarded-document.js

@@ -0,0 +1,45 @@
+const { get } = require('../../utils/get');
+const { isBrowser, isEnvironmentBrowser, getEnvironmentImportBinding } = require('../../utils/linkedin/bpr');
+const { isInActions, isInteractive } = require('../../utils/interactive');
+const { collectObjectPatternBindings } = require('../../utils/destructed-binding');
+
+const MESSAGE = 'Do not use unguarded window references. Please see the following guide for more infromation: http://github.com/chadhietala/ember-best-practices/files/guides/no-unguarded-window.md';
+
+function isWindowReference(node) {
+  return get(node, 'object.name') === 'window';
+}
+
+module.exports = {
+  meta: {
+    message: MESSAGE
+  },
+  create(context) {
+    let environmentImportBinding;
+    let destructuredBindings = [];
+
+    return {
+      ObjectPattern(node) {
+        if (environmentImportBinding) {
+          destructuredBindings = destructuredBindings.concat(collectObjectPatternBindings(node, {
+            [environmentImportBinding]: ['isBrowser']
+          }));
+        }
+      },
+
+      ImportDefaultSpecifier(node) {
+        environmentImportBinding = getEnvironmentImportBinding(node);
+      },
+
+      MemberExpression(node) {
+        if (isWindowReference(node)) {
+          const isEnvironmentImported = !!environmentImportBinding && destructuredBindings.includes('isBrowser');
+          const isGuarded = (isEnvironmentImported && isBrowser(node)) || isEnvironmentBrowser(node);
+
+          if (!isInActions(node) && !isInteractive(node) && !isGuarded) {
+            context.report(node, MESSAGE);
+          }
+        }
+      }
+    };
+  }
+};

lib/rules/linkedin/no-unguarded-window.js

@@ -1,5 +1,5 @@
-const { getParent } = require('../utils/get');
-const { isGuarded } = require('../utils/fast-boot');
+const { isInActions, isInteractive } = require('../utils/interactive');
+const { isBrowser, isEnvironmentBrowser } = require('../utils/linkedin/bpr');
 
 const TIMERS = ['setTimeout', 'setInterval'];
 
@@ -9,10 +9,6 @@ function isTimer(name) {
   return TIMERS.includes(name);
 }
 
-function isInAction(node) {
-  return !!getParent(node, (node) => node.type === 'Property' && node.key.name === 'actions');
-}
-
 function getName(node) {
   if (!node.callee) {
     return '';
@@ -30,8 +26,10 @@ module.exports = {
       CallExpression(node) {
         let name = getName(node);
 
-        if (name && isTimer(name) && !isInAction(node) && !isGuarded(node)) {
-          context.report(node, MESSAGE);
+        if (name && isTimer(name)) {
+          if (!isInActions(node) && !isInteractive(node) && !isBrowser(node) && !isEnvironmentBrowser(node)) {
+            context.report(node, MESSAGE);
+          }
         }
       }
     };

lib/rules/no-timers.js

@@ -1,22 +0,0 @@
-const { getParent } = require('../utils/get');
-
-function isEnvironmentBrowser(node) {
-  let callee = node.test.callee;
-
-  if (callee) {
-    let obj = callee.object;
-    let prop = callee.property;
-
-    return obj.name === 'environment' && prop.name === 'isBrowser';
-  }
-
-  return false;
-}
-
-function isGuarded(node) {
-  return getParent(node, (node) => node.type === 'IfStatement' && isEnvironmentBrowser(node));
-}
-
-module.exports = {
-  isGuarded
-};

lib/rules/no-unguarded-document.js

@@ -0,0 +1,21 @@
+const { getParent } = require('../utils/get');
+
+const INTERACTIVE_LIFECYLE_HOOKS = [
+  'willRender',
+  'didRender',
+  'willInsertElement',
+  'didInsertElement'
+];
+
+function isInActions(node) {
+  return !!getParent(node, (node) => node.type === 'Property' && node.key.name === 'actions');
+}
+
+function isInteractive(node) {
+  return !!getParent(node, node => node.type === 'Property' && INTERACTIVE_LIFECYLE_HOOKS.includes(node.key.name));
+}
+
+module.exports = {
+  isInActions,
+  isInteractive
+};

lib/utils/fast-boot.js

@@ -0,0 +1,48 @@
+const { get, getParent } = require('../../utils/get');
+
+function _getCondition(node) {
+  return node.test ? node.test.callee : null;
+}
+
+function _isBrowser(node) {
+  let callee = _getCondition(node);
+
+  return callee && callee.name === 'isBrowser';
+}
+
+function _isEnvironmentBrowser(node) {
+  let callee = _getCondition(node);
+
+  if (callee) {
+    let obj = callee.object;
+    let prop = callee.property;
+
+    return obj && obj.name === 'environment' && prop && prop.name === 'isBrowser';
+  }
+
+  return false;
+}
+
+function isIfStatement(node) {
+  return node.type === 'IfStatement';
+}
+
+function isBrowser(node) {
+  return getParent(node, (node) => isIfStatement(node) && _isBrowser(node));
+}
+
+function isEnvironmentBrowser(node) {
+  return getParent(node, (node) => isIfStatement(node) && _isEnvironmentBrowser(node));
+}
+
+function getEnvironmentImportBinding(node) {
+  if (get(node, 'parent.source.raw').includes('ember-stdlib/utils/environment')) {
+    return node.local.name;
+  }
+}
+
+module.exports = {
+  isBrowser,
+  isEnvironmentBrowser,
+  getEnvironmentImportBinding
+};

lib/utils/interactive.js

@@ -8,7 +8,8 @@
     "test": "tests"
   },
   "scripts": {
-    "test": "mocha tests tests/lib/rules/*.js tests/**/*-test.js"
+    "test": "mocha --recursive tests",
+    "test-server": "mocha --recursive --growl --watch tests"
   },
   "repository": "",
   "engines": {