Merged dspace-cris-2024_02_x into task/dspace-cris-2024_02_x/DSC-2281

Author: atarix83

.eslintrc.json

@@ -12,7 +12,6 @@
     "eslint-plugin-rxjs",
     "eslint-plugin-simple-import-sort",
     "eslint-plugin-import-newlines",
-    "eslint-plugin-jsonc",
     "dspace-angular-ts",
     "dspace-angular-html"
   ],
@@ -302,10 +301,13 @@
         "*.json5"
       ],
       "extends": [
-        "plugin:jsonc/recommended-with-jsonc"
+        "plugin:jsonc/recommended-with-json5"
       ],
       "rules": {
-        "no-irregular-whitespace": "error",
+        // The ESLint core no-irregular-whitespace rule doesn't work well in JSON
+        // See: https://ota-meshi.github.io/eslint-plugin-jsonc/rules/no-irregular-whitespace.html
+        "no-irregular-whitespace": "off",
+        "jsonc/no-irregular-whitespace": "error",
         "no-trailing-spaces": "error",
         "jsonc/comma-dangle": [
           "error",

.github/workflows/build.yml

@@ -29,6 +29,8 @@ jobs:
       DSPACE_CACHE_SERVERSIDE_ANONYMOUSCACHE_MAX: 0
       # Tell Cypress to run e2e tests using the same UI URL
       CYPRESS_BASE_URL: http://127.0.0.1:4000
+      # Disable the cookie consent banner in e2e tests to avoid errors because of elements hidden by it
+      DSPACE_INFO_ENABLECOOKIECONSENTPOPUP: false
       # When Chrome version is specified, we pin to a specific version of Chrome
       # Comment this out to use the latest release
       #CHROME_VERSION: "116.0.5845.187-1"
@@ -191,11 +193,107 @@ jobs:
       # If it does, then SSR is working, as this tag is created by our MetadataService.
       # This step also prints entire HTML of homepage for easier debugging if grep fails.
       # TODO: enable this step once we have a CRIS back end to test against
-      # - name: Verify SSR (server-side rendering)
-      #   run: |
-      #     result=$(wget -O- -q http://127.0.0.1:4000/home)
-      #     echo "$result"
-      #     echo "$result" | grep -oE "<meta name=\"title\" [^>]*>" | grep DSpace
+      # - name: Verify SSR (server-side rendering) on Homepage
+      #  run: |
+      #    result=$(wget -O- -q http://127.0.0.1:4000/home)
+      #    echo "$result"
+      #    echo "$result" | grep -oE "<meta name=\"title\" [^>]*>" | grep DSpace
+
+      # Get a specific community in our test data and verify that the "<h1>" tag includes "Publications" (the community name).
+      # If it does, then SSR is working.
+      - name: Verify SSR on a Community page
+        run: |
+          result=$(wget -O- -q http://127.0.0.1:4000/communities/a30b75e4-1682-4b4d-85fd-a47fc78dbcf6)
+          echo "$result"
+          echo "$result" | grep -oE "<h1 [^>]*>[^><]*</h1>" | grep "CRIS Community"
+
+      # Get a specific collection in our test data and verify that the "<h1>" tag includes "Publications" (the collection name).
+      # If it does, then SSR is working.
+      - name: Verify SSR on a Collection page
+        run: |
+          result=$(wget -O- -q http://127.0.0.1:4000/collections/caf04bfa-b2f6-40d3-90d2-aa0b86d92f8d)
+          echo "$result"
+          echo "$result" | grep -oE "<meta name=\"title\" [^>]*>" | grep "Publications"
+
+      # Get a specific publication in our test data and verify that the <meta name="title"> tag includes
+      # the title of this publication. If it does, then SSR is working.
+      - name: Verify SSR on a Publication page
+        run: |
+          result=$(wget -O- -q http://127.0.0.1:4000/entities/publication/1df533fd-5385-4820-babd-b5fabdb82101)
+          echo "$result"
+          echo "$result" | grep -oE "<meta name=\"title\" [^>]*>" | grep "test publication with pdf version 1"
+
+      # Get a specific person in our test data and verify that the <meta name="title"> tag includes
+      # the name of the person. If it does, then SSR is working.
+      - name: Verify SSR on a Person page
+        run: |
+          result=$(wget -O- -q http://127.0.0.1:4000/entities/person/98cea993-d448-4200-99d5-f6fab8967bf8)
+          echo "$result"
+          echo "$result" | grep -oE "<meta name=\"title\" [^>]*>" | grep "Submitter Dspace"
+
+      # Get a specific project in our test data and verify that the <meta name="title"> tag includes
+      # the name of the project. If it does, then SSR is working.
+      - name: Verify SSR on a Project page
+        run: |
+          result=$(wget -O- -q http://127.0.0.1:4000/entities/project/1e3451e4-60d7-46a8-962e-5b94b62c63ff)
+          echo "$result"
+          echo "$result" | grep -oE "<meta name=\"title\" [^>]*>" | grep "Test DSC-1819"
+
+      # Get a specific orgunit in our test data and verify that the <meta name="title"> tag includes
+      # the name of the orgunit. If it does, then SSR is working.
+      - name: Verify SSR on an OrgUnit page
+        run: |
+          result=$(wget -O- -q http://127.0.0.1:4000/entities/orgunit/6d4abaee-eedb-458d-a29b-35db82037dfa)
+          echo "$result"
+          echo "$result" | grep -oE "<meta name=\"title\" [^>]*>" | grep "4Science"
+
+      # Get a specific journal in our test data and verify that the <meta name="title"> tag includes
+      # the name of the journal. If it does, then SSR is working.
+      - name: Verify SSR on a Journal page
+        run: |
+          result=$(wget -O- -q http://127.0.0.1:4000/entities/journal/f05c4530-b1b8-4459-a048-ea1c60089a1e)
+          echo "$result"
+          echo "$result" | grep -oE "<meta name=\"title\" [^>]*>" | grep "Journal 4S"
+
+      # Get a specific funding in our test data and verify that the <meta name="title"> tag includes
+      # the name of the funding. If it does, then SSR is working.
+      - name: Verify SSR on a Funding page
+        run: |
+          result=$(wget -O- -q http://127.0.0.1:4000/entities/funding/640d35ba-6172-44c0-9e11-bf5da417cdc8)
+          echo "$result"
+          echo "$result" | grep -oE "<meta name=\"title\" [^>]*>" | grep "test funding"
+
+
+      # Verify 301 Handle redirect behavior
+      # Note: /handle/123456789/260 is the same test Publication used by our e2e tests
+      - name: Verify 301 redirect from '/handle' URLs
+        run: |
+          result=$(wget --server-response --quiet http://127.0.0.1:4000/handle/123456789/71 2>&1 | head -1 | awk '{print $2}')
+          echo "$result"
+          [[ "$result" -eq "301" ]]
+
+      # Verify 403 error code behavior
+      - name: Verify 403 error code from '/403'
+        run: |
+          result=$(wget --server-response --quiet http://127.0.0.1:4000/403 2>&1 | head -1 | awk '{print $2}')
+          echo "$result"
+          [[ "$result" -eq "403" ]]
+
+      # Verify 404 error code behavior
+      - name: Verify 404 error code from '/404' and on invalid pages
+        run: |
+          result=$(wget --server-response --quiet http://127.0.0.1:4000/404 2>&1 | head -1 | awk '{print $2}')
+          echo "$result"
+          result2=$(wget --server-response --quiet http://127.0.0.1:4000/invalidurl 2>&1 | head -1 | awk '{print $2}')
+          echo "$result2"
+          [[ "$result" -eq "404" && "$result2" -eq "404" ]]
+
+      # Verify 500 error code behavior
+      - name: Verify 500 error code from '/500'
+        run: |
+          result=$(wget --server-response --quiet http://127.0.0.1:4000/500 2>&1 | head -1 | awk '{print $2}')
+          echo "$result"
+          [[ "$result" -eq "500" ]]
 
       - name: Stop running app
         run: kill -9 $(lsof -t -i:4000)

.github/workflows/docker.yml

@@ -9,44 +9,66 @@ name: Docker images
 on:
   push:
     branches:
-      - main
-      - 'dspace-**'
+      - main-cris
+      - 'dspace-cris-*_02_x'
     tags:
-      - 'dspace-**'
+      - 'dspace-cris-**'
   pull_request:
 
 permissions:
   contents: read  # to fetch code (actions/checkout)
   packages: write # to write images to GitHub Container Registry (GHCR)
 
 jobs:
+
+  ####################################################
+  # Build/Push the '4science/dspace-cris-dependencies' image.
+  # This image is used by all other DSpace build jobs.
+  ####################################################
+  dspace-cris-angular-dependencies:
+    # Ensure this job never runs on forked repos. It's only executed for '4science/dspace'
+    if: github.repository == '4science/dspace-angular'
+    # Use the reusable-docker-build.yml script from DSpace/DSpace repo to build our Docker image
+    uses: 4science/DSpace/.github/workflows/reusable-docker-build.yml@dspace-cris-2024_02_x
+    with:
+      build_id: dspace-cris-angular-dependencies
+      image_name: 4science/dspace-cris-angular-dependencies
+      dockerfile_path: ./Dockerfile.dependencies
+    secrets:
+      DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+      DOCKER_ACCESS_TOKEN: ${{ secrets.DOCKER_ACCESS_TOKEN }}
+
+
   #############################################################
-  # Build/Push the 'dspace/dspace-angular' image
+  # Build/Push the '4science/dspace-cris-angular' image
   #############################################################
   dspace-angular:
     # Ensure this job never runs on forked repos. It's only executed for 'dspace/dspace-angular'
-    if: github.repository == 'dspace/dspace-angular'
+    if: github.repository == '4science/dspace-angular'
     # Use the reusable-docker-build.yml script from DSpace/DSpace repo to build our Docker image
-    uses: DSpace/DSpace/.github/workflows/reusable-docker-build.yml@main
+    uses: 4science/DSpace/.github/workflows/reusable-docker-build.yml@dspace-cris-2024_02_x
+    needs: dspace-cris-angular-dependencies
     with:
-      build_id: dspace-angular-dev
-      image_name: dspace/dspace-angular
+      build_id: dspace-cris-angular-dev
+      image_name: 4science/dspace-cris-angular
       dockerfile_path: ./Dockerfile
     secrets:
       DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
       DOCKER_ACCESS_TOKEN: ${{ secrets.DOCKER_ACCESS_TOKEN }}
 
   #############################################################
-  # Build/Push the 'dspace/dspace-angular' image ('-dist' tag)
+  # Build/Push the '4science/dspace-cris-angular' image ('-dist' tag)
   #############################################################
   dspace-angular-dist:
     # Ensure this job never runs on forked repos. It's only executed for 'dspace/dspace-angular'
-    if: github.repository == 'dspace/dspace-angular'
+    if: github.repository == '4science/dspace-angular'
     # Use the reusable-docker-build.yml script from DSpace/DSpace repo to build our Docker image
-    uses: DSpace/DSpace/.github/workflows/reusable-docker-build.yml@main
+    uses: 4science/DSpace/.github/workflows/reusable-docker-build.yml@dspace-cris-2024_02_x
+    # Must run after 'dspace-dependencies' job above
+    needs: dspace-cris-angular-dependencies
     with:
-      build_id: dspace-angular-dist
-      image_name: dspace/dspace-angular
+      build_id: dspace-cris-angular-dist
+      image_name: 4science/dspace-cris-angular
       dockerfile_path: ./Dockerfile.dist
       # As this is a "dist" image, its tags are all suffixed with "-dist". Otherwise, it uses the same
       # tagging logic as the primary 'dspace/dspace-angular' image above.

Dockerfile

@@ -1,20 +1,16 @@
 # This image will be published as dspace/dspace-angular
 # See https://github.com/DSpace/dspace-angular/tree/main/docker for usage details
 
-FROM docker.io/node:18-alpine
+ARG NODE_VERSION=22
+ARG DSPACE_VERSION=dspace-cris-2024_02_x
+ARG DOCKER_REGISTRY=docker.io
 
-# Ensure Python and other build tools are available
-# These are needed to install some node modules, especially on linux/arm64
-RUN apk add --update python3 make g++ && rm -rf /var/cache/apk/*
+FROM ${DOCKER_REGISTRY:-docker.io}/4science/dspace-cris-angular-dependencies:${DSPACE_VERSION:-dspace-cris-2024_02_x} AS dev
 
 WORKDIR /app
 ADD . /app/
 EXPOSE 4000
 
-# We run yarn install with an increased network timeout (5min) to avoid "ESOCKETTIMEDOUT" errors from hub.docker.com
-# See, for example https://github.com/yarnpkg/yarn/issues/5540
-RUN yarn install --network-timeout 300000
-
 # When running in dev mode, 4GB of memory is required to build & launch the app.
 # This default setting can be overridden as needed in your shell, via an env file or in docker-compose.
 # See Docker environment var precedence: https://docs.docker.com/compose/environment-variables/envvars-precedence/
@@ -25,4 +21,4 @@ ENV NODE_OPTIONS="--max_old_space_size=4096"
 # NOTE: At this time it is only possible to run Docker container in Production mode
 # if you have a public URL. See https://github.com/DSpace/dspace-angular/issues/1485
 ENV NODE_ENV=development
-CMD yarn serve --host 0.0.0.0
+CMD ["yarn", "serve", "--host", "0.0.0.0"]

Dockerfile.build

@@ -0,0 +1,17 @@
+FROM node:20-alpine AS runtime
+
+ENV NODE_ENV=production \
+NODE_OPTIONS="--max_old_space_size=4096"
+RUN apk add --update python3 make g++ && rm -rf /var/cache/apk/*
+RUN mkdir -p /app/source/config
+
+WORKDIR /app/source
+COPY dist/ ./dist
+RUN ln -s /data/config.prod.yml /app/source/config/config.prod.yml || true
+
+RUN adduser -D -h /home/dspace -s /bin/bash dspace
+RUN chown -R dspace:dspace /app/source/
+
+USER dspace
+
+CMD ["node", "dist/server/main"]

Dockerfile.dependencies

@@ -0,0 +1,18 @@
+# Test build:
+# docker build -f Dockerfile.dependencies -t 4science/dspace-cris-angular-dependencies:dspace-cris-2024_02_x .
+
+# Angular 17 + Node 22 optimized Dockerfile
+ARG NODE_VERSION=22
+ARG DSPACE_VERSION=dspace-cris-2024_02_x
+ARG DOCKER_REGISTRY=docker.io
+
+FROM docker.io/node:${NODE_VERSION-22}-alpine AS dependencies
+
+# Install build dependencies
+RUN apk add --no-cache python3 make g++
+
+WORKDIR /app
+
+# Install dependencies (use npm ci if you have package-lock.json)
+COPY package.json yarn.lock ./
+RUN yarn install --frozen-lockfile --network-timeout 300000

Dockerfile.dist

@@ -1,31 +1,41 @@
+# syntax=docker/dockerfile:1.7-labs
+
 # This image will be published as dspace/dspace-angular:$DSPACE_VERSION-dist
-# See https://github.com/DSpace/dspace-angular/tree/main/docker for usage details
+# See https://github.com/4science/dspace-angular/tree/main/docker for usage details
 
 # Test build:
-# docker build -f Dockerfile.dist -t dspace/dspace-angular:dspace-8_x-dist .
+# docker build -f Dockerfile.dist -t 4science/dspace-angular:dspace-cris-2024_02_x-dist .
+
+# Angular 17 + Node 22 optimized Dockerfile
+ARG NODE_VERSION=22
+ARG DSPACE_VERSION=dspace-cris-2024_02_x
+ARG DOCKER_REGISTRY=docker.io
 
-FROM docker.io/node:18-alpine AS build
+FROM ${DOCKER_REGISTRY:-docker.io}/4science/dspace-cris-angular-dependencies:${DSPACE_VERSION:-dspace-cris-2024_02_x} AS build
 
-# Ensure Python and other build tools are available
-# These are needed to install some node modules, especially on linux/arm64
-RUN apk add --update python3 make g++ && rm -rf /var/cache/apk/*
+COPY . /app/
 
 WORKDIR /app
-COPY package.json yarn.lock ./
-RUN yarn install --network-timeout 300000
 
-ADD . /app/
+# Build Angular app
 RUN yarn build:prod
+RUN yarn build:mirador
 
-FROM node:18-alpine
-RUN npm install --global pm2
+# ---- Production image ----
+FROM docker.io/node:${NODE_VERSION-22}-alpine AS prod
 
-COPY --chown=node:node --from=build /app/dist /app/dist
-COPY --chown=node:node config /app/config
-COPY --chown=node:node docker/dspace-ui.json /app/dspace-ui.json
+# Install pm2 globally and clean npm cache
+RUN npm install --global pm2 && npm cache clean --force
 
 WORKDIR /app
+
+# Only copy built files and config
+COPY --chown=node:node --from=build /app/dist /app/dist
+COPY --chown=node:node --from=build /app/config /app/config
+COPY --chown=node:node --from=build /app/docker/dspace-ui.json /app/dspace-ui.json
+
 USER node
 ENV NODE_ENV=production
 EXPOSE 4000
-CMD pm2-runtime start dspace-ui.json --json
+
+CMD ["pm2-runtime", "start", "dspace-ui.json", "--json"]