From 900c93f0cb048c5969d6735a15979478c56bb126 Mon Sep 17 00:00:00 2001
From: Brian Hall <brian@hack.design>
Date: Fri, 10 May 2024 07:16:49 -0500
Subject: [PATCH] Add the ability to generate a random zip code (#964)

* Add the ability to generate a random zip code

* Fix linting

* Fix typow

---------

Co-authored-by: Brian Hall <brianhall@Brians-Laptop.local>
---
 .../playwright/page-objects/broker-protection.js      |  1 +
 .../broker-protection/actions/fill-form.json          |  4 ++++
 .../test-pages/broker-protection/pages/form.html      |  4 ++++
 src/features/broker-protection/actions/fill-form.js   |  7 +++++++
 unit-test/broker-protection.js                        | 11 ++++++++++-
 5 files changed, 26 insertions(+), 1 deletion(-)

diff --git a/integration-test/playwright/page-objects/broker-protection.js b/integration-test/playwright/page-objects/broker-protection.js
index 9a0d04403..06c4b50d5 100644
--- a/integration-test/playwright/page-objects/broker-protection.js
+++ b/integration-test/playwright/page-objects/broker-protection.js
@@ -56,6 +56,7 @@ export class BrokerProtectionPage {
         await expect(this.page.getByLabel('Last Name:')).toHaveValue('Smith')
         await expect(this.page.getByLabel('Phone Number:')).toHaveValue(/^\d{10}$/)
         await expect(this.page.getByLabel('State:')).toHaveValue('IL')
+        await expect(this.page.getByLabel('Zip Code:')).toHaveValue(/^\d{5}$/)
     }
 
     /**
diff --git a/integration-test/test-pages/broker-protection/actions/fill-form.json b/integration-test/test-pages/broker-protection/actions/fill-form.json
index d918a0c94..3a66178f6 100644
--- a/integration-test/test-pages/broker-protection/actions/fill-form.json
+++ b/integration-test/test-pages/broker-protection/actions/fill-form.json
@@ -20,6 +20,10 @@
         {
           "type": "state",
           "selector": "#state"
+        },
+        {
+          "type": "$generated_zip_code$",
+          "selector": "#user_zip_code"
         }
       ]
     },
diff --git a/integration-test/test-pages/broker-protection/pages/form.html b/integration-test/test-pages/broker-protection/pages/form.html
index 126459c82..4f2d497af 100644
--- a/integration-test/test-pages/broker-protection/pages/form.html
+++ b/integration-test/test-pages/broker-protection/pages/form.html
@@ -39,6 +39,10 @@
             <option value="IL">Illinois</option>
         </select>
     </label>
+    <label>
+        Zip Code:
+        <input type="text" name="zip_code" id="user_zip_code">
+    </label>
     <button class="btn-sbmt">Submit</button>
 </form>
 <script>
diff --git a/src/features/broker-protection/actions/fill-form.js b/src/features/broker-protection/actions/fill-form.js
index 59561f3f3..00f9cebb1 100644
--- a/src/features/broker-protection/actions/fill-form.js
+++ b/src/features/broker-protection/actions/fill-form.js
@@ -50,6 +50,8 @@ export function fillMany (root, elements, data) {
             results.push(setImageUpload(inputElem))
         } else if (element.type === '$generated_phone_number$') {
             results.push(setValueForInput(inputElem, generatePhoneNumber()))
+        } else if (element.type === '$generated_zip_code$') {
+            results.push(setValueForInput(inputElem, generateZipCode()))
         } else {
             if (!Object.prototype.hasOwnProperty.call(data, element.type)) {
                 results.push({ result: false, error: `element found with selector '${element.selector}', but data didn't contain the key '${element.type}'` })
@@ -175,3 +177,8 @@ export function generatePhoneNumber () {
 
     return `${areaCode}${exchangeCode}${lineNumber}`
 }
+
+export function generateZipCode () {
+    const zipCode = generateRandomInt(10000, 99999).toString()
+    return zipCode
+}
diff --git a/unit-test/broker-protection.js b/unit-test/broker-protection.js
index dbd266a2e..5b5f2144e 100644
--- a/unit-test/broker-protection.js
+++ b/unit-test/broker-protection.js
@@ -13,7 +13,7 @@ import { replaceTemplatedUrl } from '../src/features/broker-protection/actions/b
 import { processTemplateStringWithUserData } from '../src/features/broker-protection/actions/build-url-transforms.js'
 import { names } from '../src/features/broker-protection/comparisons/constants.js'
 import { generateRandomInt } from '../src/features/broker-protection/utils.js'
-import { generatePhoneNumber } from '../src/features/broker-protection/actions/fill-form.js'
+import { generatePhoneNumber, generateZipCode } from '../src/features/broker-protection/actions/fill-form.js'
 import { CityStateExtractor } from '../src/features/broker-protection/extractors/address.js'
 
 describe('Actions', () => {
@@ -556,6 +556,15 @@ describe('Actions', () => {
                 expect(phoneNumber).toMatch(/^\d{10}$/)
             })
         })
+        describe('generateZipCode', () => {
+            it('generates a string of integers of an appropriate size', () => {
+                const zipCode = generateZipCode()
+
+                expect(typeof zipCode).toEqual('string')
+                expect(zipCode.length).toBe(5)
+                expect(zipCode).toMatch(/^\d{5}$/)
+            })
+        })
     })
 })