승인 규칙 개발 가이드라인

이 문서는 병합 요청 승인 규칙에 관련된 모든 기능에 대한 백엔드 디자인 및 흐름을 설명합니다.

이는 기여자가 코드 디자인을 더 쉽게 이해하고 기능 및 구현이 발전함에 따라 개선할 부분이 있는지를 파악하는 데 도움이 되어야 합니다.

구현 세부 정보가 많이 포함되지 않은 것은 일부가 자주 변경될 수 있기 때문입니다. 코드가 그런 것들을 더 잘 설명해야 합니다. 여기에 언급된 구성 요소는 승인 규칙 기능이 작동하도록 하는 애플리케이션의 주요 부분입니다.

참고: 이 문서는 계속 업데이트되어야 하며, 이 문서에서 다루는 코드베이스가 변경되거나 삭제되거나 새 구성 요소가 추가될 때에도 업데이트되어야 합니다.

데이터 모델

%%{init: { "fontFamily": "GitLab Sans" }}%% erDiagram accTitle: 승인 규칙 데이터 모델 accDescr: 병합 요청 승인 규칙의 엔터티 관계 다이어그램 Project ||--o{ MergeRequest: " " Project ||--o{ ApprovalProjectRule: " " ApprovalProjectRule }o--o{ User: " " ApprovalProjectRule }o--o{ Group: " " ApprovalProjectRule }o--o{ ProtectedBranch: " " MergeRequest ||--|| ApprovalState: " " ApprovalState ||--o{ ApprovalWrappedRule: " " MergeRequest ||--o{ Approval: " " MergeRequest ||--o{ ApprovalMergeRequestRule: " " ApprovalMergeRequestRule }o--o{ User: " " ApprovalMergeRequestRule }o--o{ Group: " " ApprovalMergeRequestRule ||--o| ApprovalProjectRule: " "

Project 및 MergeRequest

Project와 MergeRequest 모델은 ee/app/models/ee/project.rb 및 ee/app/models/ee/merge_request.rb에서 정의됩니다. 승인 규칙은 EE 전용 기능이기 때문에 비-EE 버전을 확장합니다. 여기에는 병합 요청 승인과 관련된 연결 및 기타 관련된 내용이 정의되어 있습니다.

ApprovalState

%%{init: { "fontFamily": "GitLab Sans" }}%% erDiagram accTitle: ApprovalState accDescr: 병합 요청과 승인 상태 간의 엔터티 관계 다이어그램 MergeRequest ||--|| ApprovalState: " "

ApprovalState 클래스는 ee/app/models/approval_state.rb에 정의되어 있습니다. 이는 실제 ActiveRecord 모델이 아닙니다. 이 클래스는 특정 병합 요청에 대한 승인 상태와 관련된 모든 로직을 캡슐화합니다. 이 상태에서 승인 규칙을 기반으로 특정 병합 요청에 적용되는 승인 규칙을 알 수 있습니다.

  • 대상 브랜치에 따라 적용되는 승인 규칙을 알 수 있음
  • 모든 규칙이 승인되었는지 확인
  • 승인이 필요한지 확인
  • 몇 개의 승인이 승인되었거나 아직 필요한지 알 수 있음

프로젝트(ApprovalProjectRule)나 병합 요청(ApprovalMergeRequestRule)에서 승인 규칙 데이터를 가져와 ApprovalWrappedRule로 래핑합니다.

ApprovalProjectRule

%%{init: { "fontFamily": "GitLab Sans" }}%% erDiagram accTitle: ApprovalProjectRule 다이어그램 accDescr: 프로젝트와 ApprovalProjectRule 간의 엔터티 관계 다이어그램 Project ||--o{ ApprovalProjectRule: " " ApprovalProjectRule }o--o{ User: " " ApprovalProjectRule }o--o{ Group: " " ApprovalProjectRule }o--o{ ProtectedBranch: " "

ApprovalProjectRule 모델은 ee/app/models/approval_project_rule.rb에 정의되어 있습니다.

프로젝트 설정 또는 프로젝트 수준 승인 API를 통해 승인 규칙이 추가/편집/삭제될 때 레코드가 생성/업데이트/삭제됩니다. ApprovalState 모델은 이러한 레코드를 가져옵니다.

protected_branches 속성은 규칙이 보호된 브랜치에 적용된 경우에 설정되고 사용됩니다. 이 기능에 대한 자세한 내용은 보호된 브랜치에 대한 승인를 참조하세요.

ApprovalMergeRequestRule

%%{init: { "fontFamily": "GitLab Sans" }}%% erDiagram accTitle: ApprovalMergeRequestRule 다이어그램 accDescr: 병합 요청과 ApprovalMergeRequestRule 간의 엔터티 관계 다이어그램 MergeRequest ||--o{ ApprovalMergeRequestRule: " " ApprovalMergeRequestRule }o--o{ User: " " ApprovalMergeRequestRule }o--o{ Group: " " ApprovalMergeRequestRule ||--o| ApprovalProjectRule: " "

ApprovalMergeRequestRule 모델은 ee/app/models/approval_merge_request_rule.rb에 정의되어 있습니다.

병합 요청 생성/편집 양식 또는 병합 요청 수준 승인 API를 통해 규칙이 추가/편집/삭제될 때 레코드가 생성/업데이트/삭제됩니다.

approval_project_rule은 기존 ApprovalProjectRule을 기반으로 할 때 설정됩니다.

ApprovalMergeRequestRule은 approval_project_rule에서 상속되지 않는 한 protected_branches를 가지고 있지 않습니다.

ApprovalWrappedRule

%%{init: { "fontFamily": "GitLab Sans" }}%% erDiagram accTitle: ApprovalWrappedRule 다이어그램 accDescr: ApprovalState와 ApprovalWrappedRule 간의 엔터티 관계 다이어그램 ApprovalState ||--o{ ApprovalWrappedRule: " "

ApprovalWrappedRule은 ee/app/modes/approval_wrapped_rule.rb에 정의되어 있으며 ActiveRecord 모델이 아닙니다. 공통 인터페이스를 위해 ApprovalProjectRule 또는 ApprovalMergeRequestRule을 래핑하는 데 사용됩니다. 또한 다음과 같은 하위 유형을 가지고 있습니다:

  • ApprovalWrappedAnyApprovalRule - any_approver 규칙을 래핑하는 데 사용됨
  • ApprovalWrappedCodeOwnerRule - code_owner 규칙을 래핑하는 데 사용됨

이 클래스는 대부분의 책임을 래핑하는 승인 규칙에 위임하지만 다음과 같은 책임을 갖습니다:

  • 승인 규칙이 승인되었는지 확인
  • 승인 규칙에 대해 주어진 승인 수 또는 필요한 승인 수를 알아냄

이 정보는 승인 규칙 및 병합 요청의 Approval 레코드에서 가져옵니다.

%%{init: { "fontFamily": "GitLab Sans" }}%% erDiagram accTitle: 승인 다이어그램 accDescr: MergeRequest 및 Approval 간의 개체 관계 다이어그램 MergeRequest ||--o{ Approval: " "

Approval 모델은 ee/app/models/approval.rb에 정의되어 있습니다. 이 모델은 병합 요청에 대한 승인에 관한 정보를 저장하는 데 책임이 있습니다. 승인이 부여되거나 철회될 때마다 레코드가 생성되거나 삭제됩니다.

컨트롤러 및 서비스

아래의 컨트롤러 및 서비스는 승인 규칙 기능을 위해 사용됩니다.

API::ProjectApprovalSettings

이 비공개 API는 ee/lib/api/project_approval_settings.rb에 정의되어 있습니다.

다음과 같이 사용됩니다:

  • 프로젝트 설정에서 승인 규칙을 나열하는 데 사용됨.
  • 프로젝트 설정에서 규칙을 생성/업데이트/삭제하는 데 사용됨.
  • 병합 요청 작성 양식에서 승인 규칙을 나열하는 데 사용됨.

Projects::MergeRequests::CreationsController

이 컨트롤러는 app/controllers/projects/merge_requests/creations_controller.rb에 정의되어 있습니다.

이 컨트롤러의 create 액션은 병합 요청 작성 양식이 제출될 때 사용됩니다. approval_rules_attributes 매개변수를 허용하여 ApprovalMergeRequestRule 레코드를 생성/업데이트/삭제합니다. 이 매개변수는 MergeRequests::CreateService를 실행할 때 함께 전달됩니다.

Projects::MergeRequestsController

이 컨트롤러는 app/controllers/projects/merge_requests_controller.rb에 정의되어 있습니다.

이 컨트롤러의 update 액션은 병합 요청 수정 양식이 제출될 때 사용됩니다. 이는 Projects::MergeRequests::CreationsController와 유사하지만 MergeRequests::UpdateService를 실행합니다.

API::MergeRequestApprovals

이 API는 ee/lib/api/merge_request_approvals.rb에 정의되어 있습니다.

병합 요청 페이지를 로드할 때 승인 API 엔드포인트가 요청됩니다.

/projects/:id/merge_requests/:merge_request_iid/approval_settings는 다음과 같이 사용되는 비공개 API 엔드포인트입니다.

  • 병합 요청 수정 양식에서 승인 규칙을 나열하는 데 사용됨.
  • 병합 요청 페이지에서 승인 규칙을 나열하는 데 사용됨.

UI 및 API를 통해 MR을 승인/승인 해제할 때는 병합 요청 승인 API 엔드포인트 또는 병합 요청 승인 해제 API 엔드포인트가 요청됩니다. 이에 따라 MergeRequests::ApprovalService 및 MergeRequests::RemoveApprovalService가 실행됩니다.

API::ProjectApprovalRules 및 API::MergeRequestApprovalRules

이러한 API는 ee/lib/api/project_approval_rules.rb 및 ee/lib/api/merge_request_approval_rules.rb에 정의되어 있습니다.

프로젝트 및 병합 요청 수준의 규칙을 나열/생성/업데이트/삭제하는 데 병합 요청 승인 API를 통해 사용됩니다.

이에 따라 ApprovalRules::CreateService, ApprovalRules::UpdateService, ApprovalRules::ProjectRuleDestroyService, 및 ApprovalRules::MergeRequestRuleDestroyService가 실행됩니다.

ApprovalRules::ParamsFilteringService

이 서비스는 ee/app/services/approval_rules/params_filtering_service.rb에 정의되어 있습니다.

이 서비스는 MergeRequests::CreateService 및 MergeRequests::UpdateService가 실행될 때만 호출됩니다.

다음을 수행하는 데 책임이 있습니다:

  • 사용자가 승인 규칙을 업데이트할 수 없는 경우 이를 제거합니다.
  • 사용자 ID를 프로젝트 구성원 여부에 따라 필터링합니다.
  • 사용자가 볼 수 있는 그룹 ID를 필터링합니다.
  • any_approver 규칙을 식별합니다.
  • 지정된 경우 숨겨진 그룹을 추가합니다.
  • 병합 요청 대상 브랜치에 적용되지 않는 (해당하지 않는 규칙) 승인 규칙을 추가합니다.

ApprovalRules::CreateService

이 서비스는 ee/app/services/approval_rules/create_service.rb에 정의되어 있습니다.

병합 요청 또는 프로젝트 수준에서 승인 규칙을 생성하는 데 책임이 있습니다.

다음과 같은 경우에 호출됩니다:

  • UI를 통해 프로젝트 수준에서 승인 규칙을 생성하는 경우.
  • API::ProjectApprovalRules /projects/:id/approval_rules 엔드포인트를 통해 프로젝트 수준에서 승인 규칙을 생성하는 경우.
  • API::MergeRequestApprovalRules /projects/:id/merge_requests/:merge_request_iid/approval_rules 엔드포인트를 통해 병합 요청 수준의 규칙을 생성하는 경우.

UI를 통해 생성된 병합 요청 수준의 규칙은 이 서비스를 사용하지 않습니다. Projects::MergeRequests::CreationsController를 참조하세요.

흐름

이 플로우차트는 다양한 기능에 대한 컨트롤러부터 모델로의 흐름을 설명하는 데 도움이 될 것입니다.

일부 CRUD API 엔드포인트는 간단하기 때문에 의도적으로 건너뜁니다.

웹 UI를 통해 승인 규칙을 포함한 병합 요청 생성

%%{init: { "fontFamily": "GitLab Sans" }}%% graph LR accTitle: UI에서의 병합 요청 생성 accDescr: 웹 UI를 통해 병합 요청을 생성하는 흐름의 플로우차트, 병합 요청에 승인 규칙이 포함된 경우 Projects::MergeRequests::CreationsController --> MergeRequests::CreateService MergeRequests::CreateService --> ApprovalRules::ParamsFilteringService ApprovalRules::ParamsFilteringService --> MergeRequests::CreateService MergeRequests::CreateService --> MergeRequest MergeRequest --> db[(Database)] MergeRequest --> User MergeRequest --> Group MergeRequest --> ApprovalProjectRule User --> db[(Database)] Group --> db[(Database)] ApprovalProjectRule --> db[(Database)]

업데이트하는 경우, 동일한 흐름이 따르지만 Projects::MergeRequestsController에서 시작하여 MergeRequests::UpdateService를 실행합니다.

MR 페이지에서 승인 규칙 보기

%%{init: { "fontFamily": "GitLab Sans" }}%% graph LR accTitle: 병합 요청에서의 승인 규칙 보기 accDescr: 프론트엔드가 MR 페이지에서 승인 규칙 정보를 검색한 후 표시하는 플로우차트 API::MergeRequestApprovals --> MergeRequest MergeRequest --> ApprovalState ApprovalState --> id1{승인 규칙이 덮어씌워졌나요?} id1{승인 규칙이 덮어씌워졌나요?} --> |아니요| ApprovalProjectRule & ApprovalMergeRequestRule id1{승인 규칙이 덮어씌워졌나요?} --> |예| ApprovalMergeRequestRule ApprovalState --> ApprovalWrappedRule ApprovalWrappedRule --> Approval

이 플로우는 프론트엔드 구성 요소에 의해 시작됩니다. 반환된 데이터는 MR 위젯에 표시하는 데 사용됩니다. ```

병합 요청 승인

%%{init: { "fontFamily": "GitLab Sans" }}%% graph LR accTitle: 승인 데이터 플로차트 accDescr: API 호출이 데이터베이스에 도달하는 승인 플로차트 API::MergeRequestApprovals --> MergeRequests::ApprovalService MergeRequests::ApprovalService --> Approval Approval --> db[(데이터베이스)]

거부할 때에도 동일한 플로우를 따르지만 MergeRequests::RemoveApprovalService가 대신 실행됩니다.

할 일

  1. code_owner 및 report_approver와 같은 다른 규칙 유형에 관련된 정보 추가
  2. 병합 요청의 승인/거부의 부작용에 관한 정보 추가