merge-it-hot

Slack Bot that keeps code review participants in the loop by sending pull requests notifications to the Slack.

Configuring dev environment

• Install Node.js and npm on your machine
• Run npm i from the repo root directory

Running unit tests

• Easy as npm run test. Unit tests are not tied to Slack or GitHub, thus, you can run them in isolation.
• Since I'm a lazy guy, tests use snapshots. You can update them by running npm run test:update-snapshots

Running an app

• Create your own Slack application and obtain required tokens to the project env variables

💡 You can use slack_app_manifest.yml file as a basis to create an app and assign all the required oauth scopes.

• Run npm run docker:init to configure Postgres
• Open merge-it-hot-compose.yml environment section and provide relevant tokens
• Run npm run docker:start to start an app in docker container

💡 If you'd like to run app locally, create the .env file in the project root directory and provide it with the values identical to merge-it-hot-compose.yml environment section After that you can simply run an app with npm run start

Running e2e-tests with an app

• e2e tests will require real Slack and GitHub connections. Please refer to Running an app section above.
• e2e-tests are implemented with HTTP Client CLI. Thus, it should be installed.
• Fill http-client.env.json file with parameters you find relevant. If you want to use real data, consider creating your own http-client.private.env.json config. It is already added to the .gitignore
• Run npm run docker:start or npm run start to start the service
• Run ijhttp .e2e-tests/e2e-test-requests.http from the project root directory.

Deploying the service

• You can use provided Dockerfile to build an image and run it with ENV variables identical to variables specified in .env.example described above
• Please, be aware that service is stateful since it caches channels and comments info. State stored in memory ( see InMemoryCache class and its' usages), that keeps implementation simple and efficiently serves hundreds of pull requests. In case of service restart, cache will be gracefully restored. However, if you need to run multiple instances or experience Slack API requests limit exceeding, you'll need to implement some external cache.

Managing database structure

• This project uses TypeORM for database migrations. After modifying the schema, you can apply migrations using npm run migration:generate ./src/api-adapters/organization-settings-provider/migrations/<MIGRATION NAME>
• Migrations are automatically applied when the app starts, so no manual intervention is typically needed.
• You can manage migrations process on your own with npm run migration:run and npm run migration:revert commands.

Useful links

• Slack apps configuration page
• Slack blocks kit builder and full controls reference