Wrong types in bull-board

[exactmultiple3425]

When I try to compile the following code, this error occurs

const adapters = [new BullAdapter(this.chatroomQueue)];
setQueues(adapters);

Error

Argument of type 'BullAdapter[]' is not assignable to parameter of type 'readonly QueueAdapter[]'.
  Type 'BullAdapter' is not assignable to type 'QueueAdapter'.
    The types returned by 'getClient()' are incompatible between these types.

It is caused by BullAdapter.getClient() returns Promise<Queue['client']> while Queue extends EventEmitter and setQueues only accept QueueAdapter[] and QueueAdapter.getClient returns Promise<Redis.Redis> (Redis.Redis is a type of ioredis)

Please fix the types definition if available, thanks.

[felixmosh]

Thank you for reporting this issue 🙏🏼

What version of TS are you using?

PR's are always welcome

[felixmosh]

I've tested the code using ts entry, and it compiles fine.

1. Clone this repo git clone [email protected]:felixmosh/bull-board.git
2. Install dps yarn install
3. Run example with yarn start:dev:server

It works as expected.

[exactmultiple3425]

I'm using typescript 3.9.2
my package.json also includes [email protected]

[felixmosh]

I've just tested it with typescript 3.9.2, still works.

[exactmultiple3425]

is it possible because @types/bull is in dependencies instead of devDependencies?

[exactmultiple3425]

I made the compilation working by the following steps

1. Git clone bull-board project
2. move all @types to devDependencies
3. yarn && yarn build && yarn link

Move to my project

1. Yarn remove bull-board
2. yarn link bull-board
3. yarn build

[felixmosh]

No, it should be in dependency, since types are part of the public api of the package (for TS users) and we consume them.

From the error looks like your ioredis types are not matched.

[felixmosh]

I made the compilation working by the following steps

1. Git clone bull-board project
2. move all @types to devDependencies
3. yarn && yarn build && yarn link

Move to my project

1. Yarn remove bull-board
2. yarn link bull-board
3. yarn build

Yeah, but now you've lost a type safty as lib consumer.

I've made a clean new project that consumes bull-board using only bull, it works.

What version of @types/ioredis do you have?

[exactmultiple3425]

I made the compilation working by the following steps

1. Git clone bull-board project
2. move all @types to devDependencies
3. yarn && yarn build && yarn link

Move to my project

1. Yarn remove bull-board
2. yarn link bull-board
3. yarn build

Yeah, but now you've lost a type safty as lib consumer.

I've made a clean new project that consumes bull-board using only bull, it works.

What version of @types/ioredis do you have?

4.16.2

[felixmosh]

What version of bull?

I've released v1.5.3 with @types/ioredis as dependency, can you try it?

[exactmultiple3425]

What version of bull?

[email protected]
[email protected]
[email protected]
@types/[email protected]

[felixmosh]

BTW, did you tried to clean install the project? (to remove node_modules & npm i)

[exactmultiple3425]

BTW, did you tried to clean install the project? (to remove node_modules & npm i)

I did

[felixmosh]

Try v1.5.3 of bull-board.

Can you check the version of node_modules/@types/ioredis && node_modules/bull/node_modules/@types/ioredis?

[exactmultiple3425]

Try v1.5.3 of bull-board.

Can you check the version of node_modules/@types/ioredis && node_modules/bull/node_modules/@types/ioredis?

node_modules/bull/node_modules/@types/ioredis: 4.14.9
node_modules/@types/ioredis: 4.16.2

tried 1.5.3, not working with another error message

error TS2345: Argument of type 'BullAdapter[]' is not assignable to parameter of type 'readonly QueueAdapter[]'.
  Type 'BullAdapter' is not assignable to type 'QueueAdapter'.
    The types returned by 'getClient()' are incompatible between these types.
      Type 'Promise<import("/Users/josephchong/work/projects/neard-js-server/node_modules/@types/bull/node_modules/@types/ioredis/index").Redis>' is not assignable to type 'Promise<import("/Users/josephchong/work/projects/neard-js-server/node_modules/bull-board/node_modules/@types/ioredis/index").Redis>'.
        Type 'Redis' is missing the following properties from type 'Redis': options, getrangeBuffer, lpushBuffer, lpos, and 21 more.

[felixmosh]

Weird... do you have "esModuleInterop": true, in your tsconfig.json?

[exactmultiple3425]

yes, I did

[felixmosh]

I don't understand why it install a different version of @types/ioredis for you...

Run npm ls @types/ioredis

I get

├─┬ [email protected]
│ ├─┬ @types/[email protected]
│ │ └── @types/[email protected] deduped
│ └── @types/[email protected]
└─┬ [email protected]
  └── @types/[email protected] deduped

Pls share your tree

[exactmultiple3425]

├─┬ @types/[email protected]
│ └── @types/[email protected] 
├── @types/[email protected] 
├─┬ @types/[email protected]
│ └── @types/[email protected] 
├─┬ [email protected]
│ └── @types/[email protected] 
└─┬ [email protected]
  └── @types/[email protected] 

[felixmosh]

I've downgraded the bull version to 3.15.0, and I get the same install result.

├─┬ [email protected]
│ ├─┬ @types/[email protected]
│ │ └── @types/[email protected] deduped
│ └── @types/[email protected]
└─┬ [email protected]
  └── @types/[email protected] deduped

Pls remove any lock files and reinstall you deps.

[exactmultiple3425]

I've downgraded the bull version to 3.15.0, and I get the same install result.

├─┬ [email protected]
│ ├─┬ @types/[email protected]
│ │ └── @types/[email protected] deduped
│ └── @types/[email protected]
└─┬ [email protected]
  └── @types/[email protected] deduped

Pls remove any lock files and reinstall you deps.

The issue is gone now and can be compiled now, thank you very much