GLSP-client and Sprotty dependency #611

rsoika · 2022-04-07T19:43:46Z

rsoika
Apr 7, 2022

I have a question about the versions of GLSP-Client and Sprotty.

In my project I am based on the dependency

 @eclipse-glsp/client": "0.9.0"

as far as I can see this binds the sprotty dependency

sprotty 0.10.0

In the moment I am developing a lot about Routing and AnchorComputers to optimize the behaviour of my BPMN core.

I have seen that there were some changes in sprotty in version 0.11.0 and 0.11.1 which also affects Routing. Now I ask myself if sprotty version 0.11.1 would show different behaviour in my project and if I am currently working on problems which may have been already solved...?

Is it possible that I upgrade sprotty to version 0.11.1 in my project? I guess this is not compatible with eclipse-glsp/client 0.9.0 ?

Answered by tortmayr

Apr 7, 2022

You are right version 0.9.0 of GLSP is only compatible with sprotty version 0.10.0. The reason for this is that sprotty introduced a complete overhaul of their action definitions with 0.11.0 (switching from a class based approach to an interface+namespace based approach) and deprecated the old way of defining actions.
In the meantime we have adapted this approach for GLSP and the nightly version of GLSP is compatible with the current sprotty nightly (potentially also 0.11.1 but that has not been tested).

If you want you could try to upgrade to the current nightly/next versions of both projects to see if you issue is resolved:
https://www.npmjs.com/package/@eclipse-glsp/client/v/0.10.0-nex…

View full answer

tortmayr · 2022-04-07T21:46:56Z

tortmayr
Apr 7, 2022
Maintainer

You are right version 0.9.0 of GLSP is only compatible with sprotty version 0.10.0. The reason for this is that sprotty introduced a complete overhaul of their action definitions with 0.11.0 (switching from a class based approach to an interface+namespace based approach) and deprecated the old way of defining actions.
In the meantime we have adapted this approach for GLSP and the nightly version of GLSP is compatible with the current sprotty nightly (potentially also 0.11.1 but that has not been tested).

If you want you could try to upgrade to the current nightly/next versions of both projects to see if you issue is resolved:
https://www.npmjs.com/package/@eclipse-glsp/client/v/0.10.0-next.385713d.170
https://www.npmjs.com/package/@eclipse-glsp/theia-integration/v/0.10.0-next.a2c1ac1.122
https://www.npmjs.com/package/sprotty/v/0.11.0-next.e898c14.30

Keep in mind that you probably need some adaptions to your code to resolve compilation errors. This will mostly affect action creation and type checking:

// Creating a new action
//pre. 0.11.0
new SelectionAction(["elementToSelect"],[])   

//new approach
SelectAction.create({selectedElementIDs: ["elementToSelect"]})  

// Typchecking
//pre 0.11.0
if (isSelectAction(actionToTest)){      
...
}

// new approach
if (SelectAction.is(actionToTest)){      
...
}

7 replies

rsoika Apr 8, 2022
Author

Now afert I have cleaned everything and build up from scratch, I run now into a strange error when starting :

index.js:61 TypeError: Cannot read property 'KIND' of undefined
    at vendors-node_modules_eclipse-glsp_client_lib_index_js-node_modules_eclipse-glsp_theia-integra-84627f.bundle.js:15579
    at Object.../node_modules/@eclipse-glsp/theia-integration/lib/browser/diagram/glsp-layout-commands.js (vendors-node_modules_eclipse-glsp_client_lib_index_js-node_modules_eclipse-glsp_theia-integra-84627f.bundle.js:15645)
    at __webpack_require__ (bundle.js:144668)
    at Object.../node_modules/@eclipse-glsp/theia-integration/lib/browser/diagram/index.js (vendors-node_modules_eclipse-glsp_client_lib_index_js-node_modules_eclipse-glsp_theia-integra-84627f.bundle.js:15991)
    at __webpack_require__ (bundle.js:144668)
    at Object.../node_modules/@eclipse-glsp/theia-integration/lib/browser/index.js (vendors-node_modules_eclipse-glsp_client_lib_index_js-node_modules_eclipse-glsp_theia-integra-84627f.bundle.js:16386)
    at __webpack_require__ (bundle.js:144668)
    at Object.../open-bpmn-theia/lib/browser/frontend-module.js (open-bpmn-theia_lib_browser_frontend-module_js-data_image_svg_xml_charset_utf-8_3Csvg_20xmlns-fdcebc.bundle.js:1632)
    at Function.__webpack_require__ (bundle.js:144668)

Could it be that I need to upgrade another dependency. For example I have dependencies like:

"@theia/core": "1.20.0",

I'm just wondering how I was able to successfully build and start with yarn before....

tortmayr Apr 8, 2022
Maintainer

Hm, what versions are you currently using for @eclipse-glsp/client and @eclipse-glsp/theia-integration?
Are you using a concrete version or just do you just use the next tag?

rsoika Apr 8, 2022
Author

I do currently using

  "devDependencies": {
    "@eclipse-glsp/config": "0.10.0",
    "lerna": "^4.0.0",
    "rimraf": "^2.6.1"
  },

  "dependencies": {
    "@eclipse-glsp/theia-integration": "0.10.0-next.a2c1ac1.122",
    "@eclipse-glsp/client": "0.10.0-next.385713d.170",
    "sprotty": "0.11.0-next.e898c14.30"    
    "@jsonforms/core": "3.0.0-beta.0",
    "@jsonforms/react": "3.0.0-beta.0",
    "@jsonforms/vanilla-renderers": "3.0.0-beta.0",
    "balloon-css": "^0.5.0"
  },

