@i-santos/firestack 1.0.0

package/scripts/publish-package.sh

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
+REGISTRY="${FIRESTACK_REGISTRY:-http://127.0.0.1:4873}"
+NPM_CACHE="${FIRESTACK_NPM_CACHE:-/tmp/npm-cache-firestack}"
+
+cd "$ROOT_DIR"
+
+if ! npm --cache "$NPM_CACHE" whoami --registry "$REGISTRY" >/dev/null 2>&1; then
+  echo "[firestack] npm auth missing for $REGISTRY"
+  echo "[firestack] run: npm adduser --registry $REGISTRY"
+  exit 1
+fi
+
+npm --cache "$NPM_CACHE" publish --registry "$REGISTRY"

package/templates/dockerignore

@@ -0,0 +1,37 @@
+# Firestack default Docker build context ignore list.
+# Keep package manifests and lockfiles available for deterministic installs.
+
+.git
+.github
+.idea
+.vscode
+
+out
+coverage
+dist
+build
+tmp
+temp
+
+.cache
+.parcel-cache
+.next
+.nuxt
+.svelte-kit
+.turbo
+.nx
+
+.firebase
+firebase-debug.log*
+
+node_modules
+**/node_modules
+playwright-report
+test-results
+
+*.tsbuildinfo
+.DS_Store
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*

package/templates/env/.env.default.example

@@ -0,0 +1,4 @@
+# Default app environment
+GCLOUD_PROJECT=demo-your-project
+VITE_USE_FIREBASE_EMULATOR=true
+VITE_FIREBASE_EMULATOR_HOST=127.0.0.1

package/templates/env/.env.development.example

@@ -0,0 +1,4 @@
+# Development app environment
+GCLOUD_PROJECT=demo-your-project
+VITE_USE_FIREBASE_EMULATOR=true
+VITE_FIREBASE_EMULATOR_HOST=127.0.0.1

package/templates/env/.env.production.example

@@ -0,0 +1,2 @@
+# Production app environment
+GCLOUD_PROJECT=prod-your-project

package/templates/env/.env.staging.example

@@ -0,0 +1,4 @@
+# Staging app environment
+GCLOUD_PROJECT=staging-your-project
+E2E_BASE_URL=https://staging.example.com
+ALLOW_NON_STAGING_E2E=false

package/templates/env/.env.test.default.example

@@ -0,0 +1,6 @@
+# Default test environment
+GCLOUD_PROJECT=demo-your-project
+FIREBASE_AUTH_EMULATOR_HOST=127.0.0.1:9099
+FIRESTORE_EMULATOR_HOST=127.0.0.1:8080
+STRIPE_WEBHOOK_SECRET=whsec_test_123
+STRIPE_SECRET_KEY=sk_test_123

package/templates/env/.env.test.development.example

@@ -0,0 +1,6 @@
+# Development test environment
+GCLOUD_PROJECT=demo-your-project
+FIREBASE_AUTH_EMULATOR_HOST=127.0.0.1:9099
+FIRESTORE_EMULATOR_HOST=127.0.0.1:8080
+STRIPE_WEBHOOK_SECRET=whsec_test_123
+STRIPE_SECRET_KEY=sk_test_123

package/templates/env/.env.test.production.example

@@ -0,0 +1,4 @@
+# Production test environment
+GCLOUD_PROJECT=prod-your-project
+E2E_BASE_URL=https://app.example.com
+ALLOW_NON_STAGING_E2E=false

package/templates/env/.env.test.staging.example

@@ -0,0 +1,8 @@
+# Staging test environment
+GCLOUD_PROJECT=staging-your-project
+E2E_BASE_URL=https://staging.example.com
+ALLOW_NON_STAGING_E2E=false
+E2E_STAGING_SMOKE_EMAIL=e2e-smoke@example.com
+E2E_STAGING_SMOKE_PASSWORD=change-me
+E2E_STAGING_FULL_EMAIL=e2e-full@example.com
+E2E_STAGING_FULL_PASSWORD=change-me

package/templates/firestack.config.json

