InfoGrab DocsInfoGrab Docs

GraphQL API 머지 리퀘스트 체크리스트

GitLab GraphQL API 변경 사항이 포함된 머지 리퀘스트를 리뷰할 때 확인해야 할 기준과 절차를 설명합니다.

GitLab GraphQL API는 상당히 복잡하므로 GraphQL 변경이 포함된 머지 리퀘스트는 GraphQL에 익숙한 사람이 리뷰해야 합니다. MR에서 @gitlab-org/graphql-experts 그룹을 멘션하거나 Slack의 #f_graphql 채널 로 요청할 수 있습니다(GitLab 팀원만 이용 가능). GraphQL 쿼리는 다음 관점에서 리뷰해야 합니다. 브레이킹 체인지 인가 성능 리뷰 기준 # 아래 목록이 전부는 아닙니다. 샘플 쿼리가 포함된 설명 # 설명에 설정 방법과 함께 샘플 쿼리가 포함되어 있는지 확인합니다. 로컬 GDK 인스턴스의 GraphiQL 에서 쿼리를 실행해 봅니다. 브레이킹 체인지 없음(전체 지원 중단 사이클을 거친 경우는 예외) # MR에 브레이킹 체인지 가 있는지 확인합니다. 기능이 실험 으로 표시되어 있다면 지원 중단 기간 없이 즉시 브레이킹 체인지를 적용할 수 있습니다. 자세한 내용은 지원 중단 및 제거 프로세스 를 참고합니다. 멀티버전 호환성 # 멀티버전 호환성이 보장되는지 확인합니다. 일반적으로 같은 GraphQL 기능의 프론트엔드 코드와 백엔드 코드를 같은 릴리스에 함께 출시할 수 없다는 뜻입니다. 자세한 내용은 여러 버전 호환성 을 참고합니다. 테크니컬 라이팅 리뷰 # 생성된 API 문서가 변경되면 테크니컬 라이터의 리뷰가 필요합니다. 변경 로그 # 실험 으로 표시되지 않은 공개 변경에는 변경 로그 항목 이 필요합니다. 프레임워크 사용 # GraphQL은 구성 요소가 많은 프레임워크입니다. 프레임워크를 그대로 따르는 것이 중요합니다. 프레임워크의 내부 요소를 수동으로 호출하지 않습니다. 예를 들어 실행 중에 리졸버를 직접 인스턴스화하지 말고 프레임워크가 처리하도록 둡니다. MyResolver.single 처럼 리졸버를 서브클래싱할 수 있습니다( 리졸버 파생 참고). 인자 로직이 복잡하다면 ready? 메서드를 사용합니다( resolver#ready의 올바른 사용 참고). 인자 검증이 복잡하다면 prepare 메서드를 사용합니다( 전처리 참고). 자세한 내용은 리졸버 가이드 를 참고합니다. 인가 # 인가가 적절히 이루어지는지, 스펙에서 authorize :some_ability 를 테스트하는지 확인합니다. 자세한 내용은 인가 가이드 를 참고합니다. 성능 # 다음을 확인합니다. N+1 문제를 점검 했고, 가능한 경우 최적화 로 N+1을 제거했습니다. 지연 평가 를 적절히 사용했습니다. 프론트엔드 GraphQL 프래그먼트 변경 # MR 이 app/assets/ , ee/app/assets/ , app/graphql/queries/ 아래의 .graphql 파일을 변경할 때 이 절을 적용합니다. N+1 쿼리 위험이 있는지 다음을 확인합니다. 프래그먼트가 중첩 연관 관계를 새로 추가하면 쿼리 깊이를 추적합니다. 예를 들어 workflows 목록 안의 workflow 선택 안에 있는 checkpoints 선택이 그렇습니다. 루트 필드부터 전체 쿼리 경로를 따라가며 각 단계가 페이지네이션되거나 배치 로드