Skip to content

Latest commit

 

History

History
134 lines (86 loc) · 4.78 KB

README.md

File metadata and controls

134 lines (86 loc) · 4.78 KB
Raw

ecore-glsp client

The example of how to build the Theia-based applications with the ecore-glsp.

Getting started

Install nvm.

curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.5/install.sh | bash

Install npm and node. At the moment, Node 12 is required; higher versions may not be supported.

nvm install 12
nvm use 12

Install yarn.

npm install -g yarn

Remarks regarding glsp-server start up

You will need openjdk >= 11 on your path, as the client starts the ecore-glsp-server.

Before you start the browser or electron application you have to run the build script build.sh in the root directory (this is also explained in the README file there). This builds the server products and publishes them into build folder of theia-ecore package.

Building

Run yarn in the root directory of this repository in the terminal:

yarn

Or with the default Build Task either via the menu Terminal > Run Build Task... or the keybinding Ctrl+Shift+B.


Run

Start Theia Browser app

  • Via Terminal:

    yarn start

    This command starts the necessary server JARs and the browser app on http://localhost:3000.

  • Via VSCode Tasks: Start the following tasks either via Ctrl+T or menu Terminal > Run Task...

    • Start Browser Backend and Server Jars
    • Open Example in Browser

Starting the Servers

If both server and client were built successfully, the necessary server JARs are copied to uml-theia-integration/build/. The standard start script start will start these JARs on application startup (process argument --startFromJar is set). To debug the Servers, please see the server README for more details. In that case please use the start script start:debug or the task Start Browser Backend in Debug Mode (expects running Server instances) which expects running server instances (process argument --startFromJar is NOT set).


Watching

To avoid having to perform a full build after each change, you can use the following workflow in VSCode to enable watching and automatic rebuilding.

As a prerequisite, perform a full build once (see above). Now perform the following steps to watch and automatically build on every file change in any package.

  • Via Terminal:

    yarn watch

  • Via VSCode Tasks: Start the following tasks either via Ctrl+T or menu Terminal > Run Task...

    • Watch all packages

Debugging

To debug the Theia components, start backend and frontend via the VSCode launch configs:

  1. Both the Model Server and the GLSP Server are started already.
  2. Start debug launch configurations either:
    1. via the Debug view
    2. via the Debug sidebar in the VSCode statusbar
    3. via the Debug command palette, accessible with shortcut Ctrl+F11
  3. Start the Theia backend via the debug launch configuration Start Browser Backend (expects running GLSP Server instance).
  4. Start the chrome debug launch configuration Launch Chrome against localhost.
  5. Check the outputs in the Debug Console Panel (open it via the menu View --> Debug Console).

To debug the frontend components, please install the recommended Debugger for Chrome extension.

Hints:

Publishing theia-ecore

Create a npm user and login to the npm registry, more on npm publishing.

npm login

Publish packages with lerna to update versions properly across local packages, more on publishing with lerna.

npx lerna publish

Running the testcafe tests

Build the Server

mvn install -U

Start client, server and the tests. (Client and Server will shutdown after the execution of the tests).

yarn e2etest

Start the tests if client and server are already running.

yarn testcafe:start

Please keep the mouse focus on the Testcafe window during the tests. Losing focus will cause tests to fail.

Enable testcafe to capture videos of test runs

To enable video capturing for failed tests, add the following configurations to .testcaferc.json.

"videoPath": "./tests/results/videos",
"videoOptions": {
    "singleFile": true,
    "failedOnly": true,
    "pathPattern": "${DATE}_${TIME}/test-${TEST_INDEX}/${USERAGENT}/${FILE_INDEX}.mp4"
}