Skip to content

Commit

Permalink
Merge pull request #48 from sskmy1024y/feat/type-support-when-use-sus…
Browse files Browse the repository at this point in the history 
…pense

Support for type definition when using suspense
  • Loading branch information
@sannajammeh
sannajammeh authored Oct 6, 2023
2 parents 84054db + b2283bb commit 639b7ff
Show file tree
Hide file tree
Showing 4 changed files with 102 additions and 89 deletions.
9 changes: 6 additions & 3 deletions packages/client/src/createSWRProxyHooks.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,15 @@ type DecorateProcedure<
TPath extends string
> = TProcedure extends AnyQueryProcedure
? {
useSWR: <TData = inferProcedureOutput<TProcedure>>(
useSWR: <
TData = inferProcedureOutput<TProcedure>,
TConfig extends SWRConfiguration<TData> = {}
>(
input: inferProcedureInput<TProcedure>,
opts?: SWRConfiguration<TData> & {
opts?: TConfig & {
isDisabled?: boolean;
}
) => SWRResponse<TData, TRPCClientErrorLike<TProcedure>>;
) => SWRResponse<TData, TRPCClientErrorLike<TProcedure>, TConfig>;

preload: (input: inferProcedureInput<TProcedure>) => Promise<void>;
getKey: GetKey<TProcedure, TPath>;
Expand Down
2 changes: 1 addition & 1 deletion test/unit/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"private": true,
"scripts": {
"run-test": "vitest run",
"test": "vitest run 2>&1 | tee tap.txt",
"test": "tsc --noEmit && vitest run 2>&1 | tee tap.txt",
"test:ui": "vitest --ui"
},
"keywords": [],
Expand Down
12 changes: 11 additions & 1 deletion test/unit/tests/query.spec.tsx
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { useState } from "react";
import { act } from "react-dom/test-utils";
import { expect, it } from "vitest";
import { expect, expectTypeOf, it } from "vitest";
import { render, screen, trpc, waitFor } from "../utils";

it("makes query without args", async () => {
Expand Down Expand Up @@ -65,3 +65,13 @@ it("makes conditional query", async () => {
expect(screen.getByText("disabled")).toBeInTheDocument();
});
});

it("Allows correct types during suspense", async () => {
() => {
const { data } = trpc.hello.useSWR(void 0, { suspense: true});

expectTypeOf(data).toBeString();

return <p>{data}</p>;
};
})
168 changes: 84 additions & 84 deletions test/unit/tests/ssg.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,108 +4,108 @@ import { unstable_serialize as swr_unstable_serialize } from "swr";
import { appRouter } from "../utils";
import { test, describe } from "vitest";

describe("unstable_serialize", async (t) => {
await test("Should serialize a string key", () => {
assert.equal(unstable_serialize("/api/users"), "/api/users");
assert.equal(
unstable_serialize("01GXTWZRVVFX1VDV8FC46S9280"),
"01GXTWZRVVFX1VDV8FC46S9280",
);
});

await test("Should serialize an array key", () => {
assert.equal(unstable_serialize(["/api/users"]), `@"/api/users",`);
});

await test("Should serialize an object key", () => {
assert.equal(unstable_serialize({ id: 1 }), "#id:1,");
});

await test("Should match SWR serialization for string", () => {
assert.equal(
unstable_serialize("/api/users"),
swr_unstable_serialize("/api/users"),
);
});

await test("Should match SWR serialization for array", () => {
assert.equal(
unstable_serialize(["/api/users"]),
swr_unstable_serialize(["/api/users"]),
);
});

await test("Should match SWR serialization for object", () => {
assert.equal(
unstable_serialize({ id: 1 }),
swr_unstable_serialize({ id: 1 }),
);
});

await test("Should match SWR serialization for object with array", () => {
assert.equal(
unstable_serialize({ id: 1, arr: [1, 2, 3] }),
swr_unstable_serialize({ id: 1, arr: [1, 2, 3] }),
);
});

await test("Should match SWR serialization for array with object and string", () => {
assert.equal(
unstable_serialize([1, { id: 1 }, "test"]),
swr_unstable_serialize([1, { id: 1 }, "test"]),
);
});
describe("unstable_serialize", async () => {
await test("Should serialize a string key", () => {
assert.equal(unstable_serialize("/api/users"), "/api/users");
assert.equal(
unstable_serialize("01GXTWZRVVFX1VDV8FC46S9280"),
"01GXTWZRVVFX1VDV8FC46S9280"
);
});

await test("Should serialize an array key", () => {
assert.equal(unstable_serialize(["/api/users"]), `@"/api/users",`);
});

await test("Should serialize an object key", () => {
assert.equal(unstable_serialize({ id: 1 }), "#id:1,");
});

await test("Should match SWR serialization for string", () => {
assert.equal(
unstable_serialize("/api/users"),
swr_unstable_serialize("/api/users")
);
});

await test("Should match SWR serialization for array", () => {
assert.equal(
unstable_serialize(["/api/users"]),
swr_unstable_serialize(["/api/users"])
);
});

await test("Should match SWR serialization for object", () => {
assert.equal(
unstable_serialize({ id: 1 }),
swr_unstable_serialize({ id: 1 })
);
});

await test("Should match SWR serialization for object with array", () => {
assert.equal(
unstable_serialize({ id: 1, arr: [1, 2, 3] }),
swr_unstable_serialize({ id: 1, arr: [1, 2, 3] })
);
});

await test("Should match SWR serialization for array with object and string", () => {
assert.equal(
unstable_serialize([1, { id: 1 }, "test"]),
swr_unstable_serialize([1, { id: 1 }, "test"])
);
});
});

const createSSG = () => {
return createProxySSGHelpers({
router: appRouter,
ctx: {} as any,
});
return createProxySSGHelpers({
router: appRouter,
ctx: {} as any,
});
};

describe("createProxySSGHelpers", async (t) => {
await test("Should return a proxy object", () => {
const ssg = createSSG();
describe("createProxySSGHelpers", async () => {
await test("Should return a proxy object", () => {
const ssg = createSSG();

assert.equal(typeof ssg, "function");
});
assert.equal(typeof ssg, "function");
});

await test("Should access route", async () => {
const ssg = createSSG();
const expected_key = '@"hello",';
assert.equal(typeof ssg.hello, "function");
await test("Should access route", async () => {
const ssg = createSSG();
const expected_key = '@"hello",';
assert.equal(typeof ssg.hello, "function");

assert.equal(ssg.hello.getKey(), expected_key);
});
assert.equal(ssg.hello.getKey(), expected_key);
});

await test("Should fetch from procedure", async () => {
const ssg = createSSG();
await test("Should fetch from procedure", async () => {
const ssg = createSSG();

const result = await ssg.hello.fetch();
const result = await ssg.hello.fetch();

assert.equal(result, "world");
});
assert.equal(result, "world");
});

await test("Should dehydrate from procedure when paralell fetch", async () => {
const ssg = createSSG();
await test("Should dehydrate from procedure when paralell fetch", async () => {
const ssg = createSSG();

ssg.hello.fetch();
ssg.hello.fetch();

const result = await ssg.dehydrate();
const result = await ssg.dehydrate();

assert.deepEqual(result, { [ssg.hello.getKey()]: "world" });
});
assert.deepEqual(result, { [ssg.hello.getKey()]: "world" });
});

await test("Should dehydrate from procedure", async () => {
const ssg = createSSG();
await test("Should dehydrate from procedure", async () => {
const ssg = createSSG();

const fetchResult = await ssg.hello.fetch();
const fetchResult = await ssg.hello.fetch();

assert.equal(fetchResult, "world");
assert.equal(fetchResult, "world");

const result = await ssg.dehydrate();
const result = await ssg.dehydrate();

assert.deepEqual(result, { [ssg.hello.getKey()]: "world" });
});
assert.deepEqual(result, { [ssg.hello.getKey()]: "world" });
});
});

1 comment on commit 639b7ff

@vercel
Copy link

@vercel vercel bot commented on 639b7ff Oct 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

trpc-swr – ./

trpc-swr.vercel.app
trpc-swr-sannajammeh.vercel.app
trpc-swr-git-main-sannajammeh.vercel.app

Please sign in to comment.