feat(extensions): allow installing plugins based on access and env (#769)

* feat(extensions): allow installing plugins

* add RBAC configuration

* use the fetch API to get the plugin configuration

* updated UI to show error states

* add installation api

* disable plugin installation for production env

Author: debsmita1

workspaces/marketplace/.changeset/silver-steaks-pretend.md

@@ -0,0 +1,10 @@
+---
+'@red-hat-developer-hub/backstage-plugin-marketplace-backend': patch
+'@red-hat-developer-hub/backstage-plugin-marketplace-common': patch
+'@red-hat-developer-hub/marketplace-cli': patch
+'@red-hat-developer-hub/backstage-plugin-marketplace': minor
+---
+
+Added an alert for production environment
+Integrated the fetch configuration and install API calls
+Fixed an import error

workspaces/marketplace/app-config.yaml

@@ -9,9 +9,10 @@ backend:
   # Used for enabling authentication, secret is shared by all backend plugins
   # See https://backstage.io/docs/auth/service-to-service-auth for
   # information on the format
-  # auth:
-  #   keys:
-  #     - secret: ${BACKEND_SECRET}
+  auth:
+    dangerouslyDisableDefaultAuthPolicy: true
+    # keys:
+    #   - secret: ${BACKEND_SECRET}
   baseUrl: http://localhost:7007
   listen:
     port: 7007
@@ -67,6 +68,13 @@ auth:
   providers:
     # See https://backstage.io/docs/auth/guest/provider
     guest: {}
+    github:
+      development:
+        clientId: ${GITHUB_CLIENT_ID}
+        clientSecret: ${GITHUB_CLIENT_SECRET}
+        signIn:
+          resolvers:
+            - resolver: usernameMatchingUserEntityName
 
 scaffolder:
   # see https://backstage.io/docs/features/software-templates/configuration for software template options
@@ -88,7 +96,6 @@ catalog:
           Location,
         ]
   locations:
-    # Local example data, file locations are relative to the backend process, typically `packages/backend`
     - type: file
       target: ../../catalog-info.yaml
       rules:
@@ -124,3 +131,4 @@ extensions:
   #   enabled: true
   #   saveToSingleFile:
   #     file: ${EXTENSIONS_PLUGIN_CONFIG}
+dangerouslyAllowSignInWithoutUserInCatalog: true

workspaces/marketplace/packages/app/package.json

@@ -19,6 +19,7 @@
     "lint": "backstage-cli package lint"
   },
   "dependencies": {
+    "@backstage-community/plugin-rbac": "^1.40.1",
     "@backstage/app-defaults": "^1.5.17",
     "@backstage/catalog-model": "^1.7.3",
     "@backstage/cli": "^0.30.0",

workspaces/marketplace/packages/app/src/App.tsx

@@ -26,6 +26,8 @@ import {
   CatalogImportPage,
   catalogImportPlugin,
 } from '@backstage/plugin-catalog-import';
+import { RbacPage } from '@backstage-community/plugin-rbac';
+
 import { ScaffolderPage, scaffolderPlugin } from '@backstage/plugin-scaffolder';
 import { orgPlugin } from '@backstage/plugin-org';
 import { SearchPage } from '@backstage/plugin-search';
@@ -47,6 +49,7 @@ import { AppRouter, FlatRoutes } from '@backstage/core-app-api';
 import { CatalogGraphPage } from '@backstage/plugin-catalog-graph';
 import { RequirePermission } from '@backstage/plugin-permission-react';
 import { catalogEntityCreatePermission } from '@backstage/plugin-catalog-common/alpha';
+import { githubAuthApiRef } from '@backstage/core-plugin-api';
 
 import { getAllThemes } from '@red-hat-developer-hub/backstage-plugin-theme';
 
@@ -77,7 +80,21 @@ const app = createApp({
     });
   },
   components: {
-    SignInPage: props => <SignInPage {...props} auto providers={['guest']} />,
+    SignInPage: props => (
+      <SignInPage
+        {...props}
+        auto
+        providers={[
+          'guest',
+          {
+            id: 'github-auth-provider',
+            title: 'GitHub',
+            message: 'Sign in using GitHub',
+            apiRef: githubAuthApiRef,
+          },
+        ]}
+      />
+    ),
   },
   themes: getAllThemes(),
 });
@@ -101,6 +118,7 @@ const routes = (
         <ReportIssue />
       </TechDocsAddons>
     </Route>
+    <Route path="/rbac" element={<RbacPage />} />;
     <Route path="/create" element={<ScaffolderPage />} />
     <Route path="/api-docs" element={<ApiExplorerPage />} />
     <Route
@@ -116,7 +134,6 @@ const routes = (
     </Route>
     <Route path="/settings" element={<UserSettingsPage />} />
     <Route path="/catalog-graph" element={<CatalogGraphPage />} />
-
     <Route path="/extensions" element={<Marketplace />} />
   </FlatRoutes>
 );

workspaces/marketplace/packages/app/src/components/Root/Root.tsx

@@ -27,6 +27,8 @@ import {
   UserSettingsSignInAvatar,
 } from '@backstage/plugin-user-settings';
 import { SidebarSearchModal } from '@backstage/plugin-search';
+import { Administration } from '@backstage-community/plugin-rbac';
+
 import {
   Sidebar,
   sidebarConfig,
@@ -94,6 +96,7 @@ export const Root = ({ children }: PropsWithChildren<{}>) => (
         <SidebarItem icon={LibraryBooks} to="docs" text="Docs" />
         <SidebarItem icon={CreateComponentIcon} to="create" text="Create..." />
         <SidebarItem icon={MarketplaceIcon} to="extensions" text="Extensions" />
+        <Administration />
         {/* End global nav */}
         <SidebarDivider />
         <SidebarScrollWrapper>

workspaces/marketplace/packages/backend/package.json

@@ -21,6 +21,7 @@
     "build-image": "docker build ../.. -f Dockerfile --tag backstage"
   },
   "dependencies": {
+    "@backstage-community/plugin-rbac-backend": "6.0.0",
     "@backstage/backend-defaults": "^0.8.1",
     "@backstage/config": "^1.3.2",
     "@backstage/plugin-app-backend": "^0.4.5",

workspaces/marketplace/packages/backend/src/index.ts

@@ -25,6 +25,8 @@ backend.add(import('@backstage/plugin-techdocs-backend/alpha'));
 
 // auth plugin
 backend.add(import('@backstage/plugin-auth-backend'));
+backend.add(import('@backstage/plugin-auth-backend-module-github-provider'));
+
 // See https://backstage.io/docs/backend-system/building-backends/migrating#the-auth-plugin
 backend.add(import('@backstage/plugin-auth-backend-module-guest-provider'));
 // See https://backstage.io/docs/auth/guest/provider
@@ -39,11 +41,12 @@ backend.add(
 backend.add(import('@backstage/plugin-catalog-backend-module-logs'));
 
 // permission plugin
-backend.add(import('@backstage/plugin-permission-backend/alpha'));
-// See https://backstage.io/docs/permissions/getting-started for how to create your own permission policy
-backend.add(
-  import('@backstage/plugin-permission-backend-module-allow-all-policy'),
-);
+backend.add(import('@backstage-community/plugin-rbac-backend'));
+// backend.add(import('@backstage/plugin-permission-backend/alpha'));
+// // See https://backstage.io/docs/permissions/getting-started for how to create your own permission policy
+// backend.add(
+//   import('@backstage/plugin-permission-backend-module-allow-all-policy'),
+// );
 
 // search plugin
 backend.add(import('@backstage/plugin-search-backend/alpha'));

workspaces/marketplace/packages/cli/src/commands/export-csv/index.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import chalk from 'chalk';
-import { Entity } from '@backstage/catalog-model/index';
+import { Entity } from '@backstage/catalog-model';
 import {
   isMarketplacePackage,
   isMarketplacePlugin,

workspaces/marketplace/plugins/marketplace-backend/README.md

@@ -21,6 +21,19 @@ backend.add(
 );
 ```
 
+### Plugin Configurations
+
+Add the following extensions configuration in your `app-config.yaml` file:
+
+```yaml
+extensions:
+  ### Example for how to enable installation to a file.
+  installation:
+    enabled: true
+    saveToSingleFile:
+      file: <path-to>/dynamic-plugins.yaml
+```
+
 ## Development
 
 This plugin backend can be started in a standalone mode from directly in this

workspaces/marketplace/plugins/marketplace-backend/src/installation/FileInstallationStorage.test.ts

@@ -58,7 +58,7 @@ describe('FileInstallationStorage', () => {
 
       expect(() => {
         fileInstallationStorage.initialize();
-      }).toThrow(`Installation config file does not exist: ${configFileName}`);
+      }).toThrow(`The file ${configFileName} is missing`);
     });
 
     it('should throw on initialize when bad plugins format', async () => {