test-methods.js

import { Mongo } from 'meteor/mongo';
import { check, Match } from 'meteor/check';
import { createMethod, Methods, schema, open, close, server } from 'meteor/jam:method';
import assert from 'assert';
import { z } from 'zod';
import SimpleSchema from 'meteor/aldeed:simple-schema';

const Any = Package['jam:easy-schema'] ? require('meteor/jam:easy-schema').Any : Match.Any;

export const wait = ms => new Promise(resolve => setTimeout(resolve, ms));

function log(input, pipeline) {
  pipeline.onResult((result) => {
    console.log(`Method ${pipeline.name} finished`, input);
    console.log('Result', result);
  });

  pipeline.onError((err) => {
    console.error(`Method ${pipeline.name} failed`);
    console.error('Error', err);
  });
};

export const mockedMethod = createMethod({
  name: 'mockedMethod',
  open: true,
  schema: {num: Number},
  run({ num }) {
    return { userId: `${this.userId}`, num };
  }
});

export const defaultAuthed = createMethod({
  name: 'defaultAuthed',
  schema: Any,
  run() {
    return 5;
  }
});

export const checkSchema = createMethod({
  name: 'checkSchema',
  schema: {num: Number, isPrivate: Boolean},
  open: true,
  async run({ num, isPrivate }) {
    if (isPrivate) {
      return num * 2;
    }

    return num
  }
});

export const zodSchema = createMethod({
  name: 'zodSchema',
  schema: z.object({num: z.number(), isPrivate: z.boolean()}),
  open: true,
  async run({ num }) {
    return num * 10
  }
});

export const simpleSchema = createMethod({
  name: 'simpleSchema',
  schema: new SimpleSchema({num: Number, isPrivate: Boolean}),
  open: true,
  async run({ num }) {
    return num * 20
  }
});

export const customValidate = createMethod({
  name: 'customValidate',
  open: true,
  validate(args) {
    check(args, {num: Number, isPrivate: Match.Maybe(Boolean)})
  },
  run({num}) {
    return num;
  }
});

export const customValidateAsync = createMethod({
  name: 'customValidateAsync',
  open: true,
  validate: async function(args) {
    check(args, {num: Number, isPrivate: Match.Maybe(Boolean)})

    const promise = new Promise((resolve, reject) => {
      if (args.num === 5) {
        reject('fail')
      } else {
        resolve('success')
      }
    })

    const result = await promise;
    if (result === 'fail') {
      throw 'fail'
    } else {
      return args
    }
  },
  run({num}) {
    return num;
  }
});

export const test1 = createMethod({
  name: 'test1',
  schema: Any,
  open: true,
  run() {
    return 5;
  }
});

export const testAsync = createMethod({
  name: 'testAsync',
  schema: {num: Number},
  open: true,
  async run({num}) {
    if (Meteor.isServer) {
      await wait(200)
    }

    return num * 10;
  }
});

export const testAsyncErrorClient = createMethod({
  name: 'testAsyncErrorClient',
  schema: {num: Number},
  open: true,
  async run({num}) {
    if (Meteor.isClient) {
      throw new Meteor.Error('client error')
    }
    if (Meteor.isServer) {
      await wait(200)
    }

    return num * 10;
  }
});

export const testAsyncErrorServer = createMethod({
  name: 'testAsyncErrorServer',
  schema: {num: Number},
  open: true,
  async run({num}) {
    if (Meteor.isServer) {
      await wait(200)
      throw new Meteor.Error('server error')
    }

    return num * 10;
  }
});

export const asyncMethod = createMethod({
  name: 'asyncMethod',
  schema: {num: Number},
  open: true,
  async run({ num }) {
    return new Promise(resolve => {
      setTimeout(() => {
        resolve(['result', 'result2', num]);
      }, 500);
    })
    .then(result => {
      return result.join(',');
    });
  }
});

export const noRetryMethod = createMethod({
  name: 'noRetryMethod',
  schema: {num: Number},
  open: true,
  options: {
    noRetry: true
  },
  async run({num}) {
    if (Meteor.isServer) {
      await wait(200)
    }

    return num * 10;
  }
});

export const voidMethod = createMethod({
  name: 'voidMethod',
  schema: {num: Number},
  open: true,
  async run({num}) {
    console.log('void')
  }
});

export const errorMethod = createMethod({
  name: 'errorMethod',
  schema: Any,
  open: true,
  run() {
    throw new Error('test error');
  }
});

export const methodUnblock = createMethod({
  name: 'methodUnblock',
  schema: Number,
  open: true,
  serverOnly: true,
  async run(n) {
    this.unblock();

    if (Meteor.isServer) {
      new Promise(resolve => setTimeout(resolve, 500))
      return n * 2;
    }

    return n;
  }
})

export const anySchema = Any;
export function run() { };

export const configMethod = createMethod({
  name: 'a',
  schema: anySchema,
  run
});

export const rateLimited = createMethod({
  name: 'rateLimited',
  schema: Any,
  open: true,
  rateLimit: {
    interval: 5000,
    limit: 5
  },
  run() {
    return true;
  }
});

export const wait100 = createMethod({
  name: 'wait100',
  schema: Any,
  open: true,
  async run() {
    // await wait(100); can't use setTimeout in 3.x
    return true;
  }
});

export const fastMethod = createMethod({
  name: 'fast',
  schema: Any,
  open: true,
  async run() {
    return 5;
  }
});

const beforeFunc = (args) => {
  assert(!!args.num, true)
  assert(typeof args.num, 'number')

  return true;
}

const anotherBeforeFunc = (args) => {
  assert(!!args.num, true)
  assert(typeof args.num, 'number')

  return 'whatever';
}

export const beforeMethod = createMethod({
  name: 'beforeMethod',
  schema: Any,
  open: true,
  before: beforeFunc,
  async run({ num }) {
    return num * 2;
  }
});

export const beforeArrayMethod = createMethod({
  name: 'beforeArrayMethod',
  schema: Any,
  open: true,
  before: [beforeFunc, anotherBeforeFunc],
  async run({ num }) {
    return num * 2;
  }
});

const afterFunc = (result, context) => {
  assert.equal(result, context.originalInput.num * 3);
  return true;
}

const anotherAfterFunc = (result, context) => {
  assert.equal(result, context.originalInput.num * 3);
  return true;
}

export const afterMethod = createMethod({
  name: 'afterMethod',
  schema: Any,
  open: true,
  async run({ num }) {
    return await num * 3;
  },
  after: afterFunc
});

export const afterArrayMethod = createMethod({
  name: 'afterArrayMethod',
  schema: Any,
  open: true,
  async run({ num }) {
    return await num * 3;
  },
  after: [afterFunc, anotherAfterFunc]
});

export const serverOnly = createMethod({
  name: 'serverOnly',
  schema: Any,
  open: true,
  serverOnly: true,
  async run({ num }) {
    return num * 3;
  }
});


export const simplePipeline = createMethod({
  name: 'simplePipeline',
  schema: Number,
  open: true,
}).pipe(
  (n) => n + 5,
  (n) => n - 1,
  (n) => n + 0.5
);

export const voidPipeline = createMethod({
  name: 'voidPipeline',
  schema: Number,
  open: true,
}).pipe(
  async function () { console.log('void pipeline') },
  async (n) => n + 5,
  async (n) => n - 1,
  async (n) => n + 0.5
);

export const asyncPipeline = createMethod({
  name: 'asyncPipeline',
  schema: Number,
  open: true,
}).pipe(
  async (n) => n + 5,
  (n) => Promise.resolve(n - 1),
  async (n) => n + 0.5
);

export const contextMethod = createMethod({
  name: 'context',
  schema: Number,
  open: true,
}).pipe(
  (input, context) => {
    resetEvents();
    return true
  },
  (input, context) => {
    assert.equal(input, true);
    assert.equal(typeof context.originalInput, 'number');
    assert.equal(context.type, 'method');
    assert.equal(context.name, 'context');

    context.onResult(r => {
      events.push(`result: ${r}`);
    });

    return input;
  }
);

export const contextFailedMethod = createMethod({
  name: 'contextFailedMethod',
  schema: Number,
  open: true,
  ...(!Meteor.isFibersDisabled && { serverOnly: true }), // in Meteor 2.x without running this on the server was producing a cached result of getEvents for some reason, not sure if it's a Tinytest bug or what. in 3.x it works as expected
}).pipe(
  (input, context) => {
    resetEvents();
    context.onError(err => {
      events.push(err.message);
    });
    context.onError(err => {
      events.push(err.message);
      throw new Meteor.Error('second err');
    });
    context.onResult(() => {
      events.push('result');
    });
  },
  () => {
    throw new Error('first err');
  }
);

const globalPipeline = createMethod({
  name: 'globalPipeline',
  schema: Number,
  open: true,
  run(input) {
    return input;
  }
});

export const globalBefore = async (input) => {
  const inc = (input, context) => input = input + 1
  Methods.configure({
    before: inc
  });

  return globalPipeline(input)
}

export const globalAfter = async (input) => {
  const dec = (input, context) => input = input - 1
  Methods.configure({
    after: dec
  });

  return globalPipeline(input)
}


// Used for publication tests

export const Numbers = new Mongo.Collection('numbers');
export const Selected = new Mongo.Collection('selected');

if (Meteor.isServer) {
  Numbers.removeAsync({});
  Selected.removeAsync({});

  for(let i = 0; i < 100; i++) {
    Numbers.insertAsync({ num: i, owner: i });
  }
}

let events = [];

export function recordEvent(text) {
  return events.push(text);
}

export function resetEvents() {
  events = [];
  return events;
}

export const getEvents = createMethod({
  name: 'getEvents',
  schema: Any,
  open: true,
  run() {
    return events
  }
});

export const setOptions = (num) => {
  Methods.configure({
    options: {
      ...Methods.config.options,
      returnStubValue: false
    }
  });

  const addSelected = createMethod({
    name: 'selected.insert',
    schema: Number,
    open: true,
    async run(num) {
      const selectedId = await Selected.insertAsync({
        _id: num.toString(),
        num
      });

      return selectedId
    }
  });
}

export const addSelected = createMethod({
  name: 'addSelected',
  schema: {num: Number},
  open: true,
  async run({num}) {
    const _id = '123'
    return Selected.insertAsync({
      _id,
      num
    });
  }
});

export const addSelectedAsync = createMethod({
  name: 'addSelectedAsync',
  schema: {num: Number},
  open: true,
  async run({num}) {
    const _id = (num * 2).toString();

    const selectedId = await Selected.insertAsync({
      _id,
      num
    });

    return selectedId
  }
});

export const rollBackAsync = createMethod({
  name: 'rollBackAsync',
  schema: {num: Number},
  open: true,
  async run({num}) {
    const _id = (num * 2).toString();

    if (Meteor.isServer) {
      throw new Meteor.Error('server error')
    }

    const selectedId = await Selected.insertAsync({
      _id,
      num
    });

    return selectedId
  }
});

export const removeSelected = createMethod({
  name: 'removeSelected',
  schema: String,
  open: true,
  async run(id) {
    return Selected.removeAsync({
      _id: id
    });
  }
});

export const updateSelected = createMethod({
  name: 'updateSelected',
  schema: { id: String, num: Number },
  open: true,
  async run({ id, num }) {
    return Selected.updateAsync(
      { _id: id },
      { $set: { num } }
    );
  }
});

async function checkOwnership(args) {
  const { ownerId } = args;

  const numberOwner = await Numbers.findOneAsync({ownerId});

  if (!numberOwner) {
    throw new Meteor.Error('not-authorized')
  }

  return args;
};


