[marketplace] Add a 3rd Party marketplace #2592

J-N-K · 2021-12-05T17:21:29Z

This adds a new AddonService implementation that allows to add marketplaces maintained by 3rd party individuals (similar to alternative app stores on the smartphone).

The configuration allows one or multiple marketplaces which provide their addons via JSON files (instead of a topic in the community forum). Installation is done by re-using the already present .jar, .kar, .json, .yaml bundle installers (same as community marketplace).

The JSON referenced by the URL encapsulates an array of one or more addon definitions like

[
  {
    "id": "tld-johndoe-binding-foo",
    "type": "binding",
    "title": "Foo Binding",
    "description": "This binding integrates Foo smarthome devices with openHAB",
    "link": "https://johndoe.tld/foodoc.html",
    "version": "1.0.0",
    "author": "John Doe",
    "maturity": "stable",
    "content_type": "application/vnd.openhab.feature;type=karfile",
    "url": "https://johndoe.tld/tld.johndoe.binding.foo-1.0.0.kar"
  },
  {
    ...
  }
]

This could also be used to distribute version-specific (by using different JSON files) bindings with back ported feature or bugfixes.

Signed-off-by: Jan N. Klug jan.n.klug@rub.de

This adds a new marketplace addon provider which allows to add marketplaces maintained by 3rd party organizations (similar to alternative app stores on your smartphone). The configuration allows one or multiple marketplaces which provide their addons via JSON files (instead of a topic in the community forum). Signed-off-by: Jan N. Klug <jan.n.klug@rub.de>

Signed-off-by: Jan N. Klug <jan.n.klug@rub.de>

clinique · 2021-12-08T22:29:41Z

I wish this will be accepted.

cweitkamp

I am fine with this new service. From my pov we should call is just JsonAddonService without the phrase "Marketplace".

cweitkamp · 2021-12-09T18:57:24Z

.../main/java/org/openhab/core/addon/marketplace/internal/json/JsonMarketplaceAddonService.java

+    private static final Map<String, AddonType> TAG_ADDON_TYPE_MAP = Map.of( //
+            "automation", new AddonType("automation", "Automation"), //
+            "binding", new AddonType("binding", "Bindings"), //
+            "misc", new AddonType("misc", "Misc"), //
+            "persistence", new AddonType("persistence", "Persistence"), //
+            "transformation", new AddonType("transformation", "Transformations"), //
+            "ui", new AddonType("ui", "User Interfaces"), //
+            "voice", new AddonType("voice", "Voice"));


Can this be refactored to be a global constant for all AddonServices? Or do we expect different capabillties of those?

Easy, but the question is what the correct place would be. In general an AddonService is not required to supply all AddonTypes, however each AddonService could pick what is available. We do not have an AddonConstants class or something similar which would be a good fit. Another solution would be to make the map public in the CommunityMarketplaceAddonService but that would mix different AddonServices which should IMO be avoided.

I hate duplicated code, but IMO here it seems the best solution.

.../main/java/org/openhab/core/addon/marketplace/internal/json/JsonMarketplaceAddonService.java

...arketplace/src/main/java/org/openhab/core/addon/marketplace/internal/json/AddonEntryDTO.java

.../main/java/org/openhab/core/addon/marketplace/internal/json/JsonMarketplaceAddonService.java

Signed-off-by: Jan N. Klug <jan.n.klug@rub.de>

J-N-K · 2021-12-10T09:16:53Z

@cweitkamp Thanks for the review. I have addressed all but one comment (the refactoring of the duplicated map).

.../main/java/org/openhab/core/addon/marketplace/internal/json/JsonMarketplaceAddonService.java

Signed-off-by: Jan N. Klug <jan.n.klug@rub.de>

ghys · 2021-12-10T14:30:24Z

...etplace/src/main/java/org/openhab/core/addon/marketplace/internal/json/JsonAddonService.java

+ */
+@Component(immediate = true, configurationPid = "org.openhab.core.marketplace.json", //
+        property = Constants.SERVICE_PID + "=org.openhab.core.marketplace.json")
+@ConfigurableService(category = "system", label = "JSON 3rd Party Addon Service", description_uri = JsonAddonService.CONFIG_URI)


From an UX perspective - it's the 3rd configurable service related to add-ons that will appear under "Settings > System Services" with barely any parameter which is beginning to become a lot and quite messy. If anything we should really think about reducing this proliferation and merging related configurations (I've talked about this before).

Add-on Management + Community Marketplace + JSON 3rd Party Addon Service (also note the difference in spelling of Add-on/Addon + JSON/Json in the existing "Json Storage"!) => Add-on Management

Regional Settings + Ephemeris => Regional Settings

Audio + Voice => Audio & Voice

Maybe also Sitemap + Charts => ?

Maybe have configurable services for the sole purposes of providing the configuration and have the actual services inject them?

I thought about that, too. The problem is that we - at least I know of no way to do it - can't group in the UI within a category. If we merge everything under e.g. system:addon (which in general would be preferred IMO), it's not easily visible to the user which parameter affects which service.

I'll fix the spelling.

