Enum 생성
새로운 enum을 생성할 때는 데이터베이스 유형으로 SMALLINT
를 사용해야 합니다.
SMALLINT
유형의 크기는 2바이트로, enum에 충분합니다.
이는 데이터베이스 공간을 절약하는 데 도움이 될 것입니다.
이 유형을 사용하려면 열을 생성하는 마이그레이션에 limit: 2
를 추가하면 됩니다.
예시:
def change
add_column :ci_job_artifacts, :file_format, :integer, limit: 2
end
모든 키/값 쌍은 FOSS에 정의되어야 합니다
요약: 모든 enum은 FOSS에 정의되어야 하며, 모델도 FOSS의 일부인 경우입니다.
class Model < ApplicationRecord
enum platform: {
aws: 0,
gcp: 1 # EE-only
}
end
enum
에 새로운 키/값 쌍을 추가하고 EE에 특화된 경우, 다음과 같이 enum
을 구성하면 유혹을 느낄 수 있습니다:
# 'Pipeline' 모델에 `failure_reason` enum을 정의합니다:
class Pipeline < ApplicationRecord
enum failure_reason: Enums::Pipeline.failure_reasons
end
# FOSS 및 EE에서 사용되는 키/값 쌍을 정의합니다:
module Enums
module Pipeline
def self.failure_reasons
{ unknown_failure: 0, config_error: 1 }
end
end
end
Enums::Pipeline.prepend_mod_with('Enums::Pipeline')
# EE에서만 사용되는 키/값 쌍을 정의합니다:
module EE
module Enums
module Pipeline
override :failure_reasons
def failure_reasons
super.merge(job_activity_limit_exceeded: 2)
end
end
end
end
이 형태 그대로 작동하지만, 몇 가지 단점이 있습니다:
- 누군가가 conflicted인 EE에 키/값 쌍을 정의할 수 있습니다.
예를 들어,
EE::Enums::Pipeline
에job_activity_limit_exceeded: 1
을 정의합니다. - 이런 경우, 해당 기능은 완전히 다르게 작동합니다.
예를 들어,
failure_reason
이config_error
인지job_activity_limit_exceeded
인지 알 수 없습니다. - 이런 경우, 데이터 무결성을 수정하기 위해 데이터베이스 마이그레이션을 배포해야 합니다. 원래 값이 복구되지 않으면 불가능할 수 있습니다.
또한, EE
모듈 값에 오프셋을 설정하여 이 문제에 대한 해결책일 수 있음을 알 수 있습니다.
예를 들어, 이 예에서는 오프셋으로 1000
을 설정합니다:
module EE
module Enums
module Pipeline
override :failure_reasons
def failure_reasons
super.merge(job_activity_limit_exceeded: 1_000, size_limit_exceeded: 1_001)
end
end
end
end
이것은 해결책으로 작동하지만, 이러한 방식에는 몇 가지 단점이 있습니다:
- 기능이 FOSS로 이동하거나 EE로 이동할 수 있습니다. 따라서 오프셋이 나중에 FOSS와 EE 사이에 혼재될 수 있습니다.
예를 들어,
job_activity_limit_exceeded
를 FOSS로 이동하는 경우,{ unknown_failure: 0, config_error: 1, job_activity_limit_exceeded: 1_000 }
이 표시됩니다. -
enum
에 대한 정수 열은 일반적으로SMALLINT
로 생성됩니다(enum 생성 참조). 따라서 오프셋이 2바이트 정수의 최대값을 초과하지 않도록 주의해야 합니다.
결론적으로, 모든 키/값 쌍을 FOSS에 정의해야 합니다. 예를 들어, 위의 예시에 다음의 코드를 작성할 수 있습니다:
class Pipeline < ApplicationRecord
enum failure_reason: {
unknown_failure: 0,
config_error: 1,
job_activity_limit_exceeded: 2
}
end
갭에 새로운 값 추가
일부 EE 및 FOSS enum을 Merge한 후에는 두 그룹의 값 사이에 갭이 생길 수 있습니다:
module Enums
module Ci
module CommitStatus
def self.failure_reasons
{
# ...
data_integrity_failure: 12,
forward_deployment_failure: 13,
insufficient_bridge_permissions: 1_001,
downstream_bridge_project_not_found: 1_002,
# ...
}
end
end
end
end
새로운 값은 갭을 채우기 위해 먼저 추가해야 합니다.
위의 예시에서 1_003
대신 14
를 추가하십시오:
{
# ...
data_integrity_failure: 12,
forward_deployment_failure: 13,
a_new_value: 14,
insufficient_bridge_permissions: 1_001,
downstream_bridge_project_not_found: 1_002,
# ...
}