Files
discourse-adplugin/assets/javascripts/discourse/components/house-ad.js
T
David Taylor c88bb59d81 FIX: Fully re-render ads when navigating between pages (#188)
In the past, the ad plugin relied on two side-effects to achieve this behaviour:

1. Components being fully destroyed/rendered when navigating between pages. This stopped working when Discourse core moved to the more efficient 'loading slider' UI

2. The `listLoading` argument. This was an implementation detail of the old discovery routing infrastructure. Core recently overhauled this and removed the `listLoading` argument, because loading is now handled properly by the Ember router.

Instead of these two properties, we can use the `currentRoute` property of Ember's router service to trigger changes when navigating between pages. A common `{{#each` trick is used to fully destroy/re-render components even if the ad network is unchanged.
2023-11-07 21:12:30 +00:00

125 lines
3.0 KiB
JavaScript

import { isBlank } from "@ember/utils";
import discourseComputed from "discourse-common/utils/decorators";
import AdComponent from "discourse/plugins/discourse-adplugin/discourse/components/ad-component";
const adIndex = {
topic_list_top: null,
topic_above_post_stream: null,
topic_above_suggested: null,
post_bottom: null,
topic_list_between: null,
};
export default AdComponent.extend({
classNames: ["house-creative"],
classNameBindings: ["adUnitClass"],
attributeBindings: ["colspanAttribute:colspan"],
adHtml: "",
@discourseComputed
colspanAttribute() {
return this.tagName === "td" ? "5" : null;
},
@discourseComputed("placement", "showAd")
adUnitClass(placement, showAd) {
return showAd ? `house-${placement}` : "";
},
@discourseComputed(
"showToGroups",
"showAfterPost",
"showAfterTopicListItem",
"showOnCurrentPage"
)
showAd(
showToGroups,
showAfterPost,
showAfterTopicListItem,
showOnCurrentPage
) {
return (
showToGroups &&
(showAfterPost || showAfterTopicListItem) &&
showOnCurrentPage
);
},
@discourseComputed("postNumber", "placement")
showAfterPost(postNumber, placement) {
if (!postNumber && placement !== "topic-list-between") {
return true;
}
return this.isNthPost(
parseInt(this.site.get("house_creatives.settings.after_nth_post"), 10)
);
},
@discourseComputed("placement")
showAfterTopicListItem(placement) {
if (placement !== "topic-list-between") {
return true;
}
return this.isNthTopicListItem(
parseInt(this.site.get("house_creatives.settings.after_nth_topic"), 10)
);
},
chooseAdHtml() {
const houseAds = this.site.get("house_creatives"),
placement = this.get("placement").replace(/-/g, "_"),
adNames = this.adsNamesForSlot(placement);
if (adNames.length > 0) {
if (!adIndex[placement]) {
adIndex[placement] = 0;
}
let ad = houseAds.creatives[adNames[adIndex[placement]]] || "";
adIndex[placement] = (adIndex[placement] + 1) % adNames.length;
return ad;
} else {
return "";
}
},
adsNamesForSlot(placement) {
const houseAds = this.site.get("house_creatives");
if (!houseAds || !houseAds.settings) {
return [];
}
const adsForSlot = houseAds.settings[placement];
if (Object.keys(houseAds.creatives).length > 0 && !isBlank(adsForSlot)) {
return adsForSlot.split("|");
} else {
return [];
}
},
refreshAd() {
this.set("adHtml", this.chooseAdHtml());
},
didInsertElement() {
this._super(...arguments);
if (!this.get("showAd")) {
return;
}
if (adIndex.topic_list_top === null) {
// start at a random spot in the ad inventory
Object.keys(adIndex).forEach((placement) => {
const adNames = this.adsNamesForSlot(placement);
adIndex[placement] = Math.floor(Math.random() * adNames.length);
});
}
this.refreshAd();
},
});