call OnError, update debug logging

Author: an-dr-eas-k

src/observers/OmnisharpDebugModeLoggerObserver.ts

@@ -5,7 +5,7 @@
 
 import { BaseLoggerObserver } from "./BaseLoggerObserver";
 import * as os from 'os';
-import { BaseEvent, OmnisharpRequestMessage, OmnisharpServerEnqueueRequest, OmnisharpServerDequeueRequest, OmnisharpServerRequestCanceled, OmnisharpServerVerboseMessage, OmnisharpServerProcessRequestStart, OmnisharpEventPacketReceived } from "../omnisharp/loggingEvents";
+import { BaseEvent, OmnisharpRequestMessage, OmnisharpServerEnqueueRequest, OmnisharpServerDequeueRequest, OmnisharpServerRequestCancelled, OmnisharpServerVerboseMessage, OmnisharpServerProcessRequestStart, OmnisharpEventPacketReceived } from "../omnisharp/loggingEvents";
 import { EventType } from "../omnisharp/EventType";
 
 export class OmnisharpDebugModeLoggerObserver extends BaseLoggerObserver {
@@ -20,8 +20,8 @@ export class OmnisharpDebugModeLoggerObserver extends BaseLoggerObserver {
             case EventType.OmnisharpServerDequeueRequest:
                 this.handleOmnisharpServerDequeueRequest(<OmnisharpServerDequeueRequest>event);
                 break;
-            case EventType.OmnisharpServerRequestCanceled:
-                this.handleOmnisharpServerRequestCanceled(<OmnisharpServerRequestCanceled>event);
+            case EventType.OmnisharpServerRequestCancelled:
+                this.handleOmnisharpServerRequestCancelled(<OmnisharpServerRequestCancelled>event);
                 break;
                 case EventType.OmnisharpServerProcessRequestStart:
                 this.handleOmnisharpProcessRequestStart(<OmnisharpServerProcessRequestStart>event);
@@ -47,17 +47,17 @@ export class OmnisharpDebugModeLoggerObserver extends BaseLoggerObserver {
     }
 
     private handleOmnisharpServerEnqueueRequest(event: OmnisharpServerEnqueueRequest) {
-        this.logger.appendLine(`Enqueue ${event.name} request for ${event.command}.`);
+        this.logger.appendLine(`Enqueue to ${event.queueName} request for ${event.command}.`);
         this.logger.appendLine();
     }
 
     private handleOmnisharpServerDequeueRequest(event: OmnisharpServerDequeueRequest) {
-        this.logger.appendLine(`Dequeue ${event.name} request for ${event.command} (${event.id}).`);
+        this.logger.appendLine(`Dequeue from ${event.queueName} with status ${event.queueStatus} request for ${event.command}${event.id? ` (${event.id})`: ''}.`);
         this.logger.appendLine();
     }
 
-    private handleOmnisharpServerRequestCanceled(event: OmnisharpServerRequestCanceled) {
-        this.logger.appendLine(`Canceled request for ${event.command} (${event.id}).`);
+    private handleOmnisharpServerRequestCancelled(event: OmnisharpServerRequestCancelled) {
+        this.logger.appendLine(`Cancelled request for ${event.command} (${event.id}).`);
         this.logger.appendLine();
     }
 

src/omnisharp/EventType.ts

@@ -83,7 +83,7 @@ export enum EventType {
     DotNetTestRunInContextStart = 76,
     DotNetTestDebugInContextStart = 77,
     TelemetryErrorEvent = 78,
-    OmnisharpServerRequestCanceled = 79
+    OmnisharpServerRequestCancelled = 79
 }
 
 //Note that the EventType protocol is shared with Razor.VSCode and the numbers here should not be altered

src/omnisharp/loggingEvents.ts

@@ -115,16 +115,16 @@ export class OmnisharpServerUnresolvedDependencies implements BaseEvent {
 
 export class OmnisharpServerEnqueueRequest implements BaseEvent {
     type = EventType.OmnisharpServerEnqueueRequest;
-    constructor(public name: string, public command: string) { }
+    constructor(public queueName: string, public command: string) { }
 }
 
 export class OmnisharpServerDequeueRequest implements BaseEvent {
     type = EventType.OmnisharpServerDequeueRequest;
-    constructor(public name: string, public command: string, public id: number) { }
+    constructor(public queueName: string, public queueStatus: string, public command: string, public id?: number) { }
 }
 
-export class OmnisharpServerRequestCanceled implements BaseEvent {
-    type = EventType.OmnisharpServerRequestCanceled;
+export class OmnisharpServerRequestCancelled implements BaseEvent {
+    type = EventType.OmnisharpServerRequestCancelled;
     constructor(public command: string, public id: number) { }
 }
 

src/omnisharp/requestQueue.ts

@@ -48,7 +48,7 @@ class RequestQueue {
 
         if (request) {
             this._waiting.delete(id);
-            this.eventStream.post(new OmnisharpServerDequeueRequest(this._name, request.command, id));
+            this.eventStream.post(new OmnisharpServerDequeueRequest(this._name, "waiting", request.command, id));
         }
 
         return request;
@@ -58,9 +58,7 @@ class RequestQueue {
         let index = this._pending.indexOf(request);
         if (index !== -1) {
             this._pending.splice(index, 1);
-
-            // Note: This calls reject() on the promise returned by OmniSharpServer.makeRequest
-            request.onError(new Error(`Pending request cancelled: ${request.command}`));
+            this.eventStream.post(new OmnisharpServerDequeueRequest(this._name, "pending", request.command));
         }
 
         if (request.id){
@@ -90,9 +88,9 @@ class RequestQueue {
             return;
         }
 
-        this.eventStream.post(new OmnisharpServerProcessRequestStart(this._name));
-
         const slots = this._maxSize - this._waiting.size;
+        
+        this.eventStream.post(new OmnisharpServerProcessRequestStart(this._name, slots));
 
         for (let i = 0; i < slots && this._pending.length > 0; i++) {
             const item = this._pending.shift();

src/omnisharp/server.ts

@@ -572,8 +572,10 @@ export class OmniSharpServer {
 
         if (token) {
             token.onCancellationRequested(() => {
-                this.eventStream.post(new ObservableEvents.OmnisharpServerRequestCanceled(request.command, request.id));
+                this.eventStream.post(new ObservableEvents.OmnisharpServerRequestCancelled(request.command, request.id));
                 this._requestQueue.cancelRequest(request);
+                // Note: This calls reject() on the promise returned by OmniSharpServer.makeRequest
+                request.onError(new Error(`Request ${request.command} cancelled, id: ${request.id}`));
             });
         }
 

test/unitTests/logging/OmnisharpDebugModeLoggerObserver.test.ts

@@ -4,7 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 import { use, should, expect } from 'chai';
 import { getNullChannel } from '../testAssets/Fakes';
-import { OmnisharpServerVerboseMessage, EventWithMessage, OmnisharpRequestMessage, OmnisharpServerEnqueueRequest, OmnisharpServerDequeueRequest, OmnisharpServerProcessRequestStart, OmnisharpEventPacketReceived, OmnisharpServerProcessRequestComplete } from '../../../src/omnisharp/loggingEvents';
+import { OmnisharpServerVerboseMessage, EventWithMessage, OmnisharpRequestMessage, OmnisharpServerEnqueueRequest, OmnisharpServerDequeueRequest, OmnisharpServerProcessRequestStart, OmnisharpEventPacketReceived, OmnisharpServerProcessRequestComplete, OmnisharpServerRequestCancelled } from '../../../src/omnisharp/loggingEvents';
 import { OmnisharpDebugModeLoggerObserver } from '../../../src/observers/OmnisharpDebugModeLoggerObserver';
 
 use(require("chai-string"));
@@ -33,25 +33,33 @@ suite("OmnisharpDebugModeLoggerObserver", () => {
     test(`OmnisharpServerEnqueueRequest: Name and Command is logged`, () => {
         let event = new OmnisharpServerEnqueueRequest("foo", "someCommand");
         observer.post(event);
-        expect(logOutput).to.contain(event.name);
+        expect(logOutput).to.contain(event.queueName);
         expect(logOutput).to.contain(event.command);
     });
 
-    test(`OmnisharpServerDequeueRequest: Name and Command is logged`, () => {
-        let event = new OmnisharpServerDequeueRequest("foo", "someCommand", 1);
+    test(`OmnisharpServerDequeueRequest: QueueName, QueueStatus, Command and Id is logged`, () => {
+        let event = new OmnisharpServerDequeueRequest("foo", "pending", "someCommand", 1);
         observer.post(event);
-        expect(logOutput).to.contain(event.name);
+        expect(logOutput).to.contain(event.queueName);
+        expect(logOutput).to.contain(event.queueStatus);
         expect(logOutput).to.contain(event.command);
         expect(logOutput).to.contain(event.id);
     });
 
-    test(`OmnisharpProcessRequestStart: Name is logged`, () => {
+    test(`OmnisharpProcessRequestStart: Name and slots is logged`, () => {
         let event = new OmnisharpServerProcessRequestStart("foobar", 2);
         observer.post(event);
         expect(logOutput).to.contain(event.name);
         expect(logOutput).to.contain(event.slots);
     });
 
+    test(`OmnisharpServerRequestCancelled: Name and Id is logged`, () => {
+        let event = new OmnisharpServerRequestCancelled("foobar", 23);
+        observer.post(event);
+        expect(logOutput).to.contain(event.command);
+        expect(logOutput).to.contain(event.id);
+    });
+
     test(`OmnisharpServer messages increase and decrease indent`, () => {
         observer.post(new OmnisharpServerVerboseMessage("!indented_1"));
         observer.post(new OmnisharpServerProcessRequestStart("name", 2));