feat(request-hook): add on failure callback

* fix(client): remove destruction from response * chore: update example Add single endpoint, add router, add pages Closes #9
2020-11-06 00:53:09 +03:00 · 2020-11-06 00:53:09 +03:00 · a1574769e9
commit a1574769e9
parent 97e5e1de35
7 changed files with 240 additions and 25 deletions
--- a/examples/movies/package-lock.json
+++ b/examples/movies/package-lock.json
@ -2249,6 +2249,12 @@
        "@types/node": "*"
      }
    },
+    "@types/history": {
+      "version": "4.7.8",
+      "resolved": "https://registry.npmjs.org/@types/history/-/history-4.7.8.tgz",
+      "integrity": "sha512-S78QIYirQcUoo6UJZx9CSP0O2ix9IaeAXwQi26Rhr/+mg7qqPy8TzaxHSUut7eGjL8WmLccT7/MXf304WjqHcA==",
+      "dev": true
+    },
    "@types/html-minifier-terser": {
      "version": "5.1.1",
      "resolved": "https://registry.npmjs.org/@types/html-minifier-terser/-/html-minifier-terser-5.1.1.tgz",
@ -2349,6 +2355,27 @@
        "@types/react": "*"
      }
    },
+    "@types/react-router": {
+      "version": "5.1.8",
+      "resolved": "https://registry.npmjs.org/@types/react-router/-/react-router-5.1.8.tgz",
+      "integrity": "sha512-HzOyJb+wFmyEhyfp4D4NYrumi+LQgQL/68HvJO+q6XtuHSDvw6Aqov7sCAhjbNq3bUPgPqbdvjXC5HeB2oEAPg==",
+      "dev": true,
+      "requires": {
+        "@types/history": "*",
+        "@types/react": "*"
+      }
+    },
+    "@types/react-router-dom": {
+      "version": "5.1.6",
+      "resolved": "https://registry.npmjs.org/@types/react-router-dom/-/react-router-dom-5.1.6.tgz",
+      "integrity": "sha512-gjrxYqxz37zWEdMVvQtWPFMFj1dRDb4TGOcgyOfSXTrEXdF92L00WE3C471O3TV/RF1oskcStkXsOU0Ete4s/g==",
+      "dev": true,
+      "requires": {
+        "@types/history": "*",
+        "@types/react": "*",
+        "@types/react-router": "*"
+      }
+    },
    "@types/resolve": {
      "version": "0.0.8",
      "resolved": "https://registry.npmjs.org/@types/resolve/-/resolve-0.0.8.tgz",
@ -7003,6 +7030,19 @@
      "resolved": "https://registry.npmjs.org/hex-color-regex/-/hex-color-regex-1.1.0.tgz",
      "integrity": "sha512-l9sfDFsuqtOqKDsQdqrMRk0U85RZc0RtOR9yPI7mRVOa4FsR/BVnZ0shmQRM96Ji99kYZP/7hn1cedc1+ApsTQ=="
    },
+    "history": {
+      "version": "4.10.1",
+      "resolved": "https://registry.npmjs.org/history/-/history-4.10.1.tgz",
+      "integrity": "sha512-36nwAD620w12kuzPAsyINPWJqlNbij+hpK1k9XRloDtym8mxzGYl2c17LnV6IAGB2Dmg4tEa7G7DlawS0+qjew==",
+      "requires": {
+        "@babel/runtime": "^7.1.2",
+        "loose-envify": "^1.2.0",
+        "resolve-pathname": "^3.0.0",
+        "tiny-invariant": "^1.0.2",
+        "tiny-warning": "^1.0.0",
+        "value-equal": "^1.0.1"
+      }
+    },
    "hmac-drbg": {
      "version": "1.0.1",
      "resolved": "https://registry.npmjs.org/hmac-drbg/-/hmac-drbg-1.0.1.tgz",
@ -7013,6 +7053,14 @@
        "minimalistic-crypto-utils": "^1.0.1"
      }
    },
+    "hoist-non-react-statics": {
+      "version": "3.3.2",
+      "resolved": "https://registry.npmjs.org/hoist-non-react-statics/-/hoist-non-react-statics-3.3.2.tgz",
+      "integrity": "sha512-/gGivxi8JPKWNm/W0jSmzcMPpfpPLc3dY/6GxhX2hQ9iGj3aDfklV4ET7NjKpSinLpJ5vafa9iiGIEZg10SfBw==",
+      "requires": {
+        "react-is": "^16.7.0"
+      }
+    },
    "hoopy": {
      "version": "0.1.4",
      "resolved": "https://registry.npmjs.org/hoopy/-/hoopy-0.1.4.tgz",
@ -9945,6 +9993,15 @@
      "resolved": "https://registry.npmjs.org/min-indent/-/min-indent-1.0.1.tgz",
      "integrity": "sha512-I9jwMn07Sy/IwOj3zVkVik2JTvgpaykDZEigL6Rx6N9LbMywwUSMtxET+7lVoDLLd3O3IXwJwvuuns8UB/HeAg=="
    },
+    "mini-create-react-context": {
+      "version": "0.4.1",
+      "resolved": "https://registry.npmjs.org/mini-create-react-context/-/mini-create-react-context-0.4.1.tgz",
+      "integrity": "sha512-YWCYEmd5CQeHGSAKrYvXgmzzkrvssZcuuQDDeqkT+PziKGMgE+0MCCtcKbROzocGBG1meBLl2FotlRwf4gAzbQ==",
+      "requires": {
+        "@babel/runtime": "^7.12.1",
+        "tiny-warning": "^1.0.3"
+      }
+    },
    "mini-css-extract-plugin": {
      "version": "0.11.3",
      "resolved": "https://registry.npmjs.org/mini-css-extract-plugin/-/mini-css-extract-plugin-0.11.3.tgz",
@ -12403,21 +12460,26 @@
          "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-2.0.1.tgz",
          "integrity": "sha1-ewUhjd+WZ79/Nwv3/bLLFf3Qqkk="
        },
+        "fastq": {
+          "version": "1.8.0",
+          "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.8.0.tgz",
+          "integrity": "sha512-SMIZoZdLh/fgofivvIkmknUXyPnvxRE3DhtZ5Me3Mrsk5gyPL42F0xr51TdRXskBxHfMp+07bcYzfsYEsSQA9Q=="
+        },
        "globals": {
          "version": "12.4.0",
          "resolved": "https://registry.npmjs.org/globals/-/globals-12.4.0.tgz",
          "integrity": "sha512-BWICuzzDvDoH54NHKCseDanAhE3CeDorgDL5MT6LMXXj2WCnd9UC2szdk4AWLfjdgNBCXLUanXYcpBBKOSWGwg=="
        },
-        "js-tokens": {
-          "version": "3.0.2",
-          "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-3.0.2.tgz",
-          "integrity": "sha1-mGbfOVECEw449/mWvOtlRDIJwls="
-        },
        "path-key": {
          "version": "3.1.1",
          "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz",
          "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q=="
        },
+        "run-parallel": {
+          "version": "1.1.9",
+          "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.1.9.tgz",
+          "integrity": "sha512-DEqnSRTDw/Tc3FXf49zedI638Z9onwUotBMiUFKmrO2sdFKIbXamXGQ3Axd4qgphxKB4kw/qP1w5kTxnfU1B9Q=="
+        },
        "shebang-command": {
          "version": "2.0.0",
          "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz",
@ -12430,9 +12492,60 @@
          "version": "3.0.0",
          "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz",
          "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A=="
+        },
+        "supports-color": {
+          "version": "5.3.0",
+          "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.3.0.tgz",
+          "integrity": "sha512-0aP01LLIskjKs3lq52EC0aGBAJhLq7B2Rd8HC/DR/PtNNpcLilNmHC12O+hu0usQpo7wtHNRqtrhBwtDb0+dNg=="
        }
      }
    },
+    "react-router": {
+      "version": "5.2.0",
+      "resolved": "https://registry.npmjs.org/react-router/-/react-router-5.2.0.tgz",
+      "integrity": "sha512-smz1DUuFHRKdcJC0jobGo8cVbhO3x50tCL4icacOlcwDOEQPq4TMqwx3sY1TP+DvtTgz4nm3thuo7A+BK2U0Dw==",
+      "requires": {
+        "@babel/runtime": "^7.1.2",
+        "history": "^4.9.0",
+        "hoist-non-react-statics": "^3.1.0",
+        "loose-envify": "^1.3.1",
+        "mini-create-react-context": "^0.4.0",
+        "path-to-regexp": "^1.7.0",
+        "prop-types": "^15.6.2",
+        "react-is": "^16.6.0",
+        "tiny-invariant": "^1.0.2",
+        "tiny-warning": "^1.0.0"
+      },
+      "dependencies": {
+        "isarray": {
+          "version": "0.0.1",
+          "resolved": "https://registry.npmjs.org/isarray/-/isarray-0.0.1.tgz",
+          "integrity": "sha1-ihis/Kmo9Bd+Cav8YDiTmwXR7t8="
+        },
+        "path-to-regexp": {
+          "version": "1.8.0",
+          "resolved": "https://registry.npmjs.org/path-to-regexp/-/path-to-regexp-1.8.0.tgz",
+          "integrity": "sha512-n43JRhlUKUAlibEJhPeir1ncUID16QnEjNpwzNdO3Lm4ywrBpBZ5oLD0I6br9evr1Y9JTqwRtAh7JLoOzAQdVA==",
+          "requires": {
+            "isarray": "0.0.1"
+          }
+        }
+      }
+    },
+    "react-router-dom": {
+      "version": "5.2.0",
+      "resolved": "https://registry.npmjs.org/react-router-dom/-/react-router-dom-5.2.0.tgz",
+      "integrity": "sha512-gxAmfylo2QUjcwxI63RhQ5G85Qqt4voZpUXSEqCwykV0baaOTQDR1f0PmY8AELqIyVc0NEZUj0Gov5lNGcXgsA==",
+      "requires": {
+        "@babel/runtime": "^7.1.2",
+        "history": "^4.9.0",
+        "loose-envify": "^1.3.1",
+        "prop-types": "^15.6.2",
+        "react-router": "5.2.0",
+        "tiny-invariant": "^1.0.2",
+        "tiny-warning": "^1.0.0"
+      }
+    },
    "react-scripts": {
      "version": "4.0.0",
      "resolved": "https://registry.npmjs.org/react-scripts/-/react-scripts-4.0.0.tgz",
@ -12887,6 +13000,11 @@
      "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-4.0.0.tgz",
      "integrity": "sha512-pb/MYmXstAkysRFx8piNI1tGFNQIFA3vkE3Gq4EuA1dF6gHp/+vgZqsCGJapvy8N3Q+4o7FwvquPJcnZ7RYy4g=="
    },
+    "resolve-pathname": {
+      "version": "3.0.0",
+      "resolved": "https://registry.npmjs.org/resolve-pathname/-/resolve-pathname-3.0.0.tgz",
+      "integrity": "sha512-C7rARubxI8bXFNB/hqcp/4iUeIXJhJZvFPFPiSPRnhU5UPxzMFIl+2E6yY6c4k9giDJAhtV+enfA+G89N6Csng=="
+    },
    "resolve-url": {
      "version": "0.2.1",
      "resolved": "https://registry.npmjs.org/resolve-url/-/resolve-url-0.2.1.tgz",
@ -14664,6 +14782,16 @@
      "resolved": "https://registry.npmjs.org/timsort/-/timsort-0.3.0.tgz",
      "integrity": "sha1-QFQRqOfmM5/mTbmiNN4R3DHgK9Q="
    },
