Как добавить тип объединения в Apollo graphql

В GraphQL, чтобы добавить тип объединения в определения типов, вы должны определить союз

т.е. union WorksheetOrError = Worksheet | ApiError

// typedefs.js
export default [
  `
  schema {
    query: Query
  }

  type Query {
    worksheet(id: String!): WorksheetOrError
  }

  union WorksheetOrError = Worksheet | ApiError 

  type Worksheet {
    id: String!
    name String
  }

  type ApiError {
    code: String!
    message: String!
  }
`];

В преобразователях вы должны определить преобразователь для типа объединения, который имеет свойство __resolveType. Это поможет сообщить исполнителю GraphQL, к какому типу относится результат.

 // resolvers.js
export default {
  Query: {
    worksheet() {
      ... 
    }
  },
  WorksheetOrError: {
    __resolveType(obj) {
      if (obj.id) {
        return 'Worksheet';
      }

      if (obj.code) {
        return 'ApiError';
      }

      return null;
    }
  },
};

Чтобы создать запрос GraphQL в Клиент Apollo

// Your application code. 

// This is my Worksheet Query in my React code.
const WorksheetQuery = gql`
  query GetWorksheet($worksheetId: String!) {
    worksheet(id: $worksheetId) {
      ... on Worksheet {
        id
        name
      }
      ... on ApiError {
        code
        message
      }
    }
  }

Теперь вы можете проверить __typename, чтобы проверить, какой тип в ответе.

Note: For those who are wondering why I'm not using GraphQL errors. It's because Apollo doesn't seem to handle errors well when it encounters a graphQL error. So for a work around I'm trying to return a custom ApiError in my response.

Есть несколько причин, по которым использование объединения с типом ошибки - это хорошо.

1. В настоящее время, если вам нужен частичный ответ с помощью GraphQLError. Apollo не кэширует ошибки, поэтому, если вы захотите повторно использовать кешированный ответ позже, у вас не будет полного ответа, так как ошибки будут удалены. (Теперь вы не можете отображать правильный интерфейс с ошибками)
2. Получение GraphQLError обратно в Apollo вернет плоский список ошибок с путем к тому, где ошибка находится в данных. Таким образом, вам нужно будет проверить, в какой части вашей схемы возникла ошибка. Однако, если вы будете следовать приведенным выше инструкциям, у вас уже будет ошибка в схеме. Таким образом, вы уже знаете, в какой части схемы произошла ошибка.