Extract AppendixProvider to a separate file

Summary:
Separate AppendixProvider to file.
Detach the appendix function from base ParamBuilder main function

Differential Revision:
D84870237

Privacy Context Container: L1276675

fbshipit-source-id: c247aeaa97c145b14efbe821094ec7f1407801c3

Author: hongj-src

nodejs/capi-param-builder/src/ParamBuilder.js

@@ -9,8 +9,8 @@ const FbcParamConfig = require('./model/FbcParamConfig');
 const CookieSettings = require('./model/CookieSettings');
 const Constants = require('./model/Constants');
 const net = require('net');
-const { version } = require('../package.json');
 const { getNormalizedAndHashedPII } = require('./piiUtil/PIIUtil');
+const { getAppendixInfo } = require('./utils/AppendixProvider');
 
 class ParamBuilder {
   constructor(input_params) {
@@ -40,22 +40,8 @@ class ParamBuilder {
     this.cookies_to_set = [];
     this.cookies_to_set_dict = {};
     // language token
-    this.appendix_new = this._getAppendixInfo(true, version);
-    this.appendix_normal = this._getAppendixInfo(false, version);
-  }
-
-  _getAppendixInfo(is_new, sdk_version) {
-    try {
-      const [major, minor, patch] = sdk_version.split('.').map(Number);
-      const is_new_byte = is_new === true ? 0x01 : 0x00;
-      const bytes = [Constants.DEFAULT_FORMAT, Constants.LANGUAGE_TOKEN_INDEX, is_new_byte, major.toString(16), minor.toString(16), patch.toString(16)];
-      const buf = Buffer.from(bytes);
-      const base64urlSafe = buf.toString('base64').replace(/\+/g, '-').replace(/\//g, '_').replace(/=+$/, '');
-      return base64urlSafe;
-    } catch (error) {
-      console.error("Exception when parsing appendix version number:" + error);
-      return Constants.LANGUAGE_TOKEN;
-    }
+    this.appendix_new = getAppendixInfo(true);
+    this.appendix_normal = getAppendixInfo(false);
   }
 
   _preprocessCookie(cookies, cookie_name) {

nodejs/capi-param-builder/src/utils/AppendixProvider.js

@@ -0,0 +1,39 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ * All rights reserved.
+ *
+ * This source code is licensed under the license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+const { version } = require('../../package.json');
+const { LANGUAGE_TOKEN , LANGUAGE_TOKEN_INDEX , DEFAULT_FORMAT } = require('../model/Constants');
+
+function getAppendixInfo(is_new) {
+    try {
+      // Validate version format: must be exactly 3 numeric parts separated by dots
+      if (!/^\d+(\.\d+){2}$/.test(version)) {
+        return LANGUAGE_TOKEN;
+      }
+
+      const [major, minor, patch] = version.split('.').map(Number);
+
+      // Validate byte range (0-255) - regex doesn't check this
+      if (major > 255 || minor > 255 || patch > 255) {
+        return LANGUAGE_TOKEN;
+      }
+
+      const is_new_byte = is_new === true ? 0x01 : 0x00;
+      const bytes = [DEFAULT_FORMAT, LANGUAGE_TOKEN_INDEX, is_new_byte, major, minor, patch];
+      const buf = Buffer.from(bytes);
+      const base64urlSafe = buf.toString('base64').replace(/\+/g, '-').replace(/\//g, '_').replace(/=+$/, '');
+      return base64urlSafe;
+    } catch (error) {
+      console.error("Exception when parsing appendix version number:" + error);
+      return LANGUAGE_TOKEN;
+    }
+  }
+
+  module.exports = {
+    getAppendixInfo
+};

nodejs/capi-param-builder/tests/AppendixProvider.test.js

@@ -0,0 +1,91 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ * All rights reserved.
+ *
+ * This source code is licensed under the license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+const { getAppendixInfo } = require('../src/utils/AppendixProvider');
+
+jest.mock('../package.json', () => ({version: '1.0.1'}));
+
+describe('AppendixProvider - getAppendixInfo', () => {
+  beforeEach(() => {
+    jest.spyOn(console, 'error').mockImplementation(() => {});
+  });
+
+  afterEach(() => {
+    console.error.mockRestore();
+    jest.resetModules();
+    jest.resetAllMocks();
+  });
+
+  test('test cases on valid input', () => {
+    expect(getAppendixInfo(true)).toBe('AQQBAQAB'); // 1.0.1
+    expect(getAppendixInfo(false)).toBe('AQQAAQAB'); // 1.0.1
+  });
+
+  test('test cases on invalid input', () => {
+    const resultFalse = getAppendixInfo(false);
+    expect(getAppendixInfo(1)).toBe(resultFalse);
+    expect(getAppendixInfo('true')).toBe(resultFalse);
+    expect(getAppendixInfo({})).toBe(resultFalse);
+    expect(getAppendixInfo([])).toBe(resultFalse);
+    expect(getAppendixInfo(0)).toBe(resultFalse);
+    expect(getAppendixInfo('')).toBe(resultFalse);
+    expect(getAppendixInfo(null)).toBe(resultFalse);
+    expect(getAppendixInfo(undefined)).toBe(resultFalse);
+  });
+
+  test('should handle version 1.15.24', () => {
+    jest.doMock('../package.json', () => ({version: '1.15.24'}));
+    const { getAppendixInfo } = require('../src/utils/AppendixProvider');
+    expect(getAppendixInfo(true)).toBe('AQQBAQ8Y');
+    expect(getAppendixInfo(false)).toBe('AQQAAQ8Y');
+  });
+
+  test('should return LANGUAGE_TOKEN when version is invalid format', () => {
+    mockPackageVersion('invalid-version');
+    const { getAppendixInfo } = require('../src/utils/AppendixProvider');
+    const result = getAppendixInfo(true);
+    expect(result).toBe('BA');
+  });
+
+  test('should return LANGUAGE_TOKEN when version is missing', () => {
+    mockPackageVersion({});
+    const { getAppendixInfo } = require('../src/utils/AppendixProvider');
+    const result = getAppendixInfo(true);
+    expect(result).toBe('BA');
+  });
+
+  test('should return LANGUAGE_TOKEN when version has only 2 parts', () => {
+    mockPackageVersion('1.0');
+    const { getAppendixInfo } = require('../src/utils/AppendixProvider');
+    const result = getAppendixInfo(true);
+    expect(result).toBe('BA');
+  });
+
+  test('should return LANGUAGE_TOKEN when version has too many parts', () => {
+    mockPackageVersion('1.0.0.1');
+    const { getAppendixInfo } = require('../src/utils/AppendixProvider');
+    const result = getAppendixInfo(true);
+    expect(result).toBe('BA');
+  });
+
+  test('should return LANGUAGE_TOKEN when version contains non-numeric values', () => {
+    mockPackageVersion('a.b.c');
+    const { getAppendixInfo } = require('../src/utils/AppendixProvider');
+    const result = getAppendixInfo(true);
+    expect(result).toBe('BA');
+  });
+
+  function mockPackageVersion(version) {
+    jest.resetModules();
+    jest.doMock('../package.json', () => ({version: version}));
+    jest.doMock('../src/model/Constants', () => ({
+      LANGUAGE_TOKEN: 'BA',
+      LANGUAGE_TOKEN_INDEX: 0x04,
+      DEFAULT_FORMAT: 0x01,
+    }));
+  }
+});

nodejs/capi-param-builder/tests/ParamBuilder.test.js

@@ -426,13 +426,4 @@ describe('ParamBuilder base unit test', () => {
     expect(builder.getFbc()).toEqual("fb.2." + DUMMY_TIMESTAMP + ".test123_test_balabala." + DUMMY_APPENDIX_NEW);
     expect(builder.getFbp()).toEqual("fb.2."+ DUMMY_TIMESTAMP + "." + DUMMY_FBP_PAYLOAD + "." + DUMMY_APPENDIX_NEW);
   });
-
-   test('testProcessRequestWithInvalidVersionNumber', () => {
-    const builder = new ParamBuilder();
-    const appendix_new = builder._getAppendixInfo(true); // null version
-    const appendix_normal = builder._getAppendixInfo(false, ""); // empty version
-    // Fallback
-    expect(appendix_new).toEqual(Constants.LANGUAGE_TOKEN);
-    expect(appendix_normal).toEqual(Constants.LANGUAGE_TOKEN);
-  });
 });