Cleaner components with useSuspenseQuery | Swizec Teller – The Global Tofay

Cleaner components with useSuspenseQuery | Swizec Teller - The Global Tofay Global Today

What makes code hard to read and think about? A combinatorial explosion of states and execution paths.

This happens when you put everything inside your component. Data loading, transformations, error handling, loading states, and that’s before you even think about user interactions.

Need to coordinate 2 or more data loaders? Fuggedaboutit.

if ((loading1 || loading2) && !error1 || ...)

The number of bugs I’ve caused this way is too damn high 🫠

Code like this leads to high cyclomatic complexity, which is less problematic than architectural complexity, but does make smoke come out your ears. The code is brittle and likely to break any time you sneeze wrong.

Ever since using TanStack Router, where these patterns are built-in at the router level, I’m increasingly a fan of solving these problems with React Suspense.

The code shows a piece of UI that renders when showBirthdays = true. Like when you click a button to start loading.

Suspense handles the loading state. ErrorBoundary handles the error state.

You can try it out here and see full code on GitHub.

Main component – happy path


Main component list today’s births

That leaves your component to implement the happy path.

const Birthdays: FC<{ day: Date }> = ({ day }) => {
  const births = useBirths(day)

  return 
}

No loading states. No error handling. Just a data loader and rendering. You could add more data loaders and assume everything’s perfect in the rendering portion of your component.

Data loader – leverages suspense

The data loader leverages suspense to suspend rendering while data loads. I’m using useSuspenseQuery from React Query, but similar tools exist in other popular libraries.

function useBirths(day: Date) {
  const query = useSuspenseQuery({
    queryKey: ["wikipedia-birthdays", day],
    queryFn: async () => {
      const response = await fetch(
        `
          day.getMonth() + 1
        }/${day.getDate()}`
      )

      if (!response.ok) {
        throw new Error("Error fetching births")
      }

      const { births } = (await response.json()) as {
        births: BirthEntry[]
      }
      births.sort((a, b) => b.year - a.year)

      return births
    },
  })

  return query.data
}

Notice that I can just throw an Error when it happens. This is important. You want any error during processing or rendering to throw so that the ErrorBoundary can catch it and show feedback to the user.

Another important detail is that I’m sorting and parsing data directly in the loader. That improves your render performance because you’re caching the data you use, not just the data you fetch.

Error component – for the errors


Error component handles errors
Error component handles errors

The ErrorBoundary renders an error component when something’s wrong. This component lets users recover from an error by resetting the boundary and refetching the data.

const LoadError: FC<{ day: Date }> = ({ day }) => {
  const queryClient = useQueryClient()
  const { resetBoundary } = useErrorBoundary()

  function refetch() {
    resetBoundary()
    queryClient.refetchQueries({
      queryKey: ["wikipedia-birthdays", day],
    })
  }

  return (
    
      Error fetching births for {getPrettyDate(day)}{" "}
      
    
  )
}

Powered by the popular react-error-boundary component from B Vaughn, a former member of the React team.

Loading component – for loading states


Loading component during suspense
Loading component during suspense

The loading component in my case is just a spinner. You can make it as fancy as you want.

No more god components that do everything! No more god hooks that try to coordinate a bazillion different states.

Keep your happy path, loading state, and errors separate. Think about one at a time ✌️

~Swizec

Followup answer to Wtf why does this work? πŸ‘‰ Why useSuspenseQuery works?

Published on May 29th, 2024 in React, React Query, Suspense

Did you enjoy this article?

Continue reading about Cleaner components with useSuspenseQuery

Semantically similar articles hand-picked by GPT-4

Senior Mindset Book

Get promoted, earn a bigger salary, work for top companies

Learn more

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

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 ❀️


#Cleaner #components #useSuspenseQuery #Swizec #Teller

Leave a Reply

Your email address will not be published. Required fields are marked *