1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
unleash.unleash/frontend
Nuno Góis 383e522127
feat: Slack App addon (#4238)
https://linear.app/unleash/issue/2-1232/implement-first-iteration-of-the-new-slack-app-addon

This PR implements the first iteration of the new Slack App addon.
Unlike the old Slack addon, this one uses a Slack App (bot) that is
installed to Slack workspaces in order to post messages. This uses
`@slack/web-api`, which internally uses the latest Slack API endpoints
like `postMessage`.

This is currently behind a flag: `slackAppAddon`.

The current flow is that the Unleash Slack App is installed from
whatever source:
 - Unleash addons page;
 - Direct link;
 - https://unleash-slack-app.vercel.app/ (temporary URL);
 - Slack App Directory (in the future);
 - Etc;

After installed, we resolve the authorization to an `access_token` that
the user can paste into the Unleash Slack App addon configuration form.


https://github.com/Unleash/unleash/assets/14320932/6a6621b9-5b8a-4921-a279-30668be6d46c

Co-authored by: @daveleek

---------

Co-authored-by: David Leek <david@getunleash.io>
2023-07-14 09:49:34 +01:00
..
cypress chore: remove strategyImprovements flag (#4043) 2023-06-28 11:38:21 +03:00
public refactor: adapt to Vite (#940) 2022-05-05 16:15:22 +01:00
scripts feat: Generate new OAS types, tags component upgrade (#3269) 2023-03-15 11:35:24 +02:00
src feat: Slack App addon (#4238) 2023-07-14 09:49:34 +01:00
.editorconfig
.gitignore Test npm publish (#3554) 2023-04-18 15:44:19 +02:00
.nvmrc chore: update to node 18 (#3527) 2023-04-18 10:35:32 +02:00
.prettierignore Orval generator POC (#2724) 2023-01-05 11:57:53 +01:00
.prettierrc refactor: format files (#719) 2022-02-18 09:51:10 +01:00
cypress.config.ts test: add interactive demo guide e2e test (#3656) 2023-05-08 09:16:18 +01:00
cypress.d.ts chore: refactor Cypress tests (#3445) 2023-04-04 11:46:28 +03:00
index.html ui flags replaced in index.html (#2617) 2022-12-07 14:31:27 +02:00
index.js
orval.config.js don't add version header to generated api schema 2023-03-15 13:29:18 +01:00
package.json chore(deps): update dependency cypress to v12.16.0 (#4185) 2023-07-07 18:20:59 +00:00
README.md chore: simplify package scripts (#3736) 2023-05-12 11:23:22 +01:00
tsconfig.json chore: refactor Cypress tests (#3445) 2023-04-04 11:46:28 +03:00
tsconfig.node.json Orval generator POC (#2724) 2023-01-05 11:57:53 +01:00
vercel.json fix: update vercel proxy paths (#2623) 2022-12-07 13:00:51 +01:00
vite.config.ts fix: preload error (#2980) 2023-01-24 20:40:03 +01:00
yarn.lock chore(deps): update dependency cypress to v12.16.0 (#4185) 2023-07-07 18:20:59 +00:00

frontend

This directory contains the Unleash Admin UI frontend app.

Run with a local instance of the unleash-api

Refer to the Contributing to Unleash guide for instructions. The frontend dev server runs (in port 3000) simultaneously with the backend dev server (in port 4242):

yarn install
yarn dev

Run with a sandbox instance of the Unleash API

Alternatively, instead of running unleash-api on localhost, you can use a remote instance:

cd ./frontend
yarn install
yarn run start:sandbox

Running end-to-end tests

We have a set of Cypress tests that run on the build before a PR can be merged so it's important that you check these yourself before submitting a PR. On the server the tests will run against the deployed Heroku app so this is what you probably want to test against:

yarn run start:sandbox

In a different shell, you can run the tests themselves:

yarn run e2e:heroku

If you need to test against patches against a local server instance, you'll need to run that, and then run the end to end tests using:

yarn run e2e

You may also need to test that a feature works against the enterprise version of unleash. Assuming the Heroku instance is still running, this can be done by:

yarn run start:enterprise
yarn run e2e

Generating the OpenAPI client

The frontend uses an OpenAPI client generated from the backend's OpenAPI spec. Whenever there are changes to the backend API, the client should be regenerated:

./scripts/generate-openapi.sh

This script assumes that you have a running instance of the enterprise backend at http://localhost:4242. The new OpenAPI client will be generated from the runtime schema of this instance. The target URL can be changed by setting the UNLEASH_OPENAPI_URL env var.

Analyzing bundle size

npx vite-bundle-visualizer in the root of the frontend directory