Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Handle the unknown-op status from test commands. #1365

Merged
merged 1 commit into from
Nov 12, 2021
Merged

Handle the unknown-op status from test commands. #1365

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions src/nrepl/cider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@

// https://github.com/clojure-emacs/cider-nrepl/blob/a740583c3aa8b582f3097611787a276775131d32/src/cider/nrepl/middleware/test.clj#L45
export interface TestSummary {
ns: number;
var: number;
test: number;
pass: number;
fail: number;
error: number;
};

// https://github.com/clojure-emacs/cider-nrepl/blob/a740583c3aa8b582f3097611787a276775131d32/src/cider/nrepl/middleware/test.clj#L97-L112
export interface TestResult {
context: string;
index: number;
message: string;
ns: string;
type: string;
var: string;
expected?: string;
'gen-input'?: string;
actual?: string;
diffs?: unknown;
error?: unknown;
line?: number
file?: string;
}

// https://github.com/clojure-emacs/cider-nrepl/blob/a740583c3aa8b582f3097611787a276775131d32/src/cider/nrepl/middleware/test.clj#L45-L46
export interface TestResults {
summary: TestSummary;
results: {
[key: string]: {
[key: string]: TestResult[]
}
}
'testing-ns'?: string
'gen-input': unknown
}
134 changes: 53 additions & 81 deletions src/nrepl/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import * as net from "net";
import { BEncoderStream, BDecoderStream } from "./bencode";
import * as cider from './cider'
import * as state from './../state';
import * as util from '../utilities';
import { PrettyPrintingOptions, disabledPrettyPrinter, getServerSidePrinter } from "../printer";
Expand All @@ -13,6 +14,28 @@ import { getStateValue, prettyPrint } from '../../out/cljs-lib/cljs-lib';
import { getConfig } from '../config';
import { log, Direction, loggingEnabled } from './logging';

function hasStatus(res: any, status: string): boolean {
return res.status && res.status.indexOf(status) > -1;
}

// When a command fails becuase of an unknown-op (usually caused by missing
// middleware), we can mark the operation as failed, so that we can show a message
// in the UI to the user.
// https://nrepl.org/nrepl/design/handlers.html
// If the handler being used by an nREPL server does not recognize or cannot
// perform the operation indicated by a request message’s :op, then it should
// respond with a message containing a :status of "unknown-op".
function resultHandler(resolve: any, reject: any) {
return (res: any): boolean => {
if (hasStatus(res, "unknown-op")) {
reject("The server does not recognize or cannot perform the '" + res.op + "' operation");
} else {
resolve(res);
}
return true;
}
}

/** An nREPL client */
export class NReplClient {
private _nextId = 0;
Expand Down Expand Up @@ -120,7 +143,7 @@ export class NReplClient {
} else if (data["id"] === nsId) {
if (data["ns"])
client.ns = data["ns"];
if (data["status"] && data["status"].indexOf("done") !== -1)
if (hasStatus(data, "done"))
client.encoder.write({ "op": "clone", "id": cloneId });
} else if (data["id"] === cloneId) {
client.session = new NReplSession(data["new-session"], client);
Expand Down Expand Up @@ -241,32 +264,23 @@ export class NReplSession {
describe(verbose?: boolean) {
return new Promise<any>((resolve, reject) => {
let id = this.client.nextId;
this.messageHandlers[id] = (msg) => {
resolve(msg);
return true;
}
this.messageHandlers[id] = resultHandler(resolve, reject);
this.client.write({ op: "describe", id: id, session: this.sessionId, verbose });
})
}

listSessions() {
return new Promise<any>((resolve, reject) => {
let id = this.client.nextId;
this.messageHandlers[id] = (msg) => {
resolve(msg);
return true;
}
this.messageHandlers[id] = resultHandler(resolve, reject);
this.client.write({ op: "ls-sessions", id: id, session: this.sessionId });
})
}

stacktrace() {
return new Promise<any>((resolve, reject) => {
let id = this.client.nextId;
this.messageHandlers[id] = (msg) => {
resolve(msg);
return true;
}
this.messageHandlers[id] = resultHandler(resolve, reject);
this.client.write({ op: "stacktrace", id, session: this.sessionId });
})
}
Expand Down Expand Up @@ -326,10 +340,7 @@ export class NReplSession {
}
let id = this.client.nextId;
return new Promise<void>((resolve, reject) => {
this.messageHandlers[id] = (msg) => {
resolve();
return true;
}
this.messageHandlers[id] = resultHandler(resolve, reject);
this.client.write({ op: "interrupt", session: this.sessionId, "interrupt-id": interruptId, id })
});
}
Expand Down Expand Up @@ -369,10 +380,7 @@ export class NReplSession {
return new Promise<any>((resolve, reject) => {
const id = this.client.nextId,
extraOpts = getConfig().enableJSCompletions ? { "enhanced-cljs-completion?": "t" } : {};
this.messageHandlers[id] = (msg) => {
resolve(msg);
return true;
}
this.messageHandlers[id] = resultHandler(resolve, reject);
this.client.write({
op: "complete",
ns,
Expand All @@ -388,32 +396,23 @@ export class NReplSession {
info(ns: string, symbol: string) {
return new Promise<any>((resolve, reject) => {
let id = this.client.nextId;
this.messageHandlers[id] = (msg) => {
resolve(msg);
return true;
}
this.messageHandlers[id] = resultHandler(resolve, reject);
this.client.write({ op: "info", ns, symbol, id, session: this.sessionId })
})
}

classpath() {
return new Promise<any>((resolve, reject) => {
let id = this.client.nextId;
this.messageHandlers[id] = (msg) => {
resolve(msg);
return true;
}
this.messageHandlers[id] = resultHandler(resolve, reject);
this.client.write({ op: "classpath", id, session: this.sessionId })
})
}

test(ns: string, test: string) {
test(ns: string, test: string): Promise<cider.TestResults> {
return new Promise<any>((resolve, reject) => {
const id = this.client.nextId;
this.messageHandlers[id] = (msg) => {
resolve(msg);
return true;
};
this.messageHandlers[id] = resultHandler(resolve, reject);
this.client.write({
op: "test-var-query",
ns,
Expand All @@ -431,12 +430,9 @@ export class NReplSession {
}

testNs(ns: string) {
return new Promise<any>((resolve, reject) => {
return new Promise<cider.TestResults>((resolve, reject) => {
let id = this.client.nextId;
this.messageHandlers[id] = (msg) => {
resolve(msg);
return true;
}
this.messageHandlers[id] = resultHandler(resolve, reject);
this.client.write({
op: "test-var-query", ns, id, session: this.sessionId, "var-query": {
"ns-query": {
Expand All @@ -448,56 +444,41 @@ export class NReplSession {
}

testAll() {
return new Promise<any>((resolve, reject) => {
return new Promise<cider.TestResults>((resolve, reject) => {
let id = this.client.nextId;
this.messageHandlers[id] = (msg) => {
resolve(msg);
return true;
}
this.messageHandlers[id] = resultHandler(resolve, reject);
this.client.write({ op: "test-all", id, session: this.sessionId, "load?": true });
})
}

retest() {
return new Promise<any>((resolve, reject) => {
return new Promise<cider.TestResults>((resolve, reject) => {
let id = this.client.nextId;
this.messageHandlers[id] = (msg) => {
resolve(msg);
return true;
}
this.messageHandlers[id] = resultHandler(resolve, reject);
this.client.write({ op: "retest", id, session: this.sessionId });
})
}

loadAll() {
return new Promise<any>((resolve, reject) => {
let id = this.client.nextId;
this.messageHandlers[id] = (msg) => {
resolve(msg);
return true;
}
this.messageHandlers[id] = resultHandler(resolve, reject);
this.client.write({ op: "ns-load-all", id, session: this.sessionId });
})
}

listNamespaces(regexps: string[]) {
return new Promise<any>((resolve, reject) => {
let id = this.client.nextId;
this.messageHandlers[id] = (msg) => {
resolve(msg);
return true;
}
this.messageHandlers[id] = resultHandler(resolve, reject);
this.client.write({ op: "ns-list", id, session: this.sessionId, "filter-regexps": regexps });
})
}

nsPath(ns: string) {
return new Promise<any>((resolve, reject) => {
let id = this.client.nextId;
this.messageHandlers[id] = (msg) => {
resolve(msg);
return true;
}
this.messageHandlers[id] = resultHandler(resolve, reject);
this.client.write({ op: "ns-path", id, ns, session: this.sessionId });
})
}
Expand All @@ -510,16 +491,16 @@ export class NReplSession {
this.messageHandlers[id] = (msg) => {
if (msg.reloading)
reloaded = msg.reloading;
if (msg.status && msg.status.indexOf("ok") != -1)
if (hasStatus(msg, "ok"))
status = "ok";
if (msg.status && msg.status.indexOf("error") != -1) {
if (hasStatus(msg, "error")) {
status = "error";
error = msg.error;
errorNs = msg["error-ns"];
}
if (msg.err)
err += msg.err
if (msg.status && msg.status.indexOf("done") != -1) {
if (hasStatus(msg, "done")) {
let res = { reloaded, status } as any;
if (error) res.error = error;
if (errorNs) res.errorNs = errorNs;
Expand All @@ -543,10 +524,7 @@ export class NReplSession {
formatCode(code: string, options?: string) {
return new Promise<any>((resolve, reject) => {
let id = this.client.nextId;
this.messageHandlers[id] = (msg) => {
resolve(msg);
return true;
}
this.messageHandlers[id] = resultHandler(resolve, reject);
this.client.write({ op: "format-code", code, options })
});
}
Expand Down Expand Up @@ -576,12 +554,9 @@ export class NReplSession {
}

sendDebugInput(input: any, debugResponseId: string, debugResponseKey: string): Promise<any> {
return new Promise<any>((resolve, _) => {
return new Promise<any>((resolve, reject) => {

this.messageHandlers[debugResponseId] = (response) => {
resolve(response);
return true;
};
this.messageHandlers[debugResponseId] = resultHandler(resolve, reject);

const data: any = {
id: debugResponseId,
Expand All @@ -596,12 +571,9 @@ export class NReplSession {
}

listDebugInstrumentedDefs(): Promise<any> {
return new Promise<any>((resolve, _) => {
return new Promise<any>((resolve, reject) => {
let id = this.client.nextId;
this.messageHandlers[id] = (msg) => {
resolve(msg);
return true;
}
this.messageHandlers[id] = resultHandler(resolve, reject);
this.client.write({ op: 'debug-instrumented-defs', id, session: this.sessionId });
});
}
Expand Down Expand Up @@ -794,7 +766,7 @@ export class NReplEvaluation {
this._exception = msg.ex;
}
// cider-nrepl debug middleware eval error (eval error occurred during debug session)
if (msg.status && msg.status.indexOf('eval-error') !== -1 && msg.causes) {
if (hasStatus(msg, 'eval-error') && msg.causes) {
const cause = msg.causes[0];
const errorMessage = `${cause.class}: ${cause.message}`;
this._stacktrace = { stacktrace: cause.stacktrace };
Expand Down Expand Up @@ -829,7 +801,7 @@ export class NReplEvaluation {
});
}
}
if (msg.status && (msg.status.indexOf('done') !== -1 || msg.status.indexOf('need-debug-input') !== -1)) {
if (hasStatus(msg, 'done') || hasStatus(msg, 'need-debug-input')) {
this.remove();
if (this.exception && this.msgValue !== debug.DEBUG_QUIT_VALUE) {
this.session.stacktrace().then((stacktrace) => {
Expand Down
Loading