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

Stabilize unstable_dataStrategy #11969

Merged
merged 3 commits into from
Sep 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/violet-beds-swim.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"react-router": minor
---

Stabilize `unstable_dataStrategy`
4 changes: 2 additions & 2 deletions integration/defer-loader-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ test.describe("deferred loaders", () => {
`,

"app/routes/redirect.tsx": js`
import { unstable_data } from 'react-router';
import { data } from 'react-router';
export function loader() {
return unstable_data(
return data(
{ food: "pizza" },
{
status: 301,
Expand Down
18 changes: 9 additions & 9 deletions integration/single-fetch-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ const files = {
`,

"app/routes/data-with-response.tsx": js`
import { useActionData, useLoaderData, unstable_data as data } from "react-router";
import { useActionData, useLoaderData, data } from "react-router";

export function headers ({ actionHeaders, loaderHeaders, errorHeaders }) {
if ([...actionHeaders].length > 0) {
Expand Down Expand Up @@ -253,7 +253,7 @@ test.describe("single-fetch", () => {
});
});

test("loads proper data (via unstable_data) on single fetch loader requests", async () => {
test("loads proper data (via data()) on single fetch loader requests", async () => {
let fixture = await createFixture({
files,
});
Expand All @@ -280,7 +280,7 @@ test.describe("single-fetch", () => {
});
});

test("loads proper data (via unstable_data) on single fetch action requests", async () => {
test("loads proper data (via data()) on single fetch action requests", async () => {
let fixture = await createFixture({
files,
});
Expand Down Expand Up @@ -505,28 +505,28 @@ test.describe("single-fetch", () => {
expect(urls).toEqual([]);
});

test("does not revalidate on 4xx/5xx action responses (via unstable_data)", async ({
test("does not revalidate on 4xx/5xx action responses (via data())", async ({
page,
}) => {
let fixture = await createFixture({
files: {
...files,
"app/routes/action.tsx": js`
import { Form, Link, useActionData, useLoaderData, useNavigation, unstable_data } from 'react-router';
import { Form, Link, useActionData, useLoaderData, useNavigation, data } from 'react-router';

export async function action({ request }) {
let fd = await request.formData();
if (fd.get('throw') === "5xx") {
throw unstable_data("Thrown 500", { status: 500 });
throw data("Thrown 500", { status: 500 });
}
if (fd.get('throw') === "4xx") {
throw unstable_data("Thrown 400", { status: 400 });
throw data("Thrown 400", { status: 400 });
}
if (fd.get('return') === "5xx") {
return unstable_data("Returned 500", { status: 500 });
return data("Returned 500", { status: 500 });
}
if (fd.get('return') === "4xx") {
return unstable_data("Returned 400", { status: 400 });
return data("Returned 400", { status: 400 });
}
return null;
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3292,7 +3292,7 @@ describe("createMemoryRouter", () => {
/>
</Route>
),
{ initialEntries: ["/foo"], unstable_dataStrategy: urlDataStrategy }
{ initialEntries: ["/foo"], dataStrategy: urlDataStrategy }
);
let { container } = render(<RouterProvider router={router} />);

Expand Down
4 changes: 2 additions & 2 deletions packages/react-router/__tests__/router/ssr-test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1403,7 +1403,7 @@ describe("ssr", () => {
let { query } = createStaticHandler(SSR_ROUTES);

let context = await query(createRequest("/custom"), {
unstable_dataStrategy: urlDataStrategy,
dataStrategy: urlDataStrategy,
});
expect(context).toMatchObject({
actionData: null,
Expand Down Expand Up @@ -2251,7 +2251,7 @@ describe("ssr", () => {
let data;

data = await queryRoute(createRequest("/custom"), {
unstable_dataStrategy: urlDataStrategy,
dataStrategy: urlDataStrategy,
});
expect(data).toBeInstanceOf(URLSearchParams);
expect((data as URLSearchParams).get("foo")).toBe("bar");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,7 @@ export function setup({
routes: enhanceRoutes(routes),
hydrationData,
window: testWindow,
unstable_dataStrategy: dataStrategy,
dataStrategy: dataStrategy,
});

let fetcherData = getFetcherData(currentRouter);
Expand Down
10 changes: 5 additions & 5 deletions packages/react-router/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ export type {
export type {
ActionFunction,
ActionFunctionArgs,
DataStrategyFunction as unstable_DataStrategyFunction,
DataStrategyFunctionArgs as unstable_DataStrategyFunctionArgs,
DataStrategyMatch as unstable_DataStrategyMatch,
DataStrategyResult as unstable_DataStrategyResult,
DataStrategyFunction,
DataStrategyFunctionArgs,
DataStrategyMatch,
DataStrategyResult,
DataWithResponseInit as UNSAFE_DataWithResponseInit,
ErrorResponse,
FormEncType,
Expand Down Expand Up @@ -58,7 +58,7 @@ export {
IDLE_BLOCKER,
} from "./lib/router/router";
export {
data as unstable_data,
data,
generatePath,
isRouteErrorResponse,
json,
Expand Down
4 changes: 2 additions & 2 deletions packages/react-router/lib/components.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ export function createMemoryRouter(
hydrationData?: HydrationState;
initialEntries?: InitialEntry[];
initialIndex?: number;
unstable_dataStrategy?: DataStrategyFunction;
dataStrategy?: DataStrategyFunction;
patchRoutesOnNavigation?: PatchRoutesOnNavigationFunction;
}
): RemixRouter {
Expand All @@ -158,7 +158,7 @@ export function createMemoryRouter(
hydrationData: opts?.hydrationData,
routes,
mapRouteProperties,
unstable_dataStrategy: opts?.unstable_dataStrategy,
dataStrategy: opts?.dataStrategy,
patchRoutesOnNavigation: opts?.patchRoutesOnNavigation,
}).initialize();
}
Expand Down
2 changes: 1 addition & 1 deletion packages/react-router/lib/dom-export/hydrated-router.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ function createHydratedRouter(): RemixRouter {
basename: ssrInfo.context.basename,
hydrationData,
mapRouteProperties,
unstable_dataStrategy: getSingleFetchDataStrategy(
dataStrategy: getSingleFetchDataStrategy(
ssrInfo.manifest,
ssrInfo.routeModules,
() => router
Expand Down
6 changes: 3 additions & 3 deletions packages/react-router/lib/dom/lib.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ interface DOMRouterOpts {
basename?: string;
future?: Partial<FutureConfig>;
hydrationData?: HydrationState;
unstable_dataStrategy?: DataStrategyFunction;
dataStrategy?: DataStrategyFunction;
patchRoutesOnNavigation?: PatchRoutesOnNavigationFunction;
window?: Window;
}
Expand All @@ -141,7 +141,7 @@ export function createBrowserRouter(
hydrationData: opts?.hydrationData || parseHydrationData(),
routes,
mapRouteProperties,
unstable_dataStrategy: opts?.unstable_dataStrategy,
dataStrategy: opts?.dataStrategy,
patchRoutesOnNavigation: opts?.patchRoutesOnNavigation,
window: opts?.window,
}).initialize();
Expand All @@ -161,7 +161,7 @@ export function createHashRouter(
hydrationData: opts?.hydrationData || parseHydrationData(),
routes,
mapRouteProperties,
unstable_dataStrategy: opts?.unstable_dataStrategy,
dataStrategy: opts?.dataStrategy,
patchRoutesOnNavigation: opts?.patchRoutesOnNavigation,
window: opts?.window,
}).initialize();
Expand Down
2 changes: 1 addition & 1 deletion packages/react-router/lib/dom/ssr/single-fetch.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ async function singleFetchActionStrategy(
return { [actionMatch.route.id]: result };
}

// For non-responses, proxy along the statusCode via unstable_data()
// For non-responses, proxy along the statusCode via data()
// (most notably for skipping action error revalidation)
return {
[actionMatch.route.id]: {
Expand Down
44 changes: 22 additions & 22 deletions packages/react-router/lib/router/router.ts
Original file line number Diff line number Diff line change
Expand Up @@ -369,8 +369,8 @@ export interface RouterInit {
future?: Partial<FutureConfig>;
hydrationData?: HydrationState;
window?: Window;
dataStrategy?: DataStrategyFunction;
patchRoutesOnNavigation?: AgnosticPatchRoutesOnNavigationFunction;
unstable_dataStrategy?: DataStrategyFunction;
}

/**
Expand Down Expand Up @@ -399,15 +399,15 @@ export interface StaticHandler {
opts?: {
requestContext?: unknown;
skipLoaderErrorBubbling?: boolean;
unstable_dataStrategy?: DataStrategyFunction;
dataStrategy?: DataStrategyFunction;
}
): Promise<StaticHandlerContext | Response>;
queryRoute(
request: Request,
opts?: {
routeId?: string;
requestContext?: unknown;
unstable_dataStrategy?: DataStrategyFunction;
dataStrategy?: DataStrategyFunction;
}
): Promise<any>;
}
Expand Down Expand Up @@ -808,7 +808,7 @@ export function createRouter(init: RouterInit): Router {
);
let inFlightDataRoutes: AgnosticDataRouteObject[] | undefined;
let basename = init.basename || "/";
let dataStrategyImpl = init.unstable_dataStrategy || defaultDataStrategy;
let dataStrategyImpl = init.dataStrategy || defaultDataStrategy;
let patchRoutesOnNavigationImpl = init.patchRoutesOnNavigation;

// Config driven behavior flags
Expand Down Expand Up @@ -3410,11 +3410,11 @@ export function createStaticHandler(
{
requestContext,
skipLoaderErrorBubbling,
unstable_dataStrategy,
dataStrategy,
}: {
requestContext?: unknown;
skipLoaderErrorBubbling?: boolean;
unstable_dataStrategy?: DataStrategyFunction;
dataStrategy?: DataStrategyFunction;
} = {}
): Promise<StaticHandlerContext | Response> {
let url = new URL(request.url);
Expand Down Expand Up @@ -3464,7 +3464,7 @@ export function createStaticHandler(
location,
matches,
requestContext,
unstable_dataStrategy || null,
dataStrategy || null,
skipLoaderErrorBubbling === true,
null
);
Expand Down Expand Up @@ -3509,11 +3509,11 @@ export function createStaticHandler(
{
routeId,
requestContext,
unstable_dataStrategy,
dataStrategy,
}: {
requestContext?: unknown;
routeId?: string;
unstable_dataStrategy?: DataStrategyFunction;
dataStrategy?: DataStrategyFunction;
} = {}
): Promise<any> {
let url = new URL(request.url);
Expand Down Expand Up @@ -3547,7 +3547,7 @@ export function createStaticHandler(
location,
matches,
requestContext,
unstable_dataStrategy || null,
dataStrategy || null,
false,
match
);
Expand Down Expand Up @@ -3582,7 +3582,7 @@ export function createStaticHandler(
location: Location,
matches: AgnosticDataRouteMatch[],
requestContext: unknown,
unstable_dataStrategy: DataStrategyFunction | null,
dataStrategy: DataStrategyFunction | null,
skipLoaderErrorBubbling: boolean,
routeMatch: AgnosticDataRouteMatch | null
): Promise<Omit<StaticHandlerContext, "location" | "basename"> | Response> {
Expand All @@ -3598,7 +3598,7 @@ export function createStaticHandler(
matches,
routeMatch || getTargetMatch(matches, location),
requestContext,
unstable_dataStrategy,
dataStrategy,
skipLoaderErrorBubbling,
routeMatch != null
);
Expand All @@ -3609,7 +3609,7 @@ export function createStaticHandler(
request,
matches,
requestContext,
unstable_dataStrategy,
dataStrategy,
skipLoaderErrorBubbling,
routeMatch
);
Expand Down Expand Up @@ -3644,7 +3644,7 @@ export function createStaticHandler(
matches: AgnosticDataRouteMatch[],
actionMatch: AgnosticDataRouteMatch,
requestContext: unknown,
unstable_dataStrategy: DataStrategyFunction | null,
dataStrategy: DataStrategyFunction | null,
skipLoaderErrorBubbling: boolean,
isRouteRequest: boolean
): Promise<Omit<StaticHandlerContext, "location" | "basename"> | Response> {
Expand All @@ -3671,7 +3671,7 @@ export function createStaticHandler(
matches,
isRouteRequest,
requestContext,
unstable_dataStrategy
dataStrategy
);
result = results[actionMatch.route.id];

Expand Down Expand Up @@ -3731,7 +3731,7 @@ export function createStaticHandler(
loaderRequest,
matches,
requestContext,
unstable_dataStrategy,
dataStrategy,
skipLoaderErrorBubbling,
null,
[boundaryMatch.route.id, result]
Expand All @@ -3756,7 +3756,7 @@ export function createStaticHandler(
loaderRequest,
matches,
requestContext,
unstable_dataStrategy,
dataStrategy,
skipLoaderErrorBubbling,
null
);
Expand All @@ -3778,7 +3778,7 @@ export function createStaticHandler(
request: Request,
matches: AgnosticDataRouteMatch[],
requestContext: unknown,
unstable_dataStrategy: DataStrategyFunction | null,
dataStrategy: DataStrategyFunction | null,
skipLoaderErrorBubbling: boolean,
routeMatch: AgnosticDataRouteMatch | null,
pendingActionResult?: PendingActionResult
Expand Down Expand Up @@ -3840,7 +3840,7 @@ export function createStaticHandler(
matches,
isRouteRequest,
requestContext,
unstable_dataStrategy
dataStrategy
);

if (request.signal.aborted) {
Expand Down Expand Up @@ -3880,10 +3880,10 @@ export function createStaticHandler(
matches: AgnosticDataRouteMatch[],
isRouteRequest: boolean,
requestContext: unknown,
unstable_dataStrategy: DataStrategyFunction | null
dataStrategy: DataStrategyFunction | null
): Promise<Record<string, DataResult>> {
let results = await callDataStrategyImpl(
unstable_dataStrategy || defaultDataStrategy,
dataStrategy || defaultDataStrategy,
type,
null,
request,
Expand Down Expand Up @@ -4867,7 +4867,7 @@ async function convertDataStrategyResultToDataResult(
};
}

// Convert thrown unstable_data() to ErrorResponse instances
// Convert thrown data() to ErrorResponse instances
result = new ErrorResponseImpl(
result.init?.status || 500,
undefined,
Expand Down
Loading