Wiki source code of Running KEITH

Version 40.1 by Soeren Domroes on 2020/08/12 11:46

version	line-number	content
40.1	1	{{layout}}
	2	{{layout-section ac:type="single"}}
	3	{{layout-cell}}
6.1	4
7.1	5
16.1	6	{{toc maxLevel="2"/}}
40.1	7	{{/layout-cell}}
	8	{{/layout-section}}
6.1	9
40.1	10	{{layout-section ac:type="single"}}
	11	{{layout-cell}}
32.1	12	== Setting up your Eclipse ==
1.1	13
39.1	14	For everything not mentioned here refer to [[Getting Eclipse>>doc:KIELER.Getting Eclipse\|\|shape="rect"]] guide. Choose the last Eclipse version and I personally recommend Eclipse for RCP & RAP developers since the Plug-In Development perspective is the default one. Another helpful perspective might be the Git perspective.
1.1	15
34.1	16	Use the installer go to advanced mode, add the KIELER url. If you plan to develop for the semantic language server (e.g. for the compiler) you should select KIELER semantics for diagram only KIELER pragmatics. In any case select the keith stream.
1.1	17
37.1	18	If you plan to develop in elk at the same time first select the Eclispe Layout Kernel setup and after that either the semantics or pragmatics setup.
1.1	19
8.1	20	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.
1.1	21
37.1	22	Make sure that you have necessary forks of ELK/KlighD set up.
	23
36.1	24	If you have problems in the workspace that are still there after a clean build do the following:
	25
	26	* Disable Project>Build automatically
	27	* Select all Klighd and pragmatics plugins and do Project>Clean>Only selected and build only selected
	28	* Do the same for the semantics projects
	29	* Enable Project>Build automatically
40.1	30	{{/layout-cell}}
	31	{{/layout-section}}
36.1	32
40.1	33	{{layout-section ac:type="two_equal"}}
	34	{{layout-cell}}
	35	== Legacy Eclipse Application ==
	36
34.1	37	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// (for semantics LS,//de.cau.cs.kieler.kgraph.language.server.LanguageServer// otherwise)
1.1	38
5.1	39	== [[image:attach:Screenshot from 2019-02-15 14-10-50.png]] ==
1.1	40
5.1	41	\\
1.1	42
33.1	43	You have to edit the arguments too. The Vm arguments host and port are added to connect the LS via socket:
1.1	44
33.1	45	{{code}}
	46	-os ${target.os} -ws ${target.ws} -arch ${target.arch} -nl ${target.nl} -consoleLog
	47	{{/code}}
	48
	49	{{code}}
	50	-Dhost=localhost -Dport=5007
	51	{{/code}}
	52
	53	\\
	54
5.1	55	[[image:attach:Screenshot from 2019-02-15 14-13-34.png]]
1.1	56
40.1	57	The default port to which KEITH tries to connect is 5007. You can of course change this for the language server but be aware that this has to be changed in KEITH too.
1.1	58
40.1	59	\\
	60	{{/layout-cell}}
	61
	62	{{layout-cell}}
	63	== Java Application ==
	64
	65	To run the language server go to //Run Configurations// create a new //Java Application// run configuration.
	66
	67	Select the //Project// //de.cau.cs.kieler.language.server// or //de.cau.cs.kieler.pragmatics.language.server// and the Main class //de.cau.cs.kieler.language.server.LanguageServer// or //de.cau.cs.kieler.pragmatics.language.server.PragmaticsLanguageServer//.
	68
	69	[[image:attach:Screenshot from 2020-08-12 13-32-36.png]]
	70
	71	In the next step all projects that you want to include in your language server have to be added to the classpath.
	72
	73	Go to Classpath, select User Entries, click Add Projects..., and select all required projects (if you are unsure just add all of them).
	74
	75	Click on Advanced>Add Folders add select the project folders of all projects you added earlier.
	76
	77	In the Arguments tab make sure to add //-Dport=5007// to the VM arguments.
	78
	79	\\
	80	{{/layout-cell}}
	81	{{/layout-section}}
	82
	83	{{layout-section ac:type="single"}}
	84	{{layout-cell}}
1.1	85	== Setting up a KEITH developer setup... ==
	86
	87	General requirements:
	88
30.1	89	* node (and additional dependencies see [[Theia developer guide>>url:https://github.com/theia-ide/theia/blob/master/doc/Developing.md\|\|shape="rect"]])
1.1	90	* npm (whatever node installs)
	91	* yarn (latest version)
	92	* Python (2.7.X)
	93	* gcc, g++, and make (for native dependencies of some npm packages)
	94	* [[Visual Studio Code>>url:https://code.visualstudio.com/\|\|shape="rect"]] (latest version)
	95	* a cloned [[keith >>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/keith/browse\|\|shape="rect"]]repository
	96
	97	== ... on linux: ==
	98
	99	(Theia has a [[guide >>url:https://www.theia-ide.org/doc/authoring_extensions\|\|shape="rect"]]for extension development that might be helpful)
	100
38.1	101	install node (for the version we refer to the Theia developer guide):
1.1	102
	103	{{code}}
	104	curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.5/install.sh \| bash
38.1	105	nvm install 10
1.1	106	{{/code}}
	107
	108	Install python if you haven't (remember: Python 2: , Python 3: ).
	109
	110	{{code language="none"}}
	111	Install yarn (a package manager build on the package manager npm):
	112	{{/code}}
	113
	114	{{{}}}
	115
	116	\\
	117
	118	{{code}}
	119	npm install -g yarn
	120	{{/code}}
	121
	122	\\
	123
	124	== ... on windows: ==
	125
38.1	126	Install [[node>>url:https://nodejs.org/download/release/v8.15.0/\|\|shape="rect"]] for windows. I personally used the {{code language="none"}}.msi{{/code}}. For the version refer to the Theia developer guide.
1.1	127
11.1	128	Use that to install windows-build-tools by executing the command in an administrative powershell.
1.1	129
	130	{{code}}
	131	npm install -g windows-build-tools
	132	{{/code}}
	133
15.1	134	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.
1.1	135
15.1	136	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.
	137
14.1	138	Yarn can be downloaded and installed from [[here>>url:https://yarnpkg.com/lang/en/docs/install/#windows-stable\|\|shape="rect"]].
	139
11.1	140	=== Known Problems in this step ===
	141
15.1	142	If python3 was already installed this may cause some problems.
11.1	143
1.1	144	== ... on mac: ==
	145
	146	Get a package manager, something like [[brew>>url:https://brew.sh/index_de\|\|shape="rect"]].
	147
	148	Use brew to install all necessary stuff.
	149
	150	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:
	151
	152	{{code}}
	153	xcode-select --install
	154	{{/code}}
	155
32.1	156	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).
1.1	157
5.1	158	= Stuff that may help =
1.1	159
35.1	160	== How to run KEITH in developer setup (socket) ==
1.1	161
35.1	162	Run the following to build and run KEITH in its developer setup (in socket mode, so the LS has to be started separately)
	163
	164	=== Running KEITH in the browser ===
	165
	166	\\
	167
	168	{{code language="bash"}}
	169	yarn && cd keith-app && yarn run socket
	170	{{/code}}
	171
	172	//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.
	173
	174	Per default the KEITH opens on localhost:3000.
	175
	176	{{info}}
	177	If you previously build keith electron, you have to execute {{code language="none"}}yarn run rebuild:browser{{/code}}
	178	{{/info}}
	179
	180	Run Launch in Chrome via VSCode to open a chrome browser on localhost:3000
	181
	182	This is necessary to be able to debug in VSCode.
	183
	184	=== Running KEITH as (unbundled) electron app ===
	185
	186	{{code language="bash"}}
	187	yarn && yarn run rebuild:electron && cd keith-app-electron && yarn run socket
	188	{{/code}}
	189
	190	//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.
	191
	192	{{info}}
	193	If you previously build keith electron, you have to execute {{code language="none"}}yarn run rebuild:electron{{/code}}
	194	{{/info}}
40.1	195	{{/layout-cell}}
	196	{{/layout-section}}
35.1	197
40.1	198	{{layout-section ac:type="two_equal"}}
	199	{{layout-cell}}
	200	== Running the already build LS (legacy, you normally do not want to do this) ==
35.1	201
5.1	202	Go to the latest [[Bamboo build>>url:https://rtsys.informatik.uni-kiel.de/bamboo/browse/KISEMA-NSI\|\|shape="rect"]] and go to Artifacts.
1.1	203
5.1	204	[[image:attach:image2019-2-7_17-46-58.png]]
1.1	205
5.1	206	Select Language Server Zip and download the LS and unpack it somewhere.
	207
	208	Locate the kieler.ini file. Depending on the OS it has a different location (linux; toplevel, windows, toplevel, mac: Content/Eclipse/kieler.ini)
	209
	210	Paste the following at the beginning of the ini-file:
	211
1.1	212	{{code language="bash"}}
5.1	213	-application
	214	de.cau.cs.kieler.language.server.LanguageServer
	215	-noSplash
1.1	216	{{/code}}
	217
32.1	218	Since an Eclipse application is built, this is needed to start the LS without a splashscreen.
1.1	219
5.1	220	If you want to connect that LS via socket to your Theia application (KEITH) add the following to the vmargs:
3.1	221
5.1	222	{{code}}
	223	-Dport=5007
	224	{{/code}}
1.1	225
40.1	226	\\
	227
	228	\\
	229	{{/layout-cell}}
	230
	231	{{layout-cell}}
	232	== Running the already build LS ==
	233
	234	Go to the latest [[Bamboo build>>url:https://rtsys.informatik.uni-kiel.de/bamboo/browse/KISEMA-TSIWE/latest\|\|shape="rect"]] and go to Artifacts.
	235
	236	Select the language server for your OS (this will be a jar file) and run it via:
	237
	238	{{code}}
	239	java -Dport=5007 -jar <name-of-the-jar-file>
	240	{{/code}}
	241	{{/layout-cell}}
	242	{{/layout-section}}
	243
	244	{{layout-section ac:type="single"}}
	245	{{layout-cell}}
5.1	246	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:
1.1	247
5.1	248	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:
1.1	249
5.1	250	[[image:attach:image2019-2-7_17-58-22.png]]
1.1	251
5.1	252	Open the {{code language="none"}}package.json{{/code}}. In the{{code language="none"}} package.json{{/code}} are several scripts defined.
3.1	253
26.1	254	{{code language="js"}}
	255	"scripts": {
	256	"prepare": "yarn run clean && yarn build",
	257	"clean": "theia clean",
	258	"build": "theia build --mode development",
	259	"start": "theia start --root-dir=../workspace",
	260	"socket": "node ./src-gen/backend/main.js --root-dir=../workspace --LSP_PORT=5007 --port=3000 --loglevel=debug",
	261	"watch": "theia build --watch --mode development"
	262	},
	263	{{/code}}
1.1	264
26.1	265	\\
	266
5.1	267	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}}.
40.1	268	{{/layout-cell}}
	269	{{/layout-section}}
3.1	270
40.1	271	{{layout-section ac:type="single"}}
	272	{{layout-cell}}
35.1	273	= Known Issues =
3.1	274
13.1	275	=== Known issues for windows: ===
	276
	277	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.
	278
	279	=== Known issues on mac: ===
	280
	281	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.
	282
	283	=== Known issues: ===
	284
26.1	285	* KEITH works in the browser/electron app, but not in the electron app/browser with the following error message:(((
	286	{{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}}
13.1	287
26.1	288	* run
	289
	290	{{code language="none"}}
	291	yarn run rebuild:electron/browser
29.1	292	{{/code}} after yarn to fix this. If it does not work, delete the
	293
	294	{{code language="none"}}
	295	node_modules
	296	{{/code}} folder and try again (for browser version rebuild browser is not needed, since
	297
	298	{{code language="none"}}
	299	yarn
	300	{{/code}} already builds the correct sources).
26.1	301	)))
40.1	302	{{/layout-cell}}
	303	{{/layout-section}}
	304	{{/layout}}

Wiki source code of Running KEITH

Navigation

Quick Links