Skip to content

Commit be04ded

Browse files
svorsvor
authored
chore: don't fetch editors from plugin registry (#64)
Signed-off-by: Valeriy Svydenko <[email protected]>
1 parent e0a0622 commit be04ded

File tree

11 files changed

+360
-177
lines changed

11 files changed

+360
-177
lines changed

‎.devfile.yaml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
schemaVersion: 2.3.0
2+
metadata:
3+
name: devworkspace-generator
4+
components:
5+
- name: builder
6+
container:
7+
image: quay.io/devfile/universal-developer-image:ubi8-latest
8+
memoryRequest: 256Mi
9+
memoryLimit: 3Gi
10+
cpuRequest: 100m
11+
cpuLimit: '1'
12+
commands:
13+
- id: build
14+
exec:
15+
label: "1. Build"
16+
component: builder
17+
workingDir: ${PROJECTS_ROOT}/devworkspace-generator
18+
commandLine: yarn && yarn format:fix && yarn build
19+
- id: test
20+
exec:
21+
label: "2. Run tests"
22+
component: builder
23+
workingDir: ${PROJECTS_ROOT}/devworkspace-generator
24+
commandLine: yarn test
25+
- id: generate-devworkspace
26+
exec:
27+
label: "3. Generate DevWorkspace with Template"
28+
component: builder
29+
workingDir: ${PROJECTS_ROOT}/devworkspace-generator
30+
commandLine: |
31+
node lib/entrypoint.js \
32+
--devfile-url:https://github.com/che-samples/java-spring-petclinic/tree/main \
33+
--editor-url:https://raw.githubusercontent.com/eclipse-che/che-operator/refs/heads/main/editors-definitions/che-code-insiders.yaml \
34+
--output-file:/tmp/devworkspace-che-code-latest.yaml \
35+
--injectDefaultComponent:true \
36+
--defaultComponentImage:registry.access.redhat.com/ubi8/openjdk-11:latest

‎.vscode/extensions.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"recommendations": [
3+
"dbaeumer.vscode-eslint",
4+
"redhat.vscode-yaml",
5+
"Orta.vscode-jest",
6+
"cnshenj.vscode-task-manager"
7+
]
8+
}

‎LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md‎

