codeceptjs/CodeceptJS

[feature-request] REST helper rejectOnError config option

Open

#1293 opened on Oct 30, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (3,956 stars) (725 forks)batch import
RESTenhancementgood first issue

Description

Just that. How do you feel about a config option for the REST helper to make the promises reject whenever there is an error response, ex. status codes 4XX, 5XX, etc? (I personally think it should be the default behaviour)

I could create a pull request for this, as I have implemented it already on a custom helper on the project I'm working on.

Contributor guide

Tech stack
javascriptnodejsrest api
Domain
testingbackendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScriptNode.jsCodeceptJS basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Look at the current REST helper implementation in CodeceptJS, likely in lib/helper/REST.js. Add a config option 'rejectOnError' that defaults to false. When enabled, reject the promise returned by the helper methods (e.g., sendGet, sendPost) if the HTTP response status code is 4xx or 5xx. Ensure the change is backward compatible. Tests should be added for the new option.