@internetarchive/collection-browser 4.3.2-rc-webdev-8334.2 → 4.4.0

package/src/tiles/item-image.ts

@@ -1,187 +1,214 @@
-import { css, CSSResultGroup, html, LitElement, nothing } from 'lit';
-import { customElement, property, query, state } from 'lit/decorators.js';
-import { ClassInfo, classMap } from 'lit/directives/class-map.js';
-
-import type { TileModel } from '../models';
-
-import {
-  baseItemImageStyles,
-  waveformGradientStyles,
-} from '../styles/item-image-styles';
-import { searchIcon } from '../assets/img/icons/mediatype/search';
-
-@customElement('item-image')
-export class ItemImage extends LitElement {
-  @property({ type: Object }) model?: TileModel;
-
-  @property({ type: String }) baseImageUrl?: string;
-
-  @property({ type: Boolean }) isListTile = false;
-
-  @property({ type: Boolean }) isCompactTile = false;
-
-  @property({ type: Boolean }) loggedIn = false;
-
-  @property({ type: Boolean }) suppressBlurring = false;
-
-  @state() private isWaveform = false;
-
-  @state() private isNotFound = false;
-
-  @query('img') private baseImage!: HTMLImageElement;
-
-  render() {
-    return html`
-      <div class=${classMap(this.itemBaseClass)}>${this.imageTemplate}</div>
-    `;
-  }
-
-  private get imageTemplate() {
-    if (this.model?.mediatype === 'search') {
-      return html`${searchIcon}`;
-    }
-
-    return html`
-      <img
-        class=${classMap(this.itemImageClass)}
-        src="${this.imageSrc}"
-        alt=""
-        @load=${this.onLoad}
-        @error=${this.onError}
-      />
-    `;
-  }
-
-  /**
-   * Helpers
-   */
-  private get imageSrc() {
-    if (this.isNotFound) return this.notFoundSrc;
-
-    // Use the correct image for web capture tiles, if possible
-    if (this.model?.captureDates && this.model.identifier) {
-      try {
-        const url = new URL(this.model.identifier);
-        const domain = encodeURIComponent(url.hostname);
-        return this.baseImageUrl
-          ? `https://web.archive.org/thumb/${domain}?generate=1`
-          : nothing;
-      } catch {
-        return `${this.baseImageUrl}/images/notfound.png`;
-      }
-    }
-
-    // Use the thumbnail URL specified in the model if it exists
-    if (this.model?.thumbnailUrl) return this.model.thumbnailUrl;
-
-    // Don't try to load invalid image URLs
-    return this.baseImageUrl && this.model?.identifier
-      ? `${this.baseImageUrl}/services/img/${this.model.identifier}`
-      : nothing;
-  }
-
-  private get notFoundSrc() {
-    return this.baseImageUrl
-      ? `${this.baseImageUrl}/images/notfound.png`
-      : nothing;
-  }
-
-  private get hashBasedGradient() {
-    if (!this.model?.identifier) {
-      return 'waveform-grad0';
-    }
-    const gradient = this.hashStrToInt(this.model.identifier) % 6; // returns 0-5
-    return `waveform-grad${gradient}`;
-  }
-
-  private hashStrToInt(str: string): number {
-    return str
-      .split('')
-      .reduce((acc: number, char: string) => acc + char.charCodeAt(0), 0);
-  }
-
-  /**
-   * Classes
-   */
-  private get itemBaseClass(): ClassInfo {
-    return {
-      'drop-shadow': true,
-      'list-box': this.isListTile,
-      'search-image': this.model?.mediatype === 'search',
-      [this.hashBasedGradient]: this.isWaveform,
-    };
-  }
-
-  private get itemImageClass(): ClassInfo {
-    const hasSensitiveContent = !!(
-      this.model?.contentWarning || this.model?.loginRequired
-    );
-    const shouldBlur = hasSensitiveContent && !this.suppressBlurring;
-
-    return {
-      contain: !this.isCompactTile && !this.isWaveform,
-      cover: this.isCompactTile,
-      blur: shouldBlur,
-      waveform: this.isWaveform,
-      'account-image': this.isAccountImage, // for account tile image
-      'collection-image': this.model?.mediatype === 'collection', // for collection tile image
-    };
-  }
-
-  /**
-   * Helper function to determine if account tile image
-   */
-  private get isAccountImage() {
-    return (
-      this.model?.mediatype === 'account' &&
-      !this.isCompactTile &&
-      !this.isListTile
-    );
-  }
-
-  /**
-   * Event listener sets isWaveform true if image is waveform
-   */
-  private onLoad() {
-    if (
-      (this.model?.mediatype === 'audio' ||
-        this.model?.mediatype === 'etree') &&
-      this.baseImage.naturalWidth / this.baseImage.naturalHeight === 4
-    ) {
-      this.isWaveform = true;
-    }
-  }
-
-  private onError() {
-    this.isNotFound = true;
-  }
-
-  /**
-   * CSS
-   */
-  static get styles(): CSSResultGroup {
-    return [
-      baseItemImageStyles,
-      waveformGradientStyles,
-      css`
-        img {
-          height: var(--imgHeight, 16rem);
-          width: var(--imgWidth, 16rem);
-        }
-
-        .search-image {
-          display: flex;
-          align-items: center;
-          justify-content: center;
-          background: rgb(245, 245, 247);
-          border-radius: 4px;
-        }
-
-        svg {
-          height: 10rem;
-          width: 10rem;
-        }
-      `,
-    ];
-  }
-}
+import {
+  css,
+  CSSResultGroup,
+  html,
+  LitElement,
+  nothing,
+  PropertyValues,
+} from 'lit';
+import { customElement, property, query, state } from 'lit/decorators.js';
+import { ClassInfo, classMap } from 'lit/directives/class-map.js';
+
+import type { TileModel } from '../models';
+
+import {
+  baseItemImageStyles,
+  waveformGradientStyles,
+} from '../styles/item-image-styles';
+import { searchIcon } from '../assets/img/icons/mediatype/search';
+
+@customElement('item-image')
+export class ItemImage extends LitElement {
+  /**
+   * Map to cache which identifiers have waveform-style thumbnails, so that
+   * they can have their waveform styling applied immediately, rather than
+   * waiting for the image content to load before applying it (which can
+   * cause noticeable flicker when such tiles refresh).
+   */
+  private static readonly waveformByIdentifier = new Map<string, boolean>();
+
+  @property({ type: Object }) model?: TileModel;
+
+  @property({ type: String }) baseImageUrl?: string;
+
+  @property({ type: Boolean }) isListTile = false;
+
+  @property({ type: Boolean }) isCompactTile = false;
+
+  @property({ type: Boolean }) loggedIn = false;
+
+  @property({ type: Boolean }) suppressBlurring = false;
+
+  @state() private isWaveform = false;
+
+  @state() private isNotFound = false;
+
+  @query('img') private baseImage!: HTMLImageElement;
+
+  protected willUpdate(changed: PropertyValues): void {
+    if (changed.has('model')) {
+      // If this identifier is known to have a waveform image, then set isWaveform upfront
+      const identifier = this.model?.identifier;
+      this.isWaveform =
+        ItemImage.waveformByIdentifier.get(identifier as string) === true;
+    }
+  }
+
+  render() {
+    return html`
+      <div class=${classMap(this.itemBaseClass)}>${this.imageTemplate}</div>
+    `;
+  }
+
+  private get imageTemplate() {
+    if (this.model?.mediatype === 'search') {
+      return html`${searchIcon}`;
+    }
+
+    return html`
+      <img
+        class=${classMap(this.itemImageClass)}
+        src="${this.imageSrc}"
+        alt=""
+        @load=${this.onLoad}
+        @error=${this.onError}
+      />
+    `;
+  }
+
+  /**
+   * Helpers
+   */
+  private get imageSrc() {
+    if (this.isNotFound) return this.notFoundSrc;
+
+    // Use the correct image for web capture tiles, if possible
+    if (this.model?.captureDates && this.model.identifier) {
+      try {
+        const url = new URL(this.model.identifier);
+        const domain = encodeURIComponent(url.hostname);
+        return this.baseImageUrl
+          ? `https://web.archive.org/thumb/${domain}?generate=1`
+          : nothing;
+      } catch {
+        return `${this.baseImageUrl}/images/notfound.png`;
+      }
+    }
+
+    // Use the thumbnail URL specified in the model if it exists
+    if (this.model?.thumbnailUrl) return this.model.thumbnailUrl;
+
+    // Don't try to load invalid image URLs
+    return this.baseImageUrl && this.model?.identifier
+      ? `${this.baseImageUrl}/services/img/${this.model.identifier}`
+      : nothing;
+  }
+
+  private get notFoundSrc() {
+    return this.baseImageUrl
+      ? `${this.baseImageUrl}/images/notfound.png`
+      : nothing;
+  }
+
+  private get hashBasedGradient() {
+    if (!this.model?.identifier) {
+      return 'waveform-grad0';
+    }
+    const gradient = this.hashStrToInt(this.model.identifier) % 6; // returns 0-5
+    return `waveform-grad${gradient}`;
+  }
+
+  private hashStrToInt(str: string): number {
+    return str
+      .split('')
+      .reduce((acc: number, char: string) => acc + char.charCodeAt(0), 0);
+  }
+
+  /**
+   * Classes
+   */
+  private get itemBaseClass(): ClassInfo {
+    return {
+      'drop-shadow': true,
+      'list-box': this.isListTile,
+      'search-image': this.model?.mediatype === 'search',
+      [this.hashBasedGradient]: this.isWaveform,
+    };
+  }
+
+  private get itemImageClass(): ClassInfo {
+    const hasSensitiveContent = !!(
+      this.model?.contentWarning || this.model?.loginRequired
+    );
+    const shouldBlur = hasSensitiveContent && !this.suppressBlurring;
+
+    return {
+      contain: !this.isCompactTile && !this.isWaveform,
+      cover: this.isCompactTile,
+      blur: shouldBlur,
+      waveform: this.isWaveform,
+      'account-image': this.isAccountImage, // for account tile image
+      'collection-image': this.model?.mediatype === 'collection', // for collection tile image
+    };
+  }
+
+  /**
+   * Helper function to determine if account tile image
+   */
+  private get isAccountImage() {
+    return (
+      this.model?.mediatype === 'account' &&
+      !this.isCompactTile &&
+      !this.isListTile
+    );
+  }
+
+  /**
+   * Event listener sets isWaveform true if image is waveform
+   */
+  private onLoad() {
+    if (
+      (this.model?.mediatype === 'audio' ||
+        this.model?.mediatype === 'etree') &&
+      this.baseImage.naturalWidth / this.baseImage.naturalHeight === 4
+    ) {
+      this.isWaveform = true;
+      if (this.model?.identifier) {
+        ItemImage.waveformByIdentifier.set(this.model.identifier, true);
+      }
+    }
+  }
+
+  private onError() {
+    this.isNotFound = true;
+  }
+
+  /**
+   * CSS
+   */
+  static get styles(): CSSResultGroup {
+    return [
+      baseItemImageStyles,
+      waveformGradientStyles,
+      css`
+        img {
+          height: var(--imgHeight, 16rem);
+          width: var(--imgWidth, 16rem);
+        }
+
+        .search-image {
+          display: flex;
+          align-items: center;
+          justify-content: center;
+          background: rgb(245, 245, 247);
+          border-radius: 4px;
+        }
+
+        svg {
+          height: 10rem;
+          width: 10rem;
+        }
+      `,
+    ];
+  }
+}

