All files / src registry.ts

83.58% Statements 397/475
77.24% Branches 112/145
86.11% Functions 31/36
83.58% Lines 397/475

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 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 4761x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 5292x 5292x 5292x 5292x 5292x 1x 1x 5510x 5285x 5285x 5285x 5285x 5510x 5510x 5510x                                   1x 1x                               1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 5141x 5141x 5141x 1x 1x       1x 1x 1688x 1688x 1x 1x 21719x 22762x 22767x 16702x 16697x 15654x 1x 1x 613x 62x 57x 608x 1x 1x 9x 15x 18x 18x 15x 9x 1x 1x 2291x 2291x 2291x 2291x       1x 1x 36x 36x 43x     43x 43x 36x 36x 1x 1x 472x 472x 530x 543x 472x 472x 543x 58x     1x 1x 3453x 4x 4x 3449x 3449x 3453x 1467x 1467x 1982x 1982x 1982x 1x 1x 15323x 15323x 1x 1x 1x 389x 407x 407x 389x 389x 389x 1x 1x 507x 507x 507x 1x 1x 5345x 5345x 1x 1x 205x 205x 205x 205x 1x 1x 21x 21x 21x 14x 14x 14x 20x 20x 1x 1x 5419x 5419x 5419x 5419x 5451x 5451x 5451x 8x 8x 5443x 5443x 5443x 5443x 5419x 5419x 1x 1x           1x 1x         1x 1x 661x 661x 661x 1x 1x     1x 1x 1x 249x 249x 297x 306x 249x 249x 306x 48x     1x 1x 1x 147x 45x 45x 147x 147x 1x 1x 1x 4x     4x 4x 1x 1x 1x 4585x 15x 15x 4570x 4570x 4570x 4570x 4585x 4653x 4653x 4653x 4570x 4570x 4570x 4570x 1x 1x 724x 2x 2x 722x 722x 724x 724x 724x 724x 857x 857x 857x 857x 724x     724x 724x 724x 724x 1x 1x 1x 1x 1x 5510x 5510x 5510x 5510x 1x 1x 5460x 5475x 5475x 5337x 5337x 5475x 123x 123x 1x 1x 151x 151x 151x 151x 151x 151x 151x 151x 151x 151x 174x 174x 1x 1x 174x 152x 152x 173x 173x 151x 151x 151x 18628x 18628x     18628x 18628x 18628x 151x 151x 151x 173x 173x 22084x 22084x 22084x 22084x 22084x 173x 151x 151x                       151x 151x 151x 1x 1x 151x 151x 151x 151x 151x 20083x 20083x 20083x 20083x 20083x 70998x 70998x 70478x 70478x 520x 520x 520x 70998x 1x 1x 70998x 20083x 151x 151x 151x 1x 1x 5443x 5443x 5443x 5348x 5348x 5348x 5348x 5348x 5346x 5346x 5348x 5348x 5348x 5244x 5244x 5348x 5348x 5348x 5348x 5443x 1x 1x 14x     14x 14x     14x 14x 14x 14x     14x 14x 7x 7x 7x 7x 14x 14x 1x 1x 5669x 5669x 5669x 5669x 5669x 319x 319x 5350x 5350x 5350x 1x 1x  
import {IObject, IParseResult} from "./objects/_iobject";
import {IFile} from "./files/_ifile";
import {Config} from "./config";
import {Issue} from "./issue";
import {ArtifactsObjects} from "./artifacts_objects";
import {ArtifactsRules} from "./artifacts_rules";
import {SkipLogic} from "./skip_logic";
import {IRegistry, IRunInput} from "./_iregistry";
import {IConfiguration} from "./_config";
import {ABAPObject} from "./objects/_abap_object";
import {FindGlobalDefinitions} from "./abap/5_syntax/global_definitions/find_global_definitions";
import {SyntaxLogic} from "./abap/5_syntax/syntax";
import {ExcludeHelper} from "./utils/excludeHelper";
import {DDICReferences} from "./ddic_references";
import {IDDICReferences} from "./_iddic_references";
 
// todo, this should really be an instance in case there are multiple Registry'ies
class ParsingPerformance {
  private static results: {runtime: number, name: string, extra: string}[];
  private static lexing: number;
  private static statements: number;
  private static structure: number;
 
  public static clear() {
    this.results = [];
    this.lexing = 0;
    this.statements = 0;
    this.structure = 0;
  }
 
