Skip to content

Conversation

@vitaliy-guliy
Copy link
Contributor

@vitaliy-guliy vitaliy-guliy commented Dec 23, 2024

Description of Changes

Compile generated @devfile/api node package as commonjs module instead of node:module.

It was around two years ago when the @devfile/api package was published as commonjs module https://www.npmjs.com/package/@devfile/api/v/2.2.1-alpha-1667236163?activeTab=code

Since that time all the node libraries generated by openapi-generator are being compiled as node:module.
( go to https://www.npmjs.com/package/@devfile/api?activeTab=code, open package.json and look at type property )

Both Che Dashboard and Che Code projects are compiled as commonjs.

There is a well known restriction, that node:modue cannot be included into commonjs module using import, require should be used instead.

Che Dashboard and Che Code projects both use @devfile/api. When we package dashboard and che-code with webpack, we do not have any issues ( btw, this is a reason why we didn't have the problem for a long time). But when we try to compile the project without using webpack and then run it in a development mode (browser downloads a thousand of separate files), we face a problem with loading some files from @devfile/api.

The original issue highlighting a problem eclipse-che/che#23163
A workaround after which I decided to open this PR che-incubator/che-code#472

Tests Performed

Explain what tests you personally ran to ensure the changes are functioning as expected.

How To Test

Instructions for the reviewer on how to test your changes.

Notes To Reviewer

Any notes you would like to include for the reviewer.

Signed-off-by: vitaliy-guliy <vgulyy@redhat.com>
Copy link
Contributor

@svor svor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Copy link
Member

@michael-valdron michael-valdron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vitaliy-guliy Thank you for your contribution!

Just have one suggestion about adding to the documentation, looks good to me otherwise.

Signed-off-by: vitaliy-guliy <vgulyy@redhat.com>
@openshift-ci openshift-ci bot removed the lgtm label Feb 6, 2025
Signed-off-by: vitaliy-guliy <vgulyy@redhat.com>
Copy link
Member

@michael-valdron michael-valdron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@openshift-ci
Copy link

openshift-ci bot commented Feb 6, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: dkwon17, michael-valdron, svor, vitaliy-guliy

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@michael-valdron michael-valdron merged commit 4d527f9 into devfile:main Feb 6, 2025
8 checks passed
@michael-valdron michael-valdron mentioned this pull request Feb 6, 2025
4 tasks
@vitaliy-guliy vitaliy-guliy deleted the module-to-commonjs branch February 10, 2025 12:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants