caching

Author: mykola-mokhnach

lib/webdriveragent.ts

@@ -404,12 +404,14 @@ export class WebDriverAgent {
   /**
    * Reuse running WDA if it has the same bundle id with updatedWDABundleId.
    * Or reuse it if it has the default id without updatedWDABundleId.
+   *
+   * @returns The WDA URL used for caching on success, or `undefined` if caching was skipped.
    */
-  async setupCaching(): Promise<void> {
+  async setupCaching(): Promise<string | undefined> {
     const status = await this.getStatus(0);
     if (!status || !status.build) {
       this.log.debug('WDA is currently not running. There is nothing to cache');
-      return;
+      return undefined;
     }
 
     const {productBundleIdentifier, upgradedAt} = status.build as any;
@@ -422,7 +424,7 @@ export class WebDriverAgent {
       this.log.info(
         `Will not reuse running WDA since it has different bundle id. The actual value is '${productBundleIdentifier}'.`,
       );
-      return;
+      return undefined;
     }
     // for simulator
     if (
@@ -433,7 +435,7 @@ export class WebDriverAgent {
       this.log.info(
         `Will not reuse running WDA since its bundle id is not equal to the default value ${WDA_RUNNER_BUNDLE_ID}`,
       );
-      return;
+      return undefined;
     }
 
     const actualUpgradeTimestamp = await getWDAUpgradeTimestamp();
@@ -448,16 +450,18 @@ export class WebDriverAgent {
         'Will not reuse running WDA since it has different version in comparison to the one ' +
           `which is bundled with appium-xcuitest-driver module (${actualUpgradeTimestamp} != ${upgradedAt})`,
       );
-      return;
+      return undefined;
     }
 
+    const cachedUrl = this.url.href;
     const message = util.hasValue(productBundleIdentifier)
-      ? `Will reuse previously cached WDA instance at '${this.url.href}' with '${productBundleIdentifier}'`
-      : `Will reuse previously cached WDA instance at '${this.url.href}'`;
+      ? `Will reuse previously cached WDA instance at '${cachedUrl}' with '${productBundleIdentifier}'`
+      : `Will reuse previously cached WDA instance at '${cachedUrl}'`;
     this.log.info(
       `${message}. Set the wdaLocalPort capability to a value different from ${this.url.port} if this is an undesired behavior.`,
     );
-    this.webDriverAgentUrl = this.url.href;
+    this.webDriverAgentUrl = cachedUrl;
+    return cachedUrl;
   }
 
   private setupProxies(sessionId: string): void {

test/unit/webdriveragent-specs.ts

@@ -251,7 +251,7 @@ describe('WebDriverAgent', function () {
         return null;
       });
 
-      await wda.setupCaching();
+      expect(await wda.setupCaching()).to.be.undefined;
       expect(wdaStub.calledOnce).to.be.true;
       expect(wda.webDriverAgentUrl === undefined).to.be.true;
     });
@@ -261,7 +261,7 @@ describe('WebDriverAgent', function () {
         return {build: {time: 'Jun 24 2018 17:08:21'}};
       });
 
-      await wda.setupCaching();
+      expect(await wda.setupCaching()).to.equal('http://127.0.0.1:8100/');
       expect(wdaStub.calledOnce).to.be.true;
       expect(wda.webDriverAgentUrl).to.equal('http://127.0.0.1:8100/');
     });
@@ -276,7 +276,7 @@ describe('WebDriverAgent', function () {
         };
       });
 
-      await wda.setupCaching();
+      expect(await wda.setupCaching()).to.be.undefined;
       expect(wdaStub.calledOnce).to.be.true;
       expect(wda.webDriverAgentUrl === undefined).to.be.true;
     });
@@ -291,7 +291,7 @@ describe('WebDriverAgent', function () {
         };
       });
 
-      await wda.setupCaching();
+      expect(await wda.setupCaching()).to.be.undefined;
       expect(wdaStub.calledOnce).to.be.true;
       expect(wda.webDriverAgentUrl === undefined).to.be.true;
     });
@@ -312,7 +312,7 @@ describe('WebDriverAgent', function () {
         };
       });
 
-      await wda.setupCaching();
+      expect(await wda.setupCaching()).to.equal('http://127.0.0.1:8100/');
       expect(wdaStub.calledOnce).to.be.true;
       expect(wda.webDriverAgentUrl).to.equal('http://127.0.0.1:8100/');
     });
@@ -323,7 +323,7 @@ describe('WebDriverAgent', function () {
       });
       getTimestampStub.callsFake(async () => 2);
 
-      await wda.setupCaching();
+      expect(await wda.setupCaching()).to.be.undefined;
       expect(wdaStub.calledOnce).to.be.true;
       expect(wda.webDriverAgentUrl === undefined).to.be.true;
     });
@@ -334,7 +334,7 @@ describe('WebDriverAgent', function () {
       });
       getTimestampStub.callsFake(async () => 1);
 
-      await wda.setupCaching();
+      expect(await wda.setupCaching()).to.equal('http://127.0.0.1:8100/');
       expect(wdaStub.calledOnce).to.be.true;
       expect(wda.webDriverAgentUrl).to.equal('http://127.0.0.1:8100/');
     });
@@ -345,7 +345,7 @@ describe('WebDriverAgent', function () {
       });
       getTimestampStub.callsFake(async () => 1);
 
-      await wda.setupCaching();
+      expect(await wda.setupCaching()).to.equal('http://127.0.0.1:8100/');
       expect(wdaStub.calledOnce).to.be.true;
       expect(wda.webDriverAgentUrl).to.equal('http://127.0.0.1:8100/');
     });
@@ -356,7 +356,7 @@ describe('WebDriverAgent', function () {
       });
       getTimestampStub.callsFake(async () => null);
 
-      await wda.setupCaching();
+      expect(await wda.setupCaching()).to.equal('http://127.0.0.1:8100/');
       expect(wdaStub.calledOnce).to.be.true;
       expect(wda.webDriverAgentUrl).to.equal('http://127.0.0.1:8100/');
     });