WORLDSERVICE-122: Cypress E2E tests for ATI Analytics #12412
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ed content on articles
karinathomasbbc
commented
Feb 17, 2025
| }; | ||
|
|
||
| export const assertFeaturesAnalysisComponentClick = () => { | ||
| it.skip('should send a click event for the Features & Analysis component', () => { |
There was a problem hiding this comment.
TODO try to fix this 🤷♀️
There was a problem hiding this comment.
See #12421 (need to check what the implications are of this fix)
karinathomasbbc
changed the title
karinathomasbbc
commented
Feb 18, 2025
karinathomasbbc
commented
Feb 18, 2025
cypress/e2e/specialFeatures/atiAnalytics/assertions/featuresAnalysis.js
Outdated
Show resolved
Hide resolved
karinathomasbbc
commented
Feb 20, 2025
Comment on lines
+7
to
+58
| const assertATIPageViewEventParamsExist = ({ | ||
| params, | ||
| contentType, | ||
| applicationType, | ||
| }) => { | ||
| expect(params).to.have.property('s'); // destination | ||
| expect(params).to.have.property('s2'); // producer | ||
| expect(params).to.have.property('p'); // page identifier | ||
| expect(params).to.have.property('x2'); // application type | ||
| expect(params).to.have.property('x3'); // application name | ||
| expect(params).to.have.property('x4'); // language | ||
| expect(params).to.have.property('x7'); // content type | ||
| expect(params).to.have.property('x8'); // library version | ||
| expect(params).to.have.property('x9'); // page title | ||
|
|
||
| if (['responsive', 'amp'].includes(applicationType)) { | ||
| expect(params).to.have.property('r'); // screen resolution & colour depth | ||
| expect(params).to.have.property('re'); // browser/viewport resolution | ||
| expect(params).to.have.property('hl'); // timestamp | ||
| expect(params).to.have.property('lng'); // device language | ||
| expect(params).to.have.property('x5'); // url | ||
| } | ||
|
|
||
| if (contentType !== 'list-datadriven') { | ||
| expect(params).to.have.property('x1'); // content ID | ||
| } | ||
|
|
||
| if (contentType === 'article') { | ||
| expect(params).to.have.property('x11'); // first published | ||
| expect(params).to.have.property('x12'); // last published | ||
| expect(params).to.have.property('x13'); // ldp things | ||
| expect(params).to.have.property('x17'); // category | ||
| } | ||
| }; | ||
|
|
||
| const assertATIComponentViewEventParamsExist = params => { | ||
| expect(params).to.have.property('s'); // destination | ||
| expect(params).to.have.property('s2'); // producer | ||
| expect(params).to.have.property('p'); // page identifier | ||
| expect(params).to.have.property('ati'); // view event | ||
| expect(params).to.have.property('type'); | ||
| expect(params.type).to.equal('AT', 'params.type'); | ||
| }; | ||
|
|
||
| const assertATIComponentClickEventParamsExist = params => { | ||
| expect(params).to.have.property('s'); // destination | ||
| expect(params).to.have.property('s2'); // producer | ||
| expect(params).to.have.property('p'); // page identifier | ||
| expect(params).to.have.property('atc'); // click event | ||
| expect(params).to.have.property('type'); | ||
| expect(params.type).to.equal('AT', 'params.type'); | ||
| }; |
There was a problem hiding this comment.
Note for reviewers: I've added a tests to assert that the query params exist, but we are not asserting on the values as they are often dynamic (and the value of adding them is low).
amoore108
approved these changes
Feb 21, 2025
LilyL0u
approved these changes
Feb 21, 2025
Thanks! It should be OK in the pipelines, I've run it against test & live data (see Testing section in the PR description above), to ensure that it wouldn't block anything 😅 ). But failing tests can easily be fixed forward or component assertions removed e.g. if a homepage no longer has a message banner. Hopefully they are fairly robust & give us confidence in our analytics 🤞 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves JIRA https://jira.dev.bbc.co.uk/browse/WORLDSERVICE-122
Overall changes
Allows us to test ATI analytics events are being fired as expected from all page types, especially the lite site (where we are enabling click tracking as part of #12360)
Code changes
Testing
CYPRESS_APP_ENV=test yarn cypress run --spec './cypress/e2e/specialFeatures/atiAnalytics/*'Expected Failing tests (as the attribute has been added in this PR):
CYPRESS_APP_ENV=live yarn cypress run --spec './cypress/e2e/specialFeatures/atiAnalytics/*'Expected Failing tests (as the attribute has been added in this PR):
See test output here: https://github.com/bbc/simorgh/actions/runs/13389554089/job/37393937077?pr=12412 - search for specialFeatures/atiAnalytics