Infrastructure/logto
0
Fork 0
mirror of https://github.com/logto-io/logto.git synced 2025-03-31 22:51:25 -05:00
Code Issues Activity

refactor(core): remove find-many (#511)

Browse source
This commit is contained in:
IceHe.xyz 2022-04-07 21:16:59 +08:00 • committed by GitHub
parent f811d32371
commit 7eb2e41936
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 25 additions and 130 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

68
packages/core/src/database/find-many.test.ts
View file

@ -1,68 +0,0 @@
import { Users } from '@logto/schemas';
import { createTestPool } from '@/utils/test-utils';
import { buildFindMany } from './find-many';
describe('buildFindMany()', () => {
it('matches expected sql', async () => {
const pool = createTestPool(
'select "id", "username", "primary_email", "primary_phone", "password_encrypted", "password_encryption_method", "password_encryption_salt", "name", "avatar", "role_names", "identities", "custom_data"\nfrom "users"'
);
const findMany = buildFindMany(pool, Users);
await findMany();
});
it('matches expected sql with where conditions', async () => {
const pool = createTestPool(
'select "id", "username", "primary_email", "primary_phone", "password_encrypted", "password_encryption_method", "password_encryption_salt", "name", "avatar", "role_names", "identities", "custom_data"\nfrom "users"\nwhere "id"=$1'
);
const findMany = buildFindMany(pool, Users);
await findMany({ where: { id: '123' } });
});
it('matches expected sql with orderBy', async () => {
const pool = createTestPool(
'select "id", "username", "primary_email", "primary_phone", "password_encrypted", "password_encryption_method", "password_encryption_salt", "name", "avatar", "role_names", "identities", "custom_data"\nfrom "users"\norder by "id" asc, "username" desc'
);
const findMany = buildFindMany(pool, Users);
await findMany({ orderBy: { id: 'asc', username: 'desc' } });
});
it('matches expected sql with limit', async () => {
const pool = createTestPool(
'select "id", "username", "primary_email", "primary_phone", "password_encrypted", "password_encryption_method", "password_encryption_salt", "name", "avatar", "role_names", "identities", "custom_data"\nfrom "users"\nlimit $1'
);
const findMany = buildFindMany(pool, Users);
await findMany({ limit: 10 });
});
it('matches expected sql with offset', async () => {
const pool = createTestPool(
'select "id", "username", "primary_email", "primary_phone", "password_encrypted", "password_encryption_method", "password_encryption_salt", "name", "avatar", "role_names", "identities", "custom_data"\nfrom "users"\noffset $1'
);
const findMany = buildFindMany(pool, Users);
await findMany({ offset: 10 });
});
it('matches expected sql with offset 0', async () => {
const pool = createTestPool(
'select "id", "username", "primary_email", "primary_phone", "password_encrypted", "password_encryption_method", "password_encryption_salt", "name", "avatar", "role_names", "identities", "custom_data"\nfrom "users"'
);
const findMany = buildFindMany(pool, Users);
await findMany({ offset: 0 });
});
it('matches expected sql with where conditions, orderBy, limit, and offset', async () => {
const pool = createTestPool(
'select "id", "username", "primary_email", "primary_phone", "password_encrypted", "password_encryption_method", "password_encryption_salt", "name", "avatar", "role_names", "identities", "custom_data"\nfrom "users"\nwhere "id"=$1\norder by "id" desc, "username" asc\nlimit $2\noffset $3'
);
const findMany = buildFindMany(pool, Users);
await findMany({
where: { id: '123' },
orderBy: { id: 'desc', username: 'asc' },
limit: 20,
offset: 20,
});
});
});

52
packages/core/src/database/find-many.ts
View file

@ -1,52 +0,0 @@
import { GeneratedSchema, SchemaLike } from '@logto/schemas';
import { notFalsy } from '@silverhand/essentials';
import { DatabasePoolType, sql } from 'slonik';
import { isKeyOf } from '@/utils/schema';
import { FindManyData, OrderBy } from './types';
import { conditionalSql, convertToIdentifiers, convertToPrimitiveOrSql } from './utils';
export const buildFindMany = <Schema extends SchemaLike, ReturnType extends SchemaLike>(
pool: DatabasePoolType,
schema: GeneratedSchema<Schema>
) => {
const { table, fields } = convertToIdentifiers(schema);
const isKeyOfSchema = isKeyOf(schema);
const connectKeyValueWithEqualSign = (partialSchema: Partial<Schema>) =>
Object.entries(partialSchema)
.map(
([key, value]) =>
isKeyOfSchema(key) && sql`${fields[key]}=${convertToPrimitiveOrSql(key, value)}`
)
.filter((entry) => notFalsy(entry));
const buildOrderBy = (orderBySchema: OrderBy<Schema>) =>
Object.entries(orderBySchema)
.map(([key, order]) => {
if (!isKeyOfSchema(key)) {
return false;
}
const orderDirection = order === 'asc' ? sql`asc` : sql`desc`;
return sql`${fields[key]} ${orderDirection}`;
})
.filter((entry) => notFalsy(entry));
return async ({ where, orderBy, limit, offset }: FindManyData<Schema> = {}) =>
pool.any<ReturnType>(sql`
select ${sql.join(Object.values(fields), sql`, `)}
from ${table}
${conditionalSql(
where,
(where) => sql`where ${sql.join(connectKeyValueWithEqualSign(where), sql` and `)}`
)}
${conditionalSql(
orderBy,
(orderBy) => sql`order by ${sql.join(buildOrderBy(orderBy), sql`, `)}`
)}
${conditionalSql(limit, (limit) => sql`limit ${limit}`)}
${conditionalSql(offset, (offset) => sql`offset ${offset}`)}
`);
};

18
packages/core/src/queries/application.ts
View file

@ -1,21 +1,29 @@
import { Application, CreateApplication, Applications } from '@logto/schemas';
import { sql } from 'slonik';
import { buildFindMany } from '@/database/find-many';
import { buildInsertInto } from '@/database/insert-into';
import pool from '@/database/pool';
import { buildUpdateWhere } from '@/database/update-where';
import { convertToIdentifiers, OmitAutoSetFields, getTotalRowCount } from '@/database/utils';
import {
convertToIdentifiers,
OmitAutoSetFields,
getTotalRowCount,
conditionalSql,
} from '@/database/utils';
import { DeletionError } from '@/errors/SlonikError';
const { table, fields } = convertToIdentifiers(Applications);
export const findTotalNumberOfApplications = async () => getTotalRowCount(table);
const findApplicationMany = buildFindMany<CreateApplication, Application>(pool, Applications);
export const findAllApplications = async (limit: number, offset: number) =>
findApplicationMany({ orderBy: { createdAt: 'desc' }, limit, offset });
pool.many<Application>(sql`
select ${sql.join(Object.values(fields), sql`, `)}
from ${table}
order by ${fields.createdAt} desc
${conditionalSql(limit, (limit) => sql`limit ${limit}`)}
${conditionalSql(offset, (offset) => sql`offset ${offset}`)}
`);
export const findApplicationById = async (id: string) =>
pool.one<Application>(sql`

17
packages/core/src/queries/resource.ts
View file

@ -1,21 +1,28 @@
import { Resource, CreateResource, Resources } from '@logto/schemas';
import { sql } from 'slonik';
import { buildFindMany } from '@/database/find-many';
import { buildInsertInto } from '@/database/insert-into';
import pool from '@/database/pool';
import { buildUpdateWhere } from '@/database/update-where';
import { convertToIdentifiers, OmitAutoSetFields, getTotalRowCount } from '@/database/utils';
import {
convertToIdentifiers,
OmitAutoSetFields,
getTotalRowCount,
conditionalSql,
} from '@/database/utils';
import { DeletionError } from '@/errors/SlonikError';
const { table, fields } = convertToIdentifiers(Resources);
export const findTotalNumberOfResources = async () => getTotalRowCount(table);
const findResourcesMany = buildFindMany<CreateResource, Resource>(pool, Resources);
export const findAllResources = async (limit: number, offset: number) =>
findResourcesMany({ limit, offset });
pool.many<Resource>(sql`
select ${sql.join(Object.values(fields), sql`, `)}
from ${table}
${conditionalSql(limit, (limit) => sql`limit ${limit}`)}
${conditionalSql(offset, (offset) => sql`offset ${offset}`)}
`);
export const findResourceByIndicator = async (indicator: string) =>
pool.maybeOne<Resource>(sql`