package/src/tiles/tile-dispatcher.ts

@@ -176,12 +176,7 @@ export class TileDispatcher
     // Use the server-specified href if available.
     // Otherwise, construct a details page URL from the item identifier.
     if (this.model.href) {
-      // Defensive decode: %3A (encoded colon) in a URL is an unambiguous sign the
-      // target URL was incorrectly percent-encoded — decode it before use.
-      const href = /%3A/i.test(this.model.href)
-        ? decodeURIComponent(this.model.href)
-        : this.model.href;
-      return `${this.baseNavigationUrl}${href}`;
+      return `${this.baseNavigationUrl}${this.model.href}`;
     }
 
     return this.displayValueProvider.itemPageUrl(

package/src/tiles/tile-display-value-provider.ts

@@ -124,8 +124,9 @@ export class TileDisplayValueProvider {
       .toISOString()
       .replace(/[TZ:-]/g, '')
       .replace(/\..*/, '');
-    // url must not be percent-encoded — Wayback Machine matches on the raw URL
-    const captureHref = `https://web.archive.org/web/${captureDateStr}/${url}`;
+    const captureHref = `https://web.archive.org/web/${captureDateStr}/${encodeURIComponent(
+      url,
+    )}`;
     const captureText = formatDate(date, 'long');
 
     return html` <a href=${captureHref}> ${captureText} </a> `;

package/test/tiles/grid/item-tile.test.ts

@@ -453,7 +453,7 @@ describe('Item Tile', () => {
     const firstDateLink = captureDatesUl?.children[0]?.querySelector('a[href]');
     expect(firstDateLink, 'first date link').to.exist;
     expect(firstDateLink?.getAttribute('href')).to.equal(
-      'https://web.archive.org/web/20100102123456/https://example.com/',
+      'https://web.archive.org/web/20100102123456/https%3A%2F%2Fexample.com%2F',
     );
     expect(firstDateLink?.textContent?.trim()).to.equal('Jan 02, 2010');
 
@@ -461,7 +461,7 @@ describe('Item Tile', () => {
       captureDatesUl?.children[1]?.querySelector('a[href]');
     expect(secondDateLink, 'second date link').to.exist;
     expect(secondDateLink?.getAttribute('href')).to.equal(
-      'https://web.archive.org/web/20110203124321/https://example.com/',
+      'https://web.archive.org/web/20110203124321/https%3A%2F%2Fexample.com%2F',
     );
     expect(secondDateLink?.textContent?.trim()).to.equal('Feb 03, 2011');
   });

package/test/tiles/list/tile-list.test.ts

@@ -509,7 +509,7 @@ describe('List Tile', () => {
     const firstDateLink = captureDatesUl?.children[0]?.querySelector('a[href]');
     expect(firstDateLink, 'first date link').to.exist;
     expect(firstDateLink?.getAttribute('href')).to.equal(
-      'https://web.archive.org/web/20100102123456/https://example.com/',
+      'https://web.archive.org/web/20100102123456/https%3A%2F%2Fexample.com%2F',
     );
     expect(firstDateLink?.textContent?.trim()).to.equal('Jan 02, 2010');
 
@@ -517,7 +517,7 @@ describe('List Tile', () => {
       captureDatesUl?.children[1]?.querySelector('a[href]');
     expect(secondDateLink, 'second date link').to.exist;
     expect(secondDateLink?.getAttribute('href')).to.equal(
-      'https://web.archive.org/web/20110203124321/https://example.com/',
+      'https://web.archive.org/web/20110203124321/https%3A%2F%2Fexample.com%2F',
     );
     expect(secondDateLink?.textContent?.trim()).to.equal('Feb 03, 2011');
   });

package/test/tiles/tile-dispatcher.test.ts

@@ -110,42 +110,6 @@ describe('Tile Dispatcher', () => {
     window.open = oldWindowOpen;
   });
 
-  it('should use model href as-is when not percent-encoded', async () => {
-    const el = await fixture<TileDispatcher>(html`
-      <tile-dispatcher
-        .model=${{
-          identifier: 'foo',
-          href: 'https://web.archive.org/web/20180613065659/http://www.sankei.com/',
-        }}
-        .baseNavigationUrl=${''}
-      ></tile-dispatcher>
-    `);
-
-    const tileLink = el.shadowRoot?.querySelector('a[href]') as HTMLAnchorElement;
-    expect(tileLink).to.exist;
-    expect(tileLink.getAttribute('href')).to.equal(
-      'https://web.archive.org/web/20180613065659/http://www.sankei.com/',
-    );
-  });
-
-  it('should decode percent-encoded model href before use', async () => {
-    const el = await fixture<TileDispatcher>(html`
-      <tile-dispatcher
-        .model=${{
-          identifier: 'foo',
-          href: 'https://web.archive.org/web/20180613065659/http%3A%2F%2Fwww.sankei.com%2F',
-        }}
-        .baseNavigationUrl=${''}
-      ></tile-dispatcher>
-    `);
-
-    const tileLink = el.shadowRoot?.querySelector('a[href]') as HTMLAnchorElement;
-    expect(tileLink).to.exist;
-    expect(tileLink.getAttribute('href')).to.equal(
-      'https://web.archive.org/web/20180613065659/http://www.sankei.com/',
-    );
-  });
-
   it('should toggle model checked state when manage check clicked', async () => {
     const el = await fixture<TileDispatcher>(html`
       <tile-dispatcher

package/tsconfig.json

@@ -1,25 +1,25 @@
-{
-  "compilerOptions": {
-    "target": "esnext",
-    "module": "esnext",
-    "moduleResolution": "bundler",
-    "noEmitOnError": true,
-    "lib": [
-      "ESNext",
-      "dom",
-      "dom.iterable"
-    ],
-    "strict": true,
-    "esModuleInterop": false,
-    "allowSyntheticDefaultImports": true,
-    "experimentalDecorators": true,
-    "importHelpers": true,
-    "outDir": "dist",
-    "sourceMap": true,
-    "inlineSources": true,
-    "rootDir": "./",
-    "declaration": true,
-    "useDefineForClassFields": false,
-  },
-  "include": ["src", "test", "index.ts", "types"],
-}
+{
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "noEmitOnError": true,
+    "lib": [
+      "ESNext",
+      "dom",
+      "dom.iterable"
+    ],
+    "strict": true,
+    "esModuleInterop": false,
+    "allowSyntheticDefaultImports": true,
+    "experimentalDecorators": true,
+    "importHelpers": true,
+    "outDir": "dist",
+    "sourceMap": true,
+    "inlineSources": true,
+    "rootDir": "./",
+    "declaration": true,
+    "useDefineForClassFields": false,
+  },
+  "include": ["src", "test", "index.ts", "types"],
+}

package/web-dev-server.config.mjs

@@ -1,30 +1,30 @@
-// import { hmrPlugin, presets } from '@open-wc/dev-server-hmr';
-
-/** Use Hot Module replacement by adding --hmr to the start command */
-const hmr = process.argv.includes('--hmr');
-
-export default /** @type {import('@web/dev-server').DevServerConfig} */ ({
-  nodeResolve: true,
-  open: '/',
-  watch: !hmr,
-
-  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
-  // esbuildTarget: 'auto'
-
-  /** Set appIndex to enable SPA routing */
-  // appIndex: 'demo/index.html',
-
-  /** Confgure bare import resolve plugin */
-  // nodeResolve: {
-  //   exportConditions: ['browser', 'development']
-  // },
-
-  plugins: [
-    /** Use Hot Module Replacement by uncommenting. Requires @open-wc/dev-server-hmr plugin */
-    // hmr && hmrPlugin({ exclude: ['**/*/node_modules/**/*'], presets: [presets.litElement] }),
-  ],
-
-  http2: true,
-  sslCert: './local.archive.org.cert',
-  sslKey: './local.archive.org.key',
-});
+// import { hmrPlugin, presets } from '@open-wc/dev-server-hmr';
+
+/** Use Hot Module replacement by adding --hmr to the start command */
+const hmr = process.argv.includes('--hmr');
+
+export default /** @type {import('@web/dev-server').DevServerConfig} */ ({
+  nodeResolve: true,
+  open: '/',
+  watch: !hmr,
+
+  /** Compile JS for older browsers. Requires @web/dev-server-esbuild plugin */
+  // esbuildTarget: 'auto'
+
+  /** Set appIndex to enable SPA routing */
+  // appIndex: 'demo/index.html',
+
+  /** Confgure bare import resolve plugin */
+  // nodeResolve: {
+  //   exportConditions: ['browser', 'development']
+  // },
+
+  plugins: [
+    /** Use Hot Module Replacement by uncommenting. Requires @open-wc/dev-server-hmr plugin */
+    // hmr && hmrPlugin({ exclude: ['**/*/node_modules/**/*'], presets: [presets.litElement] }),
+  ],
+
+  http2: true,
+  sslCert: './local.archive.org.cert',
+  sslKey: './local.archive.org.key',
+});