@mongoosejs/studio 0.5.13 → 0.6.0

package/backend/actions/Model/analyzeSchema.js

@@ -3,6 +3,7 @@
 const Archetype = require('archetype');
 const authorize = require('../../authorize');
 const { Buffer } = require('buffer');
+const readOperationOptions = require('../../helpers/readOperationOptions');
 const validateDocumentWithTimeout = require('../../helpers/validateDocumentWithTimeout');
 
 const SAMPLE_SIZE = 1000;
@@ -15,10 +16,17 @@ const AnalyzeSchemaParams = new Archetype({
   },
   roles: {
     $type: ['string']
+  },
+  maxTimeMS: {
+    $type: 'number'
+  },
+  readPreference: {
+    $type: 'string',
+    $enum: ['secondary', 'secondaryPreferred', 'primary']
   }
 }).compile('AnalyzeSchemaParams');
 
-module.exports = ({ db }) => async function analyzeSchema(params) {
+module.exports = ({ db, options }) => async function analyzeSchema(params) {
   const { model, roles } = new AnalyzeSchemaParams(params);
 
   await authorize('Model.analyzeSchema', roles);
@@ -28,10 +36,11 @@ module.exports = ({ db }) => async function analyzeSchema(params) {
     throw new Error(`Model ${model} not found`);
   }
 
-  const documentCount = await Model.collection.countDocuments();
+  const dbOptions = readOperationOptions(options, params);
+  const documentCount = await Model.collection.countDocuments({}, dbOptions);
   const rawDocs = documentCount > SAMPLE_SIZE ?
-    await Model.collection.aggregate([{ $sample: { size: SAMPLE_SIZE } }]).toArray() :
-    await Model.collection.find({}).toArray();
+    await Model.collection.aggregate([{ $sample: { size: SAMPLE_SIZE } }], dbOptions).toArray() :
+    await Model.collection.find({}, dbOptions).toArray();
 
   const paths = getSchemaPaths(Model.schema);
   const pathTypeCounts = {};
@@ -200,3 +209,6 @@ function getType(value) {
   }
   return typeof value;
 }
+
+module.exports.paramsType = AnalyzeSchemaParams;
+module.exports.tags = ['readOnly'];

package/backend/actions/Model/createChatMessage.js

@@ -62,3 +62,6 @@ const systemPrompt = `
 
   Return only the updated document body as a JavaScript object literal. Do not use Markdown or code fences.
 `.trim();
+
+module.exports.paramsType = CreateChatMessageParams;
+module.exports.tags = ['readOnly'];

package/backend/actions/Model/createDocument.js

@@ -32,3 +32,6 @@ module.exports = ({ db }) => async function CreateDocument(params) {
 
   return { doc };
 };
+
+module.exports.paramsType = CreateDocumentParams;
+module.exports.tags = [];

package/backend/actions/Model/deleteDocument.js

@@ -2,6 +2,7 @@
 
 const Archetype = require('archetype');
 const authorize = require('../../authorize');
+const operationOptions = require('../../helpers/operationOptions');
 
 const DeleteDocumentParams = new Archetype({
   model: {
@@ -14,10 +15,13 @@ const DeleteDocumentParams = new Archetype({
   },
   roles: {
     $type: ['string']
+  },
+  maxTimeMS: {
+    $type: 'number'
   }
 }).compile('DeleteDocumentParams');
 
-module.exports = ({ db }) => async function DeleteDocument(params) {
+module.exports = ({ db, options }) => async function DeleteDocument(params) {
   const { model, documentId, roles } = new DeleteDocumentParams(params);
 
   const Model = db.models[model];
@@ -30,9 +34,11 @@ module.exports = ({ db }) => async function DeleteDocument(params) {
 
   const doc = await Model.
     deleteOne({ _id: documentId }).
-    setOptions({ sanitizeFilter: true }).
+    setOptions(operationOptions(options, params, { sanitizeFilter: true })).
     orFail();
-  console.log('what is doc', doc);
 
   return { doc };
 };
+
+module.exports.paramsType = DeleteDocumentParams;
+module.exports.tags = ['destructive'];

package/backend/actions/Model/deleteDocuments.js

@@ -2,6 +2,7 @@
 
 const Archetype = require('archetype');
 const authorize = require('../../authorize');
+const operationOptions = require('../../helpers/operationOptions');
 
 const DeleteDocumentsParams = new Archetype({
   model: {
@@ -14,10 +15,13 @@ const DeleteDocumentsParams = new Archetype({
   },
   roles: {
     $type: ['string']
+  },
+  maxTimeMS: {
+    $type: 'number'
   }
 }).compile('DeleteDocumentsParams');
 
-module.exports = ({ db }) => async function DeleteDocuments(params) {
+module.exports = ({ db, options }) => async function DeleteDocuments(params) {
   const { model, documentIds, roles } = new DeleteDocumentsParams(params);
 
   const Model = db.models[model];
@@ -30,7 +34,11 @@ module.exports = ({ db }) => async function DeleteDocuments(params) {
 
   await Model.
     deleteMany({ _id: { $in: documentIds } }).
+    setOptions(operationOptions(options, params)).
     orFail();
 
   return { };
 };
+
+module.exports.paramsType = DeleteDocumentsParams;
+module.exports.tags = ['destructive'];

package/backend/actions/Model/dropCollection.js

@@ -27,3 +27,6 @@ module.exports = ({ db }) => async function dropCollection(params) {
 
   return { ok: true };
 };
+
+module.exports.paramsType = DropCollectionParams;
+module.exports.tags = ['destructive'];

package/backend/actions/Model/dropIndex.js

@@ -34,3 +34,6 @@ module.exports = ({ db }) => async function getIndexes(params) {
     mongoDBIndexes
   };
 };
+
+module.exports.paramsType = DropIndexParams;
+module.exports.tags = ['destructive'];

package/backend/actions/Model/executeDocumentScript.js

@@ -2,9 +2,9 @@
 
 const Archetype = require('archetype');
 const authorize = require('../../authorize');
-const mongoose = require('mongoose');
-const util = require('util');
-const vm = require('vm');
+const createSandbox = require('../../sandbox/createSandbox');
+const readOperationOptions = require('../../helpers/readOperationOptions');
+const operationOptions = require('../../helpers/operationOptions');
 
 const ExecuteDocumentScriptParams = new Archetype({
   model: {
@@ -21,41 +21,48 @@ const ExecuteDocumentScriptParams = new Archetype({
   },
   roles: {
     $type: ['string']
+  },
+  maxTimeMS: {
+    $type: 'number'
+  },
+  readPreference: {
+    $type: 'string',
+    $enum: ['secondary', 'secondaryPreferred', 'primary']
   }
 }).compile('ExecuteDocumentScriptParams');
 
-module.exports = ({ db }) => async function executeDocumentScript(params) {
+module.exports = ({ db, options }) => async function executeDocumentScript(params) {
   const { model, documentId, script, roles } = new ExecuteDocumentScriptParams(params);
 
   await authorize('Model.executeDocumentScript', roles);
 
-  const Model = db.models[model];
-  if (Model == null) {
+  if (db.models[model] == null) {
     throw new Error(`Model ${model} not found`);
   }
 
-  const doc = await Model.findById(documentId).setOptions({ sanitizeFilter: true }).orFail();
+  const sandbox = createSandbox(db, { ...readOperationOptions(options, params) });
 
-  const logs = [];
-  if (!db.Types) {
-    db.Types = mongoose.Types;
-  }
-  const sandbox = { db, mongoose, doc, console: {}, ObjectId: mongoose.Types.ObjectId };
-
-  sandbox.console.log = function() {
-    const args = Array.from(arguments);
-    logs.push(args.map(arg => typeof arg === 'object' ? util.inspect(arg) : arg).join(' '));
-  };
+  try {
+    const Model = sandbox.db.models[model];
+    const doc = await Model.findById(documentId).
+      setOptions(operationOptions(options, params, { sanitizeFilter: true })).
+      orFail();
+    sandbox.context.doc = doc;
 
-  const context = vm.createContext(sandbox);
-  const result = await vm.runInContext(wrappedScript(script), context);
+    const result = await sandbox.runScript({ script });
 
-  return {
-    result,
-    logs: logs.join('\n')
-  };
+    return {
+      result,
+      logs: sandbox.getLogs()
+    };
+  } finally {
+    try {
+      await sandbox.close();
+    } catch (_) {
+      // Ignore sandbox cleanup errors so they do not mask the primary result.
+    }
+  }
 };
 
-const wrappedScript = script => `(async () => {
-  ${script}
-})()`;
+module.exports.paramsType = ExecuteDocumentScriptParams;
+module.exports.tags = [];

package/backend/actions/Model/exportQueryResults.js

@@ -5,6 +5,7 @@ const mongoose = require('mongoose');
 const { stringify } = require('csv-stringify/sync');
 const authorize = require('../../authorize');
 const evaluateFilter = require('../../helpers/evaluateFilter');
+const readOperationOptions = require('../../helpers/readOperationOptions');
 
 const GetDocumentsParams = new Archetype({
   model: {
@@ -26,10 +27,17 @@ const GetDocumentsParams = new Archetype({
   },
   roles: {
     $type: ['string']
+  },
+  maxTimeMS: {
+    $type: 'number'
+  },
+  readPreference: {
+    $type: 'string',
+    $enum: ['secondary', 'secondaryPreferred', 'primary']
   }
 }).compile('GetDocumentsParams');
 
-module.exports = ({ db }) => async function exportQueryResults(params, req, res) {
+module.exports = ({ db, options }) => async function exportQueryResults(params, req, res) {
   params = new GetDocumentsParams(params);
   const { model, propertiesToInclude, roles, searchText } = params;
 
@@ -45,6 +53,7 @@ module.exports = ({ db }) => async function exportQueryResults(params, req, res)
 
   const docs = await Model.
     find(filter).
+    setOptions(readOperationOptions(options, params)).
     sort({ _id: -1 });
 
   const rows = [propertiesToInclude];
@@ -66,3 +75,6 @@ module.exports = ({ db }) => async function exportQueryResults(params, req, res)
   res.setHeader('Content-Disposition', `attachment; filename="${model.toLowerCase()}-export.csv"`);
   return csv;
 };
+
+module.exports.paramsType = GetDocumentsParams;
+module.exports.tags = ['readOnly'];

package/backend/actions/Model/getCollectionInfo.js

@@ -2,6 +2,7 @@
 
 const Archetype = require('archetype');
 const authorize = require('../../authorize');
+const readOperationOptions = require('../../helpers/readOperationOptions');
 
 const GetCollectionInfoParams = new Archetype({
   model: {
@@ -10,10 +11,17 @@ const GetCollectionInfoParams = new Archetype({
   },
   roles: {
     $type: ['string']
+  },
+  maxTimeMS: {
+    $type: 'number'
+  },
+  readPreference: {
+    $type: 'string',
+    $enum: ['secondary', 'secondaryPreferred', 'primary']
   }
 }).compile('GetCollectionInfoParams');
 
-module.exports = ({ db }) => async function getCollectionInfo(params) {
+module.exports = ({ db, options }) => async function getCollectionInfo(params) {
   const { model, roles } = new GetCollectionInfoParams(params);
 
   await authorize('Model.getCollectionInfo', roles);
@@ -23,8 +31,9 @@ module.exports = ({ db }) => async function getCollectionInfo(params) {
     throw new Error(`Model ${model} not found`);
   }
 
+  const dbOptions = readOperationOptions(options, params);
   const [collectionOptions, stats] = await Promise.all([
-    Model.collection.options(),
+    Model.collection.options(dbOptions),
     Model.aggregate([
       {
         $collStats: {
@@ -32,7 +41,7 @@ module.exports = ({ db }) => async function getCollectionInfo(params) {
           count: {}
         }
       }
-    ]).then(res => res[0] ?? {})
+    ]).option(dbOptions).then(res => res[0] ?? {})
   ]);
 
   return {
@@ -47,3 +56,6 @@ module.exports = ({ db }) => async function getCollectionInfo(params) {
     }
   };
 };
+
+module.exports.paramsType = GetCollectionInfoParams;
+module.exports.tags = ['readOnly'];

package/backend/actions/Model/getDocument.js

@@ -4,6 +4,7 @@ const Archetype = require('archetype');
 const getRefFromSchemaType = require('../../helpers/getRefFromSchemaType');
 const removeSpecifiedPaths = require('../../helpers/removeSpecifiedPaths');
 const authorize = require('../../authorize');
+const readOperationOptions = require('../../helpers/readOperationOptions');
 
 const GetDocumentParams = new Archetype({
   model: {
@@ -16,10 +17,17 @@ const GetDocumentParams = new Archetype({
   },
   roles: {
     $type: ['string']
+  },
+  maxTimeMS: {
+    $type: 'number'
+  },
+  readPreference: {
+    $type: 'string',
+    $enum: ['secondary', 'secondaryPreferred', 'primary']
   }
 }).compile('GetDocumentParams');
 
-module.exports = ({ db }) => async function getDocument(params) {
+module.exports = ({ db, options }) => async function getDocument(params) {
   const { model, documentId, roles } = new GetDocumentParams(params);
 
   await authorize('Model.getDocument', roles);
@@ -31,7 +39,7 @@ module.exports = ({ db }) => async function getDocument(params) {
 
   const doc = await Model.
     findById(documentId).
-    setOptions({ sanitizeFilter: true }).
+    setOptions(readOperationOptions(options, { sanitizeFilter: true })).
     orFail();
   const schemaPaths = {};
   for (const path of Object.keys(Model.schema.paths)) {
@@ -49,3 +57,6 @@ module.exports = ({ db }) => async function getDocument(params) {
 
   return { doc: doc.toJSON({ virtuals: true, getters: false, transform: false }), schemaPaths, virtualPaths };
 };
+
+module.exports.paramsType = GetDocumentParams;
+module.exports.tags = ['readOnly'];

package/backend/actions/Model/getDocuments.js

@@ -7,6 +7,7 @@ const getRefFromSchemaType = require('../../helpers/getRefFromSchemaType');
 const getSuggestedProjection = require('../../helpers/getSuggestedProjection');
 const parseProjectionParam = require('../../helpers/parseProjectionParam');
 const authorize = require('../../authorize');
+const readOperationOptions = require('../../helpers/readOperationOptions');
 
 const GetDocumentsParams = new Archetype({
   model: {
@@ -37,10 +38,17 @@ const GetDocumentsParams = new Archetype({
   },
   roles: {
     $type: ['string']
+  },
+  maxTimeMS: {
+    $type: 'number'
+  },
+  readPreference: {
+    $type: 'string',
+    $enum: ['secondary', 'secondaryPreferred', 'primary']
   }
 }).compile('GetDocumentsParams');
 
-module.exports = ({ db }) => async function getDocuments(params) {
+module.exports = ({ db, options }) => async function getDocuments(params) {
   params = new GetDocumentsParams(params);
   const { roles } = params;
   await authorize('Model.getDocuments', roles);
@@ -75,6 +83,7 @@ module.exports = ({ db }) => async function getDocuments(params) {
   if (projection != null) {
     query = query.select(projection);
   }
+  query.setOptions(readOperationOptions(options, params));
   const cursor = await query.cursor();
   const docs = [];
   for (let doc = await cursor.next(); doc != null; doc = await cursor.next()) {
@@ -106,9 +115,16 @@ module.exports = ({ db }) => async function getDocuments(params) {
   }
   removeSpecifiedPaths(schemaPaths, '.$*');
 
-  const numDocuments = parsedFilter == null ?
-    await Model.estimatedDocumentCount() :
-    await Model.countDocuments(filter);
+  const countQuery = parsedFilter == null ?
+    Model.estimatedDocumentCount() :
+    Model.countDocuments(filter);
+  let numDocuments = null;
+  let numDocsError = null;
+  try {
+    numDocuments = await countQuery.setOptions(readOperationOptions(options, params));
+  } catch (err) {
+    numDocsError = err?.message;
+  }
 
   const suggestedFields = getSuggestedProjection(Model);
 
@@ -116,6 +132,10 @@ module.exports = ({ db }) => async function getDocuments(params) {
     docs: docs.map(doc => doc.toJSON({ virtuals: false, getters: false, transform: false })),
     schemaPaths,
     suggestedFields,
-    numDocs: numDocuments
+    numDocs: numDocuments,
+    numDocsError
   };
 };
+
+module.exports.paramsType = GetDocumentsParams;
+module.exports.tags = ['readOnly'];

package/backend/actions/Model/getDocumentsStream.js

@@ -7,6 +7,7 @@ const getRefFromSchemaType = require('../../helpers/getRefFromSchemaType');
 const getSuggestedProjection = require('../../helpers/getSuggestedProjection');
 const parseProjectionParam = require('../../helpers/parseProjectionParam');
 const authorize = require('../../authorize');
+const readOperationOptions = require('../../helpers/readOperationOptions');
 
 const GetDocumentsParams = new Archetype({
   model: {
@@ -37,10 +38,17 @@ const GetDocumentsParams = new Archetype({
   },
   roles: {
     $type: ['string']
+  },
+  maxTimeMS: {
+    $type: 'number'
+  },
+  readPreference: {
+    $type: 'string',
+    $enum: ['secondary', 'secondaryPreferred', 'primary']
   }
 }).compile('GetDocumentsParams');
 
-module.exports = ({ db }) => async function* getDocumentsStream(params) {
+module.exports = ({ db, options }) => async function* getDocumentsStream(params) {
   params = new GetDocumentsParams(params);
   const { roles } = params;
   await authorize('Model.getDocumentsStream', roles);
@@ -75,6 +83,7 @@ module.exports = ({ db }) => async function* getDocumentsStream(params) {
   if (projection != null) {
     query = query.select(projection);
   }
+  query.setOptions(readOperationOptions(options, params));
 
   const schemaPaths = {};
   for (const path of Object.keys(Model.schema.paths)) {
@@ -106,32 +115,36 @@ module.exports = ({ db }) => async function* getDocumentsStream(params) {
   yield { schemaPaths, suggestedFields };
 
   // Start counting documents in parallel with streaming documents
-  const numDocsPromise = (parsedFilter == null)
-    ? Model.estimatedDocumentCount().exec()
-    : Model.countDocuments(filter).exec();
-
-  const cursor = await query.cursor();
+  const countQuery = (parsedFilter == null)
+    ? Model.estimatedDocumentCount()
+    : Model.countDocuments(filter);
+  const numDocsPromise = countQuery.
+    setOptions(readOperationOptions(options, params)).
+    exec();
 
   let numDocsYielded = false;
   let numDocumentsPromiseResolved = false;
   let numDocumentsValue;
   let numDocumentsError;
 
-  try {
-    // Start listening for numDocsPromise resolution
-    numDocsPromise.then(num => {
-      numDocumentsPromiseResolved = true;
-      numDocumentsValue = num;
-    }).catch(err => {
-      numDocumentsPromiseResolved = true;
-      numDocumentsError = err;
-    });
+  // Attach both handlers immediately so a fast count failure cannot become
+  // an unhandled rejection while the document cursor is still opening.
+  numDocsPromise.then(num => {
+    numDocumentsPromiseResolved = true;
+    numDocumentsValue = num;
+  }).catch(err => {
+    numDocumentsPromiseResolved = true;
+    numDocumentsError = err;
+  });
+
+  const cursor = await query.cursor();
 
+  try {
     for (let doc = await cursor.next(); doc != null; doc = await cursor.next()) {
       // If numDocsPromise has resolved and not yet yielded, yield it first
       if (numDocumentsPromiseResolved && !numDocsYielded) {
         if (numDocumentsError) {
-          yield { error: numDocumentsError };
+          yield { numDocsError: numDocumentsError.message };
         } else {
           yield { numDocs: numDocumentsValue };
         }
@@ -142,10 +155,17 @@ module.exports = ({ db }) => async function* getDocumentsStream(params) {
 
     // If numDocsPromise hasn't resolved yet, wait for it and yield
     if (!numDocsYielded) {
-      const numDocuments = await numDocsPromise;
-      yield { numDocs: numDocuments };
+      try {
+        const numDocuments = await numDocsPromise;
+        yield { numDocs: numDocuments };
+      } catch (err) {
+        yield { numDocsError: err.message };
+      }
     }
   } finally {
     await cursor.close();
   }
 };
+
+module.exports.paramsType = GetDocumentsParams;
+module.exports.tags = ['readOnly'];

package/backend/actions/Model/getEstimatedDocumentCounts.js

@@ -2,14 +2,22 @@
 
 const Archetype = require('archetype');
 const authorize = require('../../authorize');
+const readOperationOptions = require('../../helpers/readOperationOptions');
 
 const GetEstimatedDocumentCountsParams = new Archetype({
   roles: {
     $type: ['string']
+  },
+  maxTimeMS: {
+    $type: 'number'
+  },
+  readPreference: {
+    $type: 'string',
+    $enum: ['secondary', 'secondaryPreferred', 'primary']
   }
 }).compile('GetEstimatedDocumentCountsParams');
 
-module.exports = ({ db }) => async function getEstimatedDocumentCounts(params) {
+module.exports = ({ db, options }) => async function getEstimatedDocumentCounts(params) {
   const { roles } = new GetEstimatedDocumentCountsParams(params);
   await authorize('Model.getEstimatedDocumentCounts', roles);
 
@@ -20,7 +28,9 @@ module.exports = ({ db }) => async function getEstimatedDocumentCounts(params) {
   const results = await Promise.allSettled(
     modelNames.map(name => {
       const Model = db.models[name];
-      return Model.estimatedDocumentCount().exec();
+      return Model.estimatedDocumentCount().
+        setOptions(readOperationOptions(options, params)).
+        exec();
     })
   );
 
@@ -36,3 +46,6 @@ module.exports = ({ db }) => async function getEstimatedDocumentCounts(params) {
 
   return { counts };
 };
+
+module.exports.paramsType = GetEstimatedDocumentCountsParams;
+module.exports.tags = ['readOnly'];

package/backend/actions/Model/getIndexes.js

@@ -35,3 +35,6 @@ module.exports = ({ db }) => async function getIndexes(params) {
     diffIndexes
   };
 };
+
+module.exports.paramsType = GetDocumentsParams;
+module.exports.tags = ['readOnly'];

package/backend/actions/Model/getSuggestedProjection.js

@@ -31,3 +31,6 @@ module.exports = ({ db }) => async function getSuggestedProjectionAction(params)
 
   return { suggestedFields };
 };
+
+module.exports.paramsType = GetSuggestedProjectionParams;
+module.exports.tags = ['readOnly'];

package/backend/actions/Model/listModels.js

@@ -55,3 +55,6 @@ module.exports = ({ db }) => async function listModels(params) {
     readyState
   };
 };
+
+module.exports.paramsType = ListModelsParams;
+module.exports.tags = ['readOnly'];

package/backend/actions/Model/streamChatMessage.js

@@ -78,3 +78,6 @@ const systemPrompt = `
 
   Return only the updated document body as a JavaScript object literal. Do not use Markdown or code fences.
 `.trim();
+
+module.exports.paramsType = StreamChatMessageParams;
+module.exports.tags = ['readOnly'];

package/backend/actions/Model/streamDocumentChanges.js

@@ -122,3 +122,6 @@ module.exports = ({ db, changeStream }) => async function* streamDocumentChanges
     }
   }
 };
+
+module.exports.paramsType = StreamDocumentChangesParams;
+module.exports.tags = ['readOnly'];

package/backend/actions/Model/updateDocument.js

@@ -2,6 +2,7 @@
 
 const Archetype = require('archetype');
 const authorize = require('../../authorize');
+const operationOptions = require('../../helpers/operationOptions');
 
 const UpdateDocumentsParams = new Archetype({
   model: {
@@ -21,10 +22,13 @@ const UpdateDocumentsParams = new Archetype({
   },
   roles: {
     $type: ['string']
+  },
+  maxTimeMS: {
+    $type: 'number'
   }
 }).compile('UpdateDocumentsParams');
 
-module.exports = ({ db }) => async function updateDocument(params) {
+module.exports = ({ db, options }) => async function updateDocument(params) {
   const { model, _id, update, unset, roles } = new UpdateDocumentsParams(params);
 
   await authorize('Model.updateDocument', roles);
@@ -58,6 +62,10 @@ module.exports = ({ db }) => async function updateDocument(params) {
   }
 
   const doc = await Model.
-    findByIdAndUpdate(_id, updateOperation, { sanitizeFilter: true, returnDocument: 'after', overwriteImmutable: true, runValidators: false });
+    findByIdAndUpdate(_id, updateOperation, { sanitizeFilter: true, returnDocument: 'after', overwriteImmutable: true, runValidators: false }).
+    setOptions(operationOptions(options, params));
   return { doc };
 };
+
+module.exports.paramsType = UpdateDocumentsParams;
+module.exports.tags = [];