refactor: rework todos

Author: posva

src/auth/user.ts

@@ -54,14 +54,23 @@ export function updateCurrentUserProfile(profile: {
   })
 }
 
+/**
+ * Updates the current user and synchronizes the current user state. This function internally calls `updateEmail()`
+ *
+ * @experimental
+ *
+ * @param newEmail - the new email address
+ * @param credential -
+ */
 export function updateCurrentUserEmail(
   newEmail: string,
   credential: AuthCredential
 ) {
   return getCurrentUser()
     .then((user) => {
       if (user) {
-        // TODO: Maybe this whole function should be dropped since it depends on reauthenticating first or we should let the user do it. Otherwise, we need a way to retrieve the credential token when logging in
+        // TODO: Maybe this whole function should be dropped since it depends on re-authenticating first or we should
+        // let the user do it. Otherwise, we need a way to retrieve the credential token when logging in
         reauthenticateWithCredential(user, credential)
       }
       return user

src/firestore/index.ts

@@ -152,28 +152,21 @@ export function _useFirestoreRef(
   }
 
   // only add the first promise to the pending ones
-  // TODO: can we make this tree shakeable?
   if (initialSourceValue) {
     removePendingPromise = addPendingPromise(
       promise.value,
       initialSourceValue,
       options.ssrKey
     )
   }
-
-  // TODO: SSR serialize the values for Nuxt to expose them later and use them
-  // as initial values while specifying a wait: true to only swap objects once
-  // Firebase has done its initial sync. Also, on server, you don't need to
-  // create sync, you can read only once the whole thing so maybe we
-  // should take an option like once: true to not setting up any listener
+  if (getCurrentInstance()) {
+    // wait for the promise during SSR
+    // TODO: configurable ssrKey: false to disable this
+    onServerPrefetch(() => promise.value)
+  }
 
   if (hasCurrentScope) {
     onScopeDispose(stop)
-    if (getCurrentInstance()) {
-      // wait for the promise during SSR
-      // TODO: configurable ssrKey: false to disable this
-      onServerPrefetch(() => promise.value)
-    }
   }
 
   function stop(reset: ResetOption = options.reset) {

src/firestore/subscribe.ts

@@ -161,44 +161,49 @@ function subscribeToDocument(
   let unbind = noop
 
   if (options.once) {
-    getDoc(ref).then((snapshot) => {
-      if (snapshot.exists()) {
-        updateDataFromDocumentSnapshot(
-          options,
-          target,
-          path,
-          snapshot,
-          subs,
-          ops,
-          depth,
-          resolve,
-          reject
-        )
-      } else {
-        ops.set(target, path, null)
-        resolve()
-      }
-    })
-    // TODO: catch?
+    getDoc(ref)
+      .then((snapshot) => {
+        if (snapshot.exists()) {
+          updateDataFromDocumentSnapshot(
+            options,
+            target,
+            path,
+            snapshot,
+            subs,
+            ops,
+            depth,
+            resolve,
+            reject
+          )
+        } else {
+          ops.set(target, path, null)
+          resolve()
+        }
+      })
+      .catch(reject)
   } else {
-    unbind = onSnapshot(ref, (snapshot) => {
-      if (snapshot.exists()) {
-        updateDataFromDocumentSnapshot(
-          options,
-          target,
-          path,
-          snapshot,
-          subs,
-          ops,
-          depth,
-          resolve,
-          reject
-        )
-      } else {
-        ops.set(target, path, null)
-        resolve()
-      }
-    })
+    unbind = onSnapshot(
+      ref,
+      (snapshot) => {
+        if (snapshot.exists()) {
+          updateDataFromDocumentSnapshot(
+            options,
+            target,
+            path,
+            snapshot,
+            subs,
+            ops,
+            depth,
+            resolve,
+            reject
+          )
+        } else {
+          ops.set(target, path, null)
+          resolve()
+        }
+      },
+      reject
+    )
   }
 
   return () => {
@@ -274,6 +279,8 @@ function subscribeToRefs(
   })
 }
 
+// TODO: Remove ops and use just a getter function to be able to retrieve the current target ref and make things work with wait as well
+
 export function bindCollection<T = unknown>(
   target: Ref<unknown[]>,
   collection: CollectionReference<T> | Query<T>,
@@ -286,7 +293,6 @@ export function bindCollection<T = unknown>(
 
   const { snapshotListenOptions, snapshotOptions, wait, once } = options
 
-  // TODO: remove ops
   const key = 'value'
   // with wait we delay changes to the target until all values are resolved
   let arrayRef = ref(wait ? [] : target.value)

src/firestore/utils.ts

@@ -26,6 +26,7 @@ export const firestoreDefaultConverter: FirestoreDataConverter<VueFirestoreDocum
         ? (Object.defineProperties(snapshot.data(options)!, {
             id: { value: snapshot.id },
             // TODO: check if worth adding or should be through an option
+            // It could also be an example in the docs about converters
             // $meta: {
             //   value: snapshot.metadata,
             // },

src/storage/index.ts

@@ -137,8 +137,8 @@ export function useStorageMetadata(
           return (metadata.value = newData)
         }
       )
-    } else {
-      // TODO: DEV warning
+    } else if (process.env.NODE_ENV !== 'production') {
+      console.warn('[VueFire]: "update()" called with no storage source.')
     }
     return promise.value
   }