remove nested commands' events from outer KernelCommandResult.Events (#3177)

* allow explicit parenting, refactor away a bunch of command id usage

* remove command id from .NET code

* wip: remove id from TypeScript command

* Fix tests for polyglot notebook ts project

* align bahaviour to C#

* remove token property on typescript

* cleanup getOrCreateToken usage

* fix the child command root

* rename nested classes to avoid warning

---------

Co-authored-by: Diego Colombo <[email protected]>

Author: jonsequitur

src/Microsoft.DotNet.Interactive.ApiCompatibility.Tests/ApiCompatibilityTests.Interactive_api_is_not_changed.approved.txt

@@ -179,7 +179,7 @@ Microsoft.DotNet.Interactive
     public System.Threading.Tasks.Task EndInvoke(System.IAsyncResult result)
     public System.Threading.Tasks.Task Invoke(Microsoft.DotNet.Interactive.Commands.KernelCommand command, KernelInvocationContext context, KernelPipelineContinuation next)
   public class KernelCommandResult
-    .ctor(Microsoft.DotNet.Interactive.Commands.KernelCommand command, System.Collections.Generic.IEnumerable<Microsoft.DotNet.Interactive.Events.KernelEvent> events = null)
+    .ctor(Microsoft.DotNet.Interactive.Commands.KernelCommand command)
     public Microsoft.DotNet.Interactive.Commands.KernelCommand Command { get;}
     public System.Collections.Generic.IReadOnlyList<Microsoft.DotNet.Interactive.Events.KernelEvent> Events { get;}
   public class KernelCommandScheduler : KernelScheduler<Microsoft.DotNet.Interactive.Commands.KernelCommand,KernelCommandResult>, IKernelScheduler<Microsoft.DotNet.Interactive.Commands.KernelCommand,KernelCommandResult>, System.IDisposable
@@ -394,10 +394,9 @@ Microsoft.DotNet.Interactive.Commands
     public Microsoft.DotNet.Interactive.CommandRoutingSlip RoutingSlip { get;}
     public System.String TargetKernelName { get;}
     public System.Boolean Equals(KernelCommand other)
-    public System.Int32 GetHashCode()
     public System.String GetOrCreateToken()
     public System.Threading.Tasks.Task InvokeAsync(Microsoft.DotNet.Interactive.KernelInvocationContext context)
-    public System.Void SetId(System.String id)
+    public System.Void SetParent(KernelCommand parent)
     public System.Void SetToken(System.String token)
   public abstract class LanguageServiceCommand : KernelCommand, System.IEquatable<KernelCommand>
     public System.String Code { get;}
@@ -478,7 +477,6 @@ Microsoft.DotNet.Interactive.Connection
     public System.Threading.Tasks.Task SendAsync(Microsoft.DotNet.Interactive.Events.KernelEvent kernelEvent, System.Threading.CancellationToken cancellationToken)
   public abstract class IKernelCommandEnvelope
     public Microsoft.DotNet.Interactive.Commands.KernelCommand Command { get;}
-    public System.String CommandId { get;}
     public System.String CommandType { get;}
     public System.String Token { get;}
   public abstract class IKernelEventEnvelope
@@ -512,7 +510,6 @@ Microsoft.DotNet.Interactive.Connection
     public static System.Void RegisterDefaults()
     public static System.String Serialize(Microsoft.DotNet.Interactive.Commands.KernelCommand command)
     public static System.String Serialize(IKernelCommandEnvelope envelope)
-    public System.String CommandId { get;}
     public System.String CommandType { get;}
     public System.String Token { get;}
   public class KernelCommandEnvelope<T> : KernelCommandEnvelope, IKernelCommandEnvelope

src/Microsoft.DotNet.Interactive.CSharpProject.Tests/SerializationTests.Command_contract_has_not_been_broken.approved.CompileProject.json