@@ -0,0 +1,101 @@
+{
+  "version": 1,
+  "env": {
+    "profiles": {
+      "default": {
+        "files": [
+          {
+            "target": ".env.default",
+            "template": "env/.env.default.example"
+          },
+          {
+            "target": ".env.test.default",
+            "template": "env/.env.test.default.example"
+          }
+        ]
+      },
+      "staging": {
+        "files": [
+          {
+            "target": ".env.staging",
+            "template": "env/.env.staging.example"
+          },
+          {
+            "target": ".env.test.staging",
+            "template": "env/.env.test.staging.example"
+          }
+        ]
+      },
+      "production": {
+        "files": [
+          {
+            "target": ".env.production",
+            "template": "env/.env.production.example"
+          },
+          {
+            "target": ".env.test.production",
+            "template": "env/.env.test.production.example"
+          }
+        ]
+      }
+    }
+  },
+  "test": {
+    "commands": {
+      "unit": "mkdir -p out/tests/unit && node --test --experimental-strip-types --test-reporter=spec --test-reporter=junit --test-reporter-destination=stdout --test-reporter-destination=out/tests/unit/junit.xml tests/unit/**/*.test.ts",
+      "integration": "firestack internal run-functions-build && firebase emulators:exec --project ${GCLOUD_PROJECT:?Set GCLOUD_PROJECT} \"firestack internal run-integration-report\"",
+      "e2eSmoke": "mkdir -p out/tests/e2e && rm -f out/tests/e2e/junit.xml && rm -rf out/tests/e2e/html out/tests/e2e/artifacts && firestack internal run-e2e smoke",
+      "e2eFull": "mkdir -p out/tests/e2e && rm -f out/tests/e2e/junit.xml && rm -rf out/tests/e2e/html out/tests/e2e/artifacts && firestack internal run-e2e full",
+      "stagingSmoke": "mkdir -p out/tests/e2e/staging && rm -f out/tests/e2e/staging/junit.xml && rm -rf out/tests/e2e/staging/html out/tests/e2e/staging/artifacts && firestack internal run-e2e-staging smoke",
+      "stagingFull": "mkdir -p out/tests/e2e/staging && rm -f out/tests/e2e/staging/junit.xml && rm -rf out/tests/e2e/staging/html out/tests/e2e/staging/artifacts && firestack internal run-e2e-staging full",
+      "ci": "mkdir -p out/tests/unit out/tests/e2e && rm -rf out/tests/e2e/html out/tests/e2e/artifacts && node --test --experimental-strip-types --test-reporter=spec --test-reporter=junit --test-reporter-destination=stdout --test-reporter-destination=out/tests/unit/junit.xml tests/unit/**/*.test.ts && firestack internal run-functions-build && firebase emulators:exec --project ${GCLOUD_PROJECT:?Set GCLOUD_PROJECT} \"bash -lc 'set +e; firestack internal run-integration-report; integration_status=\\$?; firestack internal run-e2e smoke; e2e_status=\\$?; set -e; if [ \\$integration_status -ne 0 ] || [ \\$e2e_status -ne 0 ]; then exit 1; fi'\"",
+      "ciFailFast": "mkdir -p out/tests/unit out/tests/e2e && rm -rf out/tests/e2e/html out/tests/e2e/artifacts && node --test --experimental-strip-types --test-reporter=spec --test-reporter=junit --test-reporter-destination=stdout --test-reporter-destination=out/tests/unit/junit.xml tests/unit/**/*.test.ts && firestack internal run-functions-build && firebase emulators:exec --project ${GCLOUD_PROJECT:?Set GCLOUD_PROJECT} \"firestack internal run-integration-report && firestack internal run-e2e smoke\""
+    },
+    "docker": {
+      "dockerfile": "tests/Dockerfile",
+      "imageBaseName": "firestack-tests",
+      "nodeModulesVolumePrefix": "firestack-node_modules-",
+      "functionsNodeModulesVolumePrefix": "firestack-functions-node_modules-",
+      "emulatorCacheVolumePrefix": "firestack-firebase-cache-",
+      "buildNetwork": "host",
+      "workdir": "/work",
+      "runAsHostUser": true,
+      "preloadFirestoreEmulator": true,
+      "writablePaths": [
+        "out"
+      ],
+      "bootstrapCommand": "if [ ! -d /work/node_modules/.bin ]; then mkdir -p /work/node_modules && cp -a /opt/deps/node_modules/. /work/node_modules/; fi && if [ -n \"${FIRESTACK_FUNCTIONS_PATHS:-}\" ]; then IFS=',' read -r -a firestack_functions <<< \"$FIRESTACK_FUNCTIONS_PATHS\"; for rel in \"${firestack_functions[@]}\"; do if [ -n \"$rel\" ] && [ -d \"/opt/deps/$rel/node_modules\" ] && [ -f \"/work/$rel/package.json\" ] && [ ! -d \"/work/$rel/node_modules/.bin\" ]; then mkdir -p \"/work/$rel/node_modules\" && cp -a \"/opt/deps/$rel/node_modules/.\" \"/work/$rel/node_modules/\"; fi; done; fi",
+      "cleanup": true,
+      "addHosts": [
+        "host.docker.internal:host-gateway"
+      ],
+      "passThroughEnv": [
+        "GCLOUD_PROJECT",
+        "FIREBASE_PROJECT_ALIAS",
+        "ALLOW_NON_STAGING_E2E",
+        "E2E_BASE_URL",
+        "E2E_CLEANUP",
+        "E2E_RUN_ID",
+        "E2E_EMAIL",
+        "E2E_PASSWORD",
+        "E2E_STAGING_EMAIL",
+        "E2E_STAGING_PASSWORD",
+        "E2E_STAGING_SMOKE_EMAIL",
+        "E2E_STAGING_SMOKE_PASSWORD",
+        "E2E_STAGING_FULL_EMAIL",
+        "E2E_STAGING_FULL_PASSWORD",
+        "E2E_APP_CHECK_DEBUG_TOKEN",
+        "FIREBASE_AUTH_EMULATOR_HOST",
+        "FIRESTORE_EMULATOR_HOST",
+        "VITE_USE_FIREBASE_EMULATOR",
+        "VITE_FIREBASE_EMULATOR_HOST",
+        "STRIPE_WEBHOOK_SECRET",
+        "STRIPE_SECRET_KEY"
+      ],
+      "registry": {
+        "defaultHostUrl": "http://127.0.0.1:4873",
+        "defaultDockerUrl": "http://host.docker.internal:4873"
+      }
+    }
+  }
+}

package/templates/playwright.config.mjs

@@ -0,0 +1,65 @@
+import { defineConfig, devices } from '@playwright/test';
+
+const baseURL = process.env.E2E_BASE_URL ?? 'http://127.0.0.1:5173';
+
+function normalizeHost(rawUrl) {
+  try {
+    return new URL(rawUrl).hostname.toLowerCase();
+  } catch {
+    return null;
+  }
+}
+
+export function resolvePlaywrightOutputBaseDir(env = process.env) {
+  const explicitJunit = env.PLAYWRIGHT_JUNIT_OUTPUT_FILE?.trim();
+  const explicitHtml = env.PLAYWRIGHT_HTML_OUTPUT_DIR?.trim();
+  const explicitArtifacts = env.PLAYWRIGHT_OUTPUT_DIR?.trim();
+  if (explicitJunit || explicitHtml || explicitArtifacts) {
+    return 'out/tests/e2e';
+  }
+
+  const profileAlias = env.FIREBASE_PROJECT_ALIAS?.trim().toLowerCase();
+  if (profileAlias === 'staging') {
+    return 'out/tests/e2e/staging';
+  }
+
+  const host = normalizeHost(env.E2E_BASE_URL?.trim());
+  if (host === 'staging.presentgoal.com') {
+    return 'out/tests/e2e/staging';
+  }
+
+  return 'out/tests/e2e';
+}
+
+const baseOutputDir = resolvePlaywrightOutputBaseDir(process.env);
+const junitOutputFile = process.env.PLAYWRIGHT_JUNIT_OUTPUT_FILE ?? `${baseOutputDir}/junit.xml`;
+const htmlOutputFolder = process.env.PLAYWRIGHT_HTML_OUTPUT_DIR ?? `${baseOutputDir}/html`;
+const outputDir = process.env.PLAYWRIGHT_OUTPUT_DIR ?? `${baseOutputDir}/artifacts`;
+
+export default defineConfig({
+  testDir: 'tests/e2e',
+  outputDir,
+  timeout: 30_000,
+  expect: {
+    timeout: 5_000,
+  },
+  fullyParallel: true,
+  retries: process.env.CI ? 1 : 0,
+  reporter: [
+    ['list'],
+    ['html', { outputFolder: htmlOutputFolder, open: 'never' }],
+    ['junit', { outputFile: junitOutputFile }],
+  ],
+  use: {
+    baseURL,
+    trace: 'retain-on-failure',
+    video: 'retain-on-failure',
+    screenshot: 'only-on-failure',
+  },
+  projects: [
+    {
+      name: 'chromium',
+      use: { ...devices['Desktop Chrome'] },
+    },
+  ],
+});

