Apollo server flow

작성자: J054 김진관

정확하게 Apollo server에 대한 동작 방식에 대해 자세하게 설명하고 있는 글을 찾기 힘들어서 GraphQL query가 전반적으로 어떻게 실행되는지에 대해서 정리한다. 아마 Apollo는 GraphQL의 구현체로 query를 implement하고 실행하는데 도움을 주는 라이브러리이지 않을까 하는 생각을 하고 있다.

Execution

---

validation 이후에 GraphQL query는 GraphQL server에 의해 대개 JSON과 같은 형식으로 요청 query의 모습과 마찬가지의 모습으로 결과를 반환한다.

GraphQL은 type system 없이 query를 실행할 수 없다.

예제로 다음과 같이 type을 정의한다.

type Query {
  human(id: ID!): Human
}
 
type Human {
  name: String
  appearsIn: [Episode]
  starships: [Starship]
}
 
enum Episode {
  NEWHOPE
  EMPIRE
  JEDI
}
 
type Starship {
  name: String
}

query가 어떤식으로 동작하는지 알아보기 전에 요청과 응답을 보면 다음과 같다.

// request
{
  human(id: 1002) {
    name
    appearsIn
    starships {
      name
    }
  }
}

// response
{
  "data": {
    "human": {
      "name": "Han Solo",
      "appearsIn": [
        "NEWHOPE",
        "EMPIRE",
        "JEDI"
      ],
      "starships": [
        {
          "name": "Millenium Falcon"
        },
        {
          "name": "Imperial shuttle"
        }
      ]
    }
  }
}

GraphQL query의 field는 next type을 반환하는 previous type의 function이나 method라고 생각할 수 있다. type의 각 field는 GraphQL server developer가 정의한 resolver을 부르는 함수로 뒷받침된다. field가 실행될 때, 대응되는 resolver가 불려지고 다음 value를 반환한다.

field가 scalar type을 반환하면 실행은 완료된다. 하지만 field가 특정 object를 반환한다면 scalar를 반환할 때까지 이를 반복한다.

Root fields & resolvers

GraphQL server의 최상위 레벨은 GraphQL API로 접근할 수 있는 모든 entry point를 나타내는 type이다. 이는 Root type 또는 Query type이라고 부른다.

Query: {
  human(obj, args, context, info) {
    return context.db.loadHumanByID(args.id).then(
      userData => new Human(userData)
    )
  }
}

위의 예제에서, Query type은 human field를 제공하고 있다. 이 field에 대한 resolver는 database에 접은해서 Human 객체를 반환한다. 예제는 Javascript로 씌여졌고, GraphQL server는 많은 다른 언어를 지원한다.

resolver function은 다음 4개의 인자를 받는다.

• obj: 이전(부모) object로 root Query에서는 사용하지 않는다.
• args: 이 GraphQL query에 전달된 arguments
• context: 모든 resolver가 공유하는 값으로 주로 로그인한 user, database로의 접근 등과 같은 contextual information을 담고 있다.
• info: 현재 query와 관련된 field에 대한 구체적인 정보를 담고 있는 값

Asynchronous resolvers

DB에의 접근과 같이 비동기 작업을 위해서 resolver는 Promise, Futures, Tasks와 같은 동작을 알고 있을 필요가 있다. 하지만 Query는 단지 정의한 field를 반환하길 기대하고 있기 때문에 Query 자체는 Promise 같은 동작을 이해할 필요가 없다. 단지 실행 중에 Promise와 같은 동작이 발생하면 다음으로 넘어가기 전까지 이를 기다려서 최적의 동시성을 달성할 수 있다.

Trivial resolvers

이제 Human 객체가 사용가능해졌을 때 GraphQL은 다음 field에 대한 요청을 수행한다.

Human: {
  name(obj, args, context, info) {
    return obj.name
  }
}

GraphQL server는 type system에 의해 다음에 할 작업이 이미 결정되어 있다. Query type에서 human field에 아무것도 반환되지 않은 상태에서도 GraphQL은 다음에 resolve할 field가 무엇인지 알고 있다.

Human field에서 name을 resolve하는 경우는 다소 직관적이다. name resolver가 불려지고 obj 인자에 Human 객체가 넘어간다.

대부분의 GraphQL 라이브러리는 이정도의 resolver는 따로 정의하지 않아도 자동으로 수행한다. 만약 resolver가 정의되지 않은 경우 반환된 object에서 동일한 이름의 field를 읽어서 반환한다.(이 부분은 Apollo Server가 수행하는 일이 될 것 같다.)

Scalar coercion

name field가 resolve되는 동안에 appearsIn과 starships field가 동시에 resolve된다. appearsIn field 또한 trivial resolver를 갖고 있다.

Human: {
  appearsIn(obj) {
    return obj.appearsIn // returns [ 4, 5, 6 ]
  }
}

type system은 appearsIn이 Enum values를 반환해야 한다는 것을 알고 있다. 하지만 이 함수는 숫자들을 반환하고 있다.

위의 예제가 scalar coercion이다. type system은 기대하는 값과 API contract에 따라 resolver 함수에 의해 적절한 값으로 변환하여 반환한다. 이 경우 우리가 정의한 Enum은 내부적으로 4, 5, 6을 사용하고 있는 것이다.

List resolvers

Human: {
  starships(obj, args, context, info) {
    return obj.starshipIDs.map(
      id => context.db.loadStarshipByID(id).then(
        shipData => new Starship(shipData)
      )
    )
  }
}

starships field는 Promise의 리스트를 반환한다. Human 객체는 Starships의 id의 리스트를 갖고 있지만, 우리는 실제 Startship 객체에 id로 접근해서 가져와야 한다.

GraphQL은 다음으로 넘어가지 전까지 기다린다.

Producing the result

leaf에서 반환한 값들이 root까지 타고 올라가면서 key-value로 mapping되서 반환한다. 이렇게 모여진 결과는 요청 query와 동일한 형태로 반환된다.

출처

🔗 https://graphql.org/learn/execution/