Firebase Stub refactoring

__mocks__/gatsby-plugin-firebase.js

@@ -1,286 +1,9 @@
-import path from 'path';
+import Auth from './gatsby-plugin-firebase/auth/auth';
-import fs from 'fs';
+import Database from './gatsby-plugin-firebase/database/database';
-import { v4 as uuidv4 } from 'uuid';
-
 import {
   AuthConstants,
   DatabaseConstants,
 } from './gatsby-plugin-firebase/constants';
-import Auth from './gatsby-plugin-firebase/auth';
-
-class Database {
-  static #instance = undefined;
-  #uuid = '';
-  #data = {};
-  #references = {};
-  #anonymousUser1 = undefined;
-  #anonymousUser2 = undefined;
-
-  constructor() {
-    if (Database.#instance) {
-      return Database.#instance;
-    }
-
-    Database.#instance = this;
-
-    this.#uuid = uuidv4();
-    this.#anonymousUser1 = {
-      uid: AuthConstants.anonymousUser1.uid,
-      isAnonymous: AuthConstants.anonymousUser1.isAnonymous,
-    };
-    this.#anonymousUser2 = {
-      uid: AuthConstants.anonymousUser2.uid,
-      isAnonymous: AuthConstants.anonymousUser2.isAnonymous,
-    };
-  }
-
-  get anonymousUser1() {
-    return this.#anonymousUser1;
-  }
-
-  get anonymousUser2() {
-    return this.#anonymousUser2;
-  }
-
-  get uuid() {
-    return this.#uuid;
-  }
-
-  static readFile(fileRelativePath) {
-    const fileAbsolutePath = path.resolve(__dirname, fileRelativePath);
-    const fileBuffer = fs.readFileSync(fileAbsolutePath);
-    const fileData = JSON.parse(fileBuffer);
-    return fileData;
-  }
-
-  initializeData() {
-    const resumes = {};
-
-    const demoStateResume1 = Database.readFile('../src/data/demoState.json');
-    let date = new Date('December 15, 2020 11:20:25');
-    demoStateResume1.updatedAt = date.valueOf();
-    date.setMonth(date.getMonth() - 2);
-    demoStateResume1.createdAt = date.valueOf();
-    demoStateResume1.user = this.anonymousUser1.uid;
-    resumes[DatabaseConstants.demoStateResume1Id] = demoStateResume1;
-
-    const demoStateResume2 = JSON.parse(JSON.stringify(demoStateResume1));
-    demoStateResume2.user = this.anonymousUser2.uid;
-    resumes[DatabaseConstants.demoStateResume2Id] = demoStateResume2;
-
-    const initialStateResume = Database.readFile(
-      '../src/data/initialState.json',
-    );
-    initialStateResume.updatedAt = date.valueOf();
-    initialStateResume.createdAt = date.valueOf();
-    initialStateResume.user = this.anonymousUser1.uid;
-    resumes[DatabaseConstants.initialStateResumeId] = initialStateResume;
-
-    for (var key in resumes) {
-      const resume = resumes[key];
-
-      resume.id = key;
-      resume.name = `Test Resume ${key}`;
-    }
-
-    this.#data[DatabaseConstants.resumesPath] = resumes;
-
-    const users = {};
-    users[this.anonymousUser1.uid] = this.anonymousUser1;
-    users[this.anonymousUser2.uid] = this.anonymousUser2;
-    this.#data[DatabaseConstants.usersPath] = users;
-  }
-
-  ref(path) {
-    const newRef = new Reference(path, () => this.#data);
-    const existingRef = this.#references[newRef.path];
-    if (existingRef) {
-      return existingRef;
-    }
-
-    this.#references[newRef.path] = newRef;
-    return newRef;
-  }
-}
-
-class Reference {
-  #rootPath = '.';
-  #path = '';
-  #uuid = '';
-  #dataSnapshots = {};
-  #getDatabaseData = () => null;
-  #orderByChildPath = '';
-  #equalToValue = '';
-
-  constructor(path, getDatabaseData) {
-    if (typeof path === 'undefined' || path === null) {
-      this.#path = this.#rootPath;
-    } else if (typeof path !== 'string') {
-      throw new Error('path should be a string.');
-    }
-
-    if (!getDatabaseData) {
-      throw new Error('getDatabaseData must be provided.');
-    } else if (typeof getDatabaseData !== 'function') {
-      throw new Error('getDatabaseData should be a function.');
-    }
-
-    this.#path = path;
-    this.#uuid = uuidv4();
-    this.#getDatabaseData = getDatabaseData;
-  }
-
-  get path() {
-    return this.#path;
-  }
-
-  get uuid() {
-    return this.#uuid;
-  }
-
-  getData() {
-    const databaseData = this.#getDatabaseData();
-
-    if (!databaseData) {
-      return null;
-    }
-
-    if (this.#path === this.#rootPath) {
-      return databaseData;
-    }
-
-    let data = null;
-    if (
-      this.#path === DatabaseConstants.resumesPath ||
-      this.#path === DatabaseConstants.usersPath
-    ) {
-      data = this.#path in databaseData ? databaseData[this.#path] : null;
-
-      if (data && this.#orderByChildPath && this.#equalToValue) {
-        return Object.fromEntries(
-          Object.entries(data).filter(
-            ([key, value]) =>
-              value[this.#orderByChildPath] === this.#equalToValue,
-          ),
-        );
-      }
-
-      return data;
-    }
-
-    if (
-      this.#path.startsWith(`${DatabaseConstants.resumesPath}/`) ||
-      this.#path.startsWith(`${DatabaseConstants.usersPath}/`)
-    ) {
-      const databaseLocationId = this.#path.substring(
-        this.#path.indexOf('/') + 1,
-      );
-      if (!databaseLocationId) {
-        throw new Error('Unknown database location id.');
-      }
-
-      const pathWithoutId = this.#path.substring(0, this.#path.indexOf('/'));
-      if (pathWithoutId in databaseData) {
-        return databaseLocationId in databaseData[pathWithoutId]
-          ? databaseData[pathWithoutId][databaseLocationId]
-          : null;
-      }
-    }
-
-    return null;
-  }
-
-  off() {}
-
-  on(eventType, callback) {
-    if (eventType !== 'value') {
-      return;
-    }
-
-    let snapshot = new DataSnapshot(eventType, this, null);
-
-    if (this.#path === DatabaseConstants.connectedPath) {
-      snapshot = new DataSnapshot(eventType, this, true);
-    } else if (this.#path === DatabaseConstants.resumesPath) {
-      snapshot = new DataSnapshot(eventType, this);
-    }
-
-    callback(snapshot);
-  }
-
-  async once(eventType) {
-    const newDataSnapshot = new DataSnapshot(eventType, this);
-    const existingDataSnapshot = this.#dataSnapshots[newDataSnapshot.eventType];
-    if (existingDataSnapshot) {
-      return Promise.resolve(existingDataSnapshot);
-    }
-
-    this.#dataSnapshots[newDataSnapshot.eventType] = newDataSnapshot;
-    return Promise.resolve(newDataSnapshot);
-  }
-
-  orderByChild(path) {
-    this.#orderByChildPath = path;
-    return this;
-  }
-
-  equalTo(value) {
-    this.#equalToValue = value;
-    return this;
-  }
-
-  async update(value) {
-    return Promise.resolve(true);
-  }
-
-  async set(value) {
-    return Promise.resolve(true);
-  }
-}
-
-class DataSnapshot {
-  #eventType = '';
-  #reference = null;
-  #value = undefined;
-
-  constructor(eventType, reference, value = undefined) {
-    if (!eventType) {
-      throw new Error('eventType must be provided.');
-    } else if (typeof eventType !== 'string') {
-      throw new Error('eventType should be a string.');
-    }
-
-    this.#eventType = eventType;
-
-    if (!reference) {
-      throw new Error('reference must be provided.');
-    } else if (!(reference instanceof Reference)) {
-      throw new Error('reference must be an instance of the Reference class.');
-    }
-
-    this.#reference = reference;
-
-    this.#value = value;
-  }
-
-  get eventType() {
-    return this.#eventType;
-  }
-
-  get value() {
-    return this.#value;
-  }
-
-  val() {
-    if (this.eventType === 'value') {
-      return typeof this.value !== 'undefined'
-        ? this.value
-        : this.#reference.getData();
-    }
-
-    return undefined;
-  }
-}
 
 class FirebaseStub {
   static auth() {

__mocks__/gatsby-plugin-firebase/auth/auth.js

@@ -1,6 +1,6 @@
 import { v4 as uuidv4 } from 'uuid';
 
-import { AuthConstants } from './constants';
+import { AuthConstants } from '../constants';
 
 class Auth {
   static #instance = undefined;

__mocks__/gatsby-plugin-firebase/database/dataSnapshot.js

@@ -0,0 +1,47 @@
+import Reference from './reference';
+
+class DataSnapshot {
+  #eventType = '';
+  #reference = null;
+  #value = undefined;
+
+  constructor(eventType, reference, value = undefined) {
+    if (!eventType) {
+      throw new Error('eventType must be provided.');
+    } else if (typeof eventType !== 'string') {
+      throw new Error('eventType should be a string.');
+    }
+
+    this.#eventType = eventType;
+
+    if (!reference) {
+      throw new Error('reference must be provided.');
+    } else if (!(reference instanceof Reference)) {
+      throw new Error('reference must be an instance of the Reference class.');
+    }
+
+    this.#reference = reference;
+
+    this.#value = value;
+  }
+
+  get eventType() {
+    return this.#eventType;
+  }
+
+  get value() {
+    return this.#value;
+  }
+
+  val() {
+    if (this.eventType === 'value') {
+      return typeof this.value !== 'undefined'
+        ? this.value
+        : this.#reference.getData();
+    }
+
+    return undefined;
+  }
+}
+
+export default DataSnapshot;

__mocks__/gatsby-plugin-firebase/database/database.js

@@ -0,0 +1,105 @@
+import path from 'path';
+import fs from 'fs';
+import { v4 as uuidv4 } from 'uuid';
+
+import { AuthConstants, DatabaseConstants } from '../constants';
+import Reference from './reference';
+
+class Database {
+  static #instance = undefined;
+  #uuid = '';
+  #data = {};
+  #references = {};
+  #anonymousUser1 = undefined;
+  #anonymousUser2 = undefined;
+
+  constructor() {
+    if (Database.#instance) {
+      return Database.#instance;
+    }
+
+    Database.#instance = this;
+
+    this.#uuid = uuidv4();
+    this.#anonymousUser1 = {
+      uid: AuthConstants.anonymousUser1.uid,
+      isAnonymous: AuthConstants.anonymousUser1.isAnonymous,
+    };
+    this.#anonymousUser2 = {
+      uid: AuthConstants.anonymousUser2.uid,
+      isAnonymous: AuthConstants.anonymousUser2.isAnonymous,
+    };
+  }
+
+  get anonymousUser1() {
+    return this.#anonymousUser1;
+  }
+
+  get anonymousUser2() {
+    return this.#anonymousUser2;
+  }
+
+  get uuid() {
+    return this.#uuid;
+  }
+
+  static readFile(fileRelativePath) {
+    const fileAbsolutePath = path.resolve(__dirname, fileRelativePath);
+    const fileBuffer = fs.readFileSync(fileAbsolutePath);
+    const fileData = JSON.parse(fileBuffer);
+    return fileData;
+  }
+
+  initializeData() {
+    const resumes = {};
+
+    const demoStateResume1 = Database.readFile(
+      '../../../src/data/demoState.json',
+    );
+    let date = new Date('December 15, 2020 11:20:25');
+    demoStateResume1.updatedAt = date.valueOf();
+    date.setMonth(date.getMonth() - 2);
+    demoStateResume1.createdAt = date.valueOf();
+    demoStateResume1.user = this.anonymousUser1.uid;
+    resumes[DatabaseConstants.demoStateResume1Id] = demoStateResume1;
+
+    const demoStateResume2 = JSON.parse(JSON.stringify(demoStateResume1));
+    demoStateResume2.user = this.anonymousUser2.uid;
+    resumes[DatabaseConstants.demoStateResume2Id] = demoStateResume2;
+
+    const initialStateResume = Database.readFile(
+      '../../../src/data/initialState.json',
+    );
+    initialStateResume.updatedAt = date.valueOf();
+    initialStateResume.createdAt = date.valueOf();
+    initialStateResume.user = this.anonymousUser1.uid;
+    resumes[DatabaseConstants.initialStateResumeId] = initialStateResume;
+
+    for (var key in resumes) {
+      const resume = resumes[key];
+
+      resume.id = key;
+      resume.name = `Test Resume ${key}`;
+    }
+
+    this.#data[DatabaseConstants.resumesPath] = resumes;
+
+    const users = {};
+    users[this.anonymousUser1.uid] = this.anonymousUser1;
+    users[this.anonymousUser2.uid] = this.anonymousUser2;
+    this.#data[DatabaseConstants.usersPath] = users;
+  }
+
+  ref(path) {
+    const newRef = new Reference(path, () => this.#data);
+    const existingRef = this.#references[newRef.path];
+    if (existingRef) {
+      return existingRef;
+    }
+
+    this.#references[newRef.path] = newRef;
+    return newRef;
+  }
+}
+
+export default Database;

__mocks__/gatsby-plugin-firebase/database/reference.js

@@ -0,0 +1,141 @@
+import { v4 as uuidv4 } from 'uuid';
+
+import { DatabaseConstants } from '../constants';
+import DataSnapshot from './dataSnapshot';
+
+class Reference {
+  #rootPath = '.';
+  #path = '';
+  #uuid = '';
+  #dataSnapshots = {};
+  #getDatabaseData = () => null;
+  #orderByChildPath = '';
+  #equalToValue = '';
+
+  constructor(path, getDatabaseData) {
+    if (typeof path === 'undefined' || path === null) {
+      this.#path = this.#rootPath;
+    } else if (typeof path !== 'string') {
+      throw new Error('path should be a string.');
+    }
+
+    if (!getDatabaseData) {
+      throw new Error('getDatabaseData must be provided.');
+    } else if (typeof getDatabaseData !== 'function') {
+      throw new Error('getDatabaseData should be a function.');
+    }
+
+    this.#path = path;
+    this.#uuid = uuidv4();
+    this.#getDatabaseData = getDatabaseData;
+  }
+
+  get path() {
+    return this.#path;
+  }
+
+  get uuid() {
+    return this.#uuid;
+  }
+
+  getData() {
+    const databaseData = this.#getDatabaseData();
+
+    if (!databaseData) {
+      return null;
+    }
+
+    if (this.#path === this.#rootPath) {
+      return databaseData;
+    }
+
+    let data = null;
+    if (
+      this.#path === DatabaseConstants.resumesPath ||
+      this.#path === DatabaseConstants.usersPath
+    ) {
+      data = this.#path in databaseData ? databaseData[this.#path] : null;
+
+      if (data && this.#orderByChildPath && this.#equalToValue) {
+        return Object.fromEntries(
+          Object.entries(data).filter(
+            ([key, value]) =>
+              value[this.#orderByChildPath] === this.#equalToValue,
+          ),
+        );
+      }
+
+      return data;
+    }
+
+    if (
+      this.#path.startsWith(`${DatabaseConstants.resumesPath}/`) ||
+      this.#path.startsWith(`${DatabaseConstants.usersPath}/`)
+    ) {
+      const databaseLocationId = this.#path.substring(
+        this.#path.indexOf('/') + 1,
+      );
+      if (!databaseLocationId) {
+        throw new Error('Unknown database location id.');
+      }
+
+      const pathWithoutId = this.#path.substring(0, this.#path.indexOf('/'));
+      if (pathWithoutId in databaseData) {
+        return databaseLocationId in databaseData[pathWithoutId]
+          ? databaseData[pathWithoutId][databaseLocationId]
+          : null;
+      }
+    }
+
+    return null;
+  }
+
+  off() {}
+
+  on(eventType, callback) {
+    if (eventType !== 'value') {
+      return;
+    }
+
+    let snapshot = new DataSnapshot(eventType, this, null);
+
+    if (this.#path === DatabaseConstants.connectedPath) {
+      snapshot = new DataSnapshot(eventType, this, true);
+    } else if (this.#path === DatabaseConstants.resumesPath) {
+      snapshot = new DataSnapshot(eventType, this);
+    }
+
+    callback(snapshot);
+  }
+
+  async once(eventType) {
+    const newDataSnapshot = new DataSnapshot(eventType, this);
+    const existingDataSnapshot = this.#dataSnapshots[newDataSnapshot.eventType];
+    if (existingDataSnapshot) {
+      return Promise.resolve(existingDataSnapshot);
+    }
+
+    this.#dataSnapshots[newDataSnapshot.eventType] = newDataSnapshot;
+    return Promise.resolve(newDataSnapshot);
+  }
+
+  orderByChild(path) {
+    this.#orderByChildPath = path;
+    return this;
+  }
+
+  equalTo(value) {
+    this.#equalToValue = value;
+    return this;
+  }
+
+  async update(value) {
+    return Promise.resolve(true);
+  }
+
+  async set(value) {
+    return Promise.resolve(true);
+  }
+}
+
+export default Reference;

__mocks__/gatsby.js

@@ -1,4 +1,5 @@
 import React from 'react';
+
 const Gatsby = jest.requireActual('gatsby');
 
 const fluidImageShapes = [
@@ -75,5 +76,5 @@ module.exports = {
       href: to,
     }),
   ),
-  useStaticQuery: useStaticQuery,
+  useStaticQuery,
 };