Dependency Injection with NextJS and TypeScript

24 November 2021

Coming from a backend world, one thing that stands out when you start writing code in JavaScript, be it React, NextJS, Vue etc, is there's no great focus on code structure. Things like TypeScript bring back the concept of type checking that you'd be used to with a compiled language, and NextJS will give anyone familiar with ASP.NET MVC an alternative pattern for how a website should be constructed. But you can get the whole way through the NextJS tutorial without concepts like single responsibility, inversion of control or CQRS being mentioned once.

Now if your building a small site, maybe you can get away with not knowing or imlementing these things, but if you want to make code that's scalable or maintainable, it doesn't matter if you write in JavaScript or C# the same issues will exist but fortunately the same solutions do too.

Code Smells

Lets take a look at one of the functions on this site which gets the latest blog posts on the homepage.

1import gql from 'graphql-tag';
2import { Client, ApolClient } from '../prismicHelpers'
3
4// Models
5import { FeaturedPost } from "../../Models/FeaturedPost"
6
7const latestPostsQuery = gql`
8query latestPosts($category: String) {
9  allPosts (where : {category: $category}, first : 10, sortBy: post_date_DESC){
10    edges {
11      node {
12        category {
13          ... on Categories {
14            name
15          }          
16        },
17        title,
18        image,
19        post_date
20        _meta {
21          uid
22        }
23      }
24    }
25  }
26}
27`;
28
29export const getLatestPosts = async (category?: String) : Promise<FeaturedPost[]> => {
30  const queryOptions = {
31    query: latestPostsQuery,
32    variables: { category },
33  };
34
35  return new Promise((resolve, reject) => { ApolClient.query(queryOptions).then(response => {
36    var posts: Array<FeaturedPost> = [];
37    response.data.allPosts.edges.map((edge: { node: { title: { text: any; }[]; category: any; image: any; post_date: Date; _meta: { uid: any; }; }; }, key: any) => {
38      posts.push({
39        type: "post",
40        title: edge.node.title[0].text,
41        image: edge.node.image,
42        uid: edge.node._meta.uid,
43        category: edge.node.category?.name,
44        postDate: edge.node.post_date
45      })
46    })
47    resolve( posts);
48  }).catch(error => {
49    reject(error);
50  });
51});
52};

This bit of code queries Prismic's GraphQL API to get the latest 10 articles for a category and then maps the result onto an internal FeaturedPost model.

Some good things about it:

The Prismic logic is abstracted away from the rest of the application by mapping the results to a model.
It follows single responsibility by doing just 1 job.
All config for the API (e.g. URI) are separated into a common function rather than being duplicated.

However even though I've seen countless JavaScript examples which don't even do these good things, if this were C# and I was reviewing a pull request, I'd say it smelt and needed changing.

Here's some bad things about it:

It's taking a dependency on Apollo Client, which while is a great client for doing GraphQL queries, at the rate JS frameworks come and go we can't say we'll never replace it and in a large application that has countless queries that would be a lot of code to update.
There's also no way anything can call this without also taking a dependency on it. That means I now have a hierarchy of at least 3 functions with each one dependent on the next. If I ever wanted to add unit tests to my project I'd have a big problem.

Dependency Injection using TSyringe

These issues can be solved using Dependency Injection. There's quite a few around but the one I've chosen is TSyringe (https://github.com/microsoft/tsyringe).

It's built by Microsoft, which gives me some confidence in the amount of QA that will have gone into it, but more importantly it works the way I expect a DI framework to work. There's a good chance this could be because I'm used to working in the Microsoft stack and it therefore has natural similarities to DI frameworks in their own languages.

How to add TSyringe to a NextJS project

There's nothing specifically NextJS about TSyringe, you could use it with any TypeScript/JavaScript project, it just happens that that's what my blog is built using. However it also had a few issues getting it to work and I couldn't any articles around which explained how.

To set it up...

First install the package tsyring and reflect-metadata using npm.

1npm install --save tsyringe reflect-metadata

Modify your tsconfig.json file to include the following settings, which will allow the use of decorators in TypeScript.

1{
2  "compilerOptions": {
3    "experimentalDecorators": true,
4    "emitDecoratorMetadata": true
5  }
6}

Now there's a few more packages your going to need. As of NextJS 12, Babel is no longer used and has been replaced with SWC to provide faster compile times. However TSyringe and most other DI frameworks use decorators to function (hence the tsconfig.js setting to turn them on), but the setting for SWC to allow this set to false in NextJS and there's no way for you to provide your own config. Fortunately Babel is still supported and you can customise it. Hopefully a future version of NextJS will address this.

Install the following packages as dependencies.

1npm install -D @babel/core @babel/plugin-proposal-class-properties @babel/plugin-proposal-decorators babel-plugin-transform-typescript-metadata

Add a .bablerc file to your project with the following settings.

1{
2  "presets": ["next/babel"],
3  "plugins": [
4    "babel-plugin-transform-typescript-metadata",
5    ["@babel/plugin-proposal-decorators", { "legacy": true }],
6    ["@babel/plugin-proposal-class-properties", { "loose": true }]
7  ]
8}

Finally add this import to your _app.tsx file.

1import "reflect-metadata";

Using TSyringe

We're now ready to convert the code I had before into something more maintainable.

First I'm going to create a GraphQL Client interface which all my queries will use when they want to call a graph API. This has one function called query, which my functions will pass the graph syntax too along with a variables object.

1import { DocumentNode } from "graphql";
2
3export interface graphClient {
4  query(query: DocumentNode, variables?: {}): any;
5}

With this interface I can now turn my getLatestPosts function into a class with a constructor that will take in the instance of graphClient.

1import { inject, injectable } from "tsyringe";
2import { iGetLatestPosts } from "./iGetLatestPosts";
3import gql from "graphql-tag";
4import { graphClient } from "../iGraphQl";
5
6// Models
7import { FeaturedPost } from "../../Models/FeaturedPost";
8
9@injectable()
10export class getLatestPosts implements iGetLatestPosts {
11  graphClient: graphClient;
12
13  constructor(@inject("graphClient") private graphClientParam: graphClient) {
14    this.graphClient = graphClientParam;
15  }
16
17  private latestPostsQuery = gql`
18    query latestPosts($category: String) {
19      allPosts(
20        where: { category: $category }
21        first: 10
22        sortBy: post_date_DESC
23      ) {
24        edges {
25          node {
26            category {
27              ... on Categories {
28                name
29              }
30            }
31            title
32            image
33            post_date
34            _meta {
35              uid
36            }
37          }
38        }
39      }
40    }
41  `;
42
43  public getLatestPosts = async (
44    category?: String
45  ): Promise<FeaturedPost[]> => {
46    return new Promise((resolve, reject) => {
47      this.graphClient
48        .query(this.latestPostsQuery, { category })
49        .then((response: any) => {
50          var posts: Array<FeaturedPost> = [];
51          response.data.allPosts.edges.map(
52            (
53              edge: {
54                node: {
55                  title: { text: any }[];
56                  category: any;
57                  image: any;
58                  post_date: Date;
59                  _meta: { uid: any };
60                };
61              },
62              key: any
63            ) => {
64              posts.push({
65                type: "post",
66                title: edge.node.title[0].text,
67                image: edge.node.image,
68                uid: edge.node._meta.uid,
69                category: edge.node.category?.name,
70                postDate: edge.node.post_date,
71              });
72            }
73          );
74          resolve(posts);
75        })
76        .catch((error: any) => {
77          reject(error);
78        });
79    });
80  };
81}

Some things to note in this new class.

It's also now implementing an interface so that it can instantiated using DI.
The @injectable decorator allows TSyringe to inject the dependencies at runtime.
The constructor is decorating a parameter with @inject("graphClient") which means that parameter will be injected at runtime with whatever is configured against the graphClient token.
There are imports from tsyringe.
There are no references to the implementation of graphClient.
My function now has zero dependencies on Apollo Client and doesn't even know it's being used.

My implementation of graphClient looks like this.

1import { autoInjectable } from "tsyringe";
2import { DocumentNode } from "apollo-link";
3import ApolloClient from "apollo-client";
4import { NormalizedCacheObject } from "apollo-cache-inmemory";
5import { graphClient } from "./iGraphQl";
6
7@autoInjectable()
8export class apolloGraphClient implements graphClient {
9  apolloClient: ApolloClient<NormalizedCacheObject>;
10
11  constructor(apolloClient: ApolloClient<NormalizedCacheObject>) {
12    this.apolloClient = apolloClient;
13  }
14
15  public query = async (query: DocumentNode, variables?: {}): Promise<any> => {
16    const queryOptions = {
17      query: query,
18      variables: variables,
19    };
20
21    return new Promise((resolve, reject) => {
22      this.apolloClient
23        .query(queryOptions)
24        .then((response: any) => {
25          resolve(response);
26        })
27        .catch((error: any) => {
28          reject(error);
29        });
30    });
31  };
32}

Essentially all this function does is pass the parameters to the query function to an Apollo Client's query function. The Apollo Client itself is also being injected!

You may have expected this file to also instantiate the Apollo Client, and it could have, but I've gone to the extreme and the single purpose of this file is to act as a bridge between the business logic queries and what client is being used, so for that reason its injected.

You'll also notice that this time I'm decorating the class with @autoInjectable() and there is no decorator on the constructor parameter. More on this in a bit.

The homepage page for this site now looks like this.

1import Head from "next/head";
2
3import React, { useState } from "react";
4import { container } from "tsyringe";
5import { GetStaticProps } from "next";
6import Layout from "../layouts/layout";
7import { FeaturedRow1, FeaturedRow1Model } from "../components/featured-row-1";
8import SectionHeading from "../components/section-heading";
9import { iGetLatestPosts } from "../utils/queries/iGetLatestPosts";
10
11export default function Home({
12  latestPosts,
13  webDevelopmentPosts,
14  sitecorePosts,
15  devOpsPosts,
16}: {
17  latestPosts: FeaturedRow1Model;
18  webDevelopmentPosts: FeaturedRow1Model;
19  sitecorePosts: FeaturedRow1Model;
20  devOpsPosts: FeaturedRow1Model;
21}) {
22  return (
23    <Layout>
24      <Head>
25        <title>Hi My Name Is Tim</title>
26      </Head>
27      <SectionHeading heading="Latest Posts" link="blog"></SectionHeading>
28      <FeaturedRow1 posts={latestPosts}></FeaturedRow1>
29      <SectionHeading heading="Web Development" link="web-development"></SectionHeading>
30      <FeaturedRow1 posts={webDevelopmentPosts}></FeaturedRow1>
31      <SectionHeading heading="Sitecore" link="sitecore"></SectionHeading>
32      <FeaturedRow1 posts={sitecorePosts}></FeaturedRow1>
33      <SectionHeading heading="Devops" link="devops"></SectionHeading>
34      <FeaturedRow1 posts={devOpsPosts}></FeaturedRow1>
35    </Layout>
36  );
37}
38
39export const getStaticProps: GetStaticProps = async () => {
40  // Resolve interface for iGetLatestPosts
41  const instance = container.resolve<iGetLatestPosts>("iGetLatestPosts");
42
43  const latestPosts = await instance.getLatestPosts();
44  const webDevelopmentPosts = await instance.getLatestPosts("X8kFhxIAACcAn9oY");
45  const devOpsPosts = await instance.getLatestPosts("X8kFlRIAACkAn9pa");
46  const sitecorePosts = await instance.getLatestPosts("X8kFeBIAACkAn9nV");
47
48  return {
49    props: {
50      latestPosts: latestPosts,
51      devOpsPosts: devOpsPosts,
52      sitecorePosts: sitecorePosts,
53      webDevelopmentPosts: webDevelopmentPosts,
54    },
55  };
56};

Pages in NextJS TypeScript don't use classes, so we can't do constructor injection to get the instance of our getLatestPosts query class. Instead we are using container.resolve<iGetLatestPosts>("iGetLatestPosts") to get the instance to token name iGetLatestPosts from the DI container.

Lastly in the _app.tsx file I am registering the classes on the container. I'm only including the relevant bit of the file here.

1container.registerInstance(
2  ApolloClient,
3  new ApolloClient({
4    link: PrismicLink({
5      uri: prismicGraphUri,
6      repositoryName: prismicRepoName,
7    }),
8    cache: new InMemoryCache({ fragmentMatcher }),
9  })
10);
11
12container.register("graphClient", apolloGraphClient);
13container.register("iGetLatestPosts", getLatestPosts);

For the Apollo Client I am using register instance to register a specific instance and creating it at the same time. Notice the first parameter is the class name.

For the graph client and getLatestPosts query I am using the register method and rather than creating the instance of my implementation, just passing the class as the second parameter. The framework will handle creating an instance of them for me.

Notice the first parameter for the second two are strings rather than the actual interfaces. These are token names that the container will use to reference the instance value. With the Apollo Client, the framework will figure out the token name when it adds it to the container, but it can't do the same for an interface (if you try you will get an interface cannot be used as a type error) so you have to provide the token name instead. This is also the reason why the graph client implementation didn't need to use a string to inject the class instance in the constructor, whereas the other places did.

Personally I feel this is a weakness in the framework as it also means there is no type checking either when registering or resolving from the container.

Summary

We have seen that using JavaScript doesn't prevent us from using the same concepts as we would with any other more traditional backend language.

We've also seen how a NextJS application while slightly more awkward, can still be set up to use dependency injections.

Finally we've had a look at how to actually configure some code to have complete separation between logic within a solution.

How to create a new instance of a dependency inject object

29 September 2017

I decided to write this post after seeing it done wrong on a number of occasions and also not finding many great examples of how it should be done. Most articles of DI or IOC tend to focus on objects such as a logger being injected and then calling functions on that object.

Take for instance, this example in the Simple Injector documentation:

1using System;
2using System.Web.Mvc;
3 
4public class UserController : Controller {
5    private readonly IUserRepository repository;
6    private readonly ILogger logger;
7 
8    public UserController(IUserRepository repository, ILogger logger) {
9        this.repository = repository;
10        this.logger = logger;
11    }
12 
13    [HttpGet]
14    public ActionResult Index(Guid id) {
15        this.logger.Log("Index called.");
16        IUser user = this.repository.GetById(id);
17        return this.View(user);
18    }
19}

Here we can see the implementation of IUserRepository and ILogger get passed in the constructor and are then used in the Index method.

However what would the example be if we wanted to create a new user and call the user repository to save it? Creating a new instance of IUser from our controller becomes an issue as we don't know what the implementation of IUser is.

The incorrect implementation I usually see is someone adding a reference to the implementation and just creating a new instance of it. A bit like this:

1public class UserController : Controller {
2    [HttpPost]
3    public ActionResult SaveUser(UserDetails newUserInfo) {
4 
5        IUser user = new User;
6        user.FirstName = newUserInfo.FirstName;
7        user.LastName = newUserInfo.LastName;
8        this.repository.SaveUser(user);
9        return this.View(user);
10    }
11}

This will work, but fundamentally defeats the point of using dependency injection as we now have a dependency on the user objects specific implementation.

The solution I use is to add a factory method to our User Repository which takes care of creating a User object.

1public class UserRepository : IUserRepository {
2    public User CreateUser() {
3        return new User();
4    }
5}

Responsibility of creating the object now remains with its implementation and our controller no longer needs to have a reference to anything other than the interface.

1public class UserController : Controller {
2    [HttpPost]
3    public ActionResult SaveUser(UserDetails newUserInfo) {
4 
5        IUser user = this.repository.CreateUser();
6        user.FirstName = newUserInfo.FirstName;
7        user.LastName = newUserInfo.LastName;
8        this.repository.SaveUser(user);
9        return this.View(user);
10    }
11}