Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

fix(api): Only call Google Tag Manager if hostname has influxdata.com - prevents undefined GTM object errors in dev 

- Stub Google Tag Manager in the test
pull/5870/head
Jason Stirnaman 2025-02-19 10:37:20 -06:00
parent 0b7b73b8f7
commit b6adbbf829
3 changed files with 147 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
api-docs/template.hbs
View File

@ -3,7 +3,7 @@
<head>
<!-- Google Tag Manager -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
<script>window.location.hostname.endsWith('influxdata.com') && (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
@ -30,6 +30,21 @@
</head>
<body>
{{!-- <script>
document.addEventListener('DOMContentLoaded', function() {
// Prevent throwing errors when the Google Tag Manager script is blocked
if (!window.hasOwnProperty('fcdsc')) {
window.fcdsc = (function() {
// Return nothing for any function call chained off of fcdsc
return new Proxy({}, {
get: function(target, prop) {
return function() {};
}
});
})();
}
});
</script> --}}
<!-- Google Tag Manager (noscript) -->
<noscript>
<iframe src="https://www.googletagmanager.com/ns.html?id=GTM-WXRH9C" height="0" width="0" style="display:none;visibility:hidden"></iframe>

104
cypress/e2e/content/api-reference.cy.js Normal file
View File

@ -0,0 +1,104 @@
/// <reference types="cypress" />
const fakeGoogleTagManager = {
trackingOptIn: () => {},
trackingOptOut: () => {}
}
describe('API reference content', () => {
const subjects = [
'/influxdb/cloud/api/',
'/influxdb/cloud/api/v1/',
'/influxdb/cloud/api/v1-compatibility/',
'/influxdb/cloud/api/v2/',
'/influxdb/v2/api/',
'/influxdb/v2/api/v1/',
'/influxdb/v2/api/v1-compatibility/',
'/influxdb/v2/api/v2/',
'/influxdb3/cloud-dedicated/api/',
'/influxdb3/cloud-dedicated/api/management/',
'/influxdb3/cloud-dedicated/api/v1/',
'/influxdb3/cloud-dedicated/api/v1-compatibility/',
'/influxdb3/cloud-dedicated/api/v2/',
'/influxdb3/cloud-serverless/api/',
'/influxdb3/cloud-serverless/api/v1/',
'/influxdb3/cloud-serverless/api/v1-compatibility/',
'/influxdb3/cloud-serverless/api/v2/',
'/influxdb3/clustered/api/',
// TODO '/influxdb3/clustered/api/management/',
'/influxdb3/clustered/api/v1/',
'/influxdb3/clustered/api/v1-compatibility/',
'/influxdb3/clustered/api/v2/',
'/influxdb3/core/api/',
'/influxdb3/enterprise/api/',
];
subjects.forEach((subject) => {
describe(subject, () => {
it(`has API info`, function () {
cy.visit(subject);
window.fcdsc = fakeGoogleTagManager;
cy.stub(window.fcdsc, 'trackingOptIn').as('trackingOptIn');
cy.stub(window.fcdsc, 'trackingOptOut').as('trackingOptOut');
cy.get('h1').first().should('have.length', 1);
cy.get('[data-role$=description]').should('have.length', 1);
});
it('links back to the version home page', function () {
cy.visit(`${subject}`);
window.fcdsc = fakeGoogleTagManager;
cy.stub(window.fcdsc, 'trackingOptIn').as('trackingOptIn');
cy.stub(window.fcdsc, 'trackingOptOut').as('trackingOptOut');
cy.get('a.back').contains('Docs')
.should('have.length', 1)
.click();
// Path should be the first two segments and trailing slash in $subject
cy.location('pathname')
.should('eq', subject.replace(/^(\/[^/]+\/[^/]+\/).*/, '$1'));
cy.get('h1').should('have.length', 1);
});
it('contains valid internal links', function () {
cy.visit(subject);
window.fcdsc = fakeGoogleTagManager;
cy.stub(window.fcdsc, 'trackingOptIn').as('trackingOptIn');
cy.stub(window.fcdsc, 'trackingOptOut').as('trackingOptOut');
// The following conditional test isn't the cypress way, but the doc might not have internal links.
cy.get('body').then(($body) => {
if ($body.find('p a[href^="/"]').length === 0) {
cy.log('No internal links found');
return;
}
cy.get('p a[href^="/"]').as('internal-links');
cy.get('@internal-links').each(($a) => {
cy.log(`** Testing link ${$a.attr('href')} **`);
// cy.request doesn't show in your browser's Developer Tools
// because the request comes from Node, not from the browser.
cy.request($a.attr('href')).its('status').should('eq', 200);
});
});
});
it('contains valid external links', function () {
cy.visit(subject);
window.fcdsc = fakeGoogleTagManager;
cy.stub(window.fcdsc, 'trackingOptIn').as('trackingOptIn');
cy.stub(window.fcdsc, 'trackingOptOut').as('trackingOptOut');
// The following conditional test isn't the cypress way, but the doc might not have external links.
cy.get('body').then(($body) => {
if ($body.find('p a[href^="http"]').length === 0) {
cy.log('No external links found');
return;
}
cy.get('p a[href^="http"]').as('external-links');
cy.get('@external-links').each(($a) => {
cy.log(`** Testing link ${$a.attr('href')} **`);
cy.request($a.attr('href')).its('status').should('eq', 200);
});
});
});
});
});
});

27
cypress/e2e/content/article-links.cy.js Normal file
View File

@ -0,0 +1,27 @@
/// <reference types="cypress" />
describe('Article links', () => {
const subjects = Cypress.env('test_subjects').split(',');
subjects.forEach((subject) => {
it('contains valid internal links', function () {
cy.visit(`${subject}`);
cy.get('article a[href^="/"]') //.filter('[href^="/"]')
.each(($a) => {
cy.log(`** Testing internal link ${$a.attr('href')} **`);
// cy.request doesn't show in your browser's Developer Tools
// because the request comes from Node, not from the browser.
cy.request($a.attr('href')).its('status').should('eq', 200);
});
});
it('contains valid external links', function () {
cy.visit(`${subject}`);
cy.get('article a[href^="http"]')
.each(($a) => {
// cy.request doesn't show in your browser's Developer Tools
cy.log(`** Testing external link ${$a.attr('href')} **`);
// because the request comes from Node, not from the browser.
cy.request($a.attr('href')).its('status').should('eq', 200);
});
});
});
});