feat(extensions): Introduce fetch endpoints for configuration

[dzemanov]

Hey, I just made a Pull Request!

Introduces fetch endpoints for plugin configuration.

Fixes

Fixes RHIDP-6807

How to test

1. Create dynamic-plugins.yaml with:

plugins:
  - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-bulk-import-backend-dynamic
    disabled: false
  - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-bulk-import
    disabled: true
    pluginConfig:
      dynamicPlugins:
        frontend:
          red-hat-developer-hub.backstage-plugin-bulk-import:
            appIcons:
              - name: bulkImportIcon3
                importName: BulkImportIcon3
            dynamicRoutes:
              - path: /bulk-import/repositories
                importName: BulkImportPage
                menuItem:
                  icon: bulkImportIcon
                  text: Bulk import
  - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-marketplace-backend-dynamic
    disabled: false
  - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-marketplace
    disabled: false # COMMENT
    pluginConfig:
      dynamicPlugins:
        frontend:
          red-hat-developer-hub.backstage-plugin-marketplace:
            appIcons:
              - name: marketplace
                importName: MarketplaceIcon
            dynamicRoutes:
              - path: /extensions/catalog
                importName: DynamicMarketplacePluginRouter
            mountPoints:
              - mountPoint: internal.plugins/tab
                importName: DynamicMarketplacePluginContent
                config:
                  path: marketplace
                  title: Catalog

2. Test that the endpoints return 503 if extensions.installation.enabled is not set:

