feat(extensions): update marketplace pluginId to extensions (#762)

* feat(extensions): update extension to extensions

* update marketplace pluginId to extensions

Author: debsmita1

workspaces/marketplace/.changeset/shaggy-rules-fix.md

@@ -0,0 +1,8 @@
+---
+'@red-hat-developer-hub/backstage-plugin-marketplace-backend': patch
+'@red-hat-developer-hub/backstage-plugin-marketplace-common': patch
+'@red-hat-developer-hub/backstage-plugin-marketplace': patch
+---
+
+updated `extension` to `extensions`
+update marketplace pluginId to extensions

workspaces/marketplace/plugins/catalog-backend-module-marketplace/src/module.ts

@@ -33,7 +33,7 @@ import { MarketplacePackageProvider } from './providers/MarketplacePackageProvid
  */
 export const catalogModuleMarketplace = createBackendModule({
   pluginId: 'catalog',
-  moduleId: 'marketplace',
+  moduleId: 'extensions',
   register(reg) {
     reg.registerInit({
       deps: {

workspaces/marketplace/plugins/marketplace-backend/package.json

@@ -16,7 +16,7 @@
   },
   "backstage": {
     "role": "backend-plugin",
-    "pluginId": "marketplace",
+    "pluginId": "extensions",
     "pluginPackages": [
       "@red-hat-developer-hub/backstage-plugin-marketplace",
       "@red-hat-developer-hub/backstage-plugin-marketplace-backend",
@@ -37,6 +37,7 @@
     "@backstage/backend-plugin-api": "^1.2.0",
     "@backstage/catalog-client": "^1.9.1",
     "@backstage/catalog-model": "^1.7.3",
+    "@backstage/errors": "^1.2.7",
     "@backstage/plugin-catalog-node": "^1.16.0",
     "@backstage/plugin-permission-common": "^0.8.4",
     "@backstage/plugin-permission-node": "^0.8.8",

workspaces/marketplace/plugins/marketplace-backend/src/permissions/rules.ts

@@ -21,7 +21,7 @@ import {
 import { z } from 'zod';
 import {
   MarketplacePlugin,
-  RESOURCE_TYPE_EXTENSION_PLUGIN,
+  RESOURCE_TYPE_EXTENSIONS_PLUGIN,
 } from '@red-hat-developer-hub/backstage-plugin-marketplace-common';
 
 export type ExtentionFilter = {
@@ -35,12 +35,12 @@ export type ExtentionFilters =
   | { not: ExtentionFilters }
   | ExtentionFilter;
 
-export const extensionPermissionResourceRef = createPermissionResourceRef<
+export const extensionsPermissionResourceRef = createPermissionResourceRef<
   MarketplacePlugin,
   ExtentionFilter
 >().with({
-  pluginId: 'marketplace',
-  resourceType: RESOURCE_TYPE_EXTENSION_PLUGIN,
+  pluginId: 'extensions',
+  resourceType: RESOURCE_TYPE_EXTENSIONS_PLUGIN,
 });
 
 export type ExtensionParams = {
@@ -52,18 +52,18 @@ export type ExtensionParams = {
 const hasPluginName = createPermissionRule({
   name: 'HAS_NAME',
   description: 'Should allow users to install the plugin with specified name',
-  resourceRef: extensionPermissionResourceRef,
+  resourceRef: extensionsPermissionResourceRef,
 
   paramsSchema: z.object({
     pluginNames: z
       .string()
       .array()
       .optional()
-      .describe('List of plugin names to match on'),
+      .describe('List of plugin names or titles to match on'),
   }),
   apply: (plugin: MarketplacePlugin, { pluginNames }) => {
     return pluginNames && pluginNames.length > 0
-      ? !!pluginNames?.find(
+      ? pluginNames?.some(
           name =>
             name.toLowerCase() === plugin.metadata.title?.toLowerCase() ||
             name.toLowerCase() === plugin.metadata.name.toLowerCase(),
@@ -77,7 +77,7 @@ const hasAnnotation = createPermissionRule({
   name: 'HAS_ANNOTATION',
   description:
     'Should allow users to install the plugin with specified annotation',
-  resourceRef: extensionPermissionResourceRef,
+  resourceRef: extensionsPermissionResourceRef,
   paramsSchema: z.object({
     annotation: z.string().describe('Name of the annotation to match on'),
     value: z

workspaces/marketplace/plugins/marketplace-backend/src/plugin.ts

@@ -33,7 +33,7 @@ import { createRouter } from './router';
  * @public
  */
 export const marketplacePlugin = createBackendPlugin({
-  pluginId: 'marketplace',
+  pluginId: 'extensions',
   register(env) {
     env.registerInit({
       deps: {

workspaces/marketplace/plugins/marketplace-backend/src/router.test.ts

@@ -68,7 +68,7 @@ const setupTest = () => {
       onUnhandledRequest: (req, print) => {
         if (
           req.url.pathname === '/' ||
-          req.url.pathname.startsWith('/api/marketplace')
+          req.url.pathname.startsWith('/api/extensions')
         ) {
           // bypass
           return;
@@ -142,7 +142,7 @@ describe('createRouter', () => {
       });
 
       const response = await request(backendServer).get(
-        '/api/marketplace/collections',
+        '/api/extensions/collections',
       );
 
       expect(response.status).toEqual(200);
@@ -159,7 +159,7 @@ describe('createRouter', () => {
       });
 
       const response = await request(backendServer).get(
-        '/api/marketplace/collection/default/featured-plugins',
+        '/api/extensions/collection/default/featured-plugins',
       );
 
       expect(response.status).toEqual(200);
@@ -175,7 +175,7 @@ describe('createRouter', () => {
       });
 
       const response = await request(backendServer).get(
-        '/api/marketplace/collection/default/not-found',
+        '/api/extensions/collection/default/not-found',
       );
 
       expect(response.status).toEqual(404);
@@ -214,7 +214,7 @@ describe('createRouter', () => {
       );
 
       const response = await request(backendServer).get(
-        '/api/marketplace/collection/default/featured-plugins/plugins',
+        '/api/extensions/collection/default/featured-plugins/plugins',
       );
 
       expect(response.status).toEqual(200);
@@ -237,7 +237,7 @@ describe('createRouter', () => {
       );
 
       const response = await request(backendServer).get(
-        '/api/marketplace/collection/default/featured-plugins/plugins',
+        '/api/extensions/collection/default/featured-plugins/plugins',
       );
 
       expect(response.status).toEqual(200);
@@ -252,7 +252,7 @@ describe('createRouter', () => {
       });
 
       const response = await request(backendServer).get(
-        '/api/marketplace/collection/default/not-found/plugins',
+        '/api/extensions/collection/default/not-found/plugins',
       );
 
       expect(response.status).toEqual(404);
@@ -288,7 +288,7 @@ describe('createRouter', () => {
       });
 
       const response = await request(backendServer).get(
-        '/api/marketplace/collections/facets?facet=spec.categories',
+        '/api/extensions/collections/facets?facet=spec.categories',
       );
 
       expect(response.status).toEqual(200);
@@ -315,7 +315,7 @@ describe('createRouter', () => {
         mockData: mockPlugins,
       });
       const response = await request(backendServer).get(
-        '/api/marketplace/plugins',
+        '/api/extensions/plugins',
       );
       expect(response.status).toEqual(200);
       expect(response.body.items).toHaveLength(2);
@@ -328,7 +328,7 @@ describe('createRouter', () => {
       });
 
       const response = await request(backendServer).get(
-        '/api/marketplace/plugin/default/plugin1',
+        '/api/extensions/plugin/default/plugin1',
       );
 
       expect(response.status).toEqual(200);
@@ -341,7 +341,7 @@ describe('createRouter', () => {
         name: 'invalid-plugin',
       });
       const response = await request(backendServer).get(
-        '/api/marketplace/plugin/default/invalid-plugin',
+        '/api/extensions/plugin/default/invalid-plugin',
       );
 
       expect(response.status).toEqual(404);

workspaces/marketplace/plugins/marketplace-backend/src/router.ts

@@ -16,7 +16,7 @@
 
 import express, { Request } from 'express';
 import Router from 'express-promise-router';
-
+import { NotAllowedError } from '@backstage/errors';
 import {
   HttpAuthService,
   PermissionsService,
@@ -31,12 +31,12 @@ import {
 import {
   decodeGetEntitiesRequest,
   decodeGetEntityFacetsRequest,
-  extensionPluginCreatePermission,
-  extensionPluginReadPermission,
+  extensionsPluginWritePermission,
+  extensionsPluginReadPermission,
   MarketplaceApi,
   MarketplacePlugin,
-  RESOURCE_TYPE_EXTENSION_PLUGIN,
-  extensionPermissions,
+  RESOURCE_TYPE_EXTENSIONS_PLUGIN,
+  extensionsPermissions,
 } from '@red-hat-developer-hub/backstage-plugin-marketplace-common';
 import { createPermissionIntegrationRouter } from '@backstage/plugin-permission-node';
 import { createSearchParams } from './utils/createSearchParams';
@@ -55,8 +55,8 @@ export async function createRouter({
 }): Promise<express.Router> {
   const router = Router();
   const permissionsIntegrationRouter = createPermissionIntegrationRouter({
-    resourceType: RESOURCE_TYPE_EXTENSION_PLUGIN,
-    permissions: extensionPermissions,
+    resourceType: RESOURCE_TYPE_EXTENSIONS_PLUGIN,
+    permissions: extensionsPermissions,
     rules: Object.values(extensionRules),
   });
   router.use(express.json());
@@ -65,7 +65,7 @@ export async function createRouter({
   const authorizeConditional = async (
     request: Request,
     permission:
-      | ResourcePermission<'extension-plugin' | 'extension-package'>
+      | ResourcePermission<'extensions-plugin' | 'extensions-package'>
       | BasicPermission,
   ) => {
     const credentials = await httpAuth.credentials(request);
@@ -163,18 +163,18 @@ export async function createRouter({
     '/plugin/:namespace/:name/configuration/authorize',
     async (req, res) => {
       const [readDecision, installDecision] = await Promise.all([
-        authorizeConditional(req, extensionPluginReadPermission),
-        authorizeConditional(req, extensionPluginCreatePermission),
+        authorizeConditional(req, extensionsPluginReadPermission),
+        authorizeConditional(req, extensionsPluginWritePermission),
       ]);
       if (
         readDecision.result === AuthorizeResult.DENY &&
         installDecision.result === AuthorizeResult.DENY
       ) {
-        res.status(403);
+        res.status(200).json({ read: 'DENY', write: 'DENY' });
         return;
       }
 
-      const authorizedActions: string[] = [];
+      let authorizedActions = {};
       let plugin: MarketplacePlugin;
 
       const evaluateConditional = async (
@@ -189,34 +189,35 @@ export async function createRouter({
             );
           }
           if (matches(plugin, decision.conditions)) {
-            authorizedActions.push(action);
+            authorizedActions = { ...authorizedActions, [action]: 'ALLOW' };
           }
         } else if (decision.result === AuthorizeResult.ALLOW) {
-          authorizedActions.push(action);
+          authorizedActions = { ...authorizedActions, [action]: 'ALLOW' };
         }
       };
 
       await Promise.all([
         evaluateConditional(readDecision, 'read'),
-        evaluateConditional(installDecision, 'create'),
+        evaluateConditional(installDecision, 'write'),
       ]);
 
-      if (authorizedActions.length === 0) {
-        res.status(403);
-        return;
+      if (Object.keys(authorizedActions).length === 0) {
+        res.status(200).json({ read: 'DENY', write: 'DENY' });
+      } else {
+        res.status(200).json(authorizedActions);
       }
-      res.status(200).json({ authorizedActions });
     },
   );
 
   router.get('/plugin/:namespace/:name/configuration', async (req, res) => {
     const readDecision = await authorizeConditional(
       req,
-      extensionPluginReadPermission,
+      extensionsPluginReadPermission,
     );
     if (readDecision.result === AuthorizeResult.DENY) {
-      res.status(403).json({ error: 'Forbidden' });
-      return;
+      throw new NotAllowedError(
+        `Not allowed to read the configuration of ${req.params.namespace}:${req.params.name}`,
+      );
     }
 
     const plugin = await marketplaceApi.getPluginByName(
@@ -229,8 +230,9 @@ export async function createRouter({
       (readDecision.result === AuthorizeResult.CONDITIONAL &&
         matches(plugin, readDecision.conditions));
     if (!hasReadAccess) {
-      res.status(403).json({ error: 'Forbidden' });
-      return;
+      throw new NotAllowedError(
+        `Not allowed to read the configuration of ${req.params.namespace}:${req.params.name}`,
+      );
     }
 
     res.status(200).json({}); // This should return the configuration in YAML string
@@ -240,11 +242,12 @@ export async function createRouter({
     // installs the plugin
     const installDecision = await authorizeConditional(
       req,
-      extensionPluginCreatePermission,
+      extensionsPluginWritePermission,
     );
     if (installDecision.result === AuthorizeResult.DENY) {
-      res.status(403).json({ error: 'Forbidden' });
-      return;
+      throw new NotAllowedError(
+        `Not allowed to configure ${req.params.namespace}:${req.params.name}`,
+      );
     }
 
     const plugin = await marketplaceApi.getPluginByName(
@@ -258,8 +261,9 @@ export async function createRouter({
         matches(plugin, installDecision.conditions));
 
     if (!hasInstallAccess) {
-      res.status(403).json({ error: 'Forbidden' });
-      return;
+      throw new NotAllowedError(
+        `Not allowed to configure ${req.params.namespace}:${req.params.name}`,
+      );
     }
 
     res.status(200).json({});

workspaces/marketplace/plugins/marketplace-common/package.json

@@ -18,7 +18,7 @@
   },
   "backstage": {
     "role": "common-library",
-    "pluginId": "marketplace",
+    "pluginId": "extensions",
     "pluginPackages": [
       "@red-hat-developer-hub/backstage-plugin-marketplace",
       "@red-hat-developer-hub/backstage-plugin-marketplace-backend",