From 334cc5903af899b62a38aef26811fd11b248a394 Mon Sep 17 00:00:00 2001 From: Gao Sun Date: Thu, 26 Aug 2021 22:50:27 +0800 Subject: [PATCH 1/3] refactor: accept rest data while creating application --- packages/core/src/routes/application.ts | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/packages/core/src/routes/application.ts b/packages/core/src/routes/application.ts index ff8402207..825f78e85 100644 --- a/packages/core/src/routes/application.ts +++ b/packages/core/src/routes/application.ts @@ -1,6 +1,6 @@ import Router from 'koa-router'; -import { nativeEnum, object, string } from 'zod'; -import { ApplicationType } from '@logto/schemas'; +import { object, string } from 'zod'; +import { Applications } from '@logto/schemas'; import koaGuard from '@/middleware/koa-guard'; import { deleteApplicationById, insertApplication } from '@/queries/application'; import { buildIdGenerator } from '@/utils/id'; @@ -12,19 +12,20 @@ export default function applicationRoutes(router: Router { - const { name, type } = ctx.guard.body; + const { name, type, ...rest } = ctx.guard.body; ctx.body = await insertApplication({ id: applicationId(), type, name, oidcClientMetadata: generateOidcClientMetadata(), + ...rest, }); return next(); } From 6b6210feee460c2576a38fd7ac9d121224aa9393 Mon Sep 17 00:00:00 2001 From: Gao Sun Date: Fri, 27 Aug 2021 00:33:13 +0800 Subject: [PATCH 2/3] feat: `PATCH /application/:id` --- packages/core/src/database/insert-into.ts | 14 +++-- packages/core/src/database/update-where.ts | 58 +++++++++++++++++++++ packages/core/src/queries/application.ts | 10 +++- packages/core/src/routes/application.ts | 24 ++++++++- packages/core/src/utils/schema.ts | 6 +++ packages/phrases/src/locales/en.ts | 1 + packages/phrases/src/locales/zh-cn.ts | 1 + packages/schemas/src/foundations/schemas.ts | 4 +- 8 files changed, 106 insertions(+), 12 deletions(-) create mode 100644 packages/core/src/database/update-where.ts create mode 100644 packages/core/src/utils/schema.ts diff --git a/packages/core/src/database/insert-into.ts b/packages/core/src/database/insert-into.ts index 798b93828..8ea5def47 100644 --- a/packages/core/src/database/insert-into.ts +++ b/packages/core/src/database/insert-into.ts @@ -32,19 +32,19 @@ type InsertIntoConfig = { }; interface BuildInsertInto { - >( + ( pool: DatabasePoolType, { fieldKeys, ...rest }: GeneratedSchema, config: InsertIntoConfigReturning ): (data: OmitAutoSetFields) => Promise; - >( + ( pool: DatabasePoolType, { fieldKeys, ...rest }: GeneratedSchema, config?: InsertIntoConfig ): (data: OmitAutoSetFields) => Promise; } -export const buildInsertInto: BuildInsertInto = >( +export const buildInsertInto: BuildInsertInto = ( pool: DatabasePoolType, { fieldKeys, ...rest }: GeneratedSchema, config?: InsertIntoConfig | InsertIntoConfigReturning @@ -55,7 +55,9 @@ export const buildInsertInto: BuildInsertInto = ): Promise => { - const result = await pool.query(sql` + const { + rows: [entry], + } = await pool.query(sql` insert into ${table} (${sql.join( keys.map((key) => fields[key]), sql`, ` @@ -74,10 +76,6 @@ export const buildInsertInto: BuildInsertInto = = { + set: Partial; + where: Partial; +}; + +interface BuildUpdateWhere { + ( + pool: DatabasePoolType, + schema: GeneratedSchema, + returning: true + ): (data: UpdateWhereData) => Promise; + ( + pool: DatabasePoolType, + schema: GeneratedSchema, + returning?: false + ): (data: UpdateWhereData) => Promise; +} + +export const buildUpdateWhere: BuildUpdateWhere = ( + pool: DatabasePoolType, + schema: GeneratedSchema, + returning = false +) => { + const { table, fields } = convertToIdentifiers(schema); + const isKeyOfSchema = isKeyOf(schema); + const connectKeyValueWithEqualSign = (data: Partial) => + Object.entries(data) + .map( + ([key, value]) => + isKeyOfSchema(key) && sql`${fields[key]}=${convertToPrimitiveOrSql(key, value)}` + ) + .filter((value): value is Truthy => notFalsy(value)); + + return async ({ set, where }: UpdateWhereData) => { + const { + rows: [entry], + } = await pool.query(sql` + update ${table} + set ${sql.join(connectKeyValueWithEqualSign(set), sql`, `)} + where ${sql.join(connectKeyValueWithEqualSign(where), sql`, `)} + ${conditionalSql(returning, () => sql`returning *`)} + `); + + assert( + !returning || entry, + new RequestError({ code: 'entity.update_failed', name: schema.tableSingular }) + ); + return entry; + }; +}; diff --git a/packages/core/src/queries/application.ts b/packages/core/src/queries/application.ts index 384b794ab..90a56a3c0 100644 --- a/packages/core/src/queries/application.ts +++ b/packages/core/src/queries/application.ts @@ -1,6 +1,7 @@ import { buildInsertInto } from '@/database/insert-into'; import pool from '@/database/pool'; -import { convertToIdentifiers } from '@/database/utils'; +import { buildUpdateWhere } from '@/database/update-where'; +import { convertToIdentifiers, OmitAutoSetFields } from '@/database/utils'; import RequestError from '@/errors/RequestError'; import { ApplicationDBEntry, Applications } from '@logto/schemas'; import { sql } from 'slonik'; @@ -18,6 +19,13 @@ export const insertApplication = buildInsertInto(pool, Appli returning: true, }); +const updateApplication = buildUpdateWhere(pool, Applications, true); + +export const updateApplicationById = async ( + id: string, + set: Partial> +) => updateApplication({ set, where: { id } }); + export const deleteApplicationById = async (id: string) => { const { rowCount } = await pool.query(sql` delete from ${table} diff --git a/packages/core/src/routes/application.ts b/packages/core/src/routes/application.ts index 825f78e85..c511f86ae 100644 --- a/packages/core/src/routes/application.ts +++ b/packages/core/src/routes/application.ts @@ -2,7 +2,11 @@ import Router from 'koa-router'; import { object, string } from 'zod'; import { Applications } from '@logto/schemas'; import koaGuard from '@/middleware/koa-guard'; -import { deleteApplicationById, insertApplication } from '@/queries/application'; +import { + deleteApplicationById, + insertApplication, + updateApplicationById, +} from '@/queries/application'; import { buildIdGenerator } from '@/utils/id'; import { generateOidcClientMetadata } from '@/oidc/utils'; @@ -31,6 +35,24 @@ export default function applicationRoutes(router: Router { + const { + params: { id }, + body, + } = ctx.guard; + + ctx.body = await updateApplicationById(id, body); + return next(); + } + ); + router.delete( '/application/:id', koaGuard({ params: object({ id: string().min(1) }) }), diff --git a/packages/core/src/utils/schema.ts b/packages/core/src/utils/schema.ts new file mode 100644 index 000000000..cda5e0c8b --- /dev/null +++ b/packages/core/src/utils/schema.ts @@ -0,0 +1,6 @@ +import { GeneratedSchema, SchemaLike } from '@logto/schemas'; + +export const isKeyOf = + ({ fieldKeys }: GeneratedSchema) => + (key: string): key is keyof Schema extends string ? keyof Schema : never => + fieldKeys.includes(key); diff --git a/packages/phrases/src/locales/en.ts b/packages/phrases/src/locales/en.ts index 89c6b2f4d..b491960d1 100644 --- a/packages/phrases/src/locales/en.ts +++ b/packages/phrases/src/locales/en.ts @@ -39,6 +39,7 @@ const errors = { }, entity: { create_failed: 'Failed to create {{name}}.', + update_failed: 'Failed to update {{name}}.', not_exists: 'The {{name}} with ID `{{id}}` does not exist.', }, }; diff --git a/packages/phrases/src/locales/zh-cn.ts b/packages/phrases/src/locales/zh-cn.ts index 08c52ba9e..e688eff0f 100644 --- a/packages/phrases/src/locales/zh-cn.ts +++ b/packages/phrases/src/locales/zh-cn.ts @@ -41,6 +41,7 @@ const errors = { }, entity: { create_failed: '创建 {{name}} 失败。', + update_failed: '更新 {{name}} 失败。', not_exists: 'ID 为 `{{id}}` 的 {{name}} 不存在。', }, }; diff --git a/packages/schemas/src/foundations/schemas.ts b/packages/schemas/src/foundations/schemas.ts index e566e15ce..5d4c34a9b 100644 --- a/packages/schemas/src/foundations/schemas.ts +++ b/packages/schemas/src/foundations/schemas.ts @@ -8,11 +8,11 @@ export type Guard> = ZodObject< export type SchemaValuePrimitive = string | number | boolean | undefined; export type SchemaValue = SchemaValuePrimitive | Record; -export type SchemaLike = { +export type SchemaLike = { [key in Key]: SchemaValue; }; -export type GeneratedSchema> = keyof Schema extends string +export type GeneratedSchema = keyof Schema extends string ? Readonly<{ table: string; tableSingular: string; From 4694c0d5ce9c4c51ccf8f58b25096ca49c1bf434 Mon Sep 17 00:00:00 2001 From: Gao Sun Date: Fri, 27 Aug 2021 17:13:49 +0800 Subject: [PATCH 3/3] refactor: use 404 when not found --- packages/core/src/database/update-where.ts | 7 ++++++- packages/core/src/queries/application.ts | 7 ++++++- packages/phrases/src/locales/en.ts | 4 ++-- packages/phrases/src/locales/zh-cn.ts | 4 ++-- 4 files changed, 16 insertions(+), 6 deletions(-) diff --git a/packages/core/src/database/update-where.ts b/packages/core/src/database/update-where.ts index 276622491..077b58d7e 100644 --- a/packages/core/src/database/update-where.ts +++ b/packages/core/src/database/update-where.ts @@ -51,7 +51,12 @@ export const buildUpdateWhere: BuildUpdateWhere = ( assert( !returning || entry, - new RequestError({ code: 'entity.update_failed', name: schema.tableSingular }) + new RequestError({ + code: where.id ? 'entity.not_exists_with_id' : 'entity.not_exists', + name: schema.tableSingular, + id: where.id, + status: 404, + }) ); return entry; }; diff --git a/packages/core/src/queries/application.ts b/packages/core/src/queries/application.ts index 90a56a3c0..b76f661e1 100644 --- a/packages/core/src/queries/application.ts +++ b/packages/core/src/queries/application.ts @@ -32,6 +32,11 @@ export const deleteApplicationById = async (id: string) => { where id=${id} `); if (rowCount < 1) { - throw new RequestError({ code: 'entity.not_exists', name: Applications.tableSingular, id }); + throw new RequestError({ + code: 'entity.not_exists_with_id', + name: Applications.tableSingular, + id, + status: 404, + }); } }; diff --git a/packages/phrases/src/locales/en.ts b/packages/phrases/src/locales/en.ts index b491960d1..428bf585d 100644 --- a/packages/phrases/src/locales/en.ts +++ b/packages/phrases/src/locales/en.ts @@ -39,8 +39,8 @@ const errors = { }, entity: { create_failed: 'Failed to create {{name}}.', - update_failed: 'Failed to update {{name}}.', - not_exists: 'The {{name}} with ID `{{id}}` does not exist.', + not_exists: 'The {{name}} does not exist.', + not_exists_with_id: 'The {{name}} with ID `{{id}}` does not exist.', }, }; diff --git a/packages/phrases/src/locales/zh-cn.ts b/packages/phrases/src/locales/zh-cn.ts index e688eff0f..e6ab5f1aa 100644 --- a/packages/phrases/src/locales/zh-cn.ts +++ b/packages/phrases/src/locales/zh-cn.ts @@ -41,8 +41,8 @@ const errors = { }, entity: { create_failed: '创建 {{name}} 失败。', - update_failed: '更新 {{name}} 失败。', - not_exists: 'ID 为 `{{id}}` 的 {{name}} 不存在。', + not_exists: '该 {{name}} 不存在。', + not_exists_with_id: 'ID 为 `{{id}}` 的 {{name}} 不存在。', }, };