@daemonitor/plugins 1.1.31 → 1.1.32

package/dist/plugins/index.js

@@ -11,6 +11,7 @@ import { createSnmpPlugin } from "./monitoring/SnmpPlugin.js";
 import { createThreeCXPlugin } from "./monitoring/ThreeCXPlugin.js";
 import { createTplinkPlugin } from "./monitoring/TplinkPlugin.js";
 import { createPatroniPlugin } from "./monitoring/PatroniPlugin.js";
+import { createAdsensePlugin } from "./monitoring/AdsensePlugin.js";
 // In future, implement other plugin factory functions using the same pattern
 // import { createOSPlugin } from "./monitoring/OSPlugin.js"
 // import { createMongoDBPlugin } from "./monitoring/MongoDBPlugin.js"
@@ -33,6 +34,7 @@ export default {
     ThreeCX: createThreeCXPlugin,
     Tplink: createTplinkPlugin,
     Patroni: createPatroniPlugin,
+    Adsense: createAdsensePlugin,
     // CloudflarePlugin: createCloudflarePlugin,
     // EwelinkPlugin: createEwelinkPlugin,
     // MongoDBPlugin: createMongoDBPlugin,

package/dist/plugins/monitoring/AdsensePlugin.js

@@ -0,0 +1,154 @@
+import { createMonitoringPlugin } from "../../lib/MonitoringPlugin.js";
+// Google AdSense earnings monitor.
+//
+// AdSense has no service-account access, so this runs on a user refresh token
+// (scope adsense.readonly) minted once by hand. Each poll trades it for a
+// one-hour access token and pulls ONE report: earnings and page views per day,
+// from whichever is earlier of the 1st of the month or 29 days ago, through
+// today. Every figure on the tile (today, yesterday, 7 days, month to date, RPM,
+// the daily sparkline) is summed locally from those rows, so the numbers cannot
+// disagree with each other the way separate report calls can mid-update.
+//
+// Dates are the ACCOUNT's time zone, not this host's: "today" for an account in
+// New York is still yesterday on a UTC box for a few hours every night.
+const TOKEN_URL = "https://oauth2.googleapis.com/token";
+const API = "https://adsense.googleapis.com/v2";
+/** YYYY-MM-DD shifted by whole days. */
+export function shiftDate(date, days) {
+    const t = new Date(`${date}T00:00:00Z`);
+    t.setUTCDate(t.getUTCDate() + days);
+    return t.toISOString().slice(0, 10);
+}
+/** Today's date as the account sees it. */
+export function todayIn(timeZone, now = new Date()) {
+    // en-CA formats as YYYY-MM-DD.
+    return new Intl.DateTimeFormat("en-CA", { timeZone: timeZone || "UTC" }).format(now);
+}
+/** Earlier of the 1st of this month and 29 days back, so one report covers both windows. */
+export function reportStart(today) {
+    const monthStart = `${today.slice(0, 7)}-01`;
+    const back = shiftDate(today, -29);
+    return back < monthStart ? back : monthStart;
+}
+export function reportUrl(account, start, end) {
+    const q = new URLSearchParams({ dateRange: "CUSTOM", reportingTimeZone: "ACCOUNT_TIME_ZONE", dimensions: "DATE" });
+    for (const [k, v] of [["startDate", start], ["endDate", end]]) {
+        const [y, m, d] = v.split("-").map(Number);
+        q.set(`${k}.year`, String(y));
+        q.set(`${k}.month`, String(m));
+        q.set(`${k}.day`, String(d));
+    }
+    q.append("metrics", "ESTIMATED_EARNINGS");
+    q.append("metrics", "PAGE_VIEWS");
+    return `${API}/${account}/reports:generate?${q}`;
+}
+/** reports:generate response -> per-day rows. Columns are found by header name, not position. */
+export function parseReport(report) {
+    const headers = Array.isArray(report?.headers) ? report.headers : [];
+    const col = (name) => headers.findIndex((h) => h?.name === name);
+    const [iDate, iEarn, iViews] = [col("DATE"), col("ESTIMATED_EARNINGS"), col("PAGE_VIEWS")];
+    if (iDate < 0 || iEarn < 0)
+        throw new Error("unexpected report shape (no DATE/ESTIMATED_EARNINGS column)");
+    // A day with no traffic has no row at all, so an empty report is valid.
+    const rows = Array.isArray(report?.rows) ? report.rows : [];
+    return {
+        currency: headers[iEarn]?.currencyCode || "USD",
+        days: rows.map((r) => ({
+            date: String(r?.cells?.[iDate]?.value || ""),
+            earnings: Number(r?.cells?.[iEarn]?.value) || 0,
+            pageViews: iViews < 0 ? 0 : Number(r?.cells?.[iViews]?.value) || 0,
+        })),
+    };
+}
+const cents = (n) => Math.round(n * 100) / 100;
+/** Roll per-day rows up into the figures the tile shows. `last7` includes today, as AdSense's own "Last 7 days" does. */
+export function summarize(days, today) {
+    const by = new Map(days.map((d) => [d.date, d]));
+    const day = (date) => by.get(date) || { date, earnings: 0, pageViews: 0 };
+    const span = (n) => Array.from({ length: n }, (_, i) => day(shiftDate(today, i - n + 1)));
+    const week = span(7);
+    const last7 = week.reduce((s, d) => s + d.earnings, 0);
+    const pageViews7 = week.reduce((s, d) => s + d.pageViews, 0);
+    const month = today.slice(0, 7);
+    return {
+        today: cents(day(today).earnings),
+        yesterday: cents(day(shiftDate(today, -1)).earnings),
+        last7: cents(last7),
+        monthToDate: cents(days.filter((d) => d.date.startsWith(month)).reduce((s, d) => s + d.earnings, 0)),
+        pageViews7,
+        // Page RPM over the same 7 days: earnings per thousand page views.
+        rpm: pageViews7 ? cents((last7 / pageViews7) * 1000) : 0,
+        // Gap-filled so the sparkline has one point per day, oldest first.
+        daily: span(30),
+    };
+}
+async function getJson(url, init, timeout) {
+    const res = await fetch(url, { ...init, signal: AbortSignal.timeout(timeout) });
+    const body = await res.json().catch(() => ({}));
+    if (!res.ok) {
+        const e = new Error(body?.error_description || body?.error?.message || body?.error || `HTTP ${res.status}`);
+        e.code = typeof body?.error === "string" ? body.error : body?.error?.status;
+        throw e;
+    }
+    return body;
+}
+export function createAdsensePlugin() {
+    let refreshTimer = null;
+    // Resolved once: the account and its time zone do not change between polls.
+    let account = null;
+    const collect = async (cfg) => {
+        const timeout = cfg.timeout || 15000;
+        const tok = await getJson(TOKEN_URL, {
+            method: "POST",
+            headers: { "Content-Type": "application/x-www-form-urlencoded" },
+            body: new URLSearchParams({
+                grant_type: "refresh_token",
+                client_id: cfg.clientId || "",
+                client_secret: cfg.clientSecret || "",
+                refresh_token: cfg.refreshToken || "",
+            }).toString(),
+        }, timeout);
+        const auth = { headers: { Authorization: `Bearer ${tok.access_token}` } };
+        if (!account) {
+            const list = (await getJson(`${API}/accounts`, auth, timeout))?.accounts || [];
+            const a = cfg.accountId ? list.find((x) => x.name === cfg.accountId) : list[0];
+            if (!a)
+                throw new Error(cfg.accountId ? `account ${cfg.accountId} not visible to this token` : "no AdSense account visible to this token");
+            account = { name: a.name, timeZone: a.timeZone?.id };
+        }
+        const today = todayIn(account.timeZone);
+        const { currency, days } = parseReport(await getJson(reportUrl(account.name, reportStart(today), today), auth, timeout));
+        return { accountId: account.name, currency, asOf: today, ...summarize(days, today) };
+    };
+    const refreshFn = async (plugin) => {
+        const cfg = (plugin.config || {});
+        if (!cfg.clientId || !cfg.clientSecret || !cfg.refreshToken) {
+            await plugin.send({ error: "adsense plugin needs clientId, clientSecret and refreshToken" });
+            return;
+        }
+        try {
+            await plugin.send(await collect(cfg));
+        }
+        catch (e) {
+            // invalid_grant = the refresh token was revoked or expired. Nothing the
+            // next poll can fix, so it is flagged apart from a transient API error.
+            await plugin.send({
+                error: String(e?.message || e).slice(0, 160),
+                ...(e?.code === "invalid_grant" ? { authExpired: true } : {}),
+            });
+        }
+    };
+    const monitorFn = async (plugin) => {
+        await refreshFn(plugin);
+        // AdSense figures lag by hours; 10 minutes keeps the row inside the
+        // server's 15-minute staleness window without spending API quota.
+        refreshTimer = setInterval(() => refreshFn(plugin), plugin.config?.refreshInterval || 600000);
+    };
+    const teardownFn = async () => {
+        if (refreshTimer)
+            clearInterval(refreshTimer);
+        refreshTimer = null;
+    };
+    return createMonitoringPlugin("adsense", "adsense", "Google AdSense earnings (today, yesterday, 7 days, month to date, page RPM)", async () => { }, monitorFn, refreshFn, teardownFn);
+}
+export default createAdsensePlugin;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@daemonitor/plugins",
-  "version": "1.1.31",
+  "version": "1.1.32",
   "description": "daemonitor plugins",
   "types": "types/index.d.ts",
   "main": "dist/index.js",