Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat!: introduce nestjs-sqs v3 #85

Merged
merged 8 commits into from
Jul 14, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
refactor: apply Biome lint and format
ssut committed Jul 12, 2024
commit c803d1d70ffe176f1a66ea3ec739e9241f4e8a43
3 changes: 2 additions & 1 deletion lib/sqs.decorators.ts
Original file line number Diff line number Diff line change
@@ -2,4 +2,5 @@ import { SetMetadata } from '@nestjs/common';
import { SQS_CONSUMER_EVENT_HANDLER, SQS_CONSUMER_METHOD } from './sqs.constants';

export const SqsMessageHandler = (name: string, batch?: boolean) => SetMetadata(SQS_CONSUMER_METHOD, { name, batch });
export const SqsConsumerEventHandler = (name: string, eventName: string) => SetMetadata(SQS_CONSUMER_EVENT_HANDLER, { name, eventName });
export const SqsConsumerEventHandler = (name: string, eventName: string) =>
SetMetadata(SQS_CONSUMER_EVENT_HANDLER, { name, eventName });
43 changes: 15 additions & 28 deletions lib/sqs.module.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { DiscoveryModule, DiscoveryService } from '@golevelup/nestjs-discovery';
import { DynamicModule, Global, Module, Provider, Type } from '@nestjs/common';
import { SQS_OPTIONS } from './sqs.constants';
import { SqsService } from './sqs.service';
import { SqsModuleAsyncOptions, SqsModuleOptionsFactory, SqsOptions } from './sqs.types';
import { SQS_OPTIONS } from './sqs.constants';
import { DiscoveryModule, DiscoveryService } from '@golevelup/nestjs-discovery';

@Global()
@Module({
@@ -18,23 +18,17 @@ export class SqsModule {
};
const sqsProvider: Provider = {
provide: SqsService,
// biome-ignore lint/correctness/noUnusedVariables: <ignore>
useFactory: (sqsOptions: SqsOptions, discover: DiscoveryService) => new SqsService(options, discover),
inject: [SQS_OPTIONS, DiscoveryService],
};

return {
global: true,
module: SqsModule,
imports: [
DiscoveryModule,
],
providers: [
sqsOptions,
sqsProvider,
],
exports: [
sqsProvider,
],
imports: [DiscoveryModule],
providers: [sqsOptions, sqsProvider],
exports: [sqsProvider],
};
}

@@ -50,13 +44,8 @@ export class SqsModule {
global: true,
module: SqsModule,
imports: [DiscoveryModule, ...(options.imports ?? [])],
providers: [
...asyncProviders,
sqsProvider,
],
exports: [
sqsProvider,
],
providers: [...asyncProviders, sqsProvider],
exports: [sqsProvider],
};
}

@@ -76,16 +65,14 @@ export class SqsModule {

private static createAsyncOptionsProvider(options: SqsModuleAsyncOptions): Provider {
if (options.useFactory) {
return {
provide: SQS_OPTIONS,
useFactory: options.useFactory,
inject: options.inject || [],
};
}
return {
provide: SQS_OPTIONS,
useFactory: options.useFactory,
inject: options.inject || [],
};
}

const inject = [
(options.useClass || options.useExisting) as Type<SqsModuleOptionsFactory>,
];
const inject = [(options.useClass || options.useExisting) as Type<SqsModuleOptionsFactory>];
return {
provide: SQS_OPTIONS,
useFactory: async (optionsFactory: SqsModuleOptionsFactory) => await optionsFactory.createOptions(),
16 changes: 7 additions & 9 deletions lib/sqs.service.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
import { GetQueueAttributesCommand, PurgeQueueCommand, QueueAttributeName, SQSClient } from '@aws-sdk/client-sqs';
import { DiscoveryService } from '@golevelup/nestjs-discovery';
import { Inject, Injectable, Logger, LoggerService, OnModuleDestroy, OnModuleInit } from '@nestjs/common';
import { Consumer, StopOptions } from 'sqs-consumer';
import { Producer } from 'sqs-producer';
import { SQSClient, GetQueueAttributesCommand, PurgeQueueCommand, QueueAttributeName } from '@aws-sdk/client-sqs';
import { SQS_CONSUMER_EVENT_HANDLER, SQS_CONSUMER_METHOD, SQS_OPTIONS } from './sqs.constants';
import {
Message,
QueueName,
@@ -10,8 +12,6 @@ import {
SqsMessageHandlerMeta,
SqsOptions,
} from './sqs.types';
import { DiscoveryService } from '@golevelup/nestjs-discovery';
import { SQS_CONSUMER_EVENT_HANDLER, SQS_CONSUMER_METHOD, SQS_OPTIONS } from './sqs.constants';

@Injectable()
export class SqsService implements OnModuleInit, OnModuleDestroy {
@@ -30,12 +30,10 @@ export class SqsService implements OnModuleInit, OnModuleDestroy {
this.logger = this.options.logger ?? new Logger('SqsService', { timestamp: false });
this.globalStopOptions = this.options.globalStopOptions ?? {};

const messageHandlers = await this.discover.providerMethodsWithMetaAtKey<SqsMessageHandlerMeta>(
SQS_CONSUMER_METHOD,
);
const eventHandlers = await this.discover.providerMethodsWithMetaAtKey<SqsConsumerEventHandlerMeta>(
SQS_CONSUMER_EVENT_HANDLER,
);
const messageHandlers =
await this.discover.providerMethodsWithMetaAtKey<SqsMessageHandlerMeta>(SQS_CONSUMER_METHOD);
const eventHandlers =
await this.discover.providerMethodsWithMetaAtKey<SqsConsumerEventHandlerMeta>(SQS_CONSUMER_EVENT_HANDLER);

this.options.consumers?.forEach((options) => {
const { name, stopOptions, ...consumerOptions } = options;
4 changes: 2 additions & 2 deletions lib/sqs.types.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import type { MessageAttributeValue } from '@aws-sdk/client-sqs';
import type { LoggerService, ModuleMetadata, Type } from '@nestjs/common';
import type { Consumer, ConsumerOptions, StopOptions } from 'sqs-consumer';
import type { Producer } from 'sqs-producer';
import type { LoggerService, ModuleMetadata, Type } from '@nestjs/common';
import type { MessageAttributeValue } from '@aws-sdk/client-sqs';

export type ProducerOptions = Parameters<typeof Producer.create>[0];
export type QueueName = string;