feat(json-schema): detailed description for DEBUG mode

ardatan · Jan 11, 2022 · b692335 · b692335 · vercel · Jan 11, 2022
1 parent be704d0
commit b692335
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 13 deletions.
diff --git a/.changeset/tough-bears-share.md b/.changeset/tough-bears-share.md
@@ -0,0 +1,5 @@
+---
+'@omnigraph/json-schema': minor
+---
+
+feat(json-schema): detailed description for DEBUG mode
diff --git a/examples/json-schema-covid/tests/__snapshots__/json-schema-covid.test.js.snap b/examples/json-schema-covid/tests/__snapshots__/json-schema-covid.test.js.snap
@@ -119,10 +119,6 @@ type Query {
 
   \\"\\"\\"\\"\\"\\"
   daily: [Daily]
-
-  \\"\\"\\"
-  GET /?dataset=world-population&q={args.country}&rows=1&sort=year&facet=year&facet=country_name
-  \\"\\"\\"
   population(country: String): ApiPopulation
   stat(country: String!): Stat
 }

diff --git a/examples/json-schema-example/tests/__snapshots__/json-schema-example.test.js.snap b/examples/json-schema-example/tests/__snapshots__/json-schema-example.test.js.snap
@@ -27,21 +27,13 @@ type Foo {
 }
 
 type Mutation {
-  \\"\\"\\"PUT /user\\"\\"\\"
   createUser(input: CreateUpdateUser_Input): User
-
-  \\"\\"\\"DELETE /user/{args.id}\\"\\"\\"
   deleteUser(id: ID!): Any
-
-  \\"\\"\\"POST /user/{args.id}\\"\\"\\"
   updateUser(id: ID!, input: CreateUpdateUser_Input): User
 }
 
 type Query {
-  \\"\\"\\"GET /company/{args.id}\\"\\"\\"
   company(id: ID!): Company
-
-  \\"\\"\\"GET /me\\"\\"\\"
   me: User
 }
 

diff --git a/packages/loaders/json-schema/src/addExecutionLogicToComposer.ts b/packages/loaders/json-schema/src/addExecutionLogicToComposer.ts
@@ -88,7 +88,16 @@ export async function addExecutionLogicToComposer(
       };
       interpolationStrings.push(operationConfig.pubsubTopic);
     } else if (operationConfig.path) {
-      field.description = operationConfig.description || `${operationConfig.method} ${operationConfig.path}`;
+      if (process.env.DEBUG) {
+        field.description = `
+    Original Description: ${operationConfig.description || '(none)'}
+    Method: ${operationConfig.method}
+    baseUrl: ${baseUrl}
+    Path: ${operationConfig.path}
+`;
+      } else {
+        field.description = operationConfig.description;
+      }
       field.resolve = async (root, args, context, info) => {
         operationLogger.debug(() => `=> Resolving`);
         const interpolationData = { root, args, context, info, env };