Added Firestore implementation

Author: TOPOFGR

README.md

@@ -64,6 +64,7 @@ React Firebase Admin is our in-house admin dashboard boilerplate, used in many o
 - PWA ready thanks to CRA and Firebase
 - Multi-tenancy
 - Internationalization (English/Spanish)
+- Ability to choose between realtime database or firestore
 
 ## Tech Stack
 
@@ -88,6 +89,7 @@ React Firebase Admin is our in-house admin dashboard boilerplate, used in many o
 - [Format.js](https://formatjs.io/) (★ 11.7k) libraries for internationalization (see [docs](https://formatjs.io/docs/basic-internationalization-principles)).
 - [date-fns](https://date-fns.org/) (★ 22.3k) date utility library (see [docs](https://date-fns.org/docs/Getting-Started)).
 - [cross-env](https://github.com/kentcdodds/cross-env) (★ 4.9k) run scripts that set and use environment variables across platforms (see [docs](https://www.npmjs.com/package/cross-env)).
+- [Inquirer](https://github.com/SBoudrias/Inquirer.js/) (★ 12.2k) A collection of common interactive command line user interfaces (see [docs](https://github.com/SBoudrias/Inquirer.js/#documentation)).
 
 ### Unit Testing
 

config.json

@@ -23,6 +23,11 @@
     "predeploy": [
       "npm --prefix \"$RESOURCE_DIR\" run lint",
       "npm --prefix \"$RESOURCE_DIR\" run build"
-    ]
+    ],
+    "source": "functions"
+  },
+  "firestore": {
+    "rules": "firestore.rules",
+    "indexes": "firestore.indexes.json"
   }
 }

firebase.json

@@ -0,0 +1,4 @@
+{
+  "indexes": [],
+  "fieldOverrides": []
+}

firestore.indexes.json

@@ -0,0 +1,29 @@
+rules_version = '2';
+service cloud.firestore {
+  match /databases/{database}/documents {
+    
+    function isAuthenticated() {
+    	return request.auth != null && request.auth.token.email_verified == true;
+    }
+
+    function isAdmin() {
+      return request.auth.token.isAdmin == true;
+    }
+    
+
+    match /users/{userId} {
+      
+    function isIdentified() {
+      return request.auth.uid == userId;
+    }
+
+      allow read: if isAuthenticated() && (isAdmin() || isIdentified());
+
+      allow write: if isAuthenticated() && isAdmin();
+     
+      allow update: if isAuthenticated() && (isAdmin() || isIdentified());
+     
+      allow delete: if isAuthenticated() && isAdmin();
+    }
+  }
+}

firestore.rules

@@ -5,7 +5,7 @@ const admin = require('firebase-admin');
 const inquirer = require('inquirer');
 const fs = require('fs');
 
-const configPath = '../config.json';
+const configPath = '../src/state/api/index.js';
 
 const questions = [
   {
@@ -33,7 +33,7 @@ const questions = [
     type: 'list',
     name: 'database',
     message: 'Select the database of your choice:',
-    choices: ['Real Time Database', 'Firestore'],
+    choices: ['Realtime Database', 'Firestore'],
   },
 ];
 
@@ -57,16 +57,16 @@ const deleteDatabase = async (database) => {
     fs.rmdirSync(`./src/${dir}`, { recursive: true });
 
     console.log(`${database} cloud functions are deleted!`);
-  } catch (err) {
-    console.error(`Error while deleting ${database}.`);
+  } catch (error) {
+    console.error(`Error while deleting ${database}. ${error}`);
   }
 
   try {
     fs.rmdirSync(`./test/${dir}`, { recursive: true });
 
     console.log(`${dir} tests are deleted!`);
-  } catch (err) {
-    console.error(`Error while deleting ${database}.`);
+  } catch (error) {
+    console.error(`Error while deleting ${database} tests. ${error}`);
   }
 };
 

functions/package-lock.json

@@ -6,7 +6,7 @@ import 'mocha';
 
 chai.use(chaiAsPromised);
 
-describe('onDelete Real Time Database', () => {
+describe('onDelete Realtime Database', () => {
   let userRecord: any;
 
   it('should delete the user from the authentication section', async () => {

functions/setupProject.js

@@ -3,7 +3,7 @@ import * as chai from 'chai';
 import onUpdate from '../../../src/db/users/onUpdate.function';
 import 'mocha';
 
-describe('onUpdate Real Time Database', () => {
+describe('onUpdate Realtime Database', () => {
   let userRecord: any;
 
   before(async () => {

functions/test/db/users/onDelete.test.ts

@@ -3,6 +3,7 @@ import 'firebase/database';
 import 'firebase/auth';
 import 'firebase/storage';
 import 'firebase/functions';
+import 'firebase/firestore';
 
 const config = {
   apiKey: process.env.REACT_APP_FIRE_BASE_KEY,
@@ -12,7 +13,7 @@ const config = {
   storageBucket: process.env.REACT_APP_FIRE_BASE_STORAGE_BUCKET,
   messagingSenderId: process.env.REACT_APP_FIRE_BASE_MESSAGING_SENDER_ID,
   appId: process.env.REACT_APP_FIRE_BASE_APP_ID,
-  measurementId: process.env.REACT_APP_FIRE_BASE_MEASURMENT_ID
+  measurementId: process.env.REACT_APP_FIRE_BASE_MEASURMENT_ID,
 };
 
 firebase.initializeApp(config);

functions/test/db/users/onUpdate.test.ts

@@ -9,7 +9,7 @@ import {
   fetchDocument,
   createDocument,
   deleteDocument,
-  modifyDocument,
+  updateDocument,
 } from '../api';
 
 export const USERS_FETCH_DATA_INIT = createAction('USERS_FETCH_DATA_INIT');
@@ -256,7 +256,7 @@ export const modifyUser = ({
       isAdmin,
       logoUrl: logoUrl || newLogoUrl,
     };
-    const updateUserDbTask = modifyDocument('users', id, userData);
+    const updateUserDbTask = updateDocument('users', id, userData);
 
     try {
       await Promise.all([deleteLogoTask, uploadLogoTask, updateUserDbTask]);

src/firebase.js

@@ -0,0 +1,46 @@
+import firebase from 'firebase.js';
+
+const getFirestoreRef = (path) => firebase.firestore().collection(path);
+
+export const fetchDocument = async (collection, id) => {
+  const document = await getFirestoreRef(collection).doc(id).get();
+  if (!document.exists) {
+    return null;
+  }
+
+  return { id: document.id, ...document.data() };
+};
+
+export const fetchCollection = async (collection, options = {}) => {
+  const data = [];
+  let baseQuery = getFirestoreRef(collection);
+
+  if (options.queries) {
+    const { queries } = options;
+    queries.forEach(({ attribute, operator, value }) => {
+      baseQuery = baseQuery.where(attribute, operator, value);
+    });
+  }
+
+  if (options.sort) {
+    const { attribute, order } = options.sort;
+    baseQuery = baseQuery.orderBy(attribute, order);
+  }
+  (await baseQuery.get()).forEach((doc) =>
+    data.push({ id: doc.id, ...doc.data() })
+  );
+
+  return data;
+};
+
+export const deleteDocument = (collection, id) => {
+  return getFirestoreRef(collection).doc(id).delete();
+};
+
+export const createDocument = (collection, id, values) => {
+  return getFirestoreRef(collection).doc(id).set(values);
+};
+
+export const updateDocument = (collection, id, values) => {
+  return getFirestoreRef(collection).doc(id).update(values);
+};

src/state/actions/users.js

@@ -1,43 +1,15 @@
-import firebase from 'firebase.js';
-
-const getRealTimeRef = (path) => firebase.database().ref(path);
-
-export const fetchDocument = async (collection, id) => {
-  const document = (
-    await getRealTimeRef(`${collection}/${id}`).once(`value`)
-  ).val();
-
-  return document ? { id, ...document } : null;
-};
-
-export const fetchCollection = async (collection, options = {}) => {
-  let baseQuery = getRealTimeRef(collection);
-
-  if (options.filterBy) {
-    const { filterBy, value } = options;
-    baseQuery = baseQuery.orderByChild(filterBy).equalTo(value);
-  }
-
-  const fetchedCollection = (await baseQuery.once('value')).val();
-
-  const data = fetchedCollection
-    ? Object.entries(fetchedCollection).map(([key, value]) => ({
-        id: key,
-        ...value,
-      }))
-    : [];
-
-  return data;
-};
-
-export const deleteDocument = (collection, id) => {
-  return getRealTimeRef(`${collection}/${id}`).remove();
-};
-
-export const createDocument = (collection, id, values) => {
-  return getRealTimeRef(`${collection}/${id}`).set(values);
-};
-
-export const modifyDocument = (collection, id, values) => {
-  return getRealTimeRef(`${collection}/${id}`).update(values);
+import {
+  createDocument,
+  deleteDocument,
+  fetchCollection,
+  fetchDocument,
+  updateDocument,
+} from './rtdb';
+
+export {
+  createDocument,
+  deleteDocument,
+  fetchCollection,
+  fetchDocument,
+  updateDocument,
 };

src/state/api/firestore.js

@@ -0,0 +1,43 @@
+import firebase from 'firebase.js';
+
+const getRealTimeRef = (path) => firebase.database().ref(path);
+
+export const fetchDocument = async (collection, id) => {
+  const document = (
+    await getRealTimeRef(`${collection}/${id}`).once(`value`)
+  ).val();
+
+  return document ? { id, ...document } : null;
+};
+
+export const fetchCollection = async (collection, options = {}) => {
+  let baseQuery = getRealTimeRef(collection);
+
+  if (options.filterBy) {
+    const { filterBy, value } = options;
+    baseQuery = baseQuery.orderByChild(filterBy).equalTo(value);
+  }
+
+  const fetchedCollection = (await baseQuery.once('value')).val();
+
+  const data = fetchedCollection
+    ? Object.entries(fetchedCollection).map(([key, value]) => ({
+        id: key,
+        ...value,
+      }))
+    : [];
+
+  return data;
+};
+
+export const deleteDocument = (collection, id) => {
+  return getRealTimeRef(`${collection}/${id}`).remove();
+};
+
+export const createDocument = (collection, id, values) => {
+  return getRealTimeRef(`${collection}/${id}`).set(values);
+};
+
+export const updateDocument = (collection, id, values) => {
+  return getRealTimeRef(`${collection}/${id}`).update(values);
+};