wip

Author: silesky

.github/workflows/ci.yml

@@ -5,6 +5,33 @@ env:
   HUSKY: 0
   PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: 1
 jobs:
+ deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: '20.x'
+          cache: 'yarn'
+
+      - name: Installing Dependencies
+        run: yarn install
+
+      - name: Building App
+        run: yarn build
+        env:
+          REACT_APP_SEGMENT_WRITE_KEY: ${{ secrets.REACT_APP_SEGMENT_WRITE_KEY }}
+
+      - name: Deploy with gh-pages
+        run: |
+          git remote set-url origin https://git:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
+          npx gh-pages -d build -u "github-actions-bot <[email protected]>"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
   analytics-node:
     name: 'analytics-node QA (Node.js v${{ matrix.node-version }})'
     runs-on: ubuntu-latest

.github/workflows/deploy-signals-example-to-github-pages.yml

@@ -0,0 +1,41 @@
+name: Deploy Signals Example to GH pages
+
+on:
+  push:
+    branches:
+      # - main
+      - deploy-signals-example
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: '20.x'
+          cache: 'yarn'
+
+      - name: Change Directory to signals-example
+        run: cd packages/signals/signals-example
+
+      - name: Installing Dependencies
+        run: yarn install
+        working-directory: packages/signals/signals-example
+
+      - name: Building App
+        run: yarn build
+        env:
+          REACT_APP_SEGMENT_WRITE_KEY: ${{ secrets.REACT_APP_SEGMENT_WRITE_KEY }}
+        working-directory: packages/signals/signals-example
+
+      - name: Deploy with gh-pages
+        run: |
+          git remote set-url origin https://git:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
+          npx gh-pages -d build -u "github-actions-bot <[email protected]>"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        working-directory: packages/signals/signals-example

packages/signals/signals-example/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@internal/signals-example",
   "private": true,
+  "homepage": "https://segmentio.github.io/<repository-name>/my-test-site",
   "scripts": {
     ".": "yarn run -T turbo run --filter=@internal/signals-example...",
     "dev": "webpack serve",

packages/signals/signals-example/src/lib/analytics.ts

@@ -4,11 +4,72 @@
 import { AnalyticsBrowser } from '@segment/analytics-next'
 import { SignalsPlugin, ProcessSignal } from '@segment/analytics-signals'
 
-export const analytics = new AnalyticsBrowser()
-if (!process.env.WRITEKEY) {
+// Function to get query string parameters
+
+const STORAGE_TYPE: 'localStorage' | 'sessionStorage' = 'localStorage'
+
+// Function to set localStorage from query string parameters
+
+const queryParams = {
+  STAGE_KEY_NAME: 'stage',
+  WRITE_KEY_NAME: 'wk',
+  RESET_KEY_NAME: 'reset',
+}
+
+const Storage = () => {
+  const getQueryParams = () => {
+    const params = new URLSearchParams(window.location.search)
+    const stage = params.get(queryParams.STAGE_KEY_NAME)
+    const writeKey = params.get(queryParams.WRITE_KEY_NAME)
+    const reset = params.get(queryParams.RESET_KEY_NAME)
+    return { stage, writeKey, reset }
+  }
+
+  const clearStorage = () => {
+    window[STORAGE_TYPE].removeItem(queryParams.STAGE_KEY_NAME)
+    window[STORAGE_TYPE].removeItem(queryParams.WRITE_KEY_NAME)
+  }
+  const setStorage = () => {
+    const { stage, writeKey, reset } = getQueryParams()
+
+    if (stage !== null) {
+      window[STORAGE_TYPE].setItem(queryParams.STAGE_KEY_NAME, stage)
+    }
+    if (writeKey !== null) {
+      window[STORAGE_TYPE].setItem(queryParams.WRITE_KEY_NAME, writeKey)
+    }
+    if (reset !== null) {
+      clearStorage()
+    }
+  }
+
+  setStorage()
+  return {
+    getStorage: () => {
+      return {
+        stage: window[STORAGE_TYPE].getItem(queryParams.STAGE_KEY_NAME),
+        writeKey: window[STORAGE_TYPE].getItem(queryParams.WRITE_KEY_NAME),
+      }
+    },
+  }
+}
+
+// Set localStorage from query string parameters
+const storage = Storage()
+
+// Retrieve values from localStorage or fall back to environment variables
+const isStage =
+  storage.getStorage().stage === 'true' || process.env.STAGE === 'true'
+const writeKey = storage.getStorage().writeKey || process.env.WRITEKEY
+
+if (!writeKey) {
   throw new Error('No writekey provided.')
 }
 
+console.log('Query params allowed:', JSON.stringify(Object.values(queryParams)))
+
+export const analytics = new AnalyticsBrowser()
+
 const processSignalExample: ProcessSignal = (
   signal,
   { analytics, signals }
@@ -29,8 +90,6 @@ const processSignalExample: ProcessSignal = (
   }
 }
 
-const isStage = process.env.STAGE === 'true'
-
 const signalsPlugin = new SignalsPlugin({
   ...(isStage ? { apiHost: 'signals.segment.build/v1' } : {}),
   // enableDebugLogging: true,
@@ -41,7 +100,7 @@ export const loadAnalytics = () =>
   analytics
     .load(
       {
-        writeKey: process.env.WRITEKEY!,
+        writeKey: writeKey,
         plugins: [signalsPlugin],
         ...(isStage ? { cdnURL: 'https://cdn.segment.build' } : {}),
       },
@@ -58,7 +117,7 @@ export const loadAnalytics = () =>
       }
     )
     .then(() => {
-      console.log(`Analytics loaded with WRITEKEY=${process.env.WRITEKEY}`)
+      console.log(`Analytics loaded with WRITEKEY=${writeKey}`)
       // @ts-ignore
       window.analytics = analytics // for debugging
     })