iframe logic support api.staging.onesignal.com

* When we switch to api.onesignal.com in the future for API calls the iframe will be opened the correct URL still.

Author: jkasten2

src/context/shared/utils/Utils.ts

@@ -137,6 +137,16 @@ export class Utils {
     return Number(`${majorVersion}.${minorVersion}`);
   }
 
+  /**
+   * Gives back the last x number of parts providing a string with a delimiter.
+   * Example: lastParts("api.staging.onesignal.com", ".", 3) will return "staging.onesignal.com"
+   */
+  public static lastParts(subject: string, delimiter: string, maxParts: number): string {
+    const parts = subject.split(delimiter);
+    const skipParts = Math.max(parts.length - maxParts, 0);
+    return parts.slice(skipParts).join(delimiter);
+  }
+
   /**
    * Checks if a version is number is greater than or equal (AKA at least) to a specific compare
    *   to version.

src/managers/AltOriginManager.ts

@@ -100,8 +100,8 @@ export default class AltOriginManager {
   static getCanonicalSubscriptionUrls(config: AppConfig,
                                       buildEnv: EnvironmentKind = SdkEnvironment.getApiEnv()
                                      ): Array<URL> {
-    const apiUrl = SdkEnvironment.getOneSignalApiUrl(buildEnv);
-    const legacyDomainUrl = new URL(`https://${config.subdomain}.${apiUrl.host}`);
+    const subscriptionDomain = AltOriginManager.getWildcardLegacySubscriptionDomain(buildEnv);
+    const legacyDomainUrl = new URL(`https://${config.subdomain}.${subscriptionDomain}`);
 
     // Staging and Dev don't support going through the os.tc domain
     if (buildEnv !== EnvironmentKind.Production) {
@@ -118,6 +118,23 @@ export default class AltOriginManager {
     return urls;
   }
 
+  /**
+   * Get the wildcard part of the legacy subscription domain.
+   * Examples: onesignal.com, staging.onesignal.com, or localhost
+   */
+  static getWildcardLegacySubscriptionDomain(buildEnv: EnvironmentKind): string {
+    const apiUrl = SdkEnvironment.getOneSignalApiUrl(buildEnv);
+
+    // Prod and Dev support domains like *.onesignal.com and *.localhost 
+    let envSubdomainParts: number = 2;
+    if (buildEnv === EnvironmentKind.Staging) {
+      // Allow up to 3 parts so *.staging.onesignal.com works.
+      envSubdomainParts = 3;
+    }
+
+    return Utils.lastParts(apiUrl.host, ".", envSubdomainParts);
+  }
+
   /**
    * Returns the URL of the OneSignal proxy iFrame helper.
    */

test/unit/managers/AltOriginManager.ts

@@ -43,6 +43,22 @@ test(`should get correct canonical subscription URL for staging environment`, as
   t.is(stagingUrls[0].host, new URL(`https://test.${stagingDomain}`).host);
 });
 
+
+test(`should get correct canonical subscription URL when api.staging.onesignal.com is used`, async t => {
+  const stagingDomain = "staging.onesignal.com";
+  (<any>global).__API_ORIGIN__ = `api.${stagingDomain}`; 
+  const config = TestEnvironment.getFakeAppConfig();
+  config.subdomain = 'test';
+  config.httpUseOneSignalCom = true;
+
+  const browser = await TestEnvironment.stubDomEnvironment();
+  browser.changeURL(window, `http://${stagingDomain}`);
+
+  const stagingUrlsOsTcDomain = AltOriginManager.getCanonicalSubscriptionUrls(config, EnvironmentKind.Staging);
+  t.is(stagingUrlsOsTcDomain.length, 1);
+  t.is(stagingUrlsOsTcDomain[0].host, new URL(`https://test.${stagingDomain}`).host);
+});
+
 test(`should get correct canonical subscription URL for production environment`, async t => {
   const config = TestEnvironment.getFakeAppConfig();
   config.subdomain = 'test';
@@ -60,6 +76,24 @@ test(`should get correct canonical subscription URL for production environment`,
   t.is(prodUrls[0].host, new URL('https://test.os.tc').host);
 });
 
+test(`should get correct canonical subscription URL for production environment with api. prefix`, async t => {
+  (<any>global).__API_ORIGIN__ = `api.onesignal.com`; 
+  const config = TestEnvironment.getFakeAppConfig();
+  config.subdomain = 'test';
+  config.httpUseOneSignalCom = true;
+
+  const prodUrlsOsTcDomain = AltOriginManager.getCanonicalSubscriptionUrls(config, EnvironmentKind.Production);
+  t.is(prodUrlsOsTcDomain.length, 2);
+  t.is(prodUrlsOsTcDomain[0].host, new URL('https://test.os.tc').host);
+  t.is(prodUrlsOsTcDomain[1].host, new URL('https://test.onesignal.com').host);
+
+  config.httpUseOneSignalCom = false;
+  
+  const prodUrls = AltOriginManager.getCanonicalSubscriptionUrls(config, EnvironmentKind.Production);
+  t.is(prodUrls.length, 1);
+  t.is(prodUrls[0].host, new URL('https://test.os.tc').host);
+});
+
 function setupDiscoverAltOriginTest(t: any) {
   const appConfig = TestEnvironment.getFakeAppConfig();
   appConfig.subdomain = 'test';