feat: support date and json scalars by default (#1049)

Author: Weakky

package.json

@@ -49,6 +49,7 @@
     "get-port": "^5.1.0",
     "graphql": "^14.5.8",
     "graphql-request": "^2.1.0-next.1",
+    "graphql-scalars": "^1.1.5",
     "http-errors": "^1.7.3",
     "lodash": "^4.17.15",
     "node-fetch": "^2.6.0",

src/lib/nexus-schema-stateful/stateful-nexus-schema.ts

@@ -1,11 +1,13 @@
 import * as NexusSchema from '@nexus/schema'
 import * as GraphQL from 'graphql'
 import * as CustomTypes from './custom-types'
+import * as Scalars from '../scalars'
 
 // todo use this as return type of constructor
 export interface StatefulNexusSchema {
   state: {
     types: NexusSchemaTypeDef[]
+    scalars: Scalars.Scalars
   }
   builders: NexusSchemaStatefulBuilders
 }
@@ -81,6 +83,7 @@ type NexusSchemaTypeDef =
 export function createNexusSchemaStateful() {
   const state: StatefulNexusSchema['state'] = {
     types: [],
+    scalars: {},
   }
 
   function objectType<TypeName extends string>(
@@ -112,6 +115,7 @@ export function createNexusSchemaStateful() {
   ): NexusSchema.core.NexusScalarTypeDef<TypeName> {
     const typeDef = NexusSchema.scalarType(config)
     state.types.push(typeDef)
+    state.scalars[typeDef.name] = new GraphQL.GraphQLScalarType(config)
     return typeDef
   }
 
@@ -159,6 +163,7 @@ export function createNexusSchemaStateful() {
     if (type instanceof GraphQL.GraphQLScalarType && methodName) {
       const typeDef = NexusSchema.asNexusMethod(type, methodName)
       state.types.push(typeDef)
+      state.scalars[typeDef.name] = typeDef
       return typeDef
     }
 

src/lib/plugin/lens.ts

@@ -1,5 +1,6 @@
 import * as Lo from 'lodash'
 import prompts from 'prompts'
+import * as Scalars from '../scalars'
 import * as Layout from '../layout'
 import { rootLogger } from '../nexus-logger'
 import * as Process from '../process'
@@ -17,10 +18,11 @@ export function createBaseLens(pluginName: string): Lens {
   }
 }
 
-export function createRuntimeLens(pluginName: string): RuntimeLens {
+export function createRuntimeLens(pluginName: string, scalars: Scalars.Scalars): RuntimeLens {
   return {
     ...createBaseLens(pluginName),
     shouldGenerateArtifacts: isReflectionStage('typegen'),
+    scalars,
   }
 }
 

src/lib/plugin/load.ts

@@ -3,6 +3,7 @@ import { Either, left, right } from 'fp-ts/lib/Either'
 import * as Lo from 'lodash'
 import * as Layout from '../layout'
 import { rootLogger } from '../nexus-logger'
+import * as Scalars from '../scalars'
 import { partition } from '../utils'
 import { importPluginDimension } from './import'
 import { createBaseLens, createRuntimeLens, createWorktimeLens } from './lens'
@@ -14,7 +15,7 @@ const log = rootLogger.child('plugin')
 /**
  * Fully import and load the runtime plugins, if any, amongst the given plugins.
  */
-export function importAndLoadRuntimePlugins(plugins: Plugin[]) {
+export function importAndLoadRuntimePlugins(plugins: Plugin[], scalars: Scalars.Scalars) {
   const validPlugins = filterValidPlugins(plugins)
 
   const gotManifests = getPluginManifests(validPlugins)
@@ -30,7 +31,7 @@ export function importAndLoadRuntimePlugins(plugins: Plugin[]) {
     })
     .map((plugin) => {
       log.trace('loading runtime plugin', { name: plugin.manifest.name })
-      return plugin.run(createRuntimeLens(plugin.manifest.name))
+      return plugin.run(createRuntimeLens(plugin.manifest.name, scalars))
     })
 }
 

src/lib/plugin/types/lens.ts

@@ -1,6 +1,7 @@
 import * as Logger from '@nexus/logger'
 import * as NexusSchema from '@nexus/schema'
 import * as Prompts from 'prompts'
+import * as Scalars from '../../scalars'
 import * as Testing from '../../../testing/testing'
 import * as Layout from '../../layout'
 import * as PackageManager from '../../package-manager'
@@ -147,6 +148,7 @@ export type Lens = {
 
 export interface RuntimeLens extends Lens {
   shouldGenerateArtifacts: boolean // TODO: Should probably become isReflectionPhase
+  scalars: Scalars.Scalars
 }
 
 export interface TesttimeLens extends Lens {}

src/lib/reflection/fork-script.ts

@@ -26,7 +26,10 @@ async function run() {
 
   if (isReflectionStage('typegen')) {
     try {
-      const plugins = Plugin.importAndLoadRuntimePlugins(app.private.state.plugins)
+      const plugins = Plugin.importAndLoadRuntimePlugins(
+        app.private.state.plugins,
+        app.private.state.schemaComponent.scalars
+      )
       await writeArtifacts({
         graphqlSchema: app.private.state.assembled!.schema,
         layout,

src/lib/scalars/index.ts

@@ -0,0 +1,23 @@
+import { DateTimeResolver, JSONObjectResolver } from 'graphql-scalars'
+import { GraphQLScalarType } from 'graphql'
+
+export type Scalars = Record<string, GraphQLScalarType>
+
+interface BuiltinScalars {
+  Date: GraphQLScalarType
+  Json: GraphQLScalarType
+  [x: string]: GraphQLScalarType
+}
+
+export const builtinScalars: BuiltinScalars = {
+  Date: new GraphQLScalarType({
+    ...DateTimeResolver,
+    name: 'Date',
+  }),
+  Json: new GraphQLScalarType({
+    ...JSONObjectResolver,
+    name: 'Json',
+    description:
+      'The `JSON` scalar type represents JSON objects as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf).',
+  }),
+}

src/runtime/app.ts

@@ -10,6 +10,7 @@ import * as Server from './server'
 import { ContextCreator } from './server/server'
 import * as Settings from './settings'
 import { assertAppNotAssembled } from './utils'
+import { builtinScalars } from '../lib/scalars'
 
 const log = Logger.log.child('app')
 
@@ -120,17 +121,7 @@ export function create(): App {
     log: Logger.log,
   })
 
-  /**
-   * Setup default log filter
-   */
-
-  settingsComponent.public.change({
-    logger: {
-      filter: 'app:*, nexus:*@info+, *@warn+',
-    },
-  })
-
-  const api: App = {
+  const app: App = {
     log: log,
     settings: settingsComponent.public,
     schema: schemaComponent.public,
@@ -148,6 +139,8 @@ export function create(): App {
     assemble() {
       if (appState.assembled) return
 
+      schemaComponent.private.beforeAssembly()
+
       /**
        * Plugin reflection is run in the same process (eval). This means if the
        * process is the app, which it is during testing for example, then we
@@ -159,7 +152,10 @@ export function create(): App {
 
       appState.assembled = {} as AppState['assembled']
 
-      const loadedPlugins = Plugin.importAndLoadRuntimePlugins(appState.plugins)
+      const loadedPlugins = Plugin.importAndLoadRuntimePlugins(
+        appState.plugins,
+        appState.schemaComponent.scalars
+      )
       appState.assembled!.loadedPlugins = loadedPlugins
 
       const { schema, missingTypes } = schemaComponent.private.assemble(loadedPlugins)
@@ -194,8 +190,23 @@ export function create(): App {
     },
   }
 
+  /**
+   * Setup default log filter
+   */
+  app.settings.change({
+    logger: {
+      filter: 'app:*, nexus:*@info+, *@warn+',
+    },
+  })
+
+  /**
+   * Setup default scalar types
+   */
+  app.schema.importType(builtinScalars.Date, 'date')
+  app.schema.importType(builtinScalars.Json, 'json')
+
   return {
-    ...api,
+    ...app,
     private: {
       state: appState,
     },

src/runtime/schema/schema.ts

@@ -1,6 +1,6 @@
 import * as NexusLogger from '@nexus/logger'
 import * as NexusSchema from '@nexus/schema'
-import { GraphQLFieldResolver, GraphQLResolveInfo } from 'graphql'
+import { GraphQLFieldResolver, GraphQLResolveInfo, GraphQLScalarType } from 'graphql'
 import * as HTTP from 'http'
 import { createNexusSchemaStateful, NexusSchemaStatefulBuilders } from '../../lib/nexus-schema-stateful'
 import { RuntimeContributions } from '../../lib/plugin'
@@ -10,16 +10,19 @@ import { assertAppNotAssembled } from '../utils'
 import { log } from './logger'
 import { createSchemaSettingsManager, SchemaSettingsManager } from './settings'
 import { mapSettingsAndPluginsToNexusSchemaConfig } from './settings-mapper'
+import * as Scalars from '../../lib/scalars'
 
 export type LazyState = {
   contextContributors: ContextContributor[]
   plugins: NexusSchema.core.NexusPlugin[]
+  scalars: Scalars.Scalars
 }
 
 function createLazyState(): LazyState {
   return {
     contextContributors: [],
     plugins: [],
+    scalars: {},
   }
 }
 
@@ -72,6 +75,7 @@ export interface SchemaInternal {
     assemble(
       plugins: RuntimeContributions[]
     ): { schema: NexusSchema.core.NexusGraphQLSchema; missingTypes: Index<NexusSchema.core.MissingType> }
+    beforeAssembly(): void
     reset(): void
   }
   public: Schema
@@ -110,10 +114,15 @@ export function create(appState: AppState): SchemaInternal {
       settings: settings,
       reset() {
         statefulNexusSchema.state.types = []
+        statefulNexusSchema.state.scalars = {}
         appState.schemaComponent.contextContributors = []
         appState.schemaComponent.plugins = []
+        appState.schemaComponent.scalars = {}
       },
-      assemble: (plugins) => {
+      beforeAssembly() {
+        appState.schemaComponent.scalars = statefulNexusSchema.state.scalars
+      },
+      assemble(plugins) {
         const nexusSchemaConfig = mapSettingsAndPluginsToNexusSchemaConfig(plugins, settings.data)
         nexusSchemaConfig.types.push(...statefulNexusSchema.state.types)
         nexusSchemaConfig.plugins!.push(...appState.schemaComponent.plugins)
@@ -122,7 +131,12 @@ export function create(appState: AppState): SchemaInternal {
       },
       checks() {
         NexusSchema.core.assertNoMissingTypes(appState.assembled!.schema, appState.assembled!.missingTypes)
-        if (statefulNexusSchema.state.types.length === 0) {
+        
+        // TODO: We should separate types added by the framework and the ones added by users
+        if (
+          statefulNexusSchema.state.types.length === 2 &&
+          statefulNexusSchema.state.types.every((t) => Scalars.builtinScalars[t.name] !== undefined)
+        ) {
           log.warn(emptyExceptionMessage())
         }
       },

src/runtime/schema/settings.ts

@@ -60,7 +60,7 @@ export type SettingsInput = {
   /**
    * Disable or configure the authorization plugin
    */
-  authorization?: false | NexusSchema.core.FieldAuthorizePluginConfig,
+  authorization?: false | NexusSchema.core.FieldAuthorizePluginConfig
   /**
    * Should a [GraphQL SDL file](https://www.prisma.io/blog/graphql-sdl-schema-definition-language-6755bcb9ce51) be generated when the app is built and to where?
    *
@@ -171,7 +171,7 @@ function defaultSettings(): SettingsData {
         ...connectionPluginConfigManagedByNexus,
       },
     },
-    authorization: {}
+    authorization: {},
   }
 
   return data

test/system/__snapshots__/create-prisma-app.test.ts.snap

@@ -1034,6 +1034,26 @@ In some cases, you need to provide options to alter GraphQL's execution behavior
         "name": "__DirectiveLocation",
         "possibleTypes": null,
       },
+      Object {
+        "description": "Use JavaScript Date object for date/time fields.",
+        "enumValues": null,
+        "fields": null,
+        "inputFields": null,
+        "interfaces": null,
+        "kind": "SCALAR",
+        "name": "Date",
+        "possibleTypes": null,
+      },
+      Object {
+        "description": "The \`JSON\` scalar type represents JSON objects as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf).",
+        "enumValues": null,
+        "fields": null,
+        "inputFields": null,
+        "interfaces": null,
+        "kind": "SCALAR",
+        "name": "Json",
+        "possibleTypes": null,
+      },
     ],
   },
 }