WIP: update query types

server/src/core/server/models/action/comment.ts

@@ -254,7 +254,7 @@ export async function createAction(
   };
 
   // Extract the filter parameters.
-  const filter: FilterQuery<CommentAction> = {
+  const filter = {
     tenantID,
     ...rest,
   };
@@ -283,7 +283,7 @@ export async function createAction(
 
     // False to return the updated document instead of the original document.
     // This lets us detect if the document was updated or not.
-    returnOriginal: false,
+    returnDocument: "after",
   });
 
   // Check to see if this was a new action that was upserted, or one was found
@@ -294,12 +294,12 @@ export async function createAction(
   // Because it's relevant that we know that the action was just created, or
   // was just looked up, we need to return the action with an object that
   // indicates if it was upserted.
-  const wasUpserted = result.value!.id === id;
+  const wasUpserted = result?.id === id;
 
   // Return the action that was created/found with a boolean indicating if this
   // action was just upserted (and therefore was newly created).
   return {
-    action: result.value!,
+    action: result!,
     wasUpserted,
   };
 }
@@ -494,8 +494,8 @@ export async function removeAction(
   // Remove the action from the database, returning the action that was deleted.
   const result = await mongo.commentActions().findOneAndDelete(filter);
   return {
-    action: result.value,
-    wasRemoved: Boolean(result.ok && result.value),
+    action: result ?? undefined,
+    wasRemoved: Boolean(result),
   };
 }
 

server/src/core/server/models/comment/comment.ts

@@ -253,7 +253,7 @@ export async function pushChildCommentIDOntoParent(
       $inc: { childCount: 1 },
     },
     {
-      returnOriginal: false,
+      returnDocument: "after",
     }
   );
 
@@ -379,7 +379,7 @@ export async function editComment(
     update,
     {
       // True to return the original document instead of the updated document.
-      returnOriginal: true,
+      returnDocument: "before",
     }
   );
   if (!result.value) {
@@ -854,7 +854,7 @@ export async function updateCommentEmbeddedAt(
     {
       // True to return the original document instead of the updated
       // document.
-      returnOriginal: true,
+      returnDocument: "before",
     }
   );
   if (!result.value) {
@@ -892,7 +892,7 @@ export async function updateCommentStatus(
     {
       // True to return the original document instead of the updated
       // document.
-      returnOriginal: true,
+      returnDocument: "before",
     }
   );
   if (!result.value) {
@@ -942,7 +942,7 @@ export async function updateCommentActionCounts(
       arrayFilters: [{ "revision.id": revisionID }],
       // False to return the updated document instead of the original
       // document.
-      returnOriginal: false,
+      returnDocument: "after",
     }
   );
   if (!result.value) {
@@ -1021,7 +1021,7 @@ export async function addCommentTag(
     {
       // False to return the updated document instead of the original
       // document.
-      returnOriginal: false,
+      returnDocument: "after",
     }
   );
   if (!result.value) {
@@ -1063,7 +1063,7 @@ export async function removeCommentTag(
     {
       // False to return the updated document instead of the original
       // document.
-      returnOriginal: false,
+      returnDocument: "after",
     }
   );
   if (!result.value) {

server/src/core/server/models/comment/counts/counts.ts

@@ -256,7 +256,7 @@ export async function updateRelatedCommentCounts<
     { $inc },
     // False to return the updated document instead of the original
     // document.
-    { returnOriginal: false }
+    { returnDocument: "after" }
   );
 
   return result.value || null;

server/src/core/server/models/dsaReport/report.ts

@@ -335,7 +335,7 @@ export async function createDSAReportNote(
         history: note,
       },
     },
-    { returnOriginal: false }
+    { returnDocument: "after" }
   );
 
   if (!updatedReport.value) {
@@ -384,7 +384,7 @@ export async function createDSAReportShare(
         history: note,
       },
     },
-    { returnOriginal: false }
+    { returnDocument: "after" }
   );
 
   if (!updatedReport.value) {
@@ -422,7 +422,7 @@ export async function deleteDSAReportNote(
         history: { id: { $eq: id } },
       },
     },
-    { returnOriginal: false }
+    { returnDocument: "after" }
   );
 
   if (!updatedReport.value) {
@@ -474,7 +474,7 @@ export async function changeDSAReportStatus(
       },
       $set: { status },
     },
-    { returnOriginal: false }
+    { returnDocument: "after" }
   );
 
   if (!updatedReport.value) {
@@ -549,7 +549,7 @@ export async function makeDSAReportDecision(
         status: GQLDSAReportStatus.COMPLETED,
       },
     },
