Release 4.1.0

.storybook/main.js

@@ -1,30 +1,41 @@
 const path = require('path');
 module.exports = {
   stories: ['../src/**/*.stories.mdx', '../src/**/*.stories.@(js|jsx|ts|tsx)'],
-  addons: ['@storybook/addon-links', '@storybook/addon-essentials', '@storybook/addon-interactions', '@storybook/preset-scss', 'storybook-addon-swc', '@storybook/addon-mdx-gfm'],
+  addons: [
+    '@storybook/addon-links',
+    '@storybook/addon-essentials',
+    '@storybook/addon-interactions',
+    '@storybook/preset-scss',
+    'storybook-addon-swc',
+    '@storybook/addon-mdx-gfm',
+  ],
   framework: {
     name: '@storybook/react-webpack5',
-    options: {}
+    options: {},
   },
-  webpackFinal: async config => {
+  webpackFinal: async (config) => {
+    // TODO:: Setting minimize here because storybook fails on prod otherwise. Specifically, we get arquero errors along the lines of "Invalid variable reference: "a"".
+    // This same problem does not occur on our prod builds, only for this storybook webpack compiler
+    config.optimization.minimize = false;
     // This is required to enable TS moduleResolution: node16, as there we have to add .js extensions which are actually .ts files.
-    config.resolve.extensionAlias = {
+    (config.resolve.extensionAlias = {
       ...(config.resolve.extensionAlias || {}),
       '.js': ['.tsx', '.ts', '.js'],
       '.cjs': ['.cts', '.cjs'],
-      '.mjs': ['.mts', '.mjs']
-    }, config.resolve.alias = {
-      ...(config.resolve.alias || {}),
-      // I have no clue why this is required, but if this is missing we get a "Can't resolve '../../assets/icons/datavisyn_logo.svg' in '.../src/scss'""
-      '../../assets': path.resolve(__dirname, '../src/assets'),
-      // Add visyn_core/dist as alias, as we have scss/code imports like visyn_core/dist/assets/...
-      'visyn_core/dist': path.resolve(__dirname, '../src'),
-      'visyn_core/src': path.resolve(__dirname, '../src'),
-      'visyn_core': path.resolve(__dirname, '../src')
-    };
+      '.mjs': ['.mts', '.mjs'],
+    }),
+      (config.resolve.alias = {
+        ...(config.resolve.alias || {}),
+        // I have no clue why this is required, but if this is missing we get a "Can't resolve '../../assets/icons/datavisyn_logo.svg' in '.../src/scss'""
+        '../../assets': path.resolve(__dirname, '../src/assets'),
+        // Add visyn_core/dist as alias, as we have scss/code imports like visyn_core/dist/assets/...
+        'visyn_core/dist': path.resolve(__dirname, '../src'),
+        'visyn_core/src': path.resolve(__dirname, '../src'),
+        visyn_core: path.resolve(__dirname, '../src'),
+      });
     return config;
   },
   docs: {
-    autodocs: true
-  }
-};
+    autodocs: true,
+  },
+};

.vscode/launch.json

@@ -4,6 +4,15 @@
     // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
     "version": "0.2.0",
     "configurations": [
+
+        {
+            "name": "Debug Storybook",
+            "request": "launch",
+            "type": "chrome",
+            "url": "http://localhost:6006",
+            "webRoot": "${workspaceFolder}"
+        },
+
         {
             "name": "Python: Module",
             "type": "python",

deploy/oauth/README.md

@@ -0,0 +1,43 @@
+## Oauth2-Proxy
+
+Used to locally, manually test te behaviour of auth-reverse-proxies like ALB.
+
+Based on the suggested docker images from the main [oauth2-proxy environment](https://github.com/oauth2-proxy/oauth2-proxy/tree/master/contrib/local-environment)
+
+### Pre-requisites
+
+Add this to your /etc/hosts (uncommented)
+
+```
+127.0.0.1 keycloak
+127.0.0.1 oauth2-proxy
+```
+
+Credentials | admin/password
+Email | [email protected]
+
+# Configuration
+
+Frontend env (common env in dev, different in prod) via webpack dotenv
+
+## LOGOUT_URL
+
+The logout url consists of multiple redirects. First we need to perform the oauth2 proxy sign out via calling `/oauth2/sign_out`.
+This sign out procedure deletes the oauth2 cookie and redirects to the open id connect provider via `rd=...`. The redirect url must be an encoded url.
+In our local test case, the redirect url will then point to keycloak's openid-connect logout: `auth/realms/{realm}/protocol/openid-connect/logout`. This ensures that the oidc provider also knows that the user should be logged out to prevent automatic redirects to the app with a valid cookie.
+
+```
+?rd=http://keycloak:9080/auth/realms/master/protocol/openid-connect/logout?redirect_uri=http://localhost:4180
+```
+
+- REFRESH_URL
+
+Backend env
+
+```env
+VISYN_CORE__SECURITY__STORE__OAUTH2_SECURITY_STORE__ENABLE=true
+VISYN_CORE__SECURITY__STORE__OAUTH2_SECURITY_STORE__ACCESS_TOKEN_HEADER_NAME=x-forwarded-access-token
+VISYN_CORE__SECURITY__STORE__OAUTH2_SECURITY_STORE__COOKIE_NAME=_oauth2_proxy
+VISYN_CORE__SECURITY__STORE__OAUTH2_SECURITY_STORE__SIGNOUT_URL=http://localhost:4180/oauth2/sign_out?rd=http%3A%2F%2Fkeycloak%3A9080%2Fauth%2Frealms%2Fmaster%2Fprotocol%2Fopenid-connect%2Flogout%3Fredirect_uri%3Dhttp%3A%2F%2Flocalhost%3A4180
+
+```

deploy/oauth/docker-compose.yaml

@@ -0,0 +1,39 @@
+# Simplified variant of https://github.com/oauth2-proxy/oauth2-proxy/blob/master/contrib/local-environment/docker-compose-keycloak.yaml
+version: '3.0'
+services:
+  oauth2-proxy:
+    container_name: oauth2-proxy
+    image: quay.io/oauth2-proxy/oauth2-proxy:v7.3.0
+    command: --config /oauth2-proxy.cfg
+    hostname: oauth2-proxy
+    volumes:
+      - './oauth2-proxy.cfg:/oauth2-proxy.cfg'
+    restart: unless-stopped
+    depends_on:
+      - keycloak
+    network_mode: host
+    # required for oauth2-proxy.cfg - upstreams localhost, as the frontend isn't available inside docker
+
+  keycloak:
+    container_name: keycloak
+    image: jboss/keycloak:10.0.0
+    hostname: keycloak
+    command:
+      [
+        '-Djboss.socket.binding.port-offset=1000',
+        '-Dkeycloak.migration.action=import',
+        '-Dkeycloak.migration.provider=dir',
+        '-Dkeycloak.migration.dir=/realm-config',
+        '-Dkeycloak.migration.strategy=IGNORE_EXISTING',
+      ]
+    volumes:
+      - ./keycloak:/realm-config
+    environment:
+      KEYCLOAK_USER: admin
+      KEYCLOAK_PASSWORD: password
+    ports:
+      - 9080:9080/tcp
+# this docker image REALLY doesn't like to run in network-mode host
+# requires this in your /etc/hosts (uncommented)
+# 127.0.0.1 keycloak
+# 127.0.0.1 oauth2-proxy