bulltrackers-module 1.0.16 → 1.0.17

package/functions/invalid-speculator-handler/helpers/handler_helpers.js

@@ -0,0 +1,85 @@
+/**
+ * @fileoverview
+ * Core logic for handling invalid speculator CIDs.
+ * Finds or creates a Firestore document and adds the CIDs to it.
+ */
+
+/**
+ * Handles the logic of storing invalid speculator IDs.
+ *
+ * @param {object} message The Pub/Sub message.
+ * @param {object} firestore An initialized Firestore client.
+ * @param {object} FieldValue A reference to Firestore.FieldValue.
+ * @param {object} logger A logger instance.
+ * @param {object} config The configuration object.
+ * @param {string} config.invalidSpeculatorsCollectionName The name of the Firestore collection.
+ * @param {number} config.maxInvalidUsersPerDoc The max number of IDs to store per doc.
+ */
+exports.handleInvalidSpeculator = async (message, firestore, FieldValue, logger, config) => {
+    try {
+        const { invalidCids } = JSON.parse(Buffer.from(message.data, 'base64').toString());
+
+        if (!invalidCids || invalidCids.length === 0) {
+            logger.log('WARN', 'Received message with no invalid CIDs. Nothing to do.');
+            return;
+        }
+
+        // Use config for collection name and max doc size
+        const collectionRef = firestore.collection(config.invalidSpeculatorsCollectionName);
+        const maxPerDoc = config.maxInvalidUsersPerDoc;
+
+        // Fetch a pool of documents and pick one randomly
+        const querySnapshot = await collectionRef
+            .where('userCount', '<', maxPerDoc)
+            .limit(10) // Fetch up to 10 potential documents
+            .get();
+
+        let targetDocRef;
+
+        if (!querySnapshot.empty) {
+            // Randomly select one of the available documents to reduce contention
+            const randomIndex = Math.floor(Math.random() * querySnapshot.docs.length);
+            targetDocRef = querySnapshot.docs[randomIndex].ref;
+        } else {
+            // If no documents have space, create a new one
+            targetDocRef = collectionRef.doc();
+        }
+
+        // Atomic update using a transaction
+        await firestore.runTransaction(async (transaction) => {
+            const doc = await transaction.get(targetDocRef);
+            
+            const updates = {};
+            let newUsersCount = 0;
+
+            if (!doc.exists) {
+                // If it's a new document, initialize the user count
+                updates.userCount = 0;
+            }
+
+            for (const cid of invalidCids) {
+                const fieldPath = `users.${cid}`;
+                // Check if the user ID already exists to avoid recounting
+                if (!doc.exists || !doc.data().users || !doc.data().users[cid]) {
+                    updates[fieldPath] = true;
+                    newUsersCount++;
+                }
+            }
+
+            if (newUsersCount > 0) {
+                updates.userCount = FieldValue.increment(newUsersCount);
+                transaction.set(targetDocRef, updates, { merge: true });
+            }
+        });
+
+        logger.log('SUCCESS', `Successfully stored ${invalidCids.length} invalid speculator IDs in document ${targetDocRef.id}.`);
+
+    } catch (error) {
+        logger.log('ERROR', 'FATAL Error in Invalid Speculator Handler', {
+            errorMessage: error.message,
+            errorStack: error.stack
+        });
+        // Re-throw the error to ensure Pub/Sub retries the message
+        throw error;
+    }
+};

package/functions/invalid-speculator-handler/index.js

@@ -0,0 +1,10 @@
+/**
+ * @fileoverview
+ * Exports the InvalidSpeculatorHandler helpers.
+ */
+
+const helpers = require('./helpers/handler_helpers');
+
+module.exports = {
+    helpers,
+};

package/index.js

@@ -10,6 +10,7 @@ const TaskEngine = require('./functions/task-engine');
 const ComputationSystem = require('./functions/computation-system');
 const GenericAPI = require('./functions/generic-api'); // <-- ADD THIS
 const Dispatcher = require('./functions/dispatcher'); // <-- ADD THIS
+const InvalidSpeculatorHandler = require('./functions/invalid-speculator-handler'); // <-- ADD THIS
 
 module.exports = {
   core,
@@ -17,5 +18,6 @@ module.exports = {
   TaskEngine,
   ComputationSystem,
   GenericAPI, // <-- AND ADD THIS
-  Dispatcher, // <-- AND ADD THI
+  Dispatcher, // <-- AND ADD THIS
+  InvalidSpeculatorHandler, // <-- AND ADD THIS
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bulltrackers-module",
-  "version": "1.0.16",
+  "version": "1.0.17",
   "description": "Helper Functions for Bulltrackers.",
   "main": "index.js",
   "files": [
@@ -10,7 +10,8 @@
     "functions/core/",
     "functions/computation-system/",
     "functions/generic-api/",
-    "functions/dispatcher/"
+    "functions/dispatcher/",
+    "functions/invalid-speculator-handler/"
   ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"