-    { returnOriginal: false }
+    { returnDocument: "after" }
   );
 
   if (!updatedReport.value) {

server/src/core/server/models/helpers/query.ts

@@ -1,28 +1,34 @@
 import { isUndefined, omitBy } from "lodash";
-import { Collection, Cursor, FilterQuery as MongoFilterQuery } from "mongodb";
+import {
+  Collection,
+  Document,
+  Filter,
+  FindCursor,
+  SortDirection,
+  WithId,
+} from "mongodb";
 
-import { Writable } from "coral-common/common/lib/types";
 import logger from "coral-server/logger";
 
 /**
  * FilterQuery<T> ensures that given the type T, that the FilterQuery will be a
  * Writable, partial set of properties while also including MongoDB specific
  * properties (like $lt, or $gte).
  */
-export type FilterQuery<T> = MongoFilterQuery<Writable<Partial<T>>>;
+export type FilterQuery<T> = Filter<T>;
 
 /**
  * Query is a convenience class used to wrap the existing MongoDB driver to
  * provide easier complex query management.
  */
-export default class Query<T> {
-  public filter: FilterQuery<T>;
-  public projection: FilterQuery<T>;
+export default class Query<T extends Document> {
+  public filter: Filter<T>;
+  public projection: Filter<T>;
 
   private collection: Collection<T>;
   private skip?: number;
   private limit?: number;
-  private sort?: object;
+  private sort?: { [key: string]: SortDirection };
 
   constructor(collection: Collection<T>) {
     this.collection = collection;
@@ -33,12 +39,12 @@ export default class Query<T> {
    * where will merge the given filter into the existing query.
    * @param filter the filter to merge into the existing query
    */
-  public where(filter: FilterQuery<T>): Query<T> {
+  public where(filter: Filter<T>): Query<T> {
     this.filter = { ...this.filter, ...omitBy(filter, isUndefined) };
     return this;
   }
 
-  public project(projection: FilterQuery<T>): Query<T> {
+  public project(projection: Filter<T>): Query<T> {
     this.projection = projection;
     return this;
   }
@@ -65,15 +71,16 @@ export default class Query<T> {
    * orderBy will apply sorting to the query filter when executed.
    * @param sort the sorting option for the documents
    */
-  public orderBy(sort: object): Query<T> {
+  public orderBy(sort: { [key: string]: SortDirection }): Query<T> {
+    // todo: merge sort's together
     this.sort = { ...this.sort, ...sort };
     return this;
   }
 
   /**
    * exec will return a cursor to the query.
    */
-  public async exec(): Promise<Cursor<T>> {
+  public async exec(): Promise<FindCursor<WithId<T>>> {
     logger.trace(
       {
         collection: this.collection.collectionName,

server/src/core/server/models/migration/migration.ts

@@ -33,15 +33,15 @@ export async function startMigration(
     },
     {
       // False to return the updated document instead of the original document.
-      returnOriginal: false,
+      returnDocument: "after",
       upsert: true,
     }
   );
-  if (!result.value) {
+  if (!result) {
     throw new Error("an unexpected error occurred");
   }
 
-  return result.value;
+  return result;
 }
 
 /**
@@ -71,11 +71,11 @@ async function updateMigrationState(
     },
     {
       // False to return the updated document instead of the original document.
-      returnOriginal: false,
+      returnDocument: "after",
     }
   );
 
-  return result.value || null;
+  return result;
 }
 
 export async function finishMigration(

server/src/core/server/models/settings/signingSecret/signingSecret.ts

@@ -135,7 +135,7 @@ async function pushNewSigningSecret<T extends {}>({
   const options: FindOneAndUpdateOption = {
     // False to return the updated document instead of the original
     // document.
-    returnOriginal: false,
+    returnDocument: "after",
   };
   if (id) {
     options.arrayFilters = [
@@ -246,7 +246,7 @@ async function deprecateOldSigningSecrets<T extends {}>(
   const options: FindOneAndUpdateOption = {
     // False to return the updated document instead of the original
     // document.
-    returnOriginal: false,
+    returnDocument: "after",
     arrayFilters: [
       // Select any signing secrets with the given ids.
       { "signingSecret.kid": { $in: secretKIDsToDeprecate } },

server/src/core/server/models/site/index.ts

@@ -167,7 +167,7 @@ export async function updateSite(
       update,
       // False to return the updated document instead of the original
       // document.
-      { returnOriginal: false }
+      { returnDocument: "after" }
     );
     return result.value || null;
   } catch (err) {