Merge pull request #124 from pwa-builder/4541-cloup-apk-referrer-anal…

…ytics #4541: Add referrer field to Cloud APK analytics
pwa-builder · Dec 13, 2023 · 8860909 · 8860909
2 parents bf146a1 + 8b70948
commit 8860909
Show file tree

Hide file tree

Showing 20 changed files with 29 additions and 493 deletions.
diff --git a/.gitignore b/.gitignore
@@ -12,7 +12,9 @@ pids
 *.pid.lock
 
 #remove js files
-build/*.js
+**/*.js
+**/*.js.map
+!static/*.js
 
 # Directory for instrumented libs generated by jscoverage/JSCover
 lib-cov

diff --git a/README.md b/README.md
@@ -9,11 +9,23 @@ This tool generates a zip file containing both an `.apk` file (for testing) and
 
 Please use our [main repository for any issues/bugs/features suggestion](https://github.com/pwa-builder/PWABuilder/issues/new/choose).
 
-# Running locally
+# Running Locally
 
-Run `npm start dev`, then launch your browser to localhost:3333. A page will launch that allows you to generate an Android package.
+You will need [Docker](https://www.docker.com/products/docker-desktop/) and the [Azure CLI](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli) to run this service locally.
 
-You may also generate a package manually by sending a POST to `/generateAppPackage` with the following JSON body:
+Steps:
+
+1. Run `az acr login -n pwabuilder` to authenticate with our Azure Container Registry.
+
+2. If you are testing locally, go to `Dockerfile` and change line 13 to `NODE_ENV=test`.
+
+3. Run `npm run docker:build` to build the Docker image, this may take a while the first time you run it.
+
+4. Once the build is complete, run `npm run docker:run` to start the Docker container.
+
+5. Visit `localhost` to see the CloudAPK testing interface.
+
+If you don't want to use the testing interface, you may also generate a package manually by sending a POST to `/generateAppPackage` with the following JSON body:
 
 ```json
 {    

diff --git a/app.js b/app.js
diff --git a/app.js.map b/app.js.map
diff --git a/build/analytics.js.map b/build/analytics.js.map
diff --git a/build/analytics.ts b/build/analytics.ts
@@ -46,12 +46,13 @@ export function trackEvent(
     console.error("App insights no defaultClient");
     return;
   }
-
+  
   var properties: any = {
     name: analyticsInfo.name,
     url: analyticsInfo.url,
     platformId: analyticsInfo.platformId,
     platformIdVersion: analyticsInfo.platformIdVersion,
+    referrer: analyticsInfo.referrer,
   };
 
   try {
@@ -87,4 +88,5 @@ export type AnalyticsInfo = {
   platformId: string | null;
   platformIdVersion: string | null;
   correlationId: string | null;
+  referrer: string | null;
 };
diff --git a/build/androidPackageOptions.js.map b/build/androidPackageOptions.js.map
diff --git a/build/appPackageRequest.js.map b/build/appPackageRequest.js.map
diff --git a/build/bubbleWrapper.js.map b/build/bubbleWrapper.js.map
diff --git a/build/generatedAppPackage.js.map b/build/generatedAppPackage.js.map
diff --git a/build/signingOptions.js.map b/build/signingOptions.js.map
diff --git a/build/urlLogger.js.map b/build/urlLogger.js.map
diff --git a/build/utils.js.map b/build/utils.js.map
diff --git a/env/test.env b/env/test.env
@@ -1,9 +1,9 @@
 # Environment
-NODE_ENV=testing
+NODE_ENV=test
 
 # Server
-PORT=4000
-HOST=localost
+PORT=80
+HOST=localhost
 
 JDK8PATH=/usr/lib/jvm/java-8-openjdk-amd64/
 ANDROIDTOOLSPATH=/opt/android-sdk

diff --git a/package.json b/package.json
@@ -5,10 +5,12 @@
   "main": "server.js",
   "type": "module",
   "scripts": {
-    "start": "NODE_ENV=production&& node ./server.js",
+    "start": "node ./server.js",
     "postinstall": "tsc",
     "dev": "node --inspect=5858 --loader ts-node/esm ./server.ts",
-    "build": "tsc"
+    "build": "tsc",
+    "docker:build": "docker build -t cloud-apk .",
+    "docker:run": "docker run -p 80:80 cloud-apk"
   },
   "repository": {
     "type": "git",