SetVisibility for NestJs BullBoardFeatureModule

[jeanbacan]

I would like to set guards/ visibility per queue when using NestJs. What happens is, BullboardFeatureModule instantiate the adapter with new queueOption.adapter(...) inside its Module onModuleInit which prevents me from dynamically creating this module and setting a custom visibility.
The options passed to the adaptor do not expect visibility function nor the type used by BullBoardQueueOptions accepts a previously created adapter instance.

Suggestions:
passing setVisibility function in QueueAdapterOptions or BullboardQueueOptions
Accepting adapter instances on BullMQAdapter, althought defeats the purpose of DI used by Nest
Export the adapter with ModuleRef to offer access later durin module creation;
Expand createBullBoard return type to be able to retrieve queue/adaptors from getQueueApi

[felixmosh]

Hi, can you elaborate?
What do you mean by "set visibility"?

[jeanbacan]

On the BaseAdaptor from the Api I believe you have access to setVisibilityGuard when creating a new BullMQAdaptor. This is later used by isVisible to determine if a queue is visible or not in the dashboard. This is good because I can manage access per queue per user accessing it. Alternatively I'm not sure how I'd do it. But the visibility is called probably when rendering the queues in the UI.
That said, having nestJS module to give me access to that would be ideal. Alternatively I could rewrite my own feature Module to instantiate the adaptor my own way, or extend the BullMQAdaptor and calling its own setVisibleGuard in the constructor. It's just weird because it forces me to use the same constructor of the parent Adaptor (queue, options). I can send some code snippet tomorrow. Is a bit late for me. Thanks

[felixmosh]

I'm not familiar with Nest.js at all, but from reviewing the code, looks like you need the access to the QueueAdapter, and bullboard currenlty doesn't have this method...

will it solve your issue if bull-board will have getQueue method (just like setQueue, addQueue etc...), this way you will be able to get the adapter, and add your visibility guard.

BTW, another option is to use addQueue on the BullBoardInstance, so, instead of using BullBoardModule.forFeature to register a queue, you can Inject the bullboard instance, and use the addQueue method, to register you QueueAdapters, there, You will have the access to the adapter instance.

[jeanbacan]

Sorry for the delay. I was a bit busy with my project.
Here is my suggestion for simplicity. Adjust the following types:

static forFeature<T extends QueueAdapterOptions>(...queues: BullBoardQueueOptions<T>[]): DynamicModule;

export type BullBoardQueueOptions<T extends QueueAdapterOptions> = {
    name: string;
    adapter: {
        new (queue: any, options?: Partial<T>): BaseAdapter;
    };
    options?: Partial<T>;
};

The reason is, we can improve the nestjs module instead of moving away from it. The addQueue could help, but if you're not using nestjs module, you actually don't need it. You do have access to the adaptor when creating the board with: const adaptor = new BullMQAdapter(). Thus being able to call setVisibility. The above types should allow people to override the adaptor in the following way

export class MyBullMQAdapter extends BullMQAdapter {

  constructor(queue: Queue, options?: MyBullMQAdapterOptions) {
    super(queue, options);
    //Access your own options here.

    super.setVisibilityGuard((req: BullBoardRequest) => {
      //custom validation based on your options, or even a full function.
    });
    //other changes necessary to the adapter.
  }
}

//Using
BullBoardModule.forFeature({
        name: options.name,
        adapter: myDashOptions.isSecure ? MyBullMQAdapter : BullMQAdapter,
        options: {...}})

In any case, could be beneficial for nestjs users to have the adaptors here added to a global provider and then be exported here. I haven't tested this because it requires me to re-write the feature module but the above types is what I choose to use.

[felixmosh]

As I've said, I'm not familier with Nest.js, what is the best Nest.js way of solving it?

[jeanbacan]

Thats actually a type defined here https://github.com/felixmosh/bull-board/blob/master/packages/nestjs/src/bull-board.types.ts

I just tweaked to accept BullMQAdapter extensions

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.