#6065: fix rendering of user-defined bricks in the sidebar

[twschiller]

What does this PR do?

• Closes Error rendering brick in panel: This code can only run in the "contentScript" context #6065
• Closes Composite Renderer bricks should run non-renderer steps in content script #1939
• Fixes the run method of ExternalBrick (now called UserDefinedBrick) to run the pipeline in the contentScript

Reviewer Tips

• Review changes in brickFactory.ts
• Modifies runEffectPipeline to runHeadlessPipeline and has it return it's value

Discussion

• The root cause of the bug was an interaction between Composite Renderer bricks should run non-renderer steps in content script #1939 and #6051: make current mod state available as @mod to bricks #6052
• Instead of catching the HeadlessModeError, could call inferType and then conditionally call runEffectPipeline or runRendererPipeline based on the result. But would still need the logic to actually run the renderer brick after runRendererPipeline. So as-is, the implementation is the PR is a bit simpler

Demos

Added directly to sidebar:

Embedded in Document Builder:

Referencing a @mod variable inside of the user-defined brick:

Future Work

• Update to call the contentScript directly once Target current tab from any iframe webext-messenger#72 is implemented

Post-Merge Actions

• Update the Rainforest test to double-check the user-defined social links brick in the AI Copilot mod are rendered properly

Checklist

• Add tests: updated, but see above on Rainforest
• Designate a primary reviewer: @grahamlangford

[codecov]

Codecov Report

Merging #6067 (0e3cff4) into main (49e52e0) will decrease coverage by 0.02%.
The diff coverage is 54.54%.

@@            Coverage Diff             @@
##             main    #6067      +/-   ##
==========================================
- Coverage   67.99%   67.98%   -0.02%     
==========================================
  Files        1105     1105              
  Lines       34556    34580      +24     
  Branches     6520     6523       +3     
==========================================
+ Hits        23497    23509      +12     
- Misses      11059    11071      +12     

Impacted Files	Coverage Δ
src/blocks/errors.ts	75.00% <ø> (ø)
src/contentScript/messenger/registration.ts	0.00% <ø> (ø)
src/contentScript/pipelineProtocol.ts	0.00% <0.00%> (ø)
src/sidebar/PanelBody.tsx	82.89% <ø> (ø)
src/types/runtimeTypes.ts	20.00% <0.00%> (-80.00%)	⬇️
src/blocks/transformers/brickFactory.ts	75.72% <60.00%> (-4.51%)	⬇️
...omponents/documentBuilder/render/ButtonElement.tsx	87.09% <100.00%> (ø)
src/contentScript/messenger/api.ts	100.00% <100.00%> (ø)
src/runtime/reducePipeline.ts	85.65% <100.00%> (+0.06%)	⬆️
src/testUtils/detectPageMock.ts	57.89% <100.00%> (+4.95%)	⬆️

[grahamlangford]

This issue should be safe to close once this PR is merged, right?

[twschiller]

Yes, we can close #1939 once we merge in this PR

[github-actions]

No loom links were found in the first post. Please add one there if you'd like to it to appear on Slack.

Do not edit this comment manually.