npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@keepfy/error-extractor

v2.0.2

Published

An error extractor package for keepfy frontend apps

Downloads

34

Readme

Keepfy error extractor

A package that handles keepfy specific network & graphql errors for apollo clients

Details

This package wraps all our logic around server error messages sent by keepfy backend, it maps network and graphql errors to a known format and dispatch it to sentry if needed.

Install

yarn add @keepfy/error-extractor

Usage

When instantiating apollo client, use it on the error handler:

import * as KeepfyErrorExtractor from '@keepfy/error-extractor'
import ApolloClient from 'apollo-client'

// ...
new ApolloClient({
    // ...
    onError: (error) => {
        const { type } =
            KeepfyErrorExtractor.suggestionFromGraphQLError(error)
        
        if(type === 'INVALID_SESSION'){
          // do redirect to login emit
        }
    }
    // ...

})

Suggestions

The package offers message suggestions (since not everyone will use the strings) separated you can easily get a suggestion like this:

import * as KeepfyErrorExtractor from '@keepfy/error-extractor'
import { ApolloError } from 'apollo-client'

// from apollo error response

mutate(...options)
   .catch((error: ApolloError) => {
        const { message } =
            KeepfyErrorExtractor.suggestionFromGraphQLError(error)
   
        // do something with the error .message
   })

Auto handle for sentry

You can optionally send extracted errors to sentry.

import * as KeepfyErrorExtractor from 'keepfy-error-extractor'
import ApolloClient from 'apollo-client'

const sentryForward = KeepfyErrorExtractor.forwardToSentry(Sentry)

// ...
new ApolloClient({
    // ...
    onError: (error) => {
        const { type, message } =
            KeepfyErrorExtractor.suggestionFromGraphQLError(error)
        
        sentryForward.captureIfNeeded(type, error)

        if(type === 'INVALID_SESSION'){
          // do redirect to login emit
        }
    }
    // ...

})

Errors will be sent if the package decides that is needed, for example, UNKNOWN_ERROR are sent to sentry but EMAIL_NOT_VERIFIED are not. You can always put your own logic around the captureIfNeeded call to ignore stuff too.

Note: the handler is made for us to be able to identify non mapped errors, so the sentry open issue has the gql operation name, and some details sent by backend, there's no need to send stack traces (for now).

Note 2: we do not depend on a specific sentry package, instead, we specify an adapter with the common sentry methods (available at the types file, look for SentryAdapter), so if your sentry passed to the forward call doesn't type check, just write your adapter for it.