+    "tiny-invariant": {
+      "version": "1.1.0",
+      "resolved": "https://registry.npmjs.org/tiny-invariant/-/tiny-invariant-1.1.0.tgz",
+      "integrity": "sha512-ytxQvrb1cPc9WBEI/HSeYYoGD0kWnGEOR8RY6KomWLBVhqz0RgTwVO9dLrGz7dC+nN9llyI7OKAgRq8Vq4ZBSw=="
+    },
+    "tiny-warning": {
+      "version": "1.0.3",
+      "resolved": "https://registry.npmjs.org/tiny-warning/-/tiny-warning-1.0.3.tgz",
+      "integrity": "sha512-lBN9zLN/oAf68o3zNXYrdCt1kP8WsiGW8Oo2ka41b2IM5JL/S1CTyX1rW0mb/zSuJun0ZUrDxx4sqvYS2FWzPA=="
+    },
    "tmp": {
      "version": "0.0.33",
      "resolved": "https://registry.npmjs.org/tmp/-/tmp-0.0.33.tgz",
@ -15118,6 +15246,11 @@
        "spdx-expression-parse": "^3.0.0"
      }
    },
+    "value-equal": {
+      "version": "1.0.1",
+      "resolved": "https://registry.npmjs.org/value-equal/-/value-equal-1.0.1.tgz",
+      "integrity": "sha512-NOJ6JZCAWr0zlxZt+xqCHNTEKOsrks2HQd4MqhP1qy4z1SkbEP467eNx6TgDKXMvUOb+OENfJCZwM+16n7fRfw=="
+    },
    "vary": {
      "version": "1.1.2",
      "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz",
--- a/examples/movies/package.json
+++ b/examples/movies/package.json
@ -9,6 +9,7 @@
    "react": "^17.0.1",
    "react-dom": "^17.0.1",
    "react-rest-request": "file:../../",
+    "react-router-dom": "^5.2.0",
    "react-scripts": "4.0.0",
    "web-vitals": "^0.2.4"
  },
@ -38,6 +39,7 @@
  },
  "devDependencies": {
    "@types/react-dom": "^16.9.9",
+    "@types/react-router-dom": "^5.1.6",
    "typescript": "^4.0.5"
  }
 }
--- a/examples/movies/src/app.tsx
+++ b/examples/movies/src/app.tsx
@ -1,17 +1,19 @@
 import React from 'react';
-import { useRequest } from 'react-rest-request';
-import { MoviesEndpoint, MoviesResponse } from './endpoint';
+import { BrowserRouter, Route, Switch } from 'react-router-dom'
+import { MoviePage, MoviesPage } from './pages';
+

 export default function App() {
-    const { data, loading } = useRequest<MoviesResponse>(MoviesEndpoint);
-
-    return !data ? (
-        <div>{ loading ? 'Loading...' : 'Something went wrong' }</div>
-    ) : (
-        <ul>
-            {data.map(movie => (
-                <li key={movie.id}>{movie.title}</li>
-            ))}
-        </ul>
-    );
+    return (
+        <BrowserRouter>
+            <Switch>
+                <Route exact path='/'>
+                    <MoviesPage />
+                </Route>
+                <Route exact path='/:id'>
+                    <MoviePage />
+                </Route>
+            </Switch>
+        </BrowserRouter>
+    )
 }
--- a/examples/movies/src/endpoint.ts
+++ b/examples/movies/src/endpoint.ts
@ -12,4 +12,14 @@ export const MoviesEndpoint: Endpoint = {
    url: '/action-adventure',
 };

