Ruby: provide breakdown to differentiate net new and modified new appendix

Summary:
This change adds appendix type constants to differentiate between:
- APPENDIX_NET_NEW (0x02): Brand new cookies (0→1)
- APPENDIX_MODIFIED_NEW (0x03): Updated existing cookies with new payload
- APPENDIX_NO_CHANGE (0x00): Existing values without modification

TODO: cleanup unused variables

Differential Revision: D91720354

fbshipit-source-id: 5849cdc84fc070b62a48d55d91cb6dbaa3020b3a

Author: hongj-src

ruby/capi_param_builder/lib/capi_param_builder.rb

@@ -29,10 +29,17 @@ class ParamBuilder
   APPENDIX_LENGTH_V1 = 2
   APPENDIX_LENGTH_V2 = 8
 
+  # Appendix type constants
+  APPENDIX_NO_CHANGE = 0x00
+  APPENDIX_GENERAL_NEW = 0x01
+  APPENDIX_NET_NEW = 0x02
+  APPENDIX_MODIFIED_NEW = 0x03
+
   def initialize(input = nil)
     @fbc_params_configs = [FbcParamConfigs.new("fbclid", "", "clickID")]
-    @appendix_new = get_appendix(true)
-    @appendix_normal = get_appendix(false)
+    @appendix_net_new = get_appendix(APPENDIX_NET_NEW)
+    @appendix_modified_new = get_appendix(APPENDIX_MODIFIED_NEW)
+    @appendix_no_change = get_appendix(APPENDIX_NO_CHANGE)
 
     if input.nil?
       return
@@ -48,21 +55,27 @@ def initialize(input = nil)
     end
   end
 
-  private def get_appendix(is_new)
+  private def get_appendix(appendix_type)
     begin
       version = ReleaseConfig::VERSION
       version_parts = version.split(".")
       major = version_parts[0].to_i
       minor = version_parts[1].to_i
       patch = version_parts[2].to_i
 
