Deprecate and kill async API

[XVincentX]

According to the documentation, gavel.js offers an async API to perform validation and other operations.

According to the code, this is not an async API but a wrapper that is blocking the event loop anyway.

This is bad and harmful as people thinks that the validation is non blocking (so I do not get worried about giant payloads as is off process), while at the end of the day it is.

Please deprecate and kill this API as soon as possible.

[artem-zakharchenko]

I would deprecate both current sync and async API. After #155 lands, validation of a given transaction is a function that returns a validation result. There is no need to keep an overhead of classes, and thus the following API becomes cumbersome and obsolete:

const { HttpRequest, ExpectedHttpRequest } = require('gavel')

const request = new HttpRequest({ ... })
request.expected = new ExpectedHttpRequest({ ... })
request.isValid()

When you can do:

const { validate } = require('gavel')

const request = { ... }
const expectedResult = { ... }
const result = validate(request, expectedRequest)

[artem-zakharchenko]

Reading through isValidatable implementation I find it extremely over-engineered and complex. It gives a wrong expectation to the end user what the method actually does. Here's the usage example from the tests:

before((done) => {
  isValidatable(
    similarHttpMessage,
    baseHttpMessage,
    variant,
    (err, result) => {
      error = err;
      results = result;
      done();
    }
  );

One would assume the call signature of this function is something like this:

type IsValidatable = (httpMessage: any, anotherHttpMessage:any, type: string, callback: Function) => void

But it's not.

Current isValidatable operates only on the first argument. We must rework this method entirely, and start from understanding what purpose and usage it has.

[ApiaryBot]

🎉 This issue has been resolved in version 6.0.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