모델 및 서비스 스팸 방지 및 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. 서비스의 실행 메서드에 check_for_spam 호출 추가.

ActiveRecord 모델에 Spammable 지원 추가

  1. 모델 클래스에 Spammable 모듈을 포함합니다: 

    include Spammable

  2. attr_spammable을 추가하여 스팸을 확인할 수 있는 필드를 나타냅니다. 모델 당 두 개의 필드까지 지원됩니다: “title“과 “description”. 어떤 필드를 “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 동작을 추가하는 지원을 제공합니다. 이 컨트롤러는 관리자가 관련 Spammable 모델에 대한 스팸을 스팸 로그 섹션의 관리자 영역에서 관리할 수 있습니다.

  1. 컨트롤러에 SpammableActions::AkismetMarkAsSpamAction 모듈을 포함합니다. 

    include SpammableActions::AkismetMarkAsSpamAction

  2. #spammable_path 메서드를 구현합니다. 스팸 관리 페이지는 편집 후 이 페이지로 리디렉션됩니다. 필요한 경로 로직 예제를 참조하여 일반적으로 모델의 컨트롤러에 대한 #show 동작이어야 합니다. 

    def spammable_path
  widget_path(widget)
end

참고: 기능 구현에 따라 컨트롤러에 필요한 다른 변경 사항이 있을 수 있습니다. 자세한 내용은 Web UI를 참조하세요.

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

이 접근 방식은 영구적인 spammable 속성을 가질 수 있는 어떤 서비스에도 적용됩니다:

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

    이러한 모델의 변경으로 이후 백엔드 및 프론트엔드 CAPTCHA 로직을 처리할 수 있게 됩니다.

각 관련 서비스에 다음 변경을 적용합니다:

  1. execute 메서드에서 모델의 check_for_spam 메서드를 호출합니다. (서비스가 그 패턴을 사용하는 경우) before_create 또는 before_update도 사용할 수 있습니다. 이 메서드는 명명된 인수를 사용하므로 기존 예제를 참조하면 사용 방법이 명확합니다. 하지만 다음 두 가지 고려 사항이 있습니다:
    1. check_for_spam은 변경되지 않은(더티) Spammable 모델 인스턴스에 필요한 모든 변경이 이루어진 후에 실행되어야 합니다. 이 순서는 스팸 확인을 위해 spammable 속성이 존재함을 보장합니다.
    2. 모델의 변경된 속성에서 잠재적인 스팸이 감지되면 오류를 확인하고 save를 시도하기 전에 check_for_spam을 실행해야 합니다. 
module Widget
  class CreateService < ::Widget::BaseService
    # 참고: 스팸 확인이 필요할 확률이 높기 때문에 `perform_spam_check`의 기본값을 `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

      # 모델을 스팸 확인하기 전에 변형할 수 있는 추가 코드

      # 참고: spammable 모델이 인스턴스화된 후, 하지만 유효성 검사나 저장 전에 수행합니다.
      widget.check_for_spam(user: current_user, action: :create) if perform_spam_check

      # 모델 저장과 관련된 가능한 추가 코드가 있을 수 있으나 어떤 속성도 변경하면 안 됩니다.

      widget.save
    end

    private

    attr_reader :perform_spam_check