-      is_new_byte = is_new ? 0x01 : 0x00
+      # Validate appendix type
+      valid_types = [APPENDIX_NET_NEW, APPENDIX_GENERAL_NEW, APPENDIX_MODIFIED_NEW]
+      if valid_types.include?(appendix_type)
+        type_byte = appendix_type
+      else
+        type_byte = APPENDIX_NO_CHANGE
+      end
 
       # Create byte array
       bytes_array = [
         DEFAULT_FORMAT,        # 0x01 = 1
         LANGUAGE_TOKEN_INDEX,  # 0x05 = 5
-        is_new_byte,          # 0x01 when is_new=true, 0x00 when is_new=false
+        type_byte,            # appendix type
         major,                # Major version number
         minor,                # Minor version number
         patch                 # Patch version number
@@ -104,7 +117,7 @@ def initialize(input = nil)
     end
     # Append language token if not present
     if parts.size == MIN_PAYLOAD_SPLIT_LENGTH
-      updated_cookie_value = cookie_value + "." + @appendix_normal
+      updated_cookie_value = cookie_value + "." + @appendix_no_change
       @cookie_to_set_dict[cookie_name] = CookieSettings.new(
         cookie_name, updated_cookie_value, @etld_plus_one, DEFAULT_1PC_AGE)
       return updated_cookie_value
@@ -282,25 +295,34 @@ def get_fbp()
       return nil
     end
 
+    cookie_update = false
+    is_net_new = false
     if existing_fbc.nil?
       cookie_update = true
+      is_net_new = true
     else
       parts = existing_fbc.split(/\./)
-      cookie_update = new_fbc_payload != parts[3]
+      if parts.size < MIN_PAYLOAD_SPLIT_LENGTH
+        cookie_update = true
+        is_net_new = true
+      else
+        cookie_update = new_fbc_payload != parts[3]
+      end
     end
     if cookie_update == false
       return nil
     end
 
     current_ms = (Time.now.to_f * 1000).to_i.to_s
+    appendix = is_net_new ? @appendix_net_new : @appendix_modified_new
     new_fbc = "fb." +
       @sub_domain_index.to_s +
       "." +
       current_ms +
       "." +
       new_fbc_payload +
       "." +
-      @appendix_new
+      appendix
     updated_cookie_setting = CookieSettings.new(
       FBC_NAME, new_fbc, @etld_plus_one, DEFAULT_1PC_AGE)
     return updated_cookie_setting
@@ -319,7 +341,7 @@ def get_fbp()
       "." +
       new_fbp_payload +
       "." +
-      @appendix_new
+      @appendix_net_new
     updated_cookie_setting = CookieSettings.new(
       FBP_NAME, new_fbp, @etld_plus_one, DEFAULT_1PC_AGE)
     return updated_cookie_setting

ruby/capi_param_builder/test/test_param_builder.rb

@@ -10,8 +10,9 @@
 require 'test_etld_plus_one_resolver'
 require_relative '../lib/model/fbc_param_configs'
 
-APPENDIX_IS_NEW = "AQUBAQAB"
-APPENDIX_IS_NORMAL = "AQUAAQAB"
+APPENDIX_NET_NEW = "AQUCAQAB"
+APPENDIX_MODIFIED_NEW = "AQUDAQAB"
+APPENDIX_NO_CHANGE = "AQUAAQAB"
 
 # Save the original value before any tests run
 ORIGINAL_VERSION = ReleaseConfig::VERSION
@@ -31,10 +32,12 @@ def test_override_different_versions
         ReleaseConfig.const_set(:VERSION, "1.15.24")
         assert_equal "1.15.24", ReleaseConfig::VERSION
         builder = ParamBuilder.new()
-        appendix_new = builder.send(:get_appendix, true)
-        assert_equal(appendix_new, "AQUBAQ8Y")
-        appendix_normal = builder.send(:get_appendix, false)
-        assert_equal(appendix_normal, "AQUAAQ8Y")
+        appendix_net_new = builder.send(:get_appendix, ParamBuilder::APPENDIX_NET_NEW)
+        assert_equal(appendix_net_new, "AQUCAQ8Y")
+        appendix_modified_new = builder.send(:get_appendix, ParamBuilder::APPENDIX_MODIFIED_NEW)
+        assert_equal(appendix_modified_new, "AQUDAQ8Y")
+        appendix_no_change = builder.send(:get_appendix, ParamBuilder::APPENDIX_NO_CHANGE)
+        assert_equal(appendix_no_change, "AQUAAQ8Y")
     ensure
         ReleaseConfig.send(:remove_const, :VERSION)
         ReleaseConfig.const_set(:VERSION, tmp_original_version)
@@ -45,10 +48,10 @@ def test_override_different_versions_exception
         ReleaseConfig.send(:remove_const, :VERSION)
         ReleaseConfig.const_set(:VERSION, nil)
         builder = ParamBuilder.new()
-        appendix_new = builder.send(:get_appendix, true)
-        assert_equal(appendix_new, "BQ")
-        appendix_normal = builder.send(:get_appendix, false)
-        assert_equal(appendix_normal, "BQ")
+        appendix_net_new = builder.send(:get_appendix, ParamBuilder::APPENDIX_NET_NEW)
+        assert_equal(appendix_net_new, "BQ")
+        appendix_no_change = builder.send(:get_appendix, ParamBuilder::APPENDIX_NO_CHANGE)
+        assert_equal(appendix_no_change, "BQ")
     ensure
         ReleaseConfig.send(:remove_const, :VERSION)
         ReleaseConfig.const_set(:VERSION, tmp_original_version)
@@ -62,16 +65,16 @@ def test_process_request_with_fbc_fbp_updated
             {"test"=>"value", "_fbc"=>"fb.1.2.test_fbc"},
             "example.com?fbclid=test345")
         assert_equal(2, cookie_to_update.size())
-        assert_contains(".test123.#{APPENDIX_IS_NEW}", builder.get_fbc())
+        assert_contains(".test123.#{APPENDIX_MODIFIED_NEW}", builder.get_fbc())
         assert_contains("fb.0.", builder.get_fbp())
         for cookie in cookie_to_update do
             if cookie.name == '_fbc'
-                assert cookie.value.end_with?(".test123.#{APPENDIX_IS_NEW}")
+                assert cookie.value.end_with?(".test123.#{APPENDIX_MODIFIED_NEW}")
                 assert_contains('fb.0.', cookie.value)
                 assert_contains("localhost", cookie.domain)
             else
                 assert_equal(ParamBuilder::FBP_NAME, cookie.name)
