Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 11357x 11357x 11357x 11357x 11357x 33897x 33897x 33897x 33897x 33897x 33897x 33897x 33897x 33897x 33897x 33897x 33897x 33897x 33897x 33897x 33897x 33897x 33897x 33897x 33897x 33897x 33897x 33897x 33897x 33897x 33897x 11357x 11357x 10856x 10856x 11357x 11357x 233x 233x 11357x 11357x 240x 240x 240x 11357x 11357x 309x 309x 309x 67x 67x 242x 242x 242x 242x 309x 56x 56x 7x 7x 7x 7x 56x 47x 47x 43x 47x 4x 47x 2x 2x 2x 2x 47x 49x 242x 242x 242x 11357x 11357x 4x 4x 4x 11x 11x 11x 2x 2x 11x 4x 4x 4x 11357x 11357x 1133x 1133x 1133x 56x 1133x 1077x 891x 891x 1077x 1133x 1133x 1133x 11357x 11357x | import {BasicRuleConfig} from "./_basic_rule_config";
import {Issue} from "../issue";
import {IRule, IRuleMetadata, RuleTag} from "./_irule";
import {IObject} from "../objects/_iobject";
import {ABAPObject} from "../objects/_abap_object";
import {IRegistry} from "../_iregistry";
import {SyntaxLogic} from "../abap/5_syntax/syntax";
import {ISpaghettiScopeNode} from "../abap/5_syntax/_spaghetti_scope";
import {ScopeType} from "../abap/5_syntax/_scope_type";
import {IdentifierMeta, TypedIdentifier} from "../abap/types/_typed_identifier";
import {Position} from "../position";
import {ReferenceType} from "../abap/5_syntax/_reference";
export class SlowParameterPassingConf extends BasicRuleConfig {
}
export class SlowParameterPassing implements IRule {
private reg: IRegistry;
private conf = new SlowParameterPassingConf();
public getMetadata(): IRuleMetadata {
return {
key: "slow_parameter_passing",
title: "Slow Parameter Passing",
shortDescription: `Detects slow pass by value passing for methods where parameter is not changed`,
extendedInformation: `Method parameters defined in interfaces is not checked`,
tags: [RuleTag.Performance],
badExample: `CLASS lcl DEFINITION.
PUBLIC SECTION.
METHODS bar IMPORTING VALUE(sdf) TYPE string.
ENDCLASS.
CLASS lcl IMPLEMENTATION.
METHOD bar.
WRITE sdf.
ENDMETHOD.
ENDCLASS.`,
goodExample: `CLASS lcl DEFINITION.
PUBLIC SECTION.
METHODS bar IMPORTING sdf TYPE string.
ENDCLASS.
CLASS lcl IMPLEMENTATION.
METHOD bar.
WRITE sdf.
ENDMETHOD.
ENDCLASS.`,
};
}
public getConfig() {
return this.conf;
}
public setConfig(conf: SlowParameterPassingConf): void {
this.conf = conf;
}
public initialize(reg: IRegistry): IRule {
this.reg = reg;
return this;
}
public run(obj: IObject): readonly Issue[] {
const issues: Issue[] = [];
if (!(obj instanceof ABAPObject)) {
return [];
}
const top = new SyntaxLogic(this.reg, obj).run().spaghetti.getTop();
const methods = this.listMethodNodes(top);
for (const m of methods) {
const vars = m.getData().vars;
if (m.getIdentifier().sname.includes("~")) {
// skip methods defined in interfaces
// todo: checking for just "~" is not correct, there might be ALIASES
continue;
}
for (const v in vars) {
const id = vars[v];
if (id.getMeta().includes(IdentifierMeta.PassByValue) === false) {
continue;
} else if (this.reg.isFileDependency(id.getFilename()) === true) {
continue;
}
const writes = this.listWritePositions(m, id);
if (writes.length === 0) {
const message = "Parameter " + id.getName() + " passed by VALUE but not changed";
issues.push(Issue.atIdentifier(id, message, this.getMetadata().key, this.getConfig().severity));
}
}
}
return issues;
}
private listWritePositions(node: ISpaghettiScopeNode, id: TypedIdentifier): Position[] {
const ret: Position[] = [];
for (const v of node.getData().references) {
if (v.referenceType === ReferenceType.DataWriteReference
&& v.resolved?.getFilename() === id.getFilename()
&& v.resolved?.getStart().equals(id.getStart())) {
ret.push(v.position.getStart());
}
}
return ret;
}
private listMethodNodes(node: ISpaghettiScopeNode): ISpaghettiScopeNode[] {
const ret: ISpaghettiScopeNode[] = [];
if (node.getIdentifier().stype === ScopeType.Method) {
ret.push(node);
} else {
for (const c of node.getChildren()) {
ret.push(...this.listMethodNodes(c));
}
}
return ret;
}
}
|