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.

Sign up for GitHub

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

Jump to bottom

infer Model repository id schema from id column name #3483

Merged
merged 1 commit into from
Aug 19, 2024
Merged

infer Model repository id schema from id column name #3483

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/famous-otters-wonder.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@effect/sql": patch
---

infer Model repository id schema from id column name
63 changes: 40 additions & 23 deletions packages/sql/src/Model.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -596,11 +596,13 @@ export const JsonFromString = <S extends Schema.Schema.All | Schema.PropertySign
* @since 1.0.0
* @category repository
*/
export const makeRepository = <S extends Any, Id extends Schema.Schema.Any>(Model: S, options: {
export const makeRepository = <
S extends Any,
Id extends (keyof S["Type"]) & (keyof S["update"]["Type"]) & (keyof S["fields"])
>(Model: S, options: {
readonly tableName: string
readonly spanPrefix: string
readonly idColumn: (keyof S["Type"]) & (keyof S["update"]["Type"])
readonly idSchema: Id
readonly idColumn: Id
}): Effect.Effect<
{
readonly insert: (
Expand All @@ -609,14 +611,19 @@ export const makeRepository = <S extends Any, Id extends Schema.Schema.Any>(Mode
readonly update: (
update: S["update"]["Type"]
) => Effect.Effect<S["Type"], never, S["Context"] | S["update"]["Context"]>
readonly findById: (id: Id["Type"]) => Effect.Effect<Option.Option<S["Type"]>, never, S["Context"] | Id["Context"]>
readonly delete: (id: Id["Type"]) => Effect.Effect<void, never, Id["Context"]>
readonly findById: (
id: Schema.Schema.Type<S["fields"][Id]>
) => Effect.Effect<Option.Option<S["Type"]>, never, S["Context"] | Schema.Schema.Context<S["fields"][Id]>>
readonly delete: (
id: Schema.Schema.Type<S["fields"][Id]>
) => Effect.Effect<void, never, Schema.Schema.Context<S["fields"][Id]>>
},
never,
SqlClient
> =>
Effect.gen(function*() {
const sql = yield* SqlClient
const idSchema = Model.fields[options.idColumn] as Schema.Schema.Any

const insertSchema = SqlSchema.single({
Request: Model.insert,
Expand Down Expand Up @@ -654,11 +661,13 @@ export const makeRepository = <S extends Any, Id extends Schema.Schema.Any>(Mode
) as any

const findByIdSchema = SqlSchema.findOne({
Request: options.idSchema,
Request: idSchema,
Result: Model,
execute: (id) => sql`select * from ${sql(options.tableName)} where ${sql(options.idColumn as string)} = ${id}`
})
const findById = (id: Id["Type"]): Effect.Effect<Option.Option<S["Type"]>, never, S["Context"] | Id["Context"]> =>
const findById = (
id: Schema.Schema.Type<S["fields"][Id]>
): Effect.Effect<Option.Option<S["Type"]>, never, S["Context"] | Schema.Schema.Context<S["fields"][Id]>> =>
findByIdSchema(id).pipe(
Effect.orDie,
Effect.withSpan(`${options.spanPrefix}.findById`, {
Expand All @@ -668,10 +677,12 @@ export const makeRepository = <S extends Any, Id extends Schema.Schema.Any>(Mode
) as any

const deleteSchema = SqlSchema.void({
Request: options.idSchema,
Request: idSchema,
execute: (id) => sql`delete from ${sql(options.tableName)} where ${sql(options.idColumn as string)} = ${id}`
})
const delete_ = (id: Id["Type"]): Effect.Effect<void, never, Id["Context"]> =>
const delete_ = (
id: Schema.Schema.Type<S["fields"][Id]>
): Effect.Effect<void, never, Schema.Schema.Context<S["fields"][Id]>> =>
deleteSchema(id).pipe(
Effect.orDie,
Effect.withSpan(`${options.spanPrefix}.delete`, {
Expand All @@ -689,24 +700,30 @@ export const makeRepository = <S extends Any, Id extends Schema.Schema.Any>(Mode
* @since 1.0.0
* @category repository
*/
export const makeDataLoaders = <S extends AnyNoContext, Id extends Schema.Schema.AnyNoContext>(Model: S, options: {
readonly tableName: string
readonly spanPrefix: string
readonly idColumn: (keyof S["Type"]) & (keyof S["update"]["Type"])
readonly idSchema: Id
readonly window: number
readonly maxBatchSize?: number | undefined
}): Effect.Effect<
export const makeDataLoaders = <
S extends AnyNoContext,
Id extends (keyof S["Type"]) & (keyof S["update"]["Type"]) & (keyof S["fields"])
>(
Model: S,
options: {
readonly tableName: string
readonly spanPrefix: string
readonly idColumn: Id
readonly window: number
readonly maxBatchSize?: number | undefined
}
): Effect.Effect<
{
readonly insert: (insert: S["insert"]["Type"]) => Effect.Effect<S["Type"]>
readonly findById: (id: Id["Type"]) => Effect.Effect<Option.Option<S["Type"]>>
readonly delete: (id: Id["Type"]) => Effect.Effect<void>
readonly findById: (id: Schema.Schema.Type<S["fields"][Id]>) => Effect.Effect<Option.Option<S["Type"]>>
readonly delete: (id: Schema.Schema.Type<S["fields"][Id]>) => Effect.Effect<void>
},
never,
SqlClient | Scope
> =>
Effect.gen(function*() {
const sql = yield* SqlClient
const idSchema = Model.fields[options.idColumn] as Schema.Schema.Any

const insertResolver = yield* SqlResolver.ordered(`${options.spanPrefix}/insert`, {
Request: Model.insert,
Expand All @@ -730,7 +747,7 @@ export const makeDataLoaders = <S extends AnyNoContext, Id extends Schema.Schema
) as any

const findByIdResolver = yield* SqlResolver.grouped(`${options.spanPrefix}/findById`, {
Request: options.idSchema,
Request: idSchema,
RequestGroupKey(id) {
return id
},
Expand All @@ -745,7 +762,7 @@ export const makeDataLoaders = <S extends AnyNoContext, Id extends Schema.Schema
maxBatchSize: options.maxBatchSize!
})
const findByIdExecute = findByIdResolver.makeExecute(findByIdLoader)
const findById = (id: Id["Type"]): Effect.Effect<Option.Option<S["Type"]>> =>
const findById = (id: Schema.Schema.Type<S["fields"][Id]>): Effect.Effect<Option.Option<S["Type"]>> =>
findByIdExecute(id).pipe(
Effect.orDie,
Effect.withSpan(`${options.spanPrefix}.findById`, {
Expand All @@ -755,15 +772,15 @@ export const makeDataLoaders = <S extends AnyNoContext, Id extends Schema.Schema
) as any

const deleteResolver = yield* SqlResolver.void(`${options.spanPrefix}/delete`, {
Request: options.idSchema,
Request: idSchema,
execute: (ids) => sql`delete from ${sql(options.tableName)} where ${sql.in(options.idColumn as string, ids)}`
})
const deleteLoader = yield* RRX.dataLoader(deleteResolver, {
window: options.window,
maxBatchSize: options.maxBatchSize!
})
const deleteExecute = deleteResolver.makeExecute(deleteLoader)
const delete_ = (id: Id["Type"]): Effect.Effect<void> =>
const delete_ = (id: Schema.Schema.Type<S["fields"][Id]>): Effect.Effect<void> =>
deleteExecute(id).pipe(
Effect.orDie,
Effect.withSpan(`${options.spanPrefix}.delete`, {
Expand Down