@@ -1,6 +1,5 @@
 {
   "token": "the-token",
-  "id": "command-id",
   "commandType": "CompileProject",
   "command": {
     "targetKernelName": null,

src/Microsoft.DotNet.Interactive.CSharpProject.Tests/SerializationTests.Command_contract_has_not_been_broken.approved.OpenDocument.json

@@ -1,6 +1,5 @@
 {
   "token": "the-token",
-  "id": "command-id",
   "commandType": "OpenDocument",
   "command": {
     "relativeFilePath": "./path",

src/Microsoft.DotNet.Interactive.CSharpProject.Tests/SerializationTests.Command_contract_has_not_been_broken.approved.OpenProject.json

@@ -1,6 +1,5 @@
 {
   "token": "the-token",
-  "id": "command-id",
   "commandType": "OpenProject",
   "command": {
     "project": {

src/Microsoft.DotNet.Interactive.CSharpProject.Tests/SerializationTests.Event_contract_has_not_been_broken.approved.AssemblyProduced.json

@@ -7,7 +7,6 @@
   "eventType": "AssemblyProduced",
   "command": {
     "token": "the-token",
-    "id": "command-id",
     "commandType": "CompileProject",
     "command": {
       "targetKernelName": null,

src/Microsoft.DotNet.Interactive.CSharpProject.Tests/SerializationTests.Event_contract_has_not_been_broken.approved.DocumentOpened.json

@@ -7,7 +7,6 @@
   "eventType": "DocumentOpened",
   "command": {
     "token": "the-token",
-    "id": "command-id",
     "commandType": "OpenDocument",
     "command": {
       "relativeFilePath": "./path",

src/Microsoft.DotNet.Interactive.CSharpProject.Tests/SerializationTests.Event_contract_has_not_been_broken.approved.ProjectOpened.json

@@ -15,7 +15,6 @@
   "eventType": "ProjectOpened",
   "command": {
     "token": "the-token",
-    "id": "command-id",
     "commandType": "OpenProject",
     "command": {
       "project": {

src/Microsoft.DotNet.Interactive.CSharpProject.Tests/SerializationTests.cs

@@ -97,7 +97,6 @@ public void Command_contract_has_not_been_broken(KernelCommand command)
             .UsingExtension($"{command.GetType().Name}.json")
             .SetInteractive(Debugger.IsAttached);
 
-        command.SetId("command-id");
         command.SetToken("the-token");
 
         var json = KernelCommandEnvelope.Serialize(command);
@@ -113,7 +112,6 @@ public void Event_contract_has_not_been_broken(KernelEvent @event)
             .UsingExtension($"{@event.GetType().Name}.json")
             .SetInteractive(Debugger.IsAttached);
 
-        @event.Command?.SetId("command-id");
         @event.Command?.SetToken("the-token");
 
         var json = KernelEventEnvelope.Serialize(@event);

src/Microsoft.DotNet.Interactive.Jupyter.Tests/MagicCommandTests.lsmagic.cs

@@ -1,6 +1,7 @@
 // Copyright (c) .NET Foundation and contributors. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
+using System;
 using System.CommandLine;
 using System.Linq;
 using System.Threading.Tasks;
@@ -11,20 +12,37 @@
 using Microsoft.DotNet.Interactive.Formatting;
 using Microsoft.DotNet.Interactive.FSharp;
 using Microsoft.DotNet.Interactive.Tests.Utility;
+using Microsoft.VisualStudio.TestPlatform.Utilities;
+using Pocket;
+using Pocket.For.Xunit;
 using Xunit;
+using Xunit.Abstractions;
 
 namespace Microsoft.DotNet.Interactive.Jupyter.Tests;
 
 public partial class MagicCommandTests
 {
-    public class LSMmagic
+    [LogToPocketLogger(FileNameEnvironmentVariable = "POCKETLOGGER_LOG_PATH")]
+    public class LSMmagic : IDisposable
     {
+        private readonly CompositeDisposable _disposables = new();
+
+        public LSMmagic(ITestOutputHelper output)
+        {
+            _disposables.Add(output.SubscribeToPocketLogger());
+        }
+
+        public void Dispose()
+        {
+            _disposables.Dispose();
+        }
+
         [Fact]
         public async Task lsmagic_lists_registered_magic_commands()
         {
             using var kernel = new CompositeKernel()
-                .UseDefaultMagicCommands()
-                .LogEventsToPocketLogger();
+                               .UseDefaultMagicCommands()
+                               .LogEventsToPocketLogger();
 
             kernel.AddDirective(new Command("#!one"));
             kernel.AddDirective(new Command("#!two"));

src/Microsoft.DotNet.Interactive.Jupyter/KernelExtensions.cs

@@ -224,6 +224,7 @@ private static Command lsmagic(Kernel kernel)
                 foreach (var subkernel in subkernels)
                 {
                     var command = new SubmitCode(((SubmitCode)context.Command).Code);
+                    command.SetParent(context.Command);
 
                     await subkernel.SendAsync(command);
                 }