and for my -app module for launching the theia app I have still the following dependencies:

  "dependencies": {
    "@theia/core": "1.20.0",
    "@theia/editor": "1.20.0",
    "@theia/filesystem": "1.20.0",
    "@theia/markers": "1.20.0",
    "@theia/messages": "1.20.0",
    "@theia/monaco": "1.20.0",
    "@theia/navigator": "1.20.0",
    "@theia/preferences": "1.20.0",
    "@theia/process": "1.20.0",
    "@theia/terminal": "1.20.0",
    "@theia/workspace": "1.20.0",
    "@open-bpmn/open-bpmn-theia": "0.0.9"
  },

rsoika Apr 8, 2022
Author

Maybe my open-bpmn-theia module setup is no longer correct? I am still using the code form the workflow-example 0.9.0

Do you have an updated example working with the nightly build of eclipse-glsp? Then I can verify my own setup.

rsoika Apr 8, 2022
Author

@tortmayr Maybe this is total nonsenses, but when I try to understand the error message, my browser complains about

TypeError: Cannot read property 'KIND' of undefined
    at glsp-layout-commands.ts:40
....

in line 40 of glsp-layout-commands.ts I have:

export namespace GLSPLayoutCommands {
    export const RESIZE_WIDTH_MIN = 'glsp:' + ResizeElementsCommand.KIND + ':width:min';

But seachring for this "ResizeElementsCommand" I can only find a kind of definition (I do not understand what this is) in the file 'layout-elements-action.spec.ts'

describe('ResizeElementsCommand', () => {
    let handler: ResizeElementsActionHandler;
    const setModel = (newModel: SModelRoot): void => {
.....

And in this function/object there is no KIND property defined. Can this be the problem?

When I look into the code base of glsp-client 0.8.0 I can find the object in 'layout-commands.ts' with a KIND property

@injectable()
export class ResizeElementsCommand extends LayoutElementsCommand {
    static readonly KIND = 'layout:resize';

Could it be that ResizeElementsCommand' is really missing? ....or should I better keep my mouth shut with my JavaScript half-knowledge ;-)

tortmayr · 2022-04-10T16:22:30Z

tortmayr
Apr 10, 2022
Maintainer

Hi @rsoika,
I had a quick look at your project at it seems like the problem is that somehow two different versions of @eclipse-glsp/client got resolved in your project. The ResizeElementsCommand got renamed in between those two versions that's why it cannot be found.
To resolve this issue I recommend to add the glspGLSPversions to the resolutions block in your root package.json:

  "resolutions": {
    "**/@eclipse-glsp/theia-integration": "0.10.0-next.a2c1ac1.122",
    "**/@eclipse-glsp/client": "0.10.0-next.385713d.170",
    "**/@theia/core": "1.20.0",
    "**/@theia/editor": "1.20.0",
    "**/@theia/filesystem": "1.20.0",
    "**/@theia/markers": "1.20.0",
    "**/@theia/messages": "1.20.0",
    "**/@theia/monaco": "1.20.0",
    "**/@theia/navigator": "1.20.0",
    "**/@theia/outline-view": "1.20.0",
    "**/@theia/preferences": "1.20.0",
    "**/@theia/process": "1.20.0",
    "**/@theia/terminal": "1.20.0",
    "**/@theia/variable-resolver": "1.20.0",
    "**/@theia/userstorage": "1.20.0",
    "**/@theia/workspace": "1.20.0",
    "**/@theia/cli": "1.20.0",
    "**/inversify": "5.1.1"
  }

This ensures that exactly one version gets resolved during building.

FYI : The layout-elements-action.spec.ts is a test file and contains unit tests for the code located in layout-elements-action.ts.

I also saw that you are using a full-wipe.sh script which deletes the yarn.lock file. I would consider that bad practice. Many dependencies in npm packages have a fluent version range. The yarn.lock file is used to pin this fluent ranges to a concrete version during the initial build. This ensures that subsequent builds are always using with the same dependency tree. There should hardly ever be a reason to complete remove the yarn.lock file.
To me it looks like your script is just removing gitignored files. You could do the same with the git clean -xdf command.

1 reply

rsoika Apr 10, 2022
Author

Thanks! Yes adding to lines into the resolutions section solved the problem. Now I can build and run again. Thanks a lot!!

I also improved my project setup according to your recommendations. Thanks.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GLSP-client and Sprotty dependency #611

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Replies: 2 comments 8 replies

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

Select a reply

GLSP-client and Sprotty dependency #611

rsoika Apr 7, 2022

Replies: 2 comments · 8 replies

tortmayr Apr 7, 2022 Maintainer

rsoika Apr 8, 2022 Author

tortmayr Apr 8, 2022 Maintainer

rsoika Apr 8, 2022 Author

rsoika Apr 8, 2022 Author

rsoika Apr 8, 2022 Author

tortmayr Apr 10, 2022 Maintainer

rsoika Apr 10, 2022 Author

rsoika
Apr 7, 2022

Replies: 2 comments 8 replies

tortmayr
Apr 7, 2022
Maintainer

rsoika Apr 8, 2022
Author

tortmayr Apr 8, 2022
Maintainer

rsoika Apr 8, 2022
Author

rsoika Apr 8, 2022
Author

rsoika Apr 8, 2022
Author

tortmayr
Apr 10, 2022
Maintainer

rsoika Apr 10, 2022
Author