feat: cron instance decorations

Author: KristofersOzolinsMagebit

CHANGELOG.md

@@ -8,6 +8,7 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 
 - Added: Event name autocomplete
 - Added: Hovering CRON job schedules will show a human readable version
+- Added: Cron job indexer and instance class decorations
 - Changed: Implemented batching for the indexer to reduce load
 
 ## [1.5.0] - 2025-04-06

resources/icons/cron.svg

@@ -0,0 +1,90 @@
+import { DecorationOptions, TextEditorDecorationType, Uri, window } from 'vscode';
+import path from 'path';
+import TextDocumentDecorationProvider from './TextDocumentDecorationProvider';
+import { PhpClass } from 'parser/php/PhpClass';
+import { PhpInterface } from 'parser/php/PhpInterface';
+import PhpDocumentParser from 'common/php/PhpDocumentParser';
+import { ClasslikeInfo } from 'common/php/ClasslikeInfo';
+import MarkdownMessageBuilder from 'common/MarkdownMessageBuilder';
+import IndexManager from 'indexer/IndexManager';
+import CronIndexer from 'indexer/cron/CronIndexer';
+import { Job } from 'indexer/cron/types';
+import cronstrue from 'cronstrue';
+
+export default class CronClassDecorationProvider extends TextDocumentDecorationProvider {
+  public getType(): TextEditorDecorationType {
+    return window.createTextEditorDecorationType({
+      gutterIconPath: path.join(__dirname, 'resources', 'icons', 'cron.svg'),
+      gutterIconSize: '80%',
+      borderColor: 'rgba(0, 188, 202, 0.5)',
+      borderStyle: 'dotted',
+      borderWidth: '0 0 1px 0',
+    });
+  }
+
+  public async getDecorations(): Promise<DecorationOptions[]> {
+    const decorations: DecorationOptions[] = [];
+    const phpFile = await PhpDocumentParser.parse(this.document);
+
+    const classLikeNode: PhpClass | PhpInterface | undefined =
+      phpFile.classes[0] || phpFile.interfaces[0];
+
+    if (!classLikeNode) {
+      return decorations;
+    }
+
+    const classlikeInfo = new ClasslikeInfo(phpFile);
+
+    const cronIndexData = IndexManager.getIndexData(CronIndexer.KEY);
+
+    if (!cronIndexData) {
+      return decorations;
+    }
+
+    const jobs = cronIndexData.findJobsByInstance(classlikeInfo.getNamespace());
+
+    if (jobs.length === 0) {
+      return decorations;
+    }
+
+    decorations.push(...this.getCronInstanceDecorations(jobs, classlikeInfo));
+
+    return decorations;
+  }
+
+  private getCronInstanceDecorations(
+    jobs: Job[],
+    classlikeInfo: ClasslikeInfo
+  ): DecorationOptions[] {
+    const decorations: DecorationOptions[] = [];
+
+    const nameRange = classlikeInfo.getNameRange();
+
+    if (!nameRange) {
+      return decorations;
+    }
+
+    const hoverMessage = MarkdownMessageBuilder.create('Cron Jobs');
+
+    for (const job of jobs) {
+      hoverMessage.appendMarkdown(`- [${job.name}](${Uri.file(job.path)}) (${job.method})\n`);
+
+      if (job.schedule) {
+        hoverMessage.appendMarkdown(
+          `  - \`${job.schedule}\` (${cronstrue.toString(job.schedule)})\n`
+        );
+      }
+
+      if (job.config_path) {
+        hoverMessage.appendMarkdown(`  - Config: \`${job.config_path}\`\n`);
+      }
+    }
+
+    decorations.push({
+      range: nameRange,
+      hoverMessage: hoverMessage.build(),
+    });
+
+    return decorations;
+  }
+}

src/decorator/CronClassDecorationProvider.ts

@@ -10,4 +10,16 @@ export class CronIndexData extends AbstractIndexData<Job[]> {
   public getJobs(): Job[] {
     return this.getValues().flatMap(data => data);
   }
+
+  public findJobByName(group: string, name: string): Job | undefined {
+    return this.getJobs().find(job => job.group === group && job.name === name);
+  }
+
+  public findJobsByGroup(group: string): Job[] {
+    return this.getJobs().filter(job => job.group === group);
+  }
+
+  public findJobsByInstance(instance: string): Job[] {
+    return this.getJobs().filter(job => job.instance === instance);
+  }
 }

src/indexer/cron/CronIndexData.ts

@@ -3,6 +3,7 @@ import Observer from './Observer';
 import PluginClassDecorationProvider from 'decorator/PluginClassDecorationProvider';
 import Context from 'common/Context';
 import ObserverInstanceDecorationProvider from 'decorator/ObserverInstanceDecorationProvider';
+import CronClassDecorationProvider from 'decorator/CronClassDecorationProvider';
 
 export default class ActiveTextEditorChangeObserver extends Observer {
   public async execute(textEditor: TextEditor | undefined): Promise<void> {
@@ -11,14 +12,17 @@ export default class ActiveTextEditorChangeObserver extends Observer {
     if (textEditor && textEditor.document.languageId === 'php') {
       const pluginProvider = new PluginClassDecorationProvider(textEditor.document);
       const observerProvider = new ObserverInstanceDecorationProvider(textEditor.document);
+      const cronProvider = new CronClassDecorationProvider(textEditor.document);
 
-      const [pluginDecorations, observerDecorations] = await Promise.all([
+      const [pluginDecorations, observerDecorations, cronDecorations] = await Promise.all([
         pluginProvider.getDecorations(),
         observerProvider.getDecorations(),
+        cronProvider.getDecorations(),
       ]);
 
       textEditor.setDecorations(pluginProvider.getType(), pluginDecorations);
       textEditor.setDecorations(observerProvider.getType(), observerDecorations);
+      textEditor.setDecorations(cronProvider.getType(), cronDecorations);
     }
   }
 }