Skip to content

Commit

Permalink
Add support for Prisma Bytes
Browse files Browse the repository at this point in the history
  • Loading branch information
Tobbe committed Jan 18, 2024
1 parent f16b136 commit 4359f5b
Show file tree
Hide file tree
Showing 12 changed files with 261 additions and 17 deletions.
4 changes: 4 additions & 0 deletions packages/cli/src/commands/generate/__tests__/helpers.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -541,6 +541,10 @@ describe('mapPrismaScalarToPagePropTsType', () => {
expect(helpers.mapPrismaScalarToPagePropTsType('DateTime')).toBe('string')
})

it('maps scalar type Bytes to TS type Buffer', () => {
expect(helpers.mapPrismaScalarToPagePropTsType('Bytes')).toBe('Buffer')
})

it('maps all other type not-known to TS to unknown', () => {
expect(helpers.mapPrismaScalarToPagePropTsType('Json')).toBe('unknown')
})
Expand Down
3 changes: 2 additions & 1 deletion packages/cli/src/commands/generate/helpers.js
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ export const mapRouteParamTypeToTsType = (paramType) => {
return routeParamToTsType[paramType] || 'unknown'
}

/** @type {(scalarType: 'String' | 'Boolean' | 'Int' | 'BigInt' | 'Float' | 'Decimal' | 'DateTime' ) => string } **/
/** @type {(scalarType: 'String' | 'Boolean' | 'Int' | 'BigInt' | 'Float' | 'Decimal' | 'DateTime' | 'Bytes' ) => string } **/
export const mapPrismaScalarToPagePropTsType = (scalarType) => {
const prismaScalarToTsType = {
String: 'string',
Expand All @@ -308,6 +308,7 @@ export const mapPrismaScalarToPagePropTsType = (scalarType) => {
Float: 'number',
Decimal: 'number',
DateTime: 'string',
Bytes: 'Buffer',
}
return prismaScalarToTsType[scalarType] || 'unknown'
}
Original file line number Diff line number Diff line change
Expand Up @@ -728,6 +728,63 @@ exports[`with graphql documentations in javascript mode creates a multi word sdl
"
`;
exports[`with graphql documentations in javascript mode creates a sdl file with Byte definitions 1`] = `
"export const schema = gql\`
"""
Representation of Key.
"""
type Key {
"Description for id."
id: Int!
"Description for publicKey."
publicKey: Byte!
}
"""
About queries
"""
type Query {
"Fetch Keys."
keys: [Key!]! @requireAuth
"Fetch a Key by id."
key(id: Int!): Key @requireAuth
}
"""
Autogenerated input type of InputKey.
"""
input CreateKeyInput {
"Description for publicKey."
publicKey: Byte!
}
"""
Autogenerated input type of UpdateKey.
"""
input UpdateKeyInput {
"Description for publicKey."
publicKey: Byte
}
"""
About mutations
"""
type Mutation {
"Creates a new Key."
createKey(input: CreateKeyInput!): Key! @requireAuth
"Updates an existing Key."
updateKey(id: Int!, input: UpdateKeyInput!): Key! @requireAuth
"Deletes an existing Key."
deleteKey(id: Int!): Key! @requireAuth
}
\`
"
`;
exports[`with graphql documentations in javascript mode creates a sdl file with enum definitions 1`] = `
"export const schema = gql\`
"""
Expand Down Expand Up @@ -1163,6 +1220,63 @@ exports[`with graphql documentations in typescript mode creates a multi word sdl
"
`;
exports[`with graphql documentations in typescript mode creates a sdl file with Byte definitions 1`] = `
"export const schema = gql\`
"""
Representation of Key.
"""
type Key {
"Description for id."
id: Int!
"Description for publicKey."
publicKey: Byte!
}
"""
About queries
"""
type Query {
"Fetch Keys."
keys: [Key!]! @requireAuth
"Fetch a Key by id."
key(id: Int!): Key @requireAuth
}
"""
Autogenerated input type of InputKey.
"""
input CreateKeyInput {
"Description for publicKey."
publicKey: Byte!
}
"""
Autogenerated input type of UpdateKey.
"""
input UpdateKeyInput {
"Description for publicKey."
publicKey: Byte
}
"""
About mutations
"""
type Mutation {
"Creates a new Key."
createKey(input: CreateKeyInput!): Key! @requireAuth
"Updates an existing Key."
updateKey(id: Int!, input: UpdateKeyInput!): Key! @requireAuth
"Deletes an existing Key."
deleteKey(id: Int!): Key! @requireAuth
}
\`
"
`;
exports[`with graphql documentations in typescript mode creates a sdl file with enum definitions 1`] = `
"export const schema = gql\`
"""
Expand Down Expand Up @@ -1526,6 +1640,35 @@ exports[`without graphql documentations in javascript mode creates a multi word
"
`;
exports[`without graphql documentations in javascript mode creates a sdl file with Byte definitions 1`] = `
"export const schema = gql\`
type Key {
id: Int!
publicKey: Byte!
}
type Query {
keys: [Key!]! @requireAuth
key(id: Int!): Key @requireAuth
}
input CreateKeyInput {
publicKey: Byte!
}
input UpdateKeyInput {
publicKey: Byte
}
type Mutation {
createKey(input: CreateKeyInput!): Key! @requireAuth
updateKey(id: Int!, input: UpdateKeyInput!): Key! @requireAuth
deleteKey(id: Int!): Key! @requireAuth
}
\`
"
`;
exports[`without graphql documentations in javascript mode creates a sdl file with enum definitions 1`] = `
"export const schema = gql\`
type Shoe {
Expand Down Expand Up @@ -1734,6 +1877,35 @@ exports[`without graphql documentations in typescript mode creates a multi word
"
`;
exports[`without graphql documentations in typescript mode creates a sdl file with Byte definitions 1`] = `
"export const schema = gql\`
type Key {
id: Int!
publicKey: Byte!
}
type Query {
keys: [Key!]! @requireAuth
key(id: Int!): Key @requireAuth
}
input CreateKeyInput {
publicKey: Byte!
}
input UpdateKeyInput {
publicKey: Byte
}
type Mutation {
createKey(input: CreateKeyInput!): Key! @requireAuth
updateKey(id: Int!, input: UpdateKeyInput!): Key! @requireAuth
deleteKey(id: Int!): Key! @requireAuth
}
\`
"
`;
exports[`without graphql documentations in typescript mode creates a sdl file with enum definitions 1`] = `
"export const schema = gql\`
type Shoe {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,11 @@ model Photo {
metadata Json
}

model Key {
id Int @id @default(autoincrement())
publicKey Bytes
}

/// A list of allowed colors.
enum Color {
RED
Expand Down
55 changes: 45 additions & 10 deletions packages/cli/src/commands/generate/sdl/__tests__/sdl.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,24 @@ globalThis.__dirname = __dirname

globalThis.mockFs = false

// jest.mock('console', () => {
// return {
// info: jest.fn(),
// log: jest.fn(),
// }
// })

// jest.mock('process', () => {
// const actualProcess = jest.requireActual('process')
// return {
// ...actualProcess,
// stdout: {
// ...actualProcess.stdout,
// write: () => true,
// },
// }
// })

jest.mock('fs', () => {
const actual = jest.requireActual('fs')

Expand Down Expand Up @@ -37,7 +55,15 @@ import { ensurePosixPath } from '@redwoodjs/project-config'
import { getDefaultArgs } from '../../../../lib'
import * as sdl from '../sdl'

beforeEach(() => {
// jest.spyOn(console, 'info').mockImplementation(() => {})
// jest.spyOn(console, 'log').mockImplementation(() => {})
})

afterEach(() => {
// console.info.mockRestore()
// console.log.mockRestore()

jest.clearAllMocks()
})

Expand Down Expand Up @@ -203,6 +229,21 @@ const itCreatesAnSDLFileWithJsonDefinitions = (baseArgs = {}) => {
})
}

const itCreatesAnSDLFileWithByteDefinitions = (baseArgs = {}) => {
test('creates a sdl file with Byte definitions', async () => {
const files = await sdl.files({
...baseArgs,
name: 'Key',
crud: true,
})
const ext = extensionForBaseArgs(baseArgs)

expect(
files[path.normalize(`/path/to/project/api/src/graphql/keys.sdl.${ext}`)]
).toMatchSnapshot()
})
}

describe('without graphql documentations', () => {
describe('in javascript mode', () => {
const baseArgs = { ...getDefaultArgs(sdl.defaults), tests: true }
Expand All @@ -215,6 +256,7 @@ describe('without graphql documentations', () => {
itCreateAMultiWordSDLFileWithCRUD(baseArgs)
itCreatesAnSDLFileWithEnumDefinitions(baseArgs)
itCreatesAnSDLFileWithJsonDefinitions(baseArgs)
itCreatesAnSDLFileWithByteDefinitions(baseArgs)
})

describe('in typescript mode', () => {
Expand All @@ -232,6 +274,7 @@ describe('without graphql documentations', () => {
itCreateAMultiWordSDLFileWithCRUD(baseArgs)
itCreatesAnSDLFileWithEnumDefinitions(baseArgs)
itCreatesAnSDLFileWithJsonDefinitions(baseArgs)
itCreatesAnSDLFileWithByteDefinitions(baseArgs)
})
})

Expand All @@ -251,6 +294,7 @@ describe('with graphql documentations', () => {
itCreateAMultiWordSDLFileWithCRUD(baseArgs)
itCreatesAnSDLFileWithEnumDefinitions(baseArgs)
itCreatesAnSDLFileWithJsonDefinitions(baseArgs)
itCreatesAnSDLFileWithByteDefinitions(baseArgs)
})

describe('in typescript mode', () => {
Expand All @@ -269,20 +313,11 @@ describe('with graphql documentations', () => {
itCreateAMultiWordSDLFileWithCRUD(baseArgs)
itCreatesAnSDLFileWithEnumDefinitions(baseArgs)
itCreatesAnSDLFileWithJsonDefinitions(baseArgs)
itCreatesAnSDLFileWithByteDefinitions(baseArgs)
})
})

describe('handler', () => {
beforeEach(() => {
jest.spyOn(console, 'info').mockImplementation(() => {})
jest.spyOn(console, 'log').mockImplementation(() => {})
})

afterEach(() => {
console.info.mockRestore()
console.log.mockRestore()
})

const canBeCalledWithGivenModelName = (letterCase, model) => {
test(`can be called with ${letterCase} model name`, async () => {
const spy = jest.spyOn(fs, 'writeFileSync')
Expand Down
12 changes: 9 additions & 3 deletions packages/cli/src/commands/generate/sdl/sdl.js
Original file line number Diff line number Diff line change
Expand Up @@ -69,13 +69,14 @@ const modelFieldToSDL = ({
field.kind === 'object' ? idType(types[field.type]) : field.type
}

const dictionary = {
const prismaTypeToGraphqlType = {
Json: 'JSON',
Decimal: 'Float',
Bytes: 'Byte',
}

const fieldContent = `${field.name}: ${field.isList ? '[' : ''}${
dictionary[field.type] || field.type
prismaTypeToGraphqlType[field.type] || field.type
}${field.isList ? ']' : ''}${
(field.isRequired && required) | field.isList ? '!' : ''
}`
Expand Down Expand Up @@ -331,6 +332,7 @@ export const handler = async ({
{
title: `Generating types ...`,
task: async () => {
console.log('about to generate types')
const { errors } = await generateTypes()

for (const { message, error } of errors) {
Expand All @@ -344,7 +346,11 @@ export const handler = async ({
},
},
].filter(Boolean),
{ rendererOptions: { collapseSubtasks: false }, exitOnError: true }
{
rendererOptions: { collapseSubtasks: false },
exitOnError: true,
silentRendererCondition: process.env.NODE_ENV === 'test',
}
)

if (rollback && !force) {
Expand Down
Loading

0 comments on commit 4359f5b

Please sign in to comment.