connorads / lockbot Goto Github PK

View Code? Open in Web Editor NEW

57.0 4.0 5.0 1.26 MB

🔒 Coordinate use of your team's shared resources, in Slack 🤝

Home Page: https://lockbot.app

License: MIT License

JavaScript 1.69% TypeScript 96.67% HTML 1.64%

slack slack-bot serverless-framework dynamodb typescript nodejs aws-lambda serverless aws mutex

lockbot's Introduction

Lockbot

Demo: lockbot.app

Coordinate use of your team's shared resources, in Slack 🤝

Lockbot only lets each shared resource be locked by one person at a time - like a Mutex 🔒

Example use case: One person wants to deploy and test on a shared staging environment without someone else deploying and overwriting their deployed code, so they use /lock staging-env to lock the staging environment and notify the channel.

⚠ Lockbot cannot physically prevent naughty or unaware users from using a resource whilst it's locked by someone else. Your team must agree to use Lockbot whenever they start or stop using a shared resource.

How to use Lockbot

Lockbot has three main commands:

/locks Get locked resources list 📜
/lock [resource-name] Lock a resource 🔒
/unlock [resource-name] [options] Unlock a resource 🔓
- Set [options] to force if you need to unlock when someone is away on holiday ⛱

Each Slack channel has its own list of resources.

When someone successfully locks or unlocks a resource, the channel is notified.

Lockbot API

It is possible to view, create and delete locks via the Lockbot HTTP API.

To explore the API take a look at the OpenAPI spec.

The API is secured using basic access authentication.

/lbtoken Learn about Lockbot API access tokens 💡
/lbtoken new Generate a new Lockbot API access token 🎫

Each access token is scoped to the Slack team and channel they were created in and to the user who created them.

Contributing

Don't be a stranger, contributions are welcome ✨

See the Contributing Guide for development setup instructions.

Give this repo a Star ⭐️
Ask questions and share your feedback in issues
Create a PR or issue for bugs, enhancements, ideas and suggestions
Join the Lockbot Community Slack workspace
Contact @connorads

Security

If you discover a security vulnerability, please send an e-mail to [email protected]

lockbot's People

Contributors

Stargazers

Watchers

Forkers

floydspace alpeshvas andriizahorodniuk novatan-rb youssef50g6

lockbot's Issues

Feature: Get notified when a resource you're subscribed to is unlocked

To save users asking the lock owner to notify them or having to keep looking in the channel

Need means of subscribing
Will Lockbot need additional scopes to message a user outside of a slash command?

Error when bot is not in channel and tries to use `say`

bolt-app Error: An API error occurred: not_in_channel
    at Object.platformErrorFromResult (/var/task/node_modules/@slack/web-api/dist/errors.js:50:33)
    at WebClient.apiCall (/var/task/node_modules/@slack/web-api/dist/WebClient.js:486:28)
    at processTicksAndRejections (internal/process/task_queues.js:97:5)
    at async respond (/var/task/src/index.js:24:17)
    at async /var/task/src/index.js:53:5
    at async Array.<anonymous> (/var/task/node_modules/@slack/bolt/dist/middleware/builtin.js:203:9)
    at async Array.exports.onlyCommands (/var/task/node_modules/@slack/bolt/dist/middleware/builtin.js:39:5) {
  code: 'slack_webapi_platform_error',
  data: {
    ok: false,
    error: 'not_in_channel',
    response_metadata: { scopes: [Array], acceptedScopes: [Array] }
  }
}

Make error message more user friendly

"Oops something went wrong, please try again"

Repo: Add social sharing preview

https://github.com/connorads/lockbot/settings

Send message in channel when locking via API

When I lock via the API, I would like to see a message posted in the channel to indicate I've locked a resource. At the moment this just happens with no visibility to other users.

Sort out environment separation

Functions are split out by serverless stage but the DynamoDB table name is not.

https://serverless-stack.com/chapters/stages-in-serverless-framework.html
https://serverless-stack.com/chapters/configure-dynamodb-in-serverless.html

Feature: Get automatic reminders of the resources you are currently locking

I found myself setting Slack reminders about unlocking a resource, as it is easy to forget to do that.

It might be useful to have an automated reminder mechanism nudge you every T minutes that you're keeping some resources busy and which ones exactly.

Mention channel in lock help message

An extension of what's been done for /locks in #30

Add logging

Respond to private messages and provide help

For example ...

Public API with usage stats

Would be interesting to expose this data and perhaps measure it over time

No of teams/installs
Locks/unlocks per day

Mention the actual channel in /locks message instead of "this channel"

Add support for multiple workspaces

https://slack.dev/bolt-js/concepts#authorization

Make sure users are mentioned with @

Cannot unlock test, locked by @ABC 🔒

Make locked resources segregated by channel

So that each channel has its own locks

Feature: show the time a resource was locked in the slack message

When I run the /locks command in Slack I would love to see what time each resource was locked.

The reason I want this is I want an easier way to tell whether a lock is stale (and someone's forgotten to clean it up) or if it's been recently locked. Other features requested include notifications and I'd prefer that setup too! But this seemed like an easier improvement so thought I'd suggest it here too 😉

Upgrade Slack Bolt from 2 to 3

https://slack.dev/bolt-js/tutorial/migration-v3

Get DynamoDB config in tests from serverless.yml instead of duplicating

Idea: Access locks outside a channel

It might be nice to expand the command to work across channels e.g. /lock cazops dev or /locks cazops. Perhaps /mylocks or something to show everything I've locked.

Add tracing?

Make it optional via config?
https://docs.honeycomb.io/getting-data-in/javascript/beeline-nodejs/

Improve README.md

Usage

GIF to demonstrate usage
Explain channel segregation
What's it all for/about? Use cases? Why?
Link to website for demo
Test the app in a channel with yourself

Dev stuff

Tests run twice: 1) using in-memory (fast dev feedback 1ms) and 2) using local dynamodb (still fast feedback 40ms)
Explain core of bot logic is encapsulated in lock-bot.ts without reference to slack so could be ported to other chat platforms
Bot logic works against repository abstraction, easy to port to different database/storage
Can use other cloud cloud platform's serverless function offering, just need to adapt index.ts and serverless.yaml etc.
Forks and/or contributions are welcome

Deployment

Tokens and environment variables
state secret 256-bit key (HS256 JWT)
Info about slack bot account

Misc

Add to Slack button
Licence badge

Add /command help

https://api.slack.com/tutorials/slash-commands-style-guide

Mention in Readme companies/users for social proof

If you'd like to join the list, please comment below 🙃

Improve installationStore

https://github.com/connorads/lockbot/blob/master/src/handlers/slack/infra.ts#L24

Refactor into DynamoDB class?
Store created/updated timestamp?

Ack requests earlier

Slack docs suggests acking as soon as possible because you only have 3 seconds to respond

https://slack.dev/bolt-js/concepts#acknowledge

So after you validate input but before you start hitting databases etc.

Not currently getting any performance issues despite hitting the DB before acking in most cases.

But would need to refactor so that validation could be accessed early.

Is it worth it?

Add TTL to DynamoDB so that stale locks expire (albeit silently, for data cleanup purposes)

Locks last forever and will never be cleaned up. Even random locks in users DMs or random dead channels. Might be good to get rid of these?

Two weeks?
https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html

Add Lockbot branding/logo/avatar

Must have

Square icon/logo for bot avatar (and other icons)

Nice to have

Colour scheme
Logo with text for README.md and elsewhere

Some ideas ...

Bug: /lock [resource name] can contain spaces

/lock some thing

Supporting spaces in resource names will make it difficult to add more features by passing more params
i.e. /lock [resource name] [message] [duration]

Create lockbot Slack workspace

Add Lockbot to it
Add Slack workspace badge to readme

Logo from #28

Cannot unlock a resource that is an @mention

Unlikely a common use case but even so there's no way to get rid of the lock unless you delete it from the DB ...

/lock @connorads
/unlock @connorads

Suggestion: Add a way to update lockbot via an API

It would be really great if Lockbot had some kind of REST Api, this would allow developers to use their CI/CD tools to trigger locks, and the locks could fail if someone else is using that lock.

Reorganise code and files

Error when unknown option is passed to /unlock

i.e. /unlock thingy please should say please is not a command
And maybe accept/suggest when people use nearby things like /unlock thingy --force instead of /unlock thingy force as this is currently silently ignoring the --force

Add force unlock command

What happens if your team mate goes on holiday but forgets to unlock something?
Force unlock to the rescue.

Should notify channel and probably at/mention both the force unlocker and the lock owner

Replace aws-serverless-express

https://www.npmjs.com/package/aws-serverless-express

https://github.com/vendia/serverless-express

Make locks expire after or at a user specified time

Could use DynamoDB TTL but it has limited time guarantees and wouldn't notify users.

Add scripts to package.json

test
deploy
db:install
db:start

Perhaps also update GitHub action to use these scripts too?

package.json: Fix yarn lint script so eslint runs on all .ts files without listing specific directories

Would be nice if:

We didn't have to remember to update this if we add/move/rename folders
It works on both linux bash and windows pwsh

  "scripts": {
    "lint": "yarn tsc --noEmit && eslint . src/*.ts src/handlers/*.ts src/storage/*.ts test/*.ts",
  }

Support adding bot to workspace and not just oauth with multiple installations

Like how this bot used to work when it was first created
4af3c9e

Could be a fair bit of work to get both ways of operating to play nicely in an ideal manner:

Don't want to create installation table in DynamoDB if there aren't going to be installations
Lots of contributing docs to update

feature request - ability to request lock from person who has locked something

say person A has locked dev
I want to be able to ping person A, requesting to take dev and lock it

Use proper URL in prod

e.g. api.lockbot.app

https://www.serverless.com/blog/serverless-api-gateway-domain
https://www.serverless.com/blog/api-gateway-multiple-services

How to make it configurable so that other people can easily deploy without

Add support for enterprise/org-wide installations

Support was added in bolt v3 #106 but wasn't enabled or implemented

Do we want to support this? 🤷‍♂️
Could be straightforward to implement, not sure how to test ...

https://api.slack.com/enterprise/apps
https://api.slack.com/enterprise/apps/migration
https://slack.dev/bolt-js/tutorial/migration-v3

Setup AWS account(s)
Increase prod vs dev DynamoDB capacity
Create dev Slack App/environment

Make it so environment deployments are not shown as waiting

Not a big deal but it looks naff

Options:

Never run on master?
Only run prod on master and not on PR
Something else?

https://github.com/connorads/lockbot/deployments/activity_log

Move repo from connorads to org

https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/transferring-a-repository

Orgs are free https://github.com/pricing

Might need to update some build stuff?