@decaf-ts/integrations 0.3.12 → 0.4.1-0

package/plugins/kibana/setup-dashboards.sh

@@ -0,0 +1,84 @@
+#!/usr/bin/env bash
+#
+# Creates two dummy dashboards in Kibana via the saved objects API.
+#
+# Usage: setup-dashboards.sh <kibana_host>
+#   kibana_host e.g. http://localhost:5602
+#
+set -euo pipefail
+
+KIBANA_HOST=${1:?Usage: setup-dashboards.sh <kibana_host>}
+
+echo "Waiting for Kibana to be ready..."
+for i in $(seq 1 60); do
+  if curl -sf "${KIBANA_HOST}/api/status" >/dev/null 2>&1; then
+    echo "Kibana is ready."
+    break
+  fi
+  sleep 2
+done
+
+# Create an index pattern first (required for dashboards)
+echo "Creating index pattern..."
+INDEX_PATTERN_RESPONSE=$(curl -sf -X POST "${KIBANA_HOST}/api/saved_objects/index-pattern" \
+  -H "kbn-xsrf: true" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "attributes": {
+      "title": "test-logs-*",
+      "timeFieldName": "@timestamp"
+    }
+  }')
+
+INDEX_PATTERN_ID=$(echo "$INDEX_PATTERN_RESPONSE" | python3 -c "import sys,json; print(json.load(sys.stdin)['id'])")
+echo "Created index pattern: $INDEX_PATTERN_ID"
+
+# Create Dashboard A
+echo "Creating Dashboard A..."
+DASHBOARD_A_RESPONSE=$(curl -sf -X POST "${KIBANA_HOST}/api/saved_objects/dashboard" \
+  -H "kbn-xsrf: true" \
+  -H "Content-Type: application/json" \
+  -d "{
+    \"attributes\": {
+      \"title\": \"E2E Test Dashboard A\",
+      \"description\": \"Dashboard A for e2e testing\",
+      \"panelsJSON\": \"[]\",
+      \"optionsJSON\": \"{\\\"hidePanelTitles\\\":false,\\\"useMargins\\\":true}\",
+      \"version\": 3,
+      \"timeRestore\": false
+    }
+  }")
+
+DASHBOARD_A_ID=$(echo "$DASHBOARD_A_RESPONSE" | python3 -c "import sys,json; print(json.load(sys.stdin)['id'])")
+echo "Created Dashboard A: $DASHBOARD_A_ID"
+
+# Create Dashboard B
+echo "Creating Dashboard B..."
+DASHBOARD_B_RESPONSE=$(curl -sf -X POST "${KIBANA_HOST}/api/saved_objects/dashboard" \
+  -H "kbn-xsrf: true" \
+  -H "Content-Type: application/json" \
+  -d "{
+    \"attributes\": {
+      \"title\": \"E2E Test Dashboard B\",
+      \"description\": \"Dashboard B for e2e testing\",
+      \"panelsJSON\": \"[]\",
+      \"optionsJSON\": \"{\\\"hidePanelTitles\\\":false,\\\"useMargins\\\":true}\",
+      \"version\": 3,
+      \"timeRestore\": false
+    }
+  }")
+
+DASHBOARD_B_ID=$(echo "$DASHBOARD_B_RESPONSE" | python3 -c "import sys,json; print(json.load(sys.stdin)['id'])")
+echo "Created Dashboard B: $DASHBOARD_B_ID"
+
+# Output the dashboard IDs for the test harness
+cat > "$(dirname "$0")/dashboards.json" << EOF
+{
+  "indexPatternId": "$INDEX_PATTERN_ID",
+  "dashboardA": "$DASHBOARD_A_ID",
+  "dashboardB": "$DASHBOARD_B_ID"
+}
+EOF
+
+echo "Dashboard setup complete."
+cat "$(dirname "$0")/dashboards.json"

package/plugins/superset/.gitignore

