Allow CAPTCHA actions to fail silently

[brianhall]

Asana Task/Github Issue: https://app.asana.com/0/1199230911884351/1209924515943923/f

Description

Allows captcha actions to fail silently without stopping the opt out flow for more flexbility

Testing Steps

See Asana

Checklist

Please tick all that apply:

• I have tested this change locally
• I have tested this change locally in all supported browsers
• This change will be visible to users
• I have added automated tests that cover this change
• I have ensured the change is gated by config
• This change was covered by a ship review
• This change was covered by a tech design
• Any dependent config has been merged

[netlify]

✅ Deploy Preview for content-scope-scripts ready!

Name	Link
🔨 Latest commit	91212eb
🔍 Latest deploy log	https://app.netlify.com/sites/content-scope-scripts/deploys/67f63b96b2db3500083cf1c6
😎 Deploy Preview	https://deploy-preview-1622--content-scope-scripts.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[github-actions]

Temporary Branch Update

The temporary branch has been updated with the latest changes. Below are the details:

• Branch Name: pr-releases/pr-1622
• Commit Hash: 6860780cf88a65a885979d1ad29b0fec020b0d13
• Last Updated: April 9, 2025 at 9:19:43 AM UTC
• Install Command: npm i github:duckduckgo/content-scope-scripts#6860780cf88a65a885979d1ad29b0fec020b0d13

Please use the above install command to update to the latest version.

[github-actions]

[Beta] Generated file diff

Time updated: Wed, 09 Apr 2025 09:19:54 GMT

Android

    - android/brokerProtection.js

File has changed

Integration

    - integration/contentScope.js

File has changed

Windows

    - windows/contentScope.js

File has changed

Apple

    - dist/contentScopeIsolated.js

File has changed

[madblex]

Added a few comments that I think should be addressed, but I am also mindful we're on a tight schedule, so I'll be approving this (pending testing) since nothing is strictly blocking.

[madblex]

nit: I'd say this makes more sense as part of the SuccessResponse class:

    /**
     * @param {Pick<SuccessResponseInterface, "actionID" | "actionType">} params
     * @return {SuccessResponse}
     */
    static createEmptySuccessResponse(params) {
        return SuccessResponse.create({ ...params, response: {} });
    }

and usage becomes:

  return SuccessResponse.createEmptySuccessResponse({ actionID, actionType })

[madblex]

failSilently suggests we are allowing something to fail silently when in reality we're just skipping the action in case of failure, can we consider something on the lines of: bypassOnFailure | bypassOnError | skipOnError?

[madblex]

I think failSilently is a property of any action and it should be moved a level up (as part of injected/src/features/broker-protection/execute.js)

export async function execute(action, inputData, root = document) {
    try {
        const executeAction = async () => {
            switch (action.actionType) {
                case 'navigate':
                    return navigate(action, data(action, inputData, 'userProfile'));
                case 'extract':
                    return await extract(action, data(action, inputData, 'userProfile'), root);
                case 'click':
                    return click(action, data(action, inputData, 'userProfile'), root);
                case 'expectation':
                    return expectation(action, root);
                case 'fillForm':
                    return fillForm(action, data(action, inputData, 'extractedProfile'), root);
                case 'getCaptchaInfo':
                    return getCaptchaInfo(action, root);
                case 'solveCaptcha':
                    return solveCaptcha(action, data(action, inputData, 'token'), root);
                default: {
                    return new ErrorResponse({
                        actionID: action.id,
                        message: `unimplemented actionType: ${action.actionType}`,
                    });
                }
            }
        };

        const actionResponse = await executeAction();
        if (action.failSilently) {
            return SuccessResponse.createEmptySuccessResponse({ actionID: action.id, actionType: action.actionType });
        }
        return actionResponse;
    } catch (e) {
        // ...
    }
}