sinonjs/sinon

Cannot spy on property getters, and stubbed getters do not record calls

Open

#1,741 opened on Mar 21, 2018

View on GitHub
 (27 comments) (0 reactions) (0 assignees)JavaScript (9,548 stars) (764 forks)batch import
Help wantedProperty accessorshacktoberfestpinned

Description

  • Sinon version : 4.4.6
  • Environment : Chrome 65.0.3325.162 on Mac
  • Example URL : N/A
  • Other libraries you are using: N/A

What did you expect to happen?

I'm attempting to stub out - and monitor - a property getter, using the stubbing approach recommended in the documentation at http://sinonjs.org/releases/v4.4.6/stubs/#stubgetgetterfn

I was hoping that the resulting stub would report when the getter was actually invoked, but no such reports are logged.

(In fact, I don't actually want to stub the getter: I merely want to spy on it, but Sinon provides no property getter spy API right now afaik.)

What actually happens

I can successfully stub out the getter, and control what it does, but Sinon's invocation recording reports no calls.

(This is also related to issue #1545.)

I do understand that, for a stubbed property, there are really two sets of function calls going on - the getter and the setter - and so really there should be two sets of recordings going on. But right now, there are none: when stubbing a property, as recommended in the docs above, no recording happens.

How to reproduce

There's a small example at https://codesandbox.io/s/l5m9loy21l; output is in the console.

Contributor guide

Tech stack
javascript
Domain
testing
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-2 days
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.
mostly clear
Prerequisites
Familiarity with Sinon stubs and spiesUnderstanding of JavaScript property getters
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue is about Sinon not recording calls on stubbed property getters. Start by examining the source code for `stub.get()` and how `calls` are tracked. Look at the existing test cases for property stubbing in the sinon repository. The linked comment #1545 may provide additional context. The fix likely involves modifying the getter/setter handling in the stub implementation to properly record invocations.