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

Improve check if a provider supports subscriptions #3517

Merged
merged 3 commits into from
May 22, 2020
Merged

Improve check if a provider supports subscriptions #3517

merged 3 commits into from
May 22, 2020

Conversation

ryanio
Copy link
Collaborator

@ryanio ryanio commented May 12, 2020

Description

This PR aims to fix #3432 where @dmihal outlined some problems where if a given provider has the method on it is assumed to be capable of handling subscriptions.

The first commit adds a failing test validating the issue, and the second commit should resolve it.

In general there is no real way of detecting a provider's capabilities and developing some sort of standard would be of great benefit to the ecosystem. One solution suggested by @nivida that has been well received is a provider_capabilities endpoint.

Type of change

  • Bug fix (non-breaking change which fixes an issue)

Checklist:

  • I have selected the correct base branch.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • Any dependent changes have been merged and published in downstream modules.
  • I ran npm run dtslint with success and extended the tests and types if necessary.
  • I ran npm run test:unit with success.
  • I ran npm run test:cov and my test cases cover all the lines and branches of the added code.
  • I ran npm run build-all and tested the resulting files from dist folder in a browser.
  • I have updated the CHANGELOG.md file in the root folder.
  • I have tested my code on the live network.

@ryanio ryanio added 1.x 1.0 related issues Review Needed Maintainer(s) need to review labels May 12, 2020
@coveralls
Copy link

coveralls commented May 12, 2020

Coverage Status

Coverage increased (+0.02%) to 89.619% when pulling 06f922d on issue/3432 into 32c9805 on 1.x.

@cgewecke cgewecke self-requested a review May 13, 2020 16:06
Copy link
Collaborator

@cgewecke cgewecke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks perfect! 💯

@dmihal
Copy link

dmihal commented May 13, 2020

Looks good to me, basically if subscribe() fails, it falls back to polling.

Thanks for the help!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1.x 1.0 related issues Review Needed Maintainer(s) need to review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Checking if a provider supports subscriptions by checking for "on" property often breaks
4 participants