Wiki source code of Running KEITH

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

version	line-number	content
53.1	1
6.1	2
16.1	3	{{toc maxLevel="2"/}}
6.1	4
32.1	5	== Setting up your Eclipse ==
1.1	6
52.1	7	For everything not mentioned here refer to [[Getting Eclipse>>doc:KIELER.TO DELETE.Getting Eclipse.WebHome\|\|shape="rect"]] guide. Choose the 2021-06 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	8
42.1	9	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) or to work with the SCCharts language, you should select KIELER semantics; for diagram only KIELER pragmatics. In any case select the keith stream in semantics or the master stream in pragmatics.
1.1	10
42.1	11	If you plan to develop in elk at the same time first select the Eclipse Layout Kernel setup and after that either the semantics or pragmatics setup.
1.1	12
52.1	13	Wait till everything installs and the setup tasks finish. If you have any problems in this stage refer to the [[Getting Eclipse>>doc:KIELER.TO DELETE.Getting Eclipse.WebHome\|\|shape="rect"]] guide or ask your advisors.
1.1	14
42.1	15	Make sure that you have necessary forks of ELK/KLighD set up.
37.1	16
36.1	17	If you have problems in the workspace that are still there after a clean build do the following:
	18
	19	* Disable Project>Build automatically
42.1	20	* Select all KLighD and pragmatics plugins and do Project>Clean>Only selected and build only selected
36.1	21	* Do the same for the semantics projects
	22	* Enable Project>Build automatically
	23
40.1	24	== Java Application ==
	25
45.1	26	If you have used the semantics setup, there is a pre-configured run configuration that you can use to execute the KIELER Language Server. For that, go into the Run>[Run\|Debug] Configurations>Java Application>LanguageServer with KLighD in Workspace and execute that.
44.1	27
	28	Described below is how you can set this configuration up for yourself for any manual configuration within the language server:
	29
40.1	30	To run the language server go to //Run Configurations// create a new //Java Application// run configuration.
	31
53.1	32	(% style="letter-spacing:0.0px" %)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//.
40.1	33
	34	[[image:attach:Screenshot from 2020-08-12 13-32-36.png]]
	35
	36	In the next step all projects that you want to include in your language server have to be added to the classpath.
	37
53.1	38	Go to Classpath, select User Entries, click Add Projects..., and select all required projects (if you are unsure just add all of them).
40.1	39
	40	Click on Advanced>Add Folders add select the project folders of all projects you added earlier.
	41
	42	In the Arguments tab make sure to add //-Dport=5007// to the VM arguments.
	43
41.1	44
	45	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.
	46
40.1	47
1.1	48	== Setting up a KEITH developer setup... ==
	49
	50	General requirements:
	51
30.1	52	* node (and additional dependencies see [[Theia developer guide>>url:https://github.com/theia-ide/theia/blob/master/doc/Developing.md\|\|shape="rect"]])
1.1	53	* npm (whatever node installs)
	54	* yarn (latest version)
	55	* Python (2.7.X)
	56	* gcc, g++, and make (for native dependencies of some npm packages)
	57	* [[Visual Studio Code>>url:https://code.visualstudio.com/\|\|shape="rect"]] (latest version)
	58	* a cloned [[keith >>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/keith/browse\|\|shape="rect"]]repository
	59
	60	== ... on linux: ==
	61
	62	(Theia has a [[guide >>url:https://www.theia-ide.org/doc/authoring_extensions\|\|shape="rect"]]for extension development that might be helpful)
	63
38.1	64	install node (for the version we refer to the Theia developer guide):
1.1	65
	66	{{code}}
	67	curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.5/install.sh \| bash
38.1	68	nvm install 10
1.1	69	{{/code}}
	70
	71	Install python if you haven't (remember: Python 2: , Python 3: ).
	72
	73	{{code language="none"}}
	74	Install yarn (a package manager build on the package manager npm):
	75	{{/code}}
	76
53.1	77	{{{
	78	}}}
1.1	79
	80
	81	{{code}}
	82	npm install -g yarn
	83	{{/code}}
	84
	85
	86	== ... on windows: ==
	87
43.1	88	Install [[node>>url:https://nodejs.org/download/release/latest-v10.x/\|\|shape="rect"]] for windows. I personally used the {{code language="none"}}.msi{{/code}}. For the version refer to the Theia developer guide.
1.1	89
11.1	90	Use that to install windows-build-tools by executing the command in an administrative powershell.
1.1	91
	92	{{code}}
	93	npm install -g windows-build-tools
	94	{{/code}}
	95
15.1	96	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	97
15.1	98	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.
	99
14.1	100	Yarn can be downloaded and installed from [[here>>url:https://yarnpkg.com/lang/en/docs/install/#windows-stable\|\|shape="rect"]].
	101
11.1	102	=== Known Problems in this step ===
	103
15.1	104	If python3 was already installed this may cause some problems.
11.1	105
1.1	106	== ... on mac: ==
	107
	108	Get a package manager, something like [[brew>>url:https://brew.sh/index_de\|\|shape="rect"]].
	109
	110	Use brew to install all necessary stuff.
	111
	112	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:
	113
	114	{{code}}
	115	xcode-select --install
	116	{{/code}}
	117
32.1	118	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	119
5.1	120	= Stuff that may help =
1.1	121
35.1	122	== How to run KEITH in developer setup (socket) ==
1.1	123
35.1	124	Run the following to build and run KEITH in its developer setup (in socket mode, so the LS has to be started separately)
	125
	126	=== Running KEITH in the browser ===
	127
	128
	129	{{code language="bash"}}
	130	yarn && cd keith-app && yarn run socket
	131	{{/code}}
	132
	133	//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.
	134
	135	Per default the KEITH opens on localhost:3000.
	136
	137	{{info}}
	138	If you previously build keith electron, you have to execute {{code language="none"}}yarn run rebuild:browser{{/code}}
	139	{{/info}}
	140
	141	Run Launch in Chrome via VSCode to open a chrome browser on localhost:3000
	142
	143	This is necessary to be able to debug in VSCode.
	144
	145	=== Running KEITH as (unbundled) electron app ===
	146
	147	{{code language="bash"}}
	148	yarn && yarn run rebuild:electron && cd keith-app-electron && yarn run socket
	149	{{/code}}
	150
	151	//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.
	152
	153	{{info}}
	154	If you previously build keith electron, you have to execute {{code language="none"}}yarn run rebuild:electron{{/code}}
	155	{{/info}}
	156
53.1	157	== (% style="letter-spacing:-0.008em" %)Running the already build LS(%%) ==
35.1	158
53.1	159	{{info}}
41.1	160	In the current builds, there seems to be a problem with the packaging of the jar file and executing will cause a ClassNotFoundException for org/eclipse/ui/IStorageEditorInput when initializing the LS. We are looking into this issue. For now, setup your Eclipse as described above.
53.1	161	{{/info}}
1.1	162
40.1	163
41.1	164	Go to the latest [[Bamboo build>>url:https://rtsys.informatik.uni-kiel.de/bamboo/browse/KISEMA-NSI\|\|shape="rect"]] and go to Artifacts.
40.1	165
	166	Select the language server for your OS (this will be a jar file) and run it via:
	167
	168	{{code}}
	169	java -Dport=5007 -jar <name-of-the-jar-file>
	170	{{/code}}
	171
5.1	172	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	173
5.1	174	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	175
5.1	176	[[image:attach:image2019-2-7_17-58-22.png]]
1.1	177
5.1	178	Open the {{code language="none"}}package.json{{/code}}. In the{{code language="none"}} package.json{{/code}} are several scripts defined.
3.1	179
26.1	180	{{code language="js"}}
	181	"scripts": {
	182	"prepare": "yarn run clean && yarn build",
	183	"clean": "theia clean",
	184	"build": "theia build --mode development",
	185	"start": "theia start --root-dir=../workspace",
	186	"socket": "node ./src-gen/backend/main.js --root-dir=../workspace --LSP_PORT=5007 --port=3000 --loglevel=debug",
	187	"watch": "theia build --watch --mode development"
	188	},
	189	{{/code}}
1.1	190
26.1	191
5.1	192	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}}.
3.1	193
35.1	194	= Known Issues =
3.1	195
13.1	196	=== Known issues for windows: ===
	197
	198	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.
	199
	200	=== Known issues on mac: ===
	201
41.1	202	//(this might already be resolved, has not been tested yet though)//
	203
13.1	204	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.
	205
	206	=== Known issues: ===
	207
26.1	208	* KEITH works in the browser/electron app, but not in the electron app/browser with the following error message:(((
	209	{{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	210
26.1	211	* run
	212
53.1	213	{{code language="none"}}yarn run rebuild:electron/browser{{/code}} after yarn to fix this. If it does not work, delete the
29.1	214
53.1	215	{{code language="none"}}node_modules{{/code}} folder and try again (for browser version rebuild browser is not needed, since
29.1	216
53.1	217	{{code language="none"}}yarn{{/code}} already builds the correct sources).
26.1	218	)))