File: cypress/integration/async_queue.js

Recommend this page to a friend!
  Classes of Arturs Sosins   Countly Web SDK   cypress/integration/async_queue.js   Download  
File: cypress/integration/async_queue.js
Role: Example script
Content type: text/plain
Description: Example script
Class: Countly Web SDK
Track site accesses and errors the Countly API
Author: By
Last change:
Date: 1 month ago
Size: 13,465 bytes
 

Contents

Class file image Download
/* eslint-disable cypress/no-unnecessary-waiting */ /* eslint-disable require-jsdoc */ var Countly = require("../../lib/countly"); // import * as Countly from "../../dist/countly_umd.js"; var hp = require("../support/helper.js"); function initMain(clear) { Countly.init({ app_key: "YOUR_APP_KEY", url: "https://your.domain.count.ly", debug: true, test_mode: true, clear_stored_id: clear }); } function event(number) { return { key: `event_${number}`, segmentation: { id: number } }; } // All the tests below checks if the functions are working correctly // Currently tests for 'beforeunload' and 'unload' events has to be done manually by using the throttling option of the browser describe("Test Countly.q related methods and processes", () => { // For this tests we disable the internal heatbeat and use processAsyncQueue and sendEventsForced // So we are able to test if those functions work as intented: // processAsyncQueue should send events from .q to event queue // sendEventsForced should send events from event queue to request queue (it also calls processAsyncQueue) it("Check processAsyncQueue and sendEventsForced works as expected", () => { hp.haltAndClearStorage(() => { // Disable heartbeat and init the SDK Countly.noHeartBeat = true; initMain(); cy.wait(1000); // Check that the .q is empty expect(Countly.q.length).to.equal(0); // Add 4 events to the .q Countly.q.push(["track_errors"]); // adding this as calling it during init used to cause an error (at v23.12.5) Countly.q.push(["add_event", event(1)]); Countly.q.push(["add_event", event(2)]); Countly.q.push(["add_event", event(3)]); Countly.q.push(["add_event", event(4)]); // Check that the .q has 4 events expect(Countly.q.length).to.equal(5); cy.fetch_local_event_queue().then((rq) => { // Check that events are still in .q expect(Countly.q.length).to.equal(5); // Check that the event queue is empty expect(rq.length).to.equal(0); // Process the .q (should send things to the event queue) Countly._internals.processAsyncQueue(); // Check that the .q is empty expect(Countly.q.length).to.equal(0); cy.fetch_local_request_queue().then((rq_2) => { // Check that nothing sent to request queue expect(rq_2.length).to.equal(0); cy.fetch_local_event_queue().then((eq) => { // Check that events are now in event queue expect(eq.length).to.equal(4); // Send events from event queue to request queue Countly._internals.sendEventsForced(); cy.fetch_local_event_queue().then((eq_2) => { // Check that event queue is empty expect(eq_2.length).to.equal(0); cy.fetch_local_request_queue().then((rq_3) => { // Check that events are now in request queue expect(rq_3.length).to.equal(1); const eventsArray = JSON.parse(rq_3[0].events); expect(eventsArray[0].key).to.equal("event_1"); expect(eventsArray[1].key).to.equal("event_2"); expect(eventsArray[2].key).to.equal("event_3"); expect(eventsArray[3].key).to.equal("event_4"); }); }); }); }); }); }); }); // This test is same with the ones above but this time we use change_id to trigger processAsyncQueue it("Check changing device ID without merge empties the .q", () => { hp.haltAndClearStorage(() => { // Disable heartbeat and init the SDK Countly.noHeartBeat = true; Countly.q = []; initMain(); cy.wait(1000); // Check that the .q is empty expect(Countly.q.length).to.equal(0); // Add 4 events to the .q Countly.q.push(["add_event", event(1)]); Countly.q.push(["add_event", event(2)]); Countly.q.push(["add_event", event(3)]); Countly.q.push(["add_event", event(4)]); // Check that the .q has 4 events expect(Countly.q.length).to.equal(4); cy.fetch_local_event_queue().then((rq) => { // Check that the event queue is empty expect(rq.length).to.equal(0); // Check that events are still in .q expect(Countly.q.length).to.equal(4); // Trigger processAsyncQueue by changing device ID without merge Countly.change_id("new_user_id", false); // Check that the .q is empty expect(Countly.q.length).to.equal(0); cy.fetch_local_event_queue().then((eq) => { // Check that event queue has new device ID's orientation event expect(eq.length).to.equal(1); expect(eq[0].key).to.equal("[CLY]_orientation"); cy.fetch_local_request_queue().then((rq_2) => { // Check that events are now in request queue (second request is begin session for new device ID) expect(rq_2.length).to.equal(2); const eventsArray = JSON.parse(rq_2[0].events); expect(eventsArray[0].key).to.equal("event_1"); expect(eventsArray[1].key).to.equal("event_2"); expect(eventsArray[2].key).to.equal("event_3"); expect(eventsArray[3].key).to.equal("event_4"); // check begin session expect(rq_2[1].begin_session).to.equal(1); }); }); }); }); }); // This test checks if calling user_details triggers processAsyncQueue (it sends events from .q to event queue and then to request queue) it("Check sending user details empties .q", () => { hp.haltAndClearStorage(() => { // Disable heartbeat and init the SDK Countly.noHeartBeat = true; Countly.q = []; initMain(); cy.wait(1000); // Check that the .q is empty expect(Countly.q.length).to.equal(0); // Add 4 events to the .q Countly.q.push(["add_event", event(1)]); Countly.q.push(["add_event", event(2)]); Countly.q.push(["add_event", event(3)]); Countly.q.push(["add_event", event(4)]); // Check that the .q has 4 events expect(Countly.q.length).to.equal(4); cy.fetch_local_event_queue().then((rq) => { // Check that the event queue is empty expect(rq.length).to.equal(0); // Check that events are still in .q expect(Countly.q.length).to.equal(4); // Trigger processAsyncQueue by adding user details Countly.user_details({ name: "test_user" }); // Check that the .q is empty expect(Countly.q.length).to.equal(0); cy.fetch_local_event_queue().then((eq) => { // Check that event queue is empty expect(eq.length).to.equal(0); cy.fetch_local_request_queue().then((rq_2) => { // Check that events are now in request queue (second request is user details) expect(rq_2.length).to.equal(2); const eventsArray = JSON.parse(rq_2[0].events); expect(eventsArray[0].key).to.equal("event_1"); expect(eventsArray[1].key).to.equal("event_2"); expect(eventsArray[2].key).to.equal("event_3"); expect(eventsArray[3].key).to.equal("event_4"); // check user details const user_details = JSON.parse(rq_2[1].user_details); expect(user_details.name).to.equal("test_user"); }); }); }); }); }); // This Test checks if calling userData.save triggers processAsyncQueue (it sends events from .q to event queue and then to request queue) it("Check sending custom user info empties .q", () => { hp.haltAndClearStorage(() => { // Disable heartbeat and init the SDK Countly.noHeartBeat = true; Countly.q = []; initMain(); cy.wait(1000); // Check that the .q is empty expect(Countly.q.length).to.equal(0); // Add 4 events to the .q Countly.q.push(["add_event", event(1)]); Countly.q.push(["add_event", event(2)]); Countly.q.push(["add_event", event(3)]); Countly.q.push(["add_event", event(4)]); // Check that the .q has 4 events expect(Countly.q.length).to.equal(4); cy.fetch_local_event_queue().then((rq) => { // Check that the event queue is empty expect(rq.length).to.equal(0); // Check that events are still in .q expect(Countly.q.length).to.equal(4); // Trigger processAsyncQueue by saving UserData Countly.userData.set("name", "test_user"); Countly.userData.save(); // Check that the .q is empty expect(Countly.q.length).to.equal(0); cy.fetch_local_event_queue().then((eq) => { // Check that event queue is empty expect(eq.length).to.equal(0); cy.fetch_local_request_queue().then((rq_2) => { // Check that events are now in request queue (second request is user details) expect(rq_2.length).to.equal(2); const eventsArray = JSON.parse(rq_2[0].events); expect(eventsArray[0].key).to.equal("event_1"); expect(eventsArray[1].key).to.equal("event_2"); expect(eventsArray[2].key).to.equal("event_3"); expect(eventsArray[3].key).to.equal("event_4"); // check user data const user_details = JSON.parse(rq_2[1].user_details); expect(user_details.custom.name).to.equal("test_user"); }); }); }); }); }); // This test check if the heartbeat is processing the .q (executes processAsyncQueue) it("Check if heatbeat is processing .q", () => { hp.haltAndClearStorage(() => { // init the SDK Countly.q = []; initMain(); // Check that the .q is empty expect(Countly.q.length).to.equal(0); cy.fetch_local_event_queue().then((eq) => { // Check that the event queue is empty expect(eq.length).to.equal(0); cy.fetch_local_request_queue().then((rq) => { // Check that the request queue is empty expect(rq.length).to.equal(0); // Add 4 events to the .q Countly.q.push(["add_event", event(1)]); Countly.q.push(["add_event", event(2)]); Countly.q.push(["add_event", event(3)]); Countly.q.push(["add_event", event(4)]); // Check that the .q has 4 events expect(Countly.q.length).to.equal(4); // Wait for heartBeat to process the .q cy.wait(1500).then(() => { // Check that the .q is empty expect(Countly.q.length).to.equal(0); cy.fetch_local_event_queue().then((eq_2) => { // Check that event queue is empty as all must be in request queue expect(eq_2.length).to.equal(0); cy.fetch_local_request_queue().then((rq_2) => { // Check that events are now in request queue expect(rq_2.length).to.equal(1); const eventsArray = JSON.parse(rq_2[0].events); expect(eventsArray[0].key).to.equal("event_1"); expect(eventsArray[1].key).to.equal("event_2"); expect(eventsArray[2].key).to.equal("event_3"); expect(eventsArray[3].key).to.equal("event_4"); }); }); }); }); }); }); }); });