feat(microservices): add status, unwrap, on, and other features

[kamilmysliwiec]

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our guidelines: https://github.com/nestjs/nest/blob/master/CONTRIBUTING.md
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

• Bugfix
• Feature
• Code style update (formatting, local variables)
• Refactoring (no functional changes, no api changes)
• Build related changes
• CI related changes
• Other... Please describe:

What is the current behavior?

Issue Number: #14044 #11913 #14140

What is the new behavior?

Improvements: graceful reconnection for all transporters, exposed API to listen to internal events, ability to unwrap the client proxy and retrieve the underlying client/server reference, exposed status stream to subscribe to recent client status changes.

Use-cases:

1. React to status changes from server instances or client proxies:

const serviceRef = app.connectMicroservice({
  transport: Transport.NATS,
  options: {},
});

serviceRef.status.subscribe(status => {
  console.log('Status:', status);
});

Client:

this.clientProxy.status.subscribe(status => {
  console.log('Status:', status);
});

2. Listen to underlying, transport-specific events:

const serviceRef = app.connectMicroservice({
  transport: Transport.NATS,
  options: {},
});

serviceRef.on<NatsEvents>('disconnect', () => {
  console.log('Client disconnected');
});

Client:

// inject passing the type argument specific to the transport strategy you use
constructor(
  @Inject(MATH_SERVICE) private readonly client: ClientProxy<NatsEvents>,
) {}

// use the "on" method somewhere else
this.client.on('disconnect', () => console.log('Disconnected'));

3. Access the underlying server/client instance:

import { NatsConnection } from 'nats';

// in the bootstrap function
const serviceRef = app.connectMicroservice({
  transport: Transport.NATS,
  options: {},
});

const connection = serviceRef.unwrap<NatsConnection>();
console.log(connection.info);

Same API for the ClientProxy class

Does this PR introduce a breaking change?

• Yes
• No

Other information

[rickdgeerling]

Looks great! 🙌🏻

[rickdgeerling]

I wonder if we could add an tsconfig.json#compilerOptions.paths entry that replaces these optional dependencies with any on-compile 🤔 You'd get type-safety in the IDE, or when running tsc --noEmit

This would require a separate tsconfigs for development and compilation, and fiddling with the build system is probably not worth the small gain in DX.

[kamilmysliwiec]

tsc does not auto-replace paths from tsconfig.json#compilerOptions.paths (it leaves them as is)

[erich2s]

Why don't we just call connect() method here directly?

[yoshigev]

Hi @kamilmysliwiec,

The change here of adding abstract on and unwrap is a breaking change, as now anybody that extended this class must add these methods.

Also, the basic example here is now invalid.

Was this change intentional?

Thanks.

[kamilmysliwiec]

The change here of adding abstract on and unwrap is a breaking change, as now anybody that extended this class must add these methods.

This was released as part of v11 major release - breaking changes are intentional. We'll update the example shortly.