Update docker and CI configs

Author: sanex3339

.dockerignore

@@ -1,4 +1,4 @@
-.idea
-node_modules
-docker-compose.*
+**/.idea
+**/node_modules
+**/docker-compose.*
 .dockerignore

.env.docker.example

@@ -6,3 +6,7 @@ CLIENT_PORT_APP_ROUTER=4400
 CLIENT_PORT_PAGES_ROUTER=4401
 
 WATCH="false"
+
+# for development
+# MB_RUN_MODE="dev"
+# METASTORE_DEV_SERVER_URL=""

.github/workflows/e2e-tests.yml

@@ -17,7 +17,9 @@ jobs:
     timeout-minutes: 10
     name: e2e-tests
     env:
-      PREMIUM_EMBEDDING_TOKEN: ${{ secrets.ENTERPRISE_TOKEN }}
+      PREMIUM_EMBEDDING_TOKEN: ${{ secrets.STAGING_MB_ALL_FEATURES_TOKEN }}
+      MB_RUN_MODE: dev
+      METASTORE_DEV_SERVER_URL: ${{ secrets.METASTORE_DEV_SERVER_URL }}
     permissions:
       id-token: write
       contents: read
@@ -28,8 +30,7 @@ jobs:
       - name: Run Sample App in Docker
         run: |
           cp .env.docker.example .env.docker &&
-          npm run docker:up -- -d  &&
-          while ! nc -z localhost 4400; do sleep 1; done
+          npm run docker:e2e:up -- --wait
 
       - name: Install Chrome v111
         uses: browser-actions/setup-chrome@v1

docker-compose.local-dist.yml

@@ -0,0 +1,9 @@
+services:
+  metabase:
+    volumes:
+      - type: bind
+        source: ./local-dist/metabase.jar
+        target: /app/metabase.jar
+        read_only: true
+        bind:
+          create_host_path: false

docker-compose.yml

@@ -1,16 +1,16 @@
 services:
   metabase:
-    build:
-      context: .
-      dockerfile: metabase/Dockerfile
+    image: metabase/metabase-enterprise:v1.55.x
     environment:
-      MB_CONFIG_FILE_PATH: "./app/init-config.yml"
+      MB_CONFIG_FILE_PATH: "./app/config.yml"
       MB_JETTY_PORT: "${MB_PORT}"
       MB_EDITION: "ee"
       MB_SITE_URL: "http://localhost:${MB_PORT}/"
       MB_JWT_SHARED_SECRET: "${METABASE_JWT_SHARED_SECRET}"
       MB_SETUP_TOKEN: "${PREMIUM_EMBEDDING_TOKEN}"
       MB_PREMIUM_EMBEDDING_TOKEN: "${PREMIUM_EMBEDDING_TOKEN}"
+      MB_RUN_MODE: "${MB_RUN_MODE}"
+      METASTORE_DEV_SERVER_URL: "${METASTORE_DEV_SERVER_URL}"
       MB_JWT_IDENTITY_PROVIDER_URI: "http://localhost:${AUTH_PROVIDER_PORT}/sso/metabase"
     healthcheck:
       test: curl --fail -X GET -I "http://localhost:${MB_PORT}/api/health" || exit 1
@@ -19,6 +19,8 @@ services:
       retries: 10
     ports:
       - "${MB_PORT}:${MB_PORT}"
+    volumes:
+      - ./metabase/config.yml:/app/config.yml
 
   next-sample-app-router:
     depends_on:
@@ -38,6 +40,11 @@ services:
       NEXT_PUBLIC_METABASE_INSTANCE_URL: "http://localhost:${MB_PORT}"
       METABASE_INSTANCE_URL: "http://metabase:${MB_PORT}"
       METABASE_JWT_SHARED_SECRET: "${METABASE_JWT_SHARED_SECRET}"
+    healthcheck:
+      test: curl --fail -X GET -I "http://localhost:${CLIENT_PORT_APP_ROUTER}/" || exit 1
+      interval: 2s
+      timeout: 2s
+      retries: 5
     ports:
       - "${CLIENT_PORT_APP_ROUTER}:${CLIENT_PORT_APP_ROUTER}"
     volumes:
@@ -51,7 +58,7 @@ services:
       context: .
       dockerfile: ./next-sample-pages-router/Dockerfile
       args:
-        PORT: "${CLIENT_PORT_APP_ROUTER}"
+        PORT: "${CLIENT_PORT_PAGES_ROUTER}"
         NEXT_PUBLIC_METABASE_INSTANCE_URL: "http://localhost:${MB_PORT}"
         METABASE_INSTANCE_URL: "http://metabase:${MB_PORT}"
         METABASE_JWT_SHARED_SECRET: "${METABASE_JWT_SHARED_SECRET}"
@@ -61,6 +68,11 @@ services:
       NEXT_PUBLIC_METABASE_INSTANCE_URL: "http://localhost:${MB_PORT}"
       METABASE_INSTANCE_URL: "http://metabase:${MB_PORT}"
       METABASE_JWT_SHARED_SECRET: "${METABASE_JWT_SHARED_SECRET}"
+    healthcheck:
+      test: curl --fail -X GET -I "http://localhost:${CLIENT_PORT_PAGES_ROUTER}/" || exit 1
+      interval: 2s
+      timeout: 2s
+      retries: 5
     ports:
       - "${CLIENT_PORT_PAGES_ROUTER}:${CLIENT_PORT_PAGES_ROUTER}"
     volumes:

metabase/Dockerfile

@@ -5,6 +5,9 @@
   "scripts": {
     "start": "npm run docker:up",
     "docker:up": "docker compose --env-file .env.docker up",
-    "docker:down": "docker compose --env-file .env.docker down --rmi all --volumes"
+    "docker:e2e:up": "yarn docker:up",
+    "docker:local-dist:up": "docker compose -f docker-compose.yml -f docker-compose.local-dist.yml --env-file .env.docker up",
+    "docker:down": "docker compose --env-file .env.docker down",
+    "docker:rm": "yarn docker:down --rmi all --volumes"
   }
 }

metabase/init-config.yml renamed to metabase/config.yml

@@ -31,14 +31,21 @@ This option should be used if you don't want to test Metabase Embedding SDK with
 
 From the root directory:
 - Copy `.env.docker.example` to `.env.docker` and replace `<your_enterprise_token>` with your premium embedding token
-- Start all services in Docker with `yarn start`
+- Start all services in Docker with `yarn docker:up`
 
 It will:
-- poll a Metabase image and run it
-- build and run both `next-sample-app-router` and `next-sample-pages-router` apps
+- Poll a Metabase image and run it
+- Build and run containers with both `next-sample-app-router` and `next-sample-pages-router` apps and run it
 
 The pages router sample will start on port 4401 and the app router sample will start on port 4400.
 
+#### Local development (For Metabase developers)
+
+- To run containers with a locally built `metabase.jar`, copy it to the `./local-dist` folder as `./local-dist/metabase.jar`.
+- To run containers with a locally built Embedding SDK package, copy it to the `./local-dist` folder as `./local-dist/embedding-sdk`.
+- Run `yarn docker:local-dist:up` to start containers and use locally built dist from the `./local-dist` folder.
+- To remove containers and images completely run `yarn docker:rm`.
+
 ## Authentication
 
 Both apps provide an endpoint for user authentication, replace the logic to match your authentication system.