@fireadmin/core NPM

fireadmin

Application for Managing Firebase Applications. Includes support for multiple environments and data migrations

Features

Manage multiple environments as a single project
Project Sharing (invite by email coming soon)
"Action Runner" for common project actions such as data migrations, and generating reports
Action Features include support for:
- Multiple steps allowing many actions in one run
- Backup phase (for easy backing up data before running your actions)
- Custom logic (JS written in the browser with ESNext features like async/await)
Project level tracking of actions which have been run through Action Runner
Get/Set CORS Config of Storage Buckets
Testing for React App (Cypress) and Cloud Functions (Mocha)

coming soon

Support for copying Single Firestore Document in Copy Action
Map action - for mapping each item in a collection both on RTDB and Firestore
Authorized Google API Request Panel
Invite new users by email
User manager (including role assignment)
Data Viewer

Interested in adding a feature or contributing? Open an issue or reach out over gitter.

Getting Started

Since this is source code, a great place to start is checking the hosted version of Fireadmin available at fireadmin.io.

NPM Scripts

While developing, you will probably rely mostly on npm start; however, there are additional scripts at your disposal:

`npm run <script>`	Description
`start`	Serves your app at `localhost:3000` and displays Webpack Dashboard
`start:simple`	Serves your app at `localhost:3000` without Webpack Dashboard
`start:dist`	Builds the application to ./dist and Serves it at `localhost:3000` using `firebase serve`
`functions:start`	Runs Functions locally using `firebase functions:shell`
`functions:build`	Builds Cloud Functions to ./functions/dist
`functions:test`	Runs Functions Unit Tests with Mocha
`build`	Builds the application to ./dist
`test`	Runs E2E Tests with Cypress. See testing
`lint`	Lints the project for potential errors
`lint:fix`	Lints the project and fixes all correctable errors

Husky is used to enable prepush hook capability. The prepush script currently runs eslint, which will keep you from pushing if there is any lint within your code. If you would like to disable this, remove the prepush script from the package.json.

Application Structure

├── build                    # All build-related configuration
│   └── webpack.config.js    # Environment-specific configuration files for webpack
├── cypress                  # App End To End tests
├── docs                     # Docs application (built with Gatsby)
│   ├── content              # Content of docs (written in markdown)
│   ├── components           # React components used in docs app
│   ├── gatsby-config.js     # Gatsby plugin settings
│   ├── gatsby-node.js       # Gatsby node definitions (how templates are combined with content)
│   └── package.json         # Docs package file (docs specific dependencies)
├── functions                # Cloud Functions (uses Cloud Functions for Firebase)
│   └── index.js             # Functions entry point
├── server                   # Express application that provides webpack middleware
│   └── main.js              # Server application entry point
├── src                      # Application source code
│   ├── index.html           # Main HTML page container for app
│   ├── main.js              # Application bootstrap and rendering
│   ├── normalize.js         # Browser normalization and polyfills
│   ├── components           # Global Reusable Presentational Components
│   ├── containers           # Global Reusable Container Components
│   ├── layouts              # Components that dictate major page structure
│   │   └── CoreLayout       # Global application layout in which to render routes
│   ├── routes               # Main route definitions and async split points
│   │   ├── index.js         # Bootstrap main application routes with store
│   │   └── Home             # Fractal route
│   │       ├── index.js     # Route definitions and async split points
│   │       ├── assets       # Assets required to render components
│   │       ├── components   # Presentational React Components
│   │       ├── container    # Connect components to actions and store
│   │       ├── modules      # Collections of reducers/constants/actions
│   │       └── routes **    # Fractal sub-routes (** optional)
│   ├── static               # Static assets
│   ├── store                # Redux-specific pieces
│   │   ├── createStore.js   # Create and instrument redux store
│   │   └── reducers.js      # Reducer registry and injection
│   └── styles               # Application-wide styles (generally settings)
├── .firebaserc              # Firebase project settings (including settings for CI deployment)
├── cypress.json             # Cypress E2E Testing settings
├── database.rules.json      # Firebase Real Time Database Rules
├── firebase.json            # Firebase resource settings (including which folders are deployed)
├── firestore.indexes.json   # Firestore Indexes
├── firestore.rules          # Firestore Database Rules
└── storage.rules            # Cloud Storage Rules

