feat: cron indexer

Author: KristofersOzolinsMagebit

src/indexer/IndexManager.ts

@@ -18,14 +18,17 @@ import AclIndexer from './acl/AclIndexer';
 import { AclIndexData } from './acl/AclIndexData';
 import TemplateIndexer from './template/TemplateIndexer';
 import { TemplateIndexData } from './template/TemplateIndexData';
+import CronIndexer from './cron/CronIndexer';
+import { CronIndexData } from './cron/CronIndexData';
 
 type IndexerInstance =
   | DiIndexer
   | ModuleIndexer
   | AutoloadNamespaceIndexer
   | EventsIndexer
   | AclIndexer
-  | TemplateIndexer;
+  | TemplateIndexer
+  | CronIndexer;
 
 type IndexerDataMap = {
   [DiIndexer.KEY]: DiIndexData;
@@ -34,6 +37,7 @@ type IndexerDataMap = {
   [EventsIndexer.KEY]: EventsIndexData;
   [AclIndexer.KEY]: AclIndexData;
   [TemplateIndexer.KEY]: TemplateIndexData;
+  [CronIndexer.KEY]: CronIndexData;
 };
 
 class IndexManager {
@@ -50,6 +54,7 @@ class IndexManager {
       new EventsIndexer(),
       new AclIndexer(),
       new TemplateIndexer(),
+      new CronIndexer(),
     ];
     this.indexStorage = new IndexStorage();
   }
@@ -187,6 +192,9 @@ class IndexManager {
       case TemplateIndexer.KEY:
         return new TemplateIndexData(data) as IndexerDataMap[T];
 
+      case CronIndexer.KEY:
+        return new CronIndexData(data) as IndexerDataMap[T];
+
       default:
         return undefined;
     }

src/indexer/cron/CronIndexData.ts

@@ -0,0 +1,13 @@
+import { Memoize } from 'typescript-memoize';
+import { Job } from './types';
+import { AbstractIndexData } from 'indexer/AbstractIndexData';
+import CronIndexer from './CronIndexer';
+
+export class CronIndexData extends AbstractIndexData<Job[]> {
+  @Memoize({
+    tags: [CronIndexer.KEY],
+  })
+  public getJobs(): Job[] {
+    return this.getValues().flatMap(data => data);
+  }
+}

src/indexer/cron/CronIndexer.ts

@@ -0,0 +1,70 @@
+import { RelativePattern, Uri } from 'vscode';
+import { XMLParser } from 'fast-xml-parser';
+import { get } from 'lodash-es';
+import FileSystem from 'util/FileSystem';
+import { Job } from './types';
+import { Indexer } from 'indexer/Indexer';
+import { IndexerKey } from 'types/indexer';
+
+export default class CronIndexer extends Indexer<Job[]> {
+  public static readonly KEY = 'cron';
+
+  protected xmlParser: XMLParser;
+
+  public constructor() {
+    super();
+
+    this.xmlParser = new XMLParser({
+      ignoreAttributes: false,
+      attributeNamePrefix: '@_',
+      isArray: (_name, jpath) => {
+        return ['config.group', 'config.group.job'].includes(jpath);
+      },
+    });
+  }
+
+  public getVersion(): number {
+    return 2;
+  }
+
+  public getId(): IndexerKey {
+    return CronIndexer.KEY;
+  }
+
+  public getName(): string {
+    return 'crontab.xml';
+  }
+
+  public getPattern(uri: Uri): RelativePattern {
+    return new RelativePattern(uri, '**/etc/crontab.xml');
+  }
+
+  public async indexFile(uri: Uri): Promise<Job[]> {
+    const xml = await FileSystem.readFile(uri);
+    const parsed = this.xmlParser.parse(xml);
+    const config = get(parsed, 'config', {});
+
+    const data: Job[] = [];
+
+    // Index groups
+    const groups = get(config, 'group', []);
+
+    for (const group of groups) {
+      const jobs = get(group, 'job', []);
+
+      for (const job of jobs) {
+        data.push({
+          name: job['@_name'],
+          instance: job['@_instance'],
+          method: job['@_method'],
+          schedule: job['schedule'],
+          config_path: job['config_path'],
+          path: uri.fsPath,
+          group: group['@_id'],
+        });
+      }
+    }
+
+    return data;
+  }
+}

src/indexer/cron/types.ts

@@ -0,0 +1,9 @@
+export interface Job {
+  name: string;
+  instance: string;
+  method: string;
+  schedule?: string;
+  config_path?: string;
+  path: string;
+  group: string;
+}