Web Client Library (grouparoo#208)

* wip: web client * code-quote #userId * default value for cookieTTL * script highlighting * readme updates and remove new_session event * remove WS test file * cookies for userId, anonymousId, and sessionId * testing for the client library * include the clients/*/* * update and match typescript versions * browser test page * build both commonjs and browser modules * also cache the client dist * split ci cache into chunks * remove custom-cache-options * update web client dist path * ensure publicJSDir exists
etxeba · Jun 11, 2020 · 7a04d65 · 7a04d65
1 parent b2e56e9
commit 7a04d65
Show file tree

Hide file tree

Showing 59 changed files with 9,187 additions and 88 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -9,8 +9,12 @@ references:
     branches:
       ignore:
         - gh-pages
-  cache-options: &cache-options
-    key: package-cache-{{ .Branch }}-{{ .Revision }}
+  node-module-cache-options: &node-module-cache-options
+    key: node-module-package-cache-{{ .Branch }}-{{ .Revision }}
+  dist-cache-options: &dist-cache-options
+    key: dist-package-cache-{{ .Branch }}-{{ .Revision }}
+  core-cache-options: &core-cache-options
+    key: core-package-cache-{{ .Branch }}-{{ .Revision }}
 #
 # Define Jobs to run
 jobs:
@@ -19,17 +23,16 @@ jobs:
       - image: circleci/node:12
     steps:
       - checkout
-      - restore_cache:
-          <<: *cache-options
       - run: sudo apt-get install -y rsync
       - run:
           name: npm-install
           command: npm install
       - save_cache:
-          <<: *cache-options
+          <<: *node-module-cache-options
           paths:
             - apps/local-public/node_modules
             - apps/staging-public/node_modules
+            - clients/@grouparoo/web/node_modules
             - core/node_modules
             - node_modules
             - plugins/@grouparoo/bigquery/node_modules
@@ -46,6 +49,10 @@ jobs:
             - plugins/@grouparoo/sailthru/node_modules
             - plugins/@grouparoo/sample-ui-plugin/node_modules
             - tools/merger/node_modules
+      - save_cache:
+          <<: *dist-cache-options
+          paths:
+            - clients/@grouparoo/web/dist
             - plugins/@grouparoo/bigquery/dist
             - plugins/@grouparoo/csv/dist
             - plugins/@grouparoo/email-authentication/dist
@@ -59,6 +66,9 @@ jobs:
             - plugins/@grouparoo/postgres/dist
             - plugins/@grouparoo/sailthru/dist
             - plugins/@grouparoo/sample-ui-plugin/dist
+      - save_cache:
+          <<: *core-cache-options
+          paths:
             - core/api/dist
             - core/web/.next
   license-checker:
@@ -67,7 +77,11 @@ jobs:
     steps:
       - checkout
       - restore_cache:
-          <<: *cache-options
+          <<: *node-module-cache-options
+      - restore_cache:
+          <<: *dist-cache-options
+      - restore_cache:
+          <<: *core-cache-options
       - run:
           name: license-checker
           command: ./tools/license-checker/check
@@ -77,7 +91,11 @@ jobs:
     steps:
       - checkout
       - restore_cache:
-          <<: *cache-options
+          <<: *node-module-cache-options
+      - restore_cache:
+          <<: *dist-cache-options
+      - restore_cache:
+          <<: *core-cache-options
       - run:
           name: linter
           command: npm run lint
@@ -92,7 +110,11 @@ jobs:
     steps:
       - checkout
       - restore_cache:
-          <<: *cache-options
+          <<: *node-module-cache-options
+      - restore_cache:
+          <<: *dist-cache-options
+      - restore_cache:
+          <<: *core-cache-options
       - run:
           name: install postgresql client
           command: sudo apt install -y postgresql-client
@@ -121,7 +143,11 @@ jobs:
     steps:
       - checkout
       - restore_cache:
-          <<: *cache-options
+          <<: *node-module-cache-options
+      - restore_cache:
+          <<: *dist-cache-options
+      - restore_cache:
+          <<: *core-cache-options
       - run:
           name: install postgresql client
           command: sudo apt install -y postgresql-client
@@ -153,7 +179,11 @@ jobs:
     steps:
       - checkout
       - restore_cache:
-          <<: *cache-options
+          <<: *node-module-cache-options
+      - restore_cache:
+          <<: *dist-cache-options
+      - restore_cache:
+          <<: *core-cache-options
       - add_ssh_keys:
           fingerprints:
             - 49:46:31:67:74:97:c4:66:44:79:89:67:29:41:89:96

diff --git a/.gitignore b/.gitignore
@@ -11,21 +11,18 @@ newrelic_agent.log
 coverage
 
 # API
-api/public/javascript/ActionheroWebsocketClient.js
-api/public/javascript/ActionheroWebsocketClient.min.js
 log
 pids
 dist
 core/api/files
 core/api/report.*.json
-core/web/public/javascript/ActionheroWebsocketClient.js
-core/web/public/javascript/ActionheroWebsocketClient.min.js
 core/api/docs
 core/api/gh-pages
 
 # Web
 .next
 web/out
+core/web/public/javascript/*
 
 # Builds
 *.tgz

diff --git a/clients/@grouparoo/web/.npmignore b/clients/@grouparoo/web/.npmignore
@@ -0,0 +1,10 @@
+# General
+node_modules
+.DS_Store
+.vscode
+npm-debug.log
+yarn-error.log
+.env
+dump.rdb
+*.retry
+coverage