fxa/packages/fxa-admin-panel/README.md

Firefox Accounts Admin Panel

The FxA Admin Panel is an internal resource for FxA Admins to access a set of convenience tools.

Outside of local development, this application is protected by SSO, a VPN connection, and "guest list" login wall to ensure those without administrator privileges cannot access the service.

Development

• yarn start|stop|restart to start, stop, and restart the server as a PM2 process
• yarn build to create a production build
• yarn test to run unit tests

Getting Started

This service will automatically spin up when yarn start is ran from the root directory. A small Express server serves a React application and exposes the server config file for the client to consume via a meta tag.

The React dev server runs at localhost:8092 which can be useful when building components if you'd like an auto page refresh on file changes, however, the Express server that serves the React application and proxies its static resources runs at localhost:8091. Develop on :8091 if you need access to anything set in the server configuration file, including the URI for connecting to the fxa-admin-server.

API calls are done through Apollo Client with GraphQL to communicate with the fxa-admin-server. See its documentation to connect to the playground, a place to view the API docs and schema, and to write and test queries and mutations before using them in a component.

With the addition of subscriptions, running the Admin Panel now requires secrets to be set up in fxa-admin-server.

Option A: Set up Stripe Test Key

As documented in the Subscription Platform documentation:

If you're a Mozilla employee, you can request access to the Stripe dev (and/or stage) account, created for the FxA Subscription Platform team to easily connect with fake products and plans. Otherwise, you can create your own Stripe account to use for testing that is not linked to any bank account information with your own products and plans. These keys should be taken from Stripe's test environment which you can verify by checking that the key includes the word test.

Once you have a test key, replace the example key sk-test_123 in packages/fxa-admin-server/src/config/development.json

"stripeApiKey": "sk-test_123"

You may need to restart the service after replacing the key.

Option B: Set stripe featureFlag to false

In packages/fxa-admin-server/src/config/development.json, set the feature flag for Stripe to false, then restart the service.

External imports

You can import React components from other packages into this project. This is currently restricted to fxa-react:

// e.g. assuming the component HelloWorld exists
import HelloWorld from 'fxa-react/components/HelloWorld';

See the fxa-react section of the fxa-settings docs for more info on sharing or moving components into this package.

Testing

This package uses Jest to test both the frontend and server. By default yarn test will run all test scripts:

• yarn test-frontend will test the React App frontend under src/
• yarn test-server will test the Express server under server/

Test specific tests with the following commands:

# Test frontend tests for the component AccountSearch
yarn test-frontend AccountSearch

# Grep frontend tests for "displays the error"
yarn test-frontend -t "displays the error"

# Test server tests for the file server/lib/csp
yarn test-server server/lib/csp

# Grep server tests for "simple server routes"
yarn test-server -t "simple server routes"

Refer to Jest's CLI documentation for more advanced test configuration.

License

MPL-2.0