Skip to content

fix: zod typing for DateTime field, improve overall code generation #363

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.

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

Merged
merged 4 commits into from
Apr 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 2 additions & 9 deletions packages/next/tests/request-handler.test.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
import { loadSchema } from '@zenstackhq/testtools';
import fs from 'fs';
import { createServer, RequestListener } from 'http';
import { apiResolver } from 'next/dist/server/api-utils/node';
import superjson from 'superjson';
Expand Down Expand Up @@ -37,17 +36,13 @@ function makeTestClient(apiPath: string, options: RequestHandlerOptions, queryAr

describe('request handler tests', () => {
let origDir: string;
let projDir: string;

beforeEach(() => {
origDir = process.cwd();
});

afterEach(() => {
process.chdir(origDir);
if (projDir) {
fs.rmSync(projDir, { recursive: true, force: true });
}
});

it('simple crud', async () => {
Expand All @@ -58,8 +53,7 @@ model M {
}
`;

const { prisma, projectDir } = await loadSchema(model);
projDir = projectDir;
const { prisma } = await loadSchema(model);

await makeTestClient('/m/create', { getPrisma: () => prisma })
.post('/')
Expand Down Expand Up @@ -180,8 +174,7 @@ model M {
}
`;

const { withPresets, projectDir } = await loadSchema(model);
projDir = projectDir;
const { withPresets } = await loadSchema(model);

await makeTestClient('/m/create', { getPrisma: () => withPresets() })
.post('/m/create')
Expand Down
9 changes: 3 additions & 6 deletions packages/plugins/react/src/generator/react-query.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { DMMF } from '@prisma/generator-helper';
import { getDataModels, PluginError, PluginOptions } from '@zenstackhq/sdk';
import { PluginError, PluginOptions, createProject, getDataModels, saveProject } from '@zenstackhq/sdk';
import { DataModel, Model } from '@zenstackhq/sdk/ast';
import { camelCase, paramCase, pascalCase } from 'change-case';
import * as path from 'path';
Expand All @@ -16,7 +16,7 @@ export async function generate(model: Model, options: PluginOptions, dmmf: DMMF.
outDir = path.join(path.dirname(options.schemaPath), outDir);
}

const project = new Project();
const project = createProject();
const warnings: string[] = [];
const models = getDataModels(model);

Expand All @@ -31,7 +31,7 @@ export async function generate(model: Model, options: PluginOptions, dmmf: DMMF.
generateModelHooks(project, outDir, dataModel, mapping);
});

await project.save();
await saveProject(project);
return warnings;
}

Expand Down Expand Up @@ -319,12 +319,9 @@ function generateModelHooks(project: Project, outDir: string, model: DataModel,
`T extends { select: any; } ? T['select'] extends true ? number : Prisma.GetScalarType<T['select'], Prisma.${model.name}CountAggregateOutputType> : number`
);
}

sf.formatText();
}

function generateIndex(project: Project, outDir: string, models: DataModel[]) {
const sf = project.createSourceFile(path.join(outDir, 'index.ts'), undefined, { overwrite: true });
sf.addStatements(models.map((d) => `export * from './${paramCase(d.name)}';`));
sf.formatText();
}
18 changes: 10 additions & 8 deletions packages/plugins/react/src/generator/swr.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
import { DMMF } from '@prisma/generator-helper';
import { CrudFailureReason, getDataModels, PluginError, PluginOptions } from '@zenstackhq/sdk';
import {
CrudFailureReason,
PluginError,
PluginOptions,
createProject,
getDataModels,
saveProject,
} from '@zenstackhq/sdk';
import { DataModel, Model } from '@zenstackhq/sdk/ast';
import { camelCase, paramCase } from 'change-case';
import * as path from 'path';
Expand All @@ -16,7 +23,7 @@ export async function generate(model: Model, options: PluginOptions, dmmf: DMMF.
outDir = path.join(path.dirname(options.schemaPath), outDir);
}

const project = new Project();
const project = createProject();
const warnings: string[] = [];
const models = getDataModels(model);

Expand All @@ -31,7 +38,7 @@ export async function generate(model: Model, options: PluginOptions, dmmf: DMMF.
generateModelHooks(project, outDir, dataModel, mapping);
});

await project.save();
await saveProject(project);
return warnings;
}

Expand Down Expand Up @@ -489,14 +496,9 @@ function generateModelHooks(project: Project, outDir: string, model: DataModel,
}

useFunc.addStatements([`return { ${methods.join(', ')} };`]);

sf.formatText();
}

