@toptal/staff-portal NPM

Staff Portal (formerly known as Frontend Revolution project)

Rendering layer for the new Staff Portal application. Make sure you have read the coding guidelines.

Check the #staff-portal slack channel.

This project was bootstrapped with Davinci CLI.

Prerequisites

Setup

Staff Portal uses some packages hosted on Toptal's private NPM. In order to get them you need to have NPM_TOKEN present in your local environment.

Go to LastPass and search for NPM_TOKEN.
Save the token as an environment variable named NPM_TOKEN.

Run $ yarn install to install all dependencies

How to run locally against staging platform

Local machine (Staff Portal) → Platform Staging (API)

$ yarn start to run in dev-mode locally.
Open https://local-development.staging.toptal.net to view it in the browser.
If you are not logged-in you will be redirected to https://staging.toptal.net/users/login?return_url=https://local-development.staging.toptal.net/ where you can sign-in using staging credentials and be redirected back to Staff Portal.
A detailed explanation about authentication can be found here
The page will auto reload if you make edits.
You will also see any lint errors in the console.

For Ubuntu:

As non-root users cannot bind to ports lower than 1024 you can either sudo yarn start or run line below and then use yarn start from now on.

sudo setcap 'cap_net_bind_service=+ep' `which node`

Detailed explanation about this solution is described here.

How to run against custom platform temploy url

Local machine (Staff Portal) → Custom Platform Temploy (API)

You can target a custom platform API URL in the following way:

edit the DAVINCI_PLATFORM_API_URL field on .env.temploy file and just run the yarn start:temploy command.
change the DAVINCI_API_GATEWAY_URL field to fetch GraphQL schemas from a different URL.

How to run against local platform API url

Local Setup

Setup Lens locally if you want the Communication Tracking page to work
Follow these steps to get GraphQL Gateway service up and running locally (all steps, ensure schemas were pushed)

After starting the platform on your local machine, use: $ yarn start:local This sets DAVINCI_PLATFORM_API_URL to localhost:8082. In order to access Staff Portal directly, navigate to localhost:4015

Without docker

If you run platform and graphql-gateway without docker container, you will need to setup additional service — træfik, which we use for transparent authentication between different services. Normally, it's run as a part of platform's docker-compose, to run it separately (on macOS):

$ brew install traefik
# run in platform directory, or use absolute path in --providers.file.filename
$ traefik --api=true --api.dashboard=true --api.debug=true --api.insecure --log.level=INFO --accesslog=true --entrypoints.traefik.address=:8081 --entrypoints.web.address=:8082 --providers.file.filename=./config/traefik/dynamic.toml --providers.file.debugloggeneratedtemplate=true

dynamic.toml needs HOST_DOCKER_INTERNAL env variable to point to the actual host where gateway runs ("localhost" in our case). So set the variable in platforms .envrc. If you run traefik from another directory, add the env variable there as well.

How to run tests

Lint

For lint tests, run:

yarn lint

Unit tests

Run yarn test for unit tests.

Contract tests

Run yarn test:pact for contract tests. Please see the Confluence page for more information about contract testing for Staff Portal.

Integration Cypress tests

Prerequisites: launch the local Staff Portal instance in a separate terminal window via yarn start if the default Cypress tests configuration is used.

Run yarn test:ui:open for available integration tests to open in the browser-based user interface or run yarn test:ui:run to start all integration tests via terminal.

The default Cypress tests configuration (stored in the cypress.json configuration file) targets the https://local-development.staging.toptal.net as Staff Portal URL. However, tests can be run against any other Staff Portal instance, specified in the baseUrl field of the configuration file.

End-to-end Cucumber scenarios

Pre-requisites:

Pull platform repository, so it would be in sibling directory to staff-portal, ie. git/platform and git/staff-portal.
Set up platform locally, docker configuration recommended. Instructions are described here: https://github.com/toptal/platform/blob/master/docs/installation/README.md
Prepare cucumber environment. For this, run the next command in the platform directory: bin/setup -c

Two tags are used to mark scenarios for staff-portal:

@staff_portal for scenarios executed on legacy UI as well.
@only_staff_portal for scenarios using new UI only.

Environmental variable PLATFORM__STAFF_PORTAL__BETA_PARTICIPANT was introduced to start scenarios in new UI.

You can start scenarios with different markers:

Tags:

PLATFORM__STAFF_PORTAL__BETA_PARTICIPANT=true bundle exec cucumber -t '@staff_portal or @only_staff_portal'

Feature location:

PLATFORM__STAFF_PORTAL__BETA_PARTICIPANT=true bundle exec cucumber features/instant_availability/sales/priority_claimer.feature

Specific scenario location:

PLATFORM__STAFF_PORTAL__BETA_PARTICIPANT=true bundle exec cucumber features/instant_availability/sales/priority_claimer.feature:28

Scenario can be started in platform Pull Requests by adding comment:

To use latest masters of staff-portal and client-portal:

@toptal-bot run staff_portal features

To define staff-portal/client-portal branches in execution:

@toptal-bot run staff_portal features for staff_portal:staff-portal-branch portal:client-portal-branch

Debugging GQL endpoint in the explorer

Install the custom chrome extension which can be found here
Authenticate on https://staging.toptal.net
Use https://staging.toptal.net/api/graphql/staff endpoint in the extension
Profit!

Generate TypeScript types from GQL schema

run $ yarn generate:types
if the Username and Password are requested, please create the GitHub token and use it as password when running the command from the previous step

Beta Switching

Please go to Beta Switching docs

Supported modules

Communication

Includes:

Send Email Modal

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

1.0.1-alpha-try-monorepo.1867

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

1.0.1-alpha-try-monorepo.1866

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

1.490.193-alpha-feat-chronicles-link.3

3 years ago

1.490.371

3 years ago

1.490.193-alpha-feat-chronicles-link.2

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

1.490.323-alpha-spb-1576-fix-detailedlist-issues.0

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

1.490.294-alpha-spb-1545-detaillist-component.0

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

1.490.262-alpha-picasso-5.0

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

1.490.193-alpha-feat-chronicles-link.1

3 years ago

1.490.193

3 years ago

1.490.193-alpha-feat-chronicles-link.0

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

1.434.1-alpha-spt-message-observer.1

4 years ago

1.435.0

4 years ago

1.434.1-alpha-spt-message-observer.0

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

1.342.1-alpha-spb-858-range-filter-adjustment.3

4 years ago

1.342.1-alpha-spb-858-range-filter-adjustment.2

4 years ago

1.342.1-alpha-spb-858-range-filter-adjustment.1

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

1.342.1-alpha-spb-858-range-filter-adjustment.0

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

1.299.1-alpha-bxfe-815-test-1.0

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

1.279.1-alpha-fix-billing-bundle-size.4

4 years ago

1.279.1-alpha-fix-billing-bundle-size.3

4 years ago

1.279.1-alpha-fix-billing-bundle-size.2

4 years ago

1.279.1-alpha-fix-billing-bundle-size.1

4 years ago

1.281.0

4 years ago

1.280.0

4 years ago

1.279.1-alpha-fix-billing-bundle-size.0

4 years ago

1.279.0

4 years ago

1.278.0

4 years ago

1.277.1-alpha-SPC-63-filter-emails-by-message-ids.0

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

1.272.1-alpha-fx-1084-test-alpha.0

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago