Skip to content

Commit c5a36f6

Browse files
dvojtisedvojtise
authored
Initial version of a Webprotocol based EngineAddon server (#264)
* add lsp4j and jetty plugins to target platform * use p2 with all jetty bundles * targetplatform with jetty add a second dev target platform for convenience that allow to not have to open all required gemoc projects when developping * bump to tycho 2.7.0 * remove tycho warning * add eaop server to headless * add EAOP documentation * fix figure presentation * add mapstruct to targetplatform Signed-off-by: Didier Vojtisek <didier.vojtisek@inria.fr>
1 parent 388e985 commit c5a36f6

File tree

12 files changed

+2171
-87
lines changed

12 files changed

+2171
-87
lines changed

‎.mvn/extensions.xml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22
<extensions>
3-
<extension>
4-
<groupId>org.eclipse.tycho.extras</groupId>
5-
<artifactId>tycho-pomless</artifactId>
6-
<version>2.5.0</version>
7-
</extension>
3+
<extension>
4+
<groupId>org.eclipse.tycho</groupId>
5+
<artifactId>tycho-build</artifactId>
6+
<version>2.7.0</version>
7+
</extension>
88
</extensions>

‎dev_support/pomfirst_full_compilation/README.asciidoc‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
////////////////////////////////////////////////////////////////
2+
// Reproduce title only if not included in master documentation
3+
////////////////////////////////////////////////////////////////
4+
ifndef::includedInMaster[]
5+
6+
= Developer Guide
7+
== Contributing
8+
9+
endif::[]
10+
11+
12+
=== Compilation of the pom first jar
13+
14+
==== Introduction
15+
16+
Some of the components provided as part of the GEMOC Studio are now available as pomfirst. This means that the jar are compiled and provided using
17+
maven dependency system (while the Eclipse studio is compiled using manifest dependency information using tycho).
18+
19+
Only a subset of the components are provided as pomfirst. You can still use them in your pomfirst build but will need to rebuild the dependencies for maven.
20+
(You can also open a request https://github.com/eclipse/gemoc-studio/issues for a given jar you may require).
21+
22+
The source code of the [GEMOC Studio](http://gemoc.org/studio/) is currently spread among different git repositories in Eclipse organization.
23+
24+
This project relies on the presence of the correct git repositories (cloned with the correct name) to locally build a working studio.
25+
26+
27+
==== Usage
28+
29+
First checkout the git repositories :
30+
31+
[source,bourne]
32+
----
33+
git clone https://github.com/eclipse/gemoc-studio
34+
git clone https://github.com/eclipse/gemoc-studio-modeldebugging
35+
git clone https://github.com/eclipse/gemoc-studio-execution-moccml
36+
git clone https://github.com/eclipse/gemoc-studio-moccml
37+
git clone https://github.com/eclipse/gemoc-studio-execution-ale
38+
git clone https://github.com/eclipse/gemoc-studio-execution-java
39+
----
40+
41+
Note: the repositories must keep their names (Ie. do not change the destination folder name) as the maven pom file expects to find them at specific locations.
42+
43+
Generate the protocols code
44+
45+
[source,bourne]
46+
----
47+
cd gemoc-studio-modeldebugging/protocols/generators/ts/JSONSchema2APIProtocolGenerator
48+
npm run build
49+
npm run generate
50+
----
51+
52+
Then compile and install the pomfirst component:
53+
54+
[source,bourne]
55+
----
56+
cd gemoc-studio/dev_support/pomfirst_full_compilation
57+
mvn install
58+
----
59+
60+
[NOTE]
61+
====
62+
Most of the pomfirst component are completely recompiled from the same sources as their tycho equivalent but using maven dependencies instead of platform target.
63+
This is NOT only a repackaging of the .class and ensure that the dependencies are all defined.
64+
65+
They typically use `maven-resources-plugin` to copy the java sources.
66+
====
67+
68+
[NOTE]
69+
====
70+
`gemoc-studio/dev_support/pomfirst_full_compilation/pom.xml` is a convenient central place to compile all of them across the GEMOC repositories in one command.
71+
====
72+
73+
74+

‎dev_support/tycho_full_compilation/README.asciidoc‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,16 @@ git clone https://github.com/eclipse/gemoc-studio-execution-java
3434

3535
Note: the repositories must keep their names (Ie. do not change the destination folder name) as the maven pom file expects to find them at specific locations.
3636

37-
Then compile using maven:
37+
Generate the protocols code
38+
39+
[source,bourne]
40+
----
41+
cd gemoc-studio-modeldebugging/protocols/generators/ts/JSONSchema2APIProtocolGenerator
42+
npm run build
43+
npm run generate
44+
----
45+
46+
Then compile the Eclipse Studio using maven:
3847

3948
[source,bourne]
4049
----

‎docs/org.eclipse.gemoc.studio.doc/pom.xml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,10 @@
171171
<resource>
172172
<directory>${basedir}/../../../gemoc-studio-modeldebugging/commons/docs/dev/images</directory>
173173
<targetPath>images</targetPath>
174+
</resource>
175+
<resource>
176+
<directory>${basedir}/../../../gemoc-studio-modeldebugging/protocols/engine_addon_protocol/docs/images</directory>
177+
<targetPath>images</targetPath>
174178
</resource>
175179
<resource>
176180
<directory>${basedir}/../../../gemoc-studio-execution-java/docs/dev/images</directory>

‎docs/org.eclipse.gemoc.studio.doc/src/main/asciidoc/dev/Protocols_headContent.asciidoc‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
////////////////////////////////////////////////////////////////
2+
// Reproduce title only if not included in master documentation
3+
////////////////////////////////////////////////////////////////
4+
ifndef::includedInMaster[]
5+
6+
= Developer Guide
7+
== Components Overview
8+
9+
endif::[]
10+
11+
12+
footnote:[asciidoc source of this page: https://github.com/eclipse/gemoc-studio/tree/master/docs/org.eclipse.gemoc.studio.doc/src/main/asciidoc/dev/Protocols_headContent.asciidoc.]
13+
14+
In addition to java API, the GEMOC Studio implements several web protocols.
15+
16+
For consistency, these protocols are defined using the same mechanism as LSP.
17+
18+
However, in order to be deployed internally in web browsers, instead of defining a socket or a port for each protocol, most implementation in the studio use websockets.
19+
20+
For convenience, an extensible websocket server is provided as an eclipse plugin. This allows to deploy a new endpoint in any eclipse based application or IDE,
21+
simply by adding a plugin extension.
22+
23+
<<img-ProtocolsOverview-devguide>> shows an overview of the components that offer or use the protocols in the Eclipse Studio.
24+
25+
[[img-ProtocolsOverview-devguide]]
26+
.Protocols overview
27+
image::images/dev/ProtocolsOverview.png["Protocols overview"]
28+

‎docs/org.eclipse.gemoc.studio.doc/src/main/asciidoc/images/dev/ProtocolsOverview.plantuml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
@startuml
2+
skinparam ComponentBorderColor black
3+
4+
scale max 1024 width
5+
scale max 800 height
6+
7+
node "Execution Framework" as exec_framework {
8+
[org.eclipse.gemoc.executionframework.addon.eaop.server]
9+
}
10+
11+
interface "Engine AddOn Protocol" as EAOP
12+
13+
org.eclipse.gemoc.executionframework.addon.eaop.server - EAOP
14+
15+
@enduml

‎docs/org.eclipse.gemoc.studio.doc/src/main/asciidoc/master.asciidoc‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -316,10 +316,17 @@ include::../../../../../../gemoc-studio-execution-java/docs/dev/JavaExecution.as
316316
include::../../../../../../gemoc-studio-execution-ale/docs/dev/ALEExecution.asciidoc[]
317317

318318

319+
== Protocols
320+
321+
include::dev/Protocols_headContent.asciidoc[]
322+
323+
include::../../../../../../gemoc-studio-modeldebugging/protocols/engine_addon_protocol/docs/EngineAddonProtocol.asciidoc[]
324+
319325
== Contributing
320326

321327

322-
include::../../../../../../gemoc-studio/dev_support/full_compilation/README.asciidoc[]
328+
include::../../../../../../gemoc-studio/dev_support/tycho_full_compilation/README.asciidoc[]
329+
include::../../../../../../gemoc-studio/dev_support/pomfirst_full_compilation/README.asciidoc[]
323330

324331
=== Developing new features
325332

‎gemoc_studio/plugins/gemoc_studio-eclipse-bom/pom.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@
3333
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
3434
<maven.deploy.skip>true</maven.deploy.skip>
3535

36-
<tycho-version>2.5.0</tycho-version>
36+
<tycho-version>2.7.0</tycho-version>
3737
<xtend.version>2.25.0</xtend.version>
3838

3939
<eclipse.release.p2.url>http://download.eclipse.org/releases/2021-12</eclipse.release.p2.url>

‎gemoc_studio/releng/org.eclipse.gemoc.gemoc_studio.headless.feature/feature.xml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,9 @@ http://www.eclipse.org/legal/epl-v10.html
101101
<import plugin="org.eclipse.equinox.p2.console"/>
102102
<import plugin="org.eclipse.equinox.p2.directorywatcher"/>
103103
<import plugin="org.eclipse.equinox.p2.reconciler.dropins"/>
104+
<import plugin="org.eclipse.gemoc.ws.server"/>
105+
<import plugin="org.eclipse.gemoc.executionframework.addon.eaop.server"/>
106+
<import plugin="org.eclipse.gemoc.protocols.eaop.api"/>
104107
</requires>
105108

106109
<plugin

0 commit comments

Comments
 (0)