Swizec Teller - a geek with a hatswizec.com

    pg-mem and jest for smooth integration testing

    It's no secret that I think the cult of TDD leads you down a dark and stormy path towards brittle code with a false sense of security.

    Clean isolation, mocks for all things impure, interfaces designed for ease of testing over ease of use. The sense of achievement is immense. Look at all those green checkmarks 💪

    And outside a few special cases with complex logic or algorithms, it means boopkis to your production code.

    2 unit tests, 0 integration tests

    Most business code is JSON bureaucracy: shuttling data from one side to another. Transforming formats. Joining data streams. Abstracting knowledge domains and business processes.

    You know how to write a loop and TypeScript ensures you hold the code correctly. Unit tests don't add much.

    Fakes over mocks

    Unit tests isolate too much.

    While fantastic for complex algorithms and gnarly logic, they break down for JSON bureaucracy. They don't test the right things.

    Take this test for example:

    describe("getOAuthToken", () => {
    it("should call the db with the tokenReference successfully", async () => {
    const tokenReference = "tokenReference"
    const tableName = "oauth_token"
    await oauthService.getOAuthToken(tokenReference)
    expect(db).toBeCalledWith(tableName)
    expect(db().where).toBeCalledTimes(1)
    expect(db().where).toBeCalledWith("internal_reference", tokenReference)
    })
    })

    Verifies that calling getOAuthToken talks to the database and uses the tokenReference to fetch a row. The database is mocked and this test is pure. Runs on your machine with no external dependencies very fast.

    A beautiful example of a great unit test. 👌

    Do you think it's a useful test?

    How stubs and mocks fail

    What happens if we change the table name? This test won't notice.

    What happens if we change the table structure? This test doesn't even check.

    How do you know the code does anything of value? The test pretends to check, but you can make it pass with useless code, if you want.

    export async function getOAuthToken(): Promise<Token> {
    db("oauth_token")
    db("random_table").where("internal_reference", "tokenReference")
    return {
    access_token: "123",
    refresh_token: "afefaw",
    expires_in: 3600,
    }
    }

    Call the correct table then call a .where() with hardcoded params on a random table. Return an unrelated value of the right type. 💩

    We're using Jest with TypeScript which ensures the return types must match. At least there's that.

    You won't be mean like this in your project, I hope. It can happen by accident. When someone unfamiliar with your code makes a change that breaks it in a way that mocks obscure.

    Stubs and mocks test a strawman

    Stubs and mocks construct a strawman and test that, not your code. This is a lesson Google learned at scale – stubs and mocks make bad tests.

    But full integration testing is slow, resource intensive, and hard to get right. The more complex your production environment, the harder it is to simulate.

    To quote David Wells, an early developer of Serverless Framework: "Forget about local testing, you can't replicate AWS on your machine".

    The solution are fakes. This also is a lesson Google learned at scale and put in their wonderful Software Engineering at Google book.

    Fakes are lightweight implementations of the services you need. Maintained, ideally, by the team who makes that service.

    pg-mem is a fake database for your tests

    pg-mem is a pure in-memory implementation of Postgres. The perfect solution for database tests that sit in that sweet spot between pure unit and full integration. 😍

    You get database reads and writes, guarantees around data consistency, migrations, and zero overhead. Your tests run in memory, as fast as always.

    pg-mem achieves this through Olivier Guimbal's herculean effort. The madman built his own SQL parser and reimplemented an almost full-featured clone of Postgres in TypeScript.

    What pg-mem looks like in practice

    See the example repository for the full setup. It's based on my How to configure Jest with TypeScript from a while back when I thought this article would be "next week". 😅

    For this example we're using knex, a query builder, to talk to the database and pg-mem for testing. The project doesn't do anything useful, it exists to show off testing.

    Use Jest manual mocks to fake your database

    Jest manual mocks are the perfect place to implement a fake. You build a lightweight implementation of your code and Jest uses it in tests.

    For the database example, you take this db connection file:

    // ./src/db.ts
    import knex from "knex"
    import knexFile from "../knexfile"
    export default knex(knexFile)

    And add its fake counterpart in a sibling __mocks__/ directory:

    // ./src/__mocks__/db.ts
    import { newDb } from "pg-mem"
    import knexFile from "../../knexfile"
    const mem = newDb()
    export default mem.adapters.createKnex(0, knexFile) as typeof import("knex")

    The original db.ts file configures knex to connect to your database. You can import db and run SQL queries with db('table_name') throughout your codebase.

    The __mocks__/ version uses the same config, but instantiates an in-memory pg-mem instance and connects to that. Unless you're doing something special, the rest of your code should Just Work. It has no idea the database is fake 🤘

    Setup the pg-mem database

    Your fake database needs to be in the right state to run tests. Have the tables, the seed data, etc.

    That happens in jest.setup.ts, a test setup file that runs before your tests. Configured by the setupFilesAfterEnv value in jest.config.ts.

    // jest.setup.ts
    import db from "./src/db"
    // enables the fake database for all test files
    jest.mock("./src/db")
    // run migrations
    beforeAll(async () => {
    await db.migrate.latest()
    })
    // close connection
    afterAll(async () => {
    await db.destroy()
    })

    We import the faked db file, enable mocking for every test, and run migrations before anything else. After tests are done, we close the connection so Jest doesn't hang.

    Write better tests with a fake database

    Take that getOAuthToken example from before. Here's the function itself:

    export type OAuthToken = {
    access_token: string
    refresh_token: string
    expires_in: number
    internal_reference: string
    }
    export type OAuthTokenRow = OAuthToken & {
    internal_reference: string
    }
    export const getOAuthToken = async (
    tokenReference: string
    ): Promise<OAuthToken> => {
    const tokenRow: OAuthTokenRow = await db("oauth_token")
    .where("internal_reference", tokenReference)
    .first()
    return omit(tokenRow, "internal_reference")
    }

    Talks to the database and returns the first row of the oauth_token table that matches the tokenReference. Omits internal_reference before returning the value because that's an implementation detail. I think. We could debate on that.

    How would you write a test for this function?

    Here's what I did:

    // ./src/__tests__/oauth-service.ts
    describe("oauth-service", () => {
    let token: oauthService.OAuthToken, tokenReference: string
    beforeEach(() => {
    tokenReference = Faker.datatype.uuid()
    token = {
    access_token: Faker.datatype.string(20),
    refresh_token: Faker.datatype.string(20),
    expires_in: 3600,
    }
    })
    describe("getOAuthToken", () => {
    it("should read the oauth token from db", async () => {
    await db("oauth_token").insert({
    ...token,
    internal_reference: tokenReference,
    })
    const oauthToken = await oauthService.getOAuthToken(tokenReference)
    expect(oauthToken).toEqual(token)
    })
    })
    })

    Construct a fake OAuth token, insert into the database, use the getOAuthToken function. Compare that the result matches expectations.

    Now you can rely on this test to tell you if something's wrong.

    Table got renamed? You get a SQL error.

    Table structure changed? The result no longer matches unless you fix the function.

    Made a typo in your query or aren't using the params? The test will tell you.

    You get better insert tests too

    The insertion counterpart to getOAuthToken looks like this:

    export const insertOAuthToken = async (
    tokenReference: string,
    token: OAuthToken
    ) => {
    return db("oauth_token").insert({
    ...token,
    internal_reference: tokenReference,
    })
    }

    Gets an OAuthToken and its internal reference, saves to the database.

    How would you write this test?

    Here's what I did:

    describe("insertOAuthToken", () => {
    it("should insert a token", async () => {
    const [{ count: prevCount }] = await db("oauth_token").count()
    await oauthService.insertOAuthToken(tokenReference, token)
    const [{ count: afterCount }] = await db("oauth_token").count()
    const newToken = await db("oauth_token")
    .where("internal_reference", tokenReference)
    .first()
    expect(afterCount).toEqual((prevCount as number) + 1)
    expect(omit(newToken, "internal_reference")).toEqual(token)
    })
    })

    Compares row count before and after insertion, verifies it increments. Fetches the inserted value and verifies it matches expectations.

    Another great test would be to verify what happens, if you try to use a non-unique tokenReference and insert twice. The code currently has a bug I think.

    Principles of good DB testing with pg-mem

    1. Test the data gets inserted
    2. Test the right data gets inserted
    3. Test the inserted data gets returned
    4. Avoid hardcoded values with Faker

    Now all I'm missing from Rails is something like Factory Bot for convenient test models and data factories. The search continues

    Cheers,
    ~Swizec

    PS: you can use the __mocks__ approach to write a lightweight fake of any file. Like a 3rd party SDK, a fake microservice, or an API 😍

    Did you enjoy this article?

    Published on December 21st, 2021 in Backend Web, JavaScript, TypeScript, Testing, Jest,

    Learned something new?
    Read more Software Engineering Lessons from Production

    I write articles with real insight into the career and skills of a modern software engineer. "Raw and honest from the heart!" as one reader described them. Fueled by lessons learned over 20 years of building production code for side-projects, small businesses, and hyper growth startups. Both successful and not.

    Subscribe below 👇

    Software Engineering Lessons from Production

    Join Swizec's Newsletter and get insightful emails 💌 on mindsets, tactics, and technical skills for your career. Real lessons from building production software. No bullshit.

    "Man, love your simple writing! Yours is the only newsletter I open and only blog that I give a fuck to read & scroll till the end. And wow always take away lessons with me. Inspiring! And very relatable. 👌"

    ~ Ashish Kumar

    Join 15,883+ engineers learning lessons from my "raw and honest from the heart" emails.

    ⭐️⭐️⭐️⭐️✨
    4.5 stars average rating

    Have a burning question that you think I can answer? Hit me up on twitter and I'll do my best.

    Who am I and who do I help? I'm Swizec Teller and I turn coders into engineers with "Raw and honest from the heart!" writing. No bullshit. Real insights into the career and skills of a modern software engineer.

    Want to become a true senior engineer? Take ownership, have autonomy, and be a force multiplier on your team. The Senior Engineer Mindset ebook can help 👉 swizec.com/senior-mindset. These are the shifts in mindset that unlocked my career.

    Curious about Serverless and the modern backend? Check out Serverless Handbook, for frontend engineers 👉 ServerlessHandbook.dev

    Want to Stop copy pasting D3 examples and create data visualizations of your own? Learn how to build scalable dataviz React components your whole team can understand with React for Data Visualization

    Want to get my best emails on JavaScript, React, Serverless, Fullstack Web, or Indie Hacking? Check out swizec.com/collections

    Want to brush up on modern JavaScript syntax? Check out my interactive cheatsheet: es6cheatsheet.com

    Did someone amazing share this letter with you? Wonderful! You can sign up for my weekly letters for software engineers on their path to greatness, here: swizec.com/blog

    Want to brush up on your modern JavaScript syntax? Check out my interactive cheatsheet: es6cheatsheet.com

    By the way, just in case no one has told you it yet today: I love and appreciate you for who you are ❤️

    Created by Swizec with ❤️