@toptal/davinci-graphql-codegen 0.2.13-alpha-fx-2996-add-error-message-for-missing-engine.12 → 0.2.13

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @toptal/davinci-graphql-codegen
 
+## 0.2.13
+
+### Patch Changes
+
+- [#1541](https://github.com/toptal/davinci/pull/1541) [`397a53c9`](https://github.com/toptal/davinci/commit/397a53c9add9f7e8d485648b51cd22676d97c78f) Thanks [@TomasSlama](https://github.com/TomasSlama)! - ---
+  - Update documentation about prefering individual davinci packages usage
+- Updated dependencies [[`397a53c9`](https://github.com/toptal/davinci/commit/397a53c9add9f7e8d485648b51cd22676d97c78f)]:
+  - @toptal/davinci-monorepo@6.6.5
+
 ## 0.2.12
 
 ### Patch Changes

package/README.md

@@ -41,7 +41,7 @@ _<sup>1</sup> *This structure might be subject to change in a future iteration o
 After creating the package and applying the default configurations you should add Davinci as a dependency of `@toptal/modularity-template-graphql` (it's how we name this package within our monorepo to resolve to `libs/graphql`) and add this `script` to your `package.json`:
 
 ```
-"generate-schema": "davinci graphql-codegen generate-schema"
+"generate-schema": "davinci-graphql-codegen generate-schema"
 ```
 
 When you run the above command, it will iterate over the `schemas` you have configured in your `codegen.json` and then create those schemas locally for you to commit to your repo, and then make use of them for generating operation types.
@@ -51,7 +51,7 @@ When you run the above command, it will iterate over the `schemas` you have conf
 In order to generate operation types for your GraphQL Gateway, you'd need to add this `script` to your `package.json`.
 
 ```
-"generate-operations": "davinci graphql-codegen generate-operations"
+"generate-operations": "davinci-graphql-codegen generate-operations"
 ```
 
 Then create a `codegen.json` file at the root folder of your package that contains the following data/structure:
@@ -76,7 +76,7 @@ GraphQL Codegen is an extensible and configurable tool that gives you the abilit
 You can customize the `codegen.json` file that GraphQL Codegen is going to look for. You can do so via CLI with the following command:
 
 ```
-yarn davinci graphql-codegen generate-schema --config=./graphql/codegen-schema.json
+yarn davinci-graphql-codegen generate-schema --config=./graphql/codegen-schema.json
 ```
 
 The above script will search for `codegen-schema.json` within `./graphql`.
@@ -86,7 +86,7 @@ The above script will search for `codegen-schema.json` within `./graphql`.
 When generating operations, we have set a default setting that generates your operation types within a file named the same as where your query or mutation is and it will have the `.ts` extension. This is due to that the default extension for your queries or mutations should be `.graphql`. But you might have your query within a `.ts` file that comes with, for instance, a hook that makes use of this query, and if you'd run GraphQL Codegen Operations as is, you'll have that `.ts` file ovewriten. But you can avoid this conflict via CLI with the following command:
 
 ```
-davinci graphql-codegen generate-operations --extension=.types.ts
+davinci-graphql-codegen generate-operations --extension=.types.ts
 ```
 
 The above script will tell GraphQL Codegen that when generating operations, you'd like it to generate your types with the `.types.ts` extension so it won't conflict with your already existing `.ts` file which contains more than your query or mutation.

package/dist-package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@toptal/davinci-graphql-codegen",
+  "version": "0.2.13",
+  "description": "Codegen",
+  "author": "Toptal",
+  "license": "ISC",
+  "homepage": "https://github.com/toptal/davinci/tree/master/packages/graphql-codegen#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "bin": {
+    "davinci-graphql-codegen": "./bin/davinci-graphql-codegen.js"
+  },
+  "main": "./src/index.js",
+  "scripts": {
+    "build:package": "../../bin/build-package.js",
+    "prepublishOnly": "../../bin/prepublish.js",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "sideEffects": false,
+  "dependencies": {
+    "@google-cloud/storage": "^6.2.3",
+    "@graphql-codegen/add": "^3.1.0",
+    "@graphql-codegen/cli": "^2.11.3",
+    "@graphql-codegen/introspection": "^2.2.0",
+    "@graphql-codegen/near-operation-file-preset": "^2.2.8",
+    "@graphql-codegen/typed-document-node": "^2.3.2",
+    "@graphql-codegen/typescript": "^2.2.2",
+    "@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.6.0",
+    "@toptal/davinci-monorepo": "6.6.5",
+    "chalk": "^4.1.2",
+    "graphql": "^15.7.1"
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toptal/davinci-graphql-codegen",
-  "version": "0.2.13-alpha-fx-2996-add-error-message-for-missing-engine.12+227d5ea7",
+  "version": "0.2.13",
   "description": "Codegen",
   "author": "Toptal",
   "license": "ISC",
@@ -29,10 +29,9 @@
     "@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.6.1-alpha-fx-2996-add-error-message-for-missing-engine.21+227d5ea7",
-    "@toptal/davinci-monorepo": "6.6.5-alpha-fx-2996-add-error-message-for-missing-engine.12+227d5ea7",
+    "@toptal/davinci-cli-shared": "^1.6.0",
+    "@toptal/davinci-monorepo": "6.6.5",
     "chalk": "^4.1.2",
     "graphql": "^15.7.1"
-  },
-  "gitHead": "227d5ea750c2b2ce9f4abd1ff33bbe1838ae9d28"
+  }
 }

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

@@ -0,0 +1,59 @@
+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', () => {
+  it('returns target, schemaPath and schemaPathResolution for monorepo', () => {
+    checkIfMonorepo.mockReturnValue(() => true)
+
+    const { target, schemaPath, schemaPathResolution } =
+      getSchemaPath(monorepoSchema)
+
+    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(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/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/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.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.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)
+  })
+})