Merge branch 'feature/27-dynamically-set-envrionment-variables' into 'development'

Resolve "Dynamically set envrionment variables" Closes #27 See merge request denbi/object-storage-access-ui!25

Merge branch 'feature/27-dynamically-set-envrionment-variables' into 'development'
9e94c4c0 · Daniel Göbel · 7788bfbd · ba37118e · 9e94c4c0 · 9e94c4c0
Commit 9e94c4c0 authored 2 years ago by Daniel Göbel
--- a/.dockerignore
+++ b/.dockerignore
 node_modules
 .git
 dist
+.idea
--- a/.gitignore
+++ b/.gitignore
@@ -27,3 +27,5 @@ coverage
 *.sln
 *.sw?
 .env
+public/env.js
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -3,6 +3,9 @@
 ### General
 * Improved UI when browsing a non-existing bucket or a bucket without permissions for
 * Improved UI when not browsing a bucket
+* Load environment variables dynamically instead of injecting them into the build process.
+You can now restart the docker container with new env variables without rebuilding it.
+The browser cache for this file is disabled to immediately see the changes #27
 ### Fixes
 * Show correct number of visible objects when searching for objects #28
 ### Internal

--- a/DEVELOPING.md
+++ b/DEVELOPING.md
@@ -7,11 +7,12 @@ npm install
 ```
 ## Environment Setup
-Create the file `.env` with the following (or similar) content. See the [README](README.md) for details on these
+This has to be done only once. Export the environment variables with the appropriate values and use the `envsubst` command
-environment variables.
+to populate the template and create the file the `public/env.js`
-```
+```shell
-VITE_API_BASE_URL=http://localhost:9999/api
+export API_BASE_URL=http://localhost:9999/api
-VITE_S3_URL=http://localhost:9998
+export S3_URL=http://localhost:9998
+envsubst < src/assets/env.template.js > public/env.js
 ```
 ## Backend Setup
 Clone the [repository](https://gitlab.ub.uni-bielefeld.de/denbi/object-storage-access) for the backend and set up the

--- a/Dockerfile
+++ b/Dockerfile
@@ -13,6 +13,7 @@ RUN npm run build-only
 FROM nginx:stable-alpine as production-stage
 HEALTHCHECK --interval=35s --timeout=4s CMD curl -f http://localhost || exit 1
 COPY --from=build-stage /app/dist /usr/share/nginx/html
+COPY --from=build-stage /app/src/assets/env.template.js /tmp
 COPY nginx.conf /etc/nginx/conf.d/default.conf
 EXPOSE 80
-CMD ["nginx", "-g", "daemon off;"]
+CMD ["/bin/sh",  "-c",  "envsubst < /tmp/env.template.js > /usr/share/nginx/html/env.js && exec nginx -g 'daemon off;'"]
--- a/README.md
+++ b/README.md
@@ -7,13 +7,14 @@ backend https://gitlab.ub.uni-bielefeld.de/denbi/object-storage-access
 ## Environment Variables
-These needs to be present when bundling the JavaScript files.   
+The docker container replaces them in the `env.template.js` file and moves that file to the same location as the `index.html`.
-This needs to be considered when building docker images.  
+When accessing the website, these variables will be loaded dynamically into the application.
-| Variable            | Default                   | Value     | Description                            |
-|---------------------|---------------------------|-----------|----------------------------------------|
+| Variable        | Default | Value     | Description                            |
-| `VITE_API_BASE_URL` | http://localhost:9999/api | HTTP URL  | Base URL for the API as backend        |
+|-----------------|---------|-----------|----------------------------------------|
-| `VITE_S3_URL`       | unset                     | HTTP URL  | URL of the S3 storage to interact with |
+| `API_BASE_URL`  | unset   | HTTP URL  | Base URL for the API as backend        |
+| `S3_URL`        | unset   | HTTP URL  | URL of the S3 storage to interact with |
 ## Getting started

--- a/index.html
+++ b/index.html
@@ -5,6 +5,7 @@
    <link rel="icon" href="/favicon.ico" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>S3 Proxy</title>
+    <script src="/env.js"></script>
  </head>
  <body>
    <div id="app"></div>

--- a/nginx.conf
+++ b/nginx.conf
@@ -7,6 +7,11 @@ server {
        root   /usr/share/nginx/html;
        index  index.html index.htm;
        try_files $uri $uri/ /index.html;
+       # Disable cache for env.js
+        location ~ env\.js {
+           add_header Cache-Control 'no-store';
+           expires off;
+        }
    }

--- a/src/App.vue
+++ b/src/App.vue
@@ -5,16 +5,14 @@ import { useCookies } from "vue3-cookies";
 import { useAuthStore } from "@/stores/auth";
 import { useRouter } from "vue-router";
 import { OpenAPI } from "@/client";
+import { environment } from "@/environment";
 const { cookies } = useCookies();
 const store = useAuthStore();
 const router = useRouter();
 onBeforeMount(() => {
-  OpenAPI.BASE =
+  OpenAPI.BASE = environment.API_BASE_URL;
-    import.meta.env.VITE_API_BASE_URL != null
-      ? import.meta.env.VITE_API_BASE_URL
-      : "http://localhost:9999/api";
  store.setToken(cookies.get("bearer"));
  router.beforeEach(async (to) => {
    // make sure the user is authenticated

--- a/src/assets/env.template.js
+++ b/src/assets/env.template.js
+(function (window) {
+  window["env"] = window["env"] || {};
+  // Environment variables
+  window["env"]["apiUrl"] = "${API_BASE_URL}";
+  window["env"]["s3Url"] = "${S3_URL}";
+})(this);
--- a/src/components/BucketView.vue
+++ b/src/components/BucketView.vue
@@ -29,6 +29,7 @@ import { getSignedUrl } from "@aws-sdk/s3-request-presigner";
 import { awsAuthMiddlewareOptions } from "@aws-sdk/middleware-signing";
 import { useAuthStore } from "@/stores/auth";
 import { useBucketStore } from "@/stores/buckets";
+import { environment } from "@/environment";
 const authStore = useAuthStore();
 const bucketRepository = useBucketStore();
@@ -37,7 +38,7 @@ const middleware = [
  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
  // @ts-ignore
  (next) => async (args) => {
-    args.request.headers["host"] = import.meta.env.VITE_S3_URL.split("://")[1];
+    args.request.headers["host"] = environment.S3_URL.split("://")[1];
    return await next(args);
  },
  {
@@ -48,7 +49,7 @@ const middleware = [
 let client = new S3Client({
  region: "us-east-1",
-  endpoint: import.meta.env.VITE_S3_URL,
+  endpoint: environment.S3_URL,
  forcePathStyle: true,
  credentials: {
    accessKeyId: authStore.s3key?.access_key ?? "",
@@ -67,7 +68,7 @@ authStore.$onAction(({ name, args }) => {
    } else {
      client = new S3Client({
        region: "us-east-1",
-        endpoint: import.meta.env.VITE_S3_URL,
+        endpoint: environment.S3_URL,
        forcePathStyle: true,
        credentials: {
          accessKeyId: args[0].access_key,

--- a/src/environment.ts
+++ b/src/environment.ts
+/* eslint-disable @typescript-eslint/ban-ts-comment */
+// @ts-ignore
+const windowEnv: Record<string, string> = window["env"];
+export const environment: env = {
+  S3_URL: windowEnv["s3Url"],
+  API_BASE_URL: windowEnv["apiUrl"],
+};
+type env = {
+  S3_URL: string;
+  API_BASE_URL: string;
+};