-                assert cookie.value.end_with?(APPENDIX_IS_NEW)
+                assert cookie.value.end_with?(APPENDIX_NET_NEW)
                 assert_equal("localhost", cookie.domain)
             end
         end
@@ -86,18 +89,18 @@ def test_process_request_with_fbc_fbp_update_no_cookie
             {},
             "example.com")
         assert_equal(2, cookie_to_update.size())
-        assert builder.get_fbc().end_with?(".test123.#{APPENDIX_IS_NEW}")
+        assert builder.get_fbc().end_with?(".test123.#{APPENDIX_NET_NEW}")
         assert_contains("fb.1.", builder.get_fbp())
-        assert builder.get_fbp().end_with?(".#{APPENDIX_IS_NEW}")
+        assert builder.get_fbp().end_with?(".#{APPENDIX_NET_NEW}")
         for cookie in cookie_to_update do
             if cookie.name == '_fbc'
-                assert cookie.value.end_with?(".test123.#{APPENDIX_IS_NEW}")
+                assert cookie.value.end_with?(".test123.#{APPENDIX_NET_NEW}")
                 assert_contains('fb.1.', cookie.value)
                 assert_equal("example.com", cookie.domain)
             else
                 assert_equal(ParamBuilder::FBP_NAME, cookie.name)
                 assert_contains("fb.1.", cookie.value)
-                assert cookie.value.end_with?(".#{APPENDIX_IS_NEW}")
+                assert cookie.value.end_with?(".#{APPENDIX_NET_NEW}")
                 assert_equal("example.com", cookie.domain)
             end
         end
@@ -114,12 +117,12 @@ def test_process_request_with_with_resolver
         assert_equal(2, cookie_to_update.size())
         for cookie in cookie_to_update do
             if cookie.name == ParamBuilder::FBC_NAME
-                assert_contains(".test.#{APPENDIX_IS_NEW}", cookie.value)
+                assert_contains(".test.#{APPENDIX_MODIFIED_NEW}", cookie.value)
                 assert_contains("fb.4.", cookie.value)
                 assert_equal("this.is.a.test.com", cookie.domain)
             else
                 assert_equal(ParamBuilder::FBP_NAME, cookie.name)
-                assert_equal("fb.1.123.value.#{APPENDIX_IS_NORMAL}", cookie.value)
+                assert_equal("fb.1.123.value.#{APPENDIX_NO_CHANGE}", cookie.value)
                 assert_equal("this.is.a.test.com", cookie.domain)
             end
         end
@@ -135,7 +138,7 @@ def test_process_request_with_with_empty_constructor
             "https://example.com?fbclid=wer")
         assert_equal(1, cookie_to_update.size())
         for cookie in cookie_to_update do
-            assert_contains(".test.#{APPENDIX_IS_NEW}", cookie.value)
+            assert_contains(".test.#{APPENDIX_NET_NEW}", cookie.value)
             assert_contains("fb.4.", cookie.value)
             assert_equal("is.a.test.co.uk", cookie.domain)
         end
@@ -153,7 +156,7 @@ def test_process_request_with_with_invali_string_domain_list
             "https://example.com?fbclid=wer")
         assert_equal(1, cookie_to_update.size())
         for cookie in cookie_to_update do
-            assert_contains(".test.#{APPENDIX_IS_NEW}", cookie.value)
+            assert_contains(".test.#{APPENDIX_NET_NEW}", cookie.value)
             assert_contains("fb.4.", cookie.value)
             assert_equal("is.a.test.example.com", cookie.domain)
         end
@@ -170,13 +173,13 @@ def test_process_request_with_with_referer
         assert_equal(2, cookie_to_update.size())
         for cookie in cookie_to_update do
             if cookie.name == ParamBuilder::FBC_NAME
-                assert_contains(".wer.#{APPENDIX_IS_NEW}", cookie.value)
+                assert_contains(".wer.#{APPENDIX_NET_NEW}", cookie.value)
                 assert_contains("fb.4.", cookie.value)
                 assert_equal("is.a.test.co.uk", cookie.domain)
             else
                 assert_equal(ParamBuilder::FBP_NAME, cookie.name)
                 assert_contains("fb.4.", cookie.value)
-                assert_contains(".#{APPENDIX_IS_NEW}", cookie.value)
+                assert_contains(".#{APPENDIX_NET_NEW}", cookie.value)
                 assert_equal("is.a.test.co.uk", cookie.domain)
             end
         end
@@ -193,13 +196,13 @@ def test_process_request_with_with_duplicate_referer_params
         assert_equal(2, cookie_to_update.size())
         for cookie in cookie_to_update do
             if cookie.name == ParamBuilder::FBC_NAME
-                assert_contains(".wer.#{APPENDIX_IS_NEW}", cookie.value)
+                assert_contains(".wer.#{APPENDIX_NET_NEW}", cookie.value)
                 assert_contains("fb.4.", cookie.value)
                 assert_equal("is.a.test.co.uk", cookie.domain)
             else
                 assert_equal(ParamBuilder::FBP_NAME, cookie.name)
                 assert_contains("fb.4.", cookie.value)
-                assert_contains(".#{APPENDIX_IS_NEW}", cookie.value)
+                assert_contains(".#{APPENDIX_NET_NEW}", cookie.value)
             end
         end
         assert_equal(cookie_to_update, builder.get_cookies_to_set())
@@ -220,13 +223,13 @@ def test_process_request_with_param_config_update
         assert_equal(2, cookie_to_update.size())
         for cookie in cookie_to_update do
             if cookie.name == ParamBuilder::FBC_NAME
-                assert_contains(".test123_test1_test2.#{APPENDIX_IS_NEW}", cookie.value)
+                assert_contains(".test123_test1_test2.#{APPENDIX_NET_NEW}", cookie.value)
                 assert_contains("fb.1.", cookie.value)
                 assert_equal("example.com", cookie.domain)
             else
                 assert_equal(ParamBuilder::FBP_NAME, cookie.name)
                 assert_contains("fb.1.", cookie.value)
-                assert_contains(".#{APPENDIX_IS_NEW}", cookie.value)
+                assert_contains(".#{APPENDIX_NET_NEW}", cookie.value)
             end
         end
         assert_equal(cookie_to_update, builder.get_cookies_to_set())
@@ -246,13 +249,13 @@ def test_process_request_with_param_config_with_customized_config_only
         assert_equal(2, cookie_to_update.size())
         for cookie in cookie_to_update do
             if cookie.name == ParamBuilder::FBC_NAME
-                assert_contains(".test1_test2.#{APPENDIX_IS_NEW}", cookie.value)
+                assert_contains(".test1_test2.#{APPENDIX_NET_NEW}", cookie.value)
                 assert_contains("fb.1.", cookie.value)
                 assert_equal("example.com", cookie.domain)
             else
                 assert_equal(ParamBuilder::FBP_NAME, cookie.name)
                 assert_contains("fb.1.", cookie.value)
-                assert_contains(".#{APPENDIX_IS_NEW}", cookie.value)
+                assert_contains(".#{APPENDIX_NET_NEW}", cookie.value)
             end
         end
         assert_equal(cookie_to_update, builder.get_cookies_to_set())
@@ -274,15 +277,15 @@ def test_process_request_with_param_config_with_duplication
         for cookie in cookie_to_update do
             if cookie.name == ParamBuilder::FBC_NAME
                 assert_contains(
-                    ".test123_test1_test456.#{APPENDIX_IS_NEW}",
+                    ".test123_test1_test456.#{APPENDIX_NET_NEW}",
                     cookie.value
                 )
                 assert_contains("fb.1.", cookie.value)
                 assert_equal("example.com", cookie.domain)
             else
                 assert_equal(ParamBuilder::FBP_NAME, cookie.name)
                 assert_contains("fb.1.", cookie.value)
-                assert_contains(".#{APPENDIX_IS_NEW}", cookie.value)
+                assert_contains(".#{APPENDIX_NET_NEW}", cookie.value)
             end
         end
         assert_equal(cookie_to_update, builder.get_cookies_to_set())
@@ -305,13 +308,13 @@ def test_process_request_with_param_config_update_referer
         assert_equal(2, cookie_to_update.size())
         for cookie in cookie_to_update do
             if cookie.name == ParamBuilder::FBC_NAME
-                assert_contains(".wer_test1_placeholder.#{APPENDIX_IS_NEW}", cookie.value)
+                assert_contains(".wer_test1_placeholder.#{APPENDIX_NET_NEW}", cookie.value)
                 assert_contains("fb.1.", cookie.value)
                 assert_equal("example.com", cookie.domain)
             else
                 assert_equal(ParamBuilder::FBP_NAME, cookie.name)
                 assert_contains("fb.1.", cookie.value)
-                assert_contains(".#{APPENDIX_IS_NEW}", cookie.value)
+                assert_contains(".#{APPENDIX_NET_NEW}", cookie.value)
             end
         end
         assert_equal(cookie_to_update, builder.get_cookies_to_set())
@@ -327,7 +330,7 @@ def test_process_request_with_with_mutiple_domain_list
         for cookie in cookie_to_update do
             if cookie.name == ParamBuilder::FBC_NAME
                 assert_equal(
-                    "fb.1.2.test_fbc.#{APPENDIX_IS_NORMAL}",
+                    "fb.1.2.test_fbc.#{APPENDIX_NO_CHANGE}",
                     cookie.value
                 )
                 assert_equal(
@@ -336,7 +339,7 @@ def test_process_request_with_with_mutiple_domain_list
                 )
             else
                 assert_equal(ParamBuilder::FBP_NAME, cookie.name)
-                assert_contains(".#{APPENDIX_IS_NEW}", cookie.value)
+                assert_contains(".#{APPENDIX_NET_NEW}", cookie.value)
                 assert_equal("example.co.uk", cookie.domain)
             end
         end
@@ -380,21 +383,41 @@ def test_process_request_with_valie_cookies_with_language_update
             {"_fbp"=>"fb.1.123.345", "_fbc"=>"fb.1.2.test_fbc"},
             nil)
         assert_equal(2, cookie_to_update.size())
-        assert_equal("fb.1.2.test_fbc.#{APPENDIX_IS_NORMAL}", builder.get_fbc())
-        assert_equal("fb.1.123.345.#{APPENDIX_IS_NORMAL}", builder.get_fbp())
+        assert_equal("fb.1.2.test_fbc.#{APPENDIX_NO_CHANGE}", builder.get_fbc())
+        assert_equal("fb.1.123.345.#{APPENDIX_NO_CHANGE}", builder.get_fbp())
         for cookie in cookie_to_update do
             if cookie.name == ParamBuilder::FBC_NAME
-                assert_equal("fb.1.2.test_fbc.#{APPENDIX_IS_NORMAL}", cookie.value)
+                assert_equal("fb.1.2.test_fbc.#{APPENDIX_NO_CHANGE}", cookie.value)
                 assert_equal("localhost", cookie.domain)
             else
                 assert_equal(ParamBuilder::FBP_NAME, cookie.name)
-                assert_equal("fb.1.123.345.#{APPENDIX_IS_NORMAL}", cookie.value)
+                assert_equal("fb.1.123.345.#{APPENDIX_NO_CHANGE}", cookie.value)
                 assert_equal("localhost", cookie.domain)
             end
         end
         assert_equal(cookie_to_update, builder.get_cookies_to_set())
     end
 
+    def test_process_request_fbc_modified
+        # Test that modifying an existing fbc with a different payload uses MODIFIED_NEW appendix
+        builder = ParamBuilder.new()
+        cookie_to_update = builder.process_request(
+            "localhost",
+            {"fbclid"=>"new_click_id"},
+            {"_fbc"=>"fb.0.123.old_click_id.BQ", "_fbp"=>"fb.0.456.123456789.BQ"})
+        assert_equal(1, cookie_to_update.size())
+        fbc = builder.get_fbc()
+        assert fbc.end_with?(".new_click_id.#{APPENDIX_MODIFIED_NEW}")
+        assert_contains("fb.0.", fbc)
+        for cookie in cookie_to_update do
+            assert_equal(ParamBuilder::FBC_NAME, cookie.name)
+            assert cookie.value.end_with?(".new_click_id.#{APPENDIX_MODIFIED_NEW}")
+            assert_equal("localhost", cookie.domain)
+        end
+        assert_equal("fb.0.456.123456789.BQ", builder.get_fbp())
+        assert_equal(cookie_to_update, builder.get_cookies_to_set())
+    end
+
     def test_extract_host_from_http_host_with_protocol_and_port
         builder = ParamBuilder.new()
         host_name = builder.send(:extract_host_from_http_host, "https://example.com:3030")