Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Return a message when a 429 http response is received #115

Merged
merged 4 commits into from
Oct 1, 2021

Conversation

sandymcfadden
Copy link
Contributor

@sandymcfadden sandymcfadden commented Sep 30, 2021

Description

Currently, node-simperium only returns the response text from HTTP requests.
This adds a case for handling 429 responses from Simperium, which has an empty response body, and adds a response text which can then be used to handle this error specifically.

Now in clients if a 429 error is received you can check for it with something like
const errorMessage = error.underlyingError.message ?? '';
errorMessage === 'too many requests'; // 429 error

? 'too many requests'
: xhr.responseText;
resolve(message);
};
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

may sound silly given how simple this is right now, but I feel like a ladder of conditions would better set the stage for future changes here which might be likely. it's not the biggest issue, and there's a case to be made to let this be for now, but what are your thoughts about this construction instead?

xhr.onload = () => {
    if ( xhr.message === 429 && xhr.responseText = '' ) {
        return resolve('too many requests');
    }

    resolve(message);
}

you may find it silly for me to recommend changing a ternary into an if chain, but the early-abort here is key, that and the distinction that we're not really saying the message is one of two things, but rather that we're parsing the response and determining which of many possible outcomes we have.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the early-abort here is key, that and the distinction that we're not really saying the message is one of two things, but rather that we're parsing the response and determining which of many possible outcomes we have.

Your reasoning here makes total sense! It may not be 100% needed right now, but in the future, we may need to add more checks so I updated with your suggestion.

Copy link

@codebykat codebykat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@sandymcfadden sandymcfadden merged commit bd7ba06 into trunk Oct 1, 2021
@dmsnell dmsnell deleted the update/return-message-on-429-http-response branch October 1, 2021 17:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants