eclipse-emfcloud / emfcloud

Components and frameworks for building web-based modeling tools

EMF.cloud

EMF.cloud is the umbrella project for components and technologies making it easy to build web-based modeling tools, integrated e.g. in VSCode, Eclipse Theia and other cloud-enabled IDEs and tools.

For more information, please visit the EMF.cloud Website. If you have questions, contact us on our discussions page and have a look at our communication and support options.

EMF.cloud in Action

Components

• modelserver
• modelserver-node
• modelserver-theia
• model-validation
• coffee.editor
• ecore-glsp
• theia-tree-editor
• json-forms-property-view
• modelserver-glsp-integration
• emf-jackson

Used components

• GLSP
• JSONForms

emfcloud's Issues

Bring emfjson/emfjson-jackson to eclipse-emfcloud

We are very happy that EMFJson/emfjson-jackson agreed to become part of Eclipse EMF.Cloud! This issue shall track the necessary steps and the progress of this matter:

• Prepare archive for initial contribution
  This bundle must contain all sources with the correct copyright headers for both EPL-2.0, and MIT
• Make sure all contributors of EMFJson signed the Eclipse Contributor Agreement
• Open CQ at Eclipse
• Upload archive to the CQ at Eclipse

Once the Eclipse Foundation confirms that this contribution can move forward

• Request github repository from Eclipse
• Nominate @ghillairet for becoming Eclipse EMFCloud committer
• Make initial commit with content of aforementioned archive
• Set up CI and publishing

Before first release

• Initiate release review

For more information, see Eclipse Project Handbook.
Thanks @ghillairet for agreeing to bring EMFJson to Eclipse!

Update axios version for modelserver-node and modelserver-client

Update axios version for @eclipse-emfcloud/modelserver-node and @eclipse-emfcloud/modelserver-client

Background:

is there no import for isAxiosError?

Unfortunately not with our currently used version v0.24.0. I'm not sure why we are using such an outdated version anyhow, but we use the same for modelserver-node. I guess we should consider updating this dependency (latest is currently v1.2.3) at some point for both repos, I will create a follow-up issue in emfcloud.

Originally posted by @ndoschek in eclipse-emfcloud/emfcloud-modelserver-theia#136 (comment)

[Model Server] Support multiple workspaces

Umbrella issue for changes in the Model Server repos emfcloud-modelserver, modelserver-node, emfcloud-modelserver-theia, emfcloud-modelserver-client

• Supporting resource management for multiple workspaces
• Adjust configure server call to allow registration of additional workspaces (do not override the current workspace anymore)

[Model Server] Support custom workspace URI schemes

Umbrella issue for changes in the Model Server repos emfcloud-modelserver, modelserver-node, emfcloud-modelserver-theia, emfcloud-modelserver-client

• Allow to handle custom workspace URI schemes
• Handle workspace relative URIs on Java Model Server side (modelserver-node redirects calls to Java server by default)
• Optional:
  • Helpers to build URIs from file paths, relative paths on client side (Theia clients)

URI examples using workspace schemes:
workspace://ws-uuid001/my/relative/path.ext
custom://<workspace-id>/<project-id>/<model-type>

Add GitHub templates for the discussions forms

Similar to the Issue templates, GitHub just released discussion templates:

• https://github.blog/2023-01-09-github-discussions-just-got-better-with-category-forms/
• https://docs.github.com/en/discussions/managing-discussions-for-your-community/creating-discussion-category-forms

Suggestions to include to the emf.cloud discussion template:

• Currently, people are not using the "Mark as answer" to our liking, often we have to mark them as answered ourselves.
  We could add this as information text (as text comment) now that templates are available.

Broken link on web site

See:

https://www.eclipse.org/emfcloud/contact/

The first link for "Join our mailing list" wrongly points to:

https://accounts.eclipse.org/mailing-list/emdcloud-dev

instead of

https://accounts.eclipse.org/mailing-list/emfcloud-dev - as the second one correctly does.

Optimize Jenkins build jobs to reduce parallel builds

Optimize Jenkins builds and integrate deployments as steps instead of separate Jenkins jobs.
This will result in a cleaner emfcloud Jenkins instance, which will then hold the eclipse-emfcloud parent instance (that tracks all repository builds), the website job and the release jobs.

• Create dedicated mailing list for emfcloud ci build infos (Ticket already opened at Eclipse gitlab)
• Update Jenkinsfiles for each applicable repository
• Remove separate deploy jobs

Regarding security concerns:
We use trust level From users with Admin or Write permission:

Pull requests forks will be treated as trusted if and only if the fork owner has either Admin or Write permissions on the origin repository. This is the recommended policy.

