Back to Repositories

Testing Conversion Tracking and Boost Functionality in Searchkick

This test suite validates conversion tracking and scoring functionality in the Searchkick gem, focusing on how search results are ordered based on conversion metrics and boost terms. The tests ensure proper handling of multiple conversion types, case sensitivity, and conversion weighting.

Test Coverage Overview

The test suite provides comprehensive coverage of Searchkick’s conversion functionality, including:

Basic conversion ordering and scoring
Multiple conversion fields handling
Conversion boost term interactions
Case sensitivity in conversion tracking
Conversion weight compared to other boost factors

Implementation Analysis

The testing approach uses Minitest framework with a structured setup for different conversion scenarios. Tests implement a pattern of storing sample data with various conversion configurations and asserting the expected search result ordering. The implementation specifically validates both single and multiple conversion field handling.

Technical Details

Testing tools and setup include:

Minitest as the testing framework
Custom assertions for order verification
Speaker and Product model fixtures
Setup helper methods for test data initialization
Integration with Searchkick’s indexing and search functionality

Best Practices Demonstrated

The test suite demonstrates several testing best practices:

Isolated test cases for specific conversion features
Clear test method naming conventions
Comprehensive edge case coverage
Consistent data setup patterns
Verification of both positive and negative scenarios

ankane/searchkick

test/conversions_test.rb

            
require_relative "test_helper"

class ConversionsTest < Minitest::Test
  def setup
    super
    setup_speaker
  end

  def test_conversions
    store [
      {name: "Tomato A", conversions: {"tomato" => 1}},
      {name: "Tomato B", conversions: {"tomato" => 2}},
      {name: "Tomato C", conversions: {"tomato" => 3}}
    ]
    assert_order "tomato", ["Tomato C", "Tomato B", "Tomato A"]
    assert_equal_scores "tomato", conversions: false
  end

  def test_multiple_conversions
    store [
      {name: "Speaker A", conversions_a: {"speaker" => 1}, conversions_b: {"speaker" => 6}},
      {name: "Speaker B", conversions_a: {"speaker" => 2}, conversions_b: {"speaker" => 5}},
      {name: "Speaker C", conversions_a: {"speaker" => 3}, conversions_b: {"speaker" => 4}}
    ], Speaker

    assert_equal_scores "speaker", {conversions: false}, Speaker
    assert_equal_scores "speaker", {}, Speaker
    assert_equal_scores "speaker", {conversions: ["conversions_a", "conversions_b"]}, Speaker
    assert_equal_scores "speaker", {conversions: ["conversions_b", "conversions_a"]}, Speaker
    assert_order "speaker", ["Speaker C", "Speaker B", "Speaker A"], {conversions: "conversions_a"}, Speaker
    assert_order "speaker", ["Speaker A", "Speaker B", "Speaker C"], {conversions: "conversions_b"}, Speaker
  end

  def test_multiple_conversions_with_boost_term
    store [
      {name: "Speaker A", conversions_a: {"speaker" => 4, "speaker_1" => 1}},
      {name: "Speaker B", conversions_a: {"speaker" => 3, "speaker_1" => 2}},
      {name: "Speaker C", conversions_a: {"speaker" => 2, "speaker_1" => 3}},
      {name: "Speaker D", conversions_a: {"speaker" => 1, "speaker_1" => 4}}
    ], Speaker

    assert_order "speaker", ["Speaker A", "Speaker B", "Speaker C", "Speaker D"], {conversions: "conversions_a"}, Speaker
    assert_order "speaker", ["Speaker D", "Speaker C", "Speaker B", "Speaker A"], {conversions: "conversions_a", conversions_term: "speaker_1"}, Speaker
  end

  def test_conversions_case
    store [
      {name: "Tomato A", conversions: {"tomato" => 1, "TOMATO" => 1, "tOmAtO" => 1}},
      {name: "Tomato B", conversions: {"tomato" => 2}}
    ]
    assert_order "tomato", ["Tomato A", "Tomato B"]
  end

  def test_conversions_weight
    Product.reindex
    store [
      {name: "Product Boost", orders_count: 20},
      {name: "Product Conversions", conversions: {"product" => 10}}
    ]
    assert_order "product", ["Product Conversions", "Product Boost"], boost: "orders_count"
  end
end