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 detailed response #34

Merged
merged 2 commits into from
Jul 26, 2019
Merged

Conversation

dpopp07
Copy link
Member

@dpopp07 dpopp07 commented Jul 25, 2019

Returns the "detailed response" (which includes the body, the headers, the status, etc.) as the first callback argument after error. This used to be the body itself, so this is a breaking change (pushing to the "next" branch).

Also, renaming the body property from data to result. This is done to be consistent with the other SDKs.

This will remove the need for the generated SDKs to use the return_response parameter to determine how to resolve Promises.

Includes some test changes.

dpopp07 added 2 commits July 25, 2019 14:44
BREAKING CHANGE: The response body is no longer the 2nd callback argument, the detailed response is. The body is located under the `result` property. The `data` property is removed.
@codecov
Copy link

codecov bot commented Jul 25, 2019

Codecov Report

Merging #34 into release-candidate-v1 will increase coverage by 0.01%.
The diff coverage is 100%.

Impacted file tree graph

@@                   Coverage Diff                    @@
##           release-candidate-v1      #34      +/-   ##
========================================================
+ Coverage                 93.35%   93.37%   +0.01%     
========================================================
  Files                        12       12              
  Lines                       512      513       +1     
  Branches                    151      151              
========================================================
+ Hits                        478      479       +1     
  Misses                       33       33              
  Partials                      1        1
Impacted Files Coverage Δ
lib/requestwrapper.ts 84.73% <100%> (+0.11%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6d95d40...a8dd7be. Read the comment docs.

Copy link
Contributor

@germanattanasio germanattanasio left a comment

Choose a reason for hiding this comment

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

👍

@dpopp07 dpopp07 merged commit 0fd2298 into release-candidate-v1 Jul 26, 2019
@dpopp07 dpopp07 deleted the return-detailed-response branch July 26, 2019 16:51
Copy link
Contributor

@mkistler mkistler left a comment

Choose a reason for hiding this comment

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

Looks good! 👍

dpopp07 added a commit that referenced this pull request Aug 6, 2019
BREAKING CHANGE: The response body is no longer the 2nd callback argument, the detailed response is. The body is located under the `result` property. The `data` property is removed.
mkistler pushed a commit that referenced this pull request Sep 17, 2019
BREAKING CHANGE: The response body is no longer the 2nd callback argument, the detailed response is. The body is located under the `result` property. The `data` property is removed.
dpopp07 added a commit that referenced this pull request Oct 3, 2019
BREAKING CHANGE: The response body is no longer the 2nd callback argument, the detailed response is. The body is located under the `result` property. The `data` property is removed.
dpopp07 added a commit that referenced this pull request Oct 3, 2019
BREAKING CHANGE: The response body is no longer the 2nd callback argument, the detailed response is. The body is located under the `result` property. The `data` property is removed.
ibm-devx-automation pushed a commit that referenced this pull request Oct 3, 2019
# [1.0.0](v0.3.6...v1.0.0) (2019-10-03)

### Bug Fixes

* Move check for serviceUrl to createRequest ([#47](#47)) ([6f04739](6f04739))
* parse result from response in token managers ([6bbe423](6bbe423))
* provide bundlers alternate file for browser support ([#58](#58)) ([88a9d16](88a9d16))

### Build System

* drop support for Node versions 6 and 8 ([#33](#33)) ([d47c737](d47c737))

### Code Refactoring

* look for credentials file in working dir before home dir ([#46](#46)) ([c5556de](c5556de))
* return detailed response as second callback argument ([#34](#34)) ([dc24154](dc24154))

### Features

* add `setServiceUrl` method as a setter for the `serviceUrl` property ([#41](#41)) ([cfb188f](cfb188f))
* add specific error handling for SSL errors with cloud private instances ([#54](#54)) ([056ec9a](056ec9a))
* export `UserOptions` interface from the BaseService ([#50](#50)) ([4f0075a](4f0075a))
* implement new authenticators to handle sdk authentication ([#37](#37)) ([f876b6d](f876b6d))
* refactor core to use Promises instead of callbacks ([#55](#55)) ([9ec8afd](9ec8afd))

### BREAKING CHANGES

* None of the authenticators or request methods take callbacks as arguments anymore - they return Promises instead.
* Users that have credential files in both the working directory and the home directory will see a change in which one is used.
* The internal property `url` no longer exists on the `baseOptions` object, it has been renamed to `serviceUrl`
* The old style of passing credentials to the base service will no longer work. An Authenticator instance MUST be passed in to the base service constructor.
* token managers no longer support user access tokens. use BearerTokenAuthenticator instead
* The class names of the token managers have changed.
* `Icp4dTokenManagerV1` renamed to `Cp4dTokenManager`
* `IamTokenManagerV1` renamed to `IamTokenManager`
* `JwtTokenManagerV1` renamed to `JwtTokenManager`
* The public method `setAuthorizationInfo` is renamed to `setClientIdAndSecret`
* The response body is no longer the 2nd callback argument, the detailed response is. The body is located under the `result` property. The `data` property is removed.
* This SDK may no longer work with applications running on Node 6 or 8.
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