Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Fix ad duplication #25831

Merged
merged 2 commits into from
Apr 19, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 12 additions & 13 deletions docs/src/modules/components/Ad.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import * as React from 'react';
import clsx from 'clsx';
import PropTypes from 'prop-types';
import { withStyles } from '@material-ui/core/styles';
import Typography from '@material-ui/core/Typography';
import Box from '@material-ui/core/Box';
import Paper from '@material-ui/core/Paper';
import AdCarbon from 'docs/src/modules/components/AdCarbon';
import AdReadthedocs from 'docs/src/modules/components/AdReadthedocs';
Expand All @@ -11,10 +11,6 @@ import { AdContext, adShape } from 'docs/src/modules/components/AdManager';
import { useTranslate } from 'docs/src/modules/utils/i18n';

const styles = (theme) => ({
root: {
position: 'relative',
display: 'block',
},
'placement-body-image': {
margin: theme.spacing(4, 1, 3),
minHeight: 126,
Expand All @@ -32,17 +28,15 @@ const styles = (theme) => ({
alignItems: 'flex-end',
},
paper: {
padding: theme.spacing(1.5),
border: `2px solid ${theme.palette.primary.main}`,
display: 'block',
},
});

function PleaseDisableAdblock(props) {
const t = useTranslate();

return (
<Paper component="span" elevation={0} {...props}>
<Paper component="span" elevation={0} sx={{ display: 'block', p: 1.5 }} {...props}>
<Typography variant="body2" display="block" component="span" gutterBottom>
{t('likeMui')}
</Typography>
Expand Down Expand Up @@ -128,7 +122,7 @@ function Ad(props) {

let children;
let label;
// Hide the content to google bot.
// Hide the content to google bot to avoid its indexation.
if (/Googlebot/.test(navigator.userAgent) || disable) {
children = <span />;
} else if (adblock) {
Expand All @@ -151,7 +145,7 @@ function Ad(props) {
}

const ad = React.useContext(AdContext);
const eventLabel = label ? `${label}-${ad.portal.placement}-${adShape}` : null;
const eventLabel = label ? `${label}-${ad.placement}-${adShape}` : null;

const timerAdblock = React.useRef();

Expand Down Expand Up @@ -220,14 +214,19 @@ function Ad(props) {
}, [eventLabel]);

return (
<span
className={clsx(classes.root, classes[`placement-body-${adShape}`])}
<Box
component="span"
sx={{
position: 'relative',
display: 'block',
}}
className={classes[`placement-body-${adShape}`]}
data-ga-event-category="ad"
data-ga-event-action="click"
data-ga-event-label={eventLabel}
>
{children}
</span>
</Box>
);
}

Expand Down
19 changes: 14 additions & 5 deletions docs/src/modules/components/AdCarbon.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,20 @@ function AdCarbonImage() {
const ref = React.useRef(null);

React.useEffect(() => {
const script = loadScript(
'https://cdn.carbonads.com/carbon.js?serve=CKYIL27L&placement=material-uicom',
ref.current,
);
script.id = '_carbonads_js';
// The isolation logic of carbonads is flawed.
// Once the script starts loading, it will asynchronous resolve, with no way to stop it.
// This leads to duplication of the ad. To solve the issue, we debounce the load action.
const load = setTimeout(() => {
const script = loadScript(
'https://cdn.carbonads.com/carbon.js?serve=CKYIL27L&placement=material-uicom',
ref.current,
);
script.id = '_carbonads_js';
});

return () => {
clearTimeout(load);
};
}, []);

return <span ref={ref} />;
Expand Down
6 changes: 3 additions & 3 deletions docs/src/modules/components/AdGuest.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { AdContext } from 'docs/src/modules/components/AdManager';
export default function AdGuest(props) {
const ad = React.useContext(AdContext);

if (!ad.portal.element) {
if (!ad.element) {
return null;
}

Expand All @@ -15,13 +15,13 @@ export default function AdGuest(props) {
container={() => {
const description = document.querySelector('.description');

if (ad.portal.element === description) {
if (ad.element === description) {
description.classList.add('ad');
} else {
description.classList.remove('ad');
}

return ad.portal.element;
return ad.element;
}}
>
{props.children}
Expand Down
10 changes: 1 addition & 9 deletions docs/src/modules/components/AdManager.js
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,7 @@ export default function AdManager(props) {
setPortal({ placement: 'body-top', element: description });
}, []);

return (
<AdContext.Provider
value={{
portal,
}}
>
{props.children}
</AdContext.Provider>
);
return <AdContext.Provider value={portal}>{props.children}</AdContext.Provider>;
}

AdManager.propTypes = {
Expand Down