Changes for page Running KEITH

Last modified by Richard Kreissig on 2023/09/14 08:48

From version < 26.1 >

edited by Soeren Domroes
on 2019/07/09 10:44

To version < 24.1 >

edited by Soeren Domroes
on 2019/05/16 10:56

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Objects (1 modified, 0 added, 0 removed)
- Confluence.Code.ConfluencePageClass[0]

Details

Page properties

Content

@@ -139,29 +139,16 @@
  Open the {{code language="none"}}package.json{{/code}}. In the{{code language="none"}} package.json{{/code}} are several scripts defined.
--{{code language="js"}}
--"scripts": {
--        "prepare": "yarn run clean && yarn build",
--        "clean": "theia clean",
--        "build": "theia build --mode development",
--        "start": "theia start --root-dir=../workspace",
--        "socket": "node ./src-gen/backend/main.js --root-dir=../workspace --LSP_PORT=5007 --port=3000 --loglevel=debug",
--        "watch": "theia build --watch --mode development"
--    },
--{{/code}}
++[[image:attach:image2019-2-7_18-0-7.png]]
--\\
--
  The {{code language="none"}}LSP_PORT{{/code}} option is used to activate the connection via socket. It is also possible to specify a relative location to a LS via {{code language="none"}}LS_PATH=<path to LS>{{/code}}.
++\\
++
  == How run KEITH in developer setup (socket) ==
  Run the following to build and run KEITH in its developer setup (in socket mode, so the LS has to be started separately)
--=== Running KEITH in the browser ===
--
--\\
--
  {{code language="bash"}}
  yarn && cd keith-app && yarn run socket
  {{/code}}
@@ -170,42 +170,285 @@
  Per default the KEITH opens on localhost:3000.
--{{info}}
--If you previously build keith electron, you have to execute {{code language="none"}}yarn run rebuild: browser{{/code}}
--{{/info}}
++It is required to restart the language server if KEITH is restarted, since the diagram view has a problem (since theia-sprotty is used) to reconnect after that.
++=== Known issues for windows: ===
++
++nsfw.code not found: In the top level package.json exists a script called postinstall. Remove this on windows, delete the node_modules folder and rebuilt the application. This is a known issue of electron-builder.
++
++=== Known issues on mac: ===
++
++Since SWT is still used as part of the diagram synthesis (but is not relevant anymore). Since it is not called on the main thread this causes a deadlock. Therefore mac just does not work.
++
++=== Known issues: ===
++
  \\
--=== Running KEITH as (unbundled) electron app ===
++= Developing for KEITH =
--{{code language="bash"}}
--yarn && yarn run rebuild:electron && cd keith-app-electron && yarn run socket
++We use java ServiceLoader to register stuff. Here is a small example how a LanguageServerExtension is registered via a ServiceLoader and how it is used:
++
++== Register LanguageServerExtensions (ServiceLoader Example) ==
++
++This is a LanguageServerExtension. It has to be used in the de.cau.cs.kieler.language.server plugin. Since the language-server-plugin should not have dependencies to all plugins that define a language server extension dependency inversion is used to prevent that. A ServiceLoader does exactly that.
++
++Here is such an example extension, the KiCoolLanguageServerExtension:
++
++{{code}}
++package de.cau.cs.kieler.kicool.ide.language.server
++
++
++/**
++ * @author really fancy name
++ *
++ */
++@Singleton
++class KiCoolLanguageServerExtension implements ILanguageServerExtension, CommandExtension, ILanguageClientProvider {
++	// fancy extension stuff
++
++	var KeithLanguageClient client
++	// A language server extension must implement the initialize method,
++	// it is however only called if the extension is registered via a language.
++	// This should never be the case, so this is never called.
++    override initialize(ILanguageServerAccess access) {
++        this.languageServerAccess = access
++    }
++
++	// implement ILanguageClientProvider
++    override setLanguageClient(LanguageClient client) {
++        this.client = client as KeithLanguageClient
++    }
++
++	// implement ILanguageClientProvider
++    override getLanguageClient() {
++        return this.client
++    }
++
++}
  {{/code}}
