모델 및 서비스 스팸 방지 및 CAPTCHA 지원

REST API, GraphQL API 또는 Web UI에 스팸 또는 CAPTCHA 지원을 추가하기 전에 우선 해야 할 일은 다음과 같습니다.

  1. 백엔드 ActiveRecord 모델
  2. 서비스 레이어

스팸 또는 CAPTCHA 요청 유형과 관계없이 필요한 다음 변경 사항 중 일부 또는 대부분이 필요합니다. GraphQL API에 완전히 기반한 일부 최신 기능에는 컨트롤러가 전혀 없을 수 있으며, 컨트롤러에 mark_as_spam 작업을 추가할 필요가 없습니다.

다음을 수행하십시오.

  1. ActiveRecord 모델에 Spammable 지원 추가
  2. 컨트롤러에 mark_as_spam 작업 지원 추가
  3. 서비스의 execute 메서드에 check_for_spam 호출 추가

ActiveRecord 모델에 Spammable 지원 추가

  1. 모델 클래스에 Spammable 모듈 포함: 

    include Spammable

  2. attr_spammable을 추가하여 스팸을 확인할 수 있는 필드를 나타냅니다. 모델당 최대 두 개의 필드를 지원하며, “title“과 “description“으로 지정할 수 있습니다. 예를 들어, 다음 라인은 content 필드를 description으로 지정합니다: 

    attr_spammable :content, spam_description: true

  3. #check_for_spam? 메서드 구현을 추가합니다. 

    def check_for_spam?(user:)
  # 적용 가능한 여러 확인을 기반으로 부울 결과를 반환합니다. 이 확인은 변경된 속성, 사용자 유형, 데이터의 공개 여부 및 기타 기준을 포함할 수 있습니다. 이는 모델 유형에 따라 다를 수 있으며, 스팸 확인 요구 사항이 변할 수 있습니다.
end

    다른 기존 Spammable 모델의 이 메서드 구현을 참조하여 필요한 논리 확인의 예를 찾을 수 있습니다.

컨트롤러에 mark_as_spam 작업 지원 추가

SpammableActions::AkismetMarkAsSpamAction 모듈은 컨트롤러에 #mark_as_spam 작업을 지원합니다. 이 컨트롤러를 통해 관리자는 Admin Area 페이지의 스팸 로그 섹션에서 연결된 Spammable 모델의 스팸을 관리할 수 있습니다.

  1. 컨트롤러에 SpammableActions::AkismetMarkAsSpamAction 모듈 포함: 

    include SpammableActions::AkismetMarkAsSpamAction

  2. #spammable_path 메서드 구현을 추가합니다. 스팸 관리 페이지는 편집 후 이 페이지로 리디렉션됩니다. 다른 기존 컨트롤러의 이 메서드 구현을 참조하여 필요한 경로 논리의 예를 찾을 수 있습니다. 일반적으로, 이는 Spammable 모델의 컨트롤러에 대한 #show 작업이어야 합니다. 

    def spammable_path
  widget_path(widget)
note
기능이 구현된 방식에 따라 컨트롤러에 필요한 다른 변경 사항이 있을 수 있습니다. 자세한 내용은 Web UI를 참조하십시오.

서비스의 execute 메서드에 check_for_spam 호출 추가

이 방법은 스팸 속성을 영속화할 수 있는 모든 서비스에 적용됩니다.

  1. app/services의 관련 Create 또는 Update 서비스에서 모델에 check_for_spam 메서드를 호출합니다.
  2. 스팸 확인이 실패하는 경우:
    • 모델에 오류가 추가되어 유효하지 않게 되고 저장되지 못하게 됩니다.
    • needs_recaptcha 속성이 true로 설정됩니다.

    모델에 대한 이러한 변경으로 이후의 백엔드 및 프론트엔드 CAPTCHA 논리에서 해당 모델을 처리할 수 있게 되었습니다.

관련 있는 각 서비스에 이러한 변경을 적용하십시오.

  1. execute 메서드에서 모델에 check_for_spam 메서드를 호출합니다. (서비스가 해당 패턴을 사용하는 경우 before_create 또는 before_update를 사용할 수도 있습니다.) 이 메서드는 명명된 인수를 사용하므로 기존 예제를 참조하면 사용 방법이 명확합니다. 그러나 두 가지 중요한 고려 사항이 있습니다:
    1. check_for_spam은 변경되지 않은 (dirty) Spammable 모델 인스턴스에 필요한 모든 변경 후에 실행되어야 합니다. 이 순서는 스팸 확인할 속성이 존재함을 보장합니다.
    2. check_for_spam은 모델에 오류가 확인되고 save가 시도되기 전에 실행되어야 합니다. 모델의 변경된 속성에서 잠재적인 스팸이 감지되면 저장을 방지해야 합니다. 
module Widget
  class CreateService < ::Widget::BaseService
    # 참고: 스팸 확인이 필요한 경우 기본값으로 `true`를 추가합니다.
    def initialize(project:, current_user: nil, params: {}, perform_spam_check: true)
      super(project: project, current_user: current_user, params: params)
      
      @perform_spam_check = perform_spam_check
    end
    
    def execute
      widget = Widget::BuildService.new(project, current_user, params).execute
      
      # 모델이 스팸 확인을 수행하기 전에 더 많은 코드를 추가할 수 있습니다.
      
      # 참고: 이는 스팸 확인이 수행되기 전에 dirty 모델이 인스턴스화된 후에 수행되어야 합니다.
      widget.check_for_spam(user: current_user, action: :create) if perform_spam_check
      
      # 모델을 저장하기 위한 관련 코드 및 속성 변경이 추가될 수도 있지만, 속성을 변경해서는 안 됩니다.
      
      widget.save
    end
    
    private
    
    attr_reader :perform_spam_check