Merged dspace-cris-2023_02_x into task/dspace-cris-2023_02_x/DSC-1742

Author: atarix83

.github/workflows/build.yml

@@ -7,7 +7,8 @@ name: Build
 on: [push, pull_request]
 
 permissions:
-  contents: read  #  to fetch code (actions/checkout)
+  contents: read  # to fetch code (actions/checkout)
+  packages: read  # to fetch private images from GitHub Container Registry (GHCR)
 
 jobs:
   tests:
@@ -30,15 +31,18 @@ jobs:
       CYPRESS_BASE_URL: http://127.0.0.1:4000
       # 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"
+      #CHROME_VERSION: "116.0.5845.187-1"
       # Bump Node heap size (OOM in CI after upgrading to Angular 15)
       NODE_OPTIONS: '--max-old-space-size=4096'
       # Project name to use when running "docker compose" prior to e2e tests
       COMPOSE_PROJECT_NAME: 'ci'
+      # Docker Registry to use for Docker compose scripts below.
+      # We use GitHub's Container Registry to avoid aggressive rate limits at DockerHub.
+      DOCKER_REGISTRY: ghcr.io
     strategy:
       # Create a matrix of Node versions to test against (in parallel)
       matrix:
-        node-version: [16.x, 18.x]
+        node-version: [18.x, 20.x]
       # Do NOT exit immediately if one matrix job fails
       fail-fast: false
     # These are the actual CI steps to perform per job
@@ -108,6 +112,14 @@ jobs:
           path: 'coverage/dspace-angular/lcov.info'
           retention-days: 14
 
+      # Login to our Docker registry, so that we can access private Docker images using "docker compose" below.
+      - name: Login to ${{ env.DOCKER_REGISTRY }}
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.DOCKER_REGISTRY }}
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
       # Using "docker compose" start backend using CI configuration
       # and load assetstore from a cached copy
       - name: Start DSpace REST Backend via Docker (for e2e tests)
@@ -172,11 +184,12 @@ jobs:
       # Get homepage and verify that the <meta name="title"> tag includes "DSpace".
       # 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.
-      - 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
+      # 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: Stop running app
         run: kill -9 $(lsof -t -i:4000)

.github/workflows/docker.yml

@@ -16,7 +16,8 @@ on:
   pull_request:
 
 permissions:
-  contents: read  #  to fetch code (actions/checkout)
+  contents: read  # to fetch code (actions/checkout)
+  packages: write # to write images to GitHub Container Registry (GHCR)
 
 jobs:
   #############################################################

Dockerfile

@@ -1,7 +1,7 @@
 # This image will be published as dspace/dspace-angular
 # See https://github.com/DSpace/dspace-angular/tree/main/docker for usage details
 
-FROM node:18-alpine
+FROM docker.io/node:18-alpine
 
 # Ensure Python and other build tools are available
 # These are needed to install some node modules, especially on linux/arm64
@@ -24,5 +24,5 @@ ENV NODE_OPTIONS="--max_old_space_size=4096"
 # Listen / accept connections from all IP addresses.
 # 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
+ENV NODE_ENV=development
 CMD yarn serve --host 0.0.0.0

Dockerfile.dist

@@ -4,7 +4,7 @@
 # Test build:
 # docker build -f Dockerfile.dist -t dspace/dspace-angular:dspace-7_x-dist .
 
-FROM node:18-alpine as build
+FROM docker.io/node:18-alpine AS build
 
 # Ensure Python and other build tools are available
 # These are needed to install some node modules, especially on linux/arm64
@@ -26,6 +26,6 @@ COPY --chown=node:node docker/dspace-ui.json /app/dspace-ui.json
 
 WORKDIR /app
 USER node
-ENV NODE_ENV production
+ENV NODE_ENV=production
 EXPOSE 4000
 CMD pm2-runtime start dspace-ui.json --json

angular.json

@@ -34,7 +34,6 @@
               "ngx-export-as",
               "url-parse",
               "uuid",
-              "webfontloader",
               "xlsx",
               "zone.js"
             ],

bitbucket-pipelines.yml

@@ -6,9 +6,9 @@ definitions:
     - step: &unittest-code-checks
         name: test-code-checks
         image:
-          name: cypress/browsers:node18.12.0-chrome107
+          name: cypress/browsers:node-18.20.3-chrome-125.0.6422.141-1-ff-126.0.1-edge-125.0.2535.85-1
           run-as-user: 1000
-        size: 2x
+        size: 4x
         caches:
           - node
         script:
@@ -22,6 +22,8 @@ pipelines:
   branches:
     'dspace-cris-2023_02_x':
       - step: *unittest-code-checks
+    'prod/**':
+      - step: *unittest-code-checks
   pull-requests:
     '**':
       - step: *unittest-code-checks

config/config.example.yml

@@ -1,7 +1,7 @@
 # NOTE: will log all redux actions and transfers in console
 debug: false
 
-# Angular Universal server settings
+# Angular User Inteface settings
 # NOTE: these settings define where Node.js will start your UI application. Therefore, these
 # "ui" settings usually specify a localhost port/URL which is later proxied to a public URL (using Apache or similar)
 ui:
@@ -17,12 +17,34 @@ ui:
   # Trust X-FORWARDED-* headers from proxies (default = true)
   useProxies: true
 
+# Angular Universal / Server Side Rendering (SSR) settings
 universal:
-  # Whether to inline "critical" styles into the server-side rendered HTML.
-  # Determining which styles are critical is a relatively expensive operation;
-  # this option can be disabled to boost server performance at the expense of
-  # loading smoothness. For improved SSR performance, DSpace defaults this to false (disabled).
+  # Whether to tell Angular to inline "critical" styles into the server-side rendered HTML.
+  # Determining which styles are critical is a relatively expensive operation; this option is
+  # disabled (false) by default to boost server performance at the expense of loading smoothness.
   inlineCriticalCss: false
+  # Path prefixes to enable SSR for. By default these are limited to paths of primary DSpace objects.
+  # NOTE: The "/handle/" path ensures Handle redirects work via SSR.  The "/reload/" path ensures
+  # hard refreshes (e.g. after login) trigger SSR while fully reloading the page.
+  paths: [ '/home', '/items/', '/entities/', '/collections/', '/communities/', '/bitstream/', '/bitstreams/', '/handle/', '/reload/' ]
+  # Whether to enable rendering of Search component on SSR.
+  # If set to true the component will be included in the HTML returned from the server side rendering.
+  # If set to false the component will not be included in the HTML returned from the server side rendering.
+  enableSearchComponent: false
+  # Whether to enable rendering of Browse component on SSR.
+  # If set to true the component will be included in the HTML returned from the server side rendering.
+  # If set to false the component will not be included in the HTML returned from the server side rendering.
+  enableBrowseComponent: false
+  # Enable state transfer from the server-side application to the client-side application.
+  # Defaults to true.
+  # Note: When using an external application cache layer, it's recommended not to transfer the state to avoid caching it.
+  # Disabling it ensures that dynamic state information is not inadvertently cached, which can improve security and
+  # ensure that users always use the most up-to-date state.
+  transferState: true
+  # When a different REST base URL is used for the server-side application, the generated state contains references to
+  # REST resources with the internal URL configured. By default, these internal URLs are replaced with public URLs.
+  # Disable this setting to avoid URL replacement during SSR. In this the state is not transferred to avoid security issues.
+  replaceRestUrl: true
 
 # The REST API server settings
 # NOTE: these settings define which (publicly available) REST API to use. They are usually
@@ -33,6 +55,9 @@ rest:
   port: 443
   # NOTE: Space is capitalized because 'namespace' is a reserved string in TypeScript
   nameSpace: /server
+  # Provide a different REST url to be used during SSR execution. It must contain the whole url including protocol, server port and
+  # server namespace (uncomment to use it).
+  #ssrBaseUrl: http://localhost:8080/server
 
 # Caching settings
 cache:
@@ -107,6 +132,8 @@ auth:
     # If the rest token expires in less than this amount of time, it will be refreshed automatically.
     # This is independent from the idle warning.
     timeLeftBeforeTokenRefresh: 120000 # 2 minutes
+  # Standard login enabled
+  isPasswordLoginEnabledForAdminsOnly: false
 
 # Form settings
 form:
@@ -187,6 +214,8 @@ submission:
     metadataDetailsList:
       - label: 'Document type'
         name: dc.type
+  # Minimum number of characters required before performing a lookup.
+  minChars: 3
 
 #  Default Language in which the UI will be rendered if the user's browser language is not an active language
 defaultLanguage: en
@@ -327,15 +356,6 @@ item:
   # The maximum number of values for repeatable metadata to show in the full item
   metadataLimit: 20
 
-# When the search results are retrieved, for each item type the metadata with a valid authority value are inspected.
-# Referenced items will be fetched with a find all by id strategy to avoid individual rest requests
-# to efficiently display the search results.
-followAuthorityMetadata:
-  - type: Publication
-    metadata: dc.contributor.author
-  - type: Product
-    metadata: dc.contributor.author
-
 # Collection Page Config
 collection:
   edit:
@@ -400,10 +420,6 @@ themes:
       attributes:
         rel: manifest
         href: assets/dspace/images/favicons/manifest.webmanifest
-    - tagName: link
-      attributes:
-        rel: stylesheet
-        href: "https://fonts.googleapis.com/icon?family=Material+Icons"
 
 # The default bundles that should always be displayed as suggestions when you upload a new bundle
 bundle:
@@ -442,6 +458,29 @@ comcolSelectionSort:
   sortField: 'dc.title'
   sortDirection: 'ASC'
 
+# Live Region configuration
+# Live Region as defined by w3c, https://www.w3.org/TR/wai-aria-1.1/#terms:
+# Live regions are perceivable regions of a web page that are typically updated as a
+# result of an external event when user focus may be elsewhere.
+#
+# The DSpace live region is a component present at the bottom of all pages that is invisible by default, but is useful
+# for screen readers. Any message pushed to the live region will be announced by the screen reader. These messages
+# usually contain information about changes on the page that might not be in focus.
+liveRegion:
+  # The duration after which messages disappear from the live region in milliseconds
+  messageTimeOutDurationMs: 30000
+  # The visibility of the live region. Setting this to true is only useful for debugging purposes.
+  isVisible: false
+
+
+# Search settings
+search:
+  # Number used to render n UI elements called loading skeletons that act as placeholders.
+  # These elements indicate that some content will be loaded in their stead.
+  # Since we don't know how many filters will be loaded before we receive a response from the server we use this parameter for the skeletons count.
+  # e.g. If we set 5 then 5 loading skeletons will be visualized before the actual filters are retrieved.
+  defaultFiltersCount: 5
+
 crisLayout:
   urn:
     - name: doi
@@ -521,3 +560,19 @@ addToAnyPlugin:
   title: DSpace CRIS 7 demo
   # The link to be shown in the shared post, if different from document.location.origin (optional)
   # link: https://dspacecris7.4science.cloud/
+
+# When the search results are retrieved, for each item type the metadata with a valid authority value are inspected.
+# Referenced items will be fetched with a find all by id strategy to avoid individual rest requests
+# to efficiently display the search results.
+followAuthorityMetadata:
+  - type: Publication
+    metadata: dc.contributor.author
+  - type: Product
+    metadata: dc.contributor.author
+
+# The maximum number of item to process when following authority metadata values.
+followAuthorityMaxItemLimit: 100
+
+# The maximum number of metadata values to process for each metadata key
+# when following authority metadata values.
+followAuthorityMetadataValuesLimit: 5

cypress.config.ts

