lighthouse 8.5.1 → 8.6.0-dev.20211013

package/flow-report/.eslintrc.cjs

@@ -0,0 +1,49 @@
+/**
+ * @license Copyright 2021 The Lighthouse 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.
+ */
+
+module.exports = {
+  extends: '../.eslintrc.js',
+  env: {
+    node: true,
+    browser: true,
+  },
+  plugins: [
+    '@typescript-eslint',
+  ],
+  rules: {
+    // TODO(esmodules): move to root eslint when all code is ESM
+    // or when this is resolved: https://github.com/import-js/eslint-plugin-import/issues/2214
+    'import/order': [2, {
+      'groups': [
+        'builtin',
+        'external',
+        ['sibling', 'parent'],
+        'index',
+        'object',
+        'type',
+      ],
+      'newlines-between': 'always',
+    }],
+    '@typescript-eslint/type-annotation-spacing': 2,
+  },
+  overrides: [
+    // TS already handles this issue.
+    // https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/FAQ.md#i-get-errors-from-the-no-undef-rule-about-global-variables-not-being-defined-even-though-there-are-no-typescript-errors
+    {
+      files: ['**/*.ts', '**/*.tsx', '**/*.js'],
+      rules: {
+        'no-undef': 'off',
+      },
+    },
+  ],
+  parserOptions: {
+    ecmaVersion: 2019,
+    ecmaFeatures: {
+      jsx: true,
+    },
+    sourceType: 'module',
+  },
+};

package/flow-report/assets/styles.css

@@ -10,17 +10,28 @@
   --category-summary-font-size: 18px;
   --double-base-spacing: calc(var(--base-spacing) * 2);
   --gather-mode-icon-size: 16px;
+  --header-adjacent-title-font-size: 14px;
+  --header-adjacent-title-width: minmax(var(--min-text-width), 1fr);
+  --header-current-description-font-size: 12px;
+  --header-current-title-font-size: 20px;
+  --header-margin: minmax(0px, calc(var(--base-spacing) * 4));
   --half-base-spacing: calc(var(--base-spacing) / 2);
+  --min-text-width: 20ch;
+  --dialog-border-color: var(--color-gray-700);
   --separator-color: var(--color-gray-300);
   --sidebar-flow-step-navigation-font-size: 14px;
   --sidebar-selected-bg-color: #DDEEFF;
   --sidebar-summary-font-size: 14px;
   --sidebar-title-font-size: 16px;
+  --sidebar-max-width: 400px;
   --summary-flow-step-label-font-size: 16px;
   --summary-subtitle-font-size: 16px;
   --summary-title-font-size: 32px;
   --summary-tooltip-box-shadow-color: rgba(0, 0, 0, 0.25);
+  --topbar-button-font-size: 14px;
+  --topbar-button-size: 45px;
   --topbar-title-font-size: 14px;
+  --dialog-title-font-size: 20px;
 }
 
 .App {
@@ -41,23 +52,59 @@
   display: none;
 }
 
+@media print {
+  .App {
+    grid-template-rows: 0px auto !important;
+    grid-template-columns: 0px auto !important;
+  }
+
+  .Topbar {
+    display: none !important;
+  }
+
+  .Sidebar {
+    display: none !important;
+  }
+
+  .Content {
+    overflow-y: visible !important;
+  }
+
+  .SummaryFlow {
+    grid-template-columns: repeat(7, min-content) !important;
+  }
+}
+
 .Topbar {
+  position: relative;
+  padding-right: var(--base-spacing);
   grid-area: topbar;
   display: flex;
   align-items: center;
   border-bottom: 1px solid var(--separator-color);
 }
 
