balderdashy/sails

Stub SailsJs helper function which is called with named arguments

Open

#6,986 opened on May 6, 2020

View on GitHub
 (5 comments) (0 reactions) (0 assignees)JavaScript (1,953 forks)batch import
help wantedtry this out please

Repository metrics

Stars
 (22,778 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Node version: 10.X Sails version (sails): 1.2.3

I'm trying to mock/stub a sailsjs helper function which is called with named arguments. Using sinon library for function mocking.

Example:

function call that needs to be mocked: await sails.helpers.getData.with({})

Tried Solutions:

  1. sinon.stub(sails.helpers, 'getData').returns(true)

issue -> sails.helpers.getData.with is not a function

  1. sinon.stub(sails.helpers.getData, 'with').returns(true)

issue -> Cannot redefine property: with

reason -> non-configurable property is set to false for sails object. And we can't change that.

  1. Tried creating a fake function and adding it to sails.helpers.getData['with'] property

  2. Also tried setting special setters to sails.helpers.getData object with the help of rewire library.

What is the way to stub a helper which is called with named args.

Contributor guide

Research direction
Investigate how Sails.js implements 'with' on helpers and explore sinon's ability to stub non configurable properties or use proxyquire/rewire to mock at the module level.
Tech stack
javascriptnodejs
Domain
backend
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Needs investigation
Prerequisites
Node.jssinon
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60