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(microservices): add status, unwrap, on, and other features #14142

Open
wants to merge 5 commits into
base: 11.0.0
Choose a base branch
from

Conversation

kamilmysliwiec
Copy link
Member

@kamilmysliwiec kamilmysliwiec commented Nov 15, 2024

PR Checklist

Please check if your PR fulfills the following requirements:

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);
});
  1. 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'));
  1. 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant