https://github.com/sagi/workers-pubsub

Google Pub/Sub API for Cloudflare Workers (and Node.js)
https://github.com/sagi/workers-pubsub

api cloudflare-workers google-pubsub pubsub

Last synced: about 8 hours ago
JSON representation

Google Pub/Sub API for Cloudflare Workers (and Node.js)

• Host: GitHub
• URL: https://github.com/sagi/workers-pubsub
• Owner: sagi
• License: mit
• Created: 2019-07-09T19:17:27.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-07-05T05:52:52.000Z (6 months ago)
• Last Synced: 2024-12-18T01:09:30.057Z (8 days ago)
• Topics: api, cloudflare-workers, google-pubsub, pubsub
• Language: JavaScript
• Homepage: https://sagi.io
• Size: 424 KB
• Stars: 33
• Watchers: 4
• Forks: 6
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# workers-pubsub

[`@sagi.io/workers-pubsub`](https://www.npmjs.com/package/@sagi.io/workers-pubsub) is a Google Pub/Sub REST API for Cloudflare Workers (can also be used with Node).

⭐ We use it at **[OpenSay](https://opensay.co/?s=workers-pubsub)** to efficiently access Google's PubSub REST API with 1 round trip.

[![CircleCI](https://circleci.com/gh/sagi/workers-pubsub.svg?style=svg&circle-token=88da6b4a2a6ad3055418fb0b9da327d7fff9a99a)](https://circleci.com/gh/sagi/workers-pubsub)

[![Coverage Status](https://coveralls.io/repos/github/sagi/workers-pubsub/badge.svg)](https://coveralls.io/github/sagi/workers-pubsub)

[![MIT License](https://img.shields.io/npm/l/@sagi.io/workers-pubsub.svg?style=flat-square)](http://opensource.org/licenses/MIT)

[![version](https://img.shields.io/npm/v/@sagi.io/workers-pubsub.svg?style=flat-square)](http://npm.im/@sagi.io/workers-pubsub)

## Installation

~~~

$ npm i @sagi.io/workers-pubsub

~~~

## API

We follow [Google's Pub/Sub REST API](https://cloud.google.com/pubsub/docs/reference/rest/) specification. We'll add more methods if there's demand.

See below for concrete examples for Cloudflare Workers and Node.js.

### **`PubSubREST({ ... })`**

Instantiates `PubSub` instance.

Function definition:

```js

 const PubSubREST = async ({

  serviceAccountJSON,

  cryptoImpl = null,

  fetchImpl = null,

}) => { ... }

```

Where:

  - **`serviceAccountJSON`** *required* Is a Google Cloud service account with a **Pub/Sub Admin** role. An object.

  - **`cryptoImpl`** *optional* Not needed when running on Cloudflare Workers. See concrete example below for how to use it with Node.js.

  - **`fetchImpl`** *optional* Not needed when running on Cloudflare Workers. See concrete example below for how to use it with Node.js.

### **`PubSub.topics.publish({ ... })`**

Publishes a message to a topic.

Function definition:

```js

const publish = ({ topic, messages } = {}) => { ... }

```

Where:

  - **`topic`** *required* The topic to send messages to.

  - **`messages`** *required* an array of [Pub/Sub messages](https://cloud.google.com/pubsub/docs/reference/rest/v1/PubsubMessage). You can use the `PubSub.helpers.createPubSubMessage` method to easily create a Pub/Sub message.

### **`PubSub.topics.list({ ... })`**

Lists all topics.

### **`PubSub.helpers.createPubSubMessage({ ... })`**

Helps create a PubSub message easily.

Function definition:

```js

const createPubSubMessage = ({ message = '', attributes = undefined } = {}) => { ... }

```

Where:

  - **`message`** *optional* A message string. e.g. `Hello World`.

  - **`attributes`** *optional* An object with string values. e.g. `{ type: 'slack-poll' }`.

  - **`ordering_key`** *optional* An ordering key to allow subscribers to receive messages in order in the same region. [Read more here](https://cloud.google.com/pubsub/docs/publisher#using_ordering_keys).

Returns a [Pub/Sub message](https://cloud.google.com/pubsub/docs/reference/rest/v1/PubsubMessage).

## Cloudflare Workers Example

~~~js

import base64url from 'base64url'

import PubSubREST from '@sagi.io/workers-pubsub'

const serviceAccountJSON = ...

const PubSub = await PubSubREST({ serviceAccountJSON })

const topic = 'gcf-task'

const psMessage = PubSub.helpers.createPubSubMessage({ message: 'Hello World!' })

const messages = [ psMessage ]

await PubSub.topics.publish({ topic, messages })

~~~

## Node.js Example

~~~js

import fetchImpl from 'cross-fetch'

import { Crypto }from 'node-webcrypto-ossl'

import PubSubREST from '@sagi.io/workers-pubsub'

const cryptoImpl = new Crypto()

const serviceAccountJSON = ...

const PubSub = await PubSubREST({ serviceAccountJSON, cryptoImpl. fetchImpl })

const topic = 'gcf-task'

const psMessage = PubSub.helpers.createPubSubMessage({ message: 'Hello World!' })

const messages = [ psMessage ]

await PubSub.topics.publish({ topic, messages })

~~~