AppSync: skipping nullable nested resolvers by returning early

You can become a serverless blackbelt. Enrol to my 4-week online workshop Production-Ready Serverless and gain hands-on experience building something from scratch using serverless technologies. At the end of the workshop, you should have a broader view of the challenges you will face as your serverless architecture matures and expands. You should also have a firm grasp on when serverless is a good fit for your system as well as common pitfalls you need to avoid. Sign up now and get 15% discount with the code yanprs15!

Whilst working on a client project, I ran into an interesting problem with AppSync which I couldn’t find an answer after a lot of googling. I hope this article can save you the same pain should you run into the same problem.

The problem is that when you have a nullable nested field that you want to expand, you have to handle the null values in your VTL template and skip them. It was not obvious how to do this in a managed system like AppSync.

To give you a better idea of what I’m talking about, here is a drastically simplified version of the GraphQL schema.

In the DynamoDB table, universities are stored in the University table and users in the User table. Categories and sports are modelled as properties of a university to minimize the no. of DynamoDB reads. And the field is the profile ID for a user in the User table.

To make it easier for the UI to consume the data, we expand the field to be a fully fledged Coach type.

So, I set up the resolver for this nested field and point it at the User table. p.s. I’m using the Serverless framework with the excellent serverless-appsync-plugin to help me configure everything.

And I configured the VTL templates for the request and response.

And everything works great, except when is null.

What I needed, was a way to short-circuit the DynamoDB.GetItem request when is null. After a lot of searching, my google fu yielded nothing and I turned to my good friend Heitor Lessa. He pointed me to this helpful post which mentioned #return keyword that lets you short-circuit a resolver execution and return early.

With this, I was able to work around the problem by adding just 3 lines of code to my request template.

One thing to note is that you can’t have #return(null) but #return would null as the result for the resolver, and skip the DynamoDB GetItem operation and the response template altogether.

Liked this article? Support me on Patreon and get direct help from me via a private Slack channel or 1-2-1 mentoring.
Subscribe to my newsletter

Hi, I’m Yan. I’m an AWS Serverless Hero and I help companies go faster for less by adopting serverless technologies successfully.

Are you struggling with serverless or need guidance on best practices? Do you want someone to review your architecture and help you avoid costly mistakes down the line? Whatever the case, I’m here to help.

Hire me.

Skill up your serverless game with this hands-on workshop.

My 4-week Production-Ready Serverless online workshop is back!

This course takes you through building a production-ready serverless web application from testing, deployment, security, all the way through to observability. The motivation for this course is to give you hands-on experience building something with serverless technologies while giving you a broader view of the challenges you will face as the architecture matures and expands.

We will start at the basics and give you a firm introduction to Lambda and all the relevant concepts and service features (including the latest announcements in 2020). And then gradually ramping up and cover a wide array of topics such as API security, testing strategies, CI/CD, secret management, and operational best practices for monitoring and troubleshooting.

If you enrol now you can also get 15% OFF with the promo code “yanprs15”.

Enrol now and SAVE 15%.

Check out my new podcast Real-World Serverless where I talk with engineers who are building amazing things with serverless technologies and discuss the real-world use cases and challenges they face. If you’re interested in what people are actually doing with serverless and what it’s really like to be working with serverless day-to-day, then this is the podcast for you.

Check out my new course, Learn you some Lambda best practice for great good! In this course, you will learn best practices for working with AWS Lambda in terms of performance, cost, security, scalability, resilience and observability. We will also cover latest features from re:Invent 2019 such as Provisioned Concurrency and Lambda Destinations. Enrol now and start learning!

Check out my video course, Complete Guide to AWS Step Functions. In this course, we’ll cover everything you need to know to use AWS Step Functions service effectively. There is something for everyone from beginners to more advanced users looking for design patterns and best practices. Enrol now and start learning!