#7104: affordance to pass data from host page to AA Co-Pilot forms

[twschiller]

What does this PR do?

• Closes Support passing data to AA Copilot via postMessage #7104
• Adds window message handlers to the sidebar and frame to listen for AA Co-Pilot data requests
• Adds "Map Automation Anywhere Co-Pilot Data" brick to set the host data to pass to the AA Co-Pilot
• Adds an affordance for setting the name attribute on the IFrame brick

Remaining Work

• Figure out how to message the extension frames with the data: @fregante do we have an affordance to messaging the extension frames on a page?
• Figure out how to handle scenario where the host data is set before the frame is shown. I think when the sidebar/frame is added to the page, it needs to ask the top-level frame on the page if there's any host data set. @fregante what's the correct/best way for an extension frame on a page to message the top-level content script?

Reviewer Tips

• frameProtocol.ts contains the message handler for the window message from the AA Co-Pilot frame

Discussion

• With the IFrame brick, the frame might be embedded either directly into the sidebar, or with a layer of indirection with our frame.html to workaround the CSP
• The reason why we're pre-setting the data is that there appears to be a 30-40ms time frame in which the host page must respond to the data request message. So the information needs to be available in the parent frame to respond immediately

Demo

• https://www.loom.com/share/4042ed1300294755acf9e2715f1cb8ca?sid=cde45916-9e3d-4dce-82cd-32907d57ab9c

Team Coordination

• Coordinate with AA product team on documentation: @mthek10 @twschiller
• Upload new brick headers and create marketplace entry: @twschiller

Checklist

• Add tests: I will add a test mod and regression test entry. The code is 90% message passing, so E2E is the only effective way to test
• New files added to src/tsconfig.strictNullChecks.json (if possible)
• Designate a primary reviewer: @grahamlangford

[codecov]

Codecov Report

Attention: 55 lines in your changes are missing coverage. Please review.

Comparison is base (21b82ba) 71.21% compared to head (449c008) 71.12%.

Files	Patch %	Lines
src/contrib/automationanywhere/aaFrameProtocol.ts	0.00%	27 Missing ⚠️
...contrib/automationanywhere/SetCopilotDataEffect.ts	45.00%	11 Missing ⚠️
src/background/partnerHandlers.ts	0.00%	6 Missing ⚠️
src/tinyPages/frame.ts	0.00%	5 Missing ⚠️
src/bricks/renderers/iframe.ts	0.00%	4 Missing ⚠️
src/development/headers.ts	0.00%	1 Missing ⚠️
src/sidebar/sidebar.tsx	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #7109      +/-   ##
==========================================
- Coverage   71.21%   71.12%   -0.09%     
==========================================
  Files        1210     1213       +3     
  Lines       37469    37533      +64     
  Branches     7061     7068       +7     
==========================================
+ Hits        26682    26696      +14     
- Misses      10787    10837      +50     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[fregante]

• do we have an affordance to messaging the extension frames on a page?

Yes, via page target:

pixiebrix-extension/src/sidebar/messenger/api.ts

Lines 21 to 23 in 21b82ba

	const target = { tabId: "this", page: "/sidebar.html" } as const;
	const sidebarInThisTab = {
	renderPanels: getMethod("SIDEBAR_RENDER_PANELS", target),

• what's the correct way for an extension frame on a page to message the top-level content script?

I think it's {tabId: "this", frameId: 0}

No, getTopLevelFrame():

pixiebrix-extension/src/sidebar/ConnectedSidebar.tsx

Lines 101 to 104 in 623b16a

	const topFrame = await getTopLevelFrame();
	// Ensure persistent sidebar extension points have been installed to have reserve their panels for the sidebar
	await ensureExtensionPointsInstalled(topFrame);

"this" only works towards chrome-extension:// pages for now:

• Target current tab from any iframe webext-messenger#72

[github-actions]

When the PR is merged, the first loom link found on this PR will be posted to #sprint-demo on Slack. Do not edit this comment manually.