fix: not sending status on non-revalidated queries

stargazers-co-ltd · Sep 16, 2023 · e2e49da · e2e49da
1 parent 579f90b
commit e2e49da
Show file tree

Hide file tree

Showing 22 changed files with 381 additions and 58 deletions.
diff --git a/.changeset/curly-birds-impress.md b/.changeset/curly-birds-impress.md
@@ -0,0 +1,5 @@
+---
+'swr-loader': patch
+---
+
+Fix: status would be missing for non-revalidated fresh responses
diff --git a/.changeset/sweet-pants-do.md b/.changeset/sweet-pants-do.md
@@ -0,0 +1,5 @@
+---
+'swr-loader': patch
+---
+
+Add example for vite + react
diff --git a/README.md b/README.md
@@ -52,6 +52,8 @@ const loader = makeLoader(async () => {
 > **Note**
 > You will have to `await` swr so that the ui-blocking part can be resolved (the cache) prior to rendering, but the fresh data will still be sent as an unfulfilled promise.
 
+See the full example [here](/examples/vite-react).
+
 // automatically handles cached data, loading states, and errors, obeys `onError` behaviour
 const Component = () => {
     const { posts } = useLoaderData<typeof loader>();

diff --git a/bun.lockb b/bun.lockb
diff --git a/examples/vite-react/.eslintrc.cjs b/examples/vite-react/.eslintrc.cjs
@@ -0,0 +1,18 @@
+module.exports = {
+  root: true,
+  env: { browser: true, es2020: true },
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:react-hooks/recommended',
+  ],
+  ignorePatterns: ['dist', '.eslintrc.cjs'],
+  parser: '@typescript-eslint/parser',
+  plugins: ['react-refresh'],
+  rules: {
+    'react-refresh/only-export-components': [
+      'warn',
+      { allowConstantExport: true },
+    ],
+  },
+}
diff --git a/examples/vite-react/.gitignore b/examples/vite-react/.gitignore
@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
diff --git a/examples/vite-react/bun.lockb b/examples/vite-react/bun.lockb
diff --git a/examples/vite-react/index.html b/examples/vite-react/index.html
@@ -0,0 +1,12 @@
+<!doctype html>
+<html lang="en">
+	<head>
+		<meta charset="UTF-8" />
+		<meta name="viewport" content="width=device-width, initial-scale=1.0" />
+		<title>SWR Loader ✦ React + TS</title>
+	</head>
+	<body>
+		<div id="root"></div>
+		<script type="module" src="/src/main.tsx"></script>
+	</body>
+</html>
diff --git a/examples/vite-react/package.json b/examples/vite-react/package.json
@@ -0,0 +1,34 @@
+{
+  "name": "vite",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "localforage": "^1.10.0",
+    "match-sorter": "^6.3.1",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-router-dom": "^6.16.0",
+    "react-router-typesafe": "^1.2.0",
+    "sort-by": "^1.2.0",
+    "swr-loader": "^0.1.2"
+  },
+  "devDependencies": {
+    "@types/react": "^18.2.15",
+    "@types/react-dom": "^18.2.7",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "@vitejs/plugin-react": "^4.0.3",
+    "eslint": "^8.45.0",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-react-refresh": "^0.4.3",
+    "typescript": "^5.0.2",
+    "vite": "^4.4.5"
+  }
+}
diff --git a/examples/vite-react/src/app.css b/examples/vite-react/src/app.css
@@ -0,0 +1,42 @@
+#root {
+  max-width: 1280px;
+  margin: 0 auto;
+  padding: 2rem;
+  text-align: center;
+}
+
+.logo {
+  height: 6em;
+  padding: 1.5em;
+  will-change: filter;
+  transition: filter 300ms;
+}
+.logo:hover {
+  filter: drop-shadow(0 0 2em #646cffaa);
+}
+.logo.react:hover {
+  filter: drop-shadow(0 0 2em #61dafbaa);
+}
+
+@keyframes logo-spin {
+  from {
+    transform: rotate(0deg);
+  }
+  to {
+    transform: rotate(360deg);
+  }
+}
+
+@media (prefers-reduced-motion: no-preference) {
+  a:nth-of-type(2) .logo {
+    animation: logo-spin infinite 20s linear;
+  }
+}
+
+.card {
+  padding: 2em;
+}
+
+.read-the-docs {
+  color: #888;
+}
diff --git a/examples/vite-react/src/app.loader.ts b/examples/vite-react/src/app.loader.ts
@@ -0,0 +1,13 @@
+import { defer, makeLoader } from 'react-router-typesafe';
+import { swr } from './cache';
+
+const getDemoData = async () => {
+	await new Promise(resolve => setTimeout(resolve, 1000 * 2));
+	return { message: 'I was fetched at ' + new Date().toISOString() };
+};
+
+export const loader = makeLoader(async () => {
+	return defer({
+		demo: await swr({ cacheKey: ['demo'], maxAge: 1000 * 10, onError: 'throw', fetchFn: getDemoData }),
+	});
+});
diff --git a/examples/vite-react/src/app.tsx b/examples/vite-react/src/app.tsx
@@ -0,0 +1,28 @@
+import { useLoaderData } from 'react-router-typesafe';
+import { SWR } from 'swr-loader';
+import './App.css';
+import { loader } from './app.loader';
+
+function App() {
+	const { demo } = useLoaderData<typeof loader>();
+
+	return (
+		<main>
+			<h1>SWR Loader on Vite + React</h1>
+			<div className="card">
+				<SWR data={demo} loadingElement={'Loading…'} errorElement={'Error!'}>
+					{demo => {
+						return (
+							<dl>
+								<dt>{demo.data.message}</dt>
+								<dd>Data is: {demo.status}</dd>
+							</dl>
+						);
+					}}
+				</SWR>
+			</div>
+		</main>
+	);
+}
+
+export default App;
diff --git a/examples/vite-react/src/cache.ts b/examples/vite-react/src/cache.ts
@@ -0,0 +1,8 @@
+import { createSWR } from 'swr-loader';
+import { createIDBAdapter } from 'swr-loader/adapters/idb';
+
+const idbAdapter = createIDBAdapter({ dbName: 'demo', storeName: 'data_cache' });
+
+export const { swr, invalidate } = createSWR({
+	cacheAdapter: idbAdapter,
+});
diff --git a/examples/vite-react/src/index.css b/examples/vite-react/src/index.css
@@ -0,0 +1,69 @@
+:root {
+  font-family: Inter, system-ui, Avenir, Helvetica, Arial, sans-serif;
+  line-height: 1.5;
+  font-weight: 400;
+
+  color-scheme: light dark;
+  color: rgba(255, 255, 255, 0.87);
+  background-color: #242424;
+
+  font-synthesis: none;
+  text-rendering: optimizeLegibility;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+  -webkit-text-size-adjust: 100%;
+}
+
+a {
+  font-weight: 500;
+  color: #646cff;
+  text-decoration: inherit;
+}
+a:hover {
+  color: #535bf2;
+}
+
+body {
+  margin: 0;
+  display: flex;
+  place-items: center;
+  min-width: 320px;
+  min-height: 100vh;
+}
+
+h1 {
+  font-size: 3.2em;
+  line-height: 1.1;
+}
+
+button {
+  border-radius: 8px;
+  border: 1px solid transparent;
+  padding: 0.6em 1.2em;
+  font-size: 1em;
+  font-weight: 500;
+  font-family: inherit;
+  background-color: #1a1a1a;
+  cursor: pointer;
+  transition: border-color 0.25s;
+}
+button:hover {
+  border-color: #646cff;
+}
+button:focus,
+button:focus-visible {
+  outline: 4px auto -webkit-focus-ring-color;
+}
+
+@media (prefers-color-scheme: light) {
+  :root {
+    color: #213547;
+    background-color: #ffffff;
+  }
+  a:hover {
+    color: #747bff;
+  }
+  button {
+    background-color: #f9f9f9;
+  }
+}
diff --git a/examples/vite-react/src/main.tsx b/examples/vite-react/src/main.tsx
@@ -0,0 +1,20 @@
+import React from 'react';
+import ReactDOM from 'react-dom/client';
+import { RouterProvider, createBrowserRouter } from 'react-router-dom';
+import App from './app';
+import { loader } from './app.loader';
+import './index.css';
+
+const router = createBrowserRouter([
+	{
+		path: '/',
+		element: <App />,
+		loader,
+	},
+]);
+
+ReactDOM.createRoot(document.getElementById('root')!).render(
+	<React.StrictMode>
+		<RouterProvider router={router} />
+	</React.StrictMode>,
+);
diff --git a/examples/vite-react/src/vite-env.d.ts b/examples/vite-react/src/vite-env.d.ts
@@ -0,0 +1 @@
+/// <reference types="vite/client" />
diff --git a/examples/vite-react/tsconfig.json b/examples/vite-react/tsconfig.json
@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "useDefineForClassFields": true,
+    "lib": ["ES2020", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
+    "skipLibCheck": true,
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true,
+    "jsx": "react-jsx",
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "include": ["src"],
+  "references": [{ "path": "./tsconfig.node.json" }]
+}
diff --git a/examples/vite-react/tsconfig.node.json b/examples/vite-react/tsconfig.node.json
@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "composite": true,
+    "skipLibCheck": true,
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "allowSyntheticDefaultImports": true
+  },
+  "include": ["vite.config.ts"]
+}
diff --git a/examples/vite-react/vite.config.ts b/examples/vite-react/vite.config.ts
@@ -0,0 +1,7 @@
+import { defineConfig } from 'vite'
+import react from '@vitejs/plugin-react'
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  plugins: [react()],
+})