Parse SDK Mocked Database

Common errors

• TypeError: ParseMockDB.mockDB is not a function

  cause Attempting to call `mockDB` without passing the Parse SDK instance after v0.3.0, or `ParseMockDB` was accessed incorrectly.
  fix Ensure `const Parse = require('parse-shim');` and then call `ParseMockDB.mockDB(Parse);`.

• ReferenceError: Parse is not defined

  cause The Parse SDK (or `parse-shim`) was not imported or initialized before being passed to `ParseMockDB.mockDB()`.
  fix Add `const Parse = require('parse-shim');` at the top of your test file or ensure Parse is globally available if that's your setup.

• Error: "undefined" is not a valid class name.

  cause This error often occurs when trying to use `Parse.Object.extend` or `new Parse.Query` without a properly initialized Parse environment, which `parse-mockdb` hooks into.
  fix Ensure `Parse.initialize()` is called with placeholder values (appId, jsKey, masterKey) before mocking, as the Parse SDK sometimes requires this even when mocking.

Warnings

• breaking Version 0.4.0 is a breaking change, specifically targeting the 2.x series of the Parse JS SDK. If you are using Parse JS SDK 1.6+, you must pin your `parse-mockdb` dependency to the `v0.3.x` release to maintain compatibility.
  Fix: For Parse JS SDK 1.6+, use `npm install parse-mockdb@~0.3.0`. For Parse JS SDK 2.x+, use `npm install parse-mockdb`.
• breaking With v0.3.0, the `mockDB()` function now requires you to pass a reference to the Parse SDK instance you wish to mock. This was a significant change from previous versions.
  Fix: Update calls from `ParseMockDB.mockDB()` to `ParseMockDB.mockDB(Parse);` ensuring `Parse` is your initialized Parse SDK object.
• breaking As of v0.3.0, the `ParseMockDB` object is no longer patched onto the `Parse` module itself. You can no longer access it via `Parse.MockDB`.
  Fix: Always load `parse-mockdb` explicitly using `const ParseMockDB = require('parse-mockdb');` and refer to `ParseMockDB` directly.
• breaking The `ParseMockDB.promiseResultSync` method was removed in v0.3.0, impacting tests or code that relied on synchronous promise resolution within the mock.
  Fix: Refactor code to use standard asynchronous promise handling (e.g., `async/await` or `.then/.catch`) instead of the removed synchronous utility.
• gotcha The library's completeness section indicates several unimplemented features, including Parse class-level permissions, ACLs (row-level permissions), and special classes like `Parse.User` or `Parse.Role`. Tests relying on these features will not behave correctly with `parse-mockdb`.
  Fix: Structure tests to avoid dependencies on unimplemented features, or consider integrating with a full Parse Server for tests requiring these advanced functionalities.

Install

• npm install parse-mockdb npm
• yarn add parse-mockdb yarn
• pnpm add parse-mockdb pnpm

Imports

• ParseMockDB
  wrong:

  import ParseMockDB from 'parse-mockdb';

  correct:

  const ParseMockDB = require('parse-mockdb');

  Primarily designed for CommonJS usage, often in Node.js testing environments. ESM import syntax is not officially supported and may lead to issues.
• mockDB
  wrong:

  const { mockDB } = require('parse-mockdb'); mockDB(Parse);

  correct:

  ParseMockDB.mockDB(Parse);

  The `mockDB` and other utility functions are methods on the `ParseMockDB` object, not standalone named exports.
• Parse
  wrong:

  const Parse = require('parse');

  correct:

  const Parse = require('parse-shim');

  The library internally uses `parse-shim` for mocking, which is often used as a direct `require` in test setups alongside `parse-mockdb`.

Quickstart

This quickstart demonstrates how to set up `parse-mockdb`, mock the Parse SDK, perform basic CRUD operations, and then clean up the mock database. It highlights the typical workflow for unit testing Parse applications.

'use strict';
const Parse = require('parse-shim');
const ParseMockDB = require('parse-mockdb');

// Initialize Parse (e.g., required for some SDK operations)
Parse.initialize('appId', 'jsKey', 'masterKey');
Parse.serverURL = 'http://localhost:1337/parse'; // Or any placeholder

ParseMockDB.mockDB(Parse); // Mock the Parse RESTController

// Perform saves, queries, updates, deletes, etc... using the Parse JS SDK
async function testParseOperations() {
  const MyObject = Parse.Object.extend('MyObject');
  const myObject = new MyObject();
  myObject.set('key', 'value');
  await myObject.save();
  console.log('Object saved with id:', myObject.id);

  const query = new Parse.Query(MyObject);
  query.equalTo('key', 'value');
  const results = await query.find();
  console.log('Found objects:', results.length);
}

testParseOperations().then(() => {
  ParseMockDB.cleanUp(); // Clear the Database
  ParseMockDB.unMockDB(); // Un-mock the Parse RESTController
  console.log('MockDB cleaned up and un-mocked.');
});