New article: making Sinon work with complex setups (#2540)

Co-authored-by: Morgan Roderick <[email protected]>

docs/CONTRIBUTING.md

@@ -9,6 +9,7 @@ When you're contributing documentation changes for code in `main` branch, then d
 If you're contributing documentation for an existing release, then your documentation changes should go into the documentation for that release in `_releases/` folder, and possibly several of the following releases also.
 
 ### Where are all the _releases_?
+
 All the files that used to be under `_releases` in the `main` can be found in the `releases` branch. The `main` branch now only keeps the latest version. That means, to fix the docs of published releases you need to checkout the _relases branch_ and supply a PR against that.
 
 ## Running the documentation site locally

docs/_howto/link-seams-commonjs.md

@@ -1,13 +1,19 @@
 ---
 layout: page
-title: How to use Link Seams with CommonJS
+title: How to stub out CommonJS modules
 ---
 
-This page describes how to isolate your system under test, by stubbing out dependencies with [link seams][seams].
+This page describes how to isolate your system under test, by targetting the [link seams][seams]; replacing your dependencies with stubs you control.
 
-This is the CommonJS version, so we will be using [proxyquire][proxyquire] to construct our seams.
+> If you want a better understand of the example and get a good description of what _seams_ are, we recommend that you read the [seams (all 3 web pages)][seams] excerpt from the classic [Working Effectively with Legacy Code][legacy], though it is not strictly necessary.
 
-To better understand the example and get a good description of what seams are, we recommend that you read the [seams (all 3 web pages)][seams] excerpt from [Working Effectively with Legacy Code][legacy] before proceeding.
+This guide targets the CommonJS module system, made popular by NodeJS. There are other module systems, but until recent years this was the de-facto module system and even when the actual EcmaScript Module standard arrived in 2015, transpilers and bundlers can still _output_ code as CJS modules. For instance, Typescript outputs CJS modules per default as of 2023, so it is still relevant, as your `import foo from './foo'` might still end up being transpiled into `const foo = require('./foo')` in the end.
+
+<!-- TODO: input link to the other article on stubbing ESM -->
+
+## Hooking into `require`
+
+For us to replace the underlying calls done by `require` we need a tool to hook into the process. There are many tools that can do this: rewire, proxyquire, [Quibble][quibble], etc. This example will be using [proxyquire][proxyquire] to construct our _seams_ (i.e. replace the modules), but the actual mechanics will be very similar for the other tools.
 
 Read it?
 
@@ -83,3 +89,4 @@ describe("example", function () {
 [proxyquire]: https://github.com/thlorenz/proxyquire
 [demo-proxyquire]: https://github.com/sinonjs/demo-proxyquire
 [legacy]: https://www.goodreads.com/book/show/44919.Working_Effectively_with_Legacy_Code
+[quibble]: https://www.npmjs.com/package/quibble

docs/_howto/typescript-swc.md

@@ -0,0 +1,264 @@
+---
+layout: page
+title: "Case study: real world dependency stubbing"
+---
+
+Sinon is a simple tool that only tries to do a few things and do them well: creating and injecting test doubles (spies, fakes, stubs) into objects. Unfortunately, in todays world of build pipelines, complex tooling, transpilers and different module systems, doing the simple thing quickly becomes difficult.
+
+This article is a detailed step-by-step guide on how one can approach the typical issues that arise and various approaches for debugging and solving them. The real-world case chosen is using Sinon along with [SWC][swc-project], running tests written in TypeScript in the [Mocha test runner][mocha] and wanting to replace dependencies in this ([SUT][sut]). The essence is that there are always _many_ approaches for achieving what you want. Some require tooling, some can get away with almost no tooling, some are general in nature (not specific to SWC for instance) and some are a blend. This means you can usually make some of these approaches work for other combinations of tooling as well, once you understand what is going on. Draw inspiration from the approach and figure out what works for you!
+
+## On Typescript
+
+The Sinon project does not explicitly list TypeScript as a supported target environment. That does not mean Sinon will not run, just that there are so many complications that we cannot come up with guides on figuring out the details for you on every system :)
+
+Typescript is a super-set of EcmaScript (JavaScript) and can be transpiled in a wide variety of ways into EcmaScript, both by targetting different runtimes (ES5, ES2015, ES2023, etc) and module systems (CommonJS, ESM, AMD, ...). Some transpiler are closer to the what the standard TypeScript compiler produces, some are laxer in various ways and additionally they have all kinds of options to tweak the result. This is indeed complex, so before you dig yourself done in this matter, it is essential that you try to figure out what the resulting code _actually_ looks like.
+
+As you will see in this guide, adding a few sprinkles of `console.log` with the output of [`Object.getOwnPropertyDescriptor(object, propname)`][get-own] is usually sufficient to understand what is going on!
+
+All code and working setups described in this guide are on [Github][master-branch] and links to the correct branch can be found in each section.
+
+## Scenario
+
+### Tech
+
+- Mocha: drives the tests
+- SWC: very fast Rust-based transpiler able to target different module systems (CJS, ESM, ...) and target runtimes (ES5, ES2020, ...)
+- Typescript: Type-safe EcmaScript superset
+- Sinon: library for creating and injecting test doubles (stubs, mocks, spies and fakes)
+- Module system: CommonJS
+
+### Desired outcome
+
+Being able to replace exports on the dependency `./other` with a Sinon created test double in `main.ts` when running tests (see code below).
+
+### Problem
+
+Running tests with `ts-node` works fine, but changing the setup to using SWC instead results in the tests failing with the following output from Mocha:
+
+```
+1) main
+       should mock:
+     TypeError: Descriptor for property toBeMocked is non-configurable and non-writable
+```
+
+### Original code
+
+**main.ts**
+
+```typescript
+import { toBeMocked } from "./other";
+
+export function main() {
+  const out = toBeMocked();
+  console.log(out);
+}
+```
+
+**other.ts**
+
+```typescript
+export function toBeMocked() {
+  return "I am the original function";
+}
+```
+
+**main.spec.ts**
+
+```typescript
+import sinon from "sinon";
+import "./init";
+import * as Other from "./other";
+import { main } from "./main";
+import { expect } from "chai";
+
+const sandbox = sinon.createSandbox();
+
+describe("main", () => {
+  let mocked;
+  it("should mock", () => {
+    mocked = sandbox.stub(Other, "toBeMocked").returns("mocked");
+    main();
+    expect(mocked.called).to.be.true;
+  });
+});
+```
+
+Additionally, both the `.swcrc` file used by SWC and the `tsconfig.json` file used by `ts-node` is configured to produce modules of the CommonJS form, not ES Modules.
+
+### Brief Analysis
+
+The error message indicates the resulting output of transpilation is different from that of `ts-node`, as this is Sinon telling us that it is unable to do anything with the property of an object, when the [property descriptor][descriptor] is essentially immutable.
+
+Let us sprinkle some debugging statements to figure out what the differences between the two tools are. First we will add these some debugging output to the beginning of the test, for instance just after `it("should mock", () => {`, to see what the state is _before_ we attempt to do any modifications:
+
+```javascript
+console.log("Other", Other);
+console.log(
+  "Other property descriptors",
+  Object.getOwnPropertyDescriptors(Other)
+);
+```
+
+Now let's try what happens when running this again, once with the existing SWC setup and a second time after changing the config file for Mocha, `.mocharc.json`, to use `'ts-node'` instead of `'@swc/register` in its `'require'` array. This `--require` option of Node is for modules that will be run by Node before _your_ code, making it possible to do stuff like hook into `require` and transpile code on-the-fly.
+
+#### Output of a SWC configured run of `npm test`
+
+```
+Other { toBeMocked: [Getter] }
+Other property descriptors {
+  __esModule: {
+    value: true,
+    writable: false,
+    enumerable: false,
+    configurable: false
+  },
+  toBeMocked: {
+    get: [Function: get],
+    set: undefined,
+    enumerable: true,
+    configurable: false
+  }
+}
+    1) should mock
+
+
+  0 passing (4ms)
+  1 failing
+
+  1) main
+       should mock:
+     TypeError: Descriptor for property toBeMocked is non-configurable and non-writable
+```
+
+#### Output of a `ts-node` configured run of `npm test`
+
+```
+Other { toBeMocked: [Function: toBeMocked] }
+Other property descriptors {
+  __esModule: {
+    value: true,
+    writable: false,
+    enumerable: false,
+    configurable: false
+  },
+  toBeMocked: {
+    value: [Function: toBeMocked],
+    writable: true,
+    enumerable: true,
+    configurable: true
+  }
+}
+mocked
+    ✔ should mock
+```
+
+The important difference to note about the object `Other` is that the property `toBeMocked` is a simple writable _value_ in the case of `ts-node` and a non-configurable _getter_ in the case of SWC. It being a getter is not a problem for Sinon, as we have a multitude of options for replacing those, but if `configurable` is set to `false` Sinon cannot really do anything about it.
+
+Let us take a closer look.
+
+#### Conclusion of analysis
+
+SWC transforms the imports on the form `import * as Other from './other'` into objects where the individual exports are exposed through immutable accessors (_getters_).
+
+We can address this issue in mainly 3 ways:
+
+1. somehow reconfigure SWC to produce different output when running tests that we can work with, either making writable values or configurable getters
+2. use pure dependency injection, opening up `./other.ts` to be changed from the inside
+3. address how modules are loaded, injecting [an additional `require` "hook"](https://levelup.gitconnected.com/how-to-add-hooks-to-node-js-require-function-dee7acd12698)
+
+# Solutions
+
+## Mutating the output from the transpiler
+
+> [Working code][swc-mutable-export]
+
+If we can just flip the `configurable` flag to `true` during transpilation, Sinon could be instructed to replace the getter. It turns out, there is a SWC _plugin_ that does just that: [swc_mut_cjs_exports](https://www.npmjs.com/package/swc_mut_cjs_exports). By installing that and adding the following under the `jsc` key in `.swcrc`, you know get a configurable property descriptor.
+
+```json
+"experimental": {
+  "plugins": [[ "swc_mut_cjs_exports", {} ]]
+},
+```
+
+A getter _is_ different from a value, so you need to change your testcode slightly to replace the getter:
+
+```js
+const stub = sandbox.fake.returns("mocked");
+sandbox.replaceGetter(Other, "toBeMocked", () => stub);
+```
+
+## Use pure dependency injection
+
+> [Working code][pure-di]
+
+This technique works regardless of language, module systems, bundlers and tool chains, but requires slight modifications of the SUT to allow modifying it. Sinon cannot help with resetting state automatically in this scenario.
+
+**other.ts**
+
+```typescript
+function _toBeMocked() {
+  return "I am the original function";
+}
+
+export let toBeMocked = _toBeMocked;
+
+export function _setToBeMocked(mockImplementation) {
+  toBeMocked = mockImplementation;
+}
+```
+
+**main.spec.ts**
+
+```typescript
+describe("main", () => {
+  let mocked;
+  let original = Other.toBeMocked;
+
+  after(() => Other._setToBeMocked(original))
+
+  it("should mock", () => {
+    mocked = sandbox.stub().returns("mocked");
+    Other._setToBeMocked(mocked)
+    main();
+    expect(mocked.called).to.be.true;
+  });
+```
+
+## Hooking into Node's module loading
+
+> [Working code][cjs-mocking]
+
+This is what [the article on _targetting the link seams_][link-seams-cjs] is about. The only difference here is using Quibble instead of Proxyquire. Quibble is slightly terser and also supports being used as a ESM _loader_, making it a bit more modern and useful. The end result:
+
+```typescript
+describe("main module", () => {
+  let mocked, main;
+
+  before(() => {
+    mocked = sandbox.stub().returns("mocked");
+    quibble("./other", { toBeMocked: mocked });
+    ({ main } = require("./main"));
+  });
+
+  it("should mock", () => {
+    main();
+    expect(mocked.called).to.be.true;
+  });
+});
+```
+
+# Final remarks
+
+As can be seen, there are lots of different paths to walk in order to achieve the same basic goal. Find the one that works for your case.
+
+[link-seams-cjs]: /how-to/link-seams-commonjs/
+[master-branch]: https://github.com/fatso83/sinon-swc-bug
+[descriptor]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/defineProperty
+[get-own]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/getOwnPropertyDescriptor
+[swc-project]: https://swc.rs/
+[mocha]: https://mochajs.org/
+[sut]: http://xunitpatterns.com/SUT.html
+[require-hook]: https://levelup.gitconnected.com/how-to-add-hooks-to-node-js-require-function-dee7acd12698
+[swc-mutable-export]: https://github.com/fatso83/sinon-swc-bug/tree/swc-with-mutable-exports
+[pure-di]: https://github.com/fatso83/sinon-swc-bug/tree/pure-di
+[cjs-mocking]: https://github.com/fatso83/sinon-swc-bug/tree/cjs-mocking

docs/_includes/header.html

@@ -9,7 +9,6 @@
       <ul class="nav navbar-nav navbar-right">
         <li><a href="{{ site.baseurl }}/releases/v{{site.sinon.current_major_version}}">Documentation</a></li>
         <li><a href="{{ site.baseurl }}/releases/">Releases</a></li>
-        <li><a href="{{ site.baseurl }}/guides/">Guides</a></li>
         <li><a href="{{ site.baseurl }}/how-to/">How To</a></li>
         <li><a href="https://github.com/sinonjs/" target="blank" class="github-nav"><img src="{{ "/assets/images/github.png" | prepend: site.baseurl }}" alt="Github"></a></li>
       </ul>