function generateIndex(project: Project, outDir: string, models: DataModel[]) {
const sf = project.createSourceFile(path.join(outDir, 'index.ts'), undefined, { overwrite: true });

sf.addStatements(models.map((d) => `export * from './${paramCase(d.name)}';`));

sf.formatText();
}
11 changes: 2 additions & 9 deletions packages/plugins/react/tests/react-hooks.test.ts
Original file line number Diff line number Diff line change
@@ -1,21 +1,16 @@
/// <reference types="@types/jest" />

import { loadSchema } from '@zenstackhq/testtools';
import fs from 'fs';

describe('React Hooks Plugin Tests', () => {
let origDir: string;
let projDir: string;

beforeAll(() => {
origDir = process.cwd();
});

afterEach(() => {
process.chdir(origDir);
if (projDir) {
fs.rmSync(projDir, { recursive: true, force: true });
}
});

const sharedModel = `
Expand Down Expand Up @@ -46,7 +41,7 @@ model Foo {
`;

it('swr generator', async () => {
const { projectDir } = await loadSchema(
await loadSchema(
`
plugin react {
provider = '${process.cwd()}/dist'
Expand All @@ -60,11 +55,10 @@ ${sharedModel}
[`${origDir}/dist`, 'react', '@types/react', 'swr'],
true
);
projDir = projectDir;
});

it('react-query generator', async () => {
const { projectDir } = await loadSchema(
await loadSchema(
`
plugin react {
provider = '${process.cwd()}/dist'
Expand All @@ -79,6 +73,5 @@ ${sharedModel}
[`${origDir}/dist`, 'react', '@types/react', '@tanstack/react-query'],
true
);
projDir = projectDir;
});
});
4 changes: 2 additions & 2 deletions packages/plugins/trpc/src/generator.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { DMMF } from '@prisma/generator-helper';
import { CrudFailureReason, PluginError, PluginOptions, RUNTIME_PACKAGE } from '@zenstackhq/sdk';
import { CrudFailureReason, PluginError, PluginOptions, RUNTIME_PACKAGE, saveProject } from '@zenstackhq/sdk';
import { Model } from '@zenstackhq/sdk/ast';
import { camelCase } from 'change-case';
import { promises as fs } from 'fs';
Expand Down Expand Up @@ -42,7 +42,7 @@ export async function generate(model: Model, options: PluginOptions, dmmf: DMMF.
createAppRouter(outDir, modelOperations, hiddenModels);
createHelper(outDir);

await project.save();
await saveProject(project);
}

function createAppRouter(outDir: string, modelOperations: DMMF.ModelMapping[], hiddenModels: string[]) {
Expand Down
23 changes: 16 additions & 7 deletions packages/plugins/trpc/src/zod/generator.ts
Original file line number Diff line number Diff line change
@@ -1,18 +1,21 @@
import { ConnectorType, DMMF } from '@prisma/generator-helper';
import { Dictionary } from '@prisma/internals';
import { getLiteral, PluginOptions } from '@zenstackhq/sdk';
import { DataSource, isDataSource, Model } from '@zenstackhq/sdk/ast';
import { PluginOptions, getLiteral } from '@zenstackhq/sdk';
import { DataSource, Model, isDataSource } from '@zenstackhq/sdk/ast';
import {
addMissingInputObjectTypes,
AggregateOperationSupport,
addMissingInputObjectTypes,
resolveAggregateOperationSupport,
} from '@zenstackhq/sdk/dmmf-helpers';
import { promises as fs } from 'fs';
import path from 'path';
import Transformer from './transformer';
import removeDir from './utils/removeDir';
import { writeFileSafely } from './utils/writeFileSafely';

export async function generate(model: Model, options: PluginOptions, dmmf: DMMF.Document) {
await handleGeneratorOutputValue((options.output as string) ?? './generated');
const output = (options.output as string) ?? './generated';
await handleGeneratorOutputValue(output);

const prismaClientDmmf = dmmf;

Expand All @@ -38,7 +41,7 @@ export async function generate(model: Model, options: PluginOptions, dmmf: DMMF.

const aggregateOperationSupport = resolveAggregateOperationSupport(inputObjectTypes);

await generateObjectSchemas(inputObjectTypes);
await generateObjectSchemas(inputObjectTypes, output);
await generateModelSchemas(models, modelOperations, aggregateOperationSupport);
}

Expand All @@ -61,13 +64,19 @@ async function generateEnumSchemas(prismaSchemaEnum: DMMF.SchemaEnum[], modelSch
await transformer.generateEnumSchemas();
}

async function generateObjectSchemas(inputObjectTypes: DMMF.InputType[]) {
async function generateObjectSchemas(inputObjectTypes: DMMF.InputType[], output: string) {
const moduleNames: string[] = [];
for (let i = 0; i < inputObjectTypes.length; i += 1) {
const fields = inputObjectTypes[i]?.fields;
const name = inputObjectTypes[i]?.name;
const transformer = new Transformer({ name, fields });
await transformer.generateObjectSchema();
const moduleName = await transformer.generateObjectSchema();
moduleNames.push(moduleName);
}
await writeFileSafely(
path.join(output, `schemas/objects/index.ts`),
moduleNames.map((name) => `export * from './${name}';`).join('\n')
);
}

async function generateModelSchemas(
Expand Down
49 changes: 29 additions & 20 deletions packages/plugins/trpc/src/zod/transformer.ts
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,11 @@ export default class Transformer {
)}`
);
}

await writeFileSafely(
path.join(Transformer.outputPath, `schemas/enums/index.ts`),
this.enumTypes.map((enumType) => `export * from './${enumType.name}.schema';`).join('\n')
);
}

generateImportZodStatement() {
Expand All @@ -77,6 +82,7 @@ export default class Transformer {
path.join(Transformer.outputPath, `schemas/objects/${this.name}.schema.ts`),
'/* eslint-disable */\n' + objectSchema
);
return `${this.name}.schema`;
}

generateObjectSchemaFields() {
Expand Down Expand Up @@ -113,10 +119,11 @@ export default class Transformer {
} else if (inputType.type === 'Boolean') {
result.push(this.wrapWithZodValidators('z.boolean()', field, inputType));
} else if (inputType.type === 'DateTime') {
result.push(this.wrapWithZodValidators('z.date()', field, inputType));
result.push(this.wrapWithZodValidators(['z.date()', 'z.string().datetime()'], field, inputType));
} else if (inputType.type === 'Bytes') {
result.push(this.wrapWithZodValidators('z.number().array()', field, inputType));
} else if (inputType.type === 'Json') {
this.hasJson = true;

result.push(this.wrapWithZodValidators('jsonSchema', field, inputType));
} else if (inputType.type === 'True') {
result.push(this.wrapWithZodValidators('z.literal(true)', field, inputType));
Expand Down Expand Up @@ -158,19 +165,29 @@ export default class Transformer {
}

wrapWithZodValidators(
mainValidator: string,
mainValidators: string | string[],
field: PrismaDMMF.SchemaArg,
inputType: PrismaDMMF.SchemaArgInputType
) {
let line = '';
line = mainValidator;

if (inputType.isList) {
line += '.array()';
}
const base = Array.isArray(mainValidators) ? mainValidators : [mainValidators];

line += base
.map((validator) => {
let r = validator;
if (inputType.isList) {
r += '.array()';
}
if (!field.isRequired) {
r += '.optional()';
}
return r;
})
.join(', ');

if (!field.isRequired) {
line += '.optional()';
if (base.length > 1) {
line = `z.union([${line}])`;
}

return line;
Expand Down Expand Up @@ -356,8 +373,7 @@ export default class Transformer {
}

async generateModelSchemas() {
const globalImports: string[] = [];
let globalExport = '';
const globalExports: string[] = [];

for (const modelOperation of this.modelOperations) {
const {
Expand All @@ -381,8 +397,7 @@ export default class Transformer {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
} = modelOperation;

globalImports.push(`import { ${modelName}Schema } from './${modelName}.schema'`);
globalExport += `${modelName}: ${modelName}Schema,`;
globalExports.push(`export { ${modelName}Schema as ${modelName} } from './${modelName}.schema'`);

// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
const model = findModelByName(this.models, modelName)!;
Expand Down Expand Up @@ -547,13 +562,7 @@ ${indentString(codeBody, 4)}
path.join(Transformer.outputPath, 'schemas/index.ts'),
`
/* eslint-disable */
${globalImports.join(';\n')}

const schemas = {
${indentString(globalExport, 4)}
};

export default schemas;
${globalExports.join(';\n')}
`
);
}
Expand Down
8 changes: 1 addition & 7 deletions packages/plugins/trpc/tests/trpc.test.ts
Original file line number Diff line number Diff line change
@@ -1,25 +1,20 @@
/// <reference types="@types/jest" />

import { loadSchema } from '@zenstackhq/testtools';
import fs from 'fs';

describe('tRPC Plugin Tests', () => {
let origDir: string;
let projDir: string;

beforeAll(() => {
origDir = process.cwd();
});

afterEach(() => {
process.chdir(origDir);
if (projDir) {
fs.rmSync(projDir, { recursive: true, force: true });
}
});

it('run plugin', async () => {
const { projectDir } = await loadSchema(
await loadSchema(
`
plugin trpc {
provider = '${process.cwd()}/dist'
Expand Down Expand Up @@ -56,6 +51,5 @@ model Foo {
[`${origDir}/dist`, '@trpc/client', '@trpc/server'],
true
);
projDir = projectDir;
});
});
Loading