Skip to content

Commit 1aa1c45

Browse files
ogroppoogroppo
authoredMay 22, 2022
Remove numeric casting for id param (#20)
* Remove numeric casting for id param * change * bomp ver * set for updates & isNumeric
1 parent e753d04 commit 1aa1c45

20 files changed

+202
-65
lines changed
 

‎apps/admin/ReactAdmin.tsx

+14-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
import { Admin, ListGuesser, Resource } from "react-admin";
2-
import { PostCreate, PostList } from "./resources/Post";
2+
import { PostCreate, PostEdit, PostList } from "./resources/Post";
33
import { TagCreate, TagList } from "./resources/Tag";
44
import { UserCreate, UserEdit, UserList, UserShow } from "./resources/User";
5-
import { AdminCreate, AdminList } from "./resources/Admin";
5+
import { AdminCreate, AdminList, AdminShow } from "./resources/Admin";
66
import { useSession, signIn, signOut } from "next-auth/react";
77
import { authProvider } from "./providers/authProvider";
88
import { dataProvider } from "./providers/dataProvider";
@@ -31,9 +31,19 @@ const ReactAdmin = () => {
3131
edit={UserEdit}
3232
show={UserShow}
3333
/>
34-
<Resource name="post" list={PostList} create={PostCreate} />
34+
<Resource
35+
name="post"
36+
list={PostList}
37+
create={PostCreate}
38+
edit={PostEdit}
39+
/>
3540
<Resource name="tag" list={TagList} create={TagCreate} />
36-
<Resource name="admin" list={AdminList} create={AdminCreate} />
41+
<Resource
42+
name="admin"
43+
list={AdminList}
44+
create={AdminCreate}
45+
show={AdminShow}
46+
/>
3747
<Resource
3848
name="category"
3949
list={CategoryList}

‎apps/admin/pages/api/admin.ts

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
import type { NextApiRequest, NextApiResponse } from "next";
22
import { defaultHandler } from "ra-data-simple-prisma";
3+
import { apiHandler } from "../../middlewares/apiHandler";
34
import { prismaAdminClient } from "../../prisma/prismaAdminClient";
45

5-
export default function handler(req: NextApiRequest, res: NextApiResponse) {
6+
export default apiHandler((req: NextApiRequest, res: NextApiResponse) => {
67
return defaultHandler(req, res, prismaAdminClient);
7-
}
8+
});

‎apps/admin/pages/api/post.ts

+21-3
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,14 @@ import {
44
getListHandler,
55
GetListRequest,
66
createHandler,
7+
GetOneRequest,
8+
getOneHandler,
9+
updateHandler,
710
} from "ra-data-simple-prisma";
11+
import { apiHandler } from "../../middlewares/apiHandler";
812
import { prismaWebClient } from "./../../../website/prisma/prismaWebClient";
913

10-
export default function handler(req: NextApiRequest, res: NextApiResponse) {
14+
export default apiHandler((req: NextApiRequest, res: NextApiResponse) => {
1115
switch (req.body.method) {
1216
case "create":
1317
return createHandler(req, res, prismaWebClient["post"], {
@@ -25,12 +29,26 @@ export default function handler(req: NextApiRequest, res: NextApiResponse) {
2529
transform: (posts: any[]) => {
2630
posts.forEach((post: any) => {
2731
post.tags = post.tags.map((tag: any) => tag.id);
32+
post._tags_count = post.tags.length;
2833
});
2934
},
3035
}
3136
);
32-
37+
case "getOne":
38+
return getOneHandler(req as GetOneRequest, res, prismaWebClient["post"], {
39+
include: { tags: true },
40+
transform: (post: any) => {
41+
post.tags = post.tags.map((tag: any) => tag.id);
42+
post._tags_count = post.tags.length;
43+
},
44+
});
45+
case "update":
46+
return updateHandler(req, res, prismaWebClient["post"], {
47+
set: {
48+
tags: "id",
49+
},
50+
});
3351
default:
3452
return defaultHandler(req, res, prismaWebClient);
3553
}
36-
}
54+
});

‎apps/admin/prisma/admin.local.db

0 Bytes
Binary file not shown.

‎apps/admin/resources/Admin.tsx

+8
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,11 @@ export const AdminList = (props: ListProps) => (
3737
</Datagrid>
3838
</List>
3939
);
40+
41+
export const AdminShow = () => (
42+
<Show>
43+
<SimpleShowLayout>
44+
<TextField source="name" />
45+
</SimpleShowLayout>
46+
</Show>
47+
);

‎apps/admin/resources/Post.tsx

+15
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ import {
1515
ReferenceArrayField,
1616
SingleFieldList,
1717
ChipField,
18+
Edit,
19+
EditProps,
20+
NumberInput,
1821
} from "react-admin";
1922

2023
export const PostList = (props: ListProps) => (
@@ -46,3 +49,15 @@ export const PostCreate = (props: CreateProps) => (
4649
</SimpleForm>
4750
</Create>
4851
);
52+
53+
export const PostEdit = (props: EditProps) => (
54+
<Edit {...props}>
55+
<SimpleForm>
56+
<TextInput source="text" />
57+
<NumberInput disabled source="_tags_count" />
58+
<ReferenceArrayInput label="Tags" reference="tag" source="tags">
59+
<AutocompleteArrayInput />
60+
</ReferenceArrayInput>
61+
</SimpleForm>
62+
</Edit>
63+
);

‎apps/website/prisma/migrations/20220520162532_cascade/migration.sql

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
-- RedefineTables
2+
PRAGMA foreign_keys=OFF;
3+
CREATE TABLE "new_Post" (
4+
"id" INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT,
5+
"userId" INTEGER NOT NULL,
6+
"text" TEXT NOT NULL,
7+
"createdAt" DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
8+
"updatedAt" DATETIME,
9+
CONSTRAINT "Post_userId_fkey" FOREIGN KEY ("userId") REFERENCES "User" ("id") ON DELETE CASCADE ON UPDATE CASCADE
10+
);
11+
INSERT INTO "new_Post" ("createdAt", "id", "text", "updatedAt", "userId") SELECT "createdAt", "id", "text", "updatedAt", "userId" FROM "Post";
12+
DROP TABLE "Post";
13+
ALTER TABLE "new_Post" RENAME TO "Post";
14+
PRAGMA foreign_key_check;
15+
PRAGMA foreign_keys=ON;

‎apps/website/prisma/web.local.db

0 Bytes
Binary file not shown.

‎packages/ra-data-simple-prisma/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,9 @@ export default function handler(req: NextApiRequest, res: NextApiResponse) {
125125
{
126126
skipFields: ...
127127
allowFields: ...
128+
set: {
129+
tags: "id",
130+
},
128131
}
129132
);
130133
default: // <= fall back on default handler

‎packages/ra-data-simple-prisma/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "ra-data-simple-prisma",
3-
"version": "0.3.2",
3+
"version": "0.3.3",
44
"description": "Create a fullstack react-admin app adding just one file",
55
"main": "./dist/index.js",
66
"module": "./dist/index.mjs",

‎packages/ra-data-simple-prisma/src/createHandler.ts

+7
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,13 @@ export const createHandler = async <T extends { create: Function }>(
2020
});
2121

2222
// transfor an array to a connect (many-to-many)
23+
// e.g. (handler)
24+
// createHandler(req, res, prismaClient.post, {
25+
// connect: {
26+
// tags: "id",
27+
// },
28+
// });
29+
// (data) tags: [1, 2, 3] => tags: { connect: {id: [1, 2, 3]} }
2330
Object.entries(data).forEach(([prop, value]) => {
2431
const foreignConnectKey = options?.connect?.[prop];
2532
if (foreignConnectKey) {

‎packages/ra-data-simple-prisma/src/dataProvider.ts

+13
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import type {
66
AxiosResponse,
77
AxiosRequestConfig,
88
} from "axios";
9+
import { isNumericId } from "./lib/isNumericId";
910

1011
export const dataProvider = (
1112
endpoint: string,
@@ -65,6 +66,8 @@ export const dataProvider = (
6566
.catch(reactAdminAxiosErrorHandler);
6667
},
6768
getOne: (resource, params) => {
69+
castIdToOriginalType(params);
70+
6871
return apiService
6972
.post(resource, {
7073
method: "getOne",
@@ -105,6 +108,8 @@ export const dataProvider = (
105108
.catch(reactAdminAxiosErrorHandler);
106109
},
107110
update: (resource, params) => {
111+
castIdToOriginalType(params);
112+
108113
return apiService
109114
.post(resource, {
110115
method: "update",
@@ -125,6 +130,8 @@ export const dataProvider = (
125130
.catch(reactAdminAxiosErrorHandler);
126131
},
127132
delete: (resource, params) => {
133+
castIdToOriginalType(params);
134+
128135
return apiService
129136
.post(resource, {
130137
method: "delete",
@@ -147,6 +154,12 @@ export const dataProvider = (
147154
};
148155
};
149156

157+
// https://github.com/marmelab/react-admin/issues/7728#issuecomment-1133959466
158+
// getOne will get the id from url so if the id is number it will be sent as string
159+
const castIdToOriginalType = (params) => {
160+
if (isNumericId(params.id)) params.id = +params.id;
161+
};
162+
150163
// react-admin expects the error to be thrown
151164
// https://marmelab.com/admin-on-rest/RestClients.html#writing-your-own-rest-client
152165
const reactAdminAxiosErrorHandler = (error: AxiosError) => {

‎packages/ra-data-simple-prisma/src/deleteHandler.ts

+4-2
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,17 @@ export const deleteHandler = async <
1212
table: T,
1313
options?: DeleteOptions
1414
) => {
15+
const { id } = req.body.params;
16+
1517
const deleted = options?.softDeleteField
1618
? await table.update({
17-
where: { id: +req.body.params.id },
19+
where: { id },
1820
data: {
1921
[options?.softDeleteField]: new Date(),
2022
},
2123
})
2224
: await table.delete({
23-
where: { id: +req.body.params.id },
25+
where: { id },
2426
});
2527

2628
return res.json({ data: deleted });

‎packages/ra-data-simple-prisma/src/deleteManyHandler.ts

+7-4
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,20 @@ export const deleteManyHandler = async <
1212
table: T,
1313
options?: DeleteManyOptions
1414
) => {
15+
const { ids } = req.body.params;
16+
1517
const deleted = options?.softDeleteField
1618
? await table.updateMany({
17-
where: { id: { in: req.body.params.ids } },
19+
where: { id: { in: ids } },
1820
data: {
1921
[options?.softDeleteField]: new Date(),
2022
},
2123
})
2224
: await table.deleteMany({
23-
where: { id: { in: req.body.params.ids } },
25+
where: { id: { in: ids } },
2426
});
2527

26-
//it expects the ids of the deleted rows, but only the count is returned from the deleteMany method
27-
return res.json({ data: req.body.params.ids });
28+
// react-admin expects the ids of the deleted rows
29+
// but only the count is returned from prisma deleteMany method, so...
30+
return res.json({ data: ids });
2831
};

‎packages/ra-data-simple-prisma/src/extractWhere.ts

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import { GetListRequest, GetManyReferenceRequest } from "./Http";
22
import setObjectProp from "set-value";
3+
import { isNotField } from "./lib/isNotField";
34

45
const logicalOperators = ["gte", "lte", "lt", "gt"];
56

@@ -10,9 +11,9 @@ export const extractWhere = (req: GetListRequest | GetManyReferenceRequest) => {
1011

1112
if (filter) {
1213
Object.entries(filter).forEach(([colName, value]) => {
13-
//ignore underscored fields (_count, _sum, _avg, _min, _max and _helpers)
14-
if (colName.startsWith("_")) return;
14+
if (isNotField(colName)) return;
1515

16+
//TODO: *consider* to move into `isNotField` (but maybe to reset dates is the only way to do it)
1617
if (value === "")
1718
//react-admin does send empty strings in empty filters :(
1819
return;

‎packages/ra-data-simple-prisma/src/getOneHandler.ts

+3-1
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,10 @@ export const getOneHandler = async <
1616
transform?: (row: any) => any;
1717
}
1818
) => {
19+
const { id } = req.body.params;
20+
1921
const row = await table.findUnique({
20-
where: { id: +req.body.params.id },
22+
where: { id },
2123
select: options?.select ?? undefined,
2224
include: options?.include ?? undefined,
2325
});

‎packages/ra-data-simple-prisma/src/lib/isNotField.ts

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
import { isObject } from "./isObject";
2+
3+
export const isNotField = (fieldName: string, value?: any) => {
4+
// ignore underscored fields (_count, _sum, _avg, _min, _max and _helpers)
5+
// especially in updates they would throw an error
6+
if (fieldName.startsWith("_")) return true;
7+
8+
if (value && isObject(value)) return true;
9+
10+
return false;
11+
};

‎packages/ra-data-simple-prisma/src/lib/isNumericId.ts

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export const isNumericId = (id: string): boolean => /^\d+$/.test(id);

‎packages/ra-data-simple-prisma/src/updateHandler.ts

+28-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
import { Response, UpdateRequest } from "./Http";
2+
import { isNotField } from "./lib/isNotField";
23
import { isObject } from "./lib/isObject";
34

45
export type UpdateOptions = {
56
skipFields?: string[]; //i.e. Json fields throw error if null is used in update, they would expect {} instead
67
allowFields?: string[]; //fields that will not be checked if it's a relationship or not
8+
set?: {
9+
[key: string]: string;
10+
};
711
};
812

913
export const updateHandler = async <T extends { update: Function }>(
@@ -12,10 +16,14 @@ export const updateHandler = async <T extends { update: Function }>(
1216
table: T,
1317
options?: UpdateOptions
1418
) => {
15-
//TODO: remove underscored fields
16-
//Remove relations, allow nested updates one day
19+
const { id } = req.body.params;
20+
1721
const data = Object.entries(req.body.params.data).reduce(
1822
(fields, [key, value]) => {
23+
if (isNotField(key)) return fields;
24+
25+
//TODO: move this into `isNotField`
26+
//Remove relations, allow nested updates one day
1927
if (
2028
(!isObject(value) && !options?.skipFields?.includes(key)) ||
2129
options?.allowFields?.includes(key)
@@ -27,8 +35,25 @@ export const updateHandler = async <T extends { update: Function }>(
2735
{}
2836
);
2937

38+
// transfor an array to a connect (many-to-many)
39+
// e.g. (handler)
40+
// updateHandler(req, res, prismaClient.post, {
41+
// set: {
42+
// tags: "id",
43+
// },
44+
// });
45+
// (data) tags: [1, 2, 3] => tags: { set: [{id: 1}, {id: 2}, {id: 3}]} }
46+
Object.entries(data).forEach(([prop, values]) => {
47+
const foreignConnectKey = options?.set?.[prop];
48+
if (foreignConnectKey && Array.isArray(values)) {
49+
data[prop] = {
50+
set: values.map((value) => ({ [foreignConnectKey]: value })),
51+
};
52+
}
53+
});
54+
3055
const updated = await table.update({
31-
where: { id: +req.body.params.id },
56+
where: { id },
3257
data,
3358
});
3459

‎pnpm-lock.yaml

+45-43
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)
Please sign in to comment.