graphdb-workbench-tests/e2e-legacy/home/cookie-policy.spec.js

Cypress tests for GraphDB workbench

import HomeSteps from '../../steps/home-steps';
import {SecurityStubs} from '../../stubs/security-stubs';
import {SettingsSteps} from '../../steps/setup/settings-steps';
import {LicenseStubs} from '../../stubs/license-stubs';

Cypress.env('set_default_user_data', false);

describe('Cookie policy', () => {
    beforeEach(() => {
        cy.setCookieConsent(undefined);
        cy.viewport(1280, 1000);
        LicenseStubs.stubFreeLicense();
    });

    afterEach(() => cy.setCookieConsent(true));

    context('should show', () => {
        it('Should show consent popup to user', () => {
            HomeSteps.visitInProdMode();
            HomeSteps.getCookieConsentPopup().should('exist').and('be.visible');
            // When I click on the link
            HomeSteps.clickCookiePolicyLink();
            // Then I see the cookie policy
            HomeSteps.getCookiePolicyModal().should('exist').and('be.visible');
        });

        it('Should show cookie policy to user in user settings', () => {
            SettingsSteps.visitInProdMode();
            SettingsSteps.getCookiePolicyButton().should('exist').and('be.visible');

            // When I click on the link
            SettingsSteps.clickCookiePolicyLink();
            // Then I see the cookie policy
            SettingsSteps.getCookiePolicyModal().should('exist').and('be.visible');
        });

        it('Should save consent in user settings', () => {
            HomeSteps.visitInProdMode();
            SecurityStubs.stubUpdateUserData('admin');

            // When I click Agree button
            HomeSteps.clickAgreeButton();

            // I expect to save cookie consent in user settings
            cy.wait('@updateUser').then((xhr) => {
                expect(xhr.request.body.appSettings).to.include({
                    DEFAULT_INFERENCE: true,
                    DEFAULT_VIS_GRAPH_SCHEMA: true,
                    DEFAULT_SAMEAS: true,
                    IGNORE_SHARED_QUERIES: false,
                    EXECUTE_COUNT: true
                });

                // Assert COOKIE_CONSENT properties, excluding updatedAt
                expect(xhr.request.body.appSettings.COOKIE_CONSENT).to.include({
                    policyAccepted: true
                });

                // Assert that updatedAt is present, is a number, and is a reasonable timestamp
                const updatedAt = xhr.request.body.appSettings.COOKIE_CONSENT.updatedAt;
                expect(updatedAt).to.exist;
                expect(updatedAt).to.be.a('number');

                // Check that updatedAt is within 1 hour of the current time
                const oneHourInMilliseconds = 60 * 60 * 1000;
                const now = Date.now();
                expect(updatedAt).to.be.within(now - oneHourInMilliseconds, now + oneHourInMilliseconds);
            });
        });

        it('Should set cookies for tracking when accepted', () => {
            cy.intercept('PATCH', `/rest/security/users/admin`).as('updateUser');
            HomeSteps.visitInProdMode();

            // When I click Agree button
            HomeSteps.clickAgreeButton();

            // I expect to save cookie consent in user settings
            // There are two requests one from the new shared component and one in the legacy
            cy.wait('@updateUser');
            cy.wait('@updateUser');

            // Check if the GA tracking script is set correctly in the head
            cy.document()
                .get('head script')
                .should("have.attr", "src")
                .should('include', 'https://www.googletagmanager.com/gtm.js?id=GTM-WBP6C6Z4');

            // Check if the installation ID cookie is set correctly
            cy.getCookie('_wb').then((cookie) => {
                expect(cookie).to.exist;
                expect(cookie.value).to.match(/^WB1\.[a-zA-Z0-9\-]+\.\d+$/); // Check the cookie structure: WB1.<installationId>.<timestamp>
            });
        })
    })

    context('should not show', () => {
        it('Should NOT show consent popup to user when tracking is not applicable', () => {
            HomeSteps.visitInDevMode();
            HomeSteps.getCookieConsentPopup().should('not.exist');
        });

        it('Should NOT show cookie policy to user when tracking is not applicable', () => {
            SettingsSteps.visitInDevMode();
            SettingsSteps.getCookiePolicyButton().should('not.exist');
        });
    });
});