@liatrio/react-dora-charts v1.1.8

React DORA Charts

This component library contains charts for the standard DORA metrics.

Installation

You can install these components using the following command:

npm install @liatrio/react-dora-charts

Or

yarn add @liatrio/react-dora-charts

Usage

To use these charts, you can do as follows:

import { DeploymentFrequency, fetchData } from `@liatrio/react-dora-charts`
...
const fetchedData = fetchData(fetchProps, onSuccess, onFailure)
...
<div style={{width: "600px", height: "400px"}}>
    <DeploymentFrequencyGraph data={fetchedData} />
</div>

It is important that the chart component be wrapped in an element of some size somewhere up the tree, otherwise the chart may have unexpected behavior.

Exposed Components

Board

This is a component to display an At a Glance board for the 4 DORA Metrics and can be setup to either display trends or color coded scores.

DeploymentFrequencyGraph

This is a component to display a graph of your deployments over the specified time period.

ChangeLeadTimeGraph

This is a component to display a graph of your change lead time over the specified time period.

ChangeFailureRateGraph

This is a component to display a graph of your change failure rate over the specified time period.

RecoverTimeGraph

This is a component to display a graph of your recover time over the specified time period.

TrendGraph

This is a component to display the overall trend of the data supplied.

TrendIndicator

This component is a trend indicator you can use to display in parent components.

Exposed Functions

fetchData

Use this function to create the data parameter for the components.

This function takes a (FetchProps) object with the following properties.

buildDoraStateForPeriod

This function returns a DoraState object with information about each DORA Metric.

It takes the following values as parameters:

To get the trend value, the evaluation will use the previous period of the same length against your request period.

The DoraState object that is returned contains the following for each metric:

getDateDaysInPast and getDateDaysInPastUtc

These functions are just shortcuts to get a Date a certain number of days in the past

Component Properties

Graph Component Properties

Board Component Properties

• All the Common Properties

Trend Component Properties

• All the Common Properties

TrendIndicator Component Properties

Dependencies

These components rely on data being supplied to them. We supply the liatrio-dora-api to gather this data out of a Loki DB that is fed by our liatrio-otel-collector. If you want to create your own API, it just needs to return the Data Schema.

We also expose the fetchData function to fetch this data for you and do some preprocessing of the data before sending it into the components. If you would like to use your own function you will need to examine the preprocessing done by this function and replicate it for yours.

Data Schemas

The data schema for each chart is as follows:

{
    records: [{
      repository: string
      team: string
      title?: string
      user?: string
      sha: string
      status: boolean
      failed_at?: Date
      merged_at?: Date
      created_at: Date
      fixed_at?: Date
      deploy_url: string
      fixed_url?: string
      change_url: string
      issue_url?: string
    }, ...]
}

Testing

Unit Tests

Basic unit tests can be found in the tests directory. They can be run with npm test

Visual Diffs via Playwright

This project includes visual diff tests that are run via Playwright. They are used to ensure that the components are functioning and displaying correctly. Each component has its own set of visual diff tests that test the functionality of that component.

To run the Playwright tests, use the following commands:

You can also run a subset of the tests using tags, for example:

npx playwright test --grep @component-board
npx playwright test --grep @dataset-low

Note about updating snapshots

⚠️ Be extra cautious when updating snapshots. Any changes to the snapshots need to be manually reviewed for accuracy before committing them.

Note about Docker usage

To ensure consistency in the snapshots across different machines (local dev vs. CI), the Playwright tests are run in a Docker container. Running the tests locally is useful for creating and debugging, but all snapshots should be updated via the playwright:docker:update-snapshots command.

Contributing

See Contributing to React Dora Charts.