That means, changes on Jenkinsfiles are only used for the Jenkins build if a committer adds changes, for (new) collaborators the master Jenkinsfile is used to prevent any security issues.

Add a typescript based facade in front of the model server

The ModelServer is written in Java. For a smoother development experience in is useful to have a typescript based facade in front of the model server. This facade should be extensible.

Switch to peer dependencies for `@theia` dependencies

Check all EMF.cloud repositories and consume Theia dependencies as peerDependencies where not yet done.

Add GitHub issue templates to the emfcloud repositories

• For the emfcloud umbrella repository: Add GitHub issue templates to the repository, disable blank issues and add a button that redirects to the emfcloud discussions board for pure questions.
• For the remaining specific repositories: Add GitHub issue templates to the repository, disable blank issues and add a button that redirects to the emfcloud discussions board for pure questions.

See in general the GitHub Docs and for example the issue templates of the emfcloud-modelserver.

This issue tracks the progress for the specific emfcloud repositories:

• emfcloud PR #116
• modelserver-node PR eclipse-emfcloud/modelserver-node#2
• emfjson-jackson PR eclipse-emfcloud/emfjson-jackson#25
• jsonforms-property-view PR eclipse-emfcloud/jsonforms-property-view#20
• theia-tree-editor PR eclipse-emfcloud/theia-tree-editor#53
• model-validation PR eclipse-emfcloud/model-validation#6
• coffee-editor PR eclipse-emfcloud/coffee-editor#429
• ecore-glsp PR eclipse-emfcloud/ecore-glsp#122

Switch to GitHub projects for emfcloud planning

• Switch to GitHub projects for Kanban board (initial test project: https://github.com/orgs/eclipse-emfcloud/projects/4)
• Investigate how to use GitHub action Add To GitHub projects to automatically add new issues from all emfcloud repositories to project
• Remove current Kanban board (with uses GitHub projects (classic): https://github.com/orgs/eclipse-emfcloud/projects/2

[Model Server] Consistently use URI object in APIs

Umbrella issue for changes in the Model Server repos emfcloud-modelserver, modelserver-node, emfcloud-modelserver-theia, emfcloud-modelserver-client

• Update APIs to consistently use URI object instead of strings
• Keep an eye on differences between V1/V2
• Typescript clients
  • Perhaps useful: URI type/class in modelserver-node (e.g. https://github.com/garycourt/uri-js)
  • Only use this URI type/class within the modelserver-node APIs (not REST)

Contribute Ecore GLSP to Eclipse/EMF.Cloud

The project https://github.com/eclipsesource/ecore-glsp will be contributed to Eclipse/EMF.Cloud. It contains a graphical editor for Ecore Models, as well as some related utilities (Model/Project creation, Code generation...)

Support Theia Community Release 1.34.x

• support theia community release (RC for 1.34.x)
• ensure compatibility and smoke test
• update theia website that  lists compatible packages and publish a version there
  https://github.com/eclipse-theia/theia-website/blob/master/src/components/Releases.js

Ensure each build/deploy job reports via email on failure

Ensure each build/deploy job reports via email on failure

• Add email notification in Jenkinsfiles on merge to master/main - opened PRs
• Doublecheck all deploy/release jobs in their Jenkins configuration

Add Community Health files to EMF.cloud repositories

Add missing community documents to to all EMF.cloud repositories (where applicable):

• Code of conduct - CODE_OF_CONDUCT.md
  • Template: https://raw.githubusercontent.com/eclipse/.github/master/CODE_OF_CONDUCT.md
• Contribution guidelines - CONTRIBUTING.md
  • Example: https://github.com/eclipse-glsp/glsp/blob/master/CONTRIBUTING.md
• Security policy - SECURITY.md
  • Example: https://www.eclipse.org/security/policy.php, https://github.com/eclipse/rdf4j/blob/main/SECURITY.md
• Update README.md in case there are overlapping sections

Repos:

• emfcloud - #196
• emfcloud-modelserver - eclipse-emfcloud/emfcloud-modelserver#267
• modelserver-node - eclipse-emfcloud/modelserver-node#68
• emfcloud-modelserver-theia - eclipse-emfcloud/emfcloud-modelserver-theia#137
• model-validation - eclipse-emfcloud/model-validation#10
• coffee-editor - eclipse-emfcloud/coffee-editor#496
• ecore-glsp Remark: currently not planned to maintain this repo, hence no update of health files atm
• theia-tree-editor - eclipse-emfcloud/theia-tree-editor#71
• json-forms-property-view - eclipse-emfcloud/jsonforms-property-view#43
• modelserver-glsp-integration - eclipse-emfcloud/modelserver-glsp-integration#46
• emfjson-jackson - eclipse-emfcloud/emfjson-jackson#62