@commitspark/graphql-api 1.0.0-beta.1 → 1.0.0-beta.3

package/src/graphql/schema-utils/entry-reference-util.ts

@@ -1,5 +1,4 @@
 import {
-  GraphQLError,
   GraphQLNullableType,
   GraphQLObjectType,
   isListType,
@@ -14,6 +13,7 @@ import {
   getUnionValue,
 } from './union-type-util'
 import { hasEntryDirective, isUnionOfEntryTypes } from './entry-type-util'
+import { createError, ErrorCode } from '../errors'
 
 function isPermittedReferenceType(
   referencedTypeName: string,
@@ -45,7 +45,14 @@ async function validateReference(
     return
   } else if (isListType(fieldType)) {
     if (!Array.isArray(fieldValue)) {
-      throw new Error(`Expected array value in field "${fieldName}"`)
+      throw createError(
+        `Expected array while validation references for field "${fieldName}".`,
+        ErrorCode.SCHEMA_DATA_MISMATCH,
+        {
+          fieldName: fieldName,
+          fieldValue: fieldValue,
+        },
+      )
     }
     for (const fieldListElement of fieldValue) {
       await validateReference(
@@ -58,7 +65,14 @@ async function validateReference(
     return
   } else if (isUnionType(fieldType) || isObjectType(fieldType)) {
     if (!('id' in fieldValue)) {
-      throw new Error('Expected key "id"')
+      throw createError(
+        `Expected key "id" in data while validating reference for field "${fieldName}".`,
+        ErrorCode.SCHEMA_DATA_MISMATCH,
+        {
+          fieldName: fieldName,
+          fieldValue: fieldValue,
+        },
+      )
     }
     const referencedId = fieldValue.id
     let referencedTypeName
@@ -69,24 +83,22 @@ async function validateReference(
         referencedId,
       )
     } catch (error) {
-      throw new GraphQLError(
-        `Reference with id "${referencedId}" points to non-existing entry`,
+      throw createError(
+        `Failed to resolve entry reference "${referencedId}".`,
+        ErrorCode.BAD_USER_INPUT,
         {
-          extensions: {
-            code: 'BAD_USER_INPUT',
-            fieldName: fieldName,
-          },
+          fieldName: fieldName,
+          fieldValue: referencedId,
         },
       )
     }
     if (!isPermittedReferenceType(referencedTypeName, fieldType)) {
-      throw new GraphQLError(
-        `Reference with id "${referencedId}" points to entry of incompatible type`,
+      throw createError(
+        `Reference with ID "${referencedId}" points to entry of incompatible type "${referencedTypeName}".`,
+        ErrorCode.BAD_USER_INPUT,
         {
-          extensions: {
-            code: 'BAD_USER_INPUT',
-            fieldName: fieldName,
-          },
+          fieldName: fieldName,
+          fieldValue: referencedId,
         },
       )
     }
@@ -131,13 +143,23 @@ export async function getReferencedEntryIds(
       return [data.id]
     }
 
-    const unionTypeName = getUnionTypeNameFromFieldValue(data)
-    const unionType = type
+    const requestedUnionTypeName = getUnionTypeNameFromFieldValue(data)
+    const concreteFieldUnionType = type
       .getTypes()
-      .find((type) => type.name === unionTypeName)
-    if (!unionType) {
-      throw new Error(
-        `Type "${unionTypeName}" found in field data is not a valid type for union type "${type.name}".`,
+      .find(
+        (concreteFieldType) =>
+          concreteFieldType.name === requestedUnionTypeName,
+      )
+    if (!concreteFieldUnionType) {
+      throw createError(
+        `Type "${requestedUnionTypeName}" found in field data is not a valid type for ` +
+          `union type "${type.name}".`,
+        ErrorCode.BAD_REPOSITORY_DATA,
+        {
+          typeName: type.name,
+          fieldName: fieldName ? fieldName : undefined,
+          fieldValue: data,
+        },
       )
     }
     const unionValue = getUnionValue(data)
@@ -145,7 +167,7 @@ export async function getReferencedEntryIds(
       rootType,
       context,
       fieldName,
-      unionType,
+      concreteFieldUnionType,
       unionValue,
     )
   } else if (isObjectType(type)) {

package/src/graphql/schema-utils/union-type-util.ts

@@ -1,8 +1,15 @@
 import { EntryData } from '@commitspark/git-adapter'
+import { createError, ErrorCode } from '../errors'
 
-export function getUnionTypeNameFromFieldValue(fieldValue: any): string {
-  if (typeof fieldValue !== 'object') {
-    throw new Error('Expected object as union value')
+export function getUnionTypeNameFromFieldValue(fieldValue: unknown): string {
+  if (typeof fieldValue !== 'object' || fieldValue === null) {
+    throw createError(
+      `Expected object value in order to determine union type name.`,
+      ErrorCode.BAD_REPOSITORY_DATA,
+      {
+        fieldValue: fieldValue,
+      },
+    )
   }
 
   // Based on our @oneOf directive, we expect only one field whose name
@@ -10,11 +17,17 @@ export function getUnionTypeNameFromFieldValue(fieldValue: any): string {
   return Object.keys(fieldValue)[0]
 }
 
-export function getUnionValue(fieldValue: any): EntryData {
-  if (typeof fieldValue !== 'object') {
-    throw new Error('Expected object as union value')
+export function getUnionValue(fieldValue: unknown): EntryData {
+  if (typeof fieldValue !== 'object' || fieldValue === null) {
+    throw createError(
+      `Expected object value in order to determine union value.`,
+      ErrorCode.BAD_REPOSITORY_DATA,
+      {
+        fieldValue: fieldValue,
+      },
+    )
   }
 
   const firstKey = Object.keys(fieldValue)[0]
-  return fieldValue[firstKey]
+  return (fieldValue as Record<string, EntryData>)[firstKey]
 }

package/src/index.ts

@@ -7,6 +7,7 @@ import {
   VariableValues,
 } from './client'
 import { GitAdapter } from '@commitspark/git-adapter'
+import { ErrorCode, ErrorMetadata } from './graphql/errors'
 
 interface Client {
   postGraphQL<
@@ -19,7 +20,7 @@ interface Client {
   getSchema(ref: string): Promise<SchemaResponse>
 }
 
-export { Client, GraphQLResponse, SchemaResponse }
+export { Client, GraphQLResponse, SchemaResponse, ErrorCode, ErrorMetadata }
 
 export async function createClient(gitAdapter: GitAdapter): Promise<Client> {
   return {

package/src/persistence/persistence.ts

@@ -1,5 +1,5 @@
 import { Entry, GitAdapter } from '@commitspark/git-adapter'
-import { GraphQLError } from 'graphql'
+import { createError, ErrorCode } from '../graphql/errors'
 
 export async function getTypeById(
   gitAdapter: GitAdapter,
@@ -9,10 +9,9 @@ export async function getTypeById(
   const allEntries = await gitAdapter.getEntries(commitHash)
   const requestedEntry = allEntries.find((entry: Entry) => entry.id === id)
   if (requestedEntry === undefined) {
-    throw new GraphQLError(`Not found: ${id}`, {
-      extensions: {
-        code: 'NOT_FOUND',
-      },
+    throw createError(`No entry with id "${id}" exists.`, ErrorCode.NOT_FOUND, {
+      argumentName: 'id',
+      argumentValue: id,
     })
   }
 
@@ -27,10 +26,9 @@ export async function findById(
   const allEntries = await gitAdapter.getEntries(commitHash)
   const requestedEntry = allEntries.find((entry: Entry) => entry.id === id)
   if (requestedEntry === undefined) {
-    throw new GraphQLError(`Not found: ${id}`, {
-      extensions: {
-        code: 'NOT_FOUND',
-      },
+    throw createError(`No entry with id "${id}" exists.`, ErrorCode.NOT_FOUND, {
+      argumentName: 'id',
+      argumentValue: id,
     })
   }
 
@@ -57,13 +55,13 @@ export async function findByTypeId(
     (entry: Entry) => entry.id === id && entry.metadata.type === type,
   )
   if (requestedEntry === undefined) {
-    throw new GraphQLError(
-      `No entry of type "${type}" with id "${id}" exists`,
+    throw createError(
+      `No entry of type "${type}" with id "${id}" exists.`,
+      ErrorCode.NOT_FOUND,
       {
-        extensions: {
-          code: 'BAD_USER_INPUT',
-          argumentName: 'id',
-        },
+        typeName: type,
+        argumentName: 'id',
+        argumentValue: id,
       },
     )
   }

package/dist/cjs/graphql/resolvers/query-mutation-resolvers/query-all-resolver.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"query-all-resolver.js","sourceRoot":"","sources":["../../../../../src/graphql/resolvers/query-mutation-resolvers/query-all-resolver.ts"],"names":[],"mappings":";;;;;;;;;;;;AACA,kEAA6D;AAItD,MAAM,gBAAgB,GAKzB,CAAO,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;IACrC,MAAM,OAAO,GAAG,MAAM,IAAA,wBAAU,EAC9B,OAAO,CAAC,UAAU,EAClB,OAAO,CAAC,aAAa,EAAE,EACvB,OAAO,CAAC,IAAI,CAAC,IAAI,CAClB,CAAA;IAED,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QAC3B,uCAAY,KAAK,CAAC,IAAI,KAAE,EAAE,EAAE,KAAK,CAAC,EAAE,IAAE;IACxC,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA,CAAA;AAfY,QAAA,gBAAgB,oBAe5B"}

package/dist/esm/graphql/resolvers/query-mutation-resolvers/query-all-resolver.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"query-all-resolver.js","sourceRoot":"","sources":["../../../../../src/graphql/resolvers/query-mutation-resolvers/query-all-resolver.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAA;AAI7D,MAAM,CAAC,MAAM,gBAAgB,GAKzB,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE;IACrC,MAAM,OAAO,GAAG,MAAM,UAAU,CAC9B,OAAO,CAAC,UAAU,EAClB,OAAO,CAAC,aAAa,EAAE,EACvB,OAAO,CAAC,IAAI,CAAC,IAAI,CAClB,CAAA;IAED,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QAC3B,OAAO,EAAE,GAAG,KAAK,CAAC,IAAI,EAAE,EAAE,EAAE,KAAK,CAAC,EAAE,EAAE,CAAA;IACxC,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA"}

package/dist/types/graphql/resolvers/query-mutation-resolvers/query-all-resolver.d.ts

@@ -1,5 +0,0 @@
-import { EntryData } from '@commitspark/git-adapter';
-import { GraphQLFieldResolver } from 'graphql';
-import { QueryMutationResolverContext } from '../types';
-export declare const queryAllResolver: GraphQLFieldResolver<any, QueryMutationResolverContext, any, Promise<EntryData[]>>;
-//# sourceMappingURL=query-all-resolver.d.ts.map

package/dist/types/graphql/resolvers/query-mutation-resolvers/query-all-resolver.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"query-all-resolver.d.ts","sourceRoot":"","sources":["../../../../../src/graphql/resolvers/query-mutation-resolvers/query-all-resolver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAA;AAEpD,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAC9C,OAAO,EAAE,4BAA4B,EAAE,MAAM,UAAU,CAAA;AAEvD,eAAO,MAAM,gBAAgB,EAAE,oBAAoB,CACjD,GAAG,EACH,4BAA4B,EAC5B,GAAG,EACH,OAAO,CAAC,SAAS,EAAE,CAAC,CAWrB,CAAA"}