package/templates/tests.Dockerfile

@@ -0,0 +1,43 @@
+FROM mcr.microsoft.com/playwright:v1.58.2-noble AS base
+FROM eclipse-temurin:21-jre AS jre21
+FROM base
+
+USER root
+
+ARG FIREBASE_CONFIG_PATH=firebase.json
+ARG FIRESTACK_FUNCTIONS_INSTALL_PATHS=
+
+COPY --from=jre21 /opt/java/openjdk /opt/java/openjdk
+ENV JAVA_HOME=/opt/java/openjdk
+ENV PATH="${JAVA_HOME}/bin:${PATH}"
+
+WORKDIR /opt/deps
+
+COPY package*.json ./
+
+RUN --mount=type=cache,target=/root/.npm \
+  if [ -f package.json ]; then (npm ci || npm install); fi
+
+RUN npm install -g firebase-tools \
+  && mkdir -p /opt/firebase/emulators \
+  && FIREBASE_EMULATORS_PATH=/opt/firebase/emulators firebase setup:emulators:firestore
+
+COPY . .
+
+RUN --mount=type=cache,target=/root/.npm \
+  if [ -n "$FIRESTACK_FUNCTIONS_INSTALL_PATHS" ]; then \
+    printf '%s' "$FIRESTACK_FUNCTIONS_INSTALL_PATHS" | tr ',' '\n' > /tmp/firestack-functions-paths; \
+    while IFS= read -r rel || [ -n "$rel" ]; do \
+      [ -z "$rel" ] && continue; \
+      [ ! -f "$rel/package.json" ] && continue; \
+      (cd "$rel" && (npm ci || npm install)); \
+    done < /tmp/firestack-functions-paths; \
+  elif [ -f "$FIREBASE_CONFIG_PATH" ]; then \
+    FIREBASE_CONFIG_PATH="$FIREBASE_CONFIG_PATH" node -e "const fs=require('fs');const p=process.env.FIREBASE_CONFIG_PATH||'firebase.json';const cfg=JSON.parse(fs.readFileSync(p,'utf8'));const found=[];const add=(v)=>{if(typeof v!=='string')return;const n=v.trim().replace(/\\\\/g,'/').replace(/^\\.\\//,'');if(!n||n.startsWith('/')||n.includes('..'))return;if(fs.existsSync(n+'/package.json'))found.push(n);};const f=cfg.functions;if(typeof f==='string')add(f);else if(Array.isArray(f)){for(const e of f){if(typeof e==='string')add(e);else if(e&&typeof e==='object')add(e.source);}}else if(f&&typeof f==='object')add(f.source);process.stdout.write([...new Set(found)].join('\n'));" >/tmp/firestack-functions-paths; \
+    while IFS= read -r rel || [ -n "$rel" ]; do \
+      [ -z "$rel" ] && continue; \
+      (cd "$rel" && (npm ci || npm install)); \
+    done < /tmp/firestack-functions-paths; \
+  elif [ -f functions/package.json ]; then (cd functions && (npm ci || npm install)); fi
+
+WORKDIR /work