fix: simplify mongo cursor typings across meteor and webui

Author: Julusian

meteor/__mocks__/mongo.ts

@@ -1,6 +1,5 @@
 import { ProtectedString } from '@sofie-automation/corelib/dist/protectedString'
 import { InMemoryMongoCollection } from '@sofie-automation/corelib/dist/memoryCollection'
-import { MongoReadOnlyCollection } from '@sofie-automation/meteor-lib/dist/collections/lib'
 import { AsyncOnlyMongoCollection, AsyncOnlyReadOnlyMongoCollection } from '../server/collections/collection'
 import { Collections } from '../server/collections/lib'
 
@@ -34,7 +33,7 @@ export namespace MongoMock {
 
 	/** The backing in-memory collection for a wrapped (mock) collection. */
 	export function getInnerMockCollection<T extends { _id: ProtectedString<any> }>(
-		collection: MongoReadOnlyCollection<T> | AsyncOnlyReadOnlyMongoCollection<T>
+		collection: AsyncOnlyReadOnlyMongoCollection<T>
 	): InMemoryMongoCollection<T> {
 		return (collection as any).mockCollection
 	}

meteor/server/api/deviceTriggers/StudioObserver.ts

@@ -21,8 +21,8 @@ import { RundownContentObserver } from './RundownContentObserver'
 import { RundownsObserver } from './RundownsObserver'
 import { RundownPlaylists, Rundowns, ShowStyleBases } from '../../collections'
 import { PromiseDebounce } from '../../publications/lib/PromiseDebounce'
-import { MinimalMongoCursor } from '../../collections/implementations/asyncCollection'
 import { PieceInstancesObserver } from './PieceInstancesObserver'
+import { MinimalMongoCursor } from '../../collections/collection'
 
 type RundownContentChangeHandler = (showStyleBaseId: ShowStyleBaseId, cache: ContentCache) => () => void
 type PieceInstancesChangeHandler = (showStyleBaseId: ShowStyleBaseId, cache: PieceInstancesContentCache) => () => void

meteor/server/collections/changeStream/changeStreamCursor.ts

@@ -9,16 +9,12 @@ import {
 } from '@sofie-automation/corelib/dist/mongo'
 import { PromisifyCallbacks } from '@sofie-automation/shared-lib/dist/lib/types'
 import { observeChangesViaChangeStream, observeViaChangeStream, ObserveMultiplexerDeps } from './observeMultiplexer'
-import type { MinimalMongoCursor } from '../implementations/asyncCollection'
+import type { MinimalMongoCursor } from '../collection'
 
 export interface ChangeStreamCursorConfig<TDoc extends { _id: ProtectedString<any> }> {
 	collectionName: string
 	selector: MongoQuery<TDoc>
 	projection: MongoFieldSpecifier<TDoc> | undefined
-	/** Fetch the matching documents (native find, with projection applied) */
-	fetch: () => Promise<TDoc[]>
-	/** Count the matching documents. When `applySkipLimit` is false, ignore any skip/limit in the options. */
-	count: (applySkipLimit: boolean) => Promise<number>
 	/** Build the deps for an observe multiplexer over this cursor's query */
 	makeDeps: () => ObserveMultiplexerDeps<TDoc>
 }
@@ -27,8 +23,6 @@ export interface ChangeStreamCursorConfig<TDoc extends { _id: ProtectedString<an
  * A lazy "watcher" returned by `findWithCursor`. It exposes the async cursor methods the codebase uses
  * (`fetchAsync`/`countAsync`/`observeChangesAsync`/`observeAsync`) plus a plain `collectionName`.
  *
- * Unlike a Meteor cursor it has NO `_publishCursor`: publications are wired up by `meteorPublish`
- * (`driveSubscriptionFromCursor`).
  * Observing goes through the shared change-stream multiplexer, so identical queries are de-duplicated.
  */
 export class ChangeStreamCursor<TDoc extends { _id: ProtectedString<any> }> implements MinimalMongoCursor<TDoc> {
@@ -40,14 +34,6 @@ export class ChangeStreamCursor<TDoc extends { _id: ProtectedString<any> }> impl
 		this.collectionName = config.collectionName
 	}
 
-	async fetchAsync(): Promise<TDoc[]> {
-		return this.#config.fetch()
-	}
-
-	async countAsync(applySkipLimit = true): Promise<number> {
-		return this.#config.count(applySkipLimit)
-	}
-
 	async observeChangesAsync(
 		callbacks: PromisifyCallbacks<ObserveChangesCallbacks<TDoc>>,
 		options?: ObserveChangesOptions

meteor/server/collections/collection.ts

@@ -17,8 +17,12 @@ import { createMockCollection } from './implementations/mock'
 import { WrappedAsyncMongoCollection } from './implementations/asyncCollection'
 import { WrappedReadOnlyMongoCollection } from './implementations/readonlyWrapper'
 import { isInMockMode } from './mongoConnection'
-import { FieldNames, IndexSpecifier, UpdateOptions } from '@sofie-automation/meteor-lib/dist/collections/lib'
-import { MinimalMongoCursor } from './implementations/asyncCollection'
+import {
+	FieldNames,
+	IndexSpecifier,
+	MongoLiveQueryHandle,
+	UpdateOptions,
+} from '@sofie-automation/meteor-lib/dist/collections/lib'
 import { UserPermissions } from '@sofie-automation/meteor-lib/dist/userPermissions'
 
 export interface CustomMongoAllowRules<DBInterface> {
@@ -86,6 +90,29 @@ function createWrappedCollection<DBInterface extends { _id: ProtectedString<any>
 	}
 }
 
+/**
+ * A minimal mongo cursor, with only the async methods used by the codebase.
+ * This is intentionally only the observe methods, kept for publication usage to avoid a larger refactor
+ */
+export interface MinimalMongoCursor<T extends { _id: ProtectedString<any> }> {
+	readonly collectionName: string | null
+
+	/**
+	 * Watch a query. Receive callbacks as the result set changes.
+	 * @param callbacks Functions to call to deliver the result set as it changes
+	 */
+	observeAsync(callbacks: ObserveCallbacks<T>): Promise<MongoLiveQueryHandle>
+	/**
+	 * Watch a query. Receive callbacks as the result set changes. Only the differences between the old and new documents are passed to the callbacks.
+	 * @param callbacks Functions to call to deliver the result set as it changes
+	 * @param options { nonMutatingCallbacks: boolean }
+	 */
+	observeChangesAsync(
+		callbacks: ObserveChangesCallbacks<T>,
+		options?: { nonMutatingCallbacks?: boolean | undefined }
+	): Promise<MongoLiveQueryHandle>
+}
+
 /**
  * A minimal Async only wrapping around the base Mongo.Collection type
  */

meteor/server/collections/implementations/asyncCollection.ts

@@ -8,12 +8,7 @@ import {
 } from '@sofie-automation/corelib/dist/mongo'
 import { ProtectedString, unprotectString } from '@sofie-automation/corelib/dist/protectedString'
 import { Meteor } from 'meteor/meteor'
-import {
-	UpdateOptions,
-	IndexSpecifier,
-	MongoCursor,
-	FindOptions,
-} from '@sofie-automation/meteor-lib/dist/collections/lib'
+import { UpdateOptions, IndexSpecifier, FindOptions } from '@sofie-automation/meteor-lib/dist/collections/lib'
 import type {
 	Collection as RawCollection,
 	CreateIndexesOptions,
@@ -25,7 +20,7 @@ import { MongoFieldSpecifier } from '@sofie-automation/corelib/dist/mongo'
 import { profiler } from '../../api/profiler'
 import { logger } from '../../logging'
 import { PromisifyCallbacks } from '@sofie-automation/shared-lib/dist/lib/types'
-import { AsyncOnlyMongoCollection } from '../collection'
+import { AsyncOnlyMongoCollection, MinimalMongoCursor } from '../collection'
 import { getMongoDb } from '../mongoConnection'
 import {
 	observeChangesViaChangeStream,
@@ -35,15 +30,6 @@ import {
 import { ChangeStreamCursor } from '../changeStream/changeStreamCursor'
 import { subscribeToCollectionChangeFeed } from '../changeStream/collectionChangeFeed'
 
-/**
- * A stripped down version of a cursor, with only the async methods used by the codebase, plus the name of
- * the collection it came from (used by the publish layer to address DDP messages).
- */
-export type MinimalMongoCursor<T extends { _id: ProtectedString<any> }> = Pick<
-	MongoCursor<T>,
-	'fetchAsync' | 'observeChangesAsync' | 'observeAsync' | 'countAsync'
-> & { readonly collectionName: string | null }
-
 /**
  * Translate a meteor-lib {@link FindOptions} into the options the native `mongodb` driver accepts.
  * This is an explicit allow-list: only options known to be understood by the driver are forwarded.
@@ -168,22 +154,13 @@ export class WrappedAsyncMongoCollection<
 
 	async findWithCursor(
 		selector?: MongoQuery<DBInterface> | DBInterface['_id'],
-		options?: FindOptions<DBInterface>
+		options?: Omit<FindOptions<DBInterface>, 'fields'>
 	): Promise<MinimalMongoCursor<DBInterface>> {
 		const sel = this.mongoSelector(selector)
 		return new ChangeStreamCursor<DBInterface>({
 			collectionName: this.name,
 			selector: sel,
 			projection: this.projectionOf(options),
-			fetch: async () => this.findFetchAsync(sel, options),
-			// When applySkipLimit is false, strip skip/limit so the count reflects the total matching set.
-			count: async (applySkipLimit) =>
-				this.countDocuments(
-					sel,
-					applySkipLimit
-						? options
-						: ({ ...options, skip: undefined, limit: undefined } as FindOptions<DBInterface>)
-				),
 			makeDeps: () => this.observeDeps(sel),
 		})
 	}

meteor/server/collections/implementations/mock.ts

@@ -13,8 +13,7 @@ import type { CreateIndexesOptions, IndexDescriptionInfo } from 'mongodb'
 import { InMemoryMongoCollection } from '@sofie-automation/corelib/dist/memoryCollection'
 import { PromisifyCallbacks } from '@sofie-automation/shared-lib/dist/lib/types'
 import { UpdateOptions, IndexSpecifier } from '@sofie-automation/meteor-lib/dist/collections/lib'
-import { AsyncOnlyMongoCollection } from '../collection'
-import { MinimalMongoCursor } from './asyncCollection'
+import { AsyncOnlyMongoCollection, MinimalMongoCursor } from '../collection'
 
 /**
  * {@link WrappedMockCollection} only ever runs under jest, where `Meteor` is the mock that provides
@@ -93,17 +92,6 @@ export class WrappedMockCollection<
 		await this.#sleep(0)
 		return {
 			collectionName: this.#core.name,
-			fetchAsync: async () => {
-				await this.#sleep(0)
-				return this.#core.findFetch(selector, options)
-			},
-			countAsync: async (applySkipLimit = true) => {
-				await this.#sleep(0)
-				return this.#core.count(
-					selector,
-					applySkipLimit ? options : { ...options, skip: undefined, limit: undefined }
-				)
-			},
 			observeAsync: async (callbacks) => {
 				await this.#sleep(0)
 				return this.#core.observe(callbacks, selector, options)

meteor/server/collections/implementations/readonlyWrapper.ts

@@ -1,8 +1,7 @@
 import { ProtectedString } from '@sofie-automation/corelib/dist/protectedString'
 import { Meteor } from 'meteor/meteor'
 import type { IndexDescriptionInfo } from 'mongodb'
-import type { AsyncOnlyMongoCollection, AsyncOnlyReadOnlyMongoCollection } from '../collection'
-import type { MinimalMongoCursor } from './asyncCollection'
+import type { AsyncOnlyMongoCollection, AsyncOnlyReadOnlyMongoCollection, MinimalMongoCursor } from '../collection'
 
 export class WrappedReadOnlyMongoCollection<
 	DBInterface extends { _id: ProtectedString<any> },

meteor/server/publications/lib/lib.ts

@@ -3,7 +3,7 @@ import { AllPubSubCollections, AllPubSubTypes } from '@sofie-automation/meteor-l
 import { extractFunctionSignature } from '../../lib'
 import { protectStringObject, unprotectString } from '@sofie-automation/corelib/dist/protectedString'
 import { MetricsGauge } from '@sofie-automation/corelib/dist/prometheus'
-import { MinimalMongoCursor } from '../../collections/implementations/asyncCollection'
+import { MinimalMongoCursor } from '../../collections/collection'
 import { ChangeStreamCursor } from '../../collections/changeStream/changeStreamCursor'
 
 export const MeteorPublicationSignatures: { [key: string]: string[] } = {}

meteor/server/publications/lib/observerChain.ts

@@ -4,7 +4,7 @@ import { Simplify } from 'type-fest'
 import { assertNever } from '@sofie-automation/corelib/dist/lib'
 import { logger } from '../../logging'
 import { stringifyError } from '@sofie-automation/shared-lib/dist/lib/stringifyError'
-import { MinimalMongoCursor } from '../../collections/implementations/asyncCollection'
+import { MinimalMongoCursor } from '../../collections/collection'
 
 /**
  * https://stackoverflow.com/a/66011942

meteor/server/publications/organization.ts

@@ -71,6 +71,7 @@ meteorPublish(
 
 		return UserActionsLog.findWithCursor(selector, {
 			limit: 10_000, // this is to prevent having a publication that produces a very large array
+			sort: { timestamp: -1 },
 		})
 	}
 )