@akinon/eslint-plugin-projectzero 1.12.0 → 1.13.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @akinon/eslint-plugin-projectzero
 
+## 1.13.0
+
+### Minor Changes
+
+- ZERO-2368: Add ESLint rule to check middleware orders
+
 ## 1.12.0
 
 ## 1.11.0

package/dist/rules/check-middleware-order.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("@typescript-eslint/utils");
+const correctOrder = [
+    'withOauthLogin',
+    'withLocale',
+    'withCurrency',
+    'withPrettyUrl',
+    'withRedirectionPayment',
+    'withThreeDRedirection',
+    'withUrlRedirection'
+];
+exports.default = utils_1.ESLintUtils.RuleCreator.withoutDocs({
+    create(context) {
+        return {
+            CallExpression(node) {
+                if (node.callee.type === 'Identifier' &&
+                    correctOrder.includes(node.callee.name)) {
+                    let current = node;
+                    const callSequence = [];
+                    while (current.type === 'CallExpression' &&
+                        current.callee.type === 'Identifier') {
+                        if (correctOrder.includes(current.callee.name)) {
+                            callSequence.unshift(current.callee.name);
+                        }
+                        current = current.parent;
+                    }
+                    let isValidOrder = true;
+                    for (let i = 0; i < callSequence.length; i++) {
+                        if (callSequence[i] !== correctOrder[i]) {
+                            isValidOrder = false;
+                            break;
+                        }
+                    }
+                    // Report an error if the order is incorrect
+                    if (!isValidOrder) {
+                        context.report({
+                            node,
+                            message: `Incorrect order of middleware functions. Expected order: ${correctOrder.join(', ')}. Found order: ${callSequence.join(', ')}.`
+                        });
+                    }
+                }
+            }
+        };
+    },
+    meta: {
+        type: 'problem',
+        schema: [],
+        messages: {
+            incorrectMiddlewareOrder: 'Incorrect middleware order. Expected {{expected}}, found {{found}}.'
+        }
+    },
+    defaultOptions: []
+});

package/dist/rules/index.js

@@ -11,6 +11,7 @@ const router_import_1 = __importDefault(require("./router-import"));
 const skip_trailing_slash_redirect_1 = __importDefault(require("./skip-trailing-slash-redirect"));
 const check_locale_1 = __importDefault(require("./check-locale"));
 const meta_data_import_1 = __importDefault(require("./meta-data-import"));
+const check_middleware_order_1 = __importDefault(require("./check-middleware-order"));
 const rules = {
     'client-url': client_url_1.default,
     'image-import': image_import_1.default,
@@ -18,6 +19,7 @@ const rules = {
     'router-import': router_import_1.default,
     'skip-trailing-slash-redirect': skip_trailing_slash_redirect_1.default,
     'check-locale': check_locale_1.default,
-    'meta-data-import': meta_data_import_1.default
+    'meta-data-import': meta_data_import_1.default,
+    'check-middleware-order': check_middleware_order_1.default
 };
 exports.rules = rules;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@akinon/eslint-plugin-projectzero",
-  "version": "1.12.0",
+  "version": "1.13.0",
   "private": false,
   "description": "ESLint plugin for Project Zero Next",
   "main": "dist/index.js",

package/rules/check-middleware-order.ts

@@ -0,0 +1,64 @@
+import { ESLintUtils } from '@typescript-eslint/utils';
+
+const correctOrder = [
+  'withOauthLogin',
+  'withLocale',
+  'withCurrency',
+  'withPrettyUrl',
+  'withRedirectionPayment',
+  'withThreeDRedirection',
+  'withUrlRedirection'
+];
+
+export default ESLintUtils.RuleCreator.withoutDocs({
+  create(context: any) {
+    return {
+      CallExpression(node: any) {
+        if (
+          node.callee.type === 'Identifier' &&
+          correctOrder.includes(node.callee.name)
+        ) {
+          let current = node;
+          const callSequence = [];
+
+          while (
+            current.type === 'CallExpression' &&
+            current.callee.type === 'Identifier'
+          ) {
+            if (correctOrder.includes(current.callee.name)) {
+              callSequence.unshift(current.callee.name);
+            }
+            current = current.parent;
+          }
+
+          let isValidOrder = true;
+          for (let i = 0; i < callSequence.length; i++) {
+            if (callSequence[i] !== correctOrder[i]) {
+              isValidOrder = false;
+              break;
+            }
+          }
+
+          // Report an error if the order is incorrect
+          if (!isValidOrder) {
+            context.report({
+              node,
+              message: `Incorrect order of middleware functions. Expected order: ${correctOrder.join(
+                ', '
+              )}. Found order: ${callSequence.join(', ')}.`
+            });
+          }
+        }
+      }
+    };
+  },
+  meta: {
+    type: 'problem',
+    schema: [],
+    messages: {
+      incorrectMiddlewareOrder:
+        'Incorrect middleware order. Expected {{expected}}, found {{found}}.'
+    }
+  },
+  defaultOptions: []
+});

package/rules/index.ts

@@ -5,6 +5,7 @@ import routerImport from './router-import';
 import skipTrailingSlashRedirect from './skip-trailing-slash-redirect';
 import checkLocale from './check-locale';
 import metaDataImport from './meta-data-import';
+import checkMiddlewareOrder from './check-middleware-order';
 
 const rules = {
   'client-url': clientUrl,
@@ -13,7 +14,8 @@ const rules = {
   'router-import': routerImport,
   'skip-trailing-slash-redirect': skipTrailingSlashRedirect,
   'check-locale': checkLocale,
-  'meta-data-import': metaDataImport
+  'meta-data-import': metaDataImport,
+  'check-middleware-order': checkMiddlewareOrder
 };
 
 export { rules };