Merge pull request #888 from OneSignal/improvement/no-port-flag

rgomezp · web-flow · commit 0c1f7857e071 · 2022-06-22T19:39:40.000-05:00
Improvement/no port flag
diff --git a/build/config/page-sdk-es6.config.js b/build/config/page-sdk-es6.config.js
@@ -12,6 +12,7 @@ const apiOrigin = process.env.API_ORIGIN || "onesignal.com"
 const isProdBuild = process.env.ENV === "production";
 const nodeEnv = isProdBuild ? "production" : "development";
 const isHttps = process.env.HTTPS;
+const noDevPort = process.env.NO_DEV_PORT;
 const tests = process.env.TESTS;
 const sdkVersion = process.env.npm_package_config_sdkVersion;
 
@@ -26,6 +27,7 @@ async function getWebpackPlugins() {
         __API_TYPE__: JSON.stringify(apiEnv),
         __API_ORIGIN__: JSON.stringify(apiOrigin),
         __IS_HTTPS__: isHttps === "true",
+        __NO_DEV_PORT__: noDevPort === "true",
         __TEST__: !!tests,
         __VERSION__: sdkVersion,
         __LOGGING__: env === "development",
diff --git a/build/config/sdk.config.js b/build/config/sdk.config.js
@@ -15,6 +15,7 @@ const apiOrigin = process.env.API_ORIGIN || "localhost";
 const isProdBuild = process.env.ENV === "production";
 const nodeEnv = isProdBuild ? "production" : "development";
 const isHttps = process.env.HTTPS;
+const noDevPort = process.env.NO_DEV_PORT;
 const tests = process.env.TESTS;
 const sdkVersion = process.env.npm_package_config_sdkVersion;
 
@@ -63,6 +64,7 @@ async function getWebpackPlugins() {
         __API_TYPE__: JSON.stringify(apiEnv),
         __API_ORIGIN__: JSON.stringify(apiOrigin),
         __IS_HTTPS__: isHttps === "true",
+        __NO_DEV_PORT__: noDevPort === "true",
         __TEST__: !!tests,
         __VERSION__: sdkVersion,
         __LOGGING__: env === "development",
diff --git a/build/config/serviceworker.config.js b/build/config/serviceworker.config.js
@@ -11,6 +11,7 @@ const apiOrigin = process.env.API_ORIGIN || "localhost";
 const isProdBuild = process.env.ENV === "production";
 const nodeEnv = isProdBuild ? "production" : "development";
 const isHttps = process.env.HTTPS;
+const noDevPort = process.env.NO_DEV_PORT;
 const tests = process.env.TESTS;
 const sdkVersion = process.env.npm_package_config_sdkVersion;
 
@@ -24,6 +25,7 @@ async function getWebpackPlugins() {
       __API_TYPE__: JSON.stringify(apiEnv),
       __API_ORIGIN__: JSON.stringify(apiOrigin),
       __IS_HTTPS__: isHttps === "true",
+      __NO_DEV_PORT__: noDevPort === "true",
       __TEST__: !!tests,
       __VERSION__: sdkVersion,
       __LOGGING__: env === "development",
diff --git a/build/config/webpack.config.js b/build/config/webpack.config.js
@@ -202,6 +202,7 @@ async function getBuildDefines() {
     __API_TYPE__: process.env.API,
     __API_ORIGIN__: process.env.API_ORIGIN,
     __IS_HTTPS__: process.env.HTTPS,
+    __NO_DEV_PORT__: process.env.NO_DEV_PORT,
     __TEST__: !!process.env.TESTS,
     __VERSION__: process.env.npm_package_config_sdkVersion,
     __LOGGING__: process.env.ENV === "development",
diff --git a/build/scripts/build.sh b/build/scripts/build.sh
@@ -31,6 +31,10 @@ case $key in
     HTTPS=false
     shift # past argument
     ;;
+    --no-port)
+    NO_DEV_PORT=true
+    shift # past argument
+    ;;
     *)    # unknown option
     POSITIONAL+=("$1") # save it in an array for later
     shift # past argument
@@ -43,6 +47,8 @@ API_ORIGIN=${API_ORIGIN:-"onesignal.com"}
 ENV=${ENV:-"development"}
 API=${API:-"production"}
 HTTPS=${HTTPS:-true}
+NO_DEV_PORT=${NO_DEV_PORT:-false}
+
 
 if [ "$ENV" = "staging" ]; then
     API="staging"
@@ -55,12 +61,15 @@ echo "API_ORIGIN = ${API_ORIGIN}"
 echo "HTTPS = ${HTTPS}"
 echo "ENV = ${ENV}"
 echo "API = ${API}"
+echo "NO_DEV_PORT = ${NO_DEV_PORT}"
 echo "Unknown options -> ${POSITIONAL}"
 set -- "${POSITIONAL[@]}" # restore positional parameters
 
+# build local SW file for dev env
+./build/scripts/buildServiceWorker.sh $BUILD_ORIGIN
 
-ENV=$ENV API=$API BUILD_ORIGIN=$BUILD_ORIGIN API_ORIGIN=$API_ORIGIN HTTPS=$HTTPS yarn transpile:sources
-ENV=$ENV API=$API BUILD_ORIGIN=$BUILD_ORIGIN API_ORIGIN=$API_ORIGIN HTTPS=$HTTPS yarn bundle-sw
-ENV=$ENV API=$API BUILD_ORIGIN=$BUILD_ORIGIN API_ORIGIN=$API_ORIGIN HTTPS=$HTTPS yarn bundle-sdk
-ENV=$ENV API=$API BUILD_ORIGIN=$BUILD_ORIGIN API_ORIGIN=$API_ORIGIN HTTPS=$HTTPS yarn bundle-page-sdk-es6
-ENV=$ENV API=$API BUILD_ORIGIN=$BUILD_ORIGIN API_ORIGIN=$API_ORIGIN HTTPS=$HTTPS ./build/scripts/publish.sh
+ENV=$ENV API=$API BUILD_ORIGIN=$BUILD_ORIGIN API_ORIGIN=$API_ORIGIN HTTPS=$HTTPS NO_DEV_PORT=$NO_DEV_PORT yarn transpile:sources
+ENV=$ENV API=$API BUILD_ORIGIN=$BUILD_ORIGIN API_ORIGIN=$API_ORIGIN HTTPS=$HTTPS NO_DEV_PORT=$NO_DEV_PORT yarn bundle-sw
+ENV=$ENV API=$API BUILD_ORIGIN=$BUILD_ORIGIN API_ORIGIN=$API_ORIGIN HTTPS=$HTTPS NO_DEV_PORT=$NO_DEV_PORT yarn bundle-sdk
+ENV=$ENV API=$API BUILD_ORIGIN=$BUILD_ORIGIN API_ORIGIN=$API_ORIGIN HTTPS=$HTTPS NO_DEV_PORT=$NO_DEV_PORT yarn bundle-page-sdk-es6
+ENV=$ENV API=$API BUILD_ORIGIN=$BUILD_ORIGIN API_ORIGIN=$API_ORIGIN HTTPS=$HTTPS NO_DEV_PORT=$NO_DEV_PORT ./build/scripts/publish.sh
diff --git a/build/scripts/buildServiceWorker.sh b/build/scripts/buildServiceWorker.sh
@@ -0,0 +1,4 @@
+#!/bin/bash
+
+# Builds the local service worker file for express_webpack for use in local dev env
+echo "importScripts(\"https://${1}/sdks/Dev-OneSignalSDKWorker.js\");" > express_webpack/push/onesignal/OneSignalSDKWorker.js
diff --git a/express_webpack/README.md b/express_webpack/README.md
@@ -2,8 +2,8 @@
 ## WebSDK Sandbox Environment
 ### Run Instructions
 1. `docker-compose up`
-   - If SSL certs need to be created, this will be done for you automatically with the common name default setting `texas` and alternative DNS names (this can be customized in `certs/gen-cert.sh`):
-      - localhost
+   - If SSL certs need to be created, this will be done for you automatically with the common name default setting `localhost` and alternative DNS names (this can be customized in `certs/gen-cert.sh`):
+      - texas
       - california
       - oregon
       - washington
@@ -75,6 +75,8 @@ All builds default to `https` unless `--http` is passed to the end of the build
    - HTTP: `4000`
    - HTTPS: `4001`
 
+Use the **`--no-port`** build flag to build without a port number. This is useful when using a reverse proxy like [ngrok](https://ngrok.com/) to serve your localhost environment on the web.
+
 **API**: dev-environment API calls will be made to the `3001` port (e.g: `<custom-origin>:3001`)
 
 ### Running in Combination with OneSignal Container (dev-dev)
diff --git a/express_webpack/push/onesignal/OneSignalSDKUpdaterWorker.js b/express_webpack/push/onesignal/OneSignalSDKUpdaterWorker.js
diff --git a/src/managers/SdkEnvironment.ts b/src/managers/SdkEnvironment.ts
@@ -289,7 +289,7 @@ export default class SdkEnvironment {
 
     switch (buildEnv) {
       case EnvironmentKind.Development:
-        origin = `${protocol}://${buildOrigin}:${port}`;
+        origin = __NO_DEV_PORT__ ? `${protocol}://${buildOrigin}` : `${protocol}://${buildOrigin}:${port}`;
         break;
       case EnvironmentKind.Staging:
         origin = `https://${buildOrigin}`;
diff --git a/src/utils/OneSignalShimLoader.ts b/src/utils/OneSignalShimLoader.ts
@@ -33,7 +33,7 @@ export class OneSignalShimLoader {
 
     switch(__BUILD_TYPE__){
       case "development":
-        return `${protocol}://${buildOrigin}:${port}/sdks/Dev-`;
+        return __NO_DEV_PORT__ ? `${protocol}://${buildOrigin}/sdks/Dev-` : `${protocol}://${buildOrigin}:${port}/sdks/Dev-`;
       case "staging":
         return `https://${buildOrigin}/sdks/Staging-`;
       default:
diff --git a/typings/globals/missing.d.ts b/typings/globals/missing.d.ts
@@ -34,6 +34,7 @@ declare var OneSignal: any;
 // These __*__ variables are defined from Webpack to change resulting JS
 declare var __VERSION__: string;
 declare var __BUILD_TYPE__: string;
+declare var __NO_DEV_PORT__: string;
 declare var __BUILD_ORIGIN__: string;
 declare var __API_TYPE__: string;
 declare var __API_ORIGIN__: string;