--//yarn// builds all the stuff. //yarn run socket// in keith-app-electron starts the application. After an initial build via yarn you can run //yarn watch // to watch the changes in your repository. In another console you run yarn run socket in keith-app-electron. Now refreshing your browser is enough to apply the changes.
++The CommandExtension defines all commands (requests or notifications) that are send from client to server. An example how this looks like can be seen in the code snippet Example CommandExtension is an example how to [[define a server side extension interface.>>doc:||anchor="Registeranextension(onserverside)"]]
--{{info}}
--If you previously build keith electron, you have to execute {{code language="none"}}yarn run rebuild: browser{{/code}}
--{{/info}}
++The ILanguageClientProvider should be implemented by an extension that plans to send [[messages from the server to the client>>doc:||anchor="ServerClientcommunicationinterface"]].
--=== Known issues for windows: ===
++This language server extension is provided by a corresponding contribution, which is later used to access it:
--nsfw.code not found: In the top level package.json exists a script called postinstall. Remove this on windows, delete the node_modules folder and rebuilt the application. This is a known issue of electron-builder.
++{{code}}
++package de.cau.cs.kieler.kicool.ide.language.server
--=== Known issues on mac: ===
++import com.google.inject.Injector
++import de.cau.cs.kieler.language.server.ILanguageServerContribution
--Since SWT is still used as part of the diagram synthesis (but is not relevant anymore). Since it is not called on the main thread this causes a deadlock. Therefore mac just does not work.
++/**
++ * @author really fancy name
++ *
++ */
++class KiCoolLanguageServerContribution implements ILanguageServerContribution {
++
++    override getLanguageServerExtension(Injector injector) {
++        return injector.getInstance(KiCoolLanguageServerExtension)
++    }
++}
++{{/code}}
--=== Known issues: ===
++Create a file called de.cau.cs.kieler.language.server.ILanguageServerContribution in <plugin>/META-INF/services/ (in this example this is de.cau.cs.kieler.kicool.ide). The name of the file refers to the contribution interface that should be used to provide the contribution. The content of the file is the following:
--* KEITH works in the browser/electron app, but not in the electron app/browser with the following error message:(((
--{{code language="none"}}symbol lookup error: ... symbol lookup error: .../keith/node_modules/nsfw/build/Release/nsfw.node: undefined symbol: _ZN2v816FunctionTemplate3NewEPNS_7IsolateEPFvRKNS_20FunctionCallbackInfoINS_5ValueEEEENS_5LocalIS4_EENSA_INS_9SignatureEEEiNS_19ConstructorBehaviorENS_14SideEffectTypeE {{/code}}{{code language="none"}}Done in 0.90s.{{/code}}
++{{code}}
++de.cau.cs.kieler.kicool.ide.language.server.KiCoolLanguageServerContribution
++{{/code}}
--* run
++This is the fully qualified name of the contribution written earlier.
--{{code language="none"}}
--yarn run rebuild:electron/browser
--{{/code}} after yarn to fix this.
--)))
++The language server uses all LanguageServerExtensions like this:
++{{code}}
++var iLanguageServerExtensions = <Object>newArrayList(languageServer) // list of all language server extensions
++for (lse : KielerServiceLoader.load(ILanguageServerContribution)) { // load all contributions
++	iLanguageServerExtensions.add(lse.getLanguageServerExtension(injector))
++}
++{{/code}}
++
++The resulting list of implementions is used to add the extensions to the language server.
++
++== Register an extension (on server side) ==
++
++See example above for ServiceLoader and initial stuff.
++
++What is still missing are the contents of the CommandExtension implemented by the KiCoolLanguageServerExtension. This is an interface defining all additional commands. The CommandExtension looks like this.
++
++{{code title="Example CommandExtension"}}
++package de.cau.cs.kieler.kicool.ide.language.server
++
++import java.util.concurrent.CompletableFuture
++import org.eclipse.lsp4j.jsonrpc.services.JsonRequest
++import org.eclipse.lsp4j.jsonrpc.services.JsonSegment
++
++/**
++ * Interface to the LSP extension commands
++ *
++ * @author really fancy name
++ *
++ */
++@JsonSegment('keith/kicool')
++interface CommandExtension {
++
++    /**
++     * Compiles file given by uri with compilationsystem given by command.
++     */
++    @JsonRequest('compile')
++    def CompletableFuture<CompilationResults> compile(String uri, String clientId, String command, boolean inplace);
++
++    /**
++     * Build diagram for snapshot with id index for file given by uri. Only works, if the file was already compiled.
++     */
++    @JsonRequest('show')
++    def CompletableFuture<String> show(String uri, String clientId, int index)
++
++    /**
++     * Returns all compilation systems which are applicable for the file at given uri.
++     *
++     * @param uri URI as string to get compilation systems for
++     * @param filter boolean indicating whether compilation systems should be filtered
++     */
++    @JsonRequest('get-systems')
++    def CompletableFuture<Object> getSystems(String uri, boolean filterSystems)
++}
++{{/code}}
++
++This defines three json-rpc commands: "keith/kicool/compile", "keith/kicool/show", "keith/kicool/get-systems". These are implemented in KiCoolLanguageServerExtension.
++
  \\
