LIBDRUM-892. Update DRUM to DSpace 8.0

.eslintrc.json

@@ -8,7 +8,16 @@
     "eslint-plugin-deprecation",
     "unused-imports",
     "eslint-plugin-lodash",
-    "eslint-plugin-jsonc"
+    "eslint-plugin-jsonc",
+    "eslint-plugin-rxjs",
+    "eslint-plugin-simple-import-sort",
+    "eslint-plugin-import-newlines",
+    "eslint-plugin-jsonc",
+    "dspace-angular-ts",
+    "dspace-angular-html"
+  ],
+  "ignorePatterns": [
+    "lint/test/fixture"
   ],
   "overrides": [
     {
@@ -18,7 +27,8 @@
       "parserOptions": {
         "project": [
           "./tsconfig.json",
-          "./cypress/tsconfig.json"
+          "./cypress/tsconfig.json",
+          "./lint/tsconfig.json"
         ],
         "createDefaultProgram": true
       },
@@ -27,17 +37,32 @@
         "plugin:@typescript-eslint/recommended",
         "plugin:@typescript-eslint/recommended-requiring-type-checking",
         "plugin:@angular-eslint/recommended",
-        "plugin:@angular-eslint/template/process-inline-templates"
+        "plugin:@angular-eslint/template/process-inline-templates",
+        "plugin:rxjs/recommended"
       ],
       "rules": {
+        "indent": [
+          "error",
+          2,
+          {
+            "SwitchCase": 1,
+            "ignoredNodes": [
+              "ClassBody.body > PropertyDefinition[decorators.length > 0] > .key"
+            ]
+          }
+        ],
         "max-classes-per-file": [
           "error",
           1
         ],
         "comma-dangle": [
-          "off",
+          "error",
           "always-multiline"
         ],
+        "object-curly-spacing": [
+          "error",
+          "always"
+        ],
         "eol-last": [
           "error",
           "always"
@@ -104,15 +129,13 @@
             "allowTernary": true
           }
         ],
-        "prefer-const": "off",            // todo: re-enable & fix errors (more strict than it used to be in TSLint)
+        "prefer-const": "error",
+        "no-case-declarations": "error",
+        "no-extra-boolean-cast": "error",
         "prefer-spread": "off",
         "no-underscore-dangle": "off",
-
-        // todo: disabled rules from eslint:recommended, consider re-enabling & fixing
         "no-prototype-builtins": "off",
         "no-useless-escape": "off",
-        "no-case-declarations": "off",
-        "no-extra-boolean-cast": "off",
 
         "@angular-eslint/directive-selector": [
           "error",
@@ -139,7 +162,6 @@
           }
         ],
         "@angular-eslint/no-attribute-decorator": "error",
-        "@angular-eslint/no-forward-ref": "error",
         "@angular-eslint/no-output-native": "warn",
         "@angular-eslint/no-output-on-prefix": "warn",
         "@angular-eslint/no-conflicting-lifecycle": "warn",
@@ -183,7 +205,7 @@
         ],
         "@typescript-eslint/type-annotation-spacing": "error",
         "@typescript-eslint/unified-signatures": "error",
-        "@typescript-eslint/ban-types": "warn",  // todo: deal with {} type issues & re-enable
+        "@typescript-eslint/ban-types": "error",
         "@typescript-eslint/no-floating-promises": "warn",
         "@typescript-eslint/no-misused-promises": "warn",
         "@typescript-eslint/restrict-plus-operands": "warn",
@@ -200,17 +222,65 @@
         "@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",
 
+        "simple-import-sort/imports": "error",
+        "simple-import-sort/exports": "error",
         "import/order": "off",
+        "import/first": "error",
+        "import/newline-after-import": "error",
+        "import/no-duplicates": "error",
         "import/no-deprecated": "warn",
         "import/no-namespace": "error",
+        "import-newlines/enforce": [
+          "error",
+          {
+            "items": 1,
+            "semi": true,
+            "forceSingleLine": true
+          }
+        ],
+
         "unused-imports/no-unused-imports": "error",
         "lodash/import-scope": [
           "error",
           "method"
-        ]
+        ],
+
+        "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"
+      }
+    },
+    {
+      "files": [
+        "*.spec.ts"
+      ],
+      "parserOptions": {
+        "project": [
+          "./tsconfig.json",
+          "./cypress/tsconfig.json"
+        ],
+        "createDefaultProgram": true
+      },
+      "rules": {
+        "prefer-const": "off",
+
+        // Custom DSpace Angular rules
+        "dspace-angular-ts/themed-component-usages": "error"
       }
     },
     {
@@ -221,9 +291,8 @@
         "plugin:@angular-eslint/template/recommended"
       ],
       "rules": {
-        // todo: re-enable & fix errors
-        "@angular-eslint/template/no-negated-async": "off",
-        "@angular-eslint/template/eqeqeq": "off"
+        // Custom DSpace Angular rules
+        "dspace-angular-html/themed-component-usages": "error"
       }
     },
     {

.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

@@ -38,7 +38,7 @@ jobs:
     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
@@ -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
@@ -186,36 +192,38 @@ jobs:
       - name: Shutdown Docker containers
         run: docker compose -f ./docker/docker-compose-ci.yml down
 
-  # Codecov upload is a separate job in order to allow us to restart this separate from the entire build/test
-  # job above. This is necessary because Codecov uploads seem to randomly fail at times.
-  # See https://community.codecov.com/t/upload-issues-unable-to-locate-build-via-github-actions-api/3954
-  codecov:
-    # Must run after 'tests' job above
-    needs: tests
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      # Download artifacts from previous 'tests' job
-      - name: Download coverage artifacts
-        uses: actions/download-artifact@v4
-
-      # Now attempt upload to Codecov using its action.
-      # NOTE: We use a retry action to retry the Codecov upload if it fails the first time.
-      #
-      # Retry action: https://github.com/marketplace/actions/retry-action
-      # Codecov action: https://github.com/codecov/codecov-action
-      - name: Upload coverage to Codecov.io
-        uses: Wandalen/[email protected]
-        with:
-          action: codecov/codecov-action@v4
-          # Ensure codecov-action throws an error when it fails to upload
-          # This allows us to auto-restart the action if an error is thrown
-          with: |
-            fail_ci_if_error: true
-            token: ${{ secrets.CODECOV_TOKEN }}
-          # Try re-running action 5 times max
-          attempt_limit: 5
-          # Run again in 30 seconds
-          attempt_delay: 30000
+  # UMD Customization
+  # # Codecov upload is a separate job in order to allow us to restart this separate from the entire build/test
+  # # job above. This is necessary because Codecov uploads seem to randomly fail at times.
+  # # See https://community.codecov.com/t/upload-issues-unable-to-locate-build-via-github-actions-api/3954
+  # codecov:
+  #   # Must run after 'tests' job above
+  #   needs: tests
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - name: Checkout
+  #       uses: actions/checkout@v4
+
+  #     # Download artifacts from previous 'tests' job
+  #     - name: Download coverage artifacts
+  #       uses: actions/download-artifact@v4
+
+  #     # Now attempt upload to Codecov using its action.
+  #     # NOTE: We use a retry action to retry the Codecov upload if it fails the first time.
+  #     #
+  #     # Retry action: https://github.com/marketplace/actions/retry-action
+  #     # Codecov action: https://github.com/codecov/codecov-action
+  #     - name: Upload coverage to Codecov.io
+  #       uses: Wandalen/[email protected]
+  #       with:
+  #         action: codecov/codecov-action@v4
+  #         # Ensure codecov-action throws an error when it fails to upload
+  #         # This allows us to auto-restart the action if an error is thrown
+  #         with: |
+  #           fail_ci_if_error: true
+  #           token: ${{ secrets.CODECOV_TOKEN }}
+  #         # Try re-running action 5 times max
+  #         attempt_limit: 5
+  #         # Run again in 30 seconds
+  #         attempt_delay: 30000
+  # End UMD Customization

.github/workflows/docker.yml

@@ -4,7 +4,7 @@ name: Docker images
 # Run this Build for all pushes to 'main' or maintenance branches, or tagged releases.
 # Also run for PRs to ensure PR doesn't break Docker build process
 # NOTE: uses "reusable-docker-build.yml" in DSpace/DSpace to actually build each of the Docker images
-# https://github.com/DSpace/DSpace/blob/dspace-7_x/.github/workflows/reusable-docker-build.yml
+# https://github.com/DSpace/DSpace/blob/main/.github/workflows/reusable-docker-build.yml
 # 
 on:
   push:
@@ -26,7 +26,7 @@ jobs:
     # Ensure this job never runs on forked repos. It's only executed for 'dspace/dspace-angular'
     if: github.repository == 'dspace/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@dspace-7_x
+    uses: DSpace/DSpace/.github/workflows/reusable-docker-build.yml@main
     with:
       build_id: dspace-angular-dev
       image_name: dspace/dspace-angular
@@ -42,7 +42,7 @@ jobs:
     # Ensure this job never runs on forked repos. It's only executed for 'dspace/dspace-angular'
     if: github.repository == 'dspace/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@dspace-7_x
+    uses: DSpace/DSpace/.github/workflows/reusable-docker-build.yml@main
     with:
       build_id: dspace-angular-dist
       image_name: dspace/dspace-angular

.gitignore

@@ -5,6 +5,7 @@ config/certs/*
 # End UMD Customization
 
 /.angular/cache
+/.nx
 /__build__
 /__server_build__
 /node_modules

.vscode/launch.json

@@ -47,7 +47,7 @@
             "type": "chrome",
             "request": "launch",
             "name": "Launch Chrome against localhost",
-            "url": "http://localhost:4000",
+            "url": "https://drum-local.lib.umd.edu:4000",
             "webRoot": "${workspaceFolder}",
             "browserLaunchLocation": "ui"
         },

Dockerfile.dist

@@ -2,7 +2,7 @@
 # See https://github.com/DSpace/dspace-angular/tree/main/docker for usage details
 
 # Test build:
-# docker build -f Dockerfile.dist -t dspace/dspace-angular:dspace-7_x-dist .
+# docker build -f Dockerfile.dist -t dspace/dspace-angular:latest-dist .
 
 FROM node:18-alpine as build
 

README-DRUM.md

@@ -9,7 +9,7 @@ The original dspace-angular documentation is in the "README.md" file.
 
 ## Prerequisite
 
-* Node v16.x or v18.x
+* Node v18.x or v20.x
 * npm >= v5.x
 * yarn == v1.x
 * Ensure that the DRUM API is up and running by following the instructions at
@@ -233,3 +233,20 @@ In the launch configuration, the line:
 
 is needed to prevent Chrome from displaying a "Restore" session dialog every
 time Chrome starts. See <https://github.com/microsoft/vscode-js-debug/issues/723#issuecomment-866227122>
+
+## Running the Tests
+
+To run the TypeScript unit tests:
+
+```zsh
+$ yarn test
+```
+
+## TypeScript Linter
+
+To run the TypeScript Linter (from the "Run lint" step in
+".github/workflows/build.yml"):
+
+```zsh
+$ yarn run lint:nobuild --quiet
+```