Introduce integrity (#1191)

Signed-off-by: Dominika Zemanovicova <dzemanov@redhat.com>

Author: dzemanov

workspaces/marketplace/.changeset/two-foxes-run.md

@@ -0,0 +1,7 @@
+---
+'@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
+---
+
+Introduce `spec.integrity` field for Marketplace package

workspaces/marketplace/examples/packages/backstage-community-plugin-quay.yaml

@@ -17,7 +17,8 @@ metadata:
   tags: []
 spec:
   packageName: '@backstage-community/plugin-quay'
-  dynamicArtifact: ./dynamic-plugins/dist/backstage-community-plugin-quay
+  dynamicArtifact: '@backstage-community/plugin-quay'
+  integrity: sha512-qaZgy2lV28qlwsNnympCUbkewYCqXxLmXQXr3WWpS7gREWj4YBpytU/hQnDnqxAnQ+dQB/9U/rPdGJnLLAOB3w==
   version: 1.18.1
   backstage:
     role: frontend-plugin

workspaces/marketplace/json-schema/packages.json

@@ -93,6 +93,9 @@
         "dynamicArtifact": {
           "type": "string"
         },
+        "integrity": {
+          "type": "string"
+        },
         "version": {
           "type": "string"
         },

workspaces/marketplace/plugins/marketplace-backend/src/validation/configValidation.test.ts

@@ -32,6 +32,7 @@ describe('validateConfigurationFormat', () => {
         - package: package1
         - package: package2
           disabled: false
+          integrity: dummyabcd
           pluginConfig:
             key: value
     `);
@@ -104,6 +105,15 @@ describe('validatePackageFormat', () => {
       `,
       error: "optional 'disabled' field in package item must be a boolean",
     },
+    {
+      testCase: "'integrity' is not a string",
+      yaml: `
+        package: package1
+        integrity: []
+      `,
+      error:
+        "optional 'integrity' field in package item must be a non-empty string",
+    },
     {
       testCase: "'pluginConfig' is not a map",
       yaml: `

workspaces/marketplace/plugins/marketplace-backend/src/validation/configValidation.ts

@@ -73,6 +73,13 @@ export function validatePackageFormat(
     );
   }
 
+  const integrity = item.get('integrity');
+  if (integrity && (typeof integrity !== 'string' || integrity.trim() === '')) {
+    throw new ConfigFormatError(
+      "Invalid installation configuration, optional 'integrity' field in package item must be a non-empty string",
+    );
+  }
+
   if (packageName && packageToValidate !== packageName) {
     throw new ConfigFormatError(
       `Invalid installation configuration, 'package' field value in package item differs from '${packageName}'`,

workspaces/marketplace/plugins/marketplace-common/report.api.md

@@ -382,6 +382,8 @@ export interface MarketplacePackageSpec extends JsonObject {
     // (undocumented)
     installStatus?: MarketplacePackageInstallStatus;
     // (undocumented)
+    integrity?: string;
+    // (undocumented)
     lifecycle?: string;
     // (undocumented)
     owner?: string;

workspaces/marketplace/plugins/marketplace-common/src/types/MarketplacePackage.ts

@@ -58,6 +58,7 @@ export interface MarketplacePackageSpec extends JsonObject {
   appConfigExamples?: MarketplacePackageSpecAppConfigExample[];
   owner?: string;
   partOf?: string[];
+  integrity?: string;
   installStatus?: MarketplacePackageInstallStatus;
 }
 

workspaces/marketplace/plugins/marketplace/src/components/MarketplacePluginInstallContent.tsx

@@ -36,6 +36,7 @@ import { useNavigate } from 'react-router-dom';
 
 import {
   MarketplacePackage,
+  MarketplacePackageSpec,
   MarketplacePackageSpecAppConfigExample,
   MarketplacePlugin,
   MarketplacePluginInstallStatus,
@@ -274,10 +275,16 @@ export const MarketplacePluginInstallContent = ({
       codeEditor.setValue(configYaml);
     } else {
       const dynamicPluginYaml = {
-        plugins: (packages ?? []).map(pkg => ({
-          package: pkg.spec?.dynamicArtifact ?? './dynamic-plugins/dist/....',
-          disabled: false,
-        })),
+        plugins: (packages ?? []).map(pkg => {
+          const pkgEntry: MarketplacePackageSpec = {
+            package: pkg.spec?.dynamicArtifact ?? './dynamic-plugins/dist/....',
+            disabled: false,
+          };
+          if (pkg.spec?.integrity) {
+            pkgEntry.integrity = pkg.spec.integrity;
+          }
+          return pkgEntry;
+        }),
       };
       codeEditor.setValue(yaml.stringify(dynamicPluginYaml));
     }