Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix some crashes including with legacy classes in no-deprecated-router-transition-methods and no-implicit-injections rules #1722

Merged
merged 3 commits into from Jan 3, 2023
Merged

Fix some crashes including with legacy classes in no-deprecated-router-transition-methods and no-implicit-injections rules #1722

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9b8f413
fix: support for mixin only, object.create, and more legacy syntax
rtablada Jan 2, 2023
39c10d5
fix: create and extend logic for router transition methods
rtablada Jan 2, 2023
e42a2d9
fix: check for computed dot access errors
rtablada Jan 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
80 changes: 44 additions & 36 deletions lib/rules/no-deprecated-router-transition-methods.js
View file
Open in desktop
Expand Up @@ -76,26 +76,29 @@ module.exports = {
if (emberUtils.isAnyEmberCoreModule(context, node)) {
const classMembers = node.body.body;

for (const classMember of classMembers) {
if (emberUtils.isInjectedServiceProp(classMember, undefined, serviceInjectImportName)) {
const serviceExpression = decoratorUtils.findDecorator(
classMember,
serviceInjectImportName
).expression;

if (serviceExpression.type === 'CallExpression') {
if (
(serviceExpression.arguments.length === 0 && classMember.key.name === 'router') ||
(serviceExpression.arguments.length > 0 &&
serviceExpression.arguments[0].value === 'router')
) {
if (serviceInjectImportName) {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Without this if statement, if inject service wasn't imported: then any property would have been checked/considered as being a service.

for (const classMember of classMembers) {
if (emberUtils.isInjectedServiceProp(classMember, undefined, serviceInjectImportName)) {
const serviceExpression = decoratorUtils.findDecorator(
classMember,
serviceInjectImportName
).expression;

if (serviceExpression.type === 'CallExpression') {
if (
(serviceExpression.arguments.length === 0 && classMember.key.name === 'router') ||
(serviceExpression.arguments.length > 0 &&
serviceExpression.arguments[0].value === 'router')
) {
routerServicePropertyName = classMember.key.name;
}
} else if (classMember.key.name === 'router') {
routerServicePropertyName = classMember.key.name;
}
} else if (classMember.key.name === 'router') {
routerServicePropertyName = classMember.key.name;
}
}
}

const isRoute = emberUtils.isEmberRoute(context, node);
const isController = emberUtils.isEmberController(context, node);
isValidModule = isRoute || isController;
Expand Down Expand Up @@ -135,33 +138,38 @@ module.exports = {
ClassExpression: onClassEnter,
CallExpression(node) {
if (emberUtils.isAnyEmberCoreModule(context, node)) {
const classMembers = node.arguments[0].properties;

for (const classMember of classMembers) {
if (emberUtils.isInjectedServiceProp(classMember, undefined, serviceInjectImportName)) {
const callExpression = classMember.value;
const lastExtendArg = node.arguments[node.arguments.length - 1];

if (lastExtendArg && lastExtendArg.type === 'ObjectExpression') {
const classMembers = lastExtendArg.properties;
for (const classMember of classMembers) {
if (
(callExpression.arguments.length === 0 && classMember.key.name === 'router') ||
(callExpression.arguments.length > 0 &&
callExpression.arguments[0].value === 'router')
emberUtils.isInjectedServiceProp(classMember, undefined, serviceInjectImportName)
) {
routerServicePropertyName = classMember.key.name;
const callExpression = classMember.value;

if (
(callExpression.arguments.length === 0 && classMember.key.name === 'router') ||
(callExpression.arguments.length > 0 &&
callExpression.arguments[0].value === 'router')
) {
routerServicePropertyName = classMember.key.name;
}
}
}
const isRoute = emberUtils.isEmberRoute(context, node);
const isController = emberUtils.isEmberController(context, node);
isValidModule = isRoute || isController;

classStack.push({
node,
serviceInjectImportName,
routerServicePropertyName,
isValidModule,
isRoute,
isController,
});
}
const isRoute = emberUtils.isEmberRoute(context, node);
const isController = emberUtils.isEmberController(context, node);
isValidModule = isRoute || isController;

classStack.push({
node,
serviceInjectImportName,
routerServicePropertyName,
isValidModule,
isRoute,
isController,
});
}
},

Expand Down
12 changes: 9 additions & 3 deletions lib/rules/no-implicit-injections.js
View file
Open in desktop
Expand Up @@ -143,7 +143,9 @@ module.exports = {
});

const modulePropertyDeclarations =
node.type === 'CallExpression' ? node.arguments[0].properties : node.body.body;
node.type === 'CallExpression'
? node.arguments[node.arguments.length - 1].properties
: node.body.body;

// Get Services that don't have properties/service injections declared
configToCheckFor = modulePropertyDeclarations.reduce((accum, n) => {
Expand Down Expand Up @@ -189,8 +191,12 @@ module.exports = {
ClassDeclaration: onClassEnter,
ClassExpression: onClassEnter,
CallExpression(node) {
if (emberUtils.isAnyEmberCoreModule(context, node)) {
onModuleFound(node);
if (emberUtils.isAnyEmberCoreModule(context, node) && emberUtils.isExtendObject(node)) {
const lastExtendArg = node.arguments[node.arguments.length - 1];

if (lastExtendArg && lastExtendArg.type === 'ObjectExpression') {
onModuleFound(node);
}
}
},

Expand Down
53 changes: 53 additions & 0 deletions tests/lib/rules/no-deprecated-router-transition-methods.js
View file
Open in desktop
Expand Up @@ -305,6 +305,59 @@ ruleTester.run('no-deprecated-router-transition-methods', rule, {
}
}`,
},

// Does not error on .create
{
filename: 'utils/loads-user-controller.js',
code: `
import Controller from '@ember/controller';

const myObj = Controller.create();`,
},

// Does not error on empty .extend
{
filename: 'utils/loads-user-controller.js',
code: `
import Controller from '@ember/controller';

const myObj = Controller.extend()`,
},

// Does not error when using mixin with native class (common for validations)
{
filename: 'controllers/index.js',
code: `
import Controller from '@ember/controller';
import SomeMixin from './my-mixin';

export default class FoobarTestError extends Controller.extend(SomeMixin) {
}`,
},

// Does not error when using Mixin
{
filename: 'controller/index.js',
code: `
import Controller from '@ember/controller';
import SomeMixin from './my-mixin';

export default Component.extend(SomeMixin, {
});`,
},

// Does not error when dot access decorator is used
{
filename: 'controllers/dot-access.js',
code: `
import Controller from '@ember/controller';
import SomeMixin from './my-mixin';
import EmberObject, { computed } from '@ember/object';

export default class FoobarTestError extends Controller {
@computed.reads('model.actors') actors;
}`,
},
],
invalid: [
// Route Uses RouterService.transitionTo with different service injection types
Expand Down
71 changes: 71 additions & 0 deletions tests/lib/rules/no-implicit-injections.js
View file
Open in desktop
Expand Up @@ -339,6 +339,77 @@ ruleTester.run('no-implicit-injections', rule, {
createExtendUsage('flashMessages: service(),'),
createExtendUsage("flashMessages: service('flashMessages'),"),
createExtendUsage("flashMessages: service('flash-messages'),"),

// Does not error on .create
{
filename: 'utils/loads-user-controller.js',
code: `
import EmberObject from '@ember/object';

const myObj = EmberObject.create();`,
},

// Does not error on empty .extend
{
filename: 'utils/loads-user-controller.js',
code: `
import EmberObject from '@ember/object';

const myObj = EmberObject.extend()`,
},

// Does not error when using mixin with native class (common for validations)
{
filename: 'controller-mixin/index.js',
code: `
import { inject as service } from '@ember/service';
import Component from '@ember/component';
import SomeMixin from './my-mixin';

export default class FoobarTestError extends Component.extend(SomeMixin) {
@service flashMessages;

@action
save() {
return this.flashMessages.warn('some message');
}
}`,
options: [FLASH_MESSAGES_CONFIG],
},

// Does not error when using Mixin
{
filename: 'controller/index.js',
code: `
import { inject as service } from '@ember/service';
import Component from '@ember/component';
import SomeMixin from './my-mixin';

export default Component.extend(SomeMixin, {
flashMessages: service(),

actions: {

save() {
return this.flashMessages.warn('some message');
}
}
});`,
options: [FLASH_MESSAGES_CONFIG],
},

// Does not error when dot access decorator is used
{
filename: 'controllers/dot-access.js',
code: `
import Controller from '@ember/controller';
import SomeMixin from './my-mixin';
import EmberObject, { computed } from '@ember/object';

export default class FoobarTestError extends Controller {
@computed.reads('model.actors') actors;
}`,
},
],
invalid: [
// Basic store lint error in routes/controllers
Expand Down