Skip to content

Latest commit

 

History

History
71 lines (44 loc) · 3.23 KB

README.md

File metadata and controls

71 lines (44 loc) · 3.23 KB
Raw

Contentlayer Build Benchmarks

This is a basic benchmarking tool that measures build performance of various front-end frameworks.

✔️ Subject Conditions

There are a number of factors that contribute to the overall test condition:

  • Content Source & Volume: The location and quantity of pieces of content
  • Content Structure: The shape of the data that is being processed.
  • Test Conditions: How the tests are run.
  • Reported Results: How the output results are measured.

See below for specifics.

Content Source & Volume

The content source for each project being tested are 1k local markdown files containing frontmatter with a title property, and four paragraphs of placeholder content.

Content Structure

The content files are generated randomly at the beginning of test runs, and all test subjects use the same files during the run.

The content within each site is nearly identical. There is a home page that lists every content item in the site, and individual pages for each item, totalling 1,001 pages.

Test Conditions

Each subject is tested under two conditions:

  1. Cold: After deleting all relevant cache directories
  2. Warm: With the build artifacts in place

Before the warm build runs, we add an extra page to the content directory. This page is similar in structure and is always the same. It is used to simulate a slight change in content without removing the cache.

Reported Results

These conditions are run five times, and the reported result is the average of the five builds.

📋 Project List

This is the current list of subjects:

  • Next.js (v12.1.0) + Contentlayer (v0.1.2)
  • Next.js (v12.1.0) + Remark (v13.0.0)
  • Gatsby (v4.13.0) + gatsby-transformer-remark (v5.13.0)

🏎 Test Runner

The tests are run as a GitHub action. Results are logged in the output of the workflow on GitHub.

Running Locally

To run the project locally, install the dependencies using Yarn:

yarn install

There is a shell script that handles running the tests: bin/run.sh. You can run this directly and the results will be printed to your console.

🥇 Latest results (see action run)

┌────────────────────────┬────────────┬────────────┐
│                        │ Cold (sec) │ Warm (sec) │
├────────────────────────┼────────────┼────────────┤
│ Next.js + Contentlayer │ 23.52      │ 15.56      │
├────────────────────────┼────────────┼────────────┤
│ Next.js + Remark       │ 38.10      │ 32.80      │
├────────────────────────┼────────────┼────────────┤
│ Gatsby                 │ 32.31      │ 15.00      │
└────────────────────────┴────────────┴────────────┘