Run Your Own

Requirements

node ^8.11.3 (node 8 suggested in order to match Cloud Functions Runtime)

Before Starting

Make sure you have enabled billing on your Firebase account - external API communication requires setting up a payment method (you are only charged based on usage)
Create an account on Algolia - Create a new app, you will need the API keys later
Install Firebase Command Line Tools: npm i -g firebase-tools

Local Environment Setup

Install dependencies: npm install

Look for a src/config.js file. If one doesn't exist, create it to look like so (this is generated using firebase-ci in CI environments):

export const version = "0.*.*"; // matches package.json when using firebase-ci in CI environment

export const env = "local"; // matches branch/project alias when using firebase-ci in CI environment

// Get from Auth Tab with Firebase's Console
// matches branch/project settings when using firebase-ci in CI environment
export const firebase = {
  apiKey: "<- api key ->",
  authDomain: "<- auth domain ->",
  databaseURL: "<- database URL ->",
  projectId: "<- project ID ->",
  storageBucket: "<- storageBucket ->",
  messagingSenderId: "<- message sender ID ->",
};

export const reduxFirebase = {
  userProfile: "users",
  enableLogging: false,
  updateProfileOnLogin: true,
  useFirestoreForProfile: true,
};

// Google Analytics Tracking ID (leave blank for no analytics)
export const analyticsTrackingId = "<- your analytics tracking id ->";

// Stackdriver client side error reporting (leave blank for no client side error reporting)
export const googleApis = {
  apiKey: "<- your API Key for Google APIs ->",
};

// Algolia project info (for searching of User's Public Info and Public Templates)
export const algolia = {
  appId: "<- your algolia app id ->",
  apiKey: "<- your algolia apiKey ->",
};

export default {
  version,
  env,
  firebase,
  reduxFirebase,
  analyticsTrackingId,
  googleApis,
  algolia
}

Create functions/.runtimeconfig.json file that looks like so:

{
  "algolia": {
    "api_key": "<- your API KEY ->",
    "app_id": "<- your Algolia APP ID ->"
  },
  "gmail": {
    "email": "<- gmail account for sending invite emails ->",
    "password": "<- password for ^ email ->"
  },
  "encryption": {
    "password": "<- your own made up encryption password for service accounts -> "
  }
}

Set Functions config variables to match the file you just made (for the deployed version of your functions):

Required Variables

firebase functions:config:set algolia.api_key="<- your algolia api key ->" algolia.api_key="<- your algolia api key ->"\
encryption.password="somePassword"

Optional

firebase functions:config:set gmail.email="<- inviter gmail account ->" gmail.password="<- password of inviter account ->"

Build Project: npm run build
Deploy to Firebase: firebase deploy (deploys, Cloud Functions, Rules, and Hosting)
Start Development server: npm start NOTE: You can also use npm run start:dist to test how your application will work when deployed to Firebase
View the deployed version of the site by running firebase open hosting:site

Deployment

CI Deploy (recommended)

Note: Config for this is located within .gitlab-ci.yml. firebase-ci has been added to simplify the CI deployment process by getting settings from the .firebaserc. All that is required is providing authentication with Firebase:

Have at least two Firebase projects to ready to use, one for each environment (staging and production)
Replace info within .firebaserc under both the projects and ci sections
Replace environment settings within .gitlab-ci.yml with your own. This will make the "Operations" tab of Gitlab point to your environment URLs.
Login: firebase login:ci to generate an authentication token. This token will be used to give the CI provider rights to deploy on your behalf. Settings are provided for Gitlab, but any CI provider can be used.
Set FIREBASE_TOKEN environment variable within Gitlab-CI environment variables

Add the following environment variables to Gitlab-CI's variables (within /settings/ci_cd):