  public static push(obj: IObject, result: IParseResult): void {
    if (result.runtimeExtra) {
      this.lexing += result.runtimeExtra.lexing;
      this.statements += result.runtimeExtra.statements;
      this.structure += result.runtimeExtra.structure;
    }
    if (result.runtime < 100) {
      return;
    }
    if (this.results === undefined) {
      this.results = [];
    }

    let extra = "";
    if (result.runtimeExtra) {
      extra = `\t(lexing: ${result.runtimeExtra.lexing
      }ms, statements: ${result.runtimeExtra.statements
      }ms, structure: ${result.runtimeExtra.structure}ms)`;
    }

    this.results.push({
      runtime: result.runtime,
      extra,
      name: obj.getType() + " " + obj.getName(),
    });
  }
 
  public static output() {
    const MAX = 10;

    this.results.sort((a, b) => { return b.runtime - a.runtime; });

    for (let i = 0; i < MAX; i++) {
      const row = this.results[i];
      if (row === undefined) {
        break;
      }
      process.stderr.write(`\t${row.runtime}ms\t${row.name} ${row.extra}\n`);
    }
    process.stderr.write(`\tTotal lexing:     ${this.lexing}ms\n`);
    process.stderr.write(`\tTotal statements: ${this.statements}ms\n`);
    process.stderr.write(`\tTotal structure:  ${this.structure}ms\n`);
  }
}
 
///////////////////////////////////////////////////////////////////////////////////////////////
 
export class Registry implements IRegistry {
  private readonly objects: { [name: string]: { [type: string]: IObject } } = {};
  private readonly objectsByType: { [type: string]: { [name: string]: IObject } } = {};
  /** object containing filenames of dependencies */
  private readonly dependencies: { [filename: string]: boolean } = {};
  private readonly references: IDDICReferences;
  private conf: IConfiguration;
  private issues: Issue[] = [];
 
  public constructor(conf?: IConfiguration) {
    this.conf = conf ? conf : Config.getDefault();
    this.references = new DDICReferences();
  }
 
  public static abaplintVersion(): string {
    // magic, see build script "version.sh"
    return "{{ VERSION }}";
  }
 
  public getDDICReferences() {
    return this.references;
  }
 
  public* getObjects(): Generator<IObject, void, undefined> {
    for (const name in this.objects) {
      for (const type in this.objects[name]) {
        yield this.objects[name][type];
      }
    }
  }
 
  public* getObjectsByType(type: string): Generator<IObject, void, undefined> {
    for (const name in this.objectsByType[type] || []) {
      yield this.objectsByType[type][name];
    }
  }
 
  public* getFiles(): Generator<IFile, void, undefined> {
    for (const obj of this.getObjects()) {
      for (const file of obj.getFiles()) {
        yield file;
      }
    }
  }
 
  public getFirstObject(): IObject | undefined {
    for (const name in this.objects) {
      for (const type in this.objects[name]) {
        return this.objects[name][type];
      }
    }
    return undefined;
  }
 
  public getObjectCount(skipDependencies = true): number {
    let res = 0;
    for (const o of this.getObjects()) {
      if (skipDependencies === true && this.isDependency(o)) {
        continue;
      }
      res = res + 1;
    }
    return res;
  }
 
  public getFileByName(filename: string): IFile | undefined {
    const upper = filename.toUpperCase();
    for (const o of this.getObjects()) {
      for (const f of o.getFiles()) {
        if (f.getFilename().toUpperCase() === upper) {
          return f;
        }
      }
    }
    return undefined;
  }
 
  public getObject(type: string | undefined, name: string | undefined): IObject | undefined {
    if (type === undefined || name === undefined) {
      return undefined;
    }
 
    const searchName = name.toUpperCase();
    if (this.objects[searchName]) {
      return this.objects[searchName][type];
    }
 
    return undefined;
  }
 
  public getConfig(): IConfiguration {
    return this.conf;
  }
 
  // assumption: Config is immutable, and can only be changed via this method
  public setConfig(conf: IConfiguration): IRegistry {
    for (const obj of this.getObjects()) {
      obj.setDirty();
    }
    this.conf = conf;
    return this;
  }
 
  public inErrorNamespace(name: string): boolean {
    const reg = new RegExp(this.getConfig().getSyntaxSetttings().errorNamespace, "i");
    return reg.test(name);
  }
 
