Expose version of the registry service via API endpoint #860

xai · 2024-02-22T19:04:21Z

Server:

Define server version in gradle.properties
Add gradle task to create a resources properties file in the build directory
Expose server version at the endpoint: /api/version

Web-ui:

Display the server version in the footer.

Fixes #21

xai · 2024-02-22T19:09:12Z

As discussed with @kkistm, we decided to contribute a patch addressing #21.

I did not find any version indicator in the java server, so I introduced the version property and set it to the most recent tag. Please let me know if I overlooked something or whether we should use something other than the tag.

kkistm · 2024-02-27T10:23:51Z

server/src/main/java/org/eclipse/openvsx/json/RegistryVersionJson.java

+    name = "RegistryVersion",
+    description = "Version of the registry service"
+)
+


Looks like an extra empty line.

kkistm · 2024-02-27T10:24:29Z

server/src/main/java/org/eclipse/openvsx/LocalRegistryService.java

+            registryVersion.version = properties.getProperty("version");
+            return registryVersion;
+        } catch (IOException e) {
+            throw new RuntimeException("Failed to load version from " + propertiesPath, e);


Other methods of the service throw ErrorResultException, should it be the same here?

If I understand the code correctly, ErrorResultException seems to be used if the client side makes an argument error or uses an invalid token on a protected endpoint.

But of course you are right: If the version cannot be read, we should definitely log that so it shows in the server logs. And we should probably still return a value here, such as an 'unknown' version string, instead of throwing a runtime exception. I will address this in a follow-up commit.

I now used ErrorResultException, as you suggested.

kkistm · 2024-02-27T10:27:23Z

server/src/main/java/org/eclipse/openvsx/RegistryAPI.java

+
+    @GetMapping(path = "/api/version", produces = MediaType.APPLICATION_JSON_VALUE)
+    public ResponseEntity<RegistryVersionJson> getServerVersion() {
+        return ResponseEntity.ok(local.getRegistryVersion());


I see other methods are catching the exceptions and then process it something like this:

... } catch (ErrorResultException exc) { return exc.toResponseEntity(RegistryEntityJson.class); }

Should it be in the same way here?

Right, this seems to be the pattern we should be following. I adjusted the method accordingly.

kkistm · 2024-02-27T10:34:15Z

server/src/main/java/org/eclipse/openvsx/UpstreamRegistryService.java

@@ -381,6 +381,26 @@ public String getPublicKey(String publicId) {
        }
    }

+    @Override


It doesn't look like the method will be used by any use-case. Should it be some stub instead?

I am also unaware of a use case for now.

We could also reconsider extending the interface if there is no use case. I extended the IExtensionRegistry interface because getRegistryVersion() fulfills the interface declares "[...] registry API methods that can be accessed without authentication".

So we have three possibilities:

Remove from interface

Stub with UnsupportedOperationException

Keep implementation even if not used for now

Which one would you prefer?

For now I would propose to keep it, but add a comment that the functionality is not used at the moment, but could be used if there is a need to show a version of an upstream registry.
In future I would propose to revise the interfaces, maybe remove/add more methods.

Good idea, done!

xai · 2024-03-19T22:59:07Z

I squashed my commits into one, as suggested by @amvanbaren in #854.

amvanbaren

@xai Can you add ovsx.registry.version to the application.yml instead of using a properties file?

xai · 2024-03-29T16:05:36Z

@xai Can you add ovsx.registry.version to the application.yml instead of using a properties file?

Done. I also rebased against master again due to an import conflict.

server/src/main/java/org/eclipse/openvsx/UpstreamRegistryService.java

amvanbaren · 2024-04-01T09:25:30Z

server/src/main/java/org/eclipse/openvsx/UpstreamRegistryService.java

+            ResponseEntity<RegistryVersionJson> response = restTemplate.getForEntity(urlTemplate,
+                    RegistryVersionJson.class);
+
+            if (response.getStatusCode() == HttpStatus.OK && response.getBody() != null) {


You don't need to double check. Already handled by RestClientException.

server/src/main/java/org/eclipse/openvsx/RegistryAPI.java

amvanbaren · 2024-04-01T09:57:11Z

server/src/main/java/org/eclipse/openvsx/RegistryAPI.java

+    public ResponseEntity<RegistryVersionJson> getServerVersion() {
+        try {
+            return ResponseEntity.ok(local.getRegistryVersion());


You can add a Cache-Control header here, e.g. .cacheControl(CacheControl.maxAge(10, TimeUnit.MINUTES).cachePublic())

* server: The version number has to be updated in the application.yml file The endpoint /api/version can be queried to retrieve the version of the registry server. * webui: The version is displayed in the footer. Lazy/Suspend is used to not block rendering of the app with this call. Contributed on behalf of STMicroelectronics Signed-off-by: Olaf Lessenich <olessenich@eclipsesource.com>

xai changed the title ~~Version api~~ Expose version of the registry service via API endpoint Feb 22, 2024

kkistm reviewed Feb 27, 2024

View reviewed changes

xai requested a review from kkistm March 18, 2024 23:20

xai force-pushed the version-api branch from 537acaf to d666c3f Compare March 19, 2024 22:57

xai force-pushed the version-api branch from d666c3f to 014f045 Compare March 21, 2024 16:42

amvanbaren requested changes Mar 29, 2024

View reviewed changes

xai force-pushed the version-api branch 2 times, most recently from 1aeaa6d to 0b75caf Compare March 29, 2024 16:04

xai requested a review from amvanbaren March 29, 2024 16:05

amvanbaren reviewed Apr 1, 2024

View reviewed changes

server/src/main/java/org/eclipse/openvsx/UpstreamRegistryService.java Show resolved Hide resolved

amvanbaren reviewed Apr 1, 2024

View reviewed changes

server/src/main/java/org/eclipse/openvsx/RegistryAPI.java Show resolved Hide resolved

amvanbaren reviewed Apr 1, 2024

View reviewed changes

xai force-pushed the version-api branch 2 times, most recently from 2a9f359 to 5ba3615 Compare April 16, 2024 09:51

xai force-pushed the version-api branch from 5ba3615 to 74aa5bc Compare April 16, 2024 10:03

xai requested a review from amvanbaren April 16, 2024 10:05

amvanbaren approved these changes Apr 17, 2024

View reviewed changes

amvanbaren merged commit b98bc47 into eclipse:master Apr 17, 2024
2 checks passed

xai deleted the version-api branch April 17, 2024 08:02

amvanbaren mentioned this pull request Apr 17, 2024

Release v0.15.0 EclipseFdn/open-vsx.org#2515

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Expose version of the registry service via API endpoint #860

Expose version of the registry service via API endpoint #860

xai commented Feb 22, 2024

xai commented Feb 22, 2024

kkistm Feb 27, 2024

kkistm Feb 27, 2024

xai Feb 29, 2024 •

edited

xai Mar 15, 2024

kkistm Feb 27, 2024

xai Mar 15, 2024

kkistm Feb 27, 2024

xai Mar 15, 2024

kkistm Mar 20, 2024

xai Mar 21, 2024

xai commented Mar 19, 2024

amvanbaren left a comment

xai commented Mar 29, 2024

amvanbaren Apr 1, 2024

amvanbaren Apr 1, 2024

xai Apr 16, 2024

Expose version of the registry service via API endpoint #860

Expose version of the registry service via API endpoint #860

Conversation

xai commented Feb 22, 2024

xai commented Feb 22, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xai Feb 29, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xai commented Mar 19, 2024

amvanbaren left a comment

Choose a reason for hiding this comment

xai commented Mar 29, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xai Feb 29, 2024 •

edited