From 80289b82b876f3e9ef52d196a75a67c034b62f31 Mon Sep 17 00:00:00 2001
From: Peter van Gulik <peter@curlybracket.nl>
Date: Sat, 16 Dec 2023 22:57:38 +0100
Subject: [PATCH] add new code lens and grammar for SF APIs

---
 packages/vscode-extension/package.json        | 16 +++++++++
 .../executeApiLensProvider.ts                 | 36 +++++++++++++++++++
 packages/vscode-extension/src/extension.ts    |  7 ++--
 .../symbolProviders/apexLogSymbolProvider.ts  | 21 ++++++-----
 .../syntax/sfhttp.tmLanguage.json             | 36 +++++++++++++++++++
 pnpm-lock.yaml                                | 33 ++++++++++++++---
 6 files changed, 131 insertions(+), 18 deletions(-)
 create mode 100644 packages/vscode-extension/src/codeLensProviders/executeApiLensProvider.ts
 create mode 100644 packages/vscode-extension/syntax/sfhttp.tmLanguage.json

diff --git a/packages/vscode-extension/package.json b/packages/vscode-extension/package.json
index 6d201b9e..ff0d6186 100644
--- a/packages/vscode-extension/package.json
+++ b/packages/vscode-extension/package.json
@@ -1275,6 +1275,11 @@
                 "language": "vldp",
                 "scopeName": "source.json",
                 "path": "./syntax/datapack.tmLanguage.json"
+            },
+            {
+                "language": "sfhttp",
+                "scopeName": "source.sfhttp",
+                "path": "./syntax/sfhttp.tmLanguage.json"
             }
         ],
         "languages": [
@@ -1290,6 +1295,16 @@
                 ],
                 "configuration": "./syntax/datapack-language.json"
             },
+            {
+                "id": "sfhttp",
+                "aliases": [
+                    "Salesforce HTTP API"
+                ],
+                "extensions": [
+                    ".sfhttp",
+                    ".http"
+                ]
+            },
             {
                 "id": "xml",
                 "extensions": [
@@ -1578,6 +1593,7 @@
         "vsce": "^2.15.0",
         "vscode-languageclient": "^8.1.0",
         "vscode-test": "^1.6.1",
+        "vscode-tmgrammar-test": "^0.1.2",
         "webpack": "^5.88.2",
         "webpack-cli": "^5.1.4",
         "webpack-glob-entry": "^2.1.1",
diff --git a/packages/vscode-extension/src/codeLensProviders/executeApiLensProvider.ts b/packages/vscode-extension/src/codeLensProviders/executeApiLensProvider.ts
new file mode 100644
index 00000000..0a5d9793
--- /dev/null
+++ b/packages/vscode-extension/src/codeLensProviders/executeApiLensProvider.ts
@@ -0,0 +1,36 @@
+import * as vscode from 'vscode';
+
+import VlocodeService from "../lib/vlocodeService";
+import { container, injectable } from "@vlocode/core";
+
+@injectable()
+export class ExecuteApiLensProvider implements vscode.CodeLensProvider {
+
+    private regex = /^(GET|POST|PUT|DELETE|PATCH) (.*)$/i
+
+    public static register(service: VlocodeService) {
+        const lens = container.get(ExecuteApiLensProvider);
+        vscode.languages.registerCodeLensProvider({ pattern: '**/*.{api,http,sfhttp,sfapi}' }, lens);
+        vscode.languages.registerCodeLensProvider({ language: 'sfhttp' }, lens);
+    }
+
+    public provideCodeLenses(document: vscode.TextDocument): vscode.CodeLens[] {
+        for (let i = 0; i < document.lineCount; i++) {
+            const line = document.lineAt(i);
+            const match = line.text.match(this.regex);
+            if (match) {
+                return [
+                    new vscode.CodeLens(line.range, {
+                        title: `Execute as Salesforce API Request (${match[1].toLowerCase()})`,
+                        tooltip: "Execute the API request described in this file on the selected Salesforce org",
+                        command: "vlocode.api.execute",
+                        arguments: [ document ]
+                    })
+                ];
+            } else if (line.text) {
+                break;
+            }
+        }
+        return [];
+    }
+}
\ No newline at end of file
diff --git a/packages/vscode-extension/src/extension.ts b/packages/vscode-extension/src/extension.ts
index 3f16cddb..7145804d 100644
--- a/packages/vscode-extension/src/extension.ts
+++ b/packages/vscode-extension/src/extension.ts
@@ -31,6 +31,7 @@ import { VlocityNamespaceService } from '@vlocode/vlocity';
 import { SfdxConfigWatcher } from './lib/sfdxConfigWatcher';
 
 import './commands';
+import { ExecuteApiLensProvider } from './codeLensProviders/executeApiLensProvider';
 
 /**
  * Start time of the extension set when the extension is packed by webpack when the entry point is loaded
@@ -205,16 +206,18 @@ class Vlocode {
 
         // Add apex LOG symbol provider
         try {
-            this.service.registerDisposable(vscode.languages.registerDocumentSymbolProvider({ language: 'apexlog' }, new ApexLogSymbolProvider()));
+            ApexLogSymbolProvider.register(this.service);
         } catch(err) {
             this.logger.warn(`Unable to register symbol provider for APEX logs: ${err}`);
         }
 
+        ExecuteApiLensProvider.register(this.service);
+
         // Watch conditionalContextMenus for changes
         ConfigurationManager.onConfigChange(this.service.config, 'conditionalContextMenus',
             config => vscode.commands.executeCommand('setContext', `${constants.CONTEXT_PREFIX}.conditionalContextMenus`, config.conditionalContextMenus), { initial: true });
 
-        // watch for changes 
+        // watch for changes
         void this.service.registerDisposable(container.create(WorkspaceContextDetector, 'datapacks', DatapackDetector.filter()).initialize());
         void this.service.registerDisposable(container.create(WorkspaceContextDetector, 'metadata', MetadataDetector.filter()).initialize());
         void this.service.registerDisposable(container.create(SfdxConfigWatcher).initialize());
diff --git a/packages/vscode-extension/src/symbolProviders/apexLogSymbolProvider.ts b/packages/vscode-extension/src/symbolProviders/apexLogSymbolProvider.ts
index 5492346a..446866c8 100644
--- a/packages/vscode-extension/src/symbolProviders/apexLogSymbolProvider.ts
+++ b/packages/vscode-extension/src/symbolProviders/apexLogSymbolProvider.ts
@@ -1,25 +1,24 @@
 import * as vscode from 'vscode';
 
-/**
- * 
-09:41:19.369 (369138479)|METHOD_ENTRY|[1]|01p0Y00000O9SLP|OrderRepository.OrderRepository()
-09:41:19.369 (369244047)|METHOD_EXIT|[1]|OrderRepository
-09:41:19.369 (369309631)|CONSTRUCTOR_ENTRY|[17]|01p0Y00000O9SLP|<init>()|OrderRepository
-09:41:19.369 (369582949)|CONSTRUCTOR_EXIT|[17]|01p0Y00000O9SLP|<init>()|OrderRepository
-09:41:19.369 (369616240)|CONSTRUCTOR_ENTRY|[17]|01p5E000001BvvA|<init>(IOrderRepository)|OrderItemsController
-09:41:19.369 (369653962)|METHOD_ENTRY|[4]|01p5E000001FJwa|VlocityController.VlocityController()
-09:41:19.369 (369667080)|METHOD_EXIT|[4]|VlocityController
-09:41:19.369 (369616240)|CONSTRUCTOR_EXIT|[17]|01p5E000001BvvA|<init>(IOrderRepository)|OrderItemsController
- */
+import { container, injectable } from '@vlocode/core';
+import VlocodeService from '../lib/vlocodeService';
 
 /**
  * Provides Symbol and Outline information for Salesforce APEX logs
  */
+@injectable()
 export class ApexLogSymbolProvider implements vscode.DocumentSymbolProvider {
 
     readonly functionPattern = /^(?<time>[\d+:.]+) \(\d+\)\|(?<type>CONSTRUCTOR|METHOD|SYSTEM_METHOD)_(?<mode>ENTRY|EXIT)\|\[\d+\]\|(?<name>.*)$/;
     readonly assignmentPattern = /^(?<time>[\d+:.]+) \(\d+\)\|VARIABLE_ASSIGNMENT\|\[\d+\]\|(?<name>.*)$/;
 
+    public static register(service: VlocodeService) {
+        const symbolProvider = container.get(ApexLogSymbolProvider);
+        service.registerDisposable(
+            vscode.languages.registerDocumentSymbolProvider({ language: 'apexlog' }, symbolProvider)
+        );
+    }
+
     public provideDocumentSymbols(document: vscode.TextDocument): vscode.DocumentSymbol[] {
         const symbols = this.parseSymbols(this.getDocumentLineIterator(document));
         return symbols;
diff --git a/packages/vscode-extension/syntax/sfhttp.tmLanguage.json b/packages/vscode-extension/syntax/sfhttp.tmLanguage.json
new file mode 100644
index 00000000..be4e60e3
--- /dev/null
+++ b/packages/vscode-extension/syntax/sfhttp.tmLanguage.json
@@ -0,0 +1,36 @@
+{
+    "name": "Salesforce http API",
+    "scopeName": "source.sfhttp",
+    "patterns": [{ "include": "#method-and-headers" }],
+    "repository": {
+        "method-and-headers": {
+            "patterns": [{ "include": "#method-and-url" }, { "include": "#header" }],
+            "end": "\\r?\\n\\r?\\n"
+        },
+        "method-and-url": {
+            "captures": {
+                "1": { "name": "http.sf.method" },
+                "2": { "name": "http.sf.url" }
+            },
+            "match": "(?i)^(GET|POST|PUT|DELETE|PATCH) (.*)$\\n?",
+            "name": "meta.http.sf.method-url"
+        },
+        "header": {
+            "captures": {
+                "1": { "name": "http.sf.header.name" },
+                "2": { "name": "http.sf.header.value" }
+            },
+            "match": "(?i)^([a-z]+)[ ]*:[ ]*([a-z]+)$\\n?",
+            "name": "meta.http.sf.header"
+        },
+        "comment": {
+            "captures": {
+                "1": {
+                    "name": "http.sf.method.comment"
+                }
+            },
+            "match": "(//).*$\\n?",
+            "name": "comment.line.double-slash"
+        }
+    }
+}
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 6fe95516..cf3cd795 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -776,6 +776,9 @@ importers:
       vscode-test:
         specifier: ^1.6.1
         version: 1.6.1
+      vscode-tmgrammar-test:
+        specifier: ^0.1.2
+        version: 0.1.2
       webpack:
         specifier: ^5.88.2
         version: 5.88.2(esbuild@0.14.49)(webpack-cli@5.1.4)
@@ -2167,6 +2170,7 @@ packages:
   /@oclif/config@1.18.16:
     resolution: {integrity: sha512-VskIxVcN22qJzxRUq+raalq6Q3HUde7sokB7/xk5TqRZGEKRVbFeqdQBxDWwQeudiJEgcNiMvIFbMQ43dY37FA==}
     engines: {node: '>=8.0.0'}
+    deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.
     dependencies:
       '@oclif/errors': 1.3.6
       '@oclif/parser': 3.8.16
@@ -2220,6 +2224,7 @@ packages:
   /@oclif/errors@1.3.6:
     resolution: {integrity: sha512-fYaU4aDceETd89KXP+3cLyg9EHZsLD3RxF2IU9yxahhBpspWjkWi3Dy3bTgcwZ3V47BgxQaGapzJWDM33XIVDQ==}
     engines: {node: '>=8.0.0'}
+    deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.
     dependencies:
       clean-stack: 3.0.1
       fs-extra: 9.1.0
@@ -2252,6 +2257,7 @@ packages:
   /@oclif/parser@3.8.16:
     resolution: {integrity: sha512-jeleXSh5izmBQ6vwyCJmbFPahPpd/ajxASi25FaYAWcvwVMzP/vKAKQXKWZun6T9K/gd6ywSsTpfAXiZAjBd6g==}
     engines: {node: '>=8.0.0'}
+    deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.
     dependencies:
       '@oclif/errors': 1.3.6
       '@oclif/linewrap': 1.0.0
@@ -3176,7 +3182,7 @@ packages:
       webpack: 5.x.x
       webpack-cli: 5.x.x
     dependencies:
-      webpack: 5.88.2(webpack-cli@5.1.4)
+      webpack: 5.88.2(esbuild@0.14.49)(webpack-cli@5.1.4)
       webpack-cli: 5.1.4(webpack@5.88.2)
     dev: true
 
@@ -3187,7 +3193,7 @@ packages:
       webpack: 5.x.x
       webpack-cli: 5.x.x
     dependencies:
-      webpack: 5.88.2(webpack-cli@5.1.4)
+      webpack: 5.88.2(esbuild@0.14.49)(webpack-cli@5.1.4)
       webpack-cli: 5.1.4(webpack@5.88.2)
     dev: true
 
@@ -3202,7 +3208,7 @@ packages:
       webpack-dev-server:
         optional: true
     dependencies:
-      webpack: 5.88.2(webpack-cli@5.1.4)
+      webpack: 5.88.2(esbuild@0.14.49)(webpack-cli@5.1.4)
       webpack-cli: 5.1.4(webpack@5.88.2)
     dev: true
 
@@ -5693,7 +5699,7 @@ packages:
       esbuild: 0.19.2
       get-tsconfig: 4.7.0
       loader-utils: 2.0.4
-      webpack: 5.88.2(webpack-cli@5.1.4)
+      webpack: 5.88.2(esbuild@0.14.49)(webpack-cli@5.1.4)
       webpack-sources: 1.4.3
     dev: true
 
@@ -11377,6 +11383,7 @@ packages:
     hasBin: true
     dependencies:
       lru-cache: 6.0.0
+    dev: true
 
   /semver@7.5.4:
     resolution: {integrity: sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==}
@@ -13045,10 +13052,26 @@ packages:
       - supports-color
     dev: true
 
+  /vscode-textmate@7.0.4:
+    resolution: {integrity: sha512-9hJp0xL7HW1Q5OgGe03NACo7yiCTMEk3WU/rtKXUbncLtdg6rVVNJnHwD88UhbIYU2KoxY0Dih0x+kIsmUKn2A==}
+    dev: true
+
   /vscode-textmate@8.0.0:
     resolution: {integrity: sha512-AFbieoL7a5LMqcnOF04ji+rpXadgOXnZsxQr//r83kLPr7biP7am3g9zbaZIaBGwBRWeSvoMD4mgPdX3e4NWBg==}
     dev: true
 
+  /vscode-tmgrammar-test@0.1.2:
+    resolution: {integrity: sha512-tLJZMAP/NWeRwlpHzjSXx+HvjJzFltndoyR6AK9fJRGjALJX6Pg7EOiYyznpJ4TNC2eMmF3IRbcZBWzJwN+n5g==}
+    hasBin: true
+    dependencies:
+      chalk: 4.1.2
+      commander: 9.5.0
+      diff: 4.0.2
+      glob: 7.2.3
+      vscode-oniguruma: 1.7.0
+      vscode-textmate: 7.0.4
+    dev: true
+
   /w3c-hr-time@1.0.2:
     resolution: {integrity: sha512-z8P5DvDNjKDoFIHK7q8r8lackT6l+jo/Ye3HOle7l9nICP9lf1Ci25fy9vHd0JOWewkIFzXIEig3TdKT7JQ5fQ==}
     deprecated: Use your platform's native performance.now() and performance.timeOrigin.
@@ -13138,7 +13161,7 @@ packages:
       import-local: 3.1.0
       interpret: 3.1.1
       rechoir: 0.8.0
-      webpack: 5.88.2(webpack-cli@5.1.4)
+      webpack: 5.88.2(esbuild@0.14.49)(webpack-cli@5.1.4)
       webpack-merge: 5.9.0
     dev: true