Skip to content

fix(pubsub): ensure immediate message retry when noAck=true and processing fails #55

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

Merged
merged 2 commits into from
Aug 8, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
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
98 changes: 98 additions & 0 deletions lib/gc-pubsub.server.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ import { NO_MESSAGE_HANDLER } from '@nestjs/microservices/constants';
import { BaseRpcContext } from '@nestjs/microservices/ctx-host/base-rpc.context';
import { ALREADY_EXISTS } from './gc-pubsub.constants';
import { GCPubSubOptions } from './gc-pubsub.interface';
import { Message } from '@google-cloud/pubsub';
import { Logger } from '@nestjs/common';

describe('GCPubSubServer', () => {
let server: GCPubSubServer;
Expand All @@ -16,6 +18,33 @@ describe('GCPubSubServer', () => {
const objectToMap = (obj: any) =>
new Map(Object.keys(obj).map((key) => [key, obj[key]]) as any);

const createMockMessage = (data: any, attributes: any = {}): Message => ({
ackId: 'id',
// @ts-expect-error - Mock message for testing
publishTime: new Date(),
attributes,
id: 'id',
received: 0,
deliveryAttempt: 1,
ack: () => {},
modAck: () => {},
nack: () => {},
data: Buffer.from(typeof data === 'string' ? data : JSON.stringify(data)),
});

const simulateMessageEvent = async (
server: GCPubSubServer,
message: Message,
) => {
const onCall = subscriptionMock.on
.getCalls()
.find((call: sinon.SinonSpyCall) => call.args[0] === 'message');

expect(onCall, 'No message handler registered').to.exist;
const messageHandler = onCall.args[1];
await messageHandler(message);
};

afterEach(() => {
sandbox.restore();
});
Expand Down Expand Up @@ -202,6 +231,70 @@ describe('GCPubSubServer', () => {
});
});

describe('message acknowledgment behavior', () => {
const msg = {
pattern: 'test',
data: 'tests',
id: '3',
};

it('should auto acknowledge message when noAck is true and message handling succeeded', async () => {
server = getInstance({ noAck: true });
await server.listen(() => {});

const message = createMockMessage(msg);
const ackSpy = sinon.spy(message, 'ack');

await simulateMessageEvent(server, message);

expect(ackSpy.calledOnce).to.be.true;
});

it('should auto negative acknowledge message when noAck is true and message handling failed', async () => {
server = getInstance({ noAck: true });
await server.listen(() => {});

const message = createMockMessage(msg);
const nackSpy = sinon.spy(message, 'nack');

(server as any).messageHandlers = objectToMap({
[msg.pattern]: sinon.stub().rejects(new Error('Handler failed')),
});

await simulateMessageEvent(server, message);

expect(nackSpy.calledOnce).to.be.true;
});

it('should not auto acknowledge message when noAck is false and message handling succeeded', async () => {
server = getInstance({ noAck: false });
await server.listen(() => {});

const message = createMockMessage(msg);
const ackSpy = sinon.spy(message, 'ack');

await simulateMessageEvent(server, message);

expect(ackSpy.called).to.be.false;
});

it('should not auto negative acknowledge message when noAck is false and message handling failed', async () => {
server = getInstance({ noAck: false });
await server.listen(() => {});

const message = createMockMessage(msg);
const nackSpy = sinon.spy(message, 'nack');

(server as any).messageHandlers = objectToMap({
[msg.pattern]: sinon.stub().rejects(new Error('Handler failed')),
});

await simulateMessageEvent(server, message);

expect(nackSpy.called).to.be.false;
});
});

describe('sendMessage', () => {
beforeEach(async () => {
server = getInstance({});
Expand Down Expand Up @@ -286,6 +379,11 @@ describe('GCPubSubServer', () => {

sandbox = sinon.createSandbox();

const logger = new Logger();
sinon.stub(logger, 'error');

server['logger'] = logger;

subscriptionMock = {
create: sandbox.stub().resolves(),
close: sandbox.stub().callsFake((callback) => callback()),
Expand Down
14 changes: 11 additions & 3 deletions lib/gc-pubsub.server.ts
Original file line number Diff line number Diff line change
Expand Up @@ -128,9 +128,17 @@ export class GCPubSubServer

this.subscription
.on('message', async (message: Message) => {
await this.handleMessage(message);
if (this.noAck) {
message.ack();
try {
await this.handleMessage(message);
if (this.noAck) {
message.ack();
}
} catch (err: any) {
if (this.noAck) {
message.nack();
}

this.logger.error(err);
}
})
.on('error', (err: any) => this.logger.error(err));
Expand Down