++
++== Server Client communication interface ==
++
++Not only messages from client to server but rather messages from server client might be needed.
++
++Messages that can be send from server to client are defined in the KeithLanguageClient:
++
++{{code title="Example KeithLanguageLCient"}}
++/**
++ * LanguageClient that implements additional methods necessary for server client communication in KEITH.
++ *
++ * @author really fancy name
++ *
++ */
++ @JsonSegment("keith")
++interface KeithLanguageClient extends LanguageClient {
++
++    @JsonNotification("kicool/compile")
++    def void compile(Object results, String uri, boolean finished);
++
++    @JsonNotification("kicool/cancel-compilation")
++    def void cancelCompilation(boolean success);
++
++	// Not only notifications, but also server client requests should be possible, but currently there is no use case for that.
++}
++{{/code}}
++
++These messages can be caught on the client side by defining the message that is caught like this:
++
++{{code title="Client side message definition"}}
++export const snapshotDescriptionMessageType = new NotificationType<CodeContainer, void>('keith/kicool/compile');
++{{/code}}
++
++This message type is bound to a method that should be called whenever the client receives such a message.
++
++{{code title="Client side message registration"}}
++const lClient: ILanguageClient = await this.client.languageClient
++lClient.onNotification(snapshotDescriptionMessageType, this.handleNewSnapshotDescriptions.bind(this))
++{{/code}}
++
++The method should receive all parameters specific in the KeithLanguageClient interface on the serevr side.
++
++Such a notification from server to client is send like this:
++
++{{code title="Server side message sending"}}
++future.thenAccept([
++	// client is the KeithLanguageClient registered in a LanguageServerExtension that implements a ILanguageClientProvider
++	// compile is the command defined in the KeithLanguageClientInterface
++	client.compile(new CompilationResults(this.snapshotMap.get(uri)), uri, finished)
++])
++{{/code}}
++
++\\
++
++== Register and calling an extension (on client side) ==
++
++Language server extension do not have to be registered on the client side. It is just called.
++
++You can send a request or a notification to the language server like this:
++
++{{code title="Client side message sending"}}
++const lclient = await this.client.languageClient
++const snapshotsDescriptions: CodeContainer = await lclient.sendRequest("keith/kicool/compile", [uri, KeithDiagramManager.DIAGRAM_TYPE + '_sprotty', command,
++	this.compilerWidget.compileInplace]) as CodeContainer
++// or via a thenable
++client.languageClient.then(lClient => {
++lClient.sendRequest("keith/kicool/compile").then((snapshotsDescriptions: CodeContainer) => {
++	// very important stuff
++}
++// await is preferred, since it is shorter.
++{{/code}}
++
++In this example client is an instance of a language client. It is usually injected like this:
++
++{{code title="Client side LanguageClientContribution injection"}}
++@inject(KeithLanguageClientContribution) public readonly client: KeithLanguageClientContribution
++constructor(
++	// other injected classes that are relevant for the constructor
++    ) {
++	// constructor stuff
++}
++{{/code}}
++
++\\
++
++== How to make a new package for KEITH ==
++
++Clone the [[KEITH repository>>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/keith/browse||shape="rect"]].
++
++Open the keith folder in VSCode. You are know in the keith directory in VSCode.
++
++You see something like this: TODO picture
++
++Create a new folder called keith-<your extension name>.
++
++Copy a package.json, a tslint.json, a tsconfig.json, and a src folder into the folder.
++
++Add keith-<your extension name> to workspaces in the top level package.json.
++
++Add "keith-<your extension name>(% style="color: rgb(0,0,0);" %)": (%%)"0.1.0"(% style="color: rgb(0,0,0);" %) to the dependencies in the top level package.json and the product package.json files (e.g. the package.json in keith-app).
++
++=== What is in the src directory? ===
++
++The source directory has three optional subfolders.
++
++* node: Holds all backend related classes. This does currently only exist in the [[keith-language package>>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/keith/browse/keith-language||shape="rect"]].
++* common: Holds general helper methods, string constants and some data classes
++* browser: Holds all widgets, contribution for commands, menus, and widgets, and the frontend-extension.
++
++==== The frontend-extension ====
++
++This binds all necessary classes. Look at existing frontend extension in [[KEITH>>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/keith/browse||shape="rect"]] or [[Theia>>url:https://github.com/theia-ide/theia/tree/master/packages||shape="rect"]] to see how this is done.
++
++==== More examples for stuff ====
++
++See [[Theia examples>>url:https://www.theia-ide.org/doc/Commands_Keybindings.html||shape="rect"]].
++
++== How to write a widget ==
++
++There are different kinds of widgets that are commonly used in [[KEITH>>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/keith/browse||shape="rect"]] or in existing [[Theia packages>>url:https://github.com/theia-ide/theia/tree/master/packages||shape="rect"]].
++
++* BaseWidget: Very basic
++* ReactWidget: A render method has to be implemented that redraws the widget on demand. Additionally several on* event methods can beimplemented.
++* TreeWidget: Extends the ReactWidget and draws the contents of the widget in a tree view.
++
++If a widget has a state it should implement the StatefulWidget interface, which allows to imlement a store and restore method.
++
++Look at examples in KEITH or Theia to see how this is done.
++
++== How to make a new module for sprotty (see actionModule, ...) ==
++
++WIP
++
++\\

Confluence.Code.ConfluencePageClass[0]

Id

@@ -1,1 +1,1 @@
--60522742
++57803004

URL

@@ -1,1 +1,1 @@
--https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/60522742/Running KEITH
++https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/57803004/Running KEITH

Changes for page Running KEITH

Summary

Details

Navigation

Quick Links