  public addFile(file: IFile): IRegistry {
    return this.addFiles([file]);
  }
 
  public updateFile(file: IFile): IRegistry {
    const obj = this.find(file.getObjectName(), file.getObjectType());
    obj.updateFile(file);
    return this;
  }
 
  public removeFile(file: IFile): IRegistry {
    const obj = this.find(file.getObjectName(), file.getObjectType());
    obj.removeFile(file);
    if (obj.getFiles().length === 0) {
      this.references.clear(obj);
      this.removeObject(obj);
    }
    return this;
  }
 
  public addFiles(files: readonly IFile[]): IRegistry {
    const globalExclude = (this.conf.getGlobal().exclude ?? [])
      .map(pattern => new RegExp(pattern, "i"));
 
    for (const f of files) {
      const filename = f.getFilename();
      const isNotAbapgitFile = filename.split(".").length <= 2;
      if (isNotAbapgitFile || ExcludeHelper.isExcluded(filename, globalExclude)) {
        continue;
      }
      const found = this.findOrCreate(f.getObjectName(), f.getObjectType());
 
      found.addFile(f);
    }
    return this;
  }
 
  public addDependencies(files: readonly IFile[]): IRegistry {
    for (const f of files) {
      this.dependencies[f.getFilename().toUpperCase()] = true;
    }
    return this.addFiles(files);
  }
 
  public addDependency(file: IFile): IRegistry {
    this.dependencies[file.getFilename().toUpperCase()] = true;
    this.addFile(file);
    return this;
  }
 
  public isDependency(obj: IObject): boolean {
    const filename = obj.getFiles()[0].getFilename().toUpperCase();
    return this.dependencies[filename] === true;
  }
 
  public isFileDependency(filename: string): boolean {
    return this.dependencies[filename.toUpperCase()] === true;
  }
 
  // assumption: the file is already in the registry
  public findObjectForFile(file: IFile): IObject | undefined {
    const filename = file.getFilename();
    for (const obj of this.getObjects()) {
      for (const ofile of obj.getFiles()) {
        if (ofile.getFilename() === filename) {
          return obj;
        }
      }
    }
    return undefined;
  }
 
  // todo, this will be changed to async sometime
  public findIssues(input?: IRunInput): readonly Issue[] {
    if (this.isDirty() === true) {
      this.parse();
    }
    return this.runRules(input);
  }
 
  // todo, this will be changed to async sometime
  public findIssuesObject(iobj: IObject): readonly Issue[] {
    if (this.isDirty() === true) {
      this.parse();
    }
    return this.runRules(undefined, iobj);
  }
 
  // todo, this will be changed to async sometime
  public parse() {
    if (this.isDirty() === false) {
      return this;
    }
 
    ParsingPerformance.clear();
 
    this.issues = [];
    for (const o of this.getObjects()) {
      this.parsePrivate(o);
      this.issues.push(...o.getParsingIssues());
    }
    new FindGlobalDefinitions(this).run();
 
    return this;
  }
 
  public async parseAsync(input?: IRunInput) {
    if (this.isDirty() === false) {
      return this;
    }
 
    ParsingPerformance.clear();
    input?.progress?.set(this.getObjectCount(false), "Lexing and parsing");
 
    this.issues = [];
    for (const o of this.getObjects()) {
      await input?.progress?.tick("Lexing and parsing(" + this.conf.getVersion() + ") - " + o.getType() + " " + o.getName());
      this.parsePrivate(o);
      this.issues.push(...o.getParsingIssues());
    }
    if (input?.outputPerformance === true) {
      ParsingPerformance.output();
    }
    new FindGlobalDefinitions(this).run(input?.progress);
 
    return this;
  }
 
  //////////////////////////////////////////
 
  // todo, refactor, this is a mess, see where-used, a lot of the code should be in this method instead
  private parsePrivate(input: IObject) {
    const config = this.getConfig();
    const result = input.parse(config.getVersion(), config.getSyntaxSetttings().globalMacros);
    ParsingPerformance.push(input, result);
  }
 
  private isDirty(): boolean {
    for (const o of this.getObjects()) {
      const dirty = o.isDirty();
      if (dirty === true) {
        return true;
      }
    }
    return false;
  }
 