async function insertSelected({num, ownerId}) {
  const _id = (num * 3).toString();

  const selectedId = await Selected.insertAsync({
    _id,
    num,
    ownerId
  });

  return selectedId
};

export const addSelectedAsyncWithOwnerPipe = createMethod({
  name: 'addSelectedAsyncWithOwnerPipe',
  schema: {num: Number, ownerId: String},
  open: true
}).pipe(
  checkOwnership,
  insertSelected
)

export const addSelectedAsyncWithOwner = createMethod({
  name: 'addSelectedAsyncWithOwner',
  schema: {num: Number, ownerId: String},
  open: true,
  async run(args) {
    await checkOwnership(args);
    return await insertSelected(args);
  }
});

// test jam:easy-schema integration
export const Todos = new Mongo.Collection('todos');

const todoSchema = {
  _id: String,
  text: String
}

Todos.attachSchema(todoSchema);

const create = async ({ text }) => {
  return Todos.insertAsync({ text })
};

const edit = server(async ({ text }) => {
  return await text;
});

const num = schema(Number)(async num => {
  return await num;
});

const custom = schema({ _id: String, num: Number })(async ({ _id, num }) => {
  return await { _id, num };
});

const authRequired = close(async ({ text }) => {
  return await text;
});

const unAuthed = open(async ({ text }) => {
  return await text;
});

Todos.attachMethods({ create, edit, num, custom, authRequired }, {open: true});
Todos.attachMethods({ unAuthed });

// functional-style syntax
Methods.configure({
  open: true,
  after: server(log)
})

const aNum = schema(Number)(async num => {
  return await num;
});

export const numMethod = createMethod(aNum);
export const numMethod2 = createMethod(schema(Number)(async num => {
  return await num;
}));

const edit2 = async ({ text }) => await text;
const edit3 = server(async ({ text }) => await text);
const edit4 = async ({ text }) => await text;
const edit5 = server(async ({ text }) => {
  if (Meteor.isServer) {
    return 'sup';
  }
  return text;
});

export const editMethod = createMethod(schema({text: String})(edit2));
export const editMethod2 = createMethod(schema({text: String})(edit3));
export const editMethod3 = createMethod(server(schema({text: String})(edit4)));
export const editMethod4 = createMethod(server(schema({text: String})(async ({ text }) => {
  return await text;
})));
export const editMethod5 = createMethod(schema({text: String})(edit5));

export const closedMethod = createMethod(schema({text: String})(authRequired));

const authRequired2 = async ({ text }) => await text;
export const closedMethod2 = createMethod(server(close(schema({text: String})(authRequired2))));
export const closedMethod3 = createMethod(server(close(schema({text: String})(async ({ text }) => {
  return await text;
}))));

export const openMethod = createMethod(schema({text: String})(unAuthed));
export const openMethod2 = createMethod(server(schema({text: String})(unAuthed)));
const unAuthed2 = async ({ text }) => await text;
export const openMethod3 = createMethod(server(open(schema({text: String})(unAuthed2))));

const schemaless = () => 'hello';
const schemaed = str => 'yo';
export const schemalessMethod = createMethod(schemaless)
export const schemalessMethod2 = createMethod({
  name: 'schemalessMethod2',
  run: schemaless
})
export const schemalessMethod3 = createMethod({
  name: 'schemalessMethod3'
}).pipe(schemaless)

export const schemaedMethod = () => {
  try {
    createMethod(schemaed)
  } catch(e) {
    throw e
  }
};

export const schemaedMethod2 = () => {
  try {
    createMethod({
      name: 'schemaedMethod2',
      run: schemaed
    })
  } catch(e) {
    throw e
  }
};

export const schemaedMethod3 = () => {
  try {
    createMethod({
      name: 'schemaedMethod3'
    }).pipe(schemaless, schemaed)
  } catch(e) {
    throw e
  }
};