Would it help to introduce another level in der config description URI? E.g. system:addon:management, system:addon:marketplace and system:addon:json? The UI could then group by the second level (if present).

The good thing to this approach is that it is fully backward compatible since the service PID stays the same and therefore the configuration is also used after the config description URI changed. This also leaves us time to decide what the best approach is, since it would not create a problem if it is changed after the release.

Signed-off-by: Jan N. Klug <jan.n.klug@rub.de>

cweitkamp

LGTM. Thanks.

I agree on the grouping of settings in the UI. This PR does not need to wait for a solution for that as we obviously have to change other ConfigurableServices too to reach that goal.

* [marketplace] add a 3rd Party compatible marketplace This adds a new marketplace addon provider which allows to add marketplaces maintained by 3rd party organizations (similar to alternative app stores on your smartphone). The configuration allows one or multiple marketplaces which provide their addons via JSON files (instead of a topic in the community forum). Signed-off-by: Jan N. Klug <jan.n.klug@rub.de> GitOrigin-RevId: 8a29b07

J-N-K requested a review from a team as a code owner December 5, 2021 17:21

fix config parameter name

8711dcb

Signed-off-by: Jan N. Klug <jan.n.klug@rub.de>

cweitkamp reviewed Dec 9, 2021

View reviewed changes

cweitkamp added the enhancement An enhancement or new feature of the Core label Dec 9, 2021

address review comments

8839756

Signed-off-by: Jan N. Klug <jan.n.klug@rub.de>

cweitkamp reviewed Dec 10, 2021

View reviewed changes

.../main/java/org/openhab/core/addon/marketplace/internal/json/JsonMarketplaceAddonService.java Outdated Show resolved Hide resolved

cweitkamp reviewed Dec 10, 2021

View reviewed changes

.../main/java/org/openhab/core/addon/marketplace/internal/json/JsonMarketplaceAddonService.java Outdated Show resolved Hide resolved

J-N-K added 3 commits December 10, 2021 10:33

prevent NPE

30f3703

Signed-off-by: Jan N. Klug <jan.n.klug@rub.de>

fix spotless

3fd833d

Signed-off-by: Jan N. Klug <jan.n.klug@rub.de>

adjust bundle name

48e1fcd

Signed-off-by: Jan N. Klug <jan.n.klug@rub.de>

ghys reviewed Dec 10, 2021

View reviewed changes

J-N-K added 3 commits December 10, 2021 15:46

fix spelling

7dd12c1

Signed-off-by: Jan N. Klug <jan.n.klug@rub.de>

more fixes

52f11a1

Signed-off-by: Jan N. Klug <jan.n.klug@rub.de>

align service-pid naming with marketplace

a1809d3

Signed-off-by: Jan N. Klug <jan.n.klug@rub.de>

cweitkamp approved these changes Dec 11, 2021

View reviewed changes

cweitkamp merged commit 8a29b07 into openhab:main Dec 11, 2021

wborn added this to the 3.2 milestone Dec 13, 2021

wborn changed the title ~~[marketplace] add a 3rd Party marketplace~~ [marketplace] Add a 3rd Party marketplace Dec 18, 2021

wborn mentioned this pull request Jan 8, 2022

Build fails with: ! Failed to start bundle org.apache.aries.jax.rs.whiteboard-2.0.1, exception activator error Bad type on operand stack openhab/openhab-distro#1327

Closed

J-N-K deleted the marketplace branch February 25, 2022 07:50

J-N-K mentioned this pull request Feb 26, 2022

ExtensionService for snapshot addons #1175

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[marketplace] Add a 3rd Party marketplace #2592

[marketplace] Add a 3rd Party marketplace #2592

J-N-K commented Dec 5, 2021 •

edited

Loading

clinique commented Dec 8, 2021

cweitkamp left a comment

cweitkamp Dec 9, 2021

J-N-K Dec 10, 2021

J-N-K commented Dec 10, 2021

ghys Dec 10, 2021 •

edited

Loading

J-N-K Dec 10, 2021 •

edited

Loading

J-N-K Dec 10, 2021 •

edited

Loading

cweitkamp left a comment

[marketplace] Add a 3rd Party marketplace #2592

[marketplace] Add a 3rd Party marketplace #2592

Conversation

J-N-K commented Dec 5, 2021 • edited Loading

clinique commented Dec 8, 2021

cweitkamp left a comment

Choose a reason for hiding this comment

cweitkamp Dec 9, 2021

Choose a reason for hiding this comment

J-N-K Dec 10, 2021

Choose a reason for hiding this comment

J-N-K commented Dec 10, 2021

ghys Dec 10, 2021 • edited Loading

Choose a reason for hiding this comment

J-N-K Dec 10, 2021 • edited Loading

Choose a reason for hiding this comment

J-N-K Dec 10, 2021 • edited Loading

Choose a reason for hiding this comment

cweitkamp left a comment

Choose a reason for hiding this comment

J-N-K commented Dec 5, 2021 •

edited

Loading

ghys Dec 10, 2021 •

edited

Loading

J-N-K Dec 10, 2021 •

edited

Loading

J-N-K Dec 10, 2021 •

edited

Loading