npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@erento/nestjs-module-google-pubsub

v4.0.0

Published

NestJS module to work with Google Pub/Sub messages.

Downloads

143

Readme

NestJS Google Pub/Sub module

Easy way to publish messages to Google Pub/Sub. Supports encrypting the message.

How to use it

  1. Import

    Import this module in the module you want to use it: typescript imports: [ PubSubModule.forRoot( {keyFilename: PUBSUB_CONFIG}, X_PUBSUB_KEY, X_PUBSUB_ENCRYPTION_KEY, SERVICE_IDENTIFIER ) ]

    • PUBSUB_CONFIG is the path to the file with the service account, e.g.: ./config/pubsub.config.json
    • X_PUBSUB_KEY is a secret signature key to encrypt the message. This is necessary for write, but can be used in read operation to verify a signature.
    • X_PUBSUB_ENCRYPTION_KEY is a secret encryption key. This is necessary for write and read.
    • SERVICE_IDENTIFIER is a string represantation of a sender, e.g. "price-service", "user-service", etc.
  2. Usage

    • Publish a messages:

      await this.pubSubService.publishMessage<MyMessage>(
          'projects/project-name/topics/topic-name',
          { // this can be any object, in this case: MyMessage
              text: `some message`,
          },
          {
              myAttribute: 'any other attribute you need to pass',
          },
      );
    • Read a messages:

      private async onSubscriptionMessage (message: EncodedMessage): Promise<void> {
          try {
              await this.pubSubService.verifyMessage(message);
              const decryptedMessage: string = await this.pubSubService.decryptMessage(message);
              const parsedMessage: PubSubMessage<MyMessage> = JSON.parse(decryptedMessage);
      
              // process parsed message parsedMessage looks like: {meta: object, payload: MyMessage}
      
              message.ack();
          } catch (e) {
              message.nack();
          }
      }
    • Pull for messages: In constructor run this.registerPubSubPull();. The implementation can look as follows:

      import {EncodedMessage, PubSubMessage, PubSubService} from '@erento/nestjs-module-google-pubsub';
      
      interface MyMessage {}
      
      class MyClass {
          constructor(private readonly pubSubService: PubSubService) {
              this.registerPubSubPull();
          }
      
          private registerPubSubPull (): void {
              this.pubSubService.listenOnSubscription(
                  'projects/project-name/subscriptions/pull-subscription-name',
                  this.onSubscriptionMessage.bind(this),
                  this.onSubscriptionError.bind(this),
              );
          }
      
          private async onSubscriptionMessage (message: EncodedMessage): Promise<void> {
              // see section above how to read a message
          }
      
          private onSubscriptionError (message: EncodedRequest): void {
              Log.error(`Unexpected error happened with a message: ${JSON.stringify(message)}`);
          }
      }

Stay in touch

License

This module is MIT licensed.