🔥🚀 feat: CDN (Firebase) & feat: account section (#1438)

* localization + api-endpoint

* docs: added firebase documentation

* chore: icons

* chore: SettingsTabs

* feat: account pannel; fix: gear icons

* docs: position update

* feat: firebase

* feat: plugin support

* route

* fixed bugs with firebase and moved a lot of files

* chore(DALLE3): using UUID v4

* feat: support for social strategies; moved '/images' path

* fix: data ignored

* gitignore update

* docs: update firebase guide

* refactor: Firebase
- use singleton pattern for firebase initialization, initially on server start
- reorganize imports, move firebase specific files to own service under Files
- rename modules to remove 'avatar' redundancy
- fix imports based on changes

* ci(DALLE/DALLE3): fix tests to use logger and new expected outputs, add firebase tests

* refactor(loadToolWithAuth): pass userId to tool as field

* feat(images/parse): feat: Add URL Image Basename Extraction

Implement a new module to extract the basename of an image from a given URL. This addition includes the  function, which parses the URL and retrieves the basename using the Node.js 'url' and 'path' modules. The function is documented with JSDoc comments for better maintainability and understanding. This feature enhances the application's ability to handle and process image URLs efficiently.

* refactor(addImages): function to use a more specific regular expression for observedImagePath based on the generated image markdown standard across the app

* refactor(DALLE/DALLE3): utilize `getImageBasename` and `this.userId`; fix: pass correct image path to firebase url helper

* fix(addImages): make more general to match any image markdown descriptor

* fix(parse/getImageBasename): test result of this function for an actual image basename

* ci(DALLE3): mock getImageBasename

* refactor(AuthContext): use Recoil atom state for user

* feat: useUploadAvatarMutation, react-query hook for avatar upload

* fix(Toast): stack z-order of Toast over all components (1000)

* refactor(showToast): add optional status field to avoid importing NotificationSeverity on each use of the function

* refactor(routes/avatar): remove unnecessary get route, get userId from req.user.id, require auth on POST request

* chore(uploadAvatar): TODO: remove direct use of Model, `User`

* fix(client): fix Spinner imports

* refactor(Avatar): use react-query hook, Toast, remove unnecessary states, add optimistic UI to upload

* fix(avatar/localStrategy): correctly save local profile picture and cache bust for immediate rendering; fix: firebase init info message (only show once)

* fix: use `includes` instead of `endsWith` for checking manual query of avatar image path in case more queries are appended (as is done in avatar/localStrategy)

---------

Co-authored-by: Danny Avila <messagedaniel@protonmail.com>

api/server/index.js

@@ -4,6 +4,7 @@ const cors = require('cors');
 const express = require('express');
 const passport = require('passport');
 const mongoSanitize = require('express-mongo-sanitize');
+const { initializeFirebase } = require('~/server/services/Files/Firebase/initialize');
 const errorController = require('./controllers/ErrorController');
 const configureSocialLogins = require('./socialLogins');
 const { connectDb, indexSync } = require('~/lib/db');
@@ -23,6 +24,7 @@ const { jwtLogin, passportLogin } = require('~/strategies');
 const startServer = async () => {
   await connectDb();
   logger.info('Connected to MongoDB');
+  initializeFirebase();
   await indexSync();
 
   const app = express();

api/server/routes/files/avatar.js

@@ -0,0 +1,34 @@
+const express = require('express');
+const multer = require('multer');
+
+const uploadAvatar = require('~/server/services/Files/images/avatar/uploadAvatar');
+const { requireJwtAuth } = require('~/server/middleware/');
+const User = require('~/models/User');
+
+const upload = multer();
+const router = express.Router();
+
+router.post('/', requireJwtAuth, upload.single('input'), async (req, res) => {
+  try {
+    const userId = req.user.id;
+    const { manual } = req.body;
+    const input = req.file.buffer;
+    if (!userId) {
+      throw new Error('User ID is undefined');
+    }
+
+    // TODO: do not use Model directly, instead use a service method that uses the model
+    const user = await User.findById(userId).lean();
+
+    if (!user) {
+      throw new Error('User not found');
+    }
+    const url = await uploadAvatar(userId, input, manual);
+
+    res.json({ url });
+  } catch (error) {
+    res.status(500).json({ message: 'An error occurred while uploading the profile picture' });
+  }
+});
+
+module.exports = router;

api/server/routes/files/index.js

@@ -18,5 +18,6 @@ router.use(uaParser);
 
 router.use('/', files);
 router.use('/images', images);
+router.use('/images/avatar', require('./avatar'));
 
 module.exports = router;

api/server/services/Files/Firebase/images.js

@@ -0,0 +1,45 @@
+const fetch = require('node-fetch');
+const { ref, uploadBytes, getDownloadURL } = require('firebase/storage');
+const { getFirebaseStorage } = require('./initialize');
+
+async function saveImageToFirebaseStorage(userId, imageUrl, imageName) {
+  const storage = getFirebaseStorage();
+  if (!storage) {
+    console.error('Firebase is not initialized. Cannot save image to Firebase Storage.');
+    return null;
+  }
+
+  const storageRef = ref(storage, `images/${userId.toString()}/${imageName}`);
+
+  try {
+    // Upload image to Firebase Storage using the image URL
+    await uploadBytes(storageRef, await fetch(imageUrl).then((response) => response.buffer()));
+    return imageName;
+  } catch (error) {
+    console.error('Error uploading image to Firebase Storage:', error.message);
+    return null;
+  }
+}
+
+async function getFirebaseStorageImageUrl(imageName) {
+  const storage = getFirebaseStorage();
+  if (!storage) {
+    console.error('Firebase is not initialized. Cannot get image URL from Firebase Storage.');
+    return null;
+  }
+
+  const storageRef = ref(storage, `images/${imageName}`);
+
+  try {
+    // Get the download URL for the image from Firebase Storage
+    return `![generated image](${await getDownloadURL(storageRef)})`;
+  } catch (error) {
+    console.error('Error fetching image URL from Firebase Storage:', error.message);
+    return null;
+  }
+}
+
+module.exports = {
+  saveImageToFirebaseStorage,
+  getFirebaseStorageImageUrl,
+};

api/server/services/Files/Firebase/index.js

@@ -0,0 +1,7 @@
+const images = require('./images');
+const initialize = require('./initialize');
+
+module.exports = {
+  ...images,
+  ...initialize,
+};

api/server/services/Files/Firebase/initialize.js

@@ -0,0 +1,42 @@
+const firebase = require('firebase/app');
+const { getStorage } = require('firebase/storage');
+const { logger } = require('~/config');
+
+let i = 0;
+let firebaseApp = null;
+
+const initializeFirebase = () => {
+  // Return existing instance if already initialized
+  if (firebaseApp) {
+    return firebaseApp;
+  }
+
+  const firebaseConfig = {
+    apiKey: process.env.FIREBASE_API_KEY,
+    authDomain: process.env.FIREBASE_AUTH_DOMAIN,
+    projectId: process.env.FIREBASE_PROJECT_ID,
+    storageBucket: process.env.FIREBASE_STORAGE_BUCKET,
+    messagingSenderId: process.env.FIREBASE_MESSAGING_SENDER_ID,
+    appId: process.env.FIREBASE_APP_ID,
+  };
+
+  if (Object.values(firebaseConfig).some((value) => !value)) {
+    i === 0 &&
+      logger.info(
+        '[Optional] Firebase configuration missing or incomplete. Firebase will not be initialized.',
+      );
+    i++;
+    return null;
+  }
+
+  firebaseApp = firebase.initializeApp(firebaseConfig);
+  logger.info('Firebase initialized');
+  return firebaseApp;
+};
+
+const getFirebaseStorage = () => {
+  const app = initializeFirebase();
+  return app ? getStorage(app) : null;
+};
+
+module.exports = { initializeFirebase, getFirebaseStorage };

api/server/services/Files/images/avatar/firebaseStrategy.js

@@ -0,0 +1,29 @@
+const { ref, uploadBytes, getDownloadURL } = require('firebase/storage');
+const { getFirebaseStorage } = require('~/server/services/Files/Firebase/initialize');
+const { logger } = require('~/config');
+
+async function firebaseStrategy(userId, webPBuffer, oldUser, manual) {
+  try {
+    const storage = getFirebaseStorage();
+    if (!storage) {
+      throw new Error('Firebase is not initialized.');
+    }
+    const avatarRef = ref(storage, `images/${userId.toString()}/avatar`);
+
+    await uploadBytes(avatarRef, webPBuffer);
+    const urlFirebase = await getDownloadURL(avatarRef);
+    const isManual = manual === 'true';
+
+    const url = `${urlFirebase}?manual=${isManual}`;
+    if (isManual) {
+      oldUser.avatar = url;
+      await oldUser.save();
+    }
+    return url;
+  } catch (error) {
+    logger.error('Error uploading profile picture:', error);
+    throw error;
+  }
+}
+
+module.exports = firebaseStrategy;

api/server/services/Files/images/avatar/localStrategy.js

@@ -0,0 +1,32 @@
+const fs = require('fs').promises;
+const path = require('path');
+
+async function localStrategy(userId, webPBuffer, oldUser, manual) {
+  const userDir = path.resolve(
+    __dirname,
+    '..',
+    '..',
+    '..',
+    '..',
+    '..',
+    '..',
+    'client',
+    'public',
+    'images',
+    userId,
+  );
+  let avatarPath = path.join(userDir, 'avatar.png');
+  const urlRoute = `/images/${userId}/avatar.png`;
+  await fs.mkdir(userDir, { recursive: true });
+  await fs.writeFile(avatarPath, webPBuffer);
+  const isManual = manual === 'true';
+  let url = `${urlRoute}?manual=${isManual}&timestamp=${new Date().getTime()}`;
+  if (isManual) {
+    oldUser.avatar = url;
+    await oldUser.save();
+  }
+
+  return url;
+}
+
+module.exports = localStrategy;

api/server/services/Files/images/avatar/uploadAvatar.js

@@ -0,0 +1,63 @@
+const sharp = require('sharp');
+const fetch = require('node-fetch');
+const fs = require('fs').promises;
+const User = require('~/models/User');
+const { getFirebaseStorage } = require('~/server/services/Files/Firebase/initialize');
+const firebaseStrategy = require('./firebaseStrategy');
+const localStrategy = require('./localStrategy');
+const { logger } = require('~/config');
+
+async function convertToWebP(inputBuffer) {
+  return sharp(inputBuffer).resize({ width: 150 }).toFormat('webp').toBuffer();
+}
+
+async function uploadAvatar(userId, input, manual) {
+  try {
+    if (userId === undefined) {
+      throw new Error('User ID is undefined');
+    }
+    const _id = userId;
+    // TODO: remove direct use of Model, `User`
+    const oldUser = await User.findOne({ _id });
+    let imageBuffer;
+    if (typeof input === 'string') {
+      const response = await fetch(input);
+
+      if (!response.ok) {
+        throw new Error(`Failed to fetch image from URL. Status: ${response.status}`);
+      }
+      imageBuffer = await response.buffer();
+    } else if (input instanceof Buffer) {
+      imageBuffer = input;
+    } else if (typeof input === 'object' && input instanceof File) {
+      const fileContent = await fs.readFile(input.path);
+      imageBuffer = Buffer.from(fileContent);
+    } else {
+      throw new Error('Invalid input type. Expected URL, Buffer, or File.');
+    }
+    const { width, height } = await sharp(imageBuffer).metadata();
+    const minSize = Math.min(width, height);
+    const squaredBuffer = await sharp(imageBuffer)
+      .extract({
+        left: Math.floor((width - minSize) / 2),
+        top: Math.floor((height - minSize) / 2),
+        width: minSize,
+        height: minSize,
+      })
+      .toBuffer();
+    const webPBuffer = await convertToWebP(squaredBuffer);
+    const storage = getFirebaseStorage();
+    if (storage) {
+      const url = await firebaseStrategy(userId, webPBuffer, oldUser, manual);
+      return url;
+    }
+
+    const url = await localStrategy(userId, webPBuffer, oldUser, manual);
+    return url;
+  } catch (error) {
+    logger.error('Error uploading the avatar:', error);
+    throw error;
+  }
+}
+
+module.exports = uploadAvatar;

api/server/services/Files/images/index.js

@@ -1,11 +1,15 @@
 const convert = require('./convert');
 const encode = require('./encode');
+const parse = require('./parse');
 const resize = require('./resize');
 const validate = require('./validate');
+const uploadAvatar = require('./avatar/uploadAvatar');
 
 module.exports = {
   ...convert,
   ...encode,
+  ...parse,
   ...resize,
   ...validate,
+  uploadAvatar,
 };

api/server/services/Files/images/parse.js

@@ -0,0 +1,27 @@
+const URL = require('url').URL;
+const path = require('path');
+
+const imageExtensionRegex = /\.(jpg|jpeg|png|gif|bmp|tiff|svg)$/i;
+
+/**
+ * Extracts the image basename from a given URL.
+ *
+ * @param {string} urlString - The URL string from which the image basename is to be extracted.
+ * @returns {string} The basename of the image file from the URL.
+ * Returns an empty string if the URL does not contain a valid image basename.
+ */
+function getImageBasename(urlString) {
+  try {
+    const url = new URL(urlString);
+    const basename = path.basename(url.pathname);
+
+    return imageExtensionRegex.test(basename) ? basename : '';
+  } catch (error) {
+    // If URL parsing fails, return an empty string
+    return '';
+  }
+}
+
+module.exports = {
+  getImageBasename,
+};