ably-labs / vscode-ably Goto Github PK

View Code? Open in Web Editor NEW

5.0 6.0 0.0 6.65 MB

VSCode extension that allows management of Ably apps

Home Page: https://marketplace.visualstudio.com/items?itemName=ably-labs.vscode-ably

License: Apache License 2.0

TypeScript 94.92% JavaScript 5.08%

vscode-extension realtime ably

vscode-ably's Introduction

Ably for Visual Studio Code

Use the Ably for VS Code extension to manage your Ably apps directly in VS Code.

The extension enables you to:

List all apps in your Ably account.
- View API keys, queues and integration rules for each app.
- Copy API keys to your clipboard.
Create an Ably app.

Prerequisites

The only prerequisite is an Ably account which is free to sign-up.

Installation

After installing this extension, you need to provide your Ably account ID and Control API access token in VS Code Settings to get started.

Admin access to the Ably account is required to create a Control API access token.
The Control API access token requires the following permissions:
- read:app
- write:app
- read:key
- read:rule
- read:queue

In case the extension does not work after providing the AccountID and Control API access token, please restart VSCode.

Features

View Ably apps & details

Click on the Ably icon in the Activity Bar to view the apps in your Ably account. Apps will be listed in alphabetical order.

Expand an app to view the API keys, queues, rules and namespaces associated with it.

Use the copy to clipboard icon to copy an API key to the clipboard.

Create an Ably app

Open the command palette (CMD+SHIFT+P) and choose Ably: Create App.
Enter a name for the app when prompted.
Select whether to enforce TLS for connections or not.
A new app will be created and appears in the list once the view has been automatically refreshed.

Issues & Features

If you find an issue 🪲 or have a feature request 🚀 please file them here.

Note that this extension is still in preview.

Contributing

Want to help contributing to this project? Have a look at our contributing guide!

More info

vscode-ably's People

Contributors

Stargazers

Watchers

vscode-ably's Issues

Summary

Status	Count
🔍 Total	49
✅ Successful	28
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	20
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in README.md

https://twitter.com/ablyrealtime: Failed: Network error

Full Github Actions output

Summary

Status	Count
🔍 Total	49
✅ Successful	28
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	20
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in README.md

https://twitter.com/ablyrealtime: Failed: Network error

Full Github Actions output

Summary

Status	Count
🔍 Total	47
✅ Successful	26
⏳ Timeouts	1
🔀 Redirected	0
👻 Excluded	20
❓ Unknown	0
🚫 Errors	0

Errors per input

Errors in README.md

[TIMEOUT] https://twitter.com/ablyrealtime | Timeout

Full Github Actions output

Summary

Status	Count
🔍 Total	49
✅ Successful	28
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	20
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in README.md

https://twitter.com/ablyrealtime: Failed: Network error

Full Github Actions output

Summary

Status	Count
🔍 Total	49
✅ Successful	28
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	20
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in README.md

https://twitter.com/ablyrealtime: Failed: Network error

Full Github Actions output

Add labels to Ably App explorer view

At the moment the Ably app explorer view shows values in the tree view explorer but besides from the icon there is no indication what the values mean. Having labels for some items (e.g. key capabilities) would result in a clearer user experience.

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	29
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	19
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in CONTRIBUTING.md

https://lab.github.com/githubtraining/managing-merge-conflicts: Failed: Network error

Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	29
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	19
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in CONTRIBUTING.md

https://lab.github.com/githubtraining/managing-merge-conflicts: Failed: Network error

Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	29
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	19
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in CONTRIBUTING.md

https://lab.github.com/githubtraining/managing-merge-conflicts: Failed: Network error

Full Github Actions output

Feature: Show only active and disabled apps

📝 Feature description

At the moment the Able App Explorer lists all apps, including the deleted ones. To avoid confusion and cluttering only the active and disabled apps should be shown.

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	28
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	20
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in README.md

