Improve test coverage (close snowplow#861)

Author: Paul Boocock

.github/workflows/build.yml

@@ -3,7 +3,7 @@ name: Build
 on: 
   push:
     branches:
-      - '**' # Prevents builds on tag
+      - 'master'
   pull_request:
 
 jobs:
@@ -55,7 +55,7 @@ jobs:
       if: ${{ env.SAUCE_ACCESS_KEY != '' }}
       uses: softprops/turnstyle@v1
       with:
-        poll-interval-seconds: 10
+        poll-interval-seconds: 20
         same-branch-only: false
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/deploy_tracker.yml

@@ -50,23 +50,6 @@ jobs:
       - name: Test tracker
         run: npm run test:unit
 
-      - name: Block Concurrent Executions of E2E Tests
-        if: ${{ env.SAUCE_ACCESS_KEY != '' }}
-        uses: softprops/turnstyle@v1
-        with:
-          poll-interval-seconds: 10
-          same-branch-only: false
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-  
-      - name: Add Host for Saucelabs Tunnel
-        if: ${{ env.SAUCE_ACCESS_KEY != '' }}
-        run: echo "127.0.0.1 snowplow-js-tracker.local" | sudo tee -a /etc/hosts
-  
-      - name: Run End to End Tests
-        run: npm run test:e2e:sauce
-        if: ${{ env.SAUCE_ACCESS_KEY != '' }}
-
       - name: Get tag and tracker version information
         id: version
         run: |

src/js/out_queue.js

@@ -382,6 +382,8 @@ export function OutQueueManager(
           executeQueue();
         }
       }, connectionTimeout);
+    } else {
+      executingQueue = false;
     }
   }
 
@@ -447,7 +449,7 @@ export function OutQueueManager(
 
   return {
     enqueueRequest: enqueueRequest,
-    executeQueue: executeQueue,
+    executeQueue: () => { if (!executingQueue) { executeQueue(); } },
     setUseLocalStorage: (localStorage) => { useLocalStorage = localStorage; },
     setAnonymousTracking: (anonymous) => { anonymousTracking = anonymous; }
   };

src/js/tracker.js

@@ -3081,16 +3081,11 @@ export function Tracker(functionName, namespace, version, mutSnowplowState, argm
    */
   apiMethods.disableAnonymousTracking = function (stateStorageStrategy) {
     if (stateStorageStrategy) {
-      Object.assign(argmap, {
-        stateStorageStrategy: stateStorageStrategy,
-        anonymousTracking: false,
-      });
-
+      argmap.stateStorageStrategy = stateStorageStrategy;
+      argmap.anonymousTracking = false;
       configStateStorageStrategy = getStateStorageStrategy(argmap);
     } else {
-      Object.assign(argmap, {
-        anonymousTracking: false,
-      });
+      argmap.anonymousTracking = false;
     }
 
     configAnonymousTracking = getAnonymousTracking(argmap);
@@ -3109,9 +3104,7 @@ export function Tracker(functionName, namespace, version, mutSnowplowState, argm
    * Enables anonymous tracking (ie. tracker initialized without `anonymousTracking`)
    */
   apiMethods.enableAnonymousTracking = function (anonymousArgs) {
-    Object.assign(argmap, {
-      anonymousTracking: anonymousArgs || true,
-    });
+    argmap.anonymousTracking = anonymousArgs || true;
 
     configAnonymousTracking = getAnonymousTracking(argmap);
     configAnonymousSessionTracking = getAnonymousSessionTracking(argmap);

tests/functional/cookies.spec.js

@@ -0,0 +1,76 @@
+/*
+ * JavaScript tracker for Snowplow: tests/functional/cookies.spec.js
+ *
+ * Significant portions copyright 2010 Anthon Pang. Remainder copyright
+ * 2012-2020 Snowplow Analytics Ltd. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ *   notice, this list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ *
+ * * Neither the name of Anthon Pang nor Snowplow Analytics Ltd nor the
+ *   names of their contributors may be used to endorse or promote products
+ *   derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+describe('Tracker created domain cookies', () => {
+  it('contain the expected cookie names', () => {
+    browser.url('/cookies.html')
+    browser.waitUntil(
+      () => $('#init').getText() === 'true',
+      5000,
+      'expected init after 5s'
+    )
+
+    browser.waitUntil(
+      () => $('#cookies').getText() !== '',
+      5000,
+      'expected cookie to be set after 5s'
+    )
+
+    const cookies = $('#cookies').getText();
+
+    expect(cookies).not.toContain('_sp_0ses.'); // Missing as tests are not HTTPS and `cookieSecure: true` by default
+    expect(cookies).not.toContain('_sp_0id.');
+    expect(cookies).not.toContain('_sp_3es.'); // Missing as cookie lifetime is too short (1)
+    expect(cookies).not.toContain('_sp_3id.');
+    expect(cookies).not.toContain('_sp_4ses.'); // Missing as anonymous tracking enabled
+    expect(cookies).not.toContain('_sp_4id.');
+    expect(cookies).not.toContain('_sp_5ses.'); // Missing as only using local storage
+    expect(cookies).not.toContain('_sp_5id.');
+    expect(cookies).not.toContain('_sp_7ses.'); // Can't set a cookie for another domain
+    expect(cookies).not.toContain('_sp_7id.');
+
+    expect(cookies).toContain('_sp_1ses.');
+    expect(cookies).toContain('_sp_1id.');
+    expect(cookies).toContain('_sp_2ses.');
+    expect(cookies).toContain('_sp_2id.');
+    expect(cookies).toContain('_sp_6ses.');
+    expect(cookies).toContain('_sp_6id.');
+
+    expect($('#getDomainUserId').getText()).toMatch(/\b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b/i);
+    expect($('#getDomainUserInfo').getText()).toMatch(/\b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b.[0-9]+.[0-9].[0-9]+.[0-9]+.\b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b/i);
+    expect($('#getUserId').getText()).toBe('Dave');
+    expect($('#getCookieName').getText()).toMatch(/_sp_1id.[0-9a-z]{4}/i);
+    expect($('#getPageViewId').getText()).toMatch(/\b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b/i);
+  })
+})

tests/functional/detectors.spec.js

@@ -34,7 +34,7 @@
 import F from 'lodash/fp'
 import moment from 'moment-timezone'
 
-describe('Detectors test', () => {
+describe('Detectors', () => {
   beforeAll(() => {
     browser.url('/detectors.html')
     $('body.loaded').waitForExist()
@@ -55,8 +55,7 @@ describe('Detectors test', () => {
   })
 
   it('Check localStorage availability', () => {
-    const supportsLocalStorage = !F.isMatch( { version: '12603.3.8', browserName: 'safari' }, browser.capabilities)
-    expect($('#localStorageAccessible').getText()).toBe(String(supportsLocalStorage))
+    expect($('#localStorageAccessible').getText()).toBe('true')
   })
 
   it('Check sessionStorage availability', () => {

tests/functional/helpers.spec.js

@@ -31,9 +31,8 @@
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
-import F from 'lodash/fp'
 
-describe('Helpers test', () => {
+describe('Helpers', () => {
   it('Gets page title', () => {
     browser.url('/helpers.html')
     $('body.loaded').waitForExist()
@@ -55,7 +54,7 @@ describe('Helpers test', () => {
     expect(value).toBe('previous')
   })
 
-  it('Can add an even listener', () => {
+  it('Can add an event listener', () => {
     browser.url('/helpers.html')
     $('body.loaded').waitForExist()
     $('#click').click()