Merge pull request #12847 from jgwhite/deep-each-warning

[BUGFIX beta] Add warning for “deep @each” usage in dependent keys

Author: rwjblue

.jshintrc

@@ -21,6 +21,8 @@
         "expectAssertion",
         "expectDeprecation",
         "expectNoDeprecation",
+        "expectWarning",
+        "expectNoWarning",
         "ignoreAssertion",
         "ignoreDeprecation",
 

packages/ember-metal/lib/computed.js

@@ -1,4 +1,4 @@
-import { assert } from 'ember-metal/debug';
+import { assert, warn } from 'ember-metal/debug';
 import { set } from 'ember-metal/property_set';
 import { inspect } from 'ember-metal/utils';
 import { meta as metaFor, peekMeta } from 'ember-metal/meta';
@@ -25,6 +25,8 @@ import {
 
 function UNDEFINED() { }
 
+const DEEP_EACH_REGEX = /\.@each\.[^.]+\./;
+
 // ..........................................................
 // COMPUTED PROPERTY
 //
@@ -252,6 +254,13 @@ ComputedPropertyPrototype.property = function() {
   var args;
 
   var addArg = function(property) {
+    warn(
+      `Dependent keys containing @each only work one level deep. ` +
+        `You cannot use nested forms like [email protected] or [email protected][email protected]. ` +
+          `Please create an intermediary computed property.`,
+      DEEP_EACH_REGEX.test(property) === false,
+      { id: 'ember-metal.computed-deep-each' }
+    );
     args.push(property);
   };
 

packages/ember-metal/tests/computed_test.js

@@ -88,6 +88,28 @@ QUnit.test('defining a computed property with a dependent key ending with @each
   deepEqual(cp._dependentKeys, ['qux', 'zoopa.[]']);
 });
 
+QUnit.test('defining a computed property with a dependent key more than one level deep beyond @each is not supported', function() {
+  let warning = `Dependent keys containing @each only work one level deep. ` +
+                `You cannot use nested forms like [email protected] or [email protected][email protected]. ` +
+                `Please create an intermediary computed property.`;
+
+  expectNoWarning(() => {
+    computed('todos', () => {});
+  });
+
+  expectNoWarning(() => {
+    computed('[email protected]', () => {});
+  });
+
+  expectWarning(() => {
+    computed('[email protected]', () => {});
+  }, warning);
+
+  expectWarning(() => {
+    computed('[email protected][email protected]', () => {});
+  }, warning);
+});
+
 var objA, objB;
 QUnit.module('computed should inherit through prototype', {
   setup() {