https://twitter.com/ablyrealtime: Failed: Network error

Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	29
⏳ Timeouts	1
🔀 Redirected	0
👻 Excluded	19
❓ Unknown	0
🚫 Errors	0

Errors per input

Errors in CONTRIBUTING.md

https://lab.github.com/githubtraining/managing-merge-conflicts: Timeout

Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	28
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	20
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in README.md

https://twitter.com/ablyrealtime: Failed: Network error

Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	29
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	19
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in CONTRIBUTING.md

https://lab.github.com/githubtraining/managing-merge-conflicts: Failed: Network error

Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	29
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	19
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in CONTRIBUTING.md

https://lab.github.com/githubtraining/managing-merge-conflicts: Failed: Network error

Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	28
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	20
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in README.md

https://twitter.com/ablyrealtime: Failed: Network error

Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	29
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	19
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in CONTRIBUTING.md

https://lab.github.com/githubtraining/managing-merge-conflicts: Failed: Network error

Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	47
✅ Successful	26
⏳ Timeouts	1
🔀 Redirected	0
👻 Excluded	20
❓ Unknown	0
🚫 Errors	0

Errors per input

Errors in README.md

[TIMEOUT] https://twitter.com/ablyrealtime | Timeout

Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	28
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	20
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in README.md

https://twitter.com/ablyrealtime: Failed: Network error

Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	28
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	20
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in README.md

https://twitter.com/ablyrealtime: Failed: Network error

Full Github Actions output

Feature: Add telemetry to understand if & how the extension is used

This ties in well with #8 and check which languages / frameworks are used, where developers would drop off/have issues with.

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	28
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	20
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in README.md

https://twitter.com/ablyrealtime: Failed: Network error

Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	29
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	19
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in CONTRIBUTING.md

https://lab.github.com/githubtraining/managing-merge-conflicts: Failed: Network error

Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	28
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	20
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in README.md

https://twitter.com/ablyrealtime: Failed: Network error

Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	28
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	20
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in README.md

https://twitter.com/ablyrealtime: Failed: Network error

Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	28
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	20
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in README.md

https://twitter.com/ablyrealtime: Failed: Network error

Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	29
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	19
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in CONTRIBUTING.md

https://lab.github.com/githubtraining/managing-merge-conflicts: Failed: Network error

Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	28
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	20
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in README.md

https://twitter.com/ablyrealtime: Failed: Network error

Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	29
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	19
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in CONTRIBUTING.md

https://lab.github.com/githubtraining/managing-merge-conflicts: Failed: Network error

Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	29
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	19
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in CONTRIBUTING.md

https://lab.github.com/githubtraining/managing-merge-conflicts: Failed: Network error

Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	28
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	20
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in README.md

https://twitter.com/ablyrealtime: Failed: Network error

Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	28
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	20
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in README.md

https://twitter.com/ablyrealtime: Failed: Network error

Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	47
✅ Successful	26
⏳ Timeouts	1
🔀 Redirected	0
👻 Excluded	20
❓ Unknown	0
🚫 Errors	0

Errors per input

Errors in README.md

[TIMEOUT] https://twitter.com/ablyrealtime | Timeout
Full Github Actions output

Feature: Inspect channel events

It would be great if the extension would allow inspecting the messages sent to a channel (like is done in the Dev Console in the web portal). The user would need to select an Ably app and select the channel to inspect (or manually enter).

https://ably.com/documentation/rest-api#enumeration-rest

Link Checker Report

Summary

Status	Count
🔍 Total	47
✅ Successful	26
⏳ Timeouts	1
🔀 Redirected	0
👻 Excluded	20
❓ Unknown	0
🚫 Errors	0

Errors per input

Errors in README.md

[TIMEOUT] https://twitter.com/ablyrealtime | Timeout
Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	25
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	19
❓ Unknown	0
🚫 Errors	5

Errors per input

Errors in README.md

