Skip to content

Ensure pending or in-review sites still get placeholder ads even without preview query param #2535

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Oct 18, 2024
Merged

Ensure pending or in-review sites still get placeholder ads even without preview query param #2535

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aa1cc0b
Ensure sites in pending or in-review still get placeholder ads withou…
spastorelli Oct 18, 2024
1d5b8d2
Merge branch 'main' into steeve/fix-issue-placeholder-ads-not-rendere…
spastorelli Oct 18, 2024
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 12 additions & 8 deletions packages/gitbook/src/components/Ads/Ad.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,18 +82,22 @@ export function Ad({
(siteAdsStatus === SiteAdsStatus.Pending ||
siteAdsStatus === SiteAdsStatus.InReview));

if (!realZoneId) {
if (!realZoneId && !showPlaceholderAd) {
return;
}

(async () => {
const result = await renderAd({
placement,
ignore: ignore || preview,
zoneId: realZoneId,
mode,
source: showPlaceholderAd ? 'placeholder' : 'live',
});
const result = showPlaceholderAd
? await renderAd({ source: 'placeholder' })
: realZoneId
? await renderAd({
placement,
ignore: ignore || preview,
zoneId: realZoneId,
mode,
source: 'live',
})
: undefined;

if (cancelled) {
return;
Expand Down
25 changes: 16 additions & 9 deletions packages/gitbook/src/components/Ads/renderAd.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,13 @@ import { AdPixels } from './AdPixels';
import adRainbow from './assets/ad-rainbow.svg';
import { AdItem, AdsResponse } from './types';

interface FetchAdOptions {
type FetchAdOptions = FetchLiveAdOptions | FetchPlaceholderAdOptions;

interface FetchLiveAdOptions {
/**
* Source of the ad (live: from the platform)
*/
source: 'live';
/** ID of the zone to fetch Ads for */
zoneId: string;
/** Mode to render the Ad */
Expand All @@ -17,12 +23,13 @@ interface FetchAdOptions {
placement: string;
/** If true, we'll not track it as an impression */
ignore: boolean;
}

interface FetchPlaceholderAdOptions {
/**
* Source of the ad (live: from the platform, placeholder: static placeholder)
*
* Defaults to live.
* */
source?: 'live' | 'placeholder';
* Source of the ad (placeholder: static placeholder ad)
*/
source: 'placeholder';
}

/**
Expand All @@ -31,9 +38,9 @@ interface FetchAdOptions {
* and properly access user-agent and IP.
*/
export async function renderAd(options: FetchAdOptions) {
const { mode, source = 'live' } = options;
const mode = options.source === 'live' ? options.mode : 'classic';

const result = source === 'live' ? await fetchAd(options) : getPlaceholderAd();
const result = options.source === 'live' ? await fetchAd(options) : getPlaceholderAd();
if (!result || !result.ad.description || !result.ad.statlink) {
return null;
}
Expand All @@ -56,7 +63,7 @@ async function fetchAd({
zoneId,
placement,
ignore,
}: FetchAdOptions): Promise<{ ad: AdItem; ip: string } | null> {
}: FetchLiveAdOptions): Promise<{ ad: AdItem; ip: string } | null> {
const { ip, userAgent } = getUserAgentAndIp();

const url = new URL(`https://srv.buysellads.com/ads/${zoneId}.json`);
Expand Down
Loading