From 9b413ff13bd7b258b1ffafd896dd5a60719048f0 Mon Sep 17 00:00:00 2001 From: Aaron Boyle Date: Wed, 7 May 2025 13:57:15 +0100 Subject: [PATCH 01/19] rebase branch with the addition of workflow file --- .github/workflows/build-from-test.yml | 205 ++++++++++++++++++++++++++ 1 file changed, 205 insertions(+) create mode 100644 .github/workflows/build-from-test.yml diff --git a/.github/workflows/build-from-test.yml b/.github/workflows/build-from-test.yml new file mode 100644 index 000000000..97d3c522d --- /dev/null +++ b/.github/workflows/build-from-test.yml @@ -0,0 +1,205 @@ +name: Check and Build QA + +on: + push: + branches: + - test + workflow_dispatch: + +permissions: + contents: write + pull-requests: write + packages: write + +jobs: + check-build: + if: contains(fromJson('["test"]'), github.ref_name) + environment: ${{ matrix.network }} + strategy: + fail-fast: false + matrix: + include: + - branch: test + network: qa-govtool + workdir: ./govtool/backend + name: govtool-backend + dockerfile: ./govtool/backend/Dockerfile.qovery + image: ghcr.io/${{ github.repository }}-backend + qovery_container_name: govtool-backend + - branch: test + network: qa-govtool + workdir: ./govtool/frontend + name: govtool-frontend + dockerfile: ./govtool/frontend/Dockerfile.qovery + image: ghcr.io/${{ github.repository }}-frontend + qovery_container_name: govtool-frontend + - branch: test + network: qa-govtool + workdir: ./govtool/metadata-validation + name: govtool-metadata-validation + dockerfile: ./govtool/metadata-validation/Dockerfile + image: ghcr.io/${{ github.repository }}-metadata-validation + qovery_container_name: govtool-metadata-validation + + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v3 + + - name: Ensure Job Runs Only for Matching Branch + if: github.ref_name != matrix.branch + run: | + echo "Branch mismatch, exiting..." + exit 0 + + - name: Set TAG Environment Variable + id: set_tag + run: | + SANITIZED_BRANCH=$(echo "${{ github.ref_name }}" | tr '/' '-') + echo "COMMIT_TAG=${SANITIZED_BRANCH}-${{ github.sha }}-${{ github.run_number }}" >> $GITHUB_ENV + echo "STATIC_TAG=qa-latest" >> $GITHUB_ENV + echo "Generated TAG: $COMMIT_TAG" + echo "Generated STATIC_TAG: $STATIC_TAG" + + + - name: Lint Dockerfile + id: hadolint + uses: hadolint/hadolint-action@v3.1.0 + with: + failure-threshold: error + format: json + dockerfile: ${{ matrix.dockerfile }} + # output-file: hadolint_output.json + + - name: Save Hadolint output + id: save_hadolint_output + if: always() + run: cd ${{ matrix.workdir }} && echo "$HADOLINT_RESULTS" | jq '.' > hadolint_output.json + + - name: Print Dockerfile lint output + run: | + cd ${{ matrix.workdir }} + echo "-----HADOLINT RESULT-----" + echo "Outcome: ${{ steps.hadolint.outcome }}" + echo "-----DETAILS--------" + cat hadolint_output.json + echo "--------------------" + + - name: Code lint + id: code_lint + run: | + cd ${{ matrix.workdir }} + if [ ! -f lint.sh ]; then + echo "lint skipped" | tee code_lint_output.txt + exit 0 + fi + set -o pipefail + sudo chmod +x lint.sh && ./lint.sh 2>&1 | tee code_lint_output.txt + + - name: Unit tests + id: unit_tests + run: | + cd ${{ matrix.workdir }} + if [ ! -f unit-test.sh ]; then + echo "unit tests skipped" | tee code_lint_output.txt + exit 0 + fi + set -o pipefail + sudo chmod +x unit-test.sh && ./unit-test.sh 2>&1 | tee unit_test_output.txt + + - name: Set up Docker Buildx + uses: docker/setup-buildx-action@v2 + + - name: Cache Docker layers + uses: actions/cache@v3 + with: + path: /tmp/.buildx-cache + key: ${{ runner.os }}-buildx-${{ github.sha }}-${{ github.run_number}} + restore-keys: | + ${{ runner.os }}-buildx- + + - id: image_lowercase + uses: ASzc/change-string-case-action@v6 + with: + string: ${{ matrix.image }} + + - name: Set ENVIRONMENT Variable + run: echo "ENVIRONMENT=${{ matrix.network }}" >> $GITHUB_ENV + + - name: Sanitize Network Name + run: | + CLEAN_NETWORK=$(echo "${{ matrix.network }}" | sed 's/-govtool$//') + echo "CLEAN_NETWORK=$CLEAN_NETWORK" >> $GITHUB_ENV + + - name: Build Docker image + uses: docker/build-push-action@v5 + with: + context: ${{ matrix.workdir }} + file: ${{ matrix.dockerfile }} + tags: > + ${{ steps.image_lowercase.outputs.lowercase }}-${{ env.CLEAN_NETWORK }}:${{ env.COMMIT_TAG }}, + ${{ steps.image_lowercase.outputs.lowercase }}-${{ env.CLEAN_NETWORK }}:${{ env.STATIC_TAG }} + load: false + cache-from: type=local,src=/tmp/.buildx-cache + cache-to: type=local,dest=/tmp/.buildx-cache + outputs: type=docker,dest=/tmp/image-${{ matrix.name }}-${{ env.ENVIRONMENT }}.tar + build-args: | + VITE_APP_ENV=${{ secrets.VITE_APP_ENV }} + VITE_BASE_URL=${{ secrets.VITE_BASE_URL }} + VITE_METADATA_API_URL=${{ secrets.VITE_METADATA_API_URL }} + VITE_GTM_ID=${{ secrets.VITE_GTM_ID }} + VITE_NETWORK_FLAG=${{ secrets.VITE_NETWORK_FLAG }} + VITE_SENTRY_DSN=${{ secrets.VITE_SENTRY_DSN }} + NPMRC_TOKEN=${{ secrets.NPMRC_TOKEN }} + VITE_USERSNAP_SPACE_API_KEY=${{ secrets.VITE_USERSNAP_SPACE_API_KEY }} + VITE_IS_PROPOSAL_DISCUSSION_FORUM_ENABLED=${{ secrets.VITE_IS_PROPOSAL_DISCUSSION_FORUM_ENABLED }} + VITE_IS_GOVERNANCE_OUTCOMES_PILLAR_ENABLED=${{ secrets.VITE_IS_GOVERNANCE_OUTCOMES_PILLAR_ENABLED }} + VITE_OUTCOMES_API_URL=${{secrets.VITE_OUTCOMES_API_URL}} + VITE_PDF_API_URL=${{ secrets.VITE_PDF_API_URL }} + VITE_IPFS_GATEWAY=${{ secrets.IPFS_GATEWAY }} + VITE_IPFS_PROJECT_ID=${{ secrets.IPFS_PROJECT_ID }} + IPFS_GATEWAY=${{ secrets.IPFS_GATEWAY }} + IPFS_PROJECT_ID=${{ secrets.IPFS_PROJECT_ID }} + + - name: Login to GHCR + uses: docker/login-action@v2 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Scan Docker image with Dockle + id: dockle + run: | + wget -q https://github.com/goodwithtech/dockle/releases/download/v0.4.14/dockle_0.4.14_Linux-64bit.tar.gz + tar zxf dockle_0.4.14_Linux-64bit.tar.gz + sudo mv dockle /usr/local/bin + + dockle --exit-code 1 --exit-level fatal --format json -ak GHC_RELEASE_KEY -ak CABAL_INSTALL_RELEASE_KEY -ak STACK_RELEASE_KEY -ak KEY_SHA512 --input '/tmp/image-${{ matrix.name }}-${{ env.ENVIRONMENT }}.tar' --output ${{ matrix.workdir }}/dockle_scan_output.json + echo " dockle exited w/ $?" + cat ${{ matrix.workdir }}/dockle_scan_output.json + + echo "outcome=success" >> $GITHUB_OUTPUT + + - name: Debug TAG Before Docker Push + run: | + echo "Lowercase Image: ${{ steps.image_lowercase.outputs.lowercase }}" + echo "Network: ${{ matrix.network }}" + echo "COMMIT_TAG: ${{ env.COMMIT_TAG }}" + echo "STATIC_TAG: ${{ env.STATIC_TAG }}" + echo "Final Docker Tag: ${{ steps.image_lowercase.outputs.lowercase }}-${{ matrix.network}}:${{ env.TAG }}" + + - name: Push Docker image to GHCR + run: | + docker load -i '/tmp/image-${{ matrix.name }}-${{ env.ENVIRONMENT }}.tar' + rm -rf '/tmp/image-${{ matrix.name }}-${{ env.ENVIRONMENT }}.tar' + docker push ${{ steps.image_lowercase.outputs.lowercase }}-${{ env.CLEAN_NETWORK}}:${{ env.COMMIT_TAG }} + docker push ${{ steps.image_lowercase.outputs.lowercase }}-${{ env.CLEAN_NETWORK}}:${{ env.STATIC_TAG }} + + - name: Add tag as a PR comment + uses: ubie-oss/comment-to-merged-pr-action@v0.3.3 + id: comment-to-merged-pr + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + message: |- + This PR is in the tag: ${{ env.COMMIT_TAG }} , for ${{ matrix.name }} service From fbd17ac29a552122d8fee839d1c38f6c446e7038 Mon Sep 17 00:00:00 2001 From: Aaron Boyle Date: Thu, 8 May 2025 00:00:14 +0100 Subject: [PATCH 02/19] adds step sending request to qovery endpoint to trigger container deployment --- .github/workflows/build-from-test.yml | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/.github/workflows/build-from-test.yml b/.github/workflows/build-from-test.yml index 97d3c522d..3a04a3430 100644 --- a/.github/workflows/build-from-test.yml +++ b/.github/workflows/build-from-test.yml @@ -196,6 +196,16 @@ jobs: docker push ${{ steps.image_lowercase.outputs.lowercase }}-${{ env.CLEAN_NETWORK}}:${{ env.COMMIT_TAG }} docker push ${{ steps.image_lowercase.outputs.lowercase }}-${{ env.CLEAN_NETWORK}}:${{ env.STATIC_TAG }} + - name: Notify Qovery of new image tag + run: | + curl -X POST https://api.qovery.com/organization/${{ secrets.QOVERY_ORG_ID }}/container/deploy \ + -H "Authorization: Token ${{ secrets.QOVERY_API_TOKEN }}" \ + -H "Content-Type: application/json" \ + -d '{ + "image_name": "${{ steps.image_lowercase.outputs.lowercase }}-${{ env.CLEAN_NETWORK }}", + "tag": "${{ env.COMMIT_TAG }}" + }' + - name: Add tag as a PR comment uses: ubie-oss/comment-to-merged-pr-action@v0.3.3 id: comment-to-merged-pr From 7cbdf128ed12ef0a461d2acd3d18cbc9bbef4f55 Mon Sep 17 00:00:00 2001 From: Aaron Boyle Date: Thu, 8 May 2025 11:32:50 +0100 Subject: [PATCH 03/19] removes unnecessary env vars and updated api versions --- .github/workflows/build-from-test.yml | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/.github/workflows/build-from-test.yml b/.github/workflows/build-from-test.yml index 3a04a3430..583c9831d 100644 --- a/.github/workflows/build-from-test.yml +++ b/.github/workflows/build-from-test.yml @@ -44,7 +44,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout code - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Ensure Job Runs Only for Matching Branch if: github.ref_name != matrix.branch @@ -111,7 +111,7 @@ jobs: uses: docker/setup-buildx-action@v2 - name: Cache Docker layers - uses: actions/cache@v3 + uses: actions/cache@v4 with: path: /tmp/.buildx-cache key: ${{ runner.os }}-buildx-${{ github.sha }}-${{ github.run_number}} @@ -147,10 +147,8 @@ jobs: VITE_APP_ENV=${{ secrets.VITE_APP_ENV }} VITE_BASE_URL=${{ secrets.VITE_BASE_URL }} VITE_METADATA_API_URL=${{ secrets.VITE_METADATA_API_URL }} - VITE_GTM_ID=${{ secrets.VITE_GTM_ID }} VITE_NETWORK_FLAG=${{ secrets.VITE_NETWORK_FLAG }} VITE_SENTRY_DSN=${{ secrets.VITE_SENTRY_DSN }} - NPMRC_TOKEN=${{ secrets.NPMRC_TOKEN }} VITE_USERSNAP_SPACE_API_KEY=${{ secrets.VITE_USERSNAP_SPACE_API_KEY }} VITE_IS_PROPOSAL_DISCUSSION_FORUM_ENABLED=${{ secrets.VITE_IS_PROPOSAL_DISCUSSION_FORUM_ENABLED }} VITE_IS_GOVERNANCE_OUTCOMES_PILLAR_ENABLED=${{ secrets.VITE_IS_GOVERNANCE_OUTCOMES_PILLAR_ENABLED }} From 5c7d5c7921e00666ad7edc7b956b1f63a79a1480 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 11 Jun 2025 08:11:10 +0000 Subject: [PATCH 04/19] chore: update @intersect.mbo/pdf-ui to 1.0.0-beta --- govtool/frontend/package-lock.json | 8 ++++---- govtool/frontend/package.json | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/govtool/frontend/package-lock.json b/govtool/frontend/package-lock.json index 1adcee40a..9f63708b8 100644 --- a/govtool/frontend/package-lock.json +++ b/govtool/frontend/package-lock.json @@ -15,7 +15,7 @@ "@hookform/resolvers": "^3.3.1", "@intersect.mbo/govtool-outcomes-pillar-ui": "v1.4.3", "@intersect.mbo/intersectmbo.org-icons-set": "^1.0.8", - "@intersect.mbo/pdf-ui": "0.7.0-beta-36", + "@intersect.mbo/pdf-ui": "1.0.0-beta", "@mui/icons-material": "^5.14.3", "@mui/material": "^5.14.4", "@rollup/plugin-babel": "^6.0.4", @@ -3424,9 +3424,9 @@ "license": "ISC" }, "node_modules/@intersect.mbo/pdf-ui": { - "version": "0.7.0-beta-36", - "resolved": "https://registry.npmjs.org/@intersect.mbo/pdf-ui/-/pdf-ui-0.7.0-beta-36.tgz", - "integrity": "sha512-CncItia1kW42+IIWeFh+Mftwd09tull2vADGFDUwjLQGHzMNWNxiKQ4krlSqGSCJT9436XL6k6+OtdiMe06SpQ==", + "version": "1.0.0-beta", + "resolved": "https://registry.npmjs.org/@intersect.mbo/pdf-ui/-/pdf-ui-1.0.0-beta.tgz", + "integrity": "sha512-DeBW8uBtFfDE9bw8d9tGiRTu8M5CsX34PNHMqwReQFS463sLwkY7buqtC3FsaGFgRC4cuzAHvJF17kyc+WsiVQ==", "dependencies": { "@emurgo/cardano-serialization-lib-asmjs": "^12.0.0-beta.2", "@fontsource/poppins": "^5.0.14", diff --git a/govtool/frontend/package.json b/govtool/frontend/package.json index bb32c2bc8..0e52136ce 100644 --- a/govtool/frontend/package.json +++ b/govtool/frontend/package.json @@ -29,7 +29,7 @@ "@hookform/resolvers": "^3.3.1", "@intersect.mbo/govtool-outcomes-pillar-ui": "v1.4.3", "@intersect.mbo/intersectmbo.org-icons-set": "^1.0.8", - "@intersect.mbo/pdf-ui": "0.7.0-beta-36", + "@intersect.mbo/pdf-ui": "1.0.0-beta", "@mui/icons-material": "^5.14.3", "@mui/material": "^5.14.4", "@rollup/plugin-babel": "^6.0.4", From 4e6ceef20a057261518d6b56d6b0996cf3027df0 Mon Sep 17 00:00:00 2001 From: Ciabas Date: Wed, 11 Jun 2025 09:54:46 +0200 Subject: [PATCH 05/19] fix-storybook --- .../frontend/src/components/atoms/Link.tsx | 49 +++++++++++++++++-- .../src/components/organisms/TopNav.tsx | 32 ++++++------ .../frontend/src/stories/TopNav.stories.ts | 32 ++++++++++-- 3 files changed, 86 insertions(+), 27 deletions(-) diff --git a/govtool/frontend/src/components/atoms/Link.tsx b/govtool/frontend/src/components/atoms/Link.tsx index 14b6862c4..c56e61f60 100644 --- a/govtool/frontend/src/components/atoms/Link.tsx +++ b/govtool/frontend/src/components/atoms/Link.tsx @@ -3,12 +3,17 @@ import { NavLink } from "react-router-dom"; import { Typography } from "@mui/material"; import { useCardano } from "@context"; +const FONT_SIZE = { + small: 14, + big: 22, +}; + type LinkProps = { dataTestId?: string; isConnectWallet?: boolean; label: React.ReactNode; navTo: string; - onClick?: (event: MouseEvent) => void; + onClick?: (event: MouseEvent) => void; size?: "small" | "big"; }; @@ -24,10 +29,7 @@ export const Link = forwardRef( } = props; const { disconnectWallet } = useCardano(); - const fontSize = { - small: 14, - big: 22, - }[size]; + const fontSize = FONT_SIZE[size]; return ( ( ); }, ); + +// This component is used as a placeholder for links that do not navigate anywhere, +// but with the same styling as the Link component. +export const FakeLink = forwardRef>( + (props, ref) => { + const { + dataTestId, + isConnectWallet, + label, + size = "small", + onClick, + } = props; + const { disconnectWallet } = useCardano(); + + const fontSize = FONT_SIZE[size]; + + return ( + { + e.preventDefault(); + if (!isConnectWallet) disconnectWallet(); + if (onClick) onClick(e); + }} + ref={ref} + sx={{ + cursor: "pointer", + fontSize, + fontWeight: 500, + color: "textBlack", + }} + > + {label} + + ); + }, +); diff --git a/govtool/frontend/src/components/organisms/TopNav.tsx b/govtool/frontend/src/components/organisms/TopNav.tsx index 2d3190884..533fe60d7 100644 --- a/govtool/frontend/src/components/organisms/TopNav.tsx +++ b/govtool/frontend/src/components/organisms/TopNav.tsx @@ -2,7 +2,7 @@ import { useEffect, useRef, useState, FC } from "react"; import { NavLink, useNavigate } from "react-router-dom"; import { AppBar, Box, Grid, IconButton, Menu, MenuItem } from "@mui/material"; import MenuIcon from "@mui/icons-material/Menu"; -import { Button, Link } from "@atoms"; +import { Button, Link, FakeLink } from "@atoms"; import { ICONS, IMAGES, PATHS, NAV_ITEMS, NavMenuItem } from "@consts"; import { useCardano, useFeatureFlag, useModal } from "@context"; import { useScreenDimension, useTranslation } from "@hooks"; @@ -48,6 +48,10 @@ export const TopNav = ({ isConnectButton = true }) => { openModal({ type: "chooseWallet" }); }; + const closeDrawer = () => { + setIsDrawerOpen(false); + }; + const renderDesktopNav = () => (