Mocked type is missing in @suites/unit

[michaelcai]

Is there an existing issue for this?

• I have searched the existing issues

Current behavior

Description:
The @suites/unit package does not export the Mocked type as expected. When trying to import the Mocked type from @suites/unit using:

import { TestBed, Mocked } from '@suites/unit';

I receive the following error message:
Module '"@suites/unit"' has no exported member named 'Mocked'.

Minimum reproduction code

no

Steps to reproduce

No response

Expected behavior

Please include the Mocked type in the package's exports, or provide documentation for an alternative way to mock objects if the Mocked type has been deprecated or replaced.

Suites version

3.0.0

Node.js version

20.16.0

In which operating systems have you tested?

• macOS
• Windows
• Linux

Other

No response

[omermorad]

Hi,

Thank you for submitting this issue. I'll take a look and update here soon!

[roniavi]

Plus one on this @omermorad 🙏

[qballer]

I will look into this issue in October and try and solve it.

[omermorad]

@roniavi @michaelcai - While @qballer works to resolve this problem, please try the following workaround:

Try importing Mocked from @suites/doubles.x instead of @suites/unit. (In this case, @suites/doubles.jest).

import type { Mocked } from '@suites/doubles.jest';

This is a workaround; in order to maintain consistency and library agnostic behavior (mocking library), the Mocked type should essentially be imported from @suites/unit. You may easily modify it back to be imported from @suites/unit after the bug has been fixed.

Tell me whether it was successful please :)

[qballer]

https://github.com/qballer/suites_issue_426
I was able to reconstruct the bug in the above repo relatively easily. I will dig into why this is happening later.

[qballer]

I reconstructed the bug in the exact way described in the issue.

https://github.com/qballer/suites_issue_426

It works out of the box as expected, but after installing an additional package (e.g yarn add get-port), for some reason, the following is missing:
in
/node_modules/@suites/unit/dist/cjs/index.d.ts

Is missing:
/// <reference types="@suites/doubles.jest/unit" />

The same triple slash is missing in node_modules/@suites/unit/dist/esm/index.d.ts

Manually adding that to the d.ts file fixes the problem.

I've also noticed that the following is missing from node_modules/@suites/types.di/typings.d.ts, which is
export type IdentifierMetadata = import('@suites/di.nestjs').IdentifierMetadata;

Digging through the code, these are all added via post-install scripts of doubles.x and di.x. It looks like the fault is yarn for not running post-install script. this isn't happening in npm for example.

Which yarn version is being used?

yarnpkg/yarn#5476

[omermorad]

@michaelcai @jeffrey-jian @roniavi (also related to #439 - @mbrunoviegas)

Due to a known issue with Yarn v1.x's postinstall script handling (yarnpkg/yarn#5476), an extra step is required to set up reference types for your project. I've updated the docs, please follow: https://suites.dev/docs/overview/installation#for-yarn-v1x-users.

Please, let me know if it worked for you.

[jowusu837]

Worked for me, thanks!

[tomcastro]

Can confirm that the issue also happens in Yarn v4. Adding the global.d.ts file fixes another issue for me, that

import { TestBed } from '@suites/unit';
import type { Mocked } from '@suites/doubles.vitest';

let messagesController: MessagesController;
let messagesService: Mocked<MessagesService>;

const { unit, unitRef } = await TestBed.solitary(MessagesController).compile();

messagesController = unit;
messagesService = unitRef.get(MessagesService); // ERROR HERE: Type 'StubbedInstance<MessagesService>' is not assignable to type 'Mocked<MessagesService>'.

I still have to import Mocked from @suites/doubles.vitest instead of @suites/unit though 😕

[omermorad]

Can confirm that the issue also happens in Yarn v4. Adding the global.d.ts file fixes another issue for me, that

import { TestBed } from '@suites/unit';
import type { Mocked } from '@suites/doubles.vitest';

let messagesController: MessagesController;
let messagesService: Mocked<MessagesService>;

const { unit, unitRef } = await TestBed.solitary(MessagesController).compile();

messagesController = unit;
messagesService = unitRef.get(MessagesService); // ERROR HERE: Type 'StubbedInstance<MessagesService>' is not assignable to type 'Mocked<MessagesService>'.

I still have to import Mocked from @suites/doubles.vitest instead of @suites/unit though 😕

@tomcastro Could you please let me know the location of the global.d.ts file? Could you please provide the folder structure or the repository for reproduction?

[tomcastro]

@omermorad It's a monorepo with yarn workspaces (and turborepo). Structure looks kinda like:

apps/
--app1/
--app2/
---- src/
------ mytest.spec.ts
---- global.d.ts
---- package.json (@suites/unit and @suites/doubles.vitest are installed here)
yarn.lock
package.json

[omermorad]

@tomcastro I see. It might be that the global.d.ts file needs to be placed in a different location within the monorepo. Could you please provide a minimum reproduction repository so I can play with it?

[omermorad]

Fixed in suites-dev/suites.dev@fde85a4, see https://suites.dev/docs/overview/installation#type-reference-configuration

@tomcastro - any updates?

[saurabh-git-dev]

Having similar issue with nx nestjs with pnpm project.
Same thing working when I use npm. Without any extra configuration.

Trying to add global.d.ts which also not working. all deps are installed.