-.Topbar__menu {
-  padding: var(--base-spacing);
+.TopbarButton {
+  height: var(--topbar-button-size);
+  min-width: var(--topbar-button-size);
   cursor: pointer;
   display: flex;
+  align-items: center;
+  justify-content: center;
   -webkit-touch-callout: none;
   -webkit-user-select: none;
   -khtml-user-select: none;
   -moz-user-select: none;
   -ms-user-select: none;
   user-select: none;
+  cursor: pointer;
+  background: none;
+  color: inherit;
+  border: none;
+  font: inherit;
+  outline: inherit;
+  font-size: var(--topbar-button-font-size);
+  margin-right: var(--base-spacing);
 }
 
 .Topbar__logo {
@@ -68,6 +115,7 @@
 .Topbar__title {
   font-size: var(--topbar-title-font-size);
   font-weight: bold;
+  margin-right: var(--double-base-spacing);
 }
 
 .Content {
@@ -100,6 +148,10 @@
 .Sidebar {
   grid-area: sidebar;
   border-right: 1px solid var(--separator-color);
+  width: min-content;
+  max-width: var(--sidebar-max-width);
+  overflow-x: hidden;
+  overflow-y: auto;
 }
 .Sidebar a {
   color: var(--color-gray-800);
@@ -181,6 +233,8 @@
   grid-column: 2;
   margin: var(--half-base-spacing) 0px;
   justify-self: left;
+  overflow-x: hidden;
+  text-overflow: ellipsis;
 }
 .SidebarFlowStep__label--navigation {
   font-size: var(--sidebar-flow-step-navigation-font-size);
@@ -223,14 +277,14 @@
 
 .SummarySectionHeader__content {
   margin: var(--base-spacing) 0px;
+  text-transform: uppercase;
 }
 
 .SummaryFlow {
   width: 100%;
-  max-width: max-content;
   display: grid;
   grid-auto-rows: min-content;
-  grid-template-columns: min-content min-content 4fr 1fr 1fr 1fr 1fr;
+  grid-template-columns: min-content min-content minmax(var(--min-text-width), 4fr) 1fr 1fr 1fr 1fr;
   align-items: center;
   margin: var(--base-spacing) 0px;
 }
@@ -266,21 +320,24 @@
 .SummaryFlowStep .FlowSegment {
   grid-column: 2;
 }
+.SummaryFlowStep .FlowStepThumbnail {
+  margin: var(--base-spacing) var(--half-base-spacing);
+}
 
-.SummaryFlowStep__screenshot {
+.FlowStepThumbnail {
   align-self: center;
   justify-self: center;
-  margin: var(--base-spacing) var(--half-base-spacing);
   object-fit: cover;
   object-position: top left;
-}
-.SummaryFlowStep__screenshot[src] {
   border: 1px solid var(--color-gray);
 }
 
 .SummaryFlowStep__label {
   grid-column: 3;
   margin: var(--half-base-spacing);
+  width: 100%;
+  overflow-x: hidden;
+  text-overflow: ellipsis;
 }
 
 .SummaryFlowStep__mode {
@@ -291,6 +348,8 @@
   font-size: var(--summary-flow-step-label-font-size);
   color: var(--color-gray-800);
   text-decoration: underline;
+  width: 100%;
+  overflow-x: hidden;
 }
 
 .SummaryCategory__content {
@@ -314,7 +373,7 @@
   width: max-content;
   background-color: var(--report-background-color);
   border: 1px solid var(--color-gray-900);
-  border-radius: 5px;
+  border-radius: 3px;
   padding: var(--base-spacing);
   right: 0;
   box-shadow: 0px 4px 4px var(--summary-tooltip-box-shadow-color);
@@ -360,6 +419,7 @@
   justify-content: center;
   padding: var(--half-base-spacing);
   background-color: var(--color-gray-100);
+  color: var(--color-gray-700);
   border-top: 1px solid var(--color-gray-300);
   text-align: center;
 }
@@ -367,6 +427,11 @@
   justify-content: start;
   text-align: left;
 }
+.SummaryNavigationHeader__url > a {
+  color: inherit;
+  overflow-x: hidden;
+  text-overflow: ellipsis;
+}
 
 .SummaryFlowStep__separator {
   display: contents;
@@ -383,3 +448,201 @@
   margin: auto;
   background-color: var(--color-gray-700);
 }
+
+.Header {
+  display: grid;
+  grid-template-areas:
+    ".        .          .             current-tn    .             .          ."
+    "prev-seg prev-tn    prev-tn       current-tn    next-tn       next-tn    next-seg"
+    ".        prev-title .             current-tn    .             next-title ."
+    ".        prev-title current-title current-title current-title next-title .";
+  grid-template-rows: 1fr auto 1fr auto;
+  grid-template-columns: var(--header-margin) var(--header-adjacent-title-width) auto auto auto var(--header-adjacent-title-width) var(--header-margin);
+  align-items: center;
+  margin: var(--double-base-spacing) 0px;
+}
+.Header a {
+  color: var(--color-gray-800);
+}
+.Header > .Header__segment:first-child {
+  grid-area: prev-seg;
+}
+.Header > .Header__segment:last-child {
+  grid-area: next-seg;
+}
+
+.Header__prev-thumbnail {
+  display: flex;
+  align-items: center;
+  grid-area: prev-tn;
+}
+.Header__current-thumbnail {
+  display: flex;
+  align-items: center;
+  grid-area: current-tn;
+}
+.Header__next-thumbnail {
+  display: flex;
+  align-items: center;
+  grid-area: next-tn;
+}
+.Header__prev-thumbnail .Header__segment,
+.Header__next-thumbnail .Header__segment {
+  flex-grow: 1;
+}
+
+.Header__segment {
+  height: 2px;
+  background-color: var(--color-blue-A700);
+}
+
+.HeaderThumbnail {
+  position: relative;
+  display: flex;
+  margin: var(--base-spacing) 0px;
+}
+.HeaderThumbnail--main .FlowStepThumbnail {
+  border: 2px solid var(--color-blue-A700);
+}
+.HeaderThumbnail--prev .HeaderThumbnail__icon {
+  top: 50%;
+  left: 100%;
+}
+.HeaderThumbnail--next .HeaderThumbnail__icon {
+  top: 50%;
+  left: 0;
+}
+.HeaderThumbnail--main .HeaderThumbnail__icon {
+  top: 100%;
+  left: 50%;
+}
+
+.HeaderThumbnail__icon {
+  position: absolute;
+  display: flex;
+  padding: calc(var(--base-spacing) * 0.25);
+  background-color: var(--report-background-color);
+  border-radius: 50%;
+  transform: translate(-50%, -50%);
+  color: var(--color-blue-A700)
+}
+
+.Header__prev-title {
+  grid-area: prev-title;
+  text-align: left;
+}
+
+.Header__next-title {
+  grid-area: next-title;
+  text-align: right;
+  justify-self: end;
+}
+
+.Header__prev-title,
+.Header__next-title {
+  font-size: var(--header-adjacent-title-font-size);
+  align-self: start;
+  overflow-x: hidden;
+  text-overflow: ellipsis;
+  width: 100%;
+}
+
+.Header__current-title {
+  grid-area: current-title;
+  text-align: center;
+  font-size: var(--header-current-title-font-size);
+  font-weight: bold;
+  overflow-x: hidden;
+  text-overflow: ellipsis;
+}
+
+.Header__current-description {
+  text-align: center;
+  font-size: var(--header-current-description-font-size);
+  font-weight: normal;
+}
+
+.HelpDialog {
+  position: absolute;
+  top: 100%;
+  right: var(--base-spacing);
+  z-index: 100;
+  max-width: 720px;
+
+  background: var(--color-white);
+  color: var(--color-gray-800);
+  border-radius: 3px;
+  border: 1px solid var(--dialog-border-color);
+  box-shadow: 0px 4px 12px var(--summary-tooltip-box-shadow-color);
+
+  padding: var(--base-spacing) calc(var(--base-spacing) * 1.5);
+}
+
+.HelpDialog__title {
+  display: flex;
+  align-items: center;
+
+  font-size: var(--dialog-title-font-size);
+  font-weight: bold;
+
+  margin-bottom: calc(var(--base-spacing) * 2);
+}
+
+.HelpDialog__close {
+  background: none;
+  border: none;
+  cursor: pointer;
+  line-height: 0;
+}
+
+.HelpDialog__columns {
+  display: grid;
+  grid-auto-flow: column;
+  grid-template-rows: repeat(4, auto);
+  grid-template-columns: repeat(3, 1fr);
+  grid-column-gap: var(--base-spacing);
+}
+
+.HelpDialogColumn {
+  display: contents;
+}
+
+.HelpDialogColumn__header-title {
+  font-size: var(--category-summary-font-size);
+  font-weight: bold;
+}
+
+.HelpDialogColumn__legend-label {
+  color: var(--color-blue-A700);
+  font-weight: bold;
+}
+
+.HelpDialogColumn ul {
+  padding-left: var(--base-spacing);
+}
+
+.HelpDialogColumn__use-cases p,
+.HelpDialogColumn__categories p {
+  font-weight: bold;
+  color: var(--color-gray-700);
+}
+
+.HelpDialogColumnTimeline {
+  display: flex;
+  align-items: center;
+
+  height: var(--double-base-spacing);
+  color: var(--color-blue-A700);
+  margin-right: calc(var(--base-spacing) * -1);
+}
+
+.HelpDialogColumn:last-child .HelpDialogColumnTimeline {
+  margin-right: 0;
+}
+
+.HelpDialogColumnTimeline__line {
+  height: 2px;
+  flex-grow: 1;
+
+  background: var(--color-blue-A700);
+}

package/flow-report/jest.config.js

@@ -4,7 +4,7 @@
  * 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.
  */
 
-module.exports = {
+export default {
   testEnvironment: 'node',
   preset: 'ts-jest',
   globalSetup: './test/setup/global-setup.ts',

package/flow-report/package.json

@@ -0,0 +1,4 @@
+{
+  "type": "module",
+  "//": "Any directory that uses `import ... from` or `export ...` must be type module. Temporary file until root package.json is type: module"
+}

package/flow-report/src/app.tsx

@@ -5,23 +5,43 @@
  */
 
 import {FunctionComponent} from 'preact';
-import {useState} from 'preact/hooks';
+import {useEffect, useRef, useState} from 'preact/hooks';
 
 import {ReportRendererProvider} from './wrappers/report-renderer';
 import {Sidebar} from './sidebar/sidebar';
 import {Summary} from './summary/summary';
-import {classNames, FlowResultContext, useCurrentLhr} from './util';
+import {classNames, FlowResultContext, useCurrentLhr, useHashParam} from './util';
 import {Report} from './wrappers/report';
 import {Topbar} from './topbar';
+import {Header} from './header';
+import {I18nProvider} from './i18n/i18n';
 
 const Content: FunctionComponent = () => {
   const currentLhr = useCurrentLhr();
+  const anchor = useHashParam('anchor');
+  const ref = useRef<HTMLDivElement>(null);
+
+  useEffect(() => {
+    if (anchor) {
+      const el = document.getElementById(anchor);
+      if (el) {
+        el.scrollIntoView({behavior: 'smooth'});
+        return;
+      }
+    }
+
+    // Scroll to top no anchor is found.
+    if (ref.current) ref.current.scrollTop = 0;
+  }, [anchor, currentLhr]);
 
   return (
-    <div className="Content">
+    <div ref={ref} className="Content">
       {
         currentLhr ?
-          <Report/> :
+          <>
+            <Header currentLhr={currentLhr}/>
+            <Report currentLhr={currentLhr}/>
+          </> :
           <Summary/>
       }
     </div>
@@ -33,11 +53,13 @@ export const App: FunctionComponent<{flowResult: LH.FlowResult}> = ({flowResult}
   return (
     <FlowResultContext.Provider value={flowResult}>
       <ReportRendererProvider>
-        <div className={classNames('App', {'App--collapsed': collapsed})}>
-          <Topbar onMenuClick={() => setCollapsed(c => !c)} />
-          <Sidebar/>
-          <Content/>
-        </div>
+        <I18nProvider>
+          <div className={classNames('App', {'App--collapsed': collapsed})} data-testid="App">
+            <Topbar onMenuClick={() => setCollapsed(c => !c)} />
+            <Sidebar/>
+            <Content/>
+          </div>
+        </I18nProvider>
       </ReportRendererProvider>
     </FlowResultContext.Provider>
   );

package/flow-report/src/common.tsx

@@ -5,27 +5,106 @@
  */
 
 import {FunctionComponent} from 'preact';
+import {useEffect, useState} from 'preact/hooks';
 
 import {NavigationIcon, SnapshotIcon, TimespanIcon} from './icons';
+import {getFilmstripFrames, getScreenDimensions, getScreenshot} from './util';
+
+const ANIMATION_FRAME_DURATION_MS = 250;
 
 export const Separator: FunctionComponent = () => {
   return <div className="Separator" role="separator"></div>;
 };
 
+export const FlowStepIcon: FunctionComponent<{mode: LH.Result.GatherMode}> = ({mode}) => {
+  return <>
+    {
+      mode === 'navigation' && <NavigationIcon/>
+    }
+    {
+      mode === 'timespan' && <TimespanIcon/>
+    }
+    {
+      mode === 'snapshot' && <SnapshotIcon/>
+    }
+  </>;
+};
+
 export const FlowSegment: FunctionComponent<{mode?: LH.Result.GatherMode}> = ({mode}) => {
   return (
     <div className="FlowSegment">
       <div className="FlowSegment__top-line"/>
       {
-        mode === 'navigation' && <NavigationIcon/>
-      }
-      {
-        mode === 'timespan' && <TimespanIcon/>
-      }
-      {
-        mode === 'snapshot' && <SnapshotIcon/>
+        mode && <FlowStepIcon mode={mode}/>
       }
       <div className="FlowSegment__bottom-line"/>
     </div>
   );
 };
+
+const FlowStepAnimatedThumbnail: FunctionComponent<{
+  frames: Array<{data: string}>,
+  width: number,
+  height: number,
+}> = ({frames, width, height}) => {
+  const [frameIndex, setFrameIndex] = useState(0);
+  // Handle a frame array of a different length being set.
+  const effectiveFrameIndex = frameIndex % frames.length;
+
+  useEffect(() => {
+    const interval = setInterval(
+      () => setFrameIndex(i => (i + 1) % frames.length),
+      ANIMATION_FRAME_DURATION_MS
+    );
+
+    return () => clearInterval(interval);
+  }, [frames.length]);
+
+  return (
+    <img
+      className="FlowStepThumbnail"
+      data-testid="FlowStepAnimatedThumbnail"
+      src={frames[effectiveFrameIndex].data}
+      style={{width, height}}
+      alt="Animated screenshots of a page tested by Lighthouse"
+    />
+  );
+};
+
+export const FlowStepThumbnail: FunctionComponent<{
+  reportResult: LH.ReportResult,
+  width?: number,
+  height?: number,
+}> = ({reportResult, width, height}) => {
+  const screenshot = getScreenshot(reportResult);
+  const frames = getFilmstripFrames(reportResult);
+
+  // Resize the image to fit the viewport aspect ratio.
+  const dimensions = getScreenDimensions(reportResult);
+  if (width && height === undefined) {
+    height = dimensions.height * width / dimensions.width;
+  } else if (height && width === undefined) {
+    width = dimensions.width * height / dimensions.height;
+  }
+
+  if (!width || !height) {
+    console.warn(new Error('FlowStepThumbnail requested without any dimensions').stack);
+    return <></>;
+  }
+
+  if (reportResult.gatherMode === 'timespan' && frames && frames.length) {
+    return <FlowStepAnimatedThumbnail frames={frames} width={width} height={height} />;
+  }
+
+  return <>
+    {
+      screenshot &&
+        <img
+          className="FlowStepThumbnail"
+          src={screenshot}
+          style={{width, height}}
+          alt="Screenshot of a page tested by Lighthouse"
+        />
+    }
+  </>;
+};