  private runRules(input?: IRunInput, iobj?: IObject): readonly Issue[] {
    const rulePerformance: {[index: string]: number} = {};
    const issues = this.issues.slice(0);
 
    const objects = iobj ? [iobj] : this.getObjects();
    const rules = this.conf.getEnabledRules();
    const skipLogic = new SkipLogic(this);
 
    input?.progress?.set(iobj ? 1 : this.getObjectCount(false), "Run Syntax");
    const check: IObject[] = [];
    for (const obj of objects) {
      input?.progress?.tick("Run Syntax - " + obj.getName());
      if (skipLogic.skip(obj) || this.isDependency(obj)) {
        continue;
      }
      if (obj instanceof ABAPObject) {
        new SyntaxLogic(this, obj).run();
      }
      check.push(obj);
    }
 
    input?.progress?.set(rules.length, "Initialize Rules");
    for (const rule of rules) {
      input?.progress?.tick("Initialize Rules - " + rule.getMetadata().key);
      if (rule.initialize === undefined) {
        throw new Error(rule.getMetadata().key + " missing initialize method");
      }
      rule.initialize(this);
      rulePerformance[rule.getMetadata().key] = 0;
    }
 
    input?.progress?.set(check.length, "Finding Issues");
    for (const obj of check) {
      input?.progress?.tick("Finding Issues - " + obj.getType() + " " + obj.getName());
      for (const rule of rules) {
        const before = Date.now();
        issues.push(...rule.run(obj));
        const runtime = Date.now() - before;
        rulePerformance[rule.getMetadata().key] = rulePerformance[rule.getMetadata().key] + runtime;
      }
    }
 
    if (input?.outputPerformance === true) {
      const perf: {name: string, time: number}[] = [];
      for (const p in rulePerformance) {
        if (rulePerformance[p] > 100) { // ignore rules if it takes less than 100ms
          perf.push({name: p, time: rulePerformance[p]});
        }
      }
      perf.sort((a, b) => {return b.time - a.time;});
      for (const p of perf) {
        process.stderr.write("\t" + p.time + "ms\t" + p.name + "\n");
      }
    }
 
    return this.excludeIssues(issues);
  }
 
  private excludeIssues(issues: Issue[]): Issue[] {
 
    const ret: Issue[] = issues;
 
    // exclude issues, as now we know both the filename and issue key
    for (const rule of ArtifactsRules.getRules()) {
      const key = rule.getMetadata().key;
      const ruleExclude: string[] = (this.conf.readByKey(key, "exclude") ?? []);
      const ruleExcludePatterns = ruleExclude.map(x => new RegExp(x, "i"));
 
      for (let i = ret.length - 1; i >= 0; i--) {
 
        if (ret[i].getKey() !== key) {
          continue;
        }
 
        const filename = ret[i].getFilename();
 
        if (ExcludeHelper.isExcluded(filename, ruleExcludePatterns)) {
          ret.splice(i, 1);
        }
      }
    }
 
    return ret;
  }
 
  private findOrCreate(name: string, type?: string): IObject {
    try {
      return this.find(name, type);
    } catch {
      const newName = name.toUpperCase();
      const newType = type ? type : "UNKNOWN";
      const add = ArtifactsObjects.newObject(newName, newType);
 
      if (this.objects[newName] === undefined) {
        this.objects[newName] = {};
      }
      this.objects[newName][newType] = add;
 
      if (this.objectsByType[newType] === undefined) {
        this.objectsByType[newType] = {};
      }
      this.objectsByType[newType][newName] = add;
 
      return add;
    }
  }
 
  private removeObject(remove: IObject | undefined): void {
    if (remove === undefined) {
      return;
    }
 
    if (this.objects[remove.getName()][remove.getType()] === undefined) {
      throw new Error("removeObject: object not found");
    }
 
    if (Object.keys(this.objects[remove.getName()]).length === 1) {
      delete this.objects[remove.getName()];
    } else {
      delete this.objects[remove.getName()][remove.getType()];
    }
 
    if (Object.keys(this.objectsByType[remove.getType()]).length === 1) {
      delete this.objectsByType[remove.getType()];
    } else {
      delete this.objectsByType[remove.getType()][remove.getName()];
    }
 
  }
 
  private find(name: string, type?: string): IObject {
    const searchType = type ? type : "UNKNOWN";
    const searchName = name.toUpperCase();
 
    if (this.objects[searchName] !== undefined
      && this.objects[searchName][searchType]) {
      return this.objects[searchName][searchType];
    }
 
    throw new Error("find: object not found, " + type + " " + name);
  }
 
}