@atlaskit/eslint-plugin-platform 0.0.3 → 0.0.4

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/eslint-plugin-platform
 
+## 0.0.4
+
+### Patch Changes
+
+- [`cd5b194f403`](https://bitbucket.org/atlassian/atlassian-frontend/commits/cd5b194f403) - Add check to ensure that there is only one feature flag call per expression
+
 ## 0.0.3
 
 ### Patch Changes

package/dist/cjs/rules/ensure-feature-flag-registration/index.js

@@ -31,6 +31,34 @@ var getPackageJsonForFileName = function getPackageJsonForFileName(filename) {
   pkgJsonCache.set(pkgJsonPath, packageJson);
   return packageJson;
 };
+var __isOnlyOneFlagCheckInExpression = function __isOnlyOneFlagCheckInExpression(root, ignoredNode) {
+  switch (root.type) {
+    case 'IfStatement':
+      return __isOnlyOneFlagCheckInExpression(root.test, ignoredNode);
+    case 'CallExpression':
+      if (root === ignoredNode) {
+        return true;
+      }
+      return !(root.callee.type === 'Identifier' && root.callee.name === 'getBooleanFF');
+
+    // shouldn't ever get here but just in case
+    case 'Identifier':
+      return root.name !== 'getBooleanFF';
+    case 'BinaryExpression':
+    case 'LogicalExpression':
+      return __isOnlyOneFlagCheckInExpression(root.left, ignoredNode) && __isOnlyOneFlagCheckInExpression(root.right, ignoredNode);
+    default:
+      return true;
+  }
+};
+var isOnlyOneFlagCheckInExpression = function isOnlyOneFlagCheckInExpression(node) {
+  var root = node.parent;
+  // find the root node of the expression
+  while (root.type === 'LogicalExpression') {
+    root = root.parent;
+  }
+  return __isOnlyOneFlagCheckInExpression(root, node);
+};
 var rule = {
   meta: {
     hasSuggestions: false,
@@ -42,7 +70,8 @@ var rule = {
       onlyInlineIf: "Only call feature flags as part of an expression, don't assign to a variable! See http://go/pff-eslint for more details",
       onlyStringLiteral: "Only get feature flags by string literal, don't use variables! See http://go/pff-eslint for more details",
       registrationSectionMissing: 'Please add a "platform-feature-flags" section to your package.json! See http://go/pff-eslint for more details',
-      featureFlagMissing: "Please add a \"{{ featureFlag }}\" section to the \"platform-feature-flags\" section in your package.json. See http://go/pff-eslint for more details"
+      featureFlagMissing: "Please add a \"{{ featureFlag }}\" section to the \"platform-feature-flags\" section in your package.json. See http://go/pff-eslint for more details",
+      multipleFlagCheckInExpression: "Only check one flag per expression! See http://go/pff-eslint for more details"
     }
   },
   create: function create(context) {
@@ -61,7 +90,14 @@ var rule = {
           switch ((_node$parent = node.parent) === null || _node$parent === void 0 ? void 0 : _node$parent.type) {
             case 'IfStatement':
             case 'ConditionalExpression':
+              break;
             case 'LogicalExpression':
+              if (!isOnlyOneFlagCheckInExpression(node)) {
+                context.report({
+                  node: node,
+                  messageId: 'multipleFlagCheckInExpression'
+                });
+              }
               break;
             default:
               return context.report({

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/eslint-plugin-platform",
-	"version": "0.0.3",
+	"version": "0.0.4",
 	"sideEffects": false
 }

package/dist/es2019/rules/ensure-feature-flag-registration/index.js

@@ -24,6 +24,34 @@ const getPackageJsonForFileName = filename => {
   pkgJsonCache.set(pkgJsonPath, packageJson);
   return packageJson;
 };
+const __isOnlyOneFlagCheckInExpression = (root, ignoredNode) => {
+  switch (root.type) {
+    case 'IfStatement':
+      return __isOnlyOneFlagCheckInExpression(root.test, ignoredNode);
+    case 'CallExpression':
+      if (root === ignoredNode) {
+        return true;
+      }
+      return !(root.callee.type === 'Identifier' && root.callee.name === 'getBooleanFF');
+
+    // shouldn't ever get here but just in case
+    case 'Identifier':
+      return root.name !== 'getBooleanFF';
+    case 'BinaryExpression':
+    case 'LogicalExpression':
+      return __isOnlyOneFlagCheckInExpression(root.left, ignoredNode) && __isOnlyOneFlagCheckInExpression(root.right, ignoredNode);
+    default:
+      return true;
+  }
+};
+const isOnlyOneFlagCheckInExpression = node => {
+  let root = node.parent;
+  // find the root node of the expression
+  while (root.type === 'LogicalExpression') {
+    root = root.parent;
+  }
+  return __isOnlyOneFlagCheckInExpression(root, node);
+};
 const rule = {
   meta: {
     hasSuggestions: false,
@@ -35,7 +63,8 @@ const rule = {
       onlyInlineIf: "Only call feature flags as part of an expression, don't assign to a variable! See http://go/pff-eslint for more details",
       onlyStringLiteral: "Only get feature flags by string literal, don't use variables! See http://go/pff-eslint for more details",
       registrationSectionMissing: 'Please add a "platform-feature-flags" section to your package.json! See http://go/pff-eslint for more details',
-      featureFlagMissing: `Please add a "{{ featureFlag }}" section to the "platform-feature-flags" section in your package.json. See http://go/pff-eslint for more details`
+      featureFlagMissing: `Please add a "{{ featureFlag }}" section to the "platform-feature-flags" section in your package.json. See http://go/pff-eslint for more details`,
+      multipleFlagCheckInExpression: `Only check one flag per expression! See http://go/pff-eslint for more details`
     }
   },
   create(context) {
@@ -54,7 +83,14 @@ const rule = {
           switch ((_node$parent = node.parent) === null || _node$parent === void 0 ? void 0 : _node$parent.type) {
             case 'IfStatement':
             case 'ConditionalExpression':
+              break;
             case 'LogicalExpression':
+              if (!isOnlyOneFlagCheckInExpression(node)) {
+                context.report({
+                  node,
+                  messageId: 'multipleFlagCheckInExpression'
+                });
+              }
               break;
             default:
               return context.report({

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/eslint-plugin-platform",
-	"version": "0.0.3",
+	"version": "0.0.4",
 	"sideEffects": false
 }

package/dist/esm/rules/ensure-feature-flag-registration/index.js

@@ -24,6 +24,34 @@ var getPackageJsonForFileName = function getPackageJsonForFileName(filename) {
   pkgJsonCache.set(pkgJsonPath, packageJson);
   return packageJson;
 };
+var __isOnlyOneFlagCheckInExpression = function __isOnlyOneFlagCheckInExpression(root, ignoredNode) {
+  switch (root.type) {
+    case 'IfStatement':
+      return __isOnlyOneFlagCheckInExpression(root.test, ignoredNode);
+    case 'CallExpression':
+      if (root === ignoredNode) {
+        return true;
+      }
+      return !(root.callee.type === 'Identifier' && root.callee.name === 'getBooleanFF');
+
+    // shouldn't ever get here but just in case
+    case 'Identifier':
+      return root.name !== 'getBooleanFF';
+    case 'BinaryExpression':
+    case 'LogicalExpression':
+      return __isOnlyOneFlagCheckInExpression(root.left, ignoredNode) && __isOnlyOneFlagCheckInExpression(root.right, ignoredNode);
+    default:
+      return true;
+  }
+};
+var isOnlyOneFlagCheckInExpression = function isOnlyOneFlagCheckInExpression(node) {
+  var root = node.parent;
+  // find the root node of the expression
+  while (root.type === 'LogicalExpression') {
+    root = root.parent;
+  }
+  return __isOnlyOneFlagCheckInExpression(root, node);
+};
 var rule = {
   meta: {
     hasSuggestions: false,
@@ -35,7 +63,8 @@ var rule = {
       onlyInlineIf: "Only call feature flags as part of an expression, don't assign to a variable! See http://go/pff-eslint for more details",
       onlyStringLiteral: "Only get feature flags by string literal, don't use variables! See http://go/pff-eslint for more details",
       registrationSectionMissing: 'Please add a "platform-feature-flags" section to your package.json! See http://go/pff-eslint for more details',
-      featureFlagMissing: "Please add a \"{{ featureFlag }}\" section to the \"platform-feature-flags\" section in your package.json. See http://go/pff-eslint for more details"
+      featureFlagMissing: "Please add a \"{{ featureFlag }}\" section to the \"platform-feature-flags\" section in your package.json. See http://go/pff-eslint for more details",
+      multipleFlagCheckInExpression: "Only check one flag per expression! See http://go/pff-eslint for more details"
     }
   },
   create: function create(context) {
@@ -54,7 +83,14 @@ var rule = {
           switch ((_node$parent = node.parent) === null || _node$parent === void 0 ? void 0 : _node$parent.type) {
             case 'IfStatement':
             case 'ConditionalExpression':
+              break;
             case 'LogicalExpression':
+              if (!isOnlyOneFlagCheckInExpression(node)) {
+                context.report({
+                  node: node,
+                  messageId: 'multipleFlagCheckInExpression'
+                });
+              }
               break;
             default:
               return context.report({

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/eslint-plugin-platform",
-	"version": "0.0.3",
+	"version": "0.0.4",
 	"sideEffects": false
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@atlaskit/eslint-plugin-platform",
   "description": "The essential plugin for use with Atlassian frontend platform tools",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "author": "Atlassian Pty Ltd",
   "atlassian": {
     "team": "UIP - Platform Integration Trust (PITa)",

package/src/rules/ensure-feature-flag-registration/__tests__/unit/rule.test.tsx

@@ -63,6 +63,20 @@ describe('with existing platform-feature-flags section', () => {
         code: `const ff = "test-flag"; if(getBooleanFF(ff)) { }`,
         errors: [{ messageId: 'onlyStringLiteral' }],
       },
+      {
+        code: `if(getBooleanFF('test-flag') && getBooleanFF('test-flag')) { }`,
+        errors: [
+          { messageId: 'multipleFlagCheckInExpression' },
+          { messageId: 'multipleFlagCheckInExpression' },
+        ],
+      },
+      {
+        code: `if((getBooleanFF('test-flag') || 1 == true) && getBooleanFF('test-flag')) { }`,
+        errors: [
+          { messageId: 'multipleFlagCheckInExpression' },
+          { messageId: 'multipleFlagCheckInExpression' },
+        ],
+      },
     ],
   });
 });

package/src/rules/ensure-feature-flag-registration/index.tsx

@@ -33,6 +33,51 @@ const getPackageJsonForFileName = (filename: string): readPkgUp.PackageJson => {
   return packageJson;
 };
 
+const __isOnlyOneFlagCheckInExpression = (
+  root: Rule.Node,
+  ignoredNode: Rule.Node,
+): boolean => {
+  switch (root.type) {
+    case 'IfStatement':
+      return __isOnlyOneFlagCheckInExpression(
+        root.test as Rule.Node,
+        ignoredNode,
+      );
+
+    case 'CallExpression':
+      if (root === ignoredNode) {
+        return true;
+      }
+      return !(
+        root.callee.type === 'Identifier' && root.callee.name === 'getBooleanFF'
+      );
+
+    // shouldn't ever get here but just in case
+    case 'Identifier':
+      return root.name !== 'getBooleanFF';
+
+    case 'BinaryExpression':
+    case 'LogicalExpression':
+      return (
+        __isOnlyOneFlagCheckInExpression(root.left as Rule.Node, ignoredNode) &&
+        __isOnlyOneFlagCheckInExpression(root.right as Rule.Node, ignoredNode)
+      );
+
+    default:
+      return true;
+  }
+};
+
+const isOnlyOneFlagCheckInExpression = (node: Rule.Node): boolean => {
+  let root = node.parent;
+  // find the root node of the expression
+  while (root.type === 'LogicalExpression') {
+    root = root.parent;
+  }
+
+  return __isOnlyOneFlagCheckInExpression(root, node);
+};
+
 const rule: Rule.RuleModule = {
   meta: {
     hasSuggestions: false,
@@ -48,6 +93,7 @@ const rule: Rule.RuleModule = {
       registrationSectionMissing:
         'Please add a "platform-feature-flags" section to your package.json! See http://go/pff-eslint for more details',
       featureFlagMissing: `Please add a "{{ featureFlag }}" section to the "platform-feature-flags" section in your package.json. See http://go/pff-eslint for more details`,
+      multipleFlagCheckInExpression: `Only check one flag per expression! See http://go/pff-eslint for more details`,
     },
   },
   create(context) {
@@ -67,7 +113,14 @@ const rule: Rule.RuleModule = {
           switch (node.parent?.type) {
             case 'IfStatement':
             case 'ConditionalExpression':
+              break;
             case 'LogicalExpression':
+              if (!isOnlyOneFlagCheckInExpression(node)) {
+                context.report({
+                  node,
+                  messageId: 'multipleFlagCheckInExpression',
+                });
+              }
               break;
             default:
               return context.report({