template.tpl

___TERMS_OF_SERVICE___

By creating or modifying this file you agree to Google Tag Manager's Community
Template Gallery Developer Terms of Service available at
https://developers.google.com/tag-manager/gallery-tos (or such other URL as
Google may provide), as modified from time to time.


___INFO___

{
  "type": "MACRO",
  "id": "cvt_temp_public_id",
  "version": 1,
  "securityGroups": [],
  "displayName": "IP Anonymizer",
  "description": "Anonymize any IPv4 or IPv6 address by removing the last octet or hex.",
  "containerContexts": [
    "SERVER"
  ]
}


___TEMPLATE_PARAMETERS___

[
  {
    "type": "CHECKBOX",
    "name": "read_from_event_data",
    "checkboxText": "Read Client IP from Event Data",
    "simpleValueType": true,
    "help": "Reads the ip_override value from Event Data"
  },
  {
    "type": "GROUP",
    "name": "advanced_options",
    "displayName": "Advanced Options",
    "groupStyle": "ZIPPY_CLOSED",
    "subParams": [
      {
        "type": "SELECT",
        "name": "input_ip",
        "displayName": "Client IP Address",
        "macrosInSelect": true,
        "selectItems": [],
        "simpleValueType": true,
        "help": "Provide any IP Address to be anonymized"
      }
    ],
    "enablingConditions": [
      {
        "paramName": "read_from_event_data",
        "paramValue": true,
        "type": "NOT_EQUALS"
      }
    ]
  }
]


___SANDBOXED_JS_FOR_SERVER___

const queryPermission = require('queryPermission');
const getEventData = require('getEventData');

const keyPath = 'ip_override';
const input_ip = data.input_ip;

// Read from Event Data
if(queryPermission('read_event_data', keyPath)){
  const input_ip = data.input_ip ? data.input_ip : getEventData(keyPath);
  
  // Check for valid IPv4
  const ipv4_regex = "^(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]\\d|\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|1\\d\\d|[1-9]\\d|\\d)){3}$";

  if(input_ip.match(ipv4_regex) !== null){
     return input_ip.substring(0,input_ip.lastIndexOf('.')).concat('.0');
  }
  
  //Check for valid IPv6
  if(input_ip.match(":") !== null){
    const keep_bits = input_ip.split(':').slice(0,3);
    const zero_bits = ["0:0:0::"];
    
    return keep_bits.concat(zero_bits).join(':');
  }
  
  return false;
  
}


___SERVER_PERMISSIONS___

[
  {
    "instance": {
      "key": {
        "publicId": "read_event_data",
        "versionId": "1"
      },
      "param": [
        {
          "key": "keyPatterns",
          "value": {
            "type": 2,
            "listItem": [
              {
                "type": 1,
                "string": "ip_override"
              }
            ]
          }
        },
        {
          "key": "eventDataAccess",
          "value": {
            "type": 1,
            "string": "specific"
          }
        }
      ]
    },
    "clientAnnotations": {
      "isEditedByUser": true
    },
    "isRequired": true
  }
]


___TESTS___

scenarios:
- name: Valid IPv4
  code: |-
    const mockData = {
      input_ip: '192.168.0.1'
    };

    // Call runCode to run the template's code.
    let variableResult = runCode(mockData);

    // Verify that the variable returns a result.
    assertThat(variableResult).isEqualTo('192.168.0.0');
- name: Valid IPv6
  code: |-
    const mockData = {
      input_ip: 'ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff'
    };

    // Call runCode to run the template's code.
    let variableResult = runCode(mockData);

    // Verify that the variable returns a result.
    assertThat(variableResult).isEqualTo('ffff:ffff:ffff:0:0:0::');
- name: Invalid IPv4
  code: |-
    const mockData = {
      input_ip: '300.168.0.1'
    };

    // Call runCode to run the template's code.
    let variableResult = runCode(mockData);

    // Verify that the variable returns a result.
    assertThat(variableResult).isFalse();
- name: Invalid string
  code: |-
    const mockData = {
      input_ip: 'unicorn 192.168.0.1'
    };

    // Call runCode to run the template's code.
    let variableResult = runCode(mockData);

    // Verify that the variable returns a result.
    assertThat(variableResult).isFalse();


___NOTES___

Created on 28.8.2021, 22:55:41