[
https://issues.apache.org/jira/browse/BEAM-10545?focusedWorklogId=469325&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-469325
]
ASF GitHub Bot logged work on BEAM-10545:
-----------------------------------------
Author: ASF GitHub Bot
Created on: 11/Aug/20 17:18
Start Date: 11/Aug/20 17:18
Worklog Time Spent: 10m
Work Description: KevinGG commented on a change in pull request #12460:
URL: https://github.com/apache/beam/pull/12460#discussion_r468740290
##########
File path:
sdks/python/apache_beam/runners/interactive/extensions/apache-beam-jupyterlab-sidepanel/src/common/HtmlView.tsx
##########
@@ -0,0 +1,119 @@
+// 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 React from 'react';
+
+export interface IHtmlProvider {
+ readonly html: string;
+ readonly script: Array<string>;
+}
+
+interface IHtmlViewProps {
+ htmlProvider: IHtmlProvider;
+}
+
+interface IHtmlViewState {
+ innerHtml: string;
+ script: Array<string>;
+}
+
+/**
+ * A common HTML viewing component that renders given HTML and executes scripts
+ * from the given provider.
+ */
+export class HtmlView extends React.Component<IHtmlViewProps, IHtmlViewState> {
+ constructor(props: IHtmlViewProps) {
+ super(props);
+ this.state = {
+ innerHtml: props.htmlProvider.html,
+ script: []
+ };
+ }
+
+ componentDidMount(): void {
+ this._updateRenderTimerId = setInterval(() => this.updateRender(), 1000);
+ }
+
+ componentWillUnmount(): void {
+ clearInterval(this._updateRenderTimerId);
+ }
+
+ updateRender(): void {
+ const currentHtml = this.state.innerHtml;
+ const htmlToUpdate = this.props.htmlProvider.html;
+ const currentScript = this.state.script;
+ const scriptToUpdate = [...this.props.htmlProvider.script];
+ if (htmlToUpdate !== currentHtml) {
+ this.setState({
+ innerHtml: htmlToUpdate,
+ // As long as the html is updated, clear the script state.
+ script: []
+ });
+ }
+ /* Depending on whether this iteration updates the html, the scripts
+ * are executed differently.
+ * Html updated: all scripts are new, start execution from index 0;
+ * Html not updated: only newly added scripts need to be executed.
+ */
+ const currentScriptLength =
+ htmlToUpdate === currentHtml ? currentScript.length : 0;
+ if (scriptToUpdate.length > currentScriptLength) {
+ this.setState(
+ {
+ script: scriptToUpdate
+ },
+ // Executes scripts once the state is updated.
+ () => {
+ for (let i = currentScriptLength; i < scriptToUpdate.length; ++i) {
+ new Function(scriptToUpdate[i])();
+ }
+ }
+ );
+ }
+ }
+
+ render(): React.ReactNode {
+ return (
+ // This injects raw HTML fetched from kernel into JSX.
+ <div dangerouslySetInnerHTML={{ __html: this.state.innerHtml }} />
+ );
+ }
+
+ private _updateRenderTimerId: number;
+}
+
+/**
+ * Makes the browser support HTML import and import HTML from given hrefs if
+ * any is given.
+ *
+ * Native HTML import has been deprecated by modern browsers. To support
+ * importing reusable HTML templates, webcomponentsjs library is needed.
+ * The given hrefs will be imported once the library is loaded.
+ *
+ * Note everything is appended to head and if there are duplicated HTML
+ * imports, only the first one will take effect.
+ */
+export function importHtml(hrefs: Array<string>): void {
Review comment:
This is needed when initializing the `Widget` during activation of the
extension.
The `importHtml` only needs to be invoked once.
The HTML we are targeting is the one used by
[PAIR-facets](https://pair-code.github.io/facets/).
Once invoked, later in the view, those facets visualization sent back from
the kernel could be rendered correctly.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 469325)
Time Spent: 4h 20m (was: 4h 10m)
> Apache Beam JupyterLab SidePanel
> --------------------------------
>
> Key: BEAM-10545
> URL: https://issues.apache.org/jira/browse/BEAM-10545
> Project: Beam
> Issue Type: New Feature
> Components: runner-py-interactive
> Reporter: Ning Kang
> Assignee: Ning Kang
> Priority: P2
> Time Spent: 4h 20m
> Remaining Estimate: 0h
>
> Create a JupyterLab extension to provide information and controls
> interactively when running Apache Beam notebooks in JupyterLab.
> Design
> [doc|https://docs.google.com/document/d/1aKK8TzSrl8WiG0K4v9xZEfLMCinuGqRlMOyb7xOhgy4/edit?usp=sharing]
> A vote has been held, and the name of the extension is selected:
> apache-beam-jupyterlab-sidepanel
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