Lines changed: 51 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,51 @@
11
## DevWorkspace Generator
2-
The library is used by Devfile registry component to generate the DevWorkspace components and DevWorkspace templates. It requires editor definitions from the
3-
[che-plugin-registry](https://github.com/eclipse-che/che-plugin-registry/).
2+
[![Contribute](https://www.eclipse.org/che/contribute.svg)](https://workspaces.openshift.com#https://github.com/devfile/devworkspace-generator)
3+
[![Contribute (nightly)](https://img.shields.io/static/v1?label=nightly%20Che&message=for%20maintainers&logo=eclipseche&color=FDB940&labelColor=525C86)](https://che-dogfooding.apps.che-dev.x6e0.p1.openshiftapps.com#https://github.com/devfile/devworkspace-generator)
4+
5+
The library is used by Eclipse Che to generate DevWorkspace components and templates. It requires both the original devfile.yaml and the editor definitions.
6+
7+
## Where is it Published?
8+
This library is available on npm.
9+
10+
You can find the published package here: \
11+
__npm:__ [@eclipse-che/che-devworkspace-generator](https://www.npmjs.com/package/@eclipse-che/che-devworkspace-generator)
12+
13+
## Usage
14+
15+
### Here’s an example of how to use the @eclipse-che/che-devworkspace-generator library to generate a DevWorkspace and DevWorkspaceTemplate:
16+
17+
```typescript
18+
import { Main as DevworkspaceGenerator } from '@eclipse-che/che-devworkspace-generator/lib/main';
19+
import { V1alpha2DevWorkspaceTemplate } from '@devfile/api';
20+
import { dump } from 'js-yaml';
21+
22+
// Initialize the DevWorkspace generator
23+
const generator = new DevworkspaceGenerator();
24+
25+
// Example function to generate DevWorkspace resources
26+
async function generateDevWorkspace(devfileContent: string, editorContent: string, axiosInstance: any) {
27+
// Generate the Devfile context
28+
const context = await generator.generateDevfileContext(
29+
{
30+
devfileContent,
31+
editorContent,
32+
projects: [],
33+
},
34+
axiosInstance,
35+
);
36+
37+
// Convert templates and DevWorkspace to YAML
38+
const allContentArray = context.devWorkspaceTemplates.map(
39+
(template: V1alpha2DevWorkspaceTemplate) => dump(template),
40+
);
41+
allContentArray.push(dump(context.devWorkspace));
42+
43+
// Return the YAML content joined by "---"
44+
return allContentArray.join('---\n');
45+
}
46+
```
447

5-
## How to use the library
6-
The library can be used as a standalone library.
48+
### The library can be used as a standalone library:
749

850
```
951
USAGE
@@ -14,10 +56,11 @@ OPTIONS
1456
or
1557
--devfile-path: path to the devfile.yaml file
1658
17-
--plugin-registry-url: URL to the plugin registry that contains editor definitions (devfile.yaml)
18-
--editor-entry: editor ID, found on the <plugin-registry-url>, to resolve the devfile.yaml
59+
--editor-url: URL for the editor's definition, should be publicly accessible for download.
1960
or
2061
--editor-path: local file path of the editor devfile.yaml
62+
or
63+
--editor-content: content of the editor devfile.yaml
2164
2265
--output-file: local file path for the generated devworkspace yaml
2366
@@ -29,12 +72,11 @@ OPTIONS
2972
3073
EXAMPLES
3174
32-
# online example, using editor definition from https://che-plugin-registry-main.surge.sh/
75+
# online example, using editor definition from https://raw.githubusercontent.com/eclipse-che/che-operator/refs/heads/main/editors-definitions/che-code-insiders.yaml
3376
3477
$ node lib/entrypoint.js \
3578
--devfile-url:https://github.com/che-samples/java-spring-petclinic/tree/main \
36-
--plugin-registry-url:https://che-plugin-registry-main.surge.sh/v3/ \
37-
--editor-entry:che-incubator/che-code/latest \
79+
--editor-url:https://raw.githubusercontent.com/eclipse-che/che-operator/refs/heads/main/editors-definitions/che-code-insiders.yaml \
3880
--output-file:/tmp/devworkspace-che-code-latest.yaml \
3981
--injectDefaultComponent:true \
4082
--defaultComponentImage:registry.access.redhat.com/ubi8/openjdk-11:latest

src/plugin-registry/plugin-registry-module.ts renamed to src/editor/editor-module.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@
99
***********************************************************************/
1010
import { ContainerModule, interfaces } from 'inversify';
1111

12-
import { PluginRegistryResolver } from './plugin-registry-resolver';
12+
import { EditorResolver } from './editor-resolver';
1313

14-
const pluginRegistryModule = new ContainerModule((bind: interfaces.Bind) => {
15-
bind(PluginRegistryResolver).toSelf().inSingletonScope();
14+
const editorModule = new ContainerModule((bind: interfaces.Bind) => {
15+
bind(EditorResolver).toSelf().inSingletonScope();
1616
});
1717

18-
export { pluginRegistryModule };
18+
export { editorModule };

src/plugin-registry/plugin-registry-resolver.ts renamed to src/editor/editor-resolver.ts

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,27 +10,22 @@
1010

1111
import * as jsYaml from 'js-yaml';
1212

13-
import { inject, injectable, named } from 'inversify';
13+
import { inject, injectable } from 'inversify';
1414

1515
import { UrlFetcher } from '../fetch/url-fetcher';
1616

1717
/**
1818
* Resolve plug-ins by grabbing the definition from the plug-in registry.
1919
*/
2020
@injectable()
21-
export class PluginRegistryResolver {
22-
@inject('string')
23-
@named('PLUGIN_REGISTRY_URL')
24-
private pluginRegistryUrl: string;
25-
21+
export class EditorResolver {
2622
@inject(UrlFetcher)
2723
private urlFetcher: UrlFetcher;
2824

29-
// FQN id (like che-incubator/che-code/next)
25+
// Editor URL (like https://raw.githubusercontent.com/eclipse-che/che-operator/refs/heads/main/editors-definitions/che-code-latest.yaml)
3026
// eslint-disable-next-line @typescript-eslint/no-explicit-any
31-
async loadDevfilePlugin(devfileId: string): Promise<any> {
32-
const devfileUrl = `${this.pluginRegistryUrl}/plugins/${devfileId}/devfile.yaml`;
33-
const devfileContent = await this.urlFetcher.fetchText(devfileUrl);
27+
async loadEditor(editorUrl: string): Promise<any> {
28+
const devfileContent = await this.urlFetcher.fetchText(editorUrl);
3429
return jsYaml.load(devfileContent);
3530
}
3631
}

0 commit comments

Comments
 (0)