Merge pull request #159 from jamesplease/3.0.0

jamesplease · web-flow · commit 5eddd22c7e0c · 2018-04-24T18:40:26.000-07:00
3.0.0
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,18 @@
 # Changelog
 
+### v3.0.0 (2018/4/24)
+
+> Although the changes in this release are technically breaking, they are unlikely to
+> affect most users' code.
+
+**Breaking Changes**
+
+* When a request fails, the `data` from a request will no longer be set to `null`. This
+  allows you to control whether or not your UI continues to display the existing data.
+
+* The `responseType` prop is now more forgiving. If the body cannot be parsed with
+  the `responseType` that you set, then `data` will be set to `null`.
+
 ### v2.0.4 (2018/4/20)
 
 **Bug Fixes**
diff --git a/README.md b/README.md
@@ -364,30 +364,8 @@ about the response, such as its status code.
 </Fetch>
 ```
 
-```jsx
-// Some "enterprisey" endpoints return text stack traces anytime that they error. A function
-// `responseType` can protect you against this.
-<Fetch
-  url="/countries/2"
-  responseType={response => {
-    // Only parse as JSON when the request's code is not an error code, and it is
-    // not 204 No Content.
-    return response.ok && response.status !== 204 ? 'json' : 'text';
-  }}
-  transformData={countryName => {
-    return {
-      countryName
-    };
-  }}>
-  {({ data }) => {
-    if (data) {
-      return <div>{data.countryName}</div>;
-    }
-
-    return null;
-  }}
-</Fetch>
-```
+If the response body cannot be parsed as the `responseType` that you specify, then `data` will
+be set to `null`.
 
 ##### `requestName`
 
diff --git a/examples/fetch-components/package.json b/examples/fetch-components/package.json
@@ -6,7 +6,7 @@
     "react": "^16.2.0",
     "react-composer": "^4.1.0",
     "react-dom": "^16.2.0",
-    "react-request": "^2.0.4",
+    "react-request": "^3.0.0",
     "react-scripts": "1.1.0"
   },
   "scripts": {
diff --git a/examples/lazy-read/package.json b/examples/lazy-read/package.json
@@ -5,7 +5,7 @@
   "dependencies": {
     "react": "^16.2.0",
     "react-dom": "^16.2.0",
-    "react-request": "^2.0.4",
+    "react-request": "^3.0.0",
     "react-scripts": "1.1.0"
   },
   "scripts": {
diff --git a/examples/multiple-requests/package.json b/examples/multiple-requests/package.json
@@ -6,7 +6,7 @@
     "react": "^16.2.0",
     "react-composer": "^4.1.0",
     "react-dom": "^16.2.0",
-    "react-request": "^2.0.4",
+    "react-request": "^3.0.0",
     "react-scripts": "1.1.0"
   },
   "scripts": {
diff --git a/examples/request-deduplication/package.json b/examples/request-deduplication/package.json
@@ -5,7 +5,7 @@
   "dependencies": {
     "react": "^16.2.0",
     "react-dom": "^16.2.0",
-    "react-request": "^2.0.4",
+    "react-request": "^3.0.0",
     "react-scripts": "1.1.0"
   },
   "scripts": {
diff --git a/examples/response-caching/package.json b/examples/response-caching/package.json
@@ -5,7 +5,7 @@
   "dependencies": {
     "react": "^16.2.0",
     "react-dom": "^16.2.0",
-    "react-request": "^2.0.4",
+    "react-request": "^3.0.0",
     "react-scripts": "1.1.0"
   },
   "scripts": {
diff --git a/examples/simple-read/package.json b/examples/simple-read/package.json
@@ -5,7 +5,7 @@
   "dependencies": {
     "react": "^16.2.0",
     "react-dom": "^16.2.0",
-    "react-request": "^2.0.4",
+    "react-request": "^3.0.0",
     "react-scripts": "1.1.0"
   },
   "scripts": {
diff --git a/examples/updating-a-resource/package.json b/examples/updating-a-resource/package.json
@@ -5,7 +5,7 @@
   "dependencies": {
     "react": "^16.2.0",
     "react-dom": "^16.2.0",
-    "react-request": "^2.0.4",
+    "react-request": "^3.0.0",
     "react-scripts": "1.1.0"
   },
   "scripts": {
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "react-request",
-  "version": "2.0.4",
+  "version": "3.0.0",
   "description": "Declarative HTTP requests with React.",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -83,7 +83,7 @@
     "rollup-plugin-uglify": "^2.0.1"
   },
   "dependencies": {
-    "fetch-dedupe": "^2.1.0",
+    "fetch-dedupe": "^3.0.0",
     "prop-types": "^15.6.0"
   }
 }
diff --git a/src/fetch.js b/src/fetch.js
@@ -369,6 +369,14 @@ export class Fetch extends React.Component {
 
     data = data ? this.props.transformData(data) : null;
 
+    // If we already have some data in state on error, then we continue to
+    // pass that data down. This prevents the data from being wiped when a
+    // request fails, which is generally not what people want.
+    // For more, see: GitHub Issue #154
+    if (error && this.state.data) {
+      data = this.state.data;
+    }
+
     if (hittingNetwork) {
       this.props.afterFetch({
         url,
diff --git a/test/do-fetch.test.js b/test/do-fetch.test.js
diff --git a/test/index.test.js b/test/index.test.js

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "react-request",`
`3`		`- "version": "2.0.4",`
	`3`	`+ "version": "3.0.0",`
`4`	`4`	`"description": "Declarative HTTP requests with React.",`
`5`	`5`	`"main": "lib/index.js",`
`6`	`6`	`"module": "es/index.js",`
`@@ -83,7 +83,7 @@`
`83`	`83`	`"rollup-plugin-uglify": "^2.0.1"`
`84`	`84`	`},`
`85`	`85`	`"dependencies": {`
`86`		`- "fetch-dedupe": "^2.1.0",`
	`86`	`+ "fetch-dedupe": "^3.0.0",`
`87`	`87`	`"prop-types": "^15.6.0"`
`88`	`88`	`}`
`89`	`89`	`}`