Merge remote-tracking branch 'upstream/main' into theme-fixes_contribute-main

Author: alexandrevryghem

.eslintrc.json

@@ -11,7 +11,13 @@
     "eslint-plugin-jsonc",
     "eslint-plugin-rxjs",
     "eslint-plugin-simple-import-sort",
-    "eslint-plugin-import-newlines"
+    "eslint-plugin-import-newlines",
+    "eslint-plugin-jsonc",
+    "dspace-angular-ts",
+    "dspace-angular-html"
+  ],
+  "ignorePatterns": [
+    "lint/test/fixture"
   ],
   "overrides": [
     {
@@ -21,7 +27,8 @@
       "parserOptions": {
         "project": [
           "./tsconfig.json",
-          "./cypress/tsconfig.json"
+          "./cypress/tsconfig.json",
+          "./lint/tsconfig.json"
         ],
         "createDefaultProgram": true
       },
@@ -38,7 +45,10 @@
           "error",
           2,
           {
-            "SwitchCase": 1
+            "SwitchCase": 1,
+            "ignoredNodes": [
+              "ClassBody.body > PropertyDefinition[decorators.length > 0] > .key"
+            ]
           }
         ],
         "max-classes-per-file": [
@@ -212,6 +222,15 @@
         "@typescript-eslint/no-unsafe-return": "off",
         "@typescript-eslint/restrict-template-expressions": "off",
         "@typescript-eslint/require-await": "off",
+        "@typescript-eslint/no-base-to-string": [
+          "error",
+          {
+            "ignoredTypeNames": [
+              "ResourceType",
+              "Error"
+            ]
+          }
+        ],
 
         "deprecation/deprecation": "warn",
 
@@ -238,7 +257,12 @@
           "method"
         ],
 
-        "rxjs/no-nested-subscribe": "off"     // todo: go over _all_ cases
+        "rxjs/no-nested-subscribe": "off",     // todo: go over _all_ cases
+
+        // Custom DSpace Angular rules
+        "dspace-angular-ts/themed-component-classes": "error",
+        "dspace-angular-ts/themed-component-selectors": "error",
+        "dspace-angular-ts/themed-component-usages": "error"
       }
     },
     {
@@ -253,7 +277,10 @@
         "createDefaultProgram": true
       },
       "rules": {
-        "prefer-const": "off"
+        "prefer-const": "off",
+
+        // Custom DSpace Angular rules
+        "dspace-angular-ts/themed-component-usages": "error"
       }
     },
     {
@@ -262,7 +289,11 @@
       ],
       "extends": [
         "plugin:@angular-eslint/template/recommended"
-      ]
+      ],
+      "rules": {
+        // Custom DSpace Angular rules
+        "dspace-angular-html/themed-component-usages": "error"
+      }
     },
     {
       "files": [

.gitattributes

@@ -13,4 +13,7 @@
 *.css eol=lf
 *.scss eol=lf
 *.html eol=lf
-*.svg eol=lf
+*.svg eol=lf
+
+# Generated documentation should have LF line endings to reduce git noise
+docs/lint/**/*.md eol=lf

.github/workflows/build.yml

@@ -85,8 +85,14 @@ jobs:
       - name: Install Yarn dependencies
         run: yarn install --frozen-lockfile
 
+      - name: Build lint plugins
+        run: yarn run build:lint
+
+      - name: Run lint plugin tests
+        run: yarn run test:lint:nobuild
+
       - name: Run lint
-        run: yarn run lint --quiet
+        run: yarn run lint:nobuild --quiet
 
       - name: Check for circular dependencies
         run: yarn run check-circ-deps

angular.json

@@ -266,6 +266,8 @@
           "options": {
             "lintFilePatterns": [
               "src/**/*.ts",
+              "cypress/**/*.ts",
+              "lint/**/*.ts",
               "src/**/*.html",
               "src/**/*.json5"
             ]

cypress/e2e/item-template.cy.ts

@@ -0,0 +1,15 @@
+const ADD_TEMPLATE_ITEM_PAGE = '/collections/'.concat(Cypress.env('DSPACE_TEST_COLLECTION')).concat('/itemtemplate');
+
+describe('Item Template', () => {
+  beforeEach(() => {
+    cy.visit(ADD_TEMPLATE_ITEM_PAGE);
+    cy.loginViaForm(Cypress.env('DSPACE_TEST_ADMIN_USER'), Cypress.env('DSPACE_TEST_ADMIN_PASSWORD'));
+  });
+
+  it('should load properly', () => {
+    cy.contains('.ds-header-row .lbl-cell', 'Field', { timeout: 10000 }).should('exist').should('be.visible');
+    cy.contains('.ds-header-row b', 'Value', { timeout: 10000 }).should('exist').should('be.visible');
+    cy.contains('.ds-header-row b', 'Lang', { timeout: 10000 }).should('exist').should('be.visible');
+    cy.contains('.ds-header-row b', 'Edit', { timeout: 10000 }).should('exist').should('be.visible');
+  });
+});

cypress/e2e/login-modal.cy.ts

@@ -3,31 +3,31 @@ import { testA11y } from 'cypress/support/utils';
 const page = {
   openLoginMenu() {
     // Click the "Log In" dropdown menu in header
-    cy.get('ds-themed-header [data-test="login-menu"]').click();
+    cy.get('ds-header [data-test="login-menu"]').click();
   },
   openUserMenu() {
     // Once logged in, click the User menu in header
-    cy.get('ds-themed-header [data-test="user-menu"]').click();
+    cy.get('ds-header [data-test="user-menu"]').click();
   },
   submitLoginAndPasswordByPressingButton(email, password) {
     // Enter email
-    cy.get('ds-themed-header [data-test="email"]').type(email);
+    cy.get('ds-header [data-test="email"]').type(email);
     // Enter password
-    cy.get('ds-themed-header [data-test="password"]').type(password);
+    cy.get('ds-header [data-test="password"]').type(password);
     // Click login button
-    cy.get('ds-themed-header [data-test="login-button"]').click();
+    cy.get('ds-header [data-test="login-button"]').click();
   },
   submitLoginAndPasswordByPressingEnter(email, password) {
     // In opened Login modal, fill out email & password, then click Enter
-    cy.get('ds-themed-header [data-test="email"]').type(email);
-    cy.get('ds-themed-header [data-test="password"]').type(password);
-    cy.get('ds-themed-header [data-test="password"]').type('{enter}');
+    cy.get('ds-header [data-test="email"]').type(email);
+    cy.get('ds-header [data-test="password"]').type(password);
+    cy.get('ds-header [data-test="password"]').type('{enter}');
   },
   submitLogoutByPressingButton() {
     // This is the POST command that will actually log us out
     cy.intercept('POST', '/server/api/authn/logout').as('logout');
     // Click logout button
-    cy.get('ds-themed-header [data-test="logout-button"]').click();
+    cy.get('ds-header [data-test="logout-button"]').click();
     // Wait until above POST command responds before continuing
     // (This ensures next action waits until logout completes)
     cy.wait('@logout');
@@ -102,10 +102,10 @@ describe('Login Modal', () => {
     page.openLoginMenu();
 
     // Registration link should be visible
-    cy.get('ds-themed-header [data-test="register"]').should('be.visible');
+    cy.get('ds-header [data-test="register"]').should('be.visible');
 
     // Click registration link & you should go to registration page
-    cy.get('ds-themed-header [data-test="register"]').click();
+    cy.get('ds-header [data-test="register"]').click();
     cy.location('pathname').should('eq', '/register');
     cy.get('ds-register-email').should('exist');
 
@@ -119,10 +119,10 @@ describe('Login Modal', () => {
     page.openLoginMenu();
 
     // Forgot password link should be visible
-    cy.get('ds-themed-header [data-test="forgot"]').should('be.visible');
+    cy.get('ds-header [data-test="forgot"]').should('be.visible');
 
     // Click link & you should go to Forgot Password page
-    cy.get('ds-themed-header [data-test="forgot"]').click();
+    cy.get('ds-header [data-test="forgot"]').click();
     cy.location('pathname').should('eq', '/forgot');
     cy.get('ds-forgot-email').should('exist');
 

cypress/e2e/search-navbar.cy.ts

@@ -1,15 +1,15 @@
 const page = {
   fillOutQueryInNavBar(query) {
     // Click the magnifying glass
-    cy.get('ds-themed-header [data-test="header-search-icon"]').click();
+    cy.get('ds-header [data-test="header-search-icon"]').click();
     // Fill out a query in input that appears
-    cy.get('ds-themed-header [data-test="header-search-box"]').type(query);
+    cy.get('ds-header [data-test="header-search-box"]').type(query);
   },
   submitQueryByPressingEnter() {
-    cy.get('ds-themed-header [data-test="header-search-box"]').type('{enter}');
+    cy.get('ds-header [data-test="header-search-box"]').type('{enter}');
   },
   submitQueryByPressingIcon() {
-    cy.get('ds-themed-header [data-test="header-search-icon"]').click();
+    cy.get('ds-header [data-test="header-search-icon"]').click();
   },
 };
 

docker/README.md

@@ -20,7 +20,7 @@ the Docker compose scripts in this 'docker' folder.
 
 ### Dockerfile
 
-This Dockerfile is used to build a *development* DSpace 7 Angular UI image, published as 'dspace/dspace-angular'
+This Dockerfile is used to build a *development* DSpace Angular UI image, published as 'dspace/dspace-angular'
 
 ```
 docker build -t dspace/dspace-angular:latest .
@@ -46,11 +46,11 @@ A default/demo version of this image is built *automatically*.
 
 ## 'docker' directory
 - docker-compose.yml
-  - Starts DSpace Angular with Docker Compose from the current branch.  This file assumes that a DSpace 7 REST instance will also be started in Docker.
+  - Starts DSpace Angular with Docker Compose from the current branch.  This file assumes that a DSpace REST instance will also be started in Docker.
 - docker-compose-rest.yml
-  - Runs a published instance of the DSpace 7 REST API - persists data in Docker volumes
+  - Runs a published instance of the DSpace REST API - persists data in Docker volumes
 - docker-compose-ci.yml
-  - Runs a published instance of the DSpace 7 REST API for CI testing.  The database is re-populated from a SQL dump on each startup.
+  - Runs a published instance of the DSpace REST API for CI testing.  The database is re-populated from a SQL dump on each startup.
 - cli.yml
   - Docker compose file that provides a DSpace CLI container to work with a running DSpace REST container.
 - cli.assetstore.yml
@@ -71,7 +71,7 @@ docker-compose -f docker/docker-compose.yml build
 
 This command provides a quick way to start both the frontend & backend from this single codebase
 ```
-docker-compose -p d7 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml up -d
+docker-compose -p d8 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml up -d
 ```
 
 Keep in mind, you may also start the backend by cloning the 'DSpace/DSpace' GitHub repository separately. See the next section.
@@ -86,14 +86,14 @@ _The system will be started in 2 steps. Each step shares the same docker network
 
 From 'DSpace/DSpace' clone (build first as needed):
 ```
-docker-compose -p d7 up -d
+docker-compose -p d8 up -d
 ```
 
 NOTE: More detailed instructions on starting the backend via Docker can be found in the [Docker Compose instructions for the Backend](https://github.com/DSpace/DSpace/blob/main/dspace/src/main/docker-compose/README.md).
 
 From 'DSpace/dspace-angular' clone (build first as needed)
 ```
-docker-compose -p d7 -f docker/docker-compose.yml up -d
+docker-compose -p d8 -f docker/docker-compose.yml up -d
 ```
 
 At this point, you should be able to access the UI from http://localhost:4000,
@@ -107,38 +107,38 @@ This allows you to run the Angular UI in *production* mode, pointing it at the d
 ```
 docker-compose -f docker/docker-compose-dist.yml pull
 docker-compose -f docker/docker-compose-dist.yml build
-docker-compose -p d7 -f docker/docker-compose-dist.yml up -d
+docker-compose -p d8 -f docker/docker-compose-dist.yml up -d
 ```
 
 ## Ingest test data from AIPDIR
 
 Create an administrator
 ```
-docker-compose -p d7 -f docker/cli.yml run --rm dspace-cli create-administrator -e test@test.edu -f admin -l user -p admin -c en
+docker-compose -p d8 -f docker/cli.yml run --rm dspace-cli create-administrator -e test@test.edu -f admin -l user -p admin -c en
 ```
 
 Load content from AIP files
 ```
-docker-compose -p d7 -f docker/cli.yml -f ./docker/cli.ingest.yml run --rm dspace-cli
+docker-compose -p d8 -f docker/cli.yml -f ./docker/cli.ingest.yml run --rm dspace-cli
 ```
 
 ## Alternative Ingest - Use Entities dataset
 _Delete your docker volumes or use a unique project (-p) name_
 
 Start DSpace with Database Content from a database dump
 ```
-docker-compose -p d7 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml -f docker/db.entities.yml up -d
+docker-compose -p d8 -f docker/docker-compose.yml -f docker/docker-compose-rest.yml -f docker/db.entities.yml up -d
 ```
 
 Load assetstore content and trigger a re-index of the repository
 ```
-docker-compose -p d7 -f docker/cli.yml -f docker/cli.assetstore.yml run --rm dspace-cli
+docker-compose -p d8 -f docker/cli.yml -f docker/cli.assetstore.yml run --rm dspace-cli
 ```
 
 ## End to end testing of the REST API (runs in GitHub Actions CI).
 _In this instance, only the REST api runs in Docker using the Entities dataset. GitHub Actions will perform CI testing of Angular using Node to drive the tests.  See `.github/workflows/build.yml` for more details._
 
 This command is only really useful for testing our Continuous Integration process.
 ```
-docker-compose -p d7ci -f docker/docker-compose-ci.yml up -d
+docker-compose -p d8ci -f docker/docker-compose-ci.yml up -d
 ```

docker/docker-compose-ci.yml

@@ -33,6 +33,7 @@ services:
       # Tell Statistics to commit all views immediately instead of waiting on Solr's autocommit.
       # This allows us to generate statistics in e2e tests so that statistics pages can be tested thoroughly.
       solr__D__statistics__P__autoCommit: 'false'
+      LOGGING_CONFIG: /dspace/config/log4j2-container.xml
     image: "${DOCKER_OWNER:-dspace}/dspace:${DSPACE_VER:-latest-test}"
     depends_on:
     - dspacedb
@@ -60,15 +61,19 @@ services:
   # NOTE: This is customized to use our loadsql image, so that we are using a database with existing test data
   dspacedb:
     container_name: dspacedb
+    image: "${DOCKER_OWNER:-dspace}/dspace-postgres-pgcrypto:${DSPACE_VER:-latest-loadsql}"
     environment:
       # This LOADSQL should be kept in sync with the LOADSQL in
       # https://github.com/DSpace/DSpace/blob/main/dspace/src/main/docker-compose/db.entities.yml
       # This SQL is available from https://github.com/DSpace-Labs/AIP-Files/releases/tag/demo-entities-data
       LOADSQL: https://github.com/DSpace-Labs/AIP-Files/releases/download/demo-entities-data/dspace7-entities-data.sql
       PGDATA: /pgdata
-    image: dspace/dspace-postgres-pgcrypto:loadsql
+      POSTGRES_PASSWORD: dspace
     networks:
       - dspacenet
+    ports:
+    - published: 5432
+      target: 5432
     stdin_open: true
     tty: true
     volumes:
@@ -105,6 +110,8 @@ services:
       cp -r /opt/solr/server/solr/configsets/statistics/* statistics
       precreate-core qaevent /opt/solr/server/solr/configsets/qaevent
       cp -r /opt/solr/server/solr/configsets/qaevent/* qaevent
+      precreate-core suggestion /opt/solr/server/solr/configsets/suggestion
+      cp -r /opt/solr/server/solr/configsets/suggestion/* suggestion
       exec solr -f
 volumes:
   assetstore: