@yellowpanther/shared 1.2.0 → 1.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yellowpanther/shared",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "publishConfig": {
     "access": "public"
   },
@@ -25,6 +25,7 @@
     "./queue/articlePublishQueue": "./src/queue/articlePublishQueue.js",
     "./queue/videoPublishQueue": "./src/queue/videoPublishQueue.js",
     "./queue/imagePublishQueue": "./src/queue/imagePublishQueue.js",
+    "./queue/imageAlbumPublishQueue": "./src/queue/imageAlbumPublishQueue.js",
     "./queue/pagePublishQueue": "./src/queue/pagePublishQueue.js",
     "./queue/productPublishQueue": "./src/queue/productPublishQueue.js",
     "./queue/quizPublishQueue": "./src/queue/quizPublishQueue.js",

package/src/index.js

@@ -18,5 +18,5 @@ module.exports = {
   addProductPublishJob: require('./queue/productPublishQueue').addProductPublishJob,
   addQuizPublishJob: require('./queue/quizPublishQueue').addQuizPublishJob,
   addPredictionPublishJob: require('./queue/predictionPublishQueue').addPredictionPublishJob,
-
+  addImageAlbumPublishJob: require('./queue/imageAlbumPublishQueue').addImageAlbumPublishJob,
 };

package/src/queue/imageAlbumPublishQueue.js

@@ -0,0 +1,164 @@
+// src/queue/imageAlbumPublishQueue.js
+// One-off *publish* scheduler for image album items (BullMQ).
+// Strong upsert: purge any prior job for the same album before adding a new delayed job.
+
+const { Queue } = require('bullmq');
+const redisClient = require('../redis/redisClient');
+// const logger = require('../logger'); // uncomment if you have a shared logger
+
+const DEBUG    = String(process.env.DEBUG_LOGGER || '').trim() === '1';
+const DRIFT_MS = Math.max(0, Number(process.env.SCHEDULE_DRIFT_MS || 250));
+
+const imageAlbumPublishQueue = new Queue('imageAlbumPublishQueue', {
+  connection: redisClient,
+  defaultJobOptions: {
+    attempts: 5,
+    backoff: { type: 'exponential', delay: 2000 },
+    removeOnComplete: 500,
+    removeOnFail: 500,
+  },
+});
+
+// ── ID helpers ────────────────────────────────────────────────────────────────
+
+function stableJobId(album_id) {
+  return `imageAlbum:publish:${album_id}`;
+}
+function versionedJobId(album_id, runAtIso) {
+  return `imageAlbum:publish:${album_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 findPendingAlbumJobs(album_id) {
+  const states = ['delayed', 'waiting', 'waiting-children', 'active'];
+  const jobs = await imageAlbumPublishQueue.getJobs(states);
+  return jobs.filter(
+    (j) => j?.name === 'imageAlbum:publish' && j?.data?.album_id === String(album_id)
+  );
+}
+
+async function purgeExistingForAlbum(album_id) {
+  let removed = 0;
+
+  // Remove any pending/waiting/active jobs for this album
+  const pendings = await findPendingAlbumJobs(album_id);
+  for (const j of pendings) {
+    try {
+      await j.remove();
+      removed++;
+    } catch (e) {
+      if (DEBUG) console.warn(`[imageAlbumPublishQueue] failed to remove pending job ${j.id}: ${e.message}`);
+    }
+  }
+
+  // Also remove a leftover stable job if present
+  const last = await imageAlbumPublishQueue.getJob(stableJobId(album_id));
+  if (last) {
+    try {
+      await last.remove();
+      removed++;
+    } catch (e) {
+      if (DEBUG) console.warn(`[imageAlbumPublishQueue] failed to remove stable job ${last.id}: ${e.message}`);
+    }
+  }
+
+  if (DEBUG) {
+    console.info('[imageAlbumPublishQueue] purgeExistingForAlbum', {
+      album_id: String(album_id),
+      removed,
+    });
+  }
+  return removed;
+}
+
+// ── Public API ───────────────────────────────────────────────────────────────
+
+/**
+ * Upsert a one-off publish job for an image album.
+ * - Purges any previous jobs for this album
+ * - Uses a versioned jobId by default (or stable if useStableId=true)
+ *
+ * @param {Object} params
+ * @param {string|number} params.album_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 addImageAlbumPublishJob({ album_id, runAtUtc, extra = {}, useStableId = false }) {
+  if (!album_id || !runAtUtc) {
+    throw new Error('addImageAlbumPublishJob: album_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 album (across states)
+  await purgeExistingForAlbum(album_id);
+
+  // Choose jobId strategy
+  const jobId = useStableId ? stableJobId(album_id) : versionedJobId(album_id, runAtIso);
+
+  const job = await imageAlbumPublishQueue.add(
+    'imageAlbum:publish',
+    { album_id: String(album_id), runAtUtc: runAtIso, extra },
+    { jobId, delay: delayMs }
+  );
+
+  if (DEBUG) {
+    console.info('[imageAlbumPublishQueue] upsert', {
+      album_id: String(album_id),
+      jobId,
+      runAtIso,
+      delayMs,
+      nowIso: new Date(now).toISOString(),
+    });
+  }
+
+  return job;
+}
+
+/** Cancel any scheduled publish for a given image album (if present). */
+async function cancelImageAlbumPublishJob(album_id) {
+  const removed = await purgeExistingForAlbum(album_id);
+  return removed > 0;
+}
+
+module.exports = {
+  imageAlbumPublishQueue,
+  addImageAlbumPublishJob,
+  cancelImageAlbumPublishJob,
+  // helpers for tooling/tests
+  stableJobId,
+  versionedJobId,
+  normalizeToUtcDate,
+};