-export type MoviesResponse = Movie[];
+export type MoviesResponse = Movie[];
+
+
+export const MovieEndpoint: Endpoint<MovieParams> = {
+    method: Method.GET,
+    url: ({ id }) => `/action-adventure/${id}`,
+};
+
+export type MovieParams = Readonly<{ id: React.Key }>;
+
+export type MovieResponse = Movie[];
--- a/examples/movies/src/pages.tsx
+++ b/examples/movies/src/pages.tsx
@ -0,0 +1,43 @@
+import React from 'react';
+import { useRequest } from 'react-rest-request';
+import { Link, useParams } from 'react-router-dom';
+import { MovieEndpoint, MovieParams, MovieResponse, MoviesEndpoint, MoviesResponse } from './endpoint';
+
+
+export function MoviesPage() {
+    const { data, loading } = useRequest<MoviesResponse>(MoviesEndpoint);
+
+    return !data ? (
+        <div>{ loading ? 'Loading...' : 'Something went wrong' }</div>
+    ) : Array.isArray(data) ? (
+        <ul>
+            {data
+                .filter(movie => !!movie.title)
+                .map(movie => (
+                    <li key={movie.id}>
+                        <Link to={`/${movie.id}`}>{movie.title}</Link>
+                    </li>
+                ))}
+            <li>
+                <Link to='/9999'><span style={{color: 'red'}}>NOT EXIST</span></Link>
+            </li>
+        </ul>
+    ) : <div>{JSON.stringify(data)}</div>;
+}
+
+export function MoviePage() {
+    const params = useParams<{ id: string}>();
+    const { data, loading } = useRequest<MovieResponse, void, MovieParams>(
+        MovieEndpoint,
+        {
+            params,
+            onFailure(res) {
+                alert(JSON.stringify(res));
+            }
+        }
+    );
+
+    return !data ? (
+        <div>{ loading ? 'Loading...' : 'Something went wrong' }</div>
+    ) : <div>{JSON.stringify(data)}</div>;
+}
--- a/src/client.ts
+++ b/src/client.ts
@ -13,9 +13,10 @@ export type RequestProps = {
    variables: Record<string, any> | FormData,
 }

-export type ClientResponse<Data extends Record<string, any>> = Readonly<Response & {
-    data: Data;
-}>
+export type ClientResponse<Data extends Record<string, any>> = Readonly<
+    Pick<Response, 'ok' | 'redirected' | 'status' | 'statusText' | 'type' | 'headers' | 'url'>
+    & { data: Data }
+>

 export class Client {
    constructor(private config: ClientConfig) {}
@ -65,7 +66,25 @@ export class Client {

        return fetch(req)
            // TODO: need to check response headers and parse json only if content-type header is application/json
-            .then(res => Promise.all([res, res.json()]))
-            .then(([res, data]) => ({ ...res, data }));
+            .then(res => Promise.all([res, res.json(), false]))
+            .then(([res, data]) => {
+                return {
+                    ok: res.ok,
+                    redirected: res.redirected,
+                    status: res.status,
+                    statusText: res.statusText,
+                    type: res.type,
+                    headers: res.headers,
+                    url: res.url,
+                    data
+                };
+            })
+            .then((res) => {
+                if (!res.ok) {
+                    throw res;
+                }
+
+                return res;
+            });
    }
 }
--- a/src/lazy-request-hook.ts
+++ b/src/lazy-request-hook.ts
@ -5,12 +5,14 @@ import { useClient } from './client-hook';
 import { Endpoint } from './endpoint';
 import { PublicRequestState, RequestAction, requestReducer, RequestState } from './reducer';
 import { useRequestContext } from './request-context';
+import { ClientResponse } from './client';

 export type LazyRequestConfig<R, V, P = void> = Readonly<{
    variables?: V;
    params?: P;
    headers?: Record<string, string>;
    onComplete?: (data: R) => unknown;
+    onFailure?: (res: ClientResponse<R>) => unknown;
 }>

 export type LazyRequestHandlerConfig<R, V, P> = Readonly<
@ -77,6 +79,7 @@ export function useLazyRequest<R = Record<string, any>, V = Record<string, any>,
            }

            const onComplete = config?.onComplete ?? handlerConfig?.onComplete;
+            const onFailure = handlerConfig?.onFailure ?? config?.onFailure;

            dispatch({ type: 'call', headers, variables, params });

@ -97,7 +100,10 @@ export function useLazyRequest<R = Record<string, any>, V = Record<string, any>,
                    },
                    (response) => {
                        dispatch({ type: 'failure', response });
-                        throw response;
+                        if (typeof onFailure === 'function') {
+                            onFailure(response);
+                        }
+                        return null;
                    }
                );
        },