@eclipse-glsp/vscode-integration
Version:
Glue code to integrate GLSP diagrams in VSCode extensions (extension part)
121 lines • 5.23 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.wrapNodeWs = exports.isValidWebSocketAddress = exports.SocketGlspVscodeServer = void 0;
/********************************************************************************
* Copyright (c) 2021-2023 EclipseSource and others.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* http://www.eclipse.org/legal/epl-2.0.
*
* This Source Code may also be made available under the following Secondary
* Licenses when the conditions for such availability set forth in the Eclipse
* Public License v. 2.0 are satisfied: GNU General Public License, version 2
* with the GNU Classpath Exception which is available at
* https://www.gnu.org/software/classpath/license.html.
*
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
********************************************************************************/
const protocol_1 = require("@eclipse-glsp/protocol");
const net = require("net");
const vscode_jsonrpc_1 = require("vscode-jsonrpc");
const node_1 = require("vscode-jsonrpc/node");
const ws_1 = require("ws");
const base_glsp_vscode_server_1 = require("../../common/quickstart-components/base-glsp-vscode-server");
/**
* This component can be used to bootstrap your extension when using the default
* GLSP server implementation via (Web)socket connection
*
* It sets up a JSON-RPC connection to a server running on a specified port and
* provides an interface, ready to be used by the `GlspVscodeConnector` for the
* GLSP-VSCode integration.
*
* If you need a component to quickly start your default GLSP server, take a look
* at the `GlspServerStarter` quickstart component.
*/
class SocketGlspVscodeServer extends base_glsp_vscode_server_1.BaseGlspVscodeServer {
constructor(options) {
super(options);
this.options = options;
}
getWebSocketAddress() {
var _a, _b;
const opts = this.options.connectionOptions;
if ('webSocketAddress' in opts) {
return opts.webSocketAddress;
}
if ('path' in opts && opts.path !== undefined) {
const protocol = (_a = opts.protocol) !== null && _a !== void 0 ? _a : 'ws';
const host = (_b = opts.host) !== null && _b !== void 0 ? _b : '127.0.0.1';
return `${protocol}://${host}:${opts.port}/${opts.path}`;
}
return undefined;
}
async createGLSPClient() {
const connection = await this.createConnection();
this.toDispose.push(connection);
return new protocol_1.BaseJsonrpcGLSPClient({
id: this.options.clientId,
connectionProvider: connection
});
}
async createConnection() {
const webSocketAddress = this.getWebSocketAddress();
if (webSocketAddress && !isValidWebSocketAddress(webSocketAddress)) {
throw new Error(`Could not connect to to GLSP Server. The WebSocket address is invalid: '${webSocketAddress}'`);
}
if (webSocketAddress) {
return this.createWebSocketConnection(webSocketAddress);
}
if (!('port' in this.options.connectionOptions)) {
throw new Error('Could not connect to to GLSP Server. The given server port is not defined');
}
if (isNaN(this.options.connectionOptions.port)) {
throw new Error(`Could not connect to to GLSP Server. The given server port is not a number: ${this.options.connectionOptions.port}`);
}
return this.createSocketConnection(this.options.connectionOptions);
}
createSocketConnection(opts) {
const socket = new net.Socket();
const reader = new node_1.SocketMessageReader(socket);
const writer = new node_1.SocketMessageWriter(socket);
const connection = (0, vscode_jsonrpc_1.createMessageConnection)(reader, writer);
socket.connect(opts);
return connection;
}
createWebSocketConnection(address) {
const webSocket = new ws_1.WebSocket(address);
return new Promise(resolve => {
webSocket.onopen = () => {
const socket = wrapNodeWs(webSocket);
resolve((0, protocol_1.createWebSocketConnection)(socket));
};
});
}
}
exports.SocketGlspVscodeServer = SocketGlspVscodeServer;
function isValidWebSocketAddress(address) {
try {
const { protocol } = new URL(address);
return protocol === 'ws:' || protocol === 'wss:';
}
catch (error) {
return false;
}
}
exports.isValidWebSocketAddress = isValidWebSocketAddress;
function wrapNodeWs(socket) {
return {
send: content => socket.send(content),
onMessage: cb => (socket.onmessage = event => cb(event.data)),
onClose: cb => (socket.onclose = event => cb(event.code, event.reason)),
onError: cb => (socket.onerror = event => {
if ('error' in event) {
cb(event.error);
}
}),
dispose: () => socket.close()
};
}
exports.wrapNodeWs = wrapNodeWs;
//# sourceMappingURL=socket-glsp-vscode-server.js.map