@parcel/utils 2.0.0-nightly.137 → 2.0.0-nightly.1370

package/src/config.js

@@ -2,87 +2,89 @@
 
 import type {ConfigResult, File, FilePath} from '@parcel/types';
 import type {FileSystem} from '@parcel/fs';
+import ThrowableDiagnostic from '@parcel/diagnostic';
 import path from 'path';
 import clone from 'clone';
+import json5 from 'json5';
+import {parse as toml} from '@iarna/toml';
+import LRU from 'lru-cache';
 
-type ConfigOutput = {|
+export type ConfigOutput = {|
   config: ConfigResult,
   files: Array<File>,
 |};
 
-type ConfigOptions = {|
+export type ConfigOptions = {|
   parse?: boolean,
+  parser?: string => any,
 |};
 
-const PARSERS = {
-  json: require('json5').parse,
-  toml: require('@iarna/toml').parse,
-};
-
-const existsCache = new Map();
+const configCache = new LRU<FilePath, ConfigOutput>({max: 500});
+const resolveCache = new Map();
 
-export async function resolveConfig(
+export function resolveConfig(
   fs: FileSystem,
   filepath: FilePath,
   filenames: Array<FilePath>,
-  opts: ?ConfigOptions,
-  root: FilePath = path.parse(filepath).root,
-): Promise<FilePath | null> {
-  filepath = await fs.realpath(path.dirname(filepath));
-
-  // Don't traverse above the module root
-  if (filepath === root || path.basename(filepath) === 'node_modules') {
-    return null;
+  projectRoot: FilePath,
+): Promise<?FilePath> {
+  // Cache the result of resolving config for this directory.
+  // This is automatically invalidated at the end of the current build.
+  let key = path.dirname(filepath) + filenames.join(',');
+  let cached = resolveCache.get(key);
+  if (cached !== undefined) {
+    return Promise.resolve(cached);
   }
 
-  for (const filename of filenames) {
-    let file = path.join(filepath, filename);
-    if ((await fs.exists(file)) && (await fs.stat(file)).isFile()) {
-      return file;
-    }
-  }
+  let resolved = fs.findAncestorFile(
+    filenames,
+    path.dirname(filepath),
+    projectRoot,
+  );
+  resolveCache.set(key, resolved);
+  return Promise.resolve(resolved);
+}
 
-  return resolveConfig(fs, filepath, filenames, opts);
+export function resolveConfigSync(
+  fs: FileSystem,
+  filepath: FilePath,
+  filenames: Array<FilePath>,
+  projectRoot: FilePath,
+): ?FilePath {
+  return fs.findAncestorFile(filenames, path.dirname(filepath), projectRoot);
 }
 
 export async function loadConfig(
   fs: FileSystem,
   filepath: FilePath,
   filenames: Array<FilePath>,
+  projectRoot: FilePath,
   opts: ?ConfigOptions,
 ): Promise<ConfigOutput | null> {
-  let configFile = await resolveConfig(fs, filepath, filenames, opts);
+  let parse = opts?.parse ?? true;
+  let configFile = await resolveConfig(fs, filepath, filenames, projectRoot);
   if (configFile) {
+    let cachedOutput = configCache.get(String(parse) + configFile);
+    if (cachedOutput) {
+      return cachedOutput;
+    }
+
     try {
       let extname = path.extname(configFile).slice(1);
-      if (extname === 'js') {
-        return {
+      if (extname === 'js' || extname === 'cjs') {
+        let output = {
           // $FlowFixMe
-          config: clone(require(configFile)),
+          config: clone(module.require(configFile)),
           files: [{filePath: configFile}],
         };
-      }
-
-      let configContent = await fs.readFile(configFile, 'utf8');
-      if (!configContent) {
-        return null;
-      }
 
-      let config;
-      if (opts && opts.parse === false) {
-        config = configContent;
-      } else {
-        let parse = PARSERS[extname] || PARSERS.json;
-        config = parse(configContent);
+        configCache.set(configFile, output);
+        return output;
       }
 
-      return {
-        config: config,
-        files: [{filePath: configFile}],
-      };
+      return readConfig(fs, configFile, opts);
     } catch (err) {
       if (err.code === 'MODULE_NOT_FOUND' || err.code === 'ENOENT') {
-        existsCache.delete(configFile);
         return null;
       }
 
@@ -92,3 +94,88 @@ export async function loadConfig(
 
   return null;
 }
+
+loadConfig.clear = () => {
+  configCache.reset();
+  resolveCache.clear();
+};
+
+export async function readConfig(
+  fs: FileSystem,
+  configFile: FilePath,
+  opts: ?ConfigOptions,
+): Promise<ConfigOutput | null> {
+  let parse = opts?.parse ?? true;
+  let cachedOutput = configCache.get(String(parse) + configFile);
+  if (cachedOutput) {
+    return cachedOutput;
+  }
+
+  try {
+    let configContent = await fs.readFile(configFile, 'utf8');
+    let config;
+    if (parse === false) {
+      config = configContent;
+    } else {
+      let extname = path.extname(configFile).slice(1);
+      let parse = opts?.parser ?? getParser(extname);
+      try {
+        config = parse(configContent);
+      } catch (e) {
+        if (extname !== '' && extname !== 'json') {
+          throw e;
+        }
+
+        let pos = {
+          line: e.lineNumber,
+          column: e.columnNumber,
+        };
+
+        throw new ThrowableDiagnostic({
+          diagnostic: {
+            message: `Failed to parse ${path.basename(configFile)}`,
+            origin: '@parcel/utils',
+            codeFrames: [
+              {
+                language: 'json5',
+                filePath: configFile,
+                code: configContent,
+                codeHighlights: [
+                  {
+                    start: pos,
+                    end: pos,
+                    message: e.message,
+                  },
+                ],
+              },
+            ],
+          },
+        });
+      }
+    }
+
+    let output = {
+      config,
+      files: [{filePath: configFile}],
+    };
+
+    configCache.set(String(parse) + configFile, output);
+    return output;
+  } catch (err) {
+    if (err.code === 'MODULE_NOT_FOUND' || err.code === 'ENOENT') {
+      return null;
+    }
+
+    throw err;
+  }
+}
+
+function getParser(extname) {
+  switch (extname) {
+    case 'toml':
+      return toml;
+    case 'json':
+    default:
+      return json5.parse;
+  }
+}

package/src/countLines.js

@@ -1,8 +1,11 @@
 // @flow strict-local
 
-export default function countLines(string: string): number {
+export default function countLines(
+  string: string,
+  startIndex: number = 0,
+): number {
   let lines = 1;
-  for (let i = 0; i < string.length; i++) {
+  for (let i = startIndex; i < string.length; i++) {
     if (string.charAt(i) === '\n') {
       lines++;
     }

package/src/debounce.js

@@ -6,7 +6,7 @@ export default function debounce<TArgs: Array<mixed>>(
 ): (...args: TArgs) => void {
   let timeout;
 
-  return function(...args: TArgs) {
+  return function (...args: TArgs) {
     if (timeout) {
       clearTimeout(timeout);
     }

package/src/dependency-location.js

@@ -1,17 +1,22 @@
 // @flow
+
 export default function createDependencyLocation(
-  start: {|
+  start: interface {
     line: number,
     column: number,
-  |},
-  moduleSpecifier: string,
+  },
+  specifier: string,
   lineOffset: number = 0,
   columnOffset: number = 0,
   // Imports are usually wrapped in quotes
   importWrapperLength: number = 2,
-) {
+): {|
+  end: {|column: number, line: number|},
+  filePath: string,
+  start: {|column: number, line: number|},
+|} {
   return {
-    filePath: moduleSpecifier,
+    filePath: specifier,
     start: {
       line: start.line + lineOffset,
       column: start.column + columnOffset,
@@ -20,7 +25,7 @@ export default function createDependencyLocation(
       line: start.line + lineOffset,
       column:
         start.column +
-        moduleSpecifier.length -
+        specifier.length -
         1 +
         importWrapperLength +
         columnOffset,

package/src/generateBuildMetrics.js

@@ -0,0 +1,158 @@
+// @flow
+
+import type {FilePath, PackagedBundle} from '@parcel/types';
+import type {FileSystem} from '@parcel/fs';
+import SourceMap from '@parcel/source-map';
+import nullthrows from 'nullthrows';
+import path from 'path';
+import {loadSourceMapUrl} from './';
+
+export type AssetStats = {|
+  filePath: string,
+  size: number,
+  originalSize: number,
+  time: number,
+|};
+
+export type BundleStats = {|
+  filePath: string,
+  size: number,
+  time: number,
+  assets: Array<AssetStats>,
+|};
+
+export type BuildMetrics = {|
+  bundles: Array<BundleStats>,
+|};
+
+async function getSourcemapSizes(
+  filePath: FilePath,
+  fs: FileSystem,
+  projectRoot: FilePath,
+): Promise<?Map<string, number>> {
+  let bundleContents = await fs.readFile(filePath, 'utf-8');
+  let mapUrlData = await loadSourceMapUrl(fs, filePath, bundleContents);
+  if (!mapUrlData) {
+    return null;
+  }
+
+  let rawMap = mapUrlData.map;
+  let sourceMap = new SourceMap(projectRoot);
+  sourceMap.addVLQMap(rawMap);
+  let parsedMapData = sourceMap.getMap();
+
+  if (parsedMapData.mappings.length > 2) {
+    let sources = parsedMapData.sources.map(s =>
+      path.normalize(path.join(projectRoot, s)),
+    );
+    let currLine = 1;
+    let currColumn = 0;
+    let currMappingIndex = 0;
+    let currMapping = parsedMapData.mappings[currMappingIndex];
+    let nextMapping = parsedMapData.mappings[currMappingIndex + 1];
+    let sourceSizes = new Array(sources.length).fill(0);
+    let unknownOrigin: number = 0;
+    for (let i = 0; i < bundleContents.length; i++) {
+      let character = bundleContents[i];
+
+      while (
+        nextMapping &&
+        nextMapping.generated.line === currLine &&
+        nextMapping.generated.column <= currColumn
+      ) {
+        currMappingIndex++;
+        currMapping = parsedMapData.mappings[currMappingIndex];
+        nextMapping = parsedMapData.mappings[currMappingIndex + 1];
+      }
+
+      let currentSource = currMapping.source;
+      let charSize = Buffer.byteLength(character, 'utf8');
+      if (
+        currentSource != null &&
+        currMapping.generated.line === currLine &&
+        currMapping.generated.column <= currColumn
+      ) {
+        sourceSizes[currentSource] += charSize;
+      } else {
+        unknownOrigin += charSize;
+      }
+
+      if (character === '\n') {
+        currColumn = 0;
+        currLine++;
+      } else {
+        currColumn++;
+      }
+    }
+
+    let sizeMap = new Map();
+    for (let i = 0; i < sourceSizes.length; i++) {
+      sizeMap.set(sources[i], sourceSizes[i]);
+    }
+
+    sizeMap.set('', unknownOrigin);
+
+    return sizeMap;
+  }
+}
+
+async function createBundleStats(
+  bundle: PackagedBundle,
+  fs: FileSystem,
+  projectRoot: FilePath,
+) {
+  let filePath = bundle.filePath;
+  let sourcemapSizes = await getSourcemapSizes(filePath, fs, projectRoot);
+
+  let assets: Map<string, AssetStats> = new Map();
+  bundle.traverseAssets(asset => {
+    let filePath = path.normalize(asset.filePath);
+    assets.set(filePath, {
+      filePath,
+      size: asset.stats.size,
+      originalSize: asset.stats.size,
+      time: asset.stats.time,
+    });
+  });
+
+  let assetsReport: Array<AssetStats> = [];
+  if (sourcemapSizes && sourcemapSizes.size) {
+    assetsReport = Array.from(sourcemapSizes.keys()).map((filePath: string) => {
+      let foundSize = sourcemapSizes.get(filePath) || 0;
+      let stats = assets.get(filePath) || {
+        filePath,
+        size: foundSize,
+        originalSize: foundSize,
+        time: 0,
+      };
+
+      return {
+        ...stats,
+        size: foundSize,
+      };
+    });
+  } else {
+    assetsReport = Array.from(assets.values());
+  }
+
+  return {
+    filePath: nullthrows(bundle.filePath),
+    size: bundle.stats.size,
+    time: bundle.stats.time,
+    assets: assetsReport.sort((a, b) => b.size - a.size),
+  };
+}
+
+export default async function generateBuildMetrics(
+  bundles: Array<PackagedBundle>,
+  fs: FileSystem,
+  projectRoot: FilePath,
+): Promise<BuildMetrics> {
+  bundles.sort((a, b) => b.stats.size - a.stats.size).filter(b => !!b.filePath);
+
+  return {
+    bundles: (
+      await Promise.all(bundles.map(b => createBundleStats(b, fs, projectRoot)))
+    ).filter(e => !!e),
+  };
+}

package/src/generateCertificate.js

@@ -8,7 +8,7 @@ export default async function generateCertificate(
   fs: FileSystem,
   cacheDir: string,
   host: ?string,
-) {
+): Promise<{|cert: Buffer, key: Buffer|}> {
   let certDirectory = cacheDir;
 
   const privateKeyPath = path.join(certDirectory, 'private.pem');

package/src/getCertificate.js

@@ -5,7 +5,7 @@ import type {FileSystem} from '@parcel/fs';
 export default async function getCertificate(
   fs: FileSystem,
   options: HTTPSOptions,
-) {
+): Promise<{|cert: Buffer, key: Buffer|}> {
   try {
     let cert = await fs.readFile(options.cert);
     let key = await fs.readFile(options.key);

package/src/getExisting.js

@@ -14,10 +14,7 @@ export default function getExisting(
   return {
     source,
     minified: fs.existsSync(minifiedPath)
-      ? fs
-          .readFileSync(minifiedPath, 'utf8')
-          .trim()
-          .replace(/;$/, '')
+      ? fs.readFileSync(minifiedPath, 'utf8').trim().replace(/;$/, '')
       : source,
   };
 }

package/src/getModuleParts.js

@@ -0,0 +1,23 @@
+// @flow strict-local
+import path from 'path';
+
+import {normalizeSeparators} from './path';
+
+/**
+ * Returns the package name and the optional subpath
+ */
+export default function getModuleParts(_name: string): [string, ?string] {
+  let name = path.normalize(_name);
+  let splitOn = name.indexOf(path.sep);
+  if (name.charAt(0) === '@') {
+    splitOn = name.indexOf(path.sep, splitOn + 1);
+  }
+  if (splitOn < 0) {
+    return [normalizeSeparators(name), undefined];
+  } else {
+    return [
+      normalizeSeparators(name.substring(0, splitOn)),
+      name.substring(splitOn + 1) || undefined,
+    ];
+  }
+}

package/src/getRootDir.js

@@ -2,8 +2,7 @@
 
 import type {FilePath} from '@parcel/types';
 import {isGlob} from './glob';
-
-const path = require('path');
+import path from 'path';
 
 export default function getRootDir(files: Array<FilePath>): FilePath {
   let cur = null;

package/src/glob.js

@@ -5,25 +5,65 @@ import type {FileSystem} from '@parcel/fs';
 
 import _isGlob from 'is-glob';
 import fastGlob, {type FastGlobOptions} from 'fast-glob';
-import {isMatch} from 'micromatch';
+import micromatch, {isMatch, makeRe, type Options} from 'micromatch';
+import {normalizeSeparators} from './path';
 
-function normalizePath(p: string): string {
-  return p.replace(/\\/g, '/');
+export function isGlob(p: FilePath): any {
+  return _isGlob(normalizeSeparators(p));
 }
 
-export function isGlob(p: FilePath) {
-  return _isGlob(normalizePath(p));
+export function isGlobMatch(
+  filePath: FilePath,
+  glob: Glob | Array<Glob>,
+  opts?: Options,
+): any {
+  glob = Array.isArray(glob)
+    ? glob.map(normalizeSeparators)
+    : normalizeSeparators(glob);
+  return isMatch(filePath, glob, opts);
 }
 
-export function isGlobMatch(filePath: FilePath, glob: Glob) {
-  return isMatch(filePath, normalizePath(glob));
+export function globMatch(
+  values: Array<string>,
+  glob: Glob | Array<Glob>,
+  opts?: Options,
+): Array<string> {
+  glob = Array.isArray(glob)
+    ? glob.map(normalizeSeparators)
+    : normalizeSeparators(glob);
+
+  return micromatch(values, glob, opts);
+}
+
+export function globToRegex(glob: Glob, opts?: Options): RegExp {
+  return makeRe(glob, opts);
 }
 
 export function globSync(
   p: FilePath,
-  options: FastGlobOptions<FilePath>,
+  fs: FileSystem,
+  options?: FastGlobOptions<FilePath>,
 ): Array<FilePath> {
-  return fastGlob.sync(normalizePath(p), options);
+  // $FlowFixMe
+  options = {
+    ...options,
+    fs: {
+      statSync: p => {
+        return fs.statSync(p);
+      },
+      lstatSync: p => {
+        // Our FileSystem interface doesn't have lstat support at the moment,
+        // but this is fine for our purposes since we follow symlinks by default.
+        return fs.statSync(p);
+      },
+      readdirSync: (p, opts) => {
+        return fs.readdirSync(p, opts);
+      },
+    },
+  };
+
+  // $FlowFixMe
+  return fastGlob.sync(normalizeSeparators(p), options);
 }
 
 export function glob(
@@ -66,5 +106,6 @@ export function glob(
     },
   };
 
-  return fastGlob(normalizePath(p), options);
+  // $FlowFixMe Added in Flow 0.121.0 upgrade in #4381
+  return fastGlob(normalizeSeparators(p), options);
 }

package/src/hash.js

@@ -0,0 +1,49 @@
+// @flow strict-local
+
+import type {Readable} from 'stream';
+import type {FileSystem} from '@parcel/fs';
+
+import {objectSortedEntriesDeep} from './collection';
+import {hashString, Hash} from '@parcel/rust';
+
+export function hashStream(stream: Readable): Promise<string> {
+  let hash = new Hash();
+  return new Promise((resolve, reject) => {
+    stream.on('error', err => {
+      reject(err);
+    });
+    stream
+      .on('data', chunk => {
+        hash.writeBuffer(chunk);
+      })
+      .on('end', function () {
+        resolve(hash.finish());
+      })
+      .on('error', err => {
+        reject(err);
+      });
+  });
+}
+
+export function hashObject(obj: {+[string]: mixed, ...}): string {
+  return hashString(JSON.stringify(objectSortedEntriesDeep(obj)));
+}
+
+let testCache: {|[string]: Promise<string>|} = {
+  /*:: ...null */
+};
+export function hashFile(fs: FileSystem, filePath: string): Promise<string> {
+  if (process.env.PARCEL_BUILD_ENV === 'test') {
+    // Development builds of these native modules are especially big and slow to hash.
+    if (
+      /parcel-swc\.[^\\/]+\.node$|lightningcss.[^\\/]+.node$/.test(filePath)
+    ) {
+      let cacheEntry = testCache[filePath];
+      if (cacheEntry) return cacheEntry;
+      let v = hashStream(fs.createReadStream(filePath));
+      testCache[filePath] = v;
+      return v;
+    }
+  }
+  return hashStream(fs.createReadStream(filePath));
+}