Search Performance Release Candidate

.github/workflows/code-quality.yml

@@ -9,10 +9,10 @@ on:
 
 env:
   NODE_VERSION: "20.x"
-  DB_USERNAME: postgres-test
-  DB_PASSWORD: postgres-test
-  DB_DATABASE: postgres-test
-  DATABASE_URL: postgres://postgres-test:postgres-test@localhost:5432/postgres-test?schema=public
+  DB_USERNAME: postgres
+  DB_PASSWORD: postgres
+  DB_DATABASE: postgres
+  DATABASE_URL: postgres://postgres:postgres@localhost:5432/postgres?schema=public
 
 jobs:
   install:
@@ -55,85 +55,16 @@ jobs:
       - name: Install e2e node dependencies
         run: cd e2e && npm ci
 
-  test:
-    runs-on: ubuntu-latest
-    needs: install
-    services:
-      db:
-        image: postgis/postgis
-        ports:
-          - "5432:5432"
-        env:
-          POSTGRES_USER: ${{ env.DB_USERNAME }}
-          POSTGRES_PASSWORD: ${{ env.DB_PASSWORD }}
-          POSTGRES_DB: ${{ env.DB_DATABASE }}
-        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
-      elasticsearch:
-        image: docker.elastic.co/elasticsearch/elasticsearch:8.12.1
-        ports:
-          - "9200:9200"
-        env:
-          ES_JAVA_OPTS: -Xms512m -Xmx512m
-          xpack.security.enabled: false
-          discovery.type: single-node
-          cluster.routing.allocation.disk.threshold_enabled: false
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-      - name: Setup node
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ env.NODE_VERSION }}
-      - name: Restore cached node modules
-        uses: actions/cache/restore@v4
-        with:
-          path: ./node_modules
-          key: "${{ runner.os }}-node_modules-${{ hashFiles('package-lock.json') }}-${{ hashFiles('**/schema.prisma') }}"
-      - name: Migrate database
-        run: npm run prisma -- migrate deploy
-      - name: Run tests
-        run: npm run test
-
-  lint:
-    runs-on: ubuntu-latest
-    needs: install
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-      - name: Setup node
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ env.NODE_VERSION }}
-      - name: Restore cached node modules
-        uses: actions/cache/restore@v4
-        with:
-          path: ./node_modules
-          key: "${{ runner.os }}-node_modules-${{ hashFiles('package-lock.json') }}-${{ hashFiles('**/schema.prisma') }}"
-      - name: Run lint
-        run: npm run lint
-      - name: Run prettier
-        run: npx prettier --check .
-
-  dependency-review:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-      - name: Review Dependencies
-        uses: actions/dependency-review-action@v4
-
-  # It would be cleaner and probably more performant to replace this build step
-  # with either a non-emitting build or a simple type check.
-  # We only have `build` available for now,
-  # since the project is currently split across a multitude of small packages,
-  # all of which have to specify their own commands.
-  # (Daniel von Atzigen, 2024-04-12)
-  build:
+  cypress:
     runs-on: ubuntu-latest
     needs:
-      - test
-      - lint
-      - dependency-review
+      - install
+    strategy:
+      # https://github.com/cypress-io/github-action/issues/48
+      fail-fast: false
+      matrix:
+        # Use 2 parallel instances
+        containers: [1, 2]
     steps:
       - name: Checkout repository
         uses: actions/checkout@v4
@@ -146,38 +77,18 @@ jobs:
         with:
           path: ./node_modules
           key: "${{ runner.os }}-node_modules-${{ hashFiles('package-lock.json') }}-${{ hashFiles('**/schema.prisma') }}"
-      - name: Reset nx
-        run: npx nx reset
-      - name: Run build
-        run: npm run build
-
-  cypress:
-    runs-on: ubuntu-latest
-    if: ${{ false }}
-    needs:
-      - test
-      - lint
-      - dependency-review
-    strategy:
-      # https://github.com/cypress-io/github-action/issues/48
-      fail-fast: false
-      matrix:
-        # Use 2 parallel instances
-        containers: [1, 2]
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
       - name: Start services
         env:
           DB_USER: ${{ env.DB_USERNAME }}
           DB_PASSWORD: ${{ env.DB_PASSWORD }}
         run: |
           cd development
+          chmod +x ./init/elasticsearch/init.sh
+          sed -i 's/- \.\/volumes\/elasticsearch\/data:\/usr\/share\/elasticsearch\/data//g' ./docker-compose.yaml
           docker compose up -d db oidc elasticsearch
-      - name: Setup
-        run: |
-          npm run prisma -- reset -f
-          # npm run start:server &> /dev/null &
+          sleep 60
+      - name: Migrate database
+        run: npm run prisma -- migrate deploy
       - name: Restore cached e2e node modules
         uses: actions/cache/restore@v4
         with:
@@ -188,6 +99,7 @@ jobs:
         with:
           command: |
             npx cypress run \
+              --browser edge \
               --record \
               --parallel \
               --key ${{ secrets.CYPRESS_RECORD_KEY }} \
