Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix rendering erroneous Adaptive Card #4852

Merged
merged 2 commits into from
Sep 21, 2023
Merged

Fix rendering erroneous Adaptive Card #4852

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4d0c922
Fix rendering erroneous Adaptive Card
compulim Sep 7, 2023
6b30856
Update PR number
compulim Sep 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- Fixes [#4718](https://github.com/microsoft/BotFramework-WebChat/issues/4718). In high contrast mode, Adaptive Card buttons, when pushed, should highlighted properly, by [@compulim](https://github.com/compulim), in PR [#4746](https://github.com/microsoft/BotFramework-WebChat/pull/4746)
- Fixes [#4721](https://github.com/microsoft/BotFramework-WebChat/issues/4721) and [#4726](https://github.com/microsoft/BotFramework-WebChat/issues/4726). Adaptive Cards `TextBlock` heading elements should start at level 2, by [@compulim](https://github.com/compulim), in PR [#4747](https://github.com/microsoft/BotFramework-WebChat/issues/4747)
- Fixes [#3699](https://github.com/microsoft/BotFramework-WebChat/issues/3699). Correcting timestamp roundoff, by [@compulim](https://github.com/compulim), in PR [#4821](https://github.com/microsoft/BotFramework-WebChat/pull/4821)
- Fixes [#4849](https://github.com/microsoft/BotFramework-WebChat/issues/4849). Rendering an erroneous Adaptive Cards should bail out and not throw `MutationObserver` error, by [@compulim](https://github.com/compulim), in PR [#4852](https://github.com/microsoft/BotFramework-WebChat/issues/4852)

## [4.15.8] - 2023-06-06

Expand Down
47 changes: 47 additions & 0 deletions __tests__/html/adaptiveCards.renderError.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<!DOCTYPE html>
<html lang="en-US">
<head>
<link href="/assets/index.css" rel="stylesheet" type="text/css" />
<script crossorigin="anonymous" src="/test-harness.js"></script>
<script crossorigin="anonymous" src="/test-page-object.js"></script>
<script crossorigin="anonymous" src="/__dist__/webchat-es5.js"></script>
</head>
<body>
<main id="webchat"></main>
<script>
run(async function () {
const { directLine, store } = testHelpers.createDirectLineEmulator();

WebChat.renderWebChat(
{
directLine,
store
},
document.getElementById('webchat')
);

await pageConditions.uiConnected();
await directLine.emulateIncomingActivity({
attachments: [
{
contentType: 'application/vnd.microsoft.card.adaptive',
content: {
// We want to render a failing Adaptive Cards, adding "*" here to fail the renderer.
type: '*AdaptiveCard*',
$schema: 'http://adaptivecards.io/schemas/adaptive-card.json',
version: '1.5',
body: [
{
text: 'Hello, World!',
type: 'TextBlock'
}
]
}
}
],
type: 'message'
});
});
</script>
</body>
</html>
5 changes: 5 additions & 0 deletions __tests__/html/adaptiveCards.renderError.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
/** @jest-environment ./packages/test/harness/src/host/jest/WebDriverEnvironment.js */

describe('Adaptive Cards', () => {
test('should not error when render an erroneous card', () => runHTML('adaptiveCards.renderError.html'));
});
16 changes: 10 additions & 6 deletions packages/bundle/src/adaptiveCards/Attachment/AdaptiveCardRenderer.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,12 +222,14 @@ const AdaptiveCardRenderer: VFC<AdaptiveCardRendererProps> = ({
// Apply all mods regardless whether the element changed or not.
// This is because we have undoed mods when we call the `useXXXModEffect` hook.
useLayoutEffect(() => {
applyActionShouldBePushButtonMod(element, actionPerformedClassName);
applyActionSetShouldNotBeMenuBarMod(element);
applyActiveElementMod(element);
applyDisabledMod(element, disabled);
applyPersistValuesMod(element);
applyRoleMod(element);
if (element) {
applyActionShouldBePushButtonMod(element, actionPerformedClassName);
applyActionSetShouldNotBeMenuBarMod(element);
applyActiveElementMod(element);
applyDisabledMod(element, disabled);
applyPersistValuesMod(element);
applyRoleMod(element);
}
}, [
actionPerformedClassName,
applyActionShouldBePushButtonMod,
Expand All @@ -240,6 +242,8 @@ const AdaptiveCardRenderer: VFC<AdaptiveCardRendererProps> = ({
element
]);

errors?.length && console.warn('botframework-webchat: Failed to render Adaptive Cards.', errors);

return errors?.length ? (
node_env === 'development' && <ErrorBox error={errors[0]} type={localize('ADAPTIVE_CARD_ERROR_BOX_TITLE_RENDER')} />
) : (
Expand Down
Loading