@owsas/parse-service

Easily find, save or delete Parse Objects

Stats

StarsIssuesVersionUpdatedCreatedSize
@owsas/parse-service
001.0.63 years ago3 years agoMinified + gzip package size for @owsas/parse-service in KB

Readme

Parse Service

Travis CI

This module exposes a class with static functions that help you find, save or delete Parse Objects with one call.

The motivation to use this package is because at some point you will need to test your code. Let's make an example with a function that adds two numbers:

// add.js
import Parse from 'parse';

export function addTwoNumbers(a, b) {
  const obj = new Parse.Object('Addition');
  obj.set('total', a + b);
  return obj.save();
}

You will find that testing this function, with jest for example, is a little bit tricky. It is because the save function of the object is not easily spyable or mockable, because you are creating a new instance of a class.

The problem here is that the save function will try to call the network, and you don't really want that if you are just unit testing your code.

So to solve the presented problem, in your testing framework you would have to mock Parse.Object to return an instance which has a mocked save method.

Our given solution is to expose a class with static functions that you can easily spy and avoid network calls from your unit tests.

Let's see how the code changes:

// add.js
import Parse from 'parse';
import { ParseService } from '@owsas/parse-service';

export function addTwoNumbers(a, b) {
  const obj = new Parse.Object('Addition');
  obj.set('total', a + b);
  return ParseService.save(obj); // the change is minimum, yet useful
}

As you can see, the save function from the object changed to ParseService.save, which is easily spyable in your testing framework. For example, in jest:

// add.test.js
import { ParseService } from '@owsas/parse-service';
import { addTwoNumbers } from './add';

describe('#addTwoNumbers', () => {
  test('should add two numbers', async () => {
    // mock ParseService
    const mock = jest.spyOn(ParseService, 'save');
    mock.mockImplementationOnce(async obj => obj);

    // call the function
    const result = await addTwoNumbers(1,3);
    expect(result.get('total')).toEqual(4); // passes
  });
});

In the presented example, you can see that we mocked ParseService's save function, and then tested that the returned object had the total set to the sum of 1 and 3.

In the same fashion, ParseService exposes static functions for:

  • Finding results in a Parse.Query (ParseService.find),
  • Finding the first result of a Parse.Query (ParseService.first),
  • Saving objects (ParseService.save)
  • Destroying objects (ParseService.destroy)

Installation

npm install --save @owsas/parse-service

or with Yarn:

yarn add @owsas/parse-service

Please, make sure you have also installed parse in your project, because this package has no dependencies

API

class ParseService {
  static count(
    query: Parse.Query, 
    options?: Parse.Query.CountOptions
  ): Parse.Promise<number>;

  static find(
    query: Parse.Query, 
    options?: Parse.Query.FindOptions
  ): Parse.Promise<Parse.Object[]>;

  static first(
    query: Parse.Query, 
    options?: Parse.Query.FirstOptions,
  ): Parse.Promise<Parse.Object>;

  static save(
    obj:Parse.Object, 
    options: Parse.Object.SaveOptions
  ): Parse.Promise<Parse.Object>;

  static destroy(
    obj:Parse.Object, 
    options: Parse.Object.DestroyOptions
  ): Parse.Promise<Parse.Object>;
}

Usage

async function test() {
  const query = new Parse.Query('Game');
  
  // using find and query options
  const results = await ParseService.find(query, { useMasterKey: true });

  // using first and query options
  const first = await ParseService.first(query, { useMasterKey: true });

  // without query options
  const first2 = await ParseService.first(query);

  // saving with save options
  first.set('points', 100);
  await ParseService.save(first, { useMasterKey: true, sessionToken: '...' });

  // without save options
  first.set('points', 100);
  await ParseService.save(first);

  // destroying with options
  await ParseService.destroy(first, { sessionToken: '...' });

  // destroying without options
  await ParseService.destroy(first);
}

Changelog

v1.0.6

  • Added each function

v1.0.5

  • Added travis CI

v1.0.4

  • Fixed git urls

v1.0.3

  • Added count function

v1.0.2

  • Added fetch function

Dev Mode

Clone this repo, and start adding your code in the index.ts file.
When you are done, write the tests in the index.test.ts file. For testing, this repo works with Jest.

Once you finished, you can publish your module to npm with npm publish. This will compile your Typescript code and send it to npm.

Make sure to change the name of the package in package.json

Dev Features

  • Testing with Jest
  • Linting out of the box (checks the style of your code), with TSLint
  • Build, prepublish and other scripts to help you to develop
  • Works with Typescript: Static typing for your JS Applications, reducing amount of runtime errors
  • Coverage out of the box, thanks to Jest
  • Uses deterministic module resolving, with Yarn

Credits

Developed by Juan Camilo Guarín Peñaranda,
Otherwise SAS, Colombia
2018

License

MIT.

Support us on Patreon

patreon

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.