Merge pull request #2377 from IntersectMBO/feat/1616-support-ipfs-in-govtool

feat(#1616): add support for ipfs in metadata validation service

Author: MSzalowski

.github/workflows/build-and-deploy-beta.yml

@@ -60,6 +60,8 @@ jobs:
       USERSNAP_SPACE_API_KEY: ${{ secrets.USERSNAP_SPACE_API_KEY }}
       IS_PROPOSAL_DISCUSSION_FORUM_ENABLED: ${{ inputs.isProposalDiscussionForumEnabled == 'enabled' }}
       PDF_API_URL: ${{ secrets.PDF_API_URL}}
+      IPFS_GATEWAY: ${{ secrets.IPFS_GATEWAY }}
+      IPFS_PROJECT_ID: ${{ secrets.IPFS_PROJECT_ID }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v4

.github/workflows/build-and-deploy-dev.yml

@@ -60,6 +60,8 @@ jobs:
       USERSNAP_SPACE_API_KEY: ${{ secrets.USERSNAP_SPACE_API_KEY }}
       IS_PROPOSAL_DISCUSSION_FORUM_ENABLED: ${{ inputs.isProposalDiscussionForumEnabled == 'enabled' }}
       PDF_API_URL: ${{ secrets.PDF_API_URL }}
+      IPFS_GATEWAY: ${{ secrets.IPFS_GATEWAY }}
+      IPFS_PROJECT_ID: ${{ secrets.IPFS_PROJECT_ID }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v4

.github/workflows/build-and-deploy-staging.yml

@@ -63,6 +63,8 @@ jobs:
       USERSNAP_SPACE_API_KEY: ${{ secrets.USERSNAP_SPACE_API_KEY }}
       IS_PROPOSAL_DISCUSSION_FORUM_ENABLED: ${{github.event_name == 'push' && 'true' || inputs.isProposalDiscussionForumEnabled == 'enabled'}}
       PDF_API_URL: ${{ secrets.PDF_API_URL}}
+      IPFS_GATEWAY: ${{ secrets.IPFS_GATEWAY }}
+      IPFS_PROJECT_ID: ${{ secrets.IPFS_PROJECT_ID }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v4

.github/workflows/build-and-deploy-test.yml

@@ -63,6 +63,8 @@ jobs:
       USERSNAP_SPACE_API_KEY: ${{ secrets.USERSNAP_SPACE_API_KEY }}
       IS_PROPOSAL_DISCUSSION_FORUM_ENABLED: ${{github.event_name == 'push' && 'true' || inputs.isProposalDiscussionForumEnabled == 'enabled'}}
       PDF_API_URL: ${{ secrets.PDF_API_URL}}
+      IPFS_GATEWAY: ${{ secrets.IPFS_GATEWAY }}
+      IPFS_PROJECT_ID: ${{ secrets.IPFS_PROJECT_ID }}
     steps:
       - name: Checkout code
         uses: actions/checkout@v4

CHANGELOG.md

@@ -16,6 +16,7 @@ changes.
 - Add support for displaying Motion of No Confidence Governance Action [Issue 1597](https://github.com/IntersectMBO/govtool/issues/1597)
 - Add support for displaying Update committee/threshold Governance Action [Issue 1598](https://github.com/IntersectMBO/govtool/issues/1598)
 - Add support for displaying New Constitution and/or Guardrails Script Governance Action [Issue 1599](https://github.com/IntersectMBO/govtool/issues/1598)
+- Add support for ipfs in metadata validation service [Issue 1616](https://github.com/IntersectMBO/govtool/issues/1616)
 
 ### Fixed
 

govtool/metadata-validation/.env.example

@@ -1 +1,3 @@
-PORT=3000
+PORT=3000
+IPFS_GATEWAY=https://ipfs.some.gateway
+IPFS_PROJECT_ID=ipfsprojectid

govtool/metadata-validation/Dockerfile

@@ -1,5 +1,8 @@
 FROM node:lts-hydrogen
 
+ARG IPFS_GATEWAY
+ARG IPFS_PROJECT_ID
+
 WORKDIR /dist
 
 COPY package*.json ./

govtool/metadata-validation/docker-compose.yml

@@ -8,6 +8,8 @@ services:
     container_name: metadata-validation
     environment:
       - PORT=${PORT}
+      - IPFS_GATEWAY=${IPFS_GATEWAY}
+      - IPFS_PROJECT_ID=${IPFS_PROJECT_ID}
     ports:
       - ${PORT}:${PORT}
     volumes:

govtool/metadata-validation/src/app.service.ts

@@ -22,15 +22,30 @@ export class AppService {
     let metadata: Record<string, unknown>;
     let standard = paramStandard;
 
+    const isIPFS = url.startsWith('ipfs://');
+    if (isIPFS) {
+      url = `${process.env.IPFS_GATEWAY}/${url.slice(7)}`;
+    }
+
     try {
       const { data: rawData } = await firstValueFrom(
-        this.httpService.get(url).pipe(
-          finalize(() => Logger.log(`Fetching ${url} completed`)),
-          catchError((error) => {
-            Logger.error(error, JSON.stringify(error));
-            throw MetadataValidationStatus.URL_NOT_FOUND;
-          }),
-        ),
+        this.httpService
+          .get(url, {
+            headers: {
+              'Content-Type': 'application/json',
+              ...(isIPFS &&
+                process.env.IPFS_PROJECT_ID && {
+                  project_id: process.env.IPFS_PROJECT_ID,
+                }),
+            },
+          })
+          .pipe(
+            finalize(() => Logger.log(`Fetching ${url} completed`)),
+            catchError((error) => {
+              Logger.error(error, JSON.stringify(error));
+              throw MetadataValidationStatus.URL_NOT_FOUND;
+            }),
+          ),
       );
 
       let parsedData;

scripts/govtool/config/templates/docker-compose.yml.tpl

@@ -187,6 +187,8 @@ services:
     image: <REPO_URL>/metadata-validation:${METADATA_VALIDATION_TAG}
     environment:
       - PORT=3000
+      - IPFS_GATEWAY=${IPFS_GATEWAY}
+      - IPFS_PROJECT_ID=${IPFS_PROJECT_ID}
     logging: *logging
     restart: always
     healthcheck: