InfoGrab DocsInfoGrab Docs

기능 스펙에서 프런트엔드 및 백엔드 Snowplow 이벤트 캡처

기능 스펙에서 프런트엔드와 백엔드 Snowplow 이벤트의 실제 페이로드를 캡처하는 방법을 설명합니다.

expect_snowplow_event 는 Gitlab::Tracking.event 에 대한 목(mock)입니다. 실제 페이로드를 검사하지 않으며 브라우저가 보내는 어떤 것도 볼 수 없으므로, 프런트엔드 Snowplow 이벤트는 스펙에서 전혀 검증할 수 없었습니다. 기능 스펙을 위해 만든 이 메커니즘은 GitLab이 백엔드와 브라우저 양쪽에서 내보내는 실제 페이로드를 캡처합니다. 프런트엔드 이벤트가 보이지 않던 이유 # 모든 스펙은 stub_snowplow 를 호출하며, 이 호출은 브라우저의 Snowplow 트래커를 localhost 로 향하게 합니다. 테스트 환경에서는 그곳에서 수신하는 것이 없으므로, 프런트엔드가 발생시킨 이벤트는 올바르게 내보내지지만 전달될 곳이 없습니다. 캡처 동작 방식 # :capture_snowplow_events 태그가 지정된 스펙은 브라우저 트래커의 수집기 호스트 이름을 스펙이 이미 실행 중인 Capybara 서버로 향하게 합니다. 테스트 환경에 등록된 Rack 미들웨어( Gitlab::Testing::SnowplowCollectorMiddleware )가 해당 수집기 경로에 응답하고 모든 페이로드를 기록합니다. 백엔드 이벤트는 기존 테스트 이미터를 통해 계속 전달됩니다. 둘 다 같은 버퍼에 쌓이므로, 스펙은 출처와 관계없이 한곳에서 이벤트를 읽습니다. 이 방식은 실제 브라우저와 Capybara 서버에 의존하므로, 태그에는 :js 가 필요하며 없으면 명확한 오류를 발생시킵니다. 추적에 대해 아무것도 검증하지 않는 예제가 설정 비용을 부담하지 않도록, :capture_snowplow_events 는 둘러싼 describe 또는 context 블록이 아니라 개별 예제에 지정합니다. 이벤트 버퍼는 태그가 지정된 각 예제 전에 생성되고 예제 후에 폐기되므로, 한 예제의 이벤트가 다른 예제에 보이는 일은 없습니다. 검증하는 내용은 단일 예제 안에서 충족할 수 있어야 합니다. Note expect_snowplow_event 는 :capture_snowplow_events 예제에서 동작하지 않습니다. 이 메서드는 stub_snowplow 가 allow(Gitlab::Tracking).to receive(:event) 로 설치하는 스파이에 대해 검증하지만, :capture_snowplow_events 태그는 수집기 호스트 이름을 직접 제어해야 하므로 의도적으로 stub_snowplow 를 건너뜁니다. 스파이가 없으면 expect_snowplow_event 는 추적과 관련된 내용이 아니라 객체가 스파이가 아니라는 오류로 실패합니다. 대신 이 페이지의 헬퍼를 사용합니다. 기존 스펙을 이벤트 캡처를 사용하도록 변환할 때 특히 중요합니다. 이벤트를 직접 검증 # 일회성 확인에는 다음 헬퍼를 직접 사용합니다. captured_snowplow_events 는 지금까지 캡처된 모든 항목을 SnowplowEvent 구조체로 반환합니다. find_snowplow_event(**attributes) 는 기다리지 않고 첫 번째 일치 항목을