@yellowpanther/shared 1.3.0 → 1.3.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yellowpanther/shared",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "publishConfig": {
     "access": "public"
   },
@@ -20,7 +20,6 @@
     "./redis/redisClient": "./src/redis/redisClient.js",
     "./queue/compressionQueue": "./src/queue/compressionQueue.js",
     "./queue/newsTranslationQueue": "./src/queue/newsTranslationQueue.js",
-    "./queue/addUserPointsQueue": "./src/queue/addUserPointsQueue.js",
     "./queue/newsTranslateQueue": "./src/queue/newsTranslateQueue.js",
     "./queue/newsPublishQueue": "./src/queue/newsPublishQueue.js",
     "./queue/articlePublishQueue": "./src/queue/articlePublishQueue.js",
@@ -29,10 +28,12 @@
     "./queue/imagePublishQueue": "./src/queue/imagePublishQueue.js",
     "./queue/imageAlbumPublishQueue": "./src/queue/imageAlbumPublishQueue.js",
     "./queue/pagePublishQueue": "./src/queue/pagePublishQueue.js",
+    "./queue/shopPublishQueue": "./src/queue/shopPublishQueue.js",
     "./queue/productPublishQueue": "./src/queue/productPublishQueue.js",
     "./queue/quizPublishQueue": "./src/queue/quizPublishQueue.js",
     "./queue/predictPublishQueue": "./src/queue/predictPublishQueue.js",
     "./queue/queueRegistry": "./src/queue/queueRegistry.js",
+    "./queue/addUserPointsQueue": "./src/queue/addUserPointsQueue.js",
     "./lang/translationHelper": "./src/lang/translationHelper.js",
     "./*": "./src/*"
   },

package/src/index.js

@@ -30,5 +30,6 @@ module.exports = {
   addImageAlbumPublishJob: require("./queue/imageAlbumPublishQueue")
     .addImageAlbumPublishJob,
   addEventPublishJob: require("./queue/eventPublishQueue").addEventPublishJob,
+  addShopPublishJob: require("./queue/shopPublishQueue").addShopPublishJob,
   addUserPointsJob: require("./queue/addUserPointsQueue").addUserPointsJob,
 };

package/src/queue/shopPublishQueue.js

@@ -0,0 +1,187 @@
+// src/queue/shopPublishQueue.js
+// One-off *publish* scheduler for shop items (BullMQ).
+// Strong upsert: purge any prior job for the same shop before adding a new delayed job.
+
+const { Queue } = require("bullmq");
+const redisClient = require("../redis/redisClient");
+// const logger = require('../logger'); // optional
+
+const DEBUG = String(process.env.DEBUG_LOGGER || "").trim() === "1";
+const DRIFT_MS = Math.max(0, Number(process.env.SCHEDULE_DRIFT_MS || 250));
+
+const shopPublishQueue = new Queue("shopPublishQueue", {
+  connection: redisClient,
+  defaultJobOptions: {
+    attempts: 5,
+    backoff: { type: "exponential", delay: 2000 },
+    removeOnComplete: 500,
+    removeOnFail: 500,
+  },
+});
+
+// ── ID helpers ────────────────────────────────────────────────────────────────
+
+/** Replace invalid chars for BullMQ IDs */
+function sanitizeId(str) {
+  return str.replace(/[:.]/g, "-");
+}
+
+/** Stable id (latest schedule) */
+function stableJobId(shop_id) {
+  return sanitizeId(`shop:publish:${shop_id}`);
+}
+
+/** Versioned id (keeps history distinct) */
+function versionedJobId(shop_id, runAtIso) {
+  return sanitizeId(`shop:publish:${shop_id}:${runAtIso}`);
+}
+
+// ── Time helpers ──────────────────────────────────────────────────────────────
+
+/** Parse anything into a UTC Date. Strings without timezone are treated as UTC. */
+function normalizeToUtcDate(input) {
+  if (input instanceof Date) return new Date(input.getTime());
+  if (typeof input === "number") return new Date(input); // epoch ms
+
+  if (typeof input === "string") {
+    // Has timezone (Z or ±hh:mm)
+    if (/[zZ]|[+\-]\d{2}:\d{2}$/.test(input)) {
+      const d = new Date(input);
+      if (Number.isNaN(d.getTime()))
+        throw new Error(`Invalid ISO datetime: ${input}`);
+      return d;
+    }
+    // No timezone => treat as UTC
+    const s = input.trim().replace(" ", "T");
+    const d = new Date(`${s}Z`);
+    if (Number.isNaN(d.getTime()))
+      throw new Error(`Invalid datetime (no tz): ${input}`);
+    return d;
+  }
+
+  throw new Error(`Unsupported runAtUtc type: ${typeof input}`);
+}
+
+// ── Purge helpers ────────────────────────────────────────────────────────────
+
+async function findPendingShopJobs(shop_id) {
+  const states = ["delayed", "waiting", "waiting-children", "active"];
+  const jobs = await shopPublishQueue.getJobs(states);
+  return jobs.filter(
+    (j) => j?.name === "shop:publish" && j?.data?.shop_id === String(shop_id),
+  );
+}
+
+async function purgeExistingForShop(shop_id) {
+  let removed = 0;
+
+  // Remove any pending/waiting/active jobs for this shop
+  const pendings = await findPendingShopJobs(shop_id);
+  for (const j of pendings) {
+    try {
+      await j.remove();
+      removed++;
+    } catch (e) {
+      if (DEBUG)
+        console.warn(
+          `[shopPublishQueue] failed to remove pending job ${j.id}: ${e.message}`,
+        );
+    }
+  }
+
+  // Also remove a leftover stable job if present
+  const last = await shopPublishQueue.getJob(stableJobId(shop_id));
+  if (last) {
+    try {
+      await last.remove();
+      removed++;
+    } catch (e) {
+      if (DEBUG)
+        console.warn(
+          `[shopPublishQueue] failed to remove stable job ${last.id}: ${e.message}`,
+        );
+    }
+  }
+
+  if (DEBUG) {
+    console.info("[shopPublishQueue] purgeExistingForShop", {
+      shop_id: String(shop_id),
+      removed,
+    });
+  }
+  return removed;
+}
+
+// ── Public API ───────────────────────────────────────────────────────────────
+
+/**
+ * Upsert a one-off publish job for a shop item.
+ * - Purges any previous jobs for this shop
+ * - Uses a versioned jobId by default (or stable if useStableId=true)
+ *
+ * @param {Object} params
+ * @param {string|number} params.shop_id
+ * @param {string|number|Date} params.runAtUtc - ISO string, epoch ms, or Date (UTC)
+ * @param {object} [params.extra]
+ * @param {boolean} [params.useStableId=false] - if true, uses stable jobId
+ */
+async function addShopPublishJob({
+  shop_id,
+  runAtUtc,
+  extra = {},
+  useStableId = false,
+}) {
+  if (!shop_id || !runAtUtc) {
+    throw new Error("addShopPublishJob: shop_id and runAtUtc are required");
+  }
+
+  const runAt = normalizeToUtcDate(runAtUtc);
+  const runAtIso = runAt.toISOString();
+
+  // Drift guard to avoid immediate fire due to ms skew
+  const now = Date.now();
+  let delayMs = runAt.getTime() - now;
+  if (delayMs < DRIFT_MS) delayMs = Math.max(0, DRIFT_MS);
+
+  // Purge any prior jobs for this shop (across states)
+  await purgeExistingForShop(shop_id);
+
+  // Choose jobId strategy
+  const jobId = useStableId
+    ? stableJobId(shop_id)
+    : versionedJobId(shop_id, runAtIso);
+
+  const job = await shopPublishQueue.add(
+    "shop:publish",
+    { shop_id: String(shop_id), runAtUtc: runAtIso, extra },
+    { jobId, delay: delayMs },
+  );
+
+  if (DEBUG) {
+    console.info("[shopPublishQueue] upsert", {
+      shop_id: String(shop_id),
+      jobId,
+      runAtIso,
+      delayMs,
+      nowIso: new Date(now).toISOString(),
+    });
+  }
+
+  return job;
+}
+
+/** Cancel any scheduled publish for a given shop (if present). */
+async function cancelShopPublishJob(shop_id) {
+  const removed = await purgeExistingForShop(shop_id);
+  return removed > 0;
+}
+
+module.exports = {
+  shopPublishQueue,
+  addShopPublishJob,
+  cancelShopPublishJob,
+  // helpers (useful for tooling/tests)
+  stableJobId,
+  versionedJobId,
+  normalizeToUtcDate,
+};