UnitReference.get method return type mismatch

[mbrunoviegas]

Hi! I'm facing a weird behavior using NestJs and it's related @suites packages.

I reproduced the problem in a simple application, which you can check here.

I have the following test file:

import type { Mocked } from '@suites/doubles.jest';
import { TestBed } from '@suites/unit';
import { BasicQueryHandler } from './basic-query.handler';
import { AppService } from './app.service';
import { BasicQuery } from './queries/basic-query';
import { APP_SERVICE, IAppService } from './interfaces/app.service';

describe('BasicQueryHandler', () => {
  let handler: BasicQueryHandler;
  let appService: Mocked<AppService>;

  beforeEach(async () => {
    const { unit, unitRef } =
      await TestBed.solitary(BasicQueryHandler).compile();
    handler = unit;
    appService = unitRef.get<IAppService>(APP_SERVICE);
  });

  it('should return "Hello World!"', async () => {
    appService.getHello.mockReturnValue('Hello MB!');
    const result = await handler.execute(new BasicQuery('World'));
    expect(result).toBe('Hello MB!');
  });
});

The first execution is sucessful and this is the doc generated from the library about unitRef.get

After installing @faker-js/faker, an error was reported, indicating that the return typing of unitRef.get was different from the one declared for appService. And also the description of get method, changed.

Type 'StubbedInstance<IAppService>' is not assignable to type 'Mocked<AppService>'.
  Type 'StubbedInstance<IAppService>' is not assignable to type '{ getHello: MockInstance<string, [foo: string], unknown>; }'.
    Types of property 'getHello' are incompatible.
      Type 'StubbedMember<(foo: string) => string>' is missing the following properties from type 'MockInstance<string, [foo: string], unknown>': getMockName, mock, mockClear, mockReset, and 13 more.ts(2322)

I checked the type files of unitRef and it wasn't modified. I also checked if the problem happens when installing diffent packages and it does.

Searching for a alternative, I chose to follow the recommendations from NestJs Doc, but I'd prefer to use the most recent version of @suites packages.

Any clue on what's going on?

[omermorad]

Hi @mbrunoviegas,
This occurs due to the Mocked type being imported from @suites/doubles.jest instead of being imported from @suites/unit.

This solution contains an issue; kindly refer to #426, which will be resolved shortly.

I would appreciate an update on how it turned out!

[qballer]

I would import Mocked like @omermorad suggested and use yarn install --force after adding a package as a workaround to the postinstall issue in yarn. You may refer to issue #426 for more details.

[omermorad]

@mbrunoviegas please refer here: #426 (comment)