{
  "error": {
    "name": "InstallationInitError",
    "message": "Installation feature is disabled under 'extensions.installation.enabled'",
    "reason": "INSTALLATION_DISABLED",
    "statusCode": 503,
    "stack": "..."
  },
  "request": {
    "method": "GET",
    "url": "/plugin/marketplace-plugin-demo/marketplace/configuration"
  },
  "response": {
    "statusCode": 503
  }

curl -X GET "http://localhost:7007/api/extensions/package/marketplace-plugin-demo/red-hat-developer-hub-backstage-plugin-marketplace/configuration" -H "Content-Type: application/json" -H "Authorization: Bearer $token"

curl -X GET "http://localhost:7007/api/extensions/plugin/marketplace-plugin-demo/marketplace/configuration" -H "Content-Type: application/json" -H "Authorization: Bearer $token"

3. Update extensions.installation to point to the dynamic-plugins.yaml file

extensions:
  installation:
    enabled: true
    saveToSingleFile:
      file: /my-path/dynamic-plugins.yaml

4. Test GET package configuration

curl -X GET "http://localhost:7007/api/extensions/package/marketplace-plugin-demo/red-hat-developer-hub-backstage-plugin-marketplace/configuration" -H "Content-Type: application/json" -H "Authorization: Bearer $token"

Should return:

{
"configYaml":
    "- package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-marketplace
      disabled: false # COMMENT
      pluginConfig:
        dynamicPlugins:
          frontend:
            red-hat-developer-hub.backstage-plugin-marketplace:
              appIcons:
                - name: marketplace
                  importName: MarketplaceIcon
              dynamicRoutes:
                - path: /extensions/catalog
                  importName: DynamicMarketplacePluginRouter
              mountPoints:
                - mountPoint: internal.plugins/tab
                  importName: DynamicMarketplacePluginContent
                  config:
                    path: marketplace
                    title: Catalog"
}

5. Test GET plugin configuration

curl -X GET "http://localhost:7007/api/extensions/plugin/marketplace-plugin-demo/marketplace/configuration" -H "Content-Type: application/json" -H "Authorization: Bearer $token"

Should return

{
"configYaml":
    "- package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-marketplace
      disabled: false # COMMENT
      pluginConfig:
        dynamicPlugins:
          frontend:
            red-hat-developer-hub.backstage-plugin-marketplace:
              appIcons:
                - name: marketplace
                  importName: MarketplaceIcon
              dynamicRoutes:
                - path: /extensions/catalog
                  importName: DynamicMarketplacePluginRouter
              mountPoints:
                - mountPoint: internal.plugins/tab
                  importName: DynamicMarketplacePluginContent
                  config:
                    path: marketplace
                    title: Catalog
    - package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-marketplace-backend-dynamic
      disabled: false"
}

6. Update plugins config to point to nonexistent file and call one of the new endpoints

{
  "error": {
    "name": "InstallationInitError",
    "message": "Installation config file does not exist: /path/to/dynamic-plugins-nonexistent.yaml",
    "reason": "FILE_NOT_EXISTS",
    "statusCode": 500,
    "stack": "..."
  },
  "request": {
    "method": "GET",
    "url": "/plugin/marketplace-plugin-demo/marketplace/configuration"
  },
  "response": {
    "statusCode": 500
  }
}

7. Remove file from config, while installation is enabled and call one of the new endpoints

{
  "error": {
    "name": "InstallationInitError",
    "message": "Missing required config value at 'extensions.installation.saveToSingleFile.file'",
    "reason": "FILE_CONFIG_VALUE_MISSING",
    "statusCode": 500,
    "stack": "..."
  },
  "request": {
    "method": "GET",
    "url": "/plugin/marketplace-plugin-demo/marketplace/configuration"
  },
  "response": {
    "statusCode": 500
  }
}

8. Update plugins config to invalid format and call one of the new endpoints

{
  "error": {
    "name": "InstallationInitError",
    "message": "Invalid installation configuration, optional 'disabled' field in each package item must be a boolean",
    "reason": "INVALID_CONFIG",
    "statusCode": 500,
    "stack": "..."
  },
  "request": {
    "method": "GET",
    "url": "/plugin/marketplace-plugin-demo/marketplace/configuration"
  },
  "response": {
    "statusCode": 500
  }
}

✔️ Checklist

• A changeset describing the change and affected packages. (more info)
• Added or Updated documentation
• Tests for new functionality and regression tests for bug fixes
• Screenshots attached (for UI changes)

[rhdh-gh-app]

Important

This PR includes changes that affect public-facing API. Please ensure you are adding/updating documentation for new features or behavior.

Changed Packages

Package Name	Package Path	Changeset Bump	Current Version
@red-hat-developer-hub/backstage-plugin-marketplace-backend	workspaces/marketplace/plugins/marketplace-backend	minor	v0.3.1
@red-hat-developer-hub/backstage-plugin-marketplace-common	workspaces/marketplace/plugins/marketplace-common	minor	v0.3.0

[debsmita1]

For a configuration like

extensions:
  ### Example for how to enable installation to a file.
  installation:
    enabled: true
    # type: 'saveToSingleFile'
    # saveToSingleFile:
    #   file: /Users/dsantra/Documents/rhdh-plugins/workspaces/marketplace/dynamic-plugins.yaml

The API throws an error saying

Installation is disabled under 'extensions.installation.enabled'.

If we are only support saving to a single file now, would it make sense to not have the type: 'saveToSingleFile' config property ?
We can add the type, once we support more installation types

For dynamic-plugin.yaml content containing a random string like xyz , I get a response like

{
  "error": {
      "name": "Error",
      "message": "Installation is disabled under 'extensions.installation.enabled'.",
      ...
          },
  "request": {
      "method": "GET",
      "url": "/plugin/marketplace-plugin-demo/marketplace/configuration"
  },
  "response": {
      "statusCode": 500
  }
}

[dzemanov]

@debsmita1 sure, we can remove the type for now.

The cases with invalid config should fall under 6. case, Marketplace installation feature is disabled, the log includes Error while loading installation data. Installation will be disabled. Error: ... and api endpoints return 500. Would it be more appropriate to throw an error and prevent plugin from starting up in case of invalid file format?

For the case when file is not specified although installation is enabled, we can change the behavior as well to throw an error and prevent plugin from starting up.

[debsmita1]

@debsmita1 sure, we can remove the type for now.

The cases with invalid config should fall under 6. case, Marketplace installation feature is disabled, the log includes Error while loading installation data. Installation will be disabled. Error: ... and api endpoints return 500. Would it be more appropriate to throw an error and prevent plugin from starting up in case of invalid file format?

I checked what we currently do with our RBAC plugin that consumes a .csv file. Invalid content in that file doesn't stop the backend or the frontend from starting, but it does disable the Create role button. So, in our case, we can disable the Install button

For the case when file is not specified although installation is enabled, we can change the behavior as well to throw an error and prevent plugin from starting up.

From our last working group call, what I have understood is, if the file is not specified, then we disable the Install button. So, if you can return an appropriate status like ex: "DYNAMIC_PLUGINS_FILE_MISSING" or something like this, then we can handle this in the UI

@ShiranHi Could you help me with how we can show this in the UI so that we can guide the users on how to get rid of the error ?

[ShiranHi]

For the case when file is not specified although installation is enabled, we can change the behavior as well to throw an error and prevent plugin from starting up.

From our last working group call, what I have understood is, if the file is not specified, then we disable the Install button. So, if you can return an appropriate status like ex: "DYNAMIC_PLUGINS_FILE_MISSING" or something like this, then we can handle this in the UI

@ShiranHi Could you help me with how we can show this in the UI so that we can guide the users on how to get rid of the error ?

Yes, disabling the Install button on the configuration page would work, we can add a tooltip on hover to say "Plugin installation is disabled. Contact your administrator for assistance."

[debsmita1]

Thank you @dzemanov !
I am able to test all the scenarios

Could you resolve the Sonarqube cloud issues ?

Tagging @PatAKnight for API review

[dzemanov]

@debsmita1 sonarqube issues are fixed, thank you for pointing them out!

[AndrienkoAleksandr]

Tested, works fine. Reviewed, pr looks good to me. @dzemanov, Thank you for great code !

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.1% Duplication on New Code

See analysis details on SonarQube Cloud