@@ -1,6 +1,7 @@
 import { defineConfig } from 'cypress';
 
 export default defineConfig({
+  video: true,
   videosFolder: 'cypress/videos',
   screenshotsFolder: 'cypress/screenshots',
   fixturesFolder: 'cypress/fixtures',
@@ -17,22 +18,25 @@ export default defineConfig({
     // (This is the data set used in our CI environment)
 
     // Admin account used for administrative tests
-    DSPACE_TEST_ADMIN_USER: 'dspacedemo+admin@gmail.com',
-    DSPACE_TEST_ADMIN_PASSWORD: 'dspace',
+    DSPACE_TEST_ADMIN_USER: 'admin@admin.com',
+    DSPACE_TEST_ADMIN_USER_UUID: '335647b6-8a52-4ecb-a8c1-7ebabb199bda',
+    DSPACE_TEST_ADMIN_PASSWORD: 'admin',
     // Community/collection/publication used for view/edit tests
-    DSPACE_TEST_COMMUNITY: '0958c910-2037-42a9-81c7-dca80e3892b4',
-    DSPACE_TEST_COLLECTION: '282164f5-d325-4740-8dd1-fa4d6d3e7200',
-    DSPACE_TEST_ENTITY_PUBLICATION: '6160810f-1e53-40db-81ef-f6621a727398',
+    DSPACE_TEST_COMMUNITY: 'a30b75e4-1682-4b4d-85fd-a47fc78dbcf6',
+    DSPACE_TEST_COLLECTION: 'caf04bfa-b2f6-40d3-90d2-aa0b86d92f8d',
+    DSPACE_TEST_ENTITY_PUBLICATION: '9d1efbce-4d55-446c-ac70-0ba8998d04d2',
     // Search term (should return results) used in search tests
     DSPACE_TEST_SEARCH_TERM: 'test',
     // Main Collection used for submission tests. Should be able to accept normal Item objects
-    DSPACE_TEST_SUBMIT_COLLECTION_NAME: 'Sample Collection',
-    DSPACE_TEST_SUBMIT_COLLECTION_UUID: '9d8334e9-25d3-4a67-9cea-3dffdef80144',
+    DSPACE_TEST_SUBMIT_COLLECTION_NAME: 'Equipments',
+    DSPACE_TEST_SUBMIT_COLLECTION_UUID: 'c1da6a21-451f-430d-ad28-0f16e5b38fa0',
     // Collection used for Person entity submission tests. MUST be configured with EntityType=Person.
-    DSPACE_TEST_SUBMIT_PERSON_COLLECTION_NAME: 'People',
+    DSPACE_TEST_SUBMIT_PERSON_COLLECTION_NAME: 'Persons',
     // Account used to test basic submission process
-    DSPACE_TEST_SUBMIT_USER: 'dspacedemo+submit@gmail.com',
-    DSPACE_TEST_SUBMIT_USER_PASSWORD: 'dspace',
+    DSPACE_TEST_SUBMIT_USER: 'admin@admin.com',
+    DSPACE_TEST_SUBMIT_USER_PASSWORD: 'admin',
+    // Administrator users group
+    DSPACE_ADMINISTRATOR_GROUP: 'f8c90336-34c1-4ad6-ab63-ba4b9357f087'
   },
   e2e: {
     // Setup our plugins for e2e tests
@@ -43,5 +47,19 @@ export default defineConfig({
     // It can be overridden via the CYPRESS_BASE_URL environment variable
     // (By default we set this to a value which should work in most development environments)
     baseUrl: 'http://localhost:4000',
+    excludeSpecPattern: [
+      'cypress/e2e/collection-create.cy.ts',
+      'cypress/e2e/collection-edit.cy.ts',
+      'cypress/e2e/collection-statistics.cy.ts',
+      'cypress/e2e/community-edit.cy.ts',
+      'cypress/e2e/community-statistics.cy.ts',
+      'cypress/e2e/homepage.cy.ts',
+      'cypress/e2e/item-edit.cy.ts',
+      'cypress/e2e/item-template.cy.ts',
+      'cypress/e2e/login-modal.cy.ts',
+      'cypress/e2e/search-navbar.cy.ts',
+      'cypress/e2e/search-page.cy.ts',
+    ]
   },
+  defaultCommandTimeout: 10000,
 });