@toptal/davinci-graphql-codegen 0.4.2-alpha-fx-3227-migrate-graphql-codegen-to-esm-b0005a16.21 → 0.4.2

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @toptal/davinci-graphql-codegen
 
+## 0.4.2
+
+### Patch Changes
+
+- Updated dependencies [[`1457314e`](https://github.com/toptal/davinci/commit/1457314e7f449146077753dcc467565e6ce4d3d2)]:
+  - @toptal/davinci-cli-shared@1.10.2
+  - @toptal/davinci-monorepo@6.8.8
+
 ## 0.4.1
 
 ### Patch Changes

package/bin/davinci-graphql-codegen.js

@@ -1,8 +1,9 @@
 #!/usr/bin/env node
-import cliEngine from '@toptal/davinci-cli-shared'
 
-import codegenGenerateSchemaCreator from '../src/commands/generate-schema.js'
-import codegenGenerateOperationsCreator from '../src/commands/generate-operations.js'
+const cliEngine = require('@toptal/davinci-cli-shared')
+
+const codegenGenerateSchemaCreator = require('../src/commands/generate-schema')
+const codegenGenerateOperationsCreator = require('../src/commands/generate-operations')
 
 cliEngine.loadCommands(
   [codegenGenerateSchemaCreator, codegenGenerateOperationsCreator],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-graphql-codegen",
-  "version": "0.4.2-alpha-fx-3227-migrate-graphql-codegen-to-esm-b0005a16.21+b0005a16",
+  "version": "0.4.2",
   "description": "Codegen",
   "author": "Toptal",
   "license": "ISC",
@@ -11,12 +11,14 @@
   "bin": {
     "davinci-graphql-codegen": "./bin/davinci-graphql-codegen.js"
   },
-  "type": "module",
-  "exports": "./index.js",
+  "main": "src/index.js",
+  "files": [
+    "src",
+    "bin",
+    "CHANGELOG.md"
+  ],
   "scripts": {
-    "build:package": "../../bin/build-package.js",
-    "prepublishOnly": "../../bin/prepublish.js",
-    "test": "NODE_OPTIONS='--experimental-vm-modules --no-warnings' yarn jest"
+    "test": "echo \"Error: no test specified\" && exit 1"
   },
   "sideEffects": false,
   "dependencies": {
@@ -30,19 +32,15 @@
     "@graphql-codegen/typescript-operations": "^2.3.5",
     "@graphql-codegen/typescript-resolvers": "^2.2.1",
     "@graphql-typed-document-node/core": "^3.1.0",
-    "@toptal/davinci-cli-shared": "1.10.2-alpha-fx-3227-migrate-graphql-codegen-to-esm-b0005a16.21+b0005a16",
-    "@toptal/davinci-monorepo": "6.8.8-alpha-fx-3227-migrate-graphql-codegen-to-esm-b0005a16.21+b0005a16",
+    "@toptal/davinci-cli-shared": "^1.10.2",
+    "@toptal/davinci-monorepo": "6.8.8",
     "chalk": "^4.1.2",
     "deepmerge": "^4.2.2",
-    "fs-extra": "^10.1.0",
-    "graphql": "^15.7.1"
+    "graphql": "^15.7.1",
+    "prettier": "^2.6.2",
+    "fs-extra": "^10.1.0"
   },
   "peerDependencies": {
     "prettier": "^2.6.2"
-  },
-  "devDependencies": {
-    "@jest/globals": "^29.3.1",
-    "prettier": "^2.6.2"
-  },
-  "gitHead": "b0005a1651c57d39a2a20fc68fb19d2908470c09"
+  }
 }

package/src/commands/generate-operations.js

@@ -1,7 +1,7 @@
-import chalk from 'chalk'
+const chalk = require('chalk')
 
-import { generateOperations } from '../generate/index.js'
-import readConfig from '../read-config/index.js'
+const { generateOperations } = require('../generate')
+const readConfig = require('../read-config')
 
 const codegenGenerateOperations = async ({ config, extension = '.ts' }) => {
   const codegen = await readConfig(config)
@@ -40,4 +40,4 @@ const codegenGenerateOperationsCreator = {
   },
 }
 
-export default codegenGenerateOperationsCreator
+module.exports = codegenGenerateOperationsCreator

package/src/commands/generate-schema.js

@@ -1,7 +1,7 @@
-import chalk from 'chalk'
+const chalk = require('chalk')
 
-import { generateSchema } from '../generate/index.js'
-import readConfig from '../read-config/index.js'
+const { generateSchema } = require('../generate')
+const readConfig = require('../read-config')
 
 const codegenGenerateSchema = async ({ projectId = 'toptal-hub', config }) => {
   const codegen = await readConfig(config)
@@ -36,4 +36,4 @@ const codegenGenerateSchemaCreator = {
   },
 }
 
-export default codegenGenerateSchemaCreator
+module.exports = codegenGenerateSchemaCreator

package/src/config/config.js

@@ -23,7 +23,7 @@ const commonTypesConfig = {
   },
 }
 
-export const commonSchemaTypesConfig = {
+const commonSchemaTypesConfig = {
   ...commonTypesConfig,
   resolverTypeWrapperSignature:
     '(parent: unknown, args: any) => ({ [K in keyof Partial<T>]: TypeOrMockList<T[K]> }) | null',
@@ -33,17 +33,17 @@ export const commonSchemaTypesConfig = {
   optionalResolveType: true,
 }
 
-export const commonOperationTypesConfig = {
+const commonOperationTypesConfig = {
   ...commonTypesConfig,
   dedupeFragments: true,
 }
 
-export const autoGenerationComments = [
+const autoGenerationComments = [
   '/* eslint-disable */',
   '/* ⚠️ THIS IS AN AUTOGENERATED FILE, DO NOT EDIT ⚠️  */',
 ]
 
-export default {
+module.exports = {
   commonOperationTypesConfig,
   commonSchemaTypesConfig,
   autoGenerationComments,

package/src/config/index.js

@@ -1,3 +1,3 @@
-import config from './config.js'
+const config = require('./config')
 
-export default config
+module.exports = config

package/src/generate/index.js

@@ -1,5 +1,4 @@
-import generateOperations from './operations.js'
-import generateSchema from './schema.js'
+const generateOperations = require('./operations')
+const generateSchema = require('./schema')
 
-export { generateOperations, generateSchema }
-export default { generateOperations, generateSchema }
+module.exports = { generateOperations, generateSchema }

package/src/generate/operations.js

@@ -1,18 +1,16 @@
-import chalk from 'chalk'
-import { generate } from '@graphql-codegen/cli'
-import fs from 'fs-extra'
-import prettier from 'prettier'
-import { dirname } from 'path'
-import merge from 'deepmerge'
+const chalk = require('chalk')
+const { generate } = require('@graphql-codegen/cli')
+const { readFileSync, writeFileSync } = require('fs-extra')
+const prettier = require('prettier')
+const { dirname } = require('path')
+const merge = require('deepmerge')
 
-import {
+const {
   commonOperationTypesConfig,
   autoGenerationComments,
-} from '../config/config.js'
-import getSchemaPath from '../services/get-schema-path.js'
-import getRelativeFilePath from '../utils/get-relative-file-path.js'
-
-const { readFileSync, writeFileSync } = fs
+} = require('../config/config')
+const getSchemaPath = require('../services/get-schema-path')
+const getRelativeFilePath = require('../utils/get-relative-file-path')
 
 const generateOperations = async ({ schema, documents, extension, config }) => {
   const docsPath = getRelativeFilePath(documents)
@@ -67,4 +65,4 @@ const generateOperations = async ({ schema, documents, extension, config }) => {
   )
 }
 
-export default generateOperations
+module.exports = generateOperations

package/src/generate/schema.js

@@ -1,18 +1,15 @@
-import { generate } from '@graphql-codegen/cli'
-import chalk from 'chalk'
-import { createRequire } from 'module'
-import { readFileSync, writeFileSync } from 'fs'
-import prettier from 'prettier'
-import { dirname } from 'path'
+const { generate } = require('@graphql-codegen/cli')
+const chalk = require('chalk')
+const { readFileSync, writeFileSync } = require('fs')
+const prettier = require('prettier')
+const { dirname } = require('path')
 
-import {
+const {
   commonSchemaTypesConfig,
   autoGenerationComments,
-} from '../config/config.js'
-import schemaLoader from '../services/schema-loader.js'
-import { isSchemaFromHttp } from '../utils/detect-schema-source.js'
-
-const localRequire = createRequire(import.meta.url)
+} = require('../config/config')
+const schemaLoader = require('../services/schema-loader')
+const { isSchemaFromHttp } = require('../utils/detect-schema-source')
 
 const generateSchema = async ({ schema, target, projectId }) => {
   const { schema: schemaPath, destination: destinationPathTs } =
@@ -30,7 +27,7 @@ const generateSchema = async ({ schema, target, projectId }) => {
         [destinationPathTs]: {
           schema: isSchemaFromHttp(schema)
             ? schema
-            : localRequire.resolve(schemaPath),
+            : require.resolve(schemaPath),
           plugins: [
             'typescript',
             'typescript-resolvers',
@@ -67,4 +64,4 @@ const generateSchema = async ({ schema, target, projectId }) => {
   )
 }
 
-export default generateSchema
+module.exports = generateSchema

package/src/index.js

@@ -1,8 +1,8 @@
-import codegenGenerateSchemaCreator from './commands/generate-schema.js'
-import codegenGenerateOperationsCreator from './commands/generate-operations.js'
-import config from './config'
+const codegenGenerateSchemaCreator = require('./commands/generate-schema')
+const codegenGenerateOperationsCreator = require('./commands/generate-operations')
+const config = require('./config')
 
-export default {
+module.exports = {
   commands: [codegenGenerateSchemaCreator, codegenGenerateOperationsCreator],
   config,
 }

package/src/read-config/index.js

@@ -1,3 +1,3 @@
-import readConfig from './read-config.js'
+const readConfig = require('./read-config')
 
-export default readConfig
+module.exports = readConfig

package/src/read-config/read-config.js

@@ -1,32 +1,13 @@
-import chalk from 'chalk'
-import { createRequire } from 'module'
+const chalk = require('chalk')
 
-import getRelativeFilePath from '../utils/get-relative-file-path.js'
-import toArray from '../utils/to-array.js'
-
-const importCodgenConfig = async path => {
-  try {
-    const localRequire = createRequire(import.meta.url)
-
-    return localRequire(path)
-  } catch (err) {
-    if (err.code === 'ERR_REQUIRE_ESM') {
-      const result = await import(path)
-
-      if (!result.default) {
-        throw Error('codegen has no default export')
-      }
-
-      return result.default
-    }
-  }
-}
+const getRelativeFilePath = require('../utils/get-relative-file-path')
+const toArray = require('../utils/to-array')
 
 const readConfig = async config => {
-  const configFileName = config ? config.split('/').pop() : 'codegen.json'
-
   let codegenPath
 
+  const configFileName = config ? config.split('/').pop() : 'codegen.json'
+
   if (config) {
     console.log(
       `🔍 Searching for ${chalk.bold(
@@ -38,13 +19,15 @@ const readConfig = async config => {
     console.log(`🔍 Searching for ${chalk.bold(configFileName)} file`)
     codegenPath = getRelativeFilePath(configFileName)
   }
+  let codegenConfig
 
   try {
-    return toArray(await importCodgenConfig(codegenPath))
+    codegenConfig = require(codegenPath)
   } catch (error) {
-    console.log(error)
     throw new Error(`❌ There is no ${chalk.bold(configFileName)} file`)
   }
+
+  return toArray(codegenConfig)
 }
 
-export default readConfig
+module.exports = readConfig

package/src/services/get-monolith-schema-path.js

@@ -1,15 +1,11 @@
-import getRelativeFilePath from '../utils/get-relative-file-path.js'
+const getRelativeFilePath = require('../utils/get-relative-file-path')
 
-export const createGetMonolithSchemaPathResolver =
-  relativeFilePathResolver => schemaPath => {
-    const schemaPathResolution = relativeFilePathResolver(
-      `${schemaPath}/schema.graphql`
-    )
+const getMonolithSchemaPath = schemaPath => {
+  const schemaPathResolution = getRelativeFilePath(
+    `${schemaPath}/schema.graphql`
+  )
 
-    return { target: schemaPath, schemaPath, schemaPathResolution }
-  }
+  return { target: schemaPath, schemaPath, schemaPathResolution }
+}
 
-const getMonolithSchemaPath =
-  createGetMonolithSchemaPathResolver(getRelativeFilePath)
-
-export default getMonolithSchemaPath
+module.exports = getMonolithSchemaPath

package/src/services/get-monorepo-schema-path.js

@@ -1,22 +1,14 @@
-import { createRequire } from 'module'
-
-const localRequire = createRequire(import.meta.url)
-
-export const createGetMonorepoSchemaPathResolver = pathResolver => schema => {
+const getMonorepoSchemaPath = schema => {
   // @toptal/modularity-template-graphql/talent -> talent
   const target = schema.split('/').pop()
   // @toptal/modularity-template-graphql/talent -> @toptal/modularity-template-graphql
   const schemaPath = schema.split('/').slice(0, 2).join('/')
 
-  const schemaPathResolution = pathResolver(
+  const schemaPathResolution = require.resolve(
     `${schemaPath}/${target}/schema.graphql`
   )
 
   return { target, schemaPath, schemaPathResolution }
 }
 
-const getMonorepoSchemaPath = createGetMonorepoSchemaPathResolver(
-  localRequire.resolve
-)
-
-export default getMonorepoSchemaPath
+module.exports = getMonorepoSchemaPath

package/src/services/get-schema-path.js

@@ -1,16 +1,14 @@
-import monorepo from '@toptal/davinci-monorepo'
+const {
+  utils: { checkIfMonorepo },
+} = require('@toptal/davinci-monorepo')
 
-import getMonorepoSchemaPath from './get-monorepo-schema-path.js'
-import getMonolithSchemaPath from './get-monolith-schema-path.js'
-
-const { checkIfMonorepo } = monorepo.utils
+const getMonorepoSchemaPath = require('./get-monorepo-schema-path')
+const getMonolithSchemaPath = require('./get-monolith-schema-path')
 
 const getSchemaPath = schema => {
-  if (checkIfMonorepo({ considerYarnWorkspaces: true })) {
-    return getMonorepoSchemaPath(schema)
-  }
-
-  return getMonolithSchemaPath(schema)
+  return checkIfMonorepo({ considerYarnWorkspaces: true })
+    ? getMonorepoSchemaPath(schema)
+    : getMonolithSchemaPath(schema)
 }
 
-export default getSchemaPath
+module.exports = getSchemaPath

package/src/services/get-schema-path.test.js

@@ -0,0 +1,71 @@
+jest.mock('@toptal/davinci-monorepo', () => ({
+  commands: [],
+  utils: { checkIfMonorepo: jest.fn() },
+}))
+
+jest.mock('./get-monorepo-schema-path', () =>
+  jest.fn(() => ({
+    target: 'talent',
+    schemaPath: '@toptal/modularity-template-graphql',
+    schemaPathResolution:
+      'home/users/alexvcasillas/toptal/libs/graphql/schema.graphql',
+  }))
+)
+
+jest.mock('./get-monolith-schema-path', () =>
+  jest.fn(() => ({
+    target: 'src/modules/graphql',
+    schemaPath: 'src/modules/graphql',
+    schemaPathResolution:
+      'home/users/alexvcasillas/toptal/screening-wizard/src/modules/graphql/schema.graphql',
+  }))
+)
+
+const {
+  utils: { checkIfMonorepo },
+} = require('@toptal/davinci-monorepo')
+
+const getSchemaPath = require('./get-schema-path')
+
+const monorepoSchema = '@toptal/modularity-template-graphql/talent'
+const monolithSchema = 'src/modules/graphql'
+
+describe('getSchemaPath', () => {
+  beforeEach(() => {
+    checkIfMonorepo.mockReset()
+  })
+
+  it('returns target, schemaPath and schemaPathResolution for monorepo', () => {
+    checkIfMonorepo.mockReturnValue(() => true)
+
+    const { target, schemaPath, schemaPathResolution } =
+      getSchemaPath(monorepoSchema)
+
+    expect(checkIfMonorepo).toHaveBeenCalledTimes(1)
+    expect(checkIfMonorepo).toHaveBeenCalledWith({
+      considerYarnWorkspaces: true,
+    })
+    expect(target).toBe('talent')
+    expect(schemaPath).toBe('@toptal/modularity-template-graphql')
+    expect(schemaPathResolution).toBe(
+      'home/users/alexvcasillas/toptal/libs/graphql/schema.graphql'
+    )
+  })
+
+  it('returns target, schemaPath and schemaPathResolution for monolith', () => {
+    checkIfMonorepo.mockReturnValue(false)
+
+    const { target, schemaPath, schemaPathResolution } =
+      getSchemaPath(monolithSchema)
+
+    expect(checkIfMonorepo).toHaveBeenCalledTimes(1)
+    expect(checkIfMonorepo).toHaveBeenCalledWith({
+      considerYarnWorkspaces: true,
+    })
+    expect(target).toBe('src/modules/graphql')
+    expect(schemaPath).toBe('src/modules/graphql')
+    expect(schemaPathResolution).toBe(
+      'home/users/alexvcasillas/toptal/screening-wizard/src/modules/graphql/schema.graphql'
+    )
+  })
+})

package/src/services/gs-schema-loader.js

@@ -1,7 +1,7 @@
-import { Storage } from '@google-cloud/storage'
+const { Storage } = require('@google-cloud/storage')
 
-import getRelativeFilePath from '../utils/get-relative-file-path.js'
-import parseGSURI from '../utils/parse-gs-uri.js'
+const getRelativeFilePath = require('../utils/get-relative-file-path')
+const parseGSURI = require('../utils/parse-gs-uri')
 
 const gsSchemaLoader = async (projectId, source, destination) => {
   // Creates a Google Storage Client
@@ -17,4 +17,4 @@ const gsSchemaLoader = async (projectId, source, destination) => {
     })
 }
 
-export default gsSchemaLoader
+module.exports = gsSchemaLoader

package/src/services/schema-loader.js

@@ -1,15 +1,15 @@
-import chalk from 'chalk'
-import { existsSync, copyFileSync, mkdirSync } from 'fs'
+const chalk = require('chalk')
+const { existsSync, copyFileSync, mkdirSync } = require('fs')
 
-import gsSchemaLoader from './gs-schema-loader.js'
-import getRelativeFilePath from '../utils/get-relative-file-path.js'
-import {
+const gsSchemaLoader = require('./gs-schema-loader')
+const getRelativeFilePath = require('../utils/get-relative-file-path')
+const {
   isSchemaFromBucket,
   isLocalSchema,
   isSchemaFromHttp,
-} from '../utils/detect-schema-source.js'
+} = require('../utils/detect-schema-source')
 
-export default async (schema, target, projectId) => {
+module.exports = async (schema, target, projectId) => {
   if (!existsSync(target)) {
     console.log("📁  Destination target doesn't exist, creating one for you...")
     mkdirSync(target)

package/src/utils/detect-schema-source.js

@@ -1,16 +1,16 @@
-export const isSchemaFromBucket = schema => {
+const isSchemaFromBucket = schema => {
   return schema.startsWith('gs://')
 }
 
-export const isSchemaFromHttp = schema => {
+const isSchemaFromHttp = schema => {
   return schema.startsWith('https://')
 }
 
-export const isLocalSchema = schema => {
+const isLocalSchema = schema => {
   return !isSchemaFromBucket(schema) && !isSchemaFromHttp(schema)
 }
 
-export default {
+module.exports = {
   isSchemaFromBucket,
   isSchemaFromHttp,
   isLocalSchema,

package/src/utils/detect-schema-source.test.js

@@ -0,0 +1,29 @@
+const {
+  isSchemaFromBucket,
+  isSchemaFromHttp,
+  isLocalSchema,
+} = require('./detect-schema-source')
+
+const gsBucketSchema = 'gs://toptal.net/gateway/graphql/talent'
+const httpSchema = 'https://toptal.net/gateway/graphql/talent'
+const localSchema = '../../graphql/talent'
+
+describe('Detect Schema Sources', () => {
+  it('detects that schema is from GS Bucket', () => {
+    expect(isSchemaFromBucket(gsBucketSchema)).toBe(true)
+    expect(isSchemaFromHttp(gsBucketSchema)).toBe(false)
+    expect(isLocalSchema(gsBucketSchema)).toBe(false)
+  })
+
+  it('detects that schema is from http', () => {
+    expect(isSchemaFromBucket(httpSchema)).toBe(false)
+    expect(isSchemaFromHttp(httpSchema)).toBe(true)
+    expect(isLocalSchema(httpSchema)).toBe(false)
+  })
+
+  it('detects that schema is from local folder', () => {
+    expect(isSchemaFromBucket(localSchema)).toBe(false)
+    expect(isSchemaFromHttp(localSchema)).toBe(false)
+    expect(isLocalSchema(localSchema)).toBe(true)
+  })
+})

package/src/utils/get-relative-file-path.js

@@ -2,4 +2,4 @@ const getRelativeFilePath = file => {
   return `${process.cwd()}/${file}`
 }
 
-export default getRelativeFilePath
+module.exports = getRelativeFilePath

package/src/utils/parse-gs-uri.js

@@ -13,4 +13,4 @@ const parseGSURI = source => {
   }
 }
 
-export default parseGSURI
+module.exports = parseGSURI

package/src/utils/parse-gs-uri.test.js

@@ -0,0 +1,12 @@
+const parseGSURI = require('./parse-gs-uri')
+
+const bucketURI = 'gs://gqlgw-introspection/staging_talent_schema.graphql'
+
+describe('Parse Google Storage Bucket URI', () => {
+  it('parses a Google Storage Bucket URI correctly', () => {
+    const { bucketName, fileName } = parseGSURI(bucketURI)
+
+    expect(bucketName).toBe('gqlgw-introspection')
+    expect(fileName).toBe('staging_talent_schema.graphql')
+  })
+})

package/src/utils/process-args.js

@@ -19,4 +19,4 @@ const processArgs = args => {
   return obj
 }
 
-export default processArgs
+module.exports = processArgs

package/src/utils/process-args.test.js

@@ -0,0 +1,10 @@
+const processArgs = require('./process-args')
+
+describe('Argument processor', () => {
+  it('process arguments correctly', () => {
+    const args = processArgs(['generate-operations', '--projectId=toptal'])
+
+    expect(args.operation).toBe('generate-operations')
+    expect(args.projectId).toBe('toptal')
+  })
+})

package/src/utils/to-array.js

@@ -6,4 +6,4 @@ const toArray = value => {
   return [value]
 }
 
-export default toArray
+module.exports = toArray

package/src/utils/to-array.test.js

@@ -0,0 +1,15 @@
+const toArray = require('./to-array')
+
+describe('toArray', () => {
+  it("converts a value into an array if it's not one", () => {
+    const asArray = toArray('hello')
+
+    expect(Array.isArray(asArray)).toBe(true)
+  })
+
+  it("returns the array as is if it's an array", () => {
+    const asArray = toArray(['hello', 'there'])
+
+    expect(Array.isArray(asArray)).toBe(true)
+  })
+})

package/esbuild.js

@@ -1,16 +0,0 @@
-import esbuild from 'esbuild'
-// Automatically exclude all node_modules from the bundled version
-import { nodeExternalsPlugin } from 'esbuild-node-externals'
-
-esbuild
-  .build({
-    entryPoints: ['./bin/davinci-graphql-codegen.ts'],
-    outdir: 'dist-package',
-    bundle: true,
-    minify: false,
-    platform: 'node',
-    sourcemap: true,
-    target: 'node14',
-    plugins: [nodeExternalsPlugin()],
-  })
-  .catch(() => process.exit(1))

package/jest.config.js

@@ -1,3 +0,0 @@
-export default {
-  transform: {},
-}

package/tsconfig.json

@@ -1,8 +0,0 @@
-{
-  "extends": "../../tsconfig.json",
-  "compilerOptions": {
-    "outDir": "dist-package",
-    "noEmit": false,
-    "paths": {}
-  }
-}