Giter Club home page Giter Club logo

js-datastore-pubsub's Introduction

datastore-pubsub

ipfs.tech Discuss codecov CI

Responsible for providing an interface-datastore compliant api to pubsub

Table of contents

Install

$ npm i datastore-pubsub

Browser <script> tag

Loading this module through a script tag will make it's exports available as DatastorePubsub in the global namespace.

<script src="https://unpkg.com/datastore-pubsub/dist/index.min.js"></script>

Usage

import { PubSubDatastore } from 'datastore-pubsub'

const dsPubsub = new PubSubDatastore(pubsub, datastore, peerId, validator)

API

Setup

new PubSubDatastore(pubsub, datastore, peerId, validator, subscriptionKeyFn)

Creates a DatastorePubsub instance.

Arguments:

  • pubsub (Object): implementation of a pubsub (must have publish and subscribe functions), such as libp2p/pubsub.
  • datastore (Object): datastore compliant with interface-datastore, such as datastore-fs.
  • peerId (PeerId Instance): peer identifier object.
  • validator (Object): containing validate function and select function.
  • subscriptionKeyFn (function): function to manipulate the key topic received according to the needs, as well as to block the message received to be published.

Note: validator object must be composed by two functions, validate (record: uint8Array, peerId: PeerId) => boolean and select (received: uint8Array, current: uint8Array) => boolean. validate aims to verify if a new record received by pubsub is valid to be stored locally by the node. If it is valid and the node already has a local record stored, select is the function provided to be responsible for deciding which record is the best (newer) between the already stored and the received through pubsub. A validator example can be found at: TODO (js-ipns)

const dsPubsub = new DatastorePubsub(pubsub, datastore, peerId, validator)

Get

const buf = await dsPubsub.get(key)

Try to subscribe a topic with Pubsub and receive the current local value if available.

Arguments:

  • key (Uint8Array): a key representing a unique identifier of the object to subscribe.

Returns Promise<Uint8Array> containing the most recent known record stored.

Put

await dsPubsub.put(key, val)

Publishes a value through pubsub.

Arguments:

  • key (Uint8Array): a key representing a unique identifier of the object to publish.
  • val (Uint8Array): value to be propagated.

Returns Promise<void>

Unsubscribe

await dsPubsub.unsubscribe(key)

Unsubscribe a previously subscribe value.

Arguments:

  • key (Uint8Array): a key representing a unique identifier of the object to publish.

Returns Promise<void>

API Docs

License

Licensed under either of

Contribute

Contributions welcome! Please check out the issues.

Also see our contributing document for more information on how we work, and about contributing in general.

Please be aware that all interactions related to this repo are subject to the IPFS Code of Conduct.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

js-datastore-pubsub's People

Contributors

achingbrain avatar dependabot-preview[bot] avatar dependabot[bot] avatar hsanjuan avatar hugomrdias avatar ipfs-mgmt-read-write[bot] avatar semantic-release-bot avatar stensonb avatar vasco-santos avatar victorb avatar web-flow avatar web3-bot avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

js-datastore-pubsub's Issues

Please re-publish 0.2.2 as 0.3.0

#19 changed how pubsub subscriptions are listed from:

const subscriptions = await this._pubsub.ls()

to

const subscriptions = await this._pubsub.getTopics()

This in effect forces the user to upgrade to a newer version of whatever libp2p-pubsub subclass they are using but also arrives as a stealth upgrade if your package.json contains ^0.2.1 as the version for this module.

This is not a backwards compatible change so should not be a patch release.

Please revert #19, republish v0.2.1 as v0.2.3, then reapply #19 and publish it as 0.3.0.

Memory leak?

If I call get for the same key, it'll call pubsub.subscribe and add another handler for the same key.

this._pubsub.subscribe(stringifiedTopic, this._handleSubscription, (err) => {

I think we only want one handler per key right?

All TieredDatastore functions should be implemented

The main purpose of this module is to be used with TieredDatastore. Accordingly, all the methods that may used by this Datastore should be implemented, in order to guarantee that no unexpected problems may occur.

With all this methods implemented, this datastore should also run interface-datastore tests against this, like here.

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you can benefit from your bug fixes and new features again.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can fix this πŸ’ͺ.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here are some links that can help you:

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.


Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two Factor Authentication for your account, set its level to "Authorization only" in your account settings. semantic-release cannot publish with the default "
Authorization and writes" level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.


Good luck with your project ✨

Your semantic-release bot πŸ“¦πŸš€

Datastore interface vs DHT API

Currently this module is called datastore-pubsub and in theory it should follow the ipfs/interface-datastore and also be compatible with the DHT API, to be used on a TieredDatastore.

This issue aims to track the discussion if we should rename the module and what it should be compatible with.

Context: #60

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.