Skip to content

Commit 74d0a82

Browse files
codinsonncodinsonn
committed
feat: Add buildSchema() script & isomorphic graphqlQuery() helper
1 parent 7f2388b commit 74d0a82

18 files changed

+452
-57
lines changed

‎apps/expo/tsconfig.json‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
{
22
"extends": "@app/core/tsconfig",
3-
"include": ["**/*.ts", "**/*.tsx"],
3+
"include": [
4+
"**/*.ts",
5+
"**/*.tsx",
6+
"../../features/app-core/graphql-env.d.ts"
7+
],
48
"exclude": ["node_modules"]
59
}

‎apps/next/tsconfig.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
"include": [
44
"**/*.ts",
55
"**/*.tsx",
6-
".next/types/**/*.ts"
6+
".next/types/**/*.ts",
7+
"../../features/app-core/graphql-env.d.ts"
78
],
89
"exclude": [
910
"node_modules"

‎features/app-core/fetchers/useHealthCheckQuery.ts‎

Lines changed: 0 additions & 33 deletions
This file was deleted.

‎features/app-core/graphql-env.d.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export type introspection = {
1717
'Query': { kind: 'OBJECT'; name: 'Query'; fields: { 'healthCheck': { name: 'healthCheck'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'OBJECT'; name: 'HealthCheckData'; ofType: null; }; } }; }; };
1818
'HealthCheckArgs': { kind: 'INPUT_OBJECT'; name: 'HealthCheckArgs'; inputFields: [{ name: 'echo'; type: { kind: 'SCALAR'; name: 'String'; ofType: null; }; defaultValue: null }]; };
1919
'String': unknown;
20-
'HealthCheckData': { kind: 'OBJECT'; name: 'HealthCheckData'; fields: { 'echo': { name: 'echo'; type: { kind: 'SCALAR'; name: 'String'; ofType: null; } }; 'status': { name: 'status'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'String'; ofType: null; }; } }; 'alive': { name: 'alive'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'Boolean'; ofType: null; }; } }; 'kicking': { name: 'kicking'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'Boolean'; ofType: null; }; } }; 'now': { name: 'now'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'String'; ofType: null; }; } }; 'aliveTime': { name: 'aliveTime'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'Float'; ofType: null; }; } }; 'aliveSince': { name: 'aliveSince'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'String'; ofType: null; }; } }; 'serverTimezone': { name: 'serverTimezone'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'String'; ofType: null; }; } }; 'requestHost': { name: 'requestHost'; type: { kind: 'SCALAR'; name: 'String'; ofType: null; } }; 'requestProtocol': { name: 'requestProtocol'; type: { kind: 'SCALAR'; name: 'String'; ofType: null; } }; 'requestURL': { name: 'requestURL'; type: { kind: 'SCALAR'; name: 'String'; ofType: null; } }; 'baseURL': { name: 'baseURL'; type: { kind: 'SCALAR'; name: 'String'; ofType: null; } }; 'apiURL': { name: 'apiURL'; type: { kind: 'SCALAR'; name: 'String'; ofType: null; } }; 'port': { name: 'port'; type: { kind: 'SCALAR'; name: 'Int'; ofType: null; } }; 'debugPort': { name: 'debugPort'; type: { kind: 'SCALAR'; name: 'Int'; ofType: null; } }; 'nodeVersion': { name: 'nodeVersion'; type: { kind: 'SCALAR'; name: 'String'; ofType: null; } }; 'v8Version': { name: 'v8Version'; type: { kind: 'SCALAR'; name: 'String'; ofType: null; } }; 'systemArch': { name: 'systemArch'; type: { kind: 'SCALAR'; name: 'String'; ofType: null; } }; 'systemPlatform': { name: 'systemPlatform'; type: { kind: 'SCALAR'; name: 'String'; ofType: null; } }; 'systemRelease': { name: 'systemRelease'; type: { kind: 'SCALAR'; name: 'String'; ofType: null; } }; 'systemFreeMemory': { name: 'systemFreeMemory'; type: { kind: 'SCALAR'; name: 'Float'; ofType: null; } }; 'systemTotalMemory': { name: 'systemTotalMemory'; type: { kind: 'SCALAR'; name: 'Float'; ofType: null; } }; 'systemLoadAverage': { name: 'systemLoadAverage'; type: { kind: 'LIST'; name: never; ofType: { kind: 'SCALAR'; name: 'Float'; ofType: null; }; } }; }; };
20+
'HealthCheckData': { kind: 'OBJECT'; name: 'HealthCheckData'; fields: { 'echo': { name: 'echo'; type: { kind: 'SCALAR'; name: 'String'; ofType: null; } }; 'status': { name: 'status'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'String'; ofType: null; }; } }; 'alive': { name: 'alive'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'Boolean'; ofType: null; }; } }; 'kicking': { name: 'kicking'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'Boolean'; ofType: null; }; } }; 'now': { name: 'now'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'String'; ofType: null; }; } }; 'aliveTime': { name: 'aliveTime'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'Float'; ofType: null; }; } }; 'aliveSince': { name: 'aliveSince'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'String'; ofType: null; }; } }; 'serverTimezone': { name: 'serverTimezone'; type: { kind: 'NON_NULL'; name: never; ofType: { kind: 'SCALAR'; name: 'String'; ofType: null; }; } }; 'requestHost': { name: 'requestHost'; type: { kind: 'SCALAR'; name: 'String'; ofType: null; } }; 'requestProtocol': { name: 'requestProtocol'; type: { kind: 'SCALAR'; name: 'String'; ofType: null; } }; 'requestURL': { name: 'requestURL'; type: { kind: 'SCALAR'; name: 'String'; ofType: null; } }; 'baseURL': { name: 'baseURL'; type: { kind: 'SCALAR'; name: 'String'; ofType: null; } }; 'backendURL': { name: 'backendURL'; type: { kind: 'SCALAR'; name: 'String'; ofType: null; } }; 'apiURL': { name: 'apiURL'; type: { kind: 'SCALAR'; name: 'String'; ofType: null; } }; 'graphURL': { name: 'graphURL'; type: { kind: 'SCALAR'; name: 'String'; ofType: null; } }; 'port': { name: 'port'; type: { kind: 'SCALAR'; name: 'Int'; ofType: null; } }; 'debugPort': { name: 'debugPort'; type: { kind: 'SCALAR'; name: 'Int'; ofType: null; } }; 'nodeVersion': { name: 'nodeVersion'; type: { kind: 'SCALAR'; name: 'String'; ofType: null; } }; 'v8Version': { name: 'v8Version'; type: { kind: 'SCALAR'; name: 'String'; ofType: null; } }; 'systemArch': { name: 'systemArch'; type: { kind: 'SCALAR'; name: 'String'; ofType: null; } }; 'systemPlatform': { name: 'systemPlatform'; type: { kind: 'SCALAR'; name: 'String'; ofType: null; } }; 'systemRelease': { name: 'systemRelease'; type: { kind: 'SCALAR'; name: 'String'; ofType: null; } }; 'systemFreeMemory': { name: 'systemFreeMemory'; type: { kind: 'SCALAR'; name: 'Float'; ofType: null; } }; 'systemTotalMemory': { name: 'systemTotalMemory'; type: { kind: 'SCALAR'; name: 'Float'; ofType: null; } }; 'systemLoadAverage': { name: 'systemLoadAverage'; type: { kind: 'LIST'; name: never; ofType: { kind: 'SCALAR'; name: 'Float'; ofType: null; }; } }; }; };
2121
'Boolean': unknown;
2222
'Float': unknown;
2323
'Int': unknown;

‎features/app-core/graphql/buildSchema.ts‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
#!/usr/bin/env node --experimental-specifier-resolution=node
2+
import path from 'path'
3+
import fs from 'fs'
4+
import { fileURLToPath } from 'node:url'
5+
import { loadFilesSync } from '@graphql-tools/load-files'
6+
import { mergeTypeDefs } from '@graphql-tools/merge'
7+
import { print } from 'graphql'
8+
9+
/* --- Constants ------------------------------------------------------------------------------- */
10+
11+
const currentDir = path.dirname(fileURLToPath(import.meta.url))
12+
const schemaPath = path.resolve(currentDir, 'schema.graphql')
13+
const typeDefsPath = path.resolve(currentDir, 'typeDefs.ts')
14+
15+
/** --- createSchemaDefinitions() -------------------------------------------------------------- */
16+
/** -i- Combine all custom and other (e.g. generated) graphql schema definitions */
17+
export const createSchemaDefinitions = () => {
18+
const rootDir = path.resolve(currentDir, '../../..')
19+
const schemaPathPattern = `${rootDir}/(features|packages)/**/!(schema).graphql`
20+
const customGraphQLDefinitions = loadFilesSync(schemaPathPattern)
21+
return mergeTypeDefs([
22+
...customGraphQLDefinitions,
23+
/* other typedefs? */
24+
])
25+
}
26+
27+
/* --- Script ---------------------------------------------------------------------------------- */
28+
29+
const buildSchemaDefinitions = async () => {
30+
const schemaDefinitions = createSchemaDefinitions()
31+
const typeDefsString = print(schemaDefinitions)
32+
fs.writeFileSync(schemaPath, typeDefsString)
33+
fs.writeFileSync(typeDefsPath, `export const typeDefs = \`${typeDefsString}\``)
34+
}
35+
36+
buildSchemaDefinitions()

‎features/app-core/graphql/graphqlQuery.ts‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
import { print } from 'graphql/language/printer'
2+
import type { TadaDocumentNode, ResultOf } from 'gql.tada'
3+
import type { QueryConfig } from './graphqlQuery.types'
4+
import { appConfig } from '../appConfig'
5+
6+
/** --- graphqlQuery --------------------------------------------------------------------------- */
7+
/** -i- Isomorphic graphql request, uses the graphql endpoint in browser & mobile, but the executable schema serverside */
8+
export const graphqlQuery = async <T extends TadaDocumentNode, R = ResultOf<T>>(query: T, config?: QueryConfig<T>) => {
9+
// Config
10+
const { variables, headers, graphqlEndpoint } = config || {}
11+
12+
// Vars
13+
const queryString = print(query)
14+
15+
// -- Native: Execute query with fetch --
16+
17+
try {
18+
const { graphURL } = appConfig
19+
const fetchURL = graphqlEndpoint || graphURL
20+
const res = await fetch(fetchURL, {
21+
method: 'POST',
22+
headers: {
23+
'Content-Type': 'application/json',
24+
...headers,
25+
},
26+
body: JSON.stringify({ query: queryString, variables }),
27+
})
28+
const { data, errors } = await res.json()
29+
if (errors) throw new Error(errors[0].message)
30+
return data as R
31+
} catch (error) {
32+
throw new Error(error)
33+
}
34+
}
35+

‎features/app-core/graphql/graphqlQuery.types.ts‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import type { TadaDocumentNode, VariablesOf } from 'gql.tada'
2+
3+
export type QueryConfig<T extends TadaDocumentNode> = {
4+
variables?: VariablesOf<T>
5+
headers?: Record<string, string>
6+
graphqlEndpoint?: string
7+
}

‎features/app-core/graphql/graphqlQuery.web.ts‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
import { print } from 'graphql/language/printer'
2+
import type { TadaDocumentNode, ResultOf } from 'gql.tada'
3+
import type { QueryConfig } from './graphqlQuery.types'
4+
import { appConfig } from '../appConfig'
5+
6+
/** --- graphqlQuery --------------------------------------------------------------------------- */
7+
/** -i- Isomorphic graphql request, uses the graphql endpoint in browser & mobile, but the executable schema serverside */
8+
export const graphqlQuery = async <T extends TadaDocumentNode, R = ResultOf<T>>(query: T, config?: QueryConfig<T>) => {
9+
// Config
10+
const { variables, headers, graphqlEndpoint } = config || {}
11+
12+
// Flags
13+
const isServer = typeof window === 'undefined'
14+
15+
// Vars
16+
const queryString = print(query)
17+
18+
// -- Server: Execute query with lazy loaded schema --
19+
20+
if (isServer) {
21+
try {
22+
const [
23+
{ graphql },
24+
{ executableSchema },
25+
] = await Promise.all([
26+
import('graphql'),
27+
import('./schema'),
28+
])
29+
const { data } = await graphql({
30+
schema: executableSchema,
31+
source: queryString,
32+
variableValues: variables,
33+
}) as { data: R }
34+
return data
35+
} catch (error) {
36+
throw new Error(error)
37+
}
38+
}
39+
40+
// -- Browser: Execute query with fetch --
41+
42+
try {
43+
const { graphURL } = appConfig
44+
const fetchURL = graphqlEndpoint || graphURL
45+
const res = await fetch(fetchURL, {
46+
method: 'POST',
47+
headers: {
48+
'Content-Type': 'application/json',
49+
...headers,
50+
},
51+
body: JSON.stringify({ query: queryString, variables }),
52+
})
53+
const { data, errors } = await res.json()
54+
if (errors) throw new Error(errors[0].message)
55+
return data as R
56+
} catch (error) {
57+
throw new Error(error)
58+
}
59+
}
60+

‎features/app-core/graphql/schema.graphql‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
type Query {
2+
healthCheck(args: HealthCheckArgs): HealthCheckData!
3+
}
4+
5+
input HealthCheckArgs {
6+
echo: String
7+
}
8+
9+
type HealthCheckData {
10+
echo: String
11+
status: String!
12+
alive: Boolean!
13+
kicking: Boolean!
14+
now: String!
15+
aliveTime: Float!
16+
aliveSince: String!
17+
serverTimezone: String!
18+
requestHost: String
19+
requestProtocol: String
20+
requestURL: String
21+
baseURL: String
22+
backendURL: String
23+
apiURL: String
24+
graphURL: String
25+
port: Int
26+
debugPort: Int
27+
nodeVersion: String
28+
v8Version: String
29+
systemArch: String
30+
systemPlatform: String
31+
systemRelease: String
32+
systemFreeMemory: Float
33+
systemTotalMemory: Float
34+
systemLoadAverage: [Float]
35+
}
36+
37+
schema {
38+
query: Query
39+
}

‎features/app-core/graphql/schema.ts‎

Lines changed: 4 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
1-
import path from 'path'
2-
import { fileURLToPath } from 'node:url'
3-
import { loadFilesSync } from '@graphql-tools/load-files'
4-
import { mergeTypeDefs, mergeResolvers } from '@graphql-tools/merge'
1+
import { mergeResolvers } from '@graphql-tools/merge'
52
import { makeExecutableSchema } from '@graphql-tools/schema'
3+
import { gql } from 'graphql-tag'
64
import type { RequestContext } from '../middleware/createRequestContext'
5+
import { typeDefs } from './typeDefs'
76
import { healthCheck } from '../resolvers/healthCheck'
87

98
/** --- createResolver() ----------------------------------------------------------------------- */
@@ -29,23 +28,10 @@ export const createRootResolver = () => mergeResolvers([
2928
/* other resolvers? */
3029
])
3130

32-
/** --- createSchemaDefinitions() -------------------------------------------------------------- */
33-
/** -i- Combine all custom and other (e.g. generated) graphql schema definitions */
34-
export const createSchemaDefinitions = () => {
35-
const currentDir = path.dirname(fileURLToPath(import.meta.url))
36-
const rootDir = path.resolve(currentDir, '../../..')
37-
const schemaPathPattern = `${rootDir}/(features|packages)/**/*.graphql`
38-
const customGraphQLDefinitions = loadFilesSync(schemaPathPattern)
39-
return mergeTypeDefs([
40-
...customGraphQLDefinitions,
41-
/* other typedefs? */
42-
])
43-
}
44-
4531
/* --- Schema ---------------------------------------------------------------------------------- */
4632

4733
export const schemaBundle = {
48-
typeDefs: createSchemaDefinitions(),
34+
typeDefs: gql`${typeDefs}`,
4935
resolvers: createRootResolver(),
5036
}
5137

0 commit comments

Comments
 (0)