@@ -196,6 +108,7 @@ jobs:
           start: npm start
           wait-on: "http://localhost:4200"
           wait-on-timeout: 120
+          working-directory: ./e2e
         env:
           VITE_APP_VERSION: 0.0.99+dev
           TZ: Europe/Zurich

.gitignore

@@ -48,7 +48,6 @@ Thumbs.db
 /libs/db-models/src/prisma/swisstopo-lambda_testdaten_asset_swissgeol
 
 __pycache__
-
 .env.local
 .env.staging
 .env.prod

.prettierignore

@@ -7,3 +7,4 @@
 /dist
 /node_modules
 /tmp
+/.idea

README.md

@@ -13,44 +13,31 @@ The following components must be installed on the development computer:
 Follow these steps to set up the development environment on your local machine:
 
 - [1. Configure Local Systems](#1-Configure-Local-Systems)
-- [2. Configure the Asset Server](#2-Configure-the-Asset-Server)
-- [3. Install Dependencies](#3-Install-Dependencies)
-- [4. Generate Database Types](#4-Generate-Database-Types)
-- [5. Initialize MinIO](#5-Initialize-MinIO)
+- [2. Install Dependencies](#2-Install-Dependencies)
+- [3. Generate Database Types](#3-Generate-Database-Types)
+- [4. Initialize MinIO](#4-Initialize-MinIO)
 
 #### 1. Configure Local Systems
 
 Configure `development/.env` according to the [local service configuration](#Local-Service-Configuration).
 
-#### 2. Configure the Asset Server
-
-Create an empty copy of the [web server configuration](#Asset-Server-Configuration) as [`apps/server-asset-sg/.env.local`](apps/server-asset-sg/.env.local).
-Configure the following variables:
-
-- Set `FRONTEND_URL=http://localhost:4200`.
-- Set `DATABASE_URL=postgres://{DB_USER}:{DB_PASSWORD}@localhost:5432/postgres?schema=public`,
-  where `{DB_USER}` and `{DB_PASSWORD}` equals the environment variables set for your local services.
-- Set all `OAUTH_*` variables to the example values to use your local OIDC server.
-- Leave `OCR_URL` empty.
-- Leave `OCR_CALLBACK_URL` empty.
-
-#### 3. Install Dependencies
+#### 2. Install Dependencies
 
 Install node modules:
 
 ```bash
 npm install
 ```
 
-#### 4. Generate Database Types
+#### 3. Generate Database Types
 
 Generate prisma-client for database-access:
 
 ```bash
 npm run prisma -- generate
 ```
 
-#### 5. Initialize MinIO
+#### 4. Initialize MinIO
 
 - [Start the development services](#Starting-the-Development-Environment).
 - Open http://localhost:9001
@@ -59,13 +46,9 @@ npm run prisma -- generate
 - Navigate to [the new bucket's browser](http://localhost:9001/browser/asset-sg) and create an empty folder with the name `asset-sg`.
 - Navigate to [Configuration](http://localhost:9001/settings/configurations/region) and change the server region to `local`.
 - Navigate to [Access Keys](http://localhost:9001/access-keys) and create a new access key.
-- Open your Asset Server Configuration at [`apps/server-asset-sg/.env.local`](apps/server-asset-sg/.env.local) and make the following changes:
-  - `S3_REGION=local`
-  - `S3_ENDPOINT=http://localhost:9000`
-  - `S3_BUCKET_NAME=asset-sg`
-  - `S3_ASSET_FOLDER=asset-sg`
-  - `S3_ACCESS_KEY_ID` as your newly generated access key.
-  - `S3_SECRET_ACCESS_KEY` as your newly generated access key's secret.
+- Open the file [`apps/server-asset-sg/.env.local`](apps/server-asset-sg/.env.local) and modify the following variables:
+  - Set `S3_ACCESS_KEY_ID` to your generated access key.
+  - Set `S3_SECRET_ACCESS_KEY` to your generated access key's secret.
 
 ### Starting the Development Environment
 

apps/client-asset-sg/docker/Dockerfile

@@ -1,7 +1,6 @@
-ARG APP_VERSION
-
 FROM node:20-alpine as app-builder
 
+ARG APP_VERSION
 ENV APP_VERSION=${APP_VERSION}
 ENV CYPRESS_INSTALL_BINARY=0
 
@@ -11,11 +10,13 @@ WORKDIR /app
 COPY . .
 
 RUN npm install
+RUN sed -i ''s/0.0.0-local/${APP_VERSION}/g'' apps/client-asset-sg/src/assets/version.json
 RUN npx nx build client-asset-sg --configuration=production
 
 # final image build
 FROM nginx:mainline-alpine
 
+ARG APP_VERSION
 ENV APP_VERSION=${APP_VERSION}
 
 WORKDIR /usr/share/nginx/html

apps/client-asset-sg/project.json

@@ -18,20 +18,21 @@
         "inlineStyleLanguage": "scss",
         "assets": ["apps/client-asset-sg/src/favicon.ico", "apps/client-asset-sg/src/assets"],
         "styles": ["apps/client-asset-sg/src/styles.scss"],
-        "scripts": []
+        "scripts": [],
+        "allowedCommonJsDependencies": ["tsafe", "validator", "xml-utils", "pbf", "rbush", "earcut"]
       },
       "configurations": {
         "production": {
           "budgets": [
             {
               "type": "initial",
-              "maximumWarning": "1.2mb",
-              "maximumError": "1.3mb"
+              "maximumWarning": "1.4mb",
+              "maximumError": "1.6mb"
             },
             {
               "type": "anyComponentStyle",
-              "maximumWarning": "2kb",
-              "maximumError": "4kb"
+              "maximumWarning": "4kb",
+              "maximumError": "6kb"
             }
           ],
           "outputHashing": "all",

apps/client-asset-sg/src/app/components/app-bar/app-bar.component.html

@@ -2,6 +2,8 @@
   <img class="logo" src="../../../assets/swissgeol_assets.svg" alt="{{ 'logoSwissGeol' | translate }}" />
 </a>
 <ng-content />
+<div class="spacer"></div>
+<span class="version">{{ version }}</span>
 <div class="language-links" *rxLet="links$ | push; let l">
   <a
     asset-sg-reset

apps/client-asset-sg/src/app/components/app-bar/app-bar.component.scss

@@ -31,10 +31,15 @@
   }
 }
 
+.spacer {
+  flex: 10;
+}
+
+.version {
+  color: #828e9a;
+}
+
 .language-links {
-  flex: 1 1 auto;
-  display: flex;
-  justify-content: flex-end;
   margin-right: 24px;
   a {
     margin-left: 0.5rem;

apps/client-asset-sg/src/app/components/app-bar/app-bar.component.ts

@@ -1,4 +1,5 @@
 import { ENTER } from '@angular/cdk/keycodes';
+import { HttpClient } from '@angular/common/http';
 import { ChangeDetectionStrategy, Component, ElementRef, Input, OnInit, Output, ViewChild } from '@angular/core';
 import { NavigationEnd, Router } from '@angular/router';
 import { isTruthy } from '@asset-sg/core';
@@ -8,6 +9,7 @@ import { flow, pipe } from 'fp-ts/function';
 import * as O from 'fp-ts/Option';
 import queryString from 'query-string';
 import { EMPTY, Observable, Subject, debounceTime, filter, map, startWith, switchMap } from 'rxjs';
+import { Version } from './version';
 
 @UntilDestroy()
 @Component({
@@ -25,6 +27,8 @@ export class AppBarComponent implements OnInit {
 
   public searchTextKeyDown$ = new Subject<KeyboardEvent>();
 
+  public version = '';
+
   public _currentLang$ = this._router.events.pipe(
     filter((e): e is NavigationEnd => e instanceof NavigationEnd),
     map((e) => e.urlAfterRedirects),
@@ -72,7 +76,8 @@ export class AppBarComponent implements OnInit {
 
   private _ngOnInit$ = new Subject<void>();
 
-  constructor(private _router: Router) {
+  constructor(private _router: Router, private readonly httpClient: HttpClient) {
+    this.httpClient.get<Version>('/assets/version.json').subscribe((v) => (this.version = v.version));
     this.searchTextChanged = this.searchTextKeyDown$.pipe(
       filter((ev) => ev.keyCode === ENTER),
       map((ev) => {

apps/client-asset-sg/src/app/components/app-bar/version.ts

@@ -0,0 +1,6 @@
+export interface Version {
+  tag: string;
+  build: string;
+  commit: string;
+  version: string;
+}

apps/client-asset-sg/src/app/components/splash-screen/splash-screen.component.html

@@ -8,7 +8,7 @@
   />
   <div class="text">
     <p class="welcome">{{ "welcomeTo" | translate }} {{ host }}</p>
-    <p class="system">Asset Data Management System</p>
+    <p class="system">Assets</p>
   </div>
   <ng-container [ngSwitch]="authService.state$ | async">
     <ng-container *ngSwitchCase="AuthState.Ongoing">

apps/client-asset-sg/src/app/i18n/de.ts

@@ -42,7 +42,7 @@ export const deAppTranslations = {
     closeInstructions: 'Anleitung schliessen',
     searchControl: 'Suchsteuerung',
     refineSearch: 'Suche verfeinern',
-    searchResults: 'Suchtreffer',
+    searchResults: 'Assets',
     author: 'Autor',
     documentDate: 'Dokumentdatum',
     usage: 'Nutzung',

apps/client-asset-sg/src/app/i18n/en.ts

@@ -43,7 +43,7 @@ export const enAppTranslations: AppTranslations = {
     closeInstructions: 'Close instructions',
     searchControl: 'Search control',
     refineSearch: 'Refine search',
-    searchResults: 'Search results',
+    searchResults: 'Assets',
     author: 'Author',
     documentDate: 'Document date',
     usage: 'Usage',