Wiki source code of Running KEITH

Version 33.1 by Niklas Rentz on 2019/09/12 13:19
Show last authors
1 = Running KEITH =
2
3
4
5 {{toc maxLevel="2"/}}
6
7 == Setting up your Eclipse ==
8
9 For everything not mentioned here refer to [[Getting Eclipse>>doc:KIELER.Getting Eclipse||shape="rect"]] guide.
10
11 Use the installer go to advanced mode, add the KIELER url. Then select first semantics and after that pragmatics (**that is very** **important**). You can see that you have done that correctly on the automatically generated name of your Eclipse: It should be something like kieler-semantics-theia.
12
13 Select the Theia stream for semantics and the Keith stream for pragmatics and use the latest Eclipse if possible. Set the targetplatform to latest and finish.
14
15 Wait till everything installs and the setup tasks finish. If you have any problems in this stage refer to the [[Getting Eclipse>>doc:KIELER.Getting Eclipse||shape="rect"]] guide.
16
17 \\
18
19 The setup tasks for Modular Target will fail. Disable it after this happens and execute them again via //Help>Perform Setup Tasks//. Open the //plug-in development// perspective. Select working sets as top level elements. Run //clean build//. Several pragmatics projects have errors. Just close them and you will be fine.
20
21 To run the language server go to //Run Configurations// create a new E//clipse Application// run configuration and select //Run an application//  and //de.cau.cs.kieler.language.server.LanguageServer//
22
23 == [[image:attach:Screenshot from 2019-02-15 14-10-50.png]] ==
24
25 \\
26
27 You have to edit the arguments too. The Vm arguments host and port are added to connect the LS via socket:
28
29 {{code}}
30 -os ${target.os} -ws ${target.ws} -arch ${target.arch} -nl ${target.nl} -consoleLog
31 {{/code}}
32
33 {{code}}
34 -Dhost=localhost -Dport=5007
35 {{/code}}
36
37 \\
38
39 [[image:attach:Screenshot from 2019-02-15 14-13-34.png]]
40
41 The default port to which KEITH tries to connect is 5007.
42
43 == Setting up a KEITH developer setup... ==
44
45 General requirements:
46
47 * node (and additional dependencies see [[Theia developer guide>>url:https://github.com/theia-ide/theia/blob/master/doc/Developing.md||shape="rect"]])
48 * npm (whatever node installs)
49 * yarn (latest version)
50 * Python (2.7.X)
51 * gcc, g++, and make (for native dependencies of some npm packages)
52 * [[Visual Studio Code>>url:https://code.visualstudio.com/||shape="rect"]] (latest version)
53 * a cloned [[keith >>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/keith/browse||shape="rect"]]repository
54
55 == ... on linux: ==
56
57 (Theia has a [[guide >>url:https://www.theia-ide.org/doc/authoring_extensions||shape="rect"]]for extension development that might be helpful)
58
59 install node 8:
60
61 {{code}}
62 curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.5/install.sh | bash
63 nvm install 8
64 {{/code}}
65
66 Install python if you haven't (remember: Python 2: , Python 3: ).
67
68 {{code language="none"}}
69 Install yarn (a package manager build on the package manager npm):
70 {{/code}}
71
72 {{{}}}
73
74 \\
75
76 {{code}}
77 npm install -g yarn
78 {{/code}}
79
80 \\
81
82 == ... on windows: ==
83
84 Install [[node 8>>url:https://nodejs.org/download/release/v8.15.0/||shape="rect"]] for windows. I personally used the {{code language="none"}}.msi{{/code}}.
85
86 Use that to install windows-build-tools by executing the command in an administrative powershell.
87
88 {{code}}
89 npm install -g windows-build-tools
90 {{/code}}
91
92 This installs make, gcc, g++, python and all this. Somehow this does not really terminate. If nothing happens anymore it may be finished, just kill the process if it does not terminate.
93
94 All the installed executables are not in the path and that is okay. This is not needed since yarn/npm knows how to call them when needed.
95
96 Yarn can be downloaded and installed from [[here>>url:https://yarnpkg.com/lang/en/docs/install/#windows-stable||shape="rect"]].
97
98 === Known Problems in this step ===
99
100 If python3 was already installed this may cause some problems.
101
102 == ... on mac: ==
103
104 Get a package manager, something like [[brew>>url:https://brew.sh/index_de||shape="rect"]].
105
106 Use brew to install all necessary stuff.
107
108 Apparently there is an issue with xcode-select: [[Theia developers>>url:https://github.com/theia-ide/theia/blob/master/doc/Developing.md||shape="rect"]] recommend the following:
109
110 {{code}}
111 xcode-select --install
112 {{/code}}
113
114 After doing this for your OS all that is missing is running KEITH (in developer setup) and setting up your Eclipse for language server development).
115
116 = Stuff that may help =
117
118 == Running the already build LS ==
119
120 Go to the latest [[Bamboo build>>url:https://rtsys.informatik.uni-kiel.de/bamboo/browse/KISEMA-NSI||shape="rect"]] and go to Artifacts.
121
122 [[image:attach:image2019-2-7_17-46-58.png]]
123
124 Select Language Server Zip and download the LS and unpack it somewhere.
125
126 Locate the kieler.ini file. Depending on the OS it has a different location (linux; toplevel, windows, toplevel, mac: Content/Eclipse/kieler.ini)
127
128 Paste the following at the beginning of the ini-file:
129
130 {{code language="bash"}}
131 -application
132 de.cau.cs.kieler.language.server.LanguageServer
133 -noSplash
134 {{/code}}
135
136 Since an Eclipse application is built, this is needed to start the LS without a splashscreen.
137
138 If you want to connect that LS via socket to your Theia application (KEITH) add the following to the vmargs:
139
140 {{code}}
141 -Dport=5007
142 {{/code}}
143
144 5007 is the standard port KEITH is currently connecting to in socket mode. You can find this port in your Theia application at the following location:
145
146 Assume you are in the [[keith >>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/keith/browse||shape="rect"]]repository. Go to {{code language="none"}}keith-app{{/code}}, you should see something like this:
147
148 [[image:attach:image2019-2-7_17-58-22.png]]
149
150 Open the {{code language="none"}}package.json{{/code}}. In the{{code language="none"}} package.json{{/code}} are several scripts defined.
151
152 {{code language="js"}}
153 "scripts": {
154 "prepare": "yarn run clean && yarn build",
155 "clean": "theia clean",
156 "build": "theia build --mode development",
157 "start": "theia start --root-dir=../workspace",
158 "socket": "node ./src-gen/backend/main.js --root-dir=../workspace --LSP_PORT=5007 --port=3000 --loglevel=debug",
159 "watch": "theia build --watch --mode development"
160 },
161 {{/code}}
162
163 \\
164
165 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}}.
166
167 == How run KEITH in developer setup (socket) ==
168
169 Run the following to build and run KEITH in its developer setup (in socket mode, so the LS has to be started separately)
170
171 === Running KEITH in the browser ===
172
173 \\
174
175 {{code language="bash"}}
176 yarn && cd keith-app && yarn run socket
177 {{/code}}
178
179 //yarn// builds all the stuff. //yarn run socket// in keith-app 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. Now refreshing your browser is enough to apply the changes.
180
181 Per default the KEITH opens on localhost:3000.
182
183 {{info}}
184 If you previously build keith electron, you have to execute {{code language="none"}}yarn run rebuild:browser{{/code}}
185 {{/info}}
186
187 \\
188
189 === Running KEITH as (unbundled) electron app ===
190
191 {{code language="bash"}}
192 yarn && yarn run rebuild:electron && cd keith-app-electron && yarn run socket
193 {{/code}}
194
195 //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.
196
197 {{info}}
198 If you previously build keith electron, you have to execute {{code language="none"}}yarn run rebuild:electron{{/code}}
199 {{/info}}
200
201 === Known issues for windows: ===
202
203 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.
204
205 === Known issues on mac: ===
206
207 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.
208
209 === Known issues: ===
210
211 * KEITH works in the browser/electron app, but not in the electron app/browser with the following error message:(((
212 {{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}}
213
214 * run
215
216 {{code language="none"}}
217 yarn run rebuild:electron/browser
218 {{/code}} after yarn to fix this. If it does not work, delete the
219
220 {{code language="none"}}
221 node_modules
222 {{/code}} folder and try again (for browser version rebuild browser is not needed, since
223
224 {{code language="none"}}
225 yarn
226 {{/code}} already builds the correct sources).
227 )))
228
229 \\

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage