backend-manager 4.2.7 → 4.2.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "backend-manager",
-  "version": "4.2.7",
+  "version": "4.2.9",
   "description": "Quick tools for developing Firebase functions",
   "main": "src/manager/index.js",
   "bin": {
@@ -79,7 +79,7 @@
     "uid-generator": "^2.0.0",
     "ultimate-jekyll-poster": "^1.0.2",
     "uuid": "^9.0.1",
-    "wonderful-fetch": "^1.3.0",
+    "wonderful-fetch": "^1.3.1",
     "wonderful-log": "^1.0.7",
     "wonderful-version": "^1.2.0",
     "yaml": "^2.6.1",

package/src/manager/functions/core/actions/api/admin/send-email.js

@@ -0,0 +1,265 @@
+// Module
+function Module() {
+
+}
+
+// Main
+Module.prototype.main = function () {
+  const self = this;
+
+  // Shortcuts
+  const Manager = self.Manager;
+  const Api = self.Api;
+  const assistant = self.assistant;
+  const payload = self.payload;
+
+  return new Promise(async function(resolve, reject) {
+    // Load libraries
+    const fetch = Manager.require('wonderful-fetch');
+
+    // Set up response obj
+    payload.response.data = {};
+
+    // Fix notification payload
+    const email = payload.data.payload;
+
+    // Log
+    assistant.log('Resolved email payload', email)
+
+    // Check if user is admin
+    if (!payload.user.roles.admin) {
+      return reject(assistant.errorify(`Admin required.`, {code: 401}));
+    }
+
+    // Attach BEM key since we are authorized
+    email.backendManagerKey = Manager?.config?.backend_manager?.key;
+
+    // Make request to ITW email service
+    await fetch('https://us-central1-itw-creative-works.cloudfunctions.net/sendEmail', {
+      method: 'POST',
+      response: 'json',
+      body: email,
+    })
+    .then((r) => {
+      // Set response
+      payload.response.data = r;
+
+      // Resolve
+      return resolve({data: payload.response.data})
+    })
+    .catch((e) => {
+      return reject(assistant.errorify(`Failed to send email: ${e}`, {code: 400, sentry: true}));
+    })
+  });
+
+};
+
+// HELPERS //
+Module.prototype.processTokens = async function (note, options) {
+  const self = this;
+
+  // Shortcuts
+  const Manager = self.Manager;
+  const Api = self.Api;
+  const assistant = self.assistant;
+  const payload = self.payload;
+
+  // Set options
+  options = options || {};
+  options.tags = options.tags || false;
+
+  // Define collection path
+  const queryConditions = options.tags
+    ? [{ field: 'tags', operator: 'array-contains-any', value: options.tags }]
+    : [];
+
+  // Batch processing logic
+  await Manager.Utilities().iterateCollection(
+    async (batch, index) => {
+      let batchTokens = [];
+
+      // Collect tokens from the current batch
+      for (const doc of batch.docs) {
+        const data = doc.data();
+        batchTokens.push(data.token);
+      }
+
+      // Send the batch
+      try {
+        assistant.log(`Sending batch ${index} with ${batchTokens.length} tokens.`);
+        await self.sendBatch(batchTokens, note, index);
+      } catch (e) {
+        assistant.error(`Error sending batch ${index}`, e);
+      }
+    },
+    {
+      collection: PATH_NOTIFICATIONS,
+      where: queryConditions,
+      batchSize: BATCH_SIZE,
+      log: true,
+    }
+  )
+  .then(() => {
+    assistant.log('All batches processed successfully.');
+  })
+  .catch(e => {
+    assistant.errorify(`Error during token processing: ${e}`, { code: 500, log: true });
+  });
+};
+
+// Sending using SDK
+// https://firebase.google.com/docs/cloud-messaging/send-message#send-messages-to-multiple-devices
+
+// Manually sending
+// https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages/send
+// https://firebase.google.com/docs/cloud-messaging/migrate-v1#provide-credentials-manually
+Module.prototype.sendBatch = async function (batch, note, id) {
+  const self = this;
+
+  // Shortcuts
+  const Manager = self.Manager;
+  const Api = self.Api;
+  const assistant = self.assistant;
+  const payload = self.payload;
+
+  // Libraries
+  const { admin } = self.libraries;
+
+  try {
+    // Log
+    assistant.log(`Sending batch ID: ${id}`);
+    console.log('🚩🚩🚩🚩🚩', 1, ); // FLAG
+    assistant.log(`batch`, batch);
+    assistant.log(`note`, note);
+
+    try {
+      const response = await admin.messaging().sendMulticast({
+        tokens: batch,
+        notification: {
+          title: 'Your Notification Title',
+          body: 'This is the notification message.'
+        },
+        data: {
+          customDataKey: 'customDataValue' // Optional custom data payload
+        }
+      })
+
+      assistant.log(`🚩🚩🚩🚩🚩 222 response ${id}`, response); // FLAG
+    } catch (e) {
+      assistant.error(`🚩🚩🚩🚩🚩 222 error ${id}`, e);
+    }
+
+    try {
+      const response = await admin.messaging().sendMulticast({
+        tokens: batch,
+        notification: note.notification,
+      })
+
+      assistant.log(`🚩🚩🚩🚩🚩 333 response ${id}`, response); // FLAG
+    } catch (e) {
+      assistant.error(`🚩🚩🚩🚩🚩 333 error ${id}`, e);
+    }
+
+    try {
+      const messages = batch.map(token => ({
+        token: token,
+        notification: {
+          title: 'Your Notification Title',
+          body: 'This is the notification message.'
+        },
+      }));
+
+      const response = await admin.messaging().sendEach(messages);
+
+      assistant.log(`🚩🚩🚩🚩🚩 444 response ${id}`, response); // FLAG
+    } catch (e) {
+      assistant.error(`🚩🚩🚩🚩🚩 444 error ${id}`, e);
+    }
+
+    // Send the batch
+    const response = await admin.messaging().sendToDevice(batch, note);
+
+    // Log
+    assistant.log(`Sent batch ID: ${id}, Success: ${response.successCount}, Failures: ${response.failureCount}`);
+
+    // Clean bad tokens
+    if (response.failureCount > 0) {
+      await self.cleanTokens(batch, response.results, id);
+    }
+
+    // Update response
+    payload.response.data.sent += (batch.length - response.failureCount);
+  } catch (e) {
+    throw assistant.errorify(`Error sending batch ${id}: ${e}`, { code: 500, log: true });
+  }
+};
+
+Module.prototype.cleanTokens = async function (batch, results, id) {
+  const self = this;
+
+  // Shortcuts
+  const Manager = self.Manager;
+  const Api = self.Api;
+  const assistant = self.assistant;
+  const payload = self.payload;
+
+  // Log
+  assistant.log(`Cleaning ${results.length} tokens of batch ID: ${id}`);
+
+  // Filter out bad tokens
+  const cleanPromises = results
+    .map((item, index) => {
+      // Check if the token is bad
+      if (item.error && BAD_TOKEN_REASONS.includes(item.error.code)) {
+        const token = batch[index];
+
+        // Log
+        assistant.log(`Found bad token: ${token} (Reason: ${item.error.code})`);
+
+        // Delete the token
+        return self.deleteToken(token, item.error.code);
+      }
+
+      // Return null for valid tokens
+      return null;
+    })
+    // Filter out nulls for valid tokens
+    .filter(Boolean);
+
+  // Clean bad tokens
+  try {
+    await Promise.all(cleanPromises);
+    assistant.log(`Completed cleaning tokens for batch ID: ${id}`);
+  } catch (e) {
+    assistant.error(`Error cleaning tokens for batch ID: ${id}`, e);
+  }
+};
+
+Module.prototype.deleteToken = async function (token, errorCode) {
+  const self = this;
+
+  // Shortcuts
+  const Manager = self.Manager;
+  const Api = self.Api;
+  const assistant = self.assistant;
+  const payload = self.payload;
+
+  // Libraries
+  const { admin } = self.libraries;
+
+  // Delete the token
+  try {
+    // Delete the token
+    await admin.firestore().doc(`${PATH_NOTIFICATIONS}/${token}`).delete();
+
+    // Log
+    assistant.log(`Deleted bad token: ${token} (Reason: ${errorCode})`);
+
+    // Update response
+    payload.response.data.deleted++;
+  } catch (error) {
+    assistant.error(`Failed to delete bad token: ${token} (Reason: ${errorCode}). Error: ${error}`);
+  }
+};
+
+module.exports = Module;

package/src/manager/functions/core/actions/api/admin/send-notification.js

@@ -127,7 +127,12 @@ Module.prototype.processTokens = async function (note, options) {
   });
 };
 
+// Sending using SDK
 // https://firebase.google.com/docs/cloud-messaging/send-message#send-messages-to-multiple-devices
+
+// Manually sending
+// https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages/send
+// https://firebase.google.com/docs/cloud-messaging/migrate-v1#provide-credentials-manually
 Module.prototype.sendBatch = async function (batch, note, id) {
   const self = this;
 
@@ -147,8 +152,6 @@ Module.prototype.sendBatch = async function (batch, note, id) {
     assistant.log(`batch`, batch);
     assistant.log(`note`, note);
 
-    // Send the batch
-    // const response = await admin.messaging().sendToDevice(batch, note);
     try {
       const response = await admin.messaging().sendMulticast({
         tokens: batch,
@@ -177,6 +180,25 @@ Module.prototype.sendBatch = async function (batch, note, id) {
       assistant.error(`🚩🚩🚩🚩🚩 333 error ${id}`, e);
     }
 
+    try {
+      const messages = batch.map(token => ({
+        token: token,
+        notification: {
+          title: 'Your Notification Title',
+          body: 'This is the notification message.'
+        },
+      }));
+
+      const response = await admin.messaging().sendEach(messages);
+
+      assistant.log(`🚩🚩🚩🚩🚩 444 response ${id}`, response); // FLAG
+    } catch (e) {
+      assistant.error(`🚩🚩🚩🚩🚩 444 error ${id}`, e);
+    }
+
+    // Send the batch
+    const response = await admin.messaging().sendToDevice(batch, note);
+
     // Log
     assistant.log(`Sent batch ID: ${id}, Success: ${response.successCount}, Failures: ${response.failureCount}`);
 

package/src/manager/index.js

@@ -152,6 +152,9 @@ Manager.prototype.init = function (exporter, options) {
     ? self.assistant.meta.environment
     : process.env.ENVIRONMENT;
 
+  // Set BEM env variables
+  process.env.BEM_FUNCTIONS_URL = self.project.functionsUrl;
+
   // Use the working Firebase logger that they disabled for whatever reason
   if (
     process.env.GCLOUD_PROJECT