✨ add ability to fix ambiguous tag names

Author: momocow

lib/headers.ts

@@ -247,19 +247,6 @@ export class HeadersImpl implements StrictHeadersProps {
     return instanceToPlain(this, { exposeUnsetFields: false });
   }
 
-  public update(
-    props: HeadersProps,
-    options: HeadersFactoryOptions = {},
-  ): Headers {
-    return (this.constructor as typeof HeadersImpl).fromJSON(
-      {
-        ...this.toJSON(),
-        ...props,
-      },
-      options,
-    );
-  }
-
   public render({
     prefix = '// ==UserScript==\n',
     suffix = '// ==/UserScript==\n',

lib/hook.ts

@@ -0,0 +1,26 @@
+import { AsyncHeadersReducer, HeadersReducer, HeadersWaterfall } from './types';
+
+export function wrapHook(
+  fn: HeadersReducer,
+): (data: HeadersWaterfall) => HeadersWaterfall;
+export function wrapHook(
+  fn: AsyncHeadersReducer,
+): (data: HeadersWaterfall) => Promise<HeadersWaterfall>;
+
+export function wrapHook(
+  fn: HeadersReducer | AsyncHeadersReducer,
+): (data: HeadersWaterfall) => HeadersWaterfall | Promise<HeadersWaterfall> {
+  return (data) => {
+    const originalHeaders = data.headers;
+    const headers = fn(data);
+
+    if (headers instanceof Promise) {
+      return headers.then((headers) => ({
+        ...data,
+        headers: headers ?? originalHeaders,
+      }));
+    }
+
+    return { ...data, headers: headers ?? originalHeaders };
+  };
+}

lib/hooks.ts

@@ -5,13 +5,13 @@ import { Compilation, Compiler, sources } from 'webpack';
 
 import { findPackage, FsReadFile, FsStat, readJSON, writeJSON } from './fs';
 import { Headers, HeadersImpl, HeadersProps } from './headers';
+import { wrapHook } from './hook';
 import {
-  applyWhitelist,
+  fixTagNames,
   resolveDownloadBaseUrl,
   resolveUpdateBaseUrl,
   setDefaultMatch,
-  wrapHook,
-} from './hooks';
+} from './reducers';
 import { processSSRI } from './ssri';
 import {
   FileInfo,
@@ -61,8 +61,7 @@ export class UserscriptPlugin {
   }
 
   protected applyHooks(): void {
-    const { downloadBaseUrl, updateBaseUrl, ssri, headers, whitelist, strict } =
-      this.options;
+    const { downloadBaseUrl, updateBaseUrl, ssri, headers } = this.options;
 
     if (typeof headers === 'function') {
       this.hooks.processHeaders.tapPromise(
@@ -94,12 +93,7 @@ export class UserscriptPlugin {
       wrapHook(setDefaultMatch),
     );
 
-    if (whitelist ?? strict) {
-      this.hooks.processHeaders.tap(
-        applyWhitelist.name,
-        wrapHook(applyWhitelist),
-      );
-    }
+    this.hooks.processHeaders.tap(fixTagNames.name, wrapHook(fixTagNames));
   }
 
   protected headersFactory(props: HeadersProps): Headers {

lib/plugin.ts

@@ -0,0 +1,75 @@
+import { URL } from 'url';
+
+import { StrictHeadersProps } from './headers';
+import { HeadersReducer } from './types';
+
+export const setDefaultMatch: HeadersReducer = ({ headers }) => {
+  if (headers.include === undefined && headers.match === undefined) {
+    return {
+      ...headers,
+      match: '*://*/*',
+    };
+  }
+  return headers;
+};
+
+export const resolveDownloadBaseUrl: HeadersReducer = ({
+  headers,
+  fileInfo,
+  options,
+}) => {
+  if (headers.downloadURL === undefined) {
+    return {
+      ...headers,
+      downloadURL: new URL(
+        fileInfo.userjsFile,
+        options.downloadBaseUrl,
+      ).toString(),
+    };
+  }
+  return headers;
+};
+
+export const resolveUpdateBaseUrl: HeadersReducer = ({
+  headers,
+  fileInfo,
+  options,
+}) => {
+  if (headers.updateURL === undefined) {
+    return {
+      ...headers,
+      updateURL: !options.metajs
+        ? headers.downloadURL
+        : new URL(fileInfo.metajsFile, options.updateBaseUrl).toString(),
+    };
+  }
+  return headers;
+};
+
+export const FIXABLE_TAG_NAMES = new Map<string, keyof StrictHeadersProps>([
+  ['updateUrl', 'updateURL'],
+  ['iconUrl', 'iconURL'],
+  ['icon64Url', 'icon64URL'],
+  ['installUrl', 'installURL'],
+  ['supportUrl', 'supportURL'],
+  ['downloadUrl', 'downloadURL'],
+  ['homepageUrl', 'homepageURL'],
+]);
+
+export const fixTagNames: HeadersReducer = ({ headers }) => {
+  for (const [source, target] of FIXABLE_TAG_NAMES) {
+    if (headers[source] !== undefined) {
+      if (headers[target] !== undefined) {
+        throw new Error(`ambiguous tags: ("${source}", "${target}")`);
+      }
+
+      headers = {
+        ...headers,
+        [source]: undefined,
+        [target]: headers[source],
+      };
+    }
+  }
+
+  return headers;
+};

lib/reducers.ts

@@ -9,9 +9,9 @@ import {
 import { Readable } from 'stream';
 import { URL } from 'url';
 
-import { Headers, HeadersProps } from './headers';
+import { HeadersProps } from './headers';
 import {
-  ProcessHeadersAsyncHook,
+  AsyncHeadersReducer,
   SSRIAlgorithm,
   SSRILock,
   SSRIMap,
@@ -24,13 +24,17 @@ export const SSRI_MAP: Map<string, Map<SSRIAlgorithm, string>> = new Map();
 const concurrency = parseInt(process.env.WPUS_SSRI_CONCURRENCY ?? '');
 const limit = pLimit(Number.isNaN(concurrency) ? 6 : concurrency);
 
-export const processSSRI: ProcessHeadersAsyncHook = async (data) => {
+export const processSSRI: AsyncHeadersReducer = async (data) => {
   const {
     headers,
     ssriLock,
     options: { ssri },
   } = data;
 
+  if (headers.resource == undefined && headers.require === undefined) {
+    return headers;
+  }
+
   const ssriOptions: SSRIOptions =
     ssri === true || ssri === undefined ? {} : ssri;
 
@@ -78,7 +82,10 @@ export const processSSRI: ProcessHeadersAsyncHook = async (data) => {
     data.ssriLock = toSSRILock(ssriMap);
   }
 
-  return updateHeaders(headers, ssriMap);
+  return {
+    ...headers,
+    ...patchHeaders(headers, ssriMap),
+  };
 };
 
 export function normalizeURL(url: string): string {
@@ -88,7 +95,7 @@ export function normalizeURL(url: string): string {
 }
 
 export function getTargetURLs(
-  headers: Headers,
+  headers: HeadersProps,
   options: Pick<SSRIOptions, 'include' | 'exclude'>,
 ): string[] {
   const urls: string[] = [];
@@ -202,13 +209,12 @@ export function updateURL(url: string, ssriMap: SSRIMap): string {
   return urlObj.toString();
 }
 
-export function updateHeaders(headers: Headers, ssriMap: SSRIMap): Headers {
+export function patchHeaders(
+  headers: HeadersProps,
+  ssriMap: SSRIMap,
+): HeadersProps {
   const headersProps: HeadersProps = {};
 
-  if (headers.resource == undefined && headers.require === undefined) {
-    return headers;
-  }
-
   if (headers.require !== undefined) {
     if (Array.isArray(headers.require)) {
       headersProps.require = headers.require.map((url) =>
@@ -228,5 +234,5 @@ export function updateHeaders(headers: Headers, ssriMap: SSRIMap): Headers {
     );
   }
 
-  return headers.update(headersProps);
+  return headersProps;
 }

lib/ssri.ts

@@ -2,7 +2,7 @@ import { IntegrityMap } from 'ssri';
 import { URL } from 'url';
 import { Chunk, Compilation } from 'webpack';
 
-import { Headers, HeadersProps } from './headers';
+import { HeadersProps } from './headers';
 
 export interface UserscriptOptions {
   root?: string;
@@ -18,7 +18,7 @@ export interface UserscriptOptions {
   ssri?: true | SSRIOptions;
 }
 
-export type HeadersProvider = ProcessHeadersHook | ProcessHeadersAsyncHook;
+export type HeadersProvider = HeadersReducer | AsyncHeadersReducer;
 export type HeadersFile = string;
 
 export type HeadersOption =
@@ -59,8 +59,8 @@ export interface HeadersWaterfall {
   ssriLock?: SSRILock;
 }
 
-export type ProcessHeadersHook = (data: HeadersWaterfall) => Headers;
+export type HeadersReducer = (data: HeadersWaterfall) => HeadersProps;
 
-export type ProcessHeadersAsyncHook = (
+export type AsyncHeadersReducer = (
   data: HeadersWaterfall,
-) => Promise<Headers>;
+) => Promise<HeadersProps>;