코드 승인 규칙 개발 가이드라인

이 문서는 Merge Request 승인 규칙에 관련된 모든 기능의 백엔드 디자인과 흐름을 설명합니다.

이는 기여자가 코드 디자인을 더 쉽게 이해하고 기능 및 구현이 발전함에 따라 개선할 부분이 있는지 확인하는 데 도움이 될 것으로 기대됩니다.

자주 변경되는 구현 세부 정보를 담지 않게 하는 것이 의도된 바입니다. 코드가 해당 사항을 더 잘 설명해야 합니다. 여기에 언급된 컴포넌트는 승인 규칙 기능이 작동하는 응용 프로그램의 주요 부분입니다.

note
이 문서는 계속 변하는 문서이며 코드베이스의 일부가 수정 또는 제거되거나 새 컴포넌트가 추가될 때 해당 부분에 맞게 업데이트되어야 합니다.

데이터 모델

%%{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 버전을 확장하고 있습니다. Merge Request 승인에 대한 관련 사항 및 기타 관련된 것들이 여기에 정의되어 있습니다.

ApprovalState

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

ApprovalState 클래스는 ee/app/models/approval_state.rb에 정의되어 있습니다. 이는 실제 ActiveRecord 모델이 아닙니다. 이 클래스는 다음과 같은 특정 Merge Request에 대한 승인 상태와 관련된 모든 논리를 캡슐화합니다:

  • 대상 브랜치를 기반으로하는 Merge Request에 적용 가능한 승인 규칙 파악
  • 특정 대상 브랜치에 적용 가능한 승인 규칙 파악
  • 모든 규칙이 승인되었는지 확인
  • 승인이 필요한지 확인
  • 몇 개의 승인이 이루어지거나 아직 필요한지 확인

이는 프로젝트(ApprovalProjectRule) 또는 Merge Request(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: Merge Request과 ApprovalMergeRequestRule 간의 엔터티 관계 다이어그램 MergeRequest ||--o{ ApprovalMergeRequestRule: " " ApprovalMergeRequestRule }o--o{ User: " " ApprovalMergeRequestRule }o--o{ Group: " " ApprovalMergeRequestRule ||--o| ApprovalProjectRule: " "

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

Merge Request 생성/편집 양식 또는 Merge Request 수준 승인 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 규칙을 래핑하는 데 사용됩니다.

이 클래스는 거의 모든 책임을 래핑하는 승인 규칙에 위임하지만 다음과 같은 책임도 가지고 있습니다:

  • 승인 규칙이 승인되었는지 확인
  • 승인 규칙에 필요한 승인 수 및 아직 필요한 승인 수 파악

이는 해당 정보를 승인 규칙 및 Merge Request에서의 Approval 레코드로부터 받아옵니다.

Approval

%%{init: { "fontFamily": "GitLab Sans" }}%% erDiagram accTitle: 승인 다이어그램 accDescr: Merge Request과 승인 간의 엔터티 관계 다이어그램 MergeRequest ||--o{ Approval: " "

Approval 모델은 ee/app/models/approval.rb에 정의되어 있습니다. 이 모델은 Merge Request에서 이루어진 승인에 관한 정보를 저장하는 책임이 있습니다. 승인이 이루어지거나 취소될 때 마다 레코드가 생성/삭제됩니다.

컨트롤러와 서비스

아래 컨트롤러와 서비스는 승인 규칙 기능에 사용되고 있습니다.

API::ProjectApprovalSettings

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

다음에 사용됩니다:

  • 프로젝트 설정에서 승인 규칙 디렉터리 표시
  • 프로젝트 설정에서 규칙 생성/업데이트/삭제
  • Merge Request 생성 양식에서 승인 규칙 디렉터리 표시

Projects::MergeRequests::CreationsController

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

이 컨트롤러의 create 액션은 Merge Request 생성 양식이 제출될 때 사용됩니다. approval_rules_attributes 매개변수를 받아들여 ApprovalMergeRequestRule 레코드의 생성/업데이트/삭제에 사용됩니다. 이는 MergeRequests::CreateService를 실행할 때 이 매개변수를 전달합니다.

Projects::MergeRequestsController

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

이 컨트롤러의 update 액션은 Merge Request 편집 양식이 제출될 때 사용됩니다. Projects::MergeRequests::CreationsController와 유사하지만 MergeRequests::UpdateService를 실행합니다.

API::MergeRequestApprovals

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

Approvals API endpoint는 Merge Request 페이지가 로드될 때 요청됩니다.

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

  • Merge Request 수정 양식에서 승인 규칙 나열.
  • Merge Request 페이지에서 승인 규칙 나열.

UI 및 API를 통해 MR을 승인하거나 승인을 취소할 때는 Approve Merge Request API 엔드포인트 또는 Unapprove Merge Request 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에서 정의됩니다.

Merge request approvals API를 통해 프로젝트 및 Merge Request 수준 규칙을 나열/생성/업데이트/삭제하는 데 사용됩니다.

ApprovalRules::CreateService, ApprovalRules::UpdateService, ApprovalRules::ProjectRuleDestroyService, 및 ApprovalRules::MergeRequestRuleDestroyService를 각각 실행합니다.

ApprovalRules::ParamsFilteringService

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

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

이는 approval_rules_attributes 매개변수를 구문 분석하여 다음을 담당합니다:

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

ApprovalRules::CreateService

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

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

이는 다음 경우에 호출됩니다:

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

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

Flow

다음 flowcharts는 다양한 기능에 대한 컨트롤러에서 모델로 흐름을 설명하는 데 도움이 될 것입니다.

일부 CRUD API 엔드포인트는 매우 직관적이기 때문에 일부러 건너뜁니다.

웹 UI를 통해 승인 규칙이 포함된 Merge Request 생성

%%{init: { "fontFamily": "GitLab Sans" }}%% graph LR accTitle: 웹 UI에서의 Merge Request 생성 accDescr: Merge Request이 승인 규칙을 포함하는 경우 웹 UI에서 Merge Request을 생성하는 플로우차트 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가 실행됩니다.

Merge Request에서 승인 규칙 보기

%%{init: { "fontFamily": "GitLab Sans" }}%% graph LR accTitle: Merge Request에서 승인 규칙 보기 accDescr: Frontend가 Merge Request 페이지에서 승인 규칙 정보를 검색하고 표시하는 방법에 대한 플로우차트 API::MergeRequestApprovals --> MergeRequest MergeRequest --> ApprovalState ApprovalState --> id1{승인 규칙이 재정의됨} id1{승인 규칙이 재정의됨} --> |아니요| ApprovalProjectRule & ApprovalMergeRequestRule id1{승인 규칙이 재정의됨} --> |예| ApprovalMergeRequestRule ApprovalState --> ApprovalWrappedRule ApprovalWrappedRule --> Approval

이 플로우는 프론트엔드 컴포넌트에 의해 시작됩니다. 반환된 데이터는 MR 위젯에 정보를 표시하는 데 사용됩니다.

Merge Request 승인

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

승인을 취소할 때에는 MergeRequests::RemoveApprovalService가 실행됩니다.

TODO

  1. code_owner 및 report_approver와 같은 다른 규칙 유형에 관련된 정보 추가.
  2. Merge Request 승인/미승인의 부작용에 관한 정보 추가.