fix(NODE-5003): cloned cursors are not legacy api (#12)

Co-authored-by: Warren James <[email protected]>

Author: nbbeeken

src/legacy_wrappers/cursors.js

@@ -7,6 +7,11 @@ module.exports = Object.create(null);
 Object.defineProperty(module.exports, '__esModule', { value: true });
 
 module.exports.makeLegacyFindCursor = function (baseClass) {
+  function toLegacyHelper(cursor) {
+    Object.setPrototypeOf(cursor, LegacyFindCursor.prototype);
+    return cursor;
+  }
+
   class LegacyFindCursor extends baseClass {
     /** @deprecated Use `collection.estimatedDocumentCount` or `collection.countDocuments` instead */
     count(options, callback) {
@@ -56,19 +61,28 @@ module.exports.makeLegacyFindCursor = function (baseClass) {
     tryNext(callback) {
       return maybeCallback(super.tryNext(), callback);
     }
+    clone() {
+      const cursor = super.clone();
+      return toLegacyHelper(cursor);
+    }
   }
 
   Object.defineProperty(baseClass.prototype, toLegacy, {
     enumerable: false,
     value: function () {
-      return Object.setPrototypeOf(this, LegacyFindCursor.prototype);
+      return toLegacyHelper(this);
     }
   });
 
   return LegacyFindCursor;
 };
 
 module.exports.makeLegacyListCollectionsCursor = function (baseClass) {
+  function toLegacyHelper(cursor) {
+    Object.setPrototypeOf(cursor, LegacyListCollectionsCursor.prototype);
+    return cursor;
+  }
+
   class LegacyListCollectionsCursor extends baseClass {
     close(options, callback) {
       callback =
@@ -95,19 +109,28 @@ module.exports.makeLegacyListCollectionsCursor = function (baseClass) {
     tryNext(callback) {
       return maybeCallback(super.tryNext(), callback);
     }
+    clone() {
+      const cursor = super.clone();
+      return toLegacyHelper(cursor);
+    }
   }
 
   Object.defineProperty(baseClass.prototype, toLegacy, {
     enumerable: false,
     value: function () {
-      return Object.setPrototypeOf(this, LegacyListCollectionsCursor.prototype);
+      return toLegacyHelper(this);
     }
   });
 
   return LegacyListCollectionsCursor;
 };
 
 module.exports.makeLegacyListIndexesCursor = function (baseClass) {
+  function toLegacyHelper(cursor) {
+    Object.setPrototypeOf(cursor, LegacyListIndexesCursor.prototype);
+    return cursor;
+  }
+
   class LegacyListIndexesCursor extends baseClass {
     close(options, callback) {
       callback =
@@ -134,19 +157,28 @@ module.exports.makeLegacyListIndexesCursor = function (baseClass) {
     tryNext(callback) {
       return maybeCallback(super.tryNext(), callback);
     }
+    clone() {
+      const cursor = super.clone();
+      return toLegacyHelper(cursor);
+    }
   }
 
   Object.defineProperty(baseClass.prototype, toLegacy, {
     enumerable: false,
     value: function () {
-      return Object.setPrototypeOf(this, LegacyListIndexesCursor.prototype);
+      return toLegacyHelper(this);
     }
   });
 
   return LegacyListIndexesCursor;
 };
 
 module.exports.makeLegacyAggregationCursor = function (baseClass) {
+  function toLegacyHelper(cursor) {
+    Object.setPrototypeOf(cursor, LegacyAggregationCursor.prototype);
+    return cursor;
+  }
+
   class LegacyAggregationCursor extends baseClass {
     explain(verbosity, callback) {
       callback =
@@ -184,12 +216,16 @@ module.exports.makeLegacyAggregationCursor = function (baseClass) {
     tryNext(callback) {
       return maybeCallback(super.tryNext(), callback);
     }
+    clone() {
+      const cursor = super.clone();
+      return toLegacyHelper(cursor);
+    }
   }
 
   Object.defineProperty(baseClass.prototype, toLegacy, {
     enumerable: false,
     value: function () {
-      return Object.setPrototypeOf(this, LegacyAggregationCursor.prototype);
+      return toLegacyHelper(this);
     }
   });
 

test/tools/api.js

@@ -40,6 +40,12 @@ const api = [
   { className: 'Admin', method: 'validateCollection', returnType: 'Promise<Document>' },
 
   { className: 'AggregationCursor', method: 'explain', returnType: 'Promise<Document>' },
+  { className: 'AggregationCursor', method: 'clone', returnType: 'AggregationCursor', notAsync: true },
+
+  { className: 'FindCursor', method: 'clone', returnType: 'FindCursor', notAsync: true },
+  { className: 'ListIndexesCursor', method: 'clone', returnType: 'ListIndexesCursor', notAsync: true },
+  { className: 'ListCollectionsCursor', method: 'clone', returnType: 'ListCollectionsCursor', notAsync: true },
+
 
   // Super class of Unordered/Ordered Bulk operations
   // This is listed here as a reference for completeness, but it is tested by the subclass overrides of execute

test/unit/legacy_wrappers/collection.test.js

@@ -43,6 +43,18 @@ describe('legacy_wrappers/collection.js', () => {
     expect(collection.find()).to.be.instanceOf(LegacyFindCursor);
   });
 
+  it('collection.listIndexes().clone() should return legacy listIndexes cursor', () => {
+    expect(collection.listIndexes().clone()).to.be.instanceOf(LegacyListIndexesCursor);
+  });
+
+  it('collection.aggregate().clone() should return legacy AggregationCursor', () => {
+    expect(collection.aggregate().clone()).to.be.instanceOf(LegacyAggregationCursor);
+  });
+
+  it('collection.find().clone() should return legacy FindCursor', () => {
+    expect(collection.find().clone()).to.be.instanceOf(LegacyFindCursor);
+  });
+
   describe('rename()', () => {
     let client;
     let collection;

test/unit/legacy_wrappers/db.test.js

@@ -28,6 +28,10 @@ describe('legacy_wrappers/db.js', () => {
     expect(db.listCollections()).to.be.instanceOf(LegacyListCollectionsCursor);
   });
 
+  it('db.listCollections().clone() should return legacy listCollections cursor', () => {
+    expect(db.listCollections().clone()).to.be.instanceOf(LegacyListCollectionsCursor);
+  });
+
   it('should return legacy ChangeStream', () => {
     expect(db.watch()).to.be.instanceOf(LegacyChangeStream);
   });