FIREBASE_TOKEN // Used to deploy to Firebase (token generated in last step)
/* Stage Vars */
STAGE_FIREBASE_API_KEY // apiKey staging project (from Firebase Auth Tab)
STAGE_ALGOLIA_APP_ID // algolia app_id of staging project
STAGE_ALGOLIA_BROWSER_KEY // algolia browser_key of staging project
/* Prod Vars */
PROD_FIREBASE_API_KEY // apiKey staging project (from Firebase Auth Tab)
PROD_ALGOLIA_APP_ID // algolia app_id of staging project
PROD_ALGOLIA_BROWSER_KEY // algolia browser_key of staging project
/* Optional */
SENTRY_DSN // Sentry DSN for error tracking
STAGE_GOOGLE_API_KEY // API Key for Stackdriver error logging (can use firebase apiKey)
PROD_GOOGLE_API_KEY // API Key for Stackdriver error logging (can use firebase apiKey)

Run a build on Gitlab-CI by pushing code to your Git remote (most likely Github)

For more options on CI settings checkout the firebase-ci docs.

Manual deploy

Make sure you have created a src/config.js file as mentioned above
Initialize project with firebase init then answer:

What file should be used for Database Rules? -> database.rules.json
What do you want to use as your public directory? -> build
Configure as a single-page app (rewrite all urls to /index.html)? -> Yes
What Firebase project do you want to associate as default? -> your Firebase project name

Build Project: npm run build
Confirm Firebase config by running locally: firebase serve
Deploy to firebase: firebase deploy NOTE: You can use firebase serve to test how your application will work when deployed to Firebase, but make sure you run npm run build first.

Docs

Documentation is available at fireadmin.io/docs

All source code and content for docs is located within the docs folder. Docs are generated from markdown into static files using Gatsby based on settings in gatsby-config.js.

Visit the docs README for more info.

Testing

NOTE: If you have setup CI deployment, E2E tests and Unit Tests can automatically run against your staging environment before running the production build.

Cloud Functions Unit Tests

Cloud Functions Unit tests are written in Mocha with code coverage generated by Istanbul. These tests cover "backend functionality" handled by Cloud Functions by stubbing the functions environment (including dependencies).

Run Locally

Go into the functions folder: cd functions
Confirm you have dependencies installed: npm i
Run unit tests: npm test
To also generate coverage while testing, run npm run test:cov

App UI Tests

End to End tests are done using Cypress and they live within the cypress folder. These tests cover UI functionality and are run directly on the hosted environment of Fireadmin. Application end to end tests are run automatically in Gitlab-CI the after deploying to the staging environment before deploying to production.

Run Locally

Create a service account within the Firebase console
Save the service account as serviceAccount.json within the root of the project
Get the UID of the user that you want to use while testing from the Authentication tab of the Firebase console to

Create a cypress/config.json with the following format:

{
  "TEST_UID": "<- user account's UID ->",
  "FIREBASE_PROJECT_ID": "<- your projectId ->",
  "FIREBASE_API_KEY": "<- your firebase apiKey ->"
}

Run npm run start:dist. This will:
1. Build the React app to the dist folder
2. Host the build app on a local server using firebase serve
In a different terminal tab, run npm run test:ui. This will:
1. Create test environment configuration (includes JWT created using service account)
2. Run Cypress tests locally through cli

To Open Cypress's local test runner UI where you can run single tests or all tests use npm run test:ui:open.

NOTE: npm run start:dist is used to start the local server in the example above for speed while running all tests. If you are developing the application while re-running a single test, or just a few, you can use npm run start instead.

FAQ

Why node 8.11.3 instead of a newer version? Cloud Functions runtime supports 6 or 8, which is why that is what is used for the CI build version. This will be switched when the functions runtime is updated
Uploading service accounts? Where do they go and how are my service accounts stored? When uploading a service account, it first goes to a Google Cloud Storage Bucket which has security rules and does not have CORS access. The copyServiceAccountToFirestore Cloud Function converts it into an encrypted string, stores it within Firestore, then removes the original file from Cloud Storage. Firestore rules keep anyone that is not a collaborator on your project using or reading the service account. Since it is associated with a specific environment, you can then limit access to what can be done with it right in the Users/Permissions tab of Fireadmin.