@@ -0,0 +1,17 @@
+# Ignore everything by default
+*
+
+# Re-include the .gitignore itself
+!.gitignore
+
+# Re-include curated configuration (Dockerfiles, compose, config, host pages, scripts)
+!Dockerfile
+!docker-compose.yml
+!superset_config.py
+!setup-dashboards.sh
+!dashboards.json
+!host/
+!host/**
+
+# Everything else (generated patch scripts org_dashboard_embed_superset/,
+# cloned Superset source .superset-source/, build artifacts, node_modules) remains ignored

package/plugins/superset/Dockerfile

@@ -0,0 +1,79 @@
+# Custom Superset image built from source with the switchable-dashboard patch.
+#
+# This Dockerfile clones the Apache Superset source, applies the patch scripts
+# (materialized by SupersetDashboardEmbedPlugin.install()), builds the SDK and
+# frontend, and produces a lean runtime image.
+#
+# Build context is the integrations/plugins/superset/ directory, which contains:
+#   - org_dashboard_embed_superset/  (generated by install())
+#   - superset_config.py             (curated runtime config)
+#
+FROM node:18-slim AS builder
+
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    git python3 python3-pip curl bash \
+    && rm -rf /var/lib/apt/lists/*
+
+WORKDIR /build
+
+# Clone Superset source
+ARG SUPERSET_GIT_URL=https://github.com/apache/superset.git
+ARG SUPERSET_GIT_REF=6.1.0
+RUN git clone --depth 1 --branch ${SUPERSET_GIT_REF} ${SUPERSET_GIT_URL} /build/superset
+
+# Copy patch scripts (materialized by install())
+COPY org_dashboard_embed_superset/patches/ /build/patches/
+COPY org_dashboard_embed_superset/build/ /build/build-scripts/
+
+# Apply patch
+RUN python3 /build/patches/apply_superset_6_1_patch.py /build/superset
+
+# Verify patch
+RUN bash /build/patches/verify_patch.sh /build/superset
+
+# Build SDK
+RUN cd /build/superset/superset-embedded-sdk && npm ci && npm run build
+
+# Build frontend
+RUN cd /build/superset/superset-frontend && npm ci && npm run build
+
+# ─── Runtime stage ──────────────────────────────────────────────────────
+FROM node:18-slim AS runtime
+
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    python3 python3-pip python3-venv curl bash \
+    && rm -rf /var/lib/apt/lists/*
+
+RUN python3 -m venv /app/venv
+ENV PATH="/app/venv/bin:$PATH"
+
+WORKDIR /app
+
+# Install Superset Python dependencies
+RUN pip install --no-cache-dir \
+    apache-superset==6.1.0 \
+    psycopg2-binary \
+    celery \
+    redis \
+    gunicorn
+
+# Copy built frontend assets from builder
+COPY --from=builder /build/superset/superset-frontend/ /app/superset-frontend/
+
+# Copy built SDK
+COPY --from=builder /build/superset/superset-embedded-sdk/ /app/superset-embedded-sdk/
+
+# Copy Superset config
+COPY superset_config.py /app/
+
+ENV SUPERSET_CONFIG_PATH=/app/superset_config.py
+ENV FLASK_APP=superset
+
+EXPOSE 8088
+
+# Initialize Superset
+RUN superset db upgrade && \
+    superset fab create-admin --username admin --firstname Admin --lastname User --email admin@example.com --password admin || true && \
+    superset init
+
+CMD ["gunicorn", "-b", "0.0.0.0:8088", "-w", "4", "--timeout", "120", "superset.app:create_app()"]

package/plugins/superset/docker-compose.yml

@@ -0,0 +1,62 @@
+services:
+  postgres:
+    image: postgres:16-alpine
+    environment:
+      POSTGRES_DB: superset
+      POSTGRES_USER: superset
+      POSTGRES_PASSWORD: superset
+    ports:
+      - "15433:5432"
+    healthcheck:
+      test: ["CMD-SHELL", "pg_isready -U superset"]
+      interval: 5s
+      timeout: 5s
+      retries: 10
+    networks:
+      - e2e
+
+  redis:
+    image: redis:7-alpine
+    ports:
+      - "16380:6379"
+    healthcheck:
+      test: ["CMD", "redis-cli", "ping"]
+      interval: 5s
+      timeout: 5s
+      retries: 10
+    networks:
+      - e2e
+
+  superset:
+    build:
+      context: .
+      dockerfile: Dockerfile
+      args:
+        SUPERSET_GIT_URL: https://github.com/apache/superset.git
+        SUPERSET_GIT_REF: "6.1.0"
+    environment:
+      - SUPERSET_CONFIG_PATH=/app/superset_config.py
+      - SUPERSET_GUEST_TOKEN_JWT_SECRET=e2e-test-secret-at-least-32-chars-long
+      - DATABASE_URL=postgresql+psycopg2://superset:superset@postgres:5432/superset
+      - REDIS_URL=redis://redis:6379/0
+      - SUPERSET_SECRET_KEY=e2e-test-secret-key-for-flask
+      - TALISMAN_ENABLED=false
+    ports:
+      - "8089:8088"
+    depends_on:
+      postgres:
+        condition: service_healthy
+      redis:
+        condition: service_healthy
+    healthcheck:
+      test: ["CMD-SHELL", "curl -sf http://localhost:8088/health || exit 1"]
+      interval: 10s
+      timeout: 10s
+      retries: 30
+      start_period: 60s
+    networks:
+      - e2e
+
+networks:
+  e2e:
+    driver: bridge

package/plugins/superset/host/index.html

@@ -0,0 +1,168 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>Superset Embed E2E Test Host</title>
+  <style>
+    * { margin: 0; padding: 0; box-sizing: border-box; }
+    body { font-family: -apple-system, sans-serif; height: 100vh; display: flex; flex-direction: column; }
+    .toolbar { padding: 12px 20px; background: #f0f0f0; border-bottom: 1px solid #ccc; display: flex; gap: 12px; align-items: center; }
+    .toolbar h1 { font-size: 16px; font-weight: 600; margin-right: auto; }
+    .toolbar button { padding: 8px 16px; border: 1px solid #ccc; border-radius: 4px; background: #fff; cursor: pointer; font-size: 14px; }
+    .toolbar button:hover { background: #e8e8e8; }
+    .toolbar button.active { background: #0066cc; color: #fff; border-color: #0066cc; }
+    #status { font-size: 12px; color: #666; padding: 4px 20px; background: #fafafa; }
+    .embed-container { flex: 1; position: relative; overflow: hidden; }
+    #supersetMount { width: 100%; height: 100%; }
+    #supersetMount iframe { width: 100%; height: 100%; border: 0; display: block; }
+  </style>
+</head>
+<body>
+  <div class="toolbar">
+    <h1>Superset Dashboard Embed E2E</h1>
+    <button id="btn-a" class="active">Dashboard A</button>
+    <button id="btn-b">Dashboard B</button>
+  </div>
+  <div id="status">Initializing...</div>
+  <div class="embed-container">
+    <div id="supersetMount"></div>
+  </div>
+
+  <!-- The patched SDK is loaded from the Superset container -->
+  <script type="module">
+    // These values are injected by the test harness via config.js
+    const config = window.__E2E_CONFIG || {};
+    const supersetHost = config.supersetHost || 'http://localhost:8089';
+    const embeddedA = config.embeddedA || '';
+    const embeddedB = config.embeddedB || '';
+    const dashboardA = config.dashboardA || '';
+    const dashboardB = config.dashboardB || '';
+
+    const status = document.getElementById('status');
+    const mountPoint = document.getElementById('supersetMount');
+
+    // Import the patched SDK from the Superset container
+    // The SDK is built from patched source and served by Superset
+    let embeddedDashboard = null;
+
+    // Guest token fetch — calls Superset guest token API
+    async function fetchGuestToken(dashboardId) {
+      status.textContent = `Fetching guest token for ${dashboardId || 'initial'}...`;
+      const url = dashboardId
+        ? `${supersetHost}/api/v1/security/guest_token/`
+        : `${supersetHost}/api/v1/security/guest_token/`;
+
+      // For e2e, we use the admin access token to create guest tokens
+      const loginResponse = await fetch(`${supersetHost}/api/v1/security/login`, {
+        method: 'POST',
+        headers: { 'Content-Type': 'application/json' },
+        body: JSON.stringify({
+          username: 'admin',
+          password: 'admin',
+          provider: 'db',
+          refresh: false,
+        }),
+      });
+      const loginData = await loginResponse.json();
+      const accessToken = loginData.access_token;
+
+      const targetDashboard = dashboardId || dashboardA;
+      const response = await fetch(url, {
+        method: 'POST',
+        headers: {
+          'Authorization': `Bearer ${accessToken}`,
+          'Content-Type': 'application/json',
+        },
+        body: JSON.stringify({
+          user: { username: 'e2e-user', first_name: 'E2E', last_name: 'Test' },
+          resources: [{ type: 'dashboard', id: targetDashboard }],
+          rls: [],
+        }),
+      });
+      const data = await response.json();
+      status.textContent = `Got guest token for ${targetDashboard}`;
+      return data.token;
+    }
+
+    async function initEmbed() {
+      try {
+        status.textContent = 'Loading Superset embedded SDK...';
+
+        // Dynamically import the SDK from the Superset container
+        // The patched SDK is available at /superset-embedded-sdk/
+        const sdkModule = await import(`${supersetHost}/superset-embedded-sdk/dist/index.mjs`);
+        const { embedDashboard } = sdkModule;
+
+        status.textContent = 'Mounting embedded dashboard...';
+
+        embeddedDashboard = await embedDashboard({
+          id: embeddedA,
+          supersetDomain: supersetHost,
+          mountPoint: mountPoint,
+          fetchGuestToken: fetchGuestToken,
+          dashboardUiConfig: {
+            hideTitle: true,
+            hideTab: true,
+            hideChartControls: true,
+            filters: { visible: true, expanded: false },
+            urlParams: { standalone: '1' },
+          },
+          iframeTitle: 'Superset E2E Dashboard',
+        });
+
+        window.__E2E_READY = true;
+        window.__E2E_EMBEDDED = embeddedDashboard;
+        status.textContent = `READY — embedded: ${embeddedA}`;
+
+        // Capture the original iframe reference
+        const iframe = mountPoint.querySelector('iframe');
+        window.__ORIGINAL_IFRAME = iframe;
+      } catch (err) {
+        status.textContent = `ERROR — ${err.message}`;
+        window.__E2E_ERROR = err.message;
+        console.error(err);
+      }
+    }
+
+    async function switchDashboard(dashboardId) {
+      if (!embeddedDashboard) {
+        status.textContent = 'Embedded dashboard not ready';
+        return;
+      }
+
+      try {
+        status.textContent = `Switching to ${dashboardId}...`;
+        window.__E2E_SWITCH_RESULT = null;
+
+        const result = await embeddedDashboard.switchDashboard(dashboardId);
+        window.__E2E_SWITCH_RESULT = result;
+        status.textContent = `Switched to ${result.dashboardId}`;
+      } catch (err) {
+        status.textContent = `Switch error — ${err.message}`;
+        window.__E2E_ERROR = err.message;
+        console.error(err);
+      }
+    }
+
+    // Button handlers
+    document.getElementById('btn-a').addEventListener('click', () => {
+      switchDashboard(dashboardA);
+      document.querySelectorAll('.toolbar button').forEach(b => b.classList.remove('active'));
+      document.getElementById('btn-a').classList.add('active');
+    });
+
+    document.getElementById('btn-b').addEventListener('click', () => {
+      switchDashboard(dashboardB);
+      document.querySelectorAll('.toolbar button').forEach(b => b.classList.remove('active'));
+      document.getElementById('btn-b').classList.add('active');
+    });
+
+    // Expose for Playwright
+    window.__E2E_SWITCH = switchDashboard;
+    window.__E2E_INIT = initEmbed;
+
+    // Start initialization
+    initEmbed();
+  </script>
+</body>
+</html>

package/plugins/superset/setup-dashboards.sh

@@ -0,0 +1,106 @@
+#!/usr/bin/env bash
+#
+# Creates two dummy dashboards in Superset via the REST API.
+# Also creates an embedded configuration for each dashboard and sets allowed domains.
+#
+# Usage: setup-dashboards.sh <superset_host>
+#   superset_host e.g. http://localhost:8089
+#
+set -euo pipefail
+
+SUPERSET_HOST=${1:?Usage: setup-dashboards.sh <superset_host>}
+
+echo "Waiting for Superset to be ready..."
+for i in $(seq 1 60); do
+  if curl -sf "${SUPERSET_HOST}/health" >/dev/null 2>&1; then
+    echo "Superset is ready."
+    break
+  fi
+  sleep 2
+done
+
+# Authenticate and get access token
+echo "Authenticating..."
+LOGIN_RESPONSE=$(curl -sf -X POST "${SUPERSET_HOST}/api/v1/security/login" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "username": "admin",
+    "password": "admin",
+    "provider": "db",
+    "refresh": false
+  }')
+
+ACCESS_TOKEN=$(echo "$LOGIN_RESPONSE" | python3 -c "import sys,json; print(json.load(sys.stdin)['access_token'])")
+echo "Got access token."
+
+AUTH_HEADER="Authorization: Bearer ${ACCESS_TOKEN}"
+
+# Create Dashboard A
+echo "Creating Dashboard A..."
+DASHBOARD_A_RESPONSE=$(curl -sf -X POST "${SUPERSET_HOST}/api/v1/dashboard/" \
+  -H "${AUTH_HEADER}" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "dashboard_title": "E2E Test Dashboard A",
+    "slug": "e2e-dashboard-a",
+    "position_json": "{\"DASHBOARD_VERSION_KEY\": \"v2\"}",
+    "metadata": "{\"chart_configuration\": {}}"
+  }')
+
+DASHBOARD_A_ID=$(echo "$DASHBOARD_A_RESPONSE" | python3 -c "import sys,json; print(json.load(sys.stdin)['id'])")
+echo "Created Dashboard A: $DASHBOARD_A_ID"
+
+# Create Dashboard B
+echo "Creating Dashboard B..."
+DASHBOARD_B_RESPONSE=$(curl -sf -X POST "${SUPERSET_HOST}/api/v1/dashboard/" \
+  -H "${AUTH_HEADER}" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "dashboard_title": "E2E Test Dashboard B",
+    "slug": "e2e-dashboard-b",
+    "position_json": "{\"DASHBOARD_VERSION_KEY\": \"v2\"}",
+    "metadata": "{\"chart_configuration\": {}}"
+  }')
+
+DASHBOARD_B_ID=$(echo "$DASHBOARD_B_RESPONSE" | python3 -c "import sys,json; print(json.load(sys.stdin)['id'])")
+echo "Created Dashboard B: $DASHBOARD_B_ID"
+
+# Create embedded configurations for both dashboards
+echo "Creating embedded configuration for Dashboard A..."
+EMBEDDED_A_RESPONSE=$(curl -sf -X POST "${SUPERSET_HOST}/api/v1/dashboard/embedded/" \
+  -H "${AUTH_HEADER}" \
+  -H "Content-Type: application/json" \
+  -d "{
+    \"resource_name\": \"Dashboard\",
+    \"resource_id\": ${DASHBOARD_A_ID},
+    \"allowed_domains\": [\"http://localhost:3002\", \"http://localhost:3001\"]
+  }")
+
+EMBEDDED_A_UUID=$(echo "$EMBEDDED_A_RESPONSE" | python3 -c "import sys,json; print(json.load(sys.stdin)['uuid'])")
+echo "Created embedded config A: $EMBEDDED_A_UUID"
+
+echo "Creating embedded configuration for Dashboard B..."
+EMBEDDED_B_RESPONSE=$(curl -sf -X POST "${SUPERSET_HOST}/api/v1/dashboard/embedded/" \
+  -H "${AUTH_HEADER}" \
+  -H "Content-Type: application/json" \
+  -d "{
+    \"resource_name\": \"Dashboard\",
+    \"resource_id\": ${DASHBOARD_B_ID},
+    \"allowed_domains\": [\"http://localhost:3002\", \"http://localhost:3001\"]
+  }")
+
+EMBEDDED_B_UUID=$(echo "$EMBEDDED_B_RESPONSE" | python3 -c "import sys,json; print(json.load(sys.stdin)['uuid'])")
+echo "Created embedded config B: $EMBEDDED_B_UUID"
+
+# Output the dashboard IDs for the test harness
+cat > "$(dirname "$0")/dashboards.json" << EOF
+{
+  "dashboardA": "${DASHBOARD_A_ID}",
+  "dashboardB": "${DASHBOARD_B_ID}",
+  "embeddedA": "${EMBEDDED_A_UUID}",
+  "embeddedB": "${EMBEDDED_B_UUID}"
+}
+EOF
+
+echo "Dashboard setup complete."
+cat "$(dirname "$0")/dashboards.json"

package/plugins/superset/superset_config.py

@@ -0,0 +1,49 @@
+"""Superset configuration for e2e testing."""
+
+import os
+
+# Database
+SQLALCHEMY_DATABASE_URI = os.environ.get(
+    "DATABASE_URL", "postgresql+psycopg2://superset:superset@postgres:5432/superset"
+)
+
+# Redis
+REDIS_HOST = os.environ.get("REDIS_HOST", "redis")
+REDIS_PORT = int(os.environ.get("REDIS_PORT", "6379"))
+CELERY_REDIS_URL = f"redis://{REDIS_HOST}:{REDIS_PORT}/0"
+CACHE_REDIS_URL = f"redis://{REDIS_HOST}:{REDIS_PORT}/1"
+
+# Secret key
+SECRET_KEY = os.environ.get("SUPERSET_SECRET_KEY", "e2e-test-secret-key-for-flask")
+
+# Enable embedded dashboards
+FEATURE_FLAGS = {
+    "EMBEDDED_SUPERSET": True,
+    "EMBEDDABLE_DASHBOARDS": True,
+}
+
+# Guest token
+GUEST_ROLE_NAME = "EmbeddedGuest"
+GUEST_TOKEN_JWT_SECRET = os.environ.get("SUPERSET_GUEST_TOKEN_JWT_SECRET", "e2e-test-secret-at-least-32-chars-long")
+GUEST_TOKEN_JWT_ALGO = "HS256"
+GUEST_TOKEN_HEADER_NAME = "X-GuestToken"
+
+# Disable Talisman for e2e (no HTTPS)
+TALISMAN_ENABLED = False
+
+# CORS
+ENABLE_CORS = True
+CORS_OPTIONS = {
+    "origins": ["*"],
+    "supports_credentials": False,
+}
+
+# Allowed domains for embedded dashboards — allows localhost for e2e tests
+# This is set per-dashboard via the API, but the default is permissive for e2e
+HTTP_HEADERS = {}
+
+# Session
+SESSION_COOKIE_SECURE = False
+
+# Logging
+LOG_LEVEL = "INFO"