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

🖥️ Support Server Actions #11061

Draft
wants to merge 21 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
17a7589
feat: integrate react-dom's useFormState with rhf's useFormState
kotarella1110 Oct 17, 2023
21c13aa
feat: add createServerActionsValidator for Server Actions
kotarella1110 Oct 17, 2023
ec8e19e
feat: change the onValid argument of handleSubmit to optional
kotarella1110 Oct 17, 2023
24d2369
build: add logic and utils to conditional exports
kotarella1110 Oct 18, 2023
c1a8ae6
chore: add server actions example
kotarella1110 Oct 18, 2023
abfe716
chore: improve server actions example
kotarella1110 Oct 19, 2023
4c20e47
feat: move actionFormState to defaultErrors prop
kotarella1110 Oct 19, 2023
fab9321
feat: include values in ServerActionsValidator response
kotarella1110 Oct 19, 2023
d74d9e2
feat: add errors prop to useForm
kotarella1110 Oct 19, 2023
a827066
chore: update example
kotarella1110 Oct 19, 2023
f3233cd
chore: remove tailwindcss from server-actions example
kotarella1110 Oct 21, 2023
0d12208
chore: add remix form example
kotarella1110 Oct 21, 2023
dbe0fef
chore: update remix-form example
kotarella1110 Oct 21, 2023
9568349
chore: update remix-form example
kotarella1110 Oct 21, 2023
2186610
chore: update remix-form example
kotarella1110 Oct 21, 2023
15bd573
feat: rename createServerActionsValidator to createActionValidator
kotarella1110 Oct 21, 2023
7bd5060
feat: rename createServerActionsValidator to createActionValidator
kotarella1110 Oct 21, 2023
ef17e17
chore: resolve conflicts
kotarella1110 Nov 8, 2023
ca6e9b0
Execute preventDefault only on invalid in handleSubmit for progressiv…
kotarella1110 Nov 10, 2023
47d2a0f
chore: resolve conflicts
kotarella1110 Nov 14, 2023
7e89c13
chore: resolve conflicts
kotarella1110 Dec 7, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
31 changes: 31 additions & 0 deletions examples/remix-form/.codesandbox/tasks.json
@@ -0,0 +1,31 @@
{
// These tasks will run in order when initializing your CodeSandbox project.
"setupTasks": [
{
"name": "Install Dependencies",
"command": "pnpm install"
}
],

// These tasks can be run from CodeSandbox. Running one will open a log in the app.
"tasks": {
"build": {
"name": "build",
"command": "pnpm build",
"runAtStart": false
},
"dev": {
"name": "dev",
"command": "pnpm dev",
"runAtStart": true,
"preview": {
"port": 3000
}
},
"start": {
"name": "start",
"command": "pnpm start",
"runAtStart": false
}
}
}
2 changes: 2 additions & 0 deletions examples/remix-form/.devcontainer/Dockerfile
@@ -0,0 +1,2 @@
FROM node:18
RUN npm install -g pnpm
6 changes: 6 additions & 0 deletions examples/remix-form/.devcontainer/devcontainer.json
@@ -0,0 +1,6 @@
{
"name": "Devcontainer",
"build": {
"dockerfile": "./Dockerfile"
}
}
4 changes: 4 additions & 0 deletions examples/remix-form/.eslintrc.cjs
@@ -0,0 +1,4 @@
/** @type {import('eslint').Linter.Config} */
module.exports = {
extends: ["@remix-run/eslint-config", "@remix-run/eslint-config/node"],
};
6 changes: 6 additions & 0 deletions examples/remix-form/.gitignore
@@ -0,0 +1,6 @@
node_modules

/.cache
/build
/public/build
.env
18 changes: 18 additions & 0 deletions examples/remix-form/app/entry.client.tsx
@@ -0,0 +1,18 @@
/**
* By default, Remix will handle hydrating your app on the client for you.
* You are free to delete this file if you'd like to, but if you ever want it revealed again, you can run `npx remix reveal` ✨
* For more information, see https://remix.run/file-conventions/entry.client
*/

import { RemixBrowser } from '@remix-run/react';
import { startTransition, StrictMode } from 'react';
import { hydrateRoot } from 'react-dom/client';

startTransition(() => {
hydrateRoot(
document,
<StrictMode>
<RemixBrowser />
</StrictMode>,
);
});
137 changes: 137 additions & 0 deletions examples/remix-form/app/entry.server.tsx
@@ -0,0 +1,137 @@
/**
* By default, Remix will handle generating the HTTP Response for you.
* You are free to delete this file if you'd like to, but if you ever want it revealed again, you can run `npx remix reveal` ✨
* For more information, see https://remix.run/file-conventions/entry.server
*/

import { PassThrough } from 'node:stream';

import type { AppLoadContext, EntryContext } from '@remix-run/node';
import { createReadableStreamFromReadable } from '@remix-run/node';
import { RemixServer } from '@remix-run/react';
import isbot from 'isbot';
import { renderToPipeableStream } from 'react-dom/server';

const ABORT_DELAY = 5_000;

export default function handleRequest(
request: Request,
responseStatusCode: number,
responseHeaders: Headers,
remixContext: EntryContext,
loadContext: AppLoadContext,
) {
return isbot(request.headers.get('user-agent'))
? handleBotRequest(
request,
responseStatusCode,
responseHeaders,
remixContext,
)
: handleBrowserRequest(
request,
responseStatusCode,
responseHeaders,
remixContext,
);
}

function handleBotRequest(
request: Request,
responseStatusCode: number,
responseHeaders: Headers,
remixContext: EntryContext,
) {
return new Promise((resolve, reject) => {
let shellRendered = false;
const { pipe, abort } = renderToPipeableStream(
<RemixServer
context={remixContext}
url={request.url}
abortDelay={ABORT_DELAY}
/>,
{
onAllReady() {
shellRendered = true;
const body = new PassThrough();
const stream = createReadableStreamFromReadable(body);

responseHeaders.set('Content-Type', 'text/html');

resolve(
new Response(stream, {
headers: responseHeaders,
status: responseStatusCode,
}),
);

pipe(body);
},
onShellError(error: unknown) {
reject(error);
},
onError(error: unknown) {
responseStatusCode = 500;
// Log streaming rendering errors from inside the shell. Don't log
// errors encountered during initial shell rendering since they'll
// reject and get logged in handleDocumentRequest.
if (shellRendered) {
console.error(error);
}
},
},
);

setTimeout(abort, ABORT_DELAY);
});
}

function handleBrowserRequest(
request: Request,
responseStatusCode: number,
responseHeaders: Headers,
remixContext: EntryContext,
) {
return new Promise((resolve, reject) => {
let shellRendered = false;
const { pipe, abort } = renderToPipeableStream(
<RemixServer
context={remixContext}
url={request.url}
abortDelay={ABORT_DELAY}
/>,
{
onShellReady() {
shellRendered = true;
const body = new PassThrough();
const stream = createReadableStreamFromReadable(body);

responseHeaders.set('Content-Type', 'text/html');

resolve(
new Response(stream, {
headers: responseHeaders,
status: responseStatusCode,
}),
);

pipe(body);
},
onShellError(error: unknown) {
reject(error);
},
onError(error: unknown) {
responseStatusCode = 500;
// Log streaming rendering errors from inside the shell. Don't log
// errors encountered during initial shell rendering since they'll
// reject and get logged in handleDocumentRequest.
if (shellRendered) {
console.error(error);
}
},
},
);

setTimeout(abort, ABORT_DELAY);
});
}
35 changes: 35 additions & 0 deletions examples/remix-form/app/root.tsx
@@ -0,0 +1,35 @@
import { cssBundleHref } from '@remix-run/css-bundle';
import type { LinksFunction } from '@remix-run/node';
import {
Links,
LiveReload,
Meta,
Outlet,
Scripts,
ScrollRestoration,
} from '@remix-run/react';
import styles from '~/styles/globals.css';

export const links: LinksFunction = () => [
...(cssBundleHref ? [{ rel: 'stylesheet', href: cssBundleHref }] : []),
{ rel: 'stylesheet', href: styles },
];

export default function App() {
return (
<html lang="en">
<head>
<meta charSet="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<Meta />
<Links />
</head>
<body>
<Outlet />
<ScrollRestoration />
<Scripts />
<LiveReload />
</body>
</html>
);
}
110 changes: 110 additions & 0 deletions examples/remix-form/app/routes/_index.tsx
@@ -0,0 +1,110 @@
import type { MetaFunction, ActionFunctionArgs } from '@remix-run/node';
import { json } from '@remix-run/node';
import { Form, useActionData } from '@remix-run/react';
import { setTimeout } from 'timers/promises';
import { createActionValidator } from 'react-hook-form/server';
import { useForm } from 'react-hook-form';
import { zodResolverSync } from '../../node_modules/@hookform/resolvers/zod';
import { z } from 'zod';

export const meta: MetaFunction = () => {
return [
{ title: 'New Remix App' },
{ name: 'description', content: 'Welcome to Remix!' },
];
};

const schema = z.object({
username: z.string().min(1, 'Username is required'),
password: z.string().min(8, 'Password must be at least 8 characters'),
});

let count = 0;
const maxCount = 1;

export async function action({ request }: ActionFunctionArgs) {
const formData = await request.formData();

await setTimeout(1000);

const validator = createActionValidator(formData, {
resolver: zodResolverSync(schema),
});

await validator.validate();

if (!validator.isValid()) {
return json(validator.getResult());
}

if (Math.random() < 0.5) {
validator.setError('root.serverError', {
type: '409',
message: 'Username already exists. Please choose a different username.',
});
return json(validator.getResult());
}

if (Math.random() < 0.5) {
count++;
if (count > maxCount) {
validator.setError('root.serverError', {
type: '401',
message: 'Too many login attempts.',
});
return json(validator.getResult());
}

validator.setError('root.serverError', {
type: '401',
message: 'Invalid username or password.',
});
return json(validator.getResult());
}

if (Math.random() < 0.5) {
validator.setError('root.serverError', {
type: '500',
message: 'Internal server error. Please try again later.',
});
}

return json({ status: 200, message: 'Login successful!' });
}

export default function Index() {
const actionData = useActionData<typeof action>();
console.log('actionData', actionData);

const {
register,
handleSubmit,
formState: { errors },
} = useForm<{
username: string;
password: string;
}>({
resolver: zodResolverSync(schema),
defaultValues: actionData?.values || {
username: '',
password: '',
},
errors: actionData?.errors,
progressive: true,
});

console.log('errors', errors);

return (
<Form method="post" onSubmit={handleSubmit()}>
<label>Username</label>
<input {...register('username')} placeholder="Username" />
{errors.username && <p>{errors.username.message}</p>}
<label>Password</label>
<input {...register('password')} type="password" placeholder="Password" />
{errors.password && <p>{errors.password.message}</p>}
<input type="submit" />
{errors.root?.serverError && <p>{errors.root.serverError.message}</p>}
</Form>
);
}