https://ably.com/documentation/control-api#ids: Failed: Network error
https://ably.com/: Failed: Network error
https://ably.com/sign-up: Failed: Network error
https://static.ably.dev/badge-black.png?ably-vscode: Failed: Network error
https://ably.com/documentation/control-api#authentication: Failed: Network error

Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	28
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	20
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in README.md

https://twitter.com/ablyrealtime: Failed: Network error

Full Github Actions output

Feature: Scaffold new projects that use Ably

The extension could also help in getting started with Ably. The developer could use the Command Palette to scaffold a new project, choosing their preferred language / framework and even some hosting options (Azure Static Web Apps, Netlify).

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	28
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	20
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in README.md

https://twitter.com/ablyrealtime: Failed: Network error

Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	29
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	19
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in CONTRIBUTING.md

https://lab.github.com/githubtraining/managing-merge-conflicts: Failed: Network error

Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	29
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	19
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in CONTRIBUTING.md

https://lab.github.com/githubtraining/managing-merge-conflicts: Failed: Network error

Full Github Actions output

Issue: Extension is not activated when Create App is used before the treeview is opened

📝 Current behavior

Error pops up when Create App is performed from the command prompt:

[Window Title]
Visual Studio Code

[Content]
Command 'Ably: Create App' resulted in an error (command 'ably.createApp' not found)

[OK]

📝 Expected behavior

Ably Create App command would start.

⚙️ Context

OS Windows 11
VSCode version: 1.66.1
Ably extension version: 0.0.1

⚙️ Steps to reproduce

Open VSCode
Do not click on the Ably icon
CTRL+SHIFT+P => Ably: Create App
Error

Add functionality to refresh the App Explorer manually

Currently, the App Explorer only loads the apps once. If apps are being added/changed outside VSCode the explorer does not reflect that. A button to refresh the explorer manually would be beneficial before a more advanced automated sync is considered.

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	28
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	20
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in README.md

https://twitter.com/ablyrealtime: Failed: Network error

Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	28
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	20
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in README.md

https://twitter.com/ablyrealtime: Failed: Network error

Full Github Actions output

Issue: Queue Stats do not show the correct child elements

📝 Current behavior

When Stats for a specific queue are expanded it lists the name of another app and some empty items and not the statistics.

📝 Expected behavior

The child items under Stats should contain:

publishRate
deliveryRate
acknowledgementRate

⚙️ Context

Version: 1.67.1 (user setup)
Commit: da15b6fd3ef856477bf6f4fb29ba1b7af717770d
Date: 2022-05-06T12:37:03.389Z
Electron: 17.4.1
Chromium: 98.0.4758.141
Node.js: 16.13.0
V8: 9.8.177.13-electron.0
OS: Windows_NT x64 10.0.22000

Ably extension version: 0.0.4

⚙️ Steps to reproduce

Expand an Ably App (that has queues)
Expand Queues
Expand a specific queue
Expand Stats

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	29
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	19
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in CONTRIBUTING.md

https://lab.github.com/githubtraining/managing-merge-conflicts: Failed: Network error

Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	29
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	19
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in CONTRIBUTING.md

https://lab.github.com/githubtraining/managing-merge-conflicts: Failed: Network error

Full Github Actions output

Link Checker Report

Summary

Status	Count
🔍 Total	49
✅ Successful	28
⏳ Timeouts	0
🔀 Redirected	0
👻 Excluded	20
❓ Unknown	0
🚫 Errors	1

Errors per input

Errors in README.md

https://twitter.com/ablyrealtime: Failed: Network error

Full Github Actions output

Feature: Allow signup to Ably via plugin

It'd be great if we could have the ability to signup via the plugin, to help remove barriers to entry. I would imagine this working by opening a link to signup on the Ably site (/signup), with the addition of metadata which would mean that:

A control API key is created automatically as part of signup
The account ID and control key is returned to VSCode and populated in the settings for the app

This would require the addition of some logic to the website, allowing for the creation + response of a control API key as part of the signup flow.