forbid overriding builtin services

lib/rules/no-restricted-service-registrations.js

@@ -0,0 +1,121 @@
+'use strict';
+
+const assert = require('assert');
+const emberUtils = require('../utils/ember');
+const {getImportIdentifier} = require('../utils/import');
+
+const DEFAULT_ERROR_MESSAGE = 'Registering this service is not allowed';
+const DEFAULT_RESTRICTED_REGISTRATIONS = ['router'];
+
+/**
+ * @type {import('eslint').Rule.RuleModule}
+ */
+module.exports = {
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: 'disallow registering certain services under certain paths',
+      category: 'Services',
+      url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/no-restricted-service-registrations.md',
+    },
+    schema: {
+      type: 'array',
+      uniqueItems: true,
+      minItems: 1,
+      items: [
+        {
+          type: 'object',
+          required: ['services'],
+          properties: {
+            services: {
+              type: 'array',
+              uniqueItems: true,
+              minItems: 1,
+              items: {
+                type: 'string',
+              },
+            },
+            message: {
+              type: 'string',
+            },
+          },
+          additionalProperties: false,
+        },
+      ],
+    },
+  },
+
+  DEFAULT_ERROR_MESSAGE,
+
+  create(context) {
+    if (!emberUtils.isTestFile(context.getFilename())) {
+      return {};
+    }
+
+    // Validate options.
+    for (const option of context.options) {
+      for (const service of option.services) {
+        assert(
+          service.toLowerCase() === service,
+          'Service name should be passed in kebab-case (all lower case)'
+        );
+      }
+    }
+
+    function checkForViolationAndReport(node, serviceName) {
+      const serviceNameKebabCase = emberUtils.convertServiceNameToKebabCase(serviceName); // splitting is used to avoid converting folder/ to folder-
+
+      for (const denylist of denylists) {
+        // Denylist services are always passed in in kebab-case, so we can do a kebab-case comparison.
+        if (denylist.services.includes(serviceNameKebabCase)) {
+          context.report({
+            node,
+            message: denylist.message || DEFAULT_ERROR_MESSAGE,
+          });
+        }
+      }
+    }
+
+    let getContextName;
+    let potentials = [];
+
+    return {
+      ImportDeclaration(node) {
+        if (node.source.value === '@ember/test-helpers') {
+          getContextName = getContextName || getImportIdentifier(node, 'getContext');
+        }
+      },
+
+      MemberExpression(node) {
+        if (node.object.name === 'owner' && node.property.name === 'register') {
+          potentials.push(node);
+        }
+
+      },
+
+      CallExpression(node) {
+        potentials = [];
+      },
+
+      'CallExpression:exit'(node) {
+        for (let potential of potentials) {
+          let first = node.arguments[0].value;
+
+          let [namespace, name] = first.split(':');
+
+          if (namespace !== 'service') {
+            return;
+          }
+
+          if (name === 'router') {
+            context.report({
+              node,
+              message: `Cannot register the router service`,
+            });
+          }
+        }
+      }
+
+    };
+  },
+};

tests/lib/rules/no-restructed-service-registrations.js

@@ -0,0 +1,59 @@
+const RuleTester = require('eslint').RuleTester;
+const rule = require('../../../lib/rules/no-restricted-service-registrations');
+
+const { DEFAULT_ERROR_MESSAGE } = rule;
+
+const ruleTester = new RuleTester({
+  parser: require.resolve('@babel/eslint-parser'),
+  parserOptions: {
+    ecmaVersion: 2020,
+    sourceType: 'module',
+  },
+});
+
+ruleTester.run('no-restricted-service-registrations', rule, {
+  valid: [
+    {
+      // Service name doesn't match (with property name):
+      code: `owner.register('service:foo')`,
+      options: [{ services: ['abc'] }],
+    },
+    {
+      // Namespace doesn't match
+      code: `owner.register('model:abc')`,
+      options: [{ services: ['abc'] }],
+    },
+  ],
+  invalid: [
+    // Basic test usage
+    {
+      code: `this.owner.register('service:router', null)`,
+      output: null,
+      errors: [{ message: `Cannot register the router service.` }],
+    },
+    // owner assigned to a variable
+    {
+      code: `let a = this.owner; a.register('service:router', null)`,
+      output: null,
+      errors: [{ message: `Cannot register the router service.` }],
+    },
+    // using getContext().owner
+    {
+      code: `import { getContext } from '@ember/test-helpers'; getContext().owner.register('service:router', null)`,
+      output: null,
+      errors: [{ message: `Cannot register the router service.` }],
+    },
+    // using getContext, but renamed
+    {
+      code: `import { getContext as a } from '@ember/test-helpers'; a().owner.register('service:router', null)`,
+      output: null,
+      errors: [{ message: `Cannot register the router service.` }],
+    },
+    // using { owner } = getContext()
+    {
+      code: `let { owner: a } = getContext(); a.register('service:router', null)`,
+      output: null,
+      errors: [{ message: `Cannot register the router service.` }],
+    },
+  ],
+});