feat: memo spec handlers (#343)

src/helpers/memo.js

@@ -0,0 +1,30 @@
+const jmv = require('../plugins/json.match');
+
+const specs = {};
+
+function memorize_spec(name, props) {
+  if (!specs[name]) {
+    specs[name] = [];
+  }
+  specs[name].push({ props });
+}
+
+function is_spec_memoized(name, new_props) {
+  const items = specs[name];
+  if (!items) {
+    return false;
+  }
+  for (const item of items) { 
+    const rules = jmv.getMatchingRules(item.props, '$');
+    const errors = jmv.validate(item.props, new_props, rules, '$', true);
+    if (!errors) { 
+      return true;
+    }
+  }
+  return false;
+}
+
+module.exports = {
+  memorize_spec,
+  is_spec_memoized
+}

src/index.d.ts

@@ -15,6 +15,10 @@ export * as settings from './exports/settings';
 export * as stash from './exports/stash';
 export * as state from './exports/state';
 
+export interface SpecOptions {
+  memo?: any
+}
+
 /**
  * returns an instance of a spec
  * @see https://pactumjs.github.io/api/requests/spec.html
@@ -25,7 +29,7 @@ export function spec(): Spec;
  * returns an instance of a spec & runs custom spec handler
  * @see https://pactumjs.github.io/api/requests/spec.html
  */
-export function spec<T = any>(name: string, data?: T): Spec;
+export function spec<T = any>(name: string, data?: T, opts?: SpecOptions): Spec;
 
 /**
  * returns an instance of spec

src/index.js

@@ -44,8 +44,8 @@ const pactum = {
   reporter,
   events,
 
-  spec(name, data) {
-    return new Spec(name, data);
+  spec(name, data, opts) {
+    return new Spec(name, data, opts);
   },
 
   flow(name) {

src/models/Spec.js

@@ -16,9 +16,10 @@ const rlc = require('../helpers/reporter.lifeCycle');
 const config = require('../config');
 const { findFile } = require('../helpers/file.utils');
 const stash = require('../exports/stash');
+const { memorize_spec, is_spec_memoized } = require('../helpers/memo');
 
 class Spec {
-  constructor(name, data) {
+  constructor(name, data, opts) {
     this.id = helper.getRandomId();
     this.flow = '';
     this._name = '';
@@ -38,6 +39,8 @@ class Spec {
     this._save = null;
     this._specHandlerData = data;
     hr.spec(name, data, this);
+    this._opts = opts || {};
+    this._opts.handler_name = name;
     this._expect.setDefaultResponseExpectations();
   }
 
@@ -513,6 +516,12 @@ class Spec {
   }
 
   async toss() {
+    if (this._opts.handler_name && typeof this._opts.memo !== 'undefined') {
+      if (is_spec_memoized(this._opts.handler_name, this._opts.memo)) {
+        return Promise.resolve();
+      }
+      memorize_spec(this._opts.handler_name, this._opts.memo);
+    }
     const tosser = new Tosser(this);
     return tosser.toss();
   }

test/component/memo.spec.js

@@ -0,0 +1,58 @@
+const { spec, handler } = require('../../src');
+const expect = require('chai').expect;
+
+describe('Memo', () => {
+
+  before(() => {
+    handler.addSpecHandler('default get memo', ({ spec }) => {
+      spec.useInteraction('default get');
+      spec.get('http://localhost:9393/default/get');
+      spec.expectStatus(200);
+    });
+    handler.addSpecHandler('default get memo duplicate', ({ spec }) => {
+      spec.useInteraction('default get');
+      spec.get('http://localhost:9393/default/get');
+      spec.expectStatus(200);
+    });
+  });
+
+  it('should memoize with boolean', async () => {
+    let response = await spec('default get memo', null, { memo: true }).returns('method');
+    expect(response).equals('GET')
+    response = await spec('default get memo', null, { memo: true }).returns('method');
+    expect(response).to.be.undefined;
+    response = await spec('default get memo', null, { memo: false }).returns('method');
+    expect(response).equals('GET')
+  });
+
+  it('should memoize with string', async () => {
+    let response = await spec('default get memo', null, { memo: 'free' }).returns('method');
+    expect(response).equals('GET');
+    response = await spec('default get memo', null, { memo: 'paid' }).returns('method');
+    expect(response).equals('GET');
+    response = await spec('default get memo', null, { memo: 'free' }).returns('method');
+    expect(response).to.be.undefined;
+    response = await spec('default get memo', null, { memo: 'paid' }).returns('method');
+    expect(response).to.be.undefined;
+  });
+
+  it('should memoize with object with multiple specs', async () => {
+    let response = await spec('default get memo', null, { memo: { plan: 'free' } }).returns('method');
+    expect(response).equals('GET');
+    response = await spec('default get memo', null, { memo: { plan: 'paid' } }).returns('method');
+    expect(response).equals('GET');
+    response = await spec('default get memo', null, { memo: { plan: 'free' } }).returns('method');
+    expect(response).to.be.undefined;
+    response = await spec('default get memo', null, { memo: { plan: 'paid' } }).returns('method');
+    expect(response).to.be.undefined;
+    response = await spec('default get memo duplicate', null, { memo: { plan: 'free' } }).returns('method');
+    expect(response).equals('GET');
+    response = await spec('default get memo duplicate', null, { memo: { plan: 'paid' } }).returns('method');
+    expect(response).equals('GET');
+    response = await spec('default get memo duplicate', null, { memo: { plan: 'free' } }).returns('method');
+    expect(response).to.be.undefined;
+    response = await spec('default get memo duplicate', null, { memo: { plan: 'paid' } }).returns('method');
+    expect(response).to.be.undefined;
+  });
+
+});