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.

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

Bento: Prepare Twitter Preact implementation #34194

Merged
merged 9 commits into from
May 6, 2021
Merged
10 changes: 7 additions & 3 deletions extensions/amp-twitter/1.0/component.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,11 @@ const MATCHES_MESSAGING_ORIGIN = () => true;
* @param {{current: (!TwitterDef.Api|null)}} ref
* @return {PreactDef.Renderable}
*/
function TwitterWithRef({requestResize, title, ...rest}, ref) {
const [height, setHeight] = useState(FULL_HEIGHT);
function TwitterWithRef(
{momentid, options, requestResize, style, title, tweetid, ...rest},
ref
) {
const [height, setHeight] = useState(null);
const messageHandler = useCallback(
(event) => {
const data = deserializeMessage(event.data);
Expand All @@ -60,8 +63,9 @@ function TwitterWithRef({requestResize, title, ...rest}, ref) {
// non-overridable props
matchesMessagingOrigin={MATCHES_MESSAGING_ORIGIN}
messageHandler={messageHandler}
options={{tweetid, momentid, ...options}}
type={TYPE}
wrapperStyle={{height}}
style={height ? {...style, height} : style}
/>
);
}
Expand Down
54 changes: 52 additions & 2 deletions extensions/amp-twitter/1.0/storybook/Basic.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

import * as Preact from '../../../../src/preact';
import {Twitter} from '../component';
import {withKnobs} from '@storybook/addon-knobs';
import {boolean, number, select, withKnobs} from '@storybook/addon-knobs';

export default {
title: 'Twitter',
Expand All @@ -25,7 +25,57 @@ export default {
};

export const _default = () => {
const tweetId = select(
'tweet id',
['1356304203044499462', '495719809695621121', '463440424141459456'],
'1356304203044499462'
);
const cards = boolean('show cards', true) ? undefined : 'hidden';
const conversation = boolean('show conversation', false) ? undefined : 'none';
return (
<Twitter
bootstrap="https://3p.ampproject.net/2104170104001/f.js"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to understand more about passing bootstrap and src. It seems like it's very specific to AMP's concept of 3p frames. How would this be used in a Preact context?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question! Ideally these will have default values so that they don't have to be provided and the component will "just work" -- however, that requires more file reorganization and isolation from AMP than the default behavior currently has. Until then, and when at that future point we do have defaults that are (potentially) tied to an AMP RTV, this is an example of how a publisher could provide alternative bootstrap or src values to opt out of using logic served by AMP.

I agree this isn't a great example of what publishers would use instead here, as it might look like recreating some of what we have in 3p/twitter.js and hosting it somewhere else (like on the publisher's own domain).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In a preact context, would a 3p iframe be used at all?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not clear, so it would be helpful to have a working component to get feedback from. :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Message received. Approval incoming

options={{cards, conversation}}
tweetid={tweetId}
src="https://d-41929527682976137678.ampproject.net/2104170104001/frame.html"
style={{width: '300px', height: '200px'}}
/>
);
};

export const moments = () => {
const limit = number('limit to', 2);
return (
<Twitter
bootstrap="https://3p.ampproject.net/2104170104001/f.js"
options={{limit}}
momentid="1009149991452135424"
src="https://d-41929527682976137678.ampproject.net/2104170104001/frame.html"
style={{width: '300px', height: '200px'}}
/>
);
};

export const timelines = () => {
const tweetLimit = number('limit to', 5);
const timelineSourceType = select(
'source type',
['profile', 'likes', 'list', 'source', 'collection', 'url', 'widget'],
'profile'
);
const timelineScreenName = 'amphtml';
const timelineUserId = '3450662892';
return (
<Twitter style={{width: 300, height: 200}} tweetId="638793490521001985" />
<Twitter
bootstrap="https://3p.ampproject.net/2104170104001/f.js"
options={{
tweetLimit,
timelineSourceType,
timelineScreenName,
timelineUserId,
}}
src="https://d-41929527682976137678.ampproject.net/2104170104001/frame.html"
style={{width: '300px', height: '200px'}}
/>
);
};
157 changes: 157 additions & 0 deletions extensions/amp-twitter/1.0/test/test-component.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,157 @@
/**
* Copyright 2020 The AMP HTML Authors. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS-IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

import * as Preact from '../../../../src/preact';
import {Twitter} from '../component';
import {WithAmpContext} from '../../../../src/preact/context';
import {createRef} from '../../../../src/preact';
import {mount} from 'enzyme';
import {serializeMessage} from '../../../../src/3p-frame-messaging';
import {waitFor} from '../../../../testing/test-helper';

describes.sandboxed('Twitter preact component v1.0', {}, (env) => {
it('should render', () => {
const wrapper = mount(
<Twitter
tweetid="1356304203044499462"
style={{
'width': '500px',
'height': '600px',
}}
/>
);

const iframe = wrapper.find('iframe');

expect(iframe.prop('src')).to.equal(
'http://ads.localhost:9876/dist.3p/current/frame.max.html'
);
expect(wrapper.find('iframe').prop('style').width).to.equal('100%');
expect(wrapper.find('iframe').prop('style').height).to.equal('100%');
});

it('should call given requestResize', () => {
const requestResizeSpy = env.sandbox.spy();
const wrapper = mount(
<Twitter
tweetid="1356304203044499462"
style={{
'width': '500px',
'height': '600px',
}}
requestResize={requestResizeSpy}
/>
);

const iframe = wrapper.find('iframe').getDOMNode();
const sentinel = JSON.parse(iframe.getAttribute('name'))['attributes'][
'sentinel'
];

const mockEvent = new CustomEvent('message');
mockEvent.data = serializeMessage('embed-size', sentinel, {
'height': 1000,
});
mockEvent.source = wrapper
.getDOMNode()
.querySelector('iframe').contentWindow;
window.dispatchEvent(mockEvent);

expect(requestResizeSpy).to.have.been.calledOnce;
});

it('should change height', async () => {
const wrapper = mount(
<Twitter
tweetid="1356304203044499462"
style={{
'width': '500px',
'height': '600px',
}}
/>
);

const iframe = wrapper.find('iframe').getDOMNode();
const sentinel = JSON.parse(iframe.getAttribute('name'))['attributes'][
'sentinel'
];

const mockEvent = new CustomEvent('message');
mockEvent.data = serializeMessage('embed-size', sentinel, {
'height': 1000,
});
mockEvent.source = wrapper
.getDOMNode()
.querySelector('iframe').contentWindow;
window.dispatchEvent(mockEvent);

wrapper.update();

await waitFor(
() => wrapper.find('div').at(0).prop('style').height == 1000,
'Height changes'
);

expect(wrapper.find('div').at(0).prop('style').height).to.equal(1000);
});

it('should dispatch load event', async () => {
const ref = createRef();
const onReadyState = env.sandbox.spy();
const wrapper = mount(
<Twitter
ref={ref}
tweetid="1356304203044499462"
style={{
'width': '500px',
'height': '600px',
}}
onReadyState={onReadyState}
/>
);

let api = ref.current;
expect(api.readyState).to.equal('loading');
expect(onReadyState).to.not.be.called;

await wrapper.find('iframe').invoke('onLoad')();
api = ref.current;
expect(api.readyState).to.equal('complete');
expect(onReadyState).to.be.calledOnce.calledWith('complete');
});

it('should reset iframe on pause', () => {
const ref = createRef();
const wrapper = mount(
<WithAmpContext playable={true}>
<Twitter
ref={ref}
tweetid="1356304203044499462"
style={{
'width': '500px',
'height': '600px',
}}
/>
</WithAmpContext>
);
expect(wrapper.find('iframe')).to.have.lengthOf(1);

const iframe = wrapper.find('iframe').getDOMNode();
const spy = env.sandbox.spy(iframe, 'src', ['set']);
wrapper.setProps({playable: false});
expect(spy.set).to.be.calledOnce;
});
});
14 changes: 12 additions & 2 deletions src/preact/component/3p-frame.js
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ const DEFAULT_SANDBOX =
function ProxyIframeEmbedWithRef(
{
allow = BLOCK_SYNC_XHR,
bootstrap,
contextOptions,
excludeSandbox,
name: nameProp,
Expand Down Expand Up @@ -122,7 +123,7 @@ function ProxyIframeEmbedWithRef(
name: JSON.stringify(
dict({
'host': parseUrlDeprecated(src).hostname,
'bootstrap': getBootstrapUrl(type, win),
'bootstrap': bootstrap ?? getBootstrapUrl(type, win),
'type': type,
// "name" must be unique across iframes, so we add a count.
// See: https://github.com/ampproject/amphtml/pull/2955
Expand All @@ -132,7 +133,16 @@ function ProxyIframeEmbedWithRef(
),
src,
});
}, [contextOptions, count, nameProp, options, srcProp, title, type]);
}, [
bootstrap,
contextOptions,
count,
nameProp,
options,
srcProp,
title,
type,
]);

return (
<IframeEmbed
Expand Down