| 1 |
// Copyright (c) Jupyter Development Team. |
| 2 |
// Distributed under the terms of the Modified BSD License. |
| 3 |
|
| 4 |
import * as widgets from '@jupyter-widgets/base'; |
| 5 |
import * as services from '@jupyterlab/services'; |
| 6 |
import { DummyManager } from './dummy-manager'; |
| 7 |
|
| 8 |
import type { JSONValue, JSONObject } from '@lumino/coreutils'; |
| 9 |
|
| 10 |
let numComms = 0; |
| 11 |
|
| 12 |
export class MockComm implements widgets.IClassicComm { |
| 13 |
constructor() { |
| 14 |
this.comm_id = `mock-comm-id-${numComms}`; |
| 15 |
numComms += 1; |
| 16 |
} |
| 17 |
|
| 18 |
on_close(fn: Function | null): void { |
| 19 |
this._on_close = fn; |
| 20 |
} |
| 21 |
|
| 22 |
on_msg(fn: Function | null): void { |
| 23 |
this._on_msg = fn; |
| 24 |
} |
| 25 |
|
| 26 |
_process_msg(msg: services.KernelMessage.ICommMsgMsg): void | Promise<void> { |
| 27 |
if (this._on_msg) { |
| 28 |
return this._on_msg(msg); |
| 29 |
} else { |
| 30 |
return Promise.resolve(); |
| 31 |
} |
| 32 |
} |
| 33 |
|
| 34 |
open( |
| 35 |
data: JSONValue, |
| 36 |
callbacks?: widgets.ICallbacks, |
| 37 |
metadata?: JSONObject, |
| 38 |
buffers?: ArrayBuffer[] | ArrayBufferView[] |
| 39 |
): string { |
| 40 |
if (this._on_open) { |
| 41 |
this._on_open(); |
| 42 |
} |
| 43 |
return ''; |
| 44 |
} |
| 45 |
|
| 46 |
close( |
| 47 |
data?: JSONValue, |
| 48 |
callbacks?: widgets.ICallbacks, |
| 49 |
metadata?: JSONObject, |
| 50 |
buffers?: ArrayBuffer[] | ArrayBufferView[] |
| 51 |
): string { |
| 52 |
if (this._on_close) { |
| 53 |
this._on_close(); |
| 54 |
} |
| 55 |
return ''; |
| 56 |
} |
| 57 |
|
| 58 |
send( |
| 59 |
data: JSONValue, |
| 60 |
callbacks?: widgets.ICallbacks, |
| 61 |
metadata?: JSONObject, |
| 62 |
buffers?: ArrayBuffer[] | ArrayBufferView[] |
| 63 |
): string { |
| 64 |
return ''; |
| 65 |
} |
| 66 |
|
| 67 |
comm_id: string; |
| 68 |
target_name: string; |
| 69 |
_on_msg: Function | null = null; |
| 70 |
_on_close: Function | null = null; |
| 71 |
_on_open: Function | null = null; |
| 72 |
} |
| 73 |
|
| 74 |
export interface IConstructor<T> { |
| 75 |
new (attributes?: any, options?: any): T; |
| 76 |
} |
| 77 |
|
| 78 |
export function createTestModel<T extends widgets.WidgetModel>( |
| 79 |
constructor: IConstructor<T>, |
| 80 |
attributes?: any, |
| 81 |
widget_manager?: widgets.WidgetModel['widget_manager'] |
| 82 |
): T { |
| 83 |
const id = widgets.uuid(); |
| 84 |
const modelOptions = { |
| 85 |
widget_manager: widget_manager || new DummyManager(), |
| 86 |
model_id: id, |
| 87 |
}; |
| 88 |
|
| 89 |
return new constructor(attributes, modelOptions); |
| 90 |
} |
| 91 |
|
| 92 |
export async function createTestModelFromSerialized< |
| 93 |
T extends widgets.WidgetModel |
| 94 |
>( |
| 95 |
constructor: IConstructor<T>, |
| 96 |
state?: any, |
| 97 |
widget_manager?: widgets.WidgetModel['widget_manager'] |
| 98 |
): Promise<T> { |
| 99 |
widget_manager = widget_manager || new DummyManager(); |
| 100 |
const attributes = await (constructor as any)._deserialize_state( |
| 101 |
state, |
| 102 |
widget_manager |
| 103 |
); |
| 104 |
|
| 105 |
return createTestModel(constructor, attributes, widget_manager); |
| 106 |
} |
| 107 |
|
| 108 |
export function createTestView<T extends widgets.WidgetView>( |
| 109 |
model: widgets.WidgetModel, |
| 110 |
viewCtor: IConstructor<T> |
| 111 |
): Promise<T> { |
| 112 |
const mgr = model.widget_manager as DummyManager; |
| 113 |
mgr.testClasses[model.get('_view_name')] = viewCtor; |
| 114 |
return model.widget_manager.create_view(model, undefined) as any; |
| 115 |
} |