Madhur/w 17619393

.github/workflows/closeStaleIssues.yml

@@ -18,7 +18,7 @@ jobs:
     steps:
       - uses: actions/stale@v9
         with:
-          node-version: '20.9.0'
+          node-version: '20.17.0'
           stale-issue-label: stale
           days-before-issue-stale: 3
           days-before-issue-close: 2

.github/workflows/runE2ETest.yml

@@ -38,7 +38,7 @@ jobs:
       matrix:
         os: ${{ fromJson(inputs.os) }}
         nodeVersion:
-          - 20.9.0
+          - 20.17.0
         vscodeVersion:
           - ${{ inputs.vscodeVersion }}
     steps:

.nvmrc

@@ -1 +1 @@
-v20.9.0
+v20.17.0

package.json

@@ -6,12 +6,12 @@
     "packages/*"
   ],
   "engines": {
-    "node": ">=20.9.0"
+    "node": ">=20.17"
   },
   "dependencies": {
     "@actions/core": "^1.11.0",
     "@actions/github": "^5.1.1",
-    "node": "^20.9.0",
+    "node": "^20.17.0",
     "npm": "^10",
     "semver": "^7.5.4",
     "ts-node": "10.9.2"
@@ -35,7 +35,7 @@
     "@vscode/test-electron": "2.3.0",
     "@vscode/vsce": "2.21.1",
     "acorn": "8.8.2",
-    "ajv": "6.12.6",
+    "ajv": "8.17.1",
     "check-peer-dependencies": "4.1.0",
     "commitizen": "^4.2.5",
     "cz-conventional-changelog": "3.3.0",

packages/salesforcedx-vscode-apex/package.json

@@ -38,6 +38,8 @@
   "devDependencies": {
     "@salesforce/salesforcedx-test-utils-vscode": "62.14.1",
     "@salesforce/ts-sinon": "1.4.0",
+    "@stoplight/spectral-core": "1.19.4",
+    "@stoplight/spectral-rulesets": "1.21.3",
     "@types/chai": "4.3.3",
     "@types/mocha": "^5",
     "@types/node": "^20.0.0",

packages/salesforcedx-vscode-apex/src/commands/apexActionController.ts

@@ -14,6 +14,7 @@ import * as vscode from 'vscode';
 import { parse } from 'yaml';
 import { workspaceContext } from '../context';
 import { nls } from '../messages';
+import { OasProcessor } from '../oas/documentProcessorPipeline/oasProcessor';
 import {
   ApexClassOASEligibleResponse,
   ApexClassOASGatherContextResponse,
@@ -98,8 +99,11 @@ export class ApexActionController {
     const documentText = fs.readFileSync(new URL(metadata.resourceUri.toString()), 'utf8');
     const openAPIdocument = await this.metadataOrchestrator.sendPromptToLLM(documentText, context);
 
-    // Convert the OpenAPI document to YAML
-    return this.cleanupYaml(openAPIdocument);
+    // hand off the validation and correction to processor.
+    const oasProcessor = new OasProcessor(context, openAPIdocument);
+    const processorResult = await oasProcessor.process();
+
+    return processorResult.yaml;
   };
 
   /**
@@ -114,19 +118,6 @@ export class ApexActionController {
     telemetryService.sendException(telemetryEvent, errorMessage);
   };
 
-  private cleanupYaml(doc: string): string {
-    // Remove the first line of the document
-    const openApiIndex = doc.indexOf('openapi');
-    if (openApiIndex === -1) {
-      throw new Error('Could not find openapi line in document:\n' + doc);
-    }
-    return doc
-      .substring(openApiIndex)
-      .split('\n')
-      .filter(line => !/^```$/.test(line))
-      .join('\n');
-  }
-
   private saveOasAsErsMetadata = async (oasSpec: string, fullPath: string): Promise<void> => {
     const orgVersion = await (await WorkspaceContextUtil.getInstance().getConnection()).retrieveMaxApiVersion();
     // Replace the schema section in the ESR file if it already exists

packages/salesforcedx-vscode-apex/src/messages/i18n.ja.ts

@@ -103,5 +103,6 @@ export const messages = {
   schema_element_not_found: 'The <schema> element was not found in the provided XML.',
   operations_element_not_found: 'The <operations> element was not found in the provided XML.',
   error_retrieving_org_version: 'Failed to retrieve org version',
-  error_parsing_yaml: 'Error parsing YAML'
+  error_parsing_yaml: 'Error parsing YAML',
+  invalid_class_annotation_for_generating_oas_doc: 'Invalid class annotation for generating OAS doc'
 };

packages/salesforcedx-vscode-apex/src/messages/i18n.ts

@@ -123,5 +123,6 @@ export const messages = {
   schema_element_not_found: 'The <schema> element was not found in the provided XML.',
   operations_element_not_found: 'The <operations> element was not found in the provided XML.',
   error_retrieving_org_version: 'Failed to retrieve org version',
-  error_parsing_yaml: 'Error parsing YAML'
+  error_parsing_yaml: 'Error parsing YAML',
+  invalid_class_annotation_for_generating_oas_doc: 'Invalid class annotation for generating OAS doc'
 };

packages/salesforcedx-vscode-apex/src/oas/documentProcessorPipeline/cleanupYamlStep.ts

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2025, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import { ProcessorInputOutput, ProcessorStep } from './processorStep';
+
+export class CleanupYamlStep implements ProcessorStep {
+  process(input: ProcessorInputOutput): Promise<ProcessorInputOutput> {
+    const cleanedupYaml = this.cleanupYaml(input.yaml);
+
+    return new Promise(resolve => {
+      resolve({ ...input, yaml: cleanedupYaml });
+    });
+  }
+
+  private cleanupYaml(doc: string): string {
+    // Remove the first line of the document
+    const openApiIndex = doc.indexOf('openapi');
+    if (openApiIndex === -1) {
+      throw new Error('Could not find openapi line in document:\n' + doc);
+    }
+    return doc
+      .substring(openApiIndex)
+      .split('\n')
+      .filter(line => !/^```$/.test(line))
+      .join('\n');
+  }
+}

packages/salesforcedx-vscode-apex/src/oas/documentProcessorPipeline/index.ts

@@ -0,0 +1,9 @@
+/*
+ * Copyright (c) 2025, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { OasProcessor } from './oasProcessor';
+
+export default OasProcessor;

packages/salesforcedx-vscode-apex/src/oas/documentProcessorPipeline/oasProcessor.ts

@@ -0,0 +1,38 @@
+/*
+ * Copyright (c) 2025, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import { nls } from '../../messages';
+import { ApexClassOASGatherContextResponse } from '../../openApiUtilities/schemas';
+import { CleanupYamlStep } from './cleanupYamlStep';
+import { OasValidationStep } from './oasValidationStep';
+import { Pipeline } from './pipeline';
+import { ProcessorInputOutput } from './processorStep';
+
+export class OasProcessor {
+  private context: ApexClassOASGatherContextResponse;
+  private document: string;
+
+  constructor(context: ApexClassOASGatherContextResponse, document: string) {
+    this.context = context;
+    this.document = document;
+  }
+
+  async process(): Promise<ProcessorInputOutput> {
+    if (this.context.classDetail.annotations.includes('RestResource')) {
+      // currently only OasValidation exists, in future this would have converters too
+      const pipeline = new Pipeline(new CleanupYamlStep()).addStep(new OasValidationStep());
+
+      console.log('Executing pipeline with input:');
+      console.log('context: ', JSON.stringify(this.context));
+      console.log('document: ', this.document);
+      const output = await pipeline.execute({ yaml: this.document });
+      console.log('Pipeline output:', output);
+      return output;
+    }
+    throw nls.localize('invalid_class_annotation_for_generating_oas_doc');
+  }
+}

packages/salesforcedx-vscode-apex/src/oas/documentProcessorPipeline/oasValidationStep.ts

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2025, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import { Spectral } from '@stoplight/spectral-core';
+import { ProcessorInputOutput, ProcessorStep } from './processorStep';
+import ruleset from './ruleset.spectral';
+
+export class OasValidationStep implements ProcessorStep {
+  async process(input: ProcessorInputOutput): Promise<ProcessorInputOutput> {
+    const spectral = new Spectral();
+
+    spectral.setRuleset(ruleset);
+
+    // we lint our document using the ruleset
+    await spectral.run(input.yaml).then(result => {
+      // the validation should be shown in problems tab, this will be covered by W-17656525
+      console.log('spectral results:', JSON.stringify(result));
+      input.errors = result;
+    });
+
+    // Since this step doesn't perform convertions we return the input for future processing
+    return input;
+  }
+}

packages/salesforcedx-vscode-apex/src/oas/documentProcessorPipeline/pipeline.ts

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2025, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { ProcessorInputOutput, ProcessorStep } from './processorStep';
+
+export class Pipeline {
+  private steps: ProcessorStep[] = [];
+
+  constructor(currentStep: ProcessorStep) {
+    this.steps.push(currentStep);
+  }
+
+  addStep(newStep: ProcessorStep) {
+    this.steps.push(newStep);
+    return this;
+  }
+
+  async execute(input: ProcessorInputOutput) {
+    let output: ProcessorInputOutput = input;
+    for (const step of this.steps) {
+      output = await step.process(output);
+    }
+    return output;
+  }
+}

packages/salesforcedx-vscode-apex/src/oas/documentProcessorPipeline/processorStep.ts

@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) 2025, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+
+import { ISpectralDiagnostic } from '@stoplight/spectral-core';
+
+export interface ProcessorInputOutput {
+  yaml: string;
+  errors?: ISpectralDiagnostic[];
+}
+
+export interface ProcessorStep {
+  process(input: ProcessorInputOutput): Promise<ProcessorInputOutput>;
+}

packages/salesforcedx-vscode-apex/src/oas/documentProcessorPipeline/ruleset.spectral.ts

@@ -0,0 +1,14 @@
+/*
+ * Copyright (c) 2025, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+import { oas } from '@stoplight/spectral-rulesets';
+
+const ruleset = {
+  extends: [oas],
+  rules: {}
+};
+
+export default ruleset;

packages/salesforcedx-vscode-lwc/package.json

@@ -28,7 +28,7 @@
     "@salesforce/lightning-lsp-common": "4.12.2",
     "@salesforce/lwc-language-server": "4.12.2",
     "@salesforce/salesforcedx-utils-vscode": "62.14.1",
-    "ajv": "6.12.6",
+    "ajv": "8.17.1",
     "applicationinsights": "1.0.7",
     "jest-editor-support": "30.3.1",
     "jest-regex-util": "^24.9.0",