Include title in telemetry commands (#6800)

bhsubra · web-flow · commit 6c9fa0824023 · 2022-05-10T13:32:11.000-07:00
diff --git a/src/Bicep.Core.Samples/Files/Completions/declarations.json b/src/Bicep.Core.Samples/Files/Completions/declarations.json
diff --git a/src/Bicep.Core.Samples/Files/Completions/moduleObject.json b/src/Bicep.Core.Samples/Files/Completions/moduleObject.json
@@ -85,13 +85,14 @@
       "newText": "{\n\t$0\n}"
     },
     "command": {
+      "title": "module body completion snippet",
       "command": "bicep.Telemetry",
       "arguments": [
         {
+          "EventName": "snippet/modulebody",
           "Properties": {
             "name": "{}"
-          },
-          "EventName": "snippet/modulebody"
+          }
         }
       ]
     }
diff --git a/src/Bicep.Core.Samples/Files/InvalidModules_LF/Completions/moduleBodyCompletions.json b/src/Bicep.Core.Samples/Files/InvalidModules_LF/Completions/moduleBodyCompletions.json
@@ -85,13 +85,14 @@
       "newText": "{\n\tname: $1\n\tparams: {\n\t\tarrayParam: $2\n\t\tobjParam: {\n\t\t}\n\t\tstringParamB: $3\n\t}\n}$0"
     },
     "command": {
+      "title": "module body completion snippet",
       "command": "bicep.Telemetry",
       "arguments": [
         {
+          "EventName": "snippet/modulebody",
           "Properties": {
             "name": "required-properties"
-          },
-          "EventName": "snippet/modulebody"
+          }
         }
       ]
     }
@@ -114,13 +115,14 @@
       "newText": "{\n\t$0\n}"
     },
     "command": {
+      "title": "module body completion snippet",
       "command": "bicep.Telemetry",
       "arguments": [
         {
+          "EventName": "snippet/modulebody",
           "Properties": {
             "name": "{}"
-          },
-          "EventName": "snippet/modulebody"
+          }
         }
       ]
     }
diff --git a/src/Bicep.Core.Samples/Files/InvalidOutputs_CRLF/Completions/objectPlusSymbols.json b/src/Bicep.Core.Samples/Files/InvalidOutputs_CRLF/Completions/objectPlusSymbols.json
@@ -1341,6 +1341,7 @@
       "newText": "{\n\t$0\n}"
     },
     "command": {
+      "title": "object body completion snippet",
       "command": "bicep.Telemetry",
       "arguments": [
         {
diff --git a/src/Bicep.Core.Samples/Files/InvalidParameters_LF/Completions/objectPlusSymbols.json b/src/Bicep.Core.Samples/Files/InvalidParameters_LF/Completions/objectPlusSymbols.json
@@ -2106,6 +2106,7 @@
       "newText": "{\n\t$0\n}"
     },
     "command": {
+      "title": "object body completion snippet",
       "command": "bicep.Telemetry",
       "arguments": [
         {
diff --git a/src/Bicep.Core.Samples/Files/InvalidResources_CRLF/Completions/deploymentScriptTopLevel.json b/src/Bicep.Core.Samples/Files/InvalidResources_CRLF/Completions/deploymentScriptTopLevel.json
@@ -103,6 +103,7 @@
       "newText": "resource ${1:Identifier} '${2:Type}' = {\n  name: $3\n  properties: {\n    $0\n  }\n}"
     },
     "command": {
+      "title": "nested resource declaration completion snippet",
       "command": "bicep.Telemetry",
       "arguments": [
         {
@@ -132,6 +133,7 @@
       "newText": "resource ${1:Identifier} '${2:Type}' = {\n  name: $3\n  $0\n}"
     },
     "command": {
+      "title": "nested resource declaration completion snippet",
       "command": "bicep.Telemetry",
       "arguments": [
         {
diff --git a/src/Bicep.Core.Samples/Files/InvalidResources_CRLF/Completions/discriminatorProperty.json b/src/Bicep.Core.Samples/Files/InvalidResources_CRLF/Completions/discriminatorProperty.json
@@ -49,6 +49,7 @@
       "newText": "resource ${1:Identifier} '${2:Type}' = {\n  name: $3\n  properties: {\n    $0\n  }\n}"
     },
     "command": {
+      "title": "nested resource declaration completion snippet",
       "command": "bicep.Telemetry",
       "arguments": [
         {
@@ -78,6 +79,7 @@
       "newText": "resource ${1:Identifier} '${2:Type}' = {\n  name: $3\n  $0\n}"
     },
     "command": {
+      "title": "nested resource declaration completion snippet",
       "command": "bicep.Telemetry",
       "arguments": [
         {
diff --git a/src/Bicep.Core.Samples/Files/InvalidResources_CRLF/Completions/objectPlusFor.json b/src/Bicep.Core.Samples/Files/InvalidResources_CRLF/Completions/objectPlusFor.json
@@ -85,6 +85,7 @@
       "newText": "{\n\tname: $1\n\tlocation: $2\n}$0"
     },
     "command": {
+      "title": "resource body completion snippet",
       "command": "bicep.Telemetry",
       "arguments": [
         {
@@ -115,6 +116,7 @@
       "newText": "{\n  name: ${1:'name'}\n  location: ${2:location}\n}\n"
     },
     "command": {
+      "title": "resource body completion snippet",
       "command": "bicep.Telemetry",
       "arguments": [
         {
@@ -145,6 +147,7 @@
       "newText": "{\n\t$0\n}"
     },
     "command": {
+      "title": "resource body completion snippet",
       "command": "bicep.Telemetry",
       "arguments": [
         {
diff --git a/src/Bicep.Core.Samples/Files/InvalidResources_CRLF/Completions/objectPlusSymbols.json b/src/Bicep.Core.Samples/Files/InvalidResources_CRLF/Completions/objectPlusSymbols.json
@@ -5936,6 +5936,7 @@
       "newText": "{\n\t$0\n}"
     },
     "command": {
+      "title": "object body completion snippet",
       "command": "bicep.Telemetry",
       "arguments": [
         {
diff --git a/src/Bicep.Core.Samples/Files/InvalidResources_CRLF/Completions/objectPlusSymbolsWithRequiredProperties.json b/src/Bicep.Core.Samples/Files/InvalidResources_CRLF/Completions/objectPlusSymbolsWithRequiredProperties.json
@@ -4519,6 +4519,7 @@
       "newText": "{\n\tname: $1\n}$0"
     },
     "command": {
+      "title": "object body completion snippet",
       "command": "bicep.Telemetry",
       "arguments": [
         {
@@ -5965,6 +5966,7 @@
       "newText": "{\n\t$0\n}"
     },
     "command": {
+      "title": "object body completion snippet",
       "command": "bicep.Telemetry",
       "arguments": [
         {
diff --git a/src/Bicep.Core.Samples/Files/InvalidResources_CRLF/Completions/topLevelProperties.json b/src/Bicep.Core.Samples/Files/InvalidResources_CRLF/Completions/topLevelProperties.json
@@ -157,6 +157,7 @@
       "newText": "resource ${1:Identifier} '${2:Type}' = {\n  name: $3\n  properties: {\n    $0\n  }\n}"
     },
     "command": {
+      "title": "nested resource declaration completion snippet",
       "command": "bicep.Telemetry",
       "arguments": [
         {
@@ -186,6 +187,7 @@
       "newText": "resource ${1:Identifier} '${2:Type}' = {\n  name: $3\n  $0\n}"
     },
     "command": {
+      "title": "nested resource declaration completion snippet",
       "command": "bicep.Telemetry",
       "arguments": [
         {
diff --git a/src/Bicep.Core.Samples/Files/InvalidResources_CRLF/Completions/topLevelPropertiesMinusName.json b/src/Bicep.Core.Samples/Files/InvalidResources_CRLF/Completions/topLevelPropertiesMinusName.json
@@ -139,6 +139,7 @@
       "newText": "resource ${1:Identifier} '${2:Type}' = {\n  name: $3\n  properties: {\n    $0\n  }\n}"
     },
     "command": {
+      "title": "nested resource declaration completion snippet",
       "command": "bicep.Telemetry",
       "arguments": [
         {
@@ -168,6 +169,7 @@
       "newText": "resource ${1:Identifier} '${2:Type}' = {\n  name: $3\n  $0\n}"
     },
     "command": {
+      "title": "nested resource declaration completion snippet",
       "command": "bicep.Telemetry",
       "arguments": [
         {
diff --git a/src/Bicep.LangServer/Completions/BicepCompletionProvider.cs b/src/Bicep.LangServer/Completions/BicepCompletionProvider.cs
@@ -24,6 +24,7 @@
 using Bicep.LanguageServer.Snippets;
 using Bicep.LanguageServer.Telemetry;
 using Bicep.LanguageServer.Utils;
+using Newtonsoft.Json.Linq;
 using OmniSharp.Extensions.LanguageServer.Protocol.Models;
 using Range = OmniSharp.Extensions.LanguageServer.Protocol.Models.Range;
 using SymbolKind = Bicep.Core.Semantics.SymbolKind;
@@ -105,7 +106,12 @@ private IEnumerable<CompletionItem> GetDeclarationCompletions(SemanticModel mode
                 {
                     string prefix = resourceSnippet.Prefix;
                     BicepTelemetryEvent telemetryEvent = BicepTelemetryEvent.CreateTopLevelDeclarationSnippetInsertion(prefix);
-                    Command command = Command.Create(TelemetryConstants.CommandName, telemetryEvent);
+                    var command = TelemetryHelper.CreateCommand
+                    (
+                        title: "top level snippet completion",
+                        name: TelemetryConstants.CommandName,
+                        args: JArray.FromObject(new List<object> { telemetryEvent })
+                    );
 
                     yield return CreateContextualSnippetCompletion(prefix,
                                                                    resourceSnippet.Detail,
@@ -127,8 +133,12 @@ private IEnumerable<CompletionItem> GetDeclarationCompletions(SemanticModel mode
                     {
                         string prefix = snippet.Prefix;
                         BicepTelemetryEvent telemetryEvent = BicepTelemetryEvent.CreateNestedResourceDeclarationSnippetInsertion(prefix);
-                        Command command = Command.Create(TelemetryConstants.CommandName, telemetryEvent);
-
+                        var command = TelemetryHelper.CreateCommand
+                        (
+                            title: "nested resource declaration completion snippet",
+                            name: TelemetryConstants.CommandName,
+                            args: JArray.FromObject(new List<object> { telemetryEvent })
+                        );
                         yield return CreateContextualSnippetCompletion(prefix,
                             snippet.Detail,
                             snippet.Text,
@@ -509,7 +519,12 @@ private IEnumerable<CompletionItem> CreateResourceBodyCompletions(SemanticModel
                 {
                     string prefix = snippet.Prefix;
                     BicepTelemetryEvent telemetryEvent = BicepTelemetryEvent.CreateResourceBodySnippetInsertion(prefix, resourceType.Type.Name);
-                    Command command = Command.Create(TelemetryConstants.CommandName, telemetryEvent);
+                    Command command = TelemetryHelper.CreateCommand
+                    (
+                        title: "resource body completion snippet",
+                        name: TelemetryConstants.CommandName,
+                        args: JArray.FromObject(new List<object> { telemetryEvent })
+                    );
 
                     yield return CreateContextualSnippetCompletion(prefix,
                         snippet.Detail,
@@ -531,8 +546,12 @@ private IEnumerable<CompletionItem> CreateModuleBodyCompletions(SemanticModel mo
             {
                 string prefix = snippet.Prefix;
                 BicepTelemetryEvent telemetryEvent = BicepTelemetryEvent.CreateModuleBodySnippetInsertion(prefix);
-                Command command = Command.Create(TelemetryConstants.CommandName, telemetryEvent);
-
+                var command = TelemetryHelper.CreateCommand
+                (
+                    title: "module body completion snippet",
+                    name: TelemetryConstants.CommandName,
+                    args: JArray.FromObject(new List<object> { telemetryEvent })
+                );
                 yield return CreateContextualSnippetCompletion(prefix,
                     snippet.Detail,
                     snippet.Text,
@@ -934,8 +953,12 @@ private IEnumerable<CompletionItem> GetObjectBodyCompletions(TypeSymbol typeSymb
             {
                 string prefix = snippet.Prefix;
                 BicepTelemetryEvent telemetryEvent = BicepTelemetryEvent.CreateObjectBodySnippetInsertion(prefix);
-                Command command = Command.Create(TelemetryConstants.CommandName, telemetryEvent);
-
+                var command = TelemetryHelper.CreateCommand
+                (
+                    title: "object body completion snippet",
+                    name: TelemetryConstants.CommandName,
+                    args: JArray.FromObject(new List<object> { telemetryEvent })
+                );
                 yield return CreateContextualSnippetCompletion(prefix,
                     snippet.Detail,
                     snippet.Text,
diff --git a/src/Bicep.LangServer/Handlers/BicepCodeActionHandler.cs b/src/Bicep.LangServer/Handlers/BicepCodeActionHandler.cs
@@ -22,6 +22,7 @@
 using Bicep.LanguageServer.Extensions;
 using Bicep.LanguageServer.Telemetry;
 using Bicep.LanguageServer.Utils;
+using Newtonsoft.Json.Linq;
 using OmniSharp.Extensions.LanguageServer.Protocol;
 using OmniSharp.Extensions.LanguageServer.Protocol.Client.Capabilities;
 using OmniSharp.Extensions.LanguageServer.Protocol.Document;
@@ -160,7 +161,11 @@ public override Task<CommandOrCodeActionContainer> Handle(CodeActionParams reque
             }
 
             BicepTelemetryEvent telemetryEvent = BicepTelemetryEvent.CreateDisableNextLineDiagnostics(diagnosticCode.String);
-            var telemetryCommand = Command.Create(TelemetryConstants.CommandName, telemetryEvent);
+            var telemetryCommand = TelemetryHelper.CreateCommand(
+                title: "disable next line diagnostics code action",
+                name: TelemetryConstants.CommandName,
+                args: JArray.FromObject(new List<object> { telemetryEvent })
+            );
 
             return new CodeAction
             {
@@ -181,8 +186,13 @@ private static CommandOrCodeAction CreateEditLinterRuleAction(DocumentUri docume
             return new CodeAction
             {
                 Title = String.Format(LangServerResources.EditLinterRuleActionTitle, ruleName),
-                Command = Command.Create(LanguageConstants.EditLinterRuleCommandName, documentUri, ruleName, bicepConfigFilePath ?? string.Empty /* (passing null not allowed) */)
-        };
+                Command = TelemetryHelper.CreateCommand
+                (
+                    title: "edit linter rule code action",
+                    name: LanguageConstants.EditLinterRuleCommandName,
+                    args: JArray.FromObject(new List<object> { documentUri, ruleName, bicepConfigFilePath ?? string.Empty /* (passing null not allowed) */ })
+                )
+            };
         }
 
         public override Task<CodeAction> Handle(CodeAction request, CancellationToken cancellationToken)
diff --git a/src/Bicep.LangServer/Telemetry/TelemetryHelper.cs b/src/Bicep.LangServer/Telemetry/TelemetryHelper.cs
@@ -5,6 +5,8 @@
 using System.Linq;
 using Bicep.Core.Analyzers.Linter;
 using Bicep.Core.Configuration;
+using Newtonsoft.Json.Linq;
+using OmniSharp.Extensions.LanguageServer.Protocol.Models;
 
 namespace Bicep.LanguageServer.Telemetry
 {
@@ -54,5 +56,17 @@ public static IEnumerable<BicepTelemetryEvent> GetTelemetryEventsForBicepConfigC
 
             return telemetryEvents;
         }
+
+        // Per LSP spec - https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#command
+        // title and name are required
+        public static Command CreateCommand(string title, string name, JArray? args)
+        {
+            return new Command()
+            {
+                Title = title,
+                Name = name,
+                Arguments = args
+            };
+        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -85,13 +85,14 @@`
`85`	`85`	`"newText": "{\n\t$0\n}"`
`86`	`86`	`},`
`87`	`87`	`"command": {`
	`88`	`+ "title": "module body completion snippet",`
`88`	`89`	`"command": "bicep.Telemetry",`
`89`	`90`	`"arguments": [`
`90`	`91`	`{`
	`92`	`+ "EventName": "snippet/modulebody",`
`91`	`93`	`"Properties": {`
`92`	`94`	`"name": "{}"`
`93`		`- },`
`94`		`- "EventName": "snippet/modulebody"`
	`95`	`+ }`
`95`	`96`	`}`
`96`	`97`	`]`
`97`	`98`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1341,6 +1341,7 @@`
`1341`	`1341`	`"newText": "{\n\t$0\n}"`
`1342`	`1342`	`},`
`1343`	`1343`	`"command": {`
	`1344`	`+ "title": "object body completion snippet",`
`1344`	`1345`	`"command": "bicep.Telemetry",`
`1345`	`1346`	`"arguments": [`
`1346`	`1347`	`{`
Original file line number	Diff line number	Diff line change
`@@ -2106,6 +2106,7 @@`
`2106`	`2106`	`"newText": "{\n\t$0\n}"`
`2107`	`2107`	`},`
`2108`	`2108`	`"command": {`
	`2109`	`+ "title": "object body completion snippet",`
`2109`	`2110`	`"command": "bicep.Telemetry",`
`2110`	`2111`	`"arguments": [`
`2111`	`2112`	`{`
Original file line number	Diff line number	Diff line change
`@@ -5936,6 +5936,7 @@`
`5936`	`5936`	`"newText": "{\n\t$0\n}"`
`5937`	`5937`	`},`
`5938`	`5938`	`"command": {`
	`5939`	`+ "title": "object body completion snippet",`
`5939`	`5940`	`"command": "bicep.Telemetry",`
`5940`	`5941`	`"arguments": [`
`5941`	`5942`	`{`