Don't use deprecated querystring package (#6806)

parcel-bundler · Oct 7, 2021 · aafc318 · aafc318
1 parent a6a6fb2
commit aafc318
Show file tree

Hide file tree

Showing 21 changed files with 64 additions and 77 deletions.
diff --git a/packages/core/core/package.json b/packages/core/core/package.json
@@ -47,7 +47,6 @@
     "json5": "^1.0.1",
     "micromatch": "^4.0.2",
     "nullthrows": "^1.1.1",
-    "querystring": "^0.2.0",
     "semver": "^5.4.1"
   },
   "devDependencies": {

diff --git a/packages/core/core/src/AssetGraph.js b/packages/core/core/src/AssetGraph.js
@@ -19,7 +19,7 @@ import type {
 
 import invariant from 'assert';
 import {hashString, Hash} from '@parcel/hash';
-import {hashObject, objectSortedEntries} from '@parcel/utils';
+import {hashObject} from '@parcel/utils';
 import nullthrows from 'nullthrows';
 import {ContentGraph} from '@parcel/graph';
 import {createDependency} from './Dependency';
@@ -62,9 +62,7 @@ export function nodeFromAssetGroup(assetGroup: AssetGroup): AssetGroupNode {
         ':' +
         (assetGroup.pipeline ?? '') +
         ':' +
-        (assetGroup.query
-          ? JSON.stringify(objectSortedEntries(assetGroup.query))
-          : ''),
+        (assetGroup.query ?? ''),
     ),
     type: 'asset_group',
     value: assetGroup,

diff --git a/packages/core/core/src/BundleGraph.js b/packages/core/core/src/BundleGraph.js
@@ -7,7 +7,6 @@ import type {
   TraversalActions,
 } from '@parcel/types';
 import type {NodeId, SerializedContentGraph} from '@parcel/graph';
-import querystring from 'querystring';
 
 import type {
   Asset,
@@ -1491,16 +1490,18 @@ export default class BundleGraph {
     let hash = new Hash();
     // TODO: sort??
     this.traverseAssets(bundle, asset => {
-      hash.writeString(
-        [
-          this.getAssetPublicId(asset),
-          asset.outputHash,
-          asset.filePath,
-          querystring.stringify(asset.query),
-          asset.type,
-          asset.uniqueKey,
-        ].join(':'),
-      );
+      {
+        hash.writeString(
+          [
+            this.getAssetPublicId(asset),
+            asset.outputHash,
+            asset.filePath,
+            asset.query,
+            asset.type,
+            asset.uniqueKey,
+          ].join(':'),
+        );
+      }
     });
 
     let hashHex = hash.finish();

diff --git a/packages/core/core/src/Transformation.js b/packages/core/core/src/Transformation.js
@@ -24,7 +24,6 @@ import type {LoadedPlugin} from './ParcelConfig';
 import path from 'path';
 import {Readable} from 'stream';
 import nullthrows from 'nullthrows';
-import {objectSortedEntries} from '@parcel/utils';
 import logger, {PluginLogger} from '@parcel/logger';
 import ThrowableDiagnostic, {
   errorToDiagnostic,
@@ -561,7 +560,7 @@ export default class Transformation {
         a.value.pipeline,
         a.value.hash,
         a.value.uniqueKey,
-        a.value.query ? JSON.stringify(objectSortedEntries(a.value.query)) : '',
+        a.value.query ?? '',
       ])
       .join('');
 

diff --git a/packages/core/core/src/assetUtils.js b/packages/core/core/src/assetUtils.js
@@ -11,7 +11,6 @@ import type {
   Symbol,
   SourceLocation,
   Transformer,
-  QueryParameters,
 } from '@parcel/types';
 import type {
   Asset,
@@ -20,7 +19,6 @@ import type {
   Environment,
   ParcelOptions,
 } from './types';
-import {objectSortedEntries} from '@parcel/utils';
 
 import {Readable} from 'stream';
 import {PluginLogger} from '@parcel/logger';
@@ -47,7 +45,7 @@ type AssetOptions = {|
   hash?: ?string,
   idBase?: ?string,
   filePath: ProjectPath,
-  query?: ?QueryParameters,
+  query?: ?string,
   type: string,
   contentKey?: ?string,
   mapKey?: ?string,
@@ -76,9 +74,6 @@ export function createAssetIdFromOptions(options: AssetOptions): string {
     options.idBase != null
       ? options.idBase
       : fromProjectPathRelative(options.filePath);
-  let queryString = options.query
-    ? JSON.stringify(objectSortedEntries(options.query))
-    : '';
 
   return hashString(
     idBase +
@@ -88,7 +83,7 @@ export function createAssetIdFromOptions(options: AssetOptions): string {
       ':' +
       (options.pipeline ?? '') +
       ':' +
-      queryString,
+      (options.query ?? ''),
   );
 }
 

diff --git a/packages/core/core/src/public/Asset.js b/packages/core/core/src/public/Asset.js
@@ -19,7 +19,6 @@ import type {
   Stats,
   MutableAssetSymbols as IMutableAssetSymbols,
   AssetSymbols as IAssetSymbols,
-  QueryParameters,
   BundleBehavior,
 } from '@parcel/types';
 import type {Asset as AssetValue, ParcelOptions} from '../types';
@@ -83,13 +82,14 @@ export function assetFromValue(
 
 class BaseAsset {
   #asset: CommittedAsset | UncommittedAsset;
+  #query /*: ?URLSearchParams */;
 
   constructor(asset: CommittedAsset | UncommittedAsset) {
     this.#asset = asset;
     _assetToAssetValue.set(this, asset.value);
   }
 
-  // $FlowFixMe
+  // $FlowFixMe[unsupported-syntax]
   [inspect](): string {
     return `Asset(${this.filePath})`;
   }
@@ -117,8 +117,11 @@ class BaseAsset {
     );
   }
 
-  get query(): QueryParameters {
-    return this.#asset.value.query ?? {};
+  get query(): URLSearchParams {
+    if (!this.#query) {
+      this.#query = new URLSearchParams(this.#asset.value.query ?? '');
+    }
+    return this.#query;
   }
 
   get meta(): Meta {

diff --git a/packages/core/core/src/requests/AssetRequest.js b/packages/core/core/src/requests/AssetRequest.js
@@ -12,7 +12,6 @@ import type {
 import type {ConfigAndCachePath} from './ParcelConfigRequest';
 import type {TransformationResult} from '../Transformation';
 
-import {objectSortedEntries} from '@parcel/utils';
 import nullthrows from 'nullthrows';
 import {hashString} from '@parcel/hash';
 import createParcelConfigRequest from './ParcelConfigRequest';
@@ -59,7 +58,7 @@ function getId(input: AssetRequestInput) {
       ':' +
       (input.pipeline ?? '') +
       ':' +
-      (input.query ? JSON.stringify(objectSortedEntries(input.query)) : ''),
+      (input.query ?? ''),
   );
 }
 

diff --git a/packages/core/core/src/requests/PathRequest.js b/packages/core/core/src/requests/PathRequest.js
@@ -239,7 +239,7 @@ export class ResolverRunner {
                   this.options.projectRoot,
                   resultFilePath,
                 ),
-                query: result.query,
+                query: result.query?.toString(),
                 sideEffects: result.sideEffects,
                 code: result.code,
                 env: dependency.env,

diff --git a/packages/core/core/src/types.js b/packages/core/core/src/types.js
@@ -24,7 +24,6 @@ import type {
   OutputFormat,
   TargetDescriptor,
   HMROptions,
-  QueryParameters,
   DetailedReportOptions,
 } from '@parcel/types';
 import type {SharedReference} from '@parcel/workers';
@@ -158,7 +157,7 @@ export type Asset = {|
   committed: boolean,
   hash: ?string,
   filePath: ProjectPath,
-  query: ?QueryParameters,
+  query: ?string,
   type: string,
   dependencies: Map<string, Dependency>,
   bundleBehavior: ?$Values<typeof BundleBehavior>,
@@ -330,7 +329,7 @@ export type AssetRequestInput = {|
   pipeline?: ?string,
   optionsRef: SharedReference,
   isURL?: boolean,
-  query?: ?QueryParameters,
+  query?: ?string,
 |};
 
 export type AssetRequestResult = Array<Asset>;

diff --git a/packages/core/core/test/AssetGraph.test.js b/packages/core/core/test/AssetGraph.test.js
@@ -253,7 +253,6 @@ describe('AssetGraph', () => {
     let req = {
       filePath: toProjectPath('/index.js'),
       env: DEFAULT_ENV,
-      query: {},
     };
 
     graph.resolveDependency(dep, req, '3');
@@ -267,7 +266,6 @@ describe('AssetGraph', () => {
     let req2 = {
       filePath: toProjectPath('/index.jsx'),
       env: DEFAULT_ENV,
-      query: {},
     };
     graph.resolveDependency(dep, req2, '4');
 
@@ -319,7 +317,7 @@ describe('AssetGraph', () => {
     });
     let sourcePath = '/index.js';
     let filePath = toProjectPath(sourcePath);
-    let req = {filePath, env: DEFAULT_ENV, query: {}};
+    let req = {filePath, env: DEFAULT_ENV};
     graph.resolveDependency(dep, req, '3');
     let assets = [
       createAsset({
@@ -486,7 +484,7 @@ describe('AssetGraph', () => {
     });
     let sourcePath = '/index.js';
     let filePath = toProjectPath(sourcePath);
-    let req = {filePath, env: DEFAULT_ENV, query: {}};
+    let req = {filePath, env: DEFAULT_ENV};
     graph.resolveDependency(dep, req, '123');
     let dep1 = createDependency({
       specifier: 'dependent-asset-1',
@@ -566,7 +564,6 @@ describe('AssetGraph', () => {
     let indexAssetGroup = {
       filePath: toProjectPath('/index.js'),
       env: DEFAULT_ENV,
-      query: {},
     };
     graph.setRootConnections({assetGroups: [indexAssetGroup]});
     let indexFooDep = createDependency({
@@ -600,7 +597,6 @@ describe('AssetGraph', () => {
     let fooAssetGroup = {
       filePath: toProjectPath('/foo.js'),
       env: DEFAULT_ENV,
-      query: {},
     };
     graph.resolveDependency(indexFooDep, fooAssetGroup, '0');
     let fooAssetGroupNode = nodeFromAssetGroup(fooAssetGroup);
@@ -626,7 +622,6 @@ describe('AssetGraph', () => {
     let utilsAssetGroup = {
       filePath: toProjectPath('/utils.js'),
       env: DEFAULT_ENV,
-      query: {},
     };
     let utilsAssetGroupNode = nodeFromAssetGroup(utilsAssetGroup);
     graph.resolveDependency(fooUtilsDep, utilsAssetGroup, '0');
@@ -646,7 +641,6 @@ describe('AssetGraph', () => {
     let barAssetGroup = {
       filePath: toProjectPath('/bar.js'),
       env: DEFAULT_ENV,
-      query: {},
     };
     graph.resolveDependency(indexBarDep, barAssetGroup, '0');
     let barAssetGroupNode = nodeFromAssetGroup(barAssetGroup);

diff --git a/packages/core/core/test/BundleGraph.test.js b/packages/core/core/test/BundleGraph.test.js
@@ -83,7 +83,7 @@ function createMockAssetGraph(ids: [string, string]) {
   });
   let sourcePath = '/index.js';
   let filePath = toProjectPath('/', sourcePath);
-  let req = {filePath, env: DEFAULT_ENV, query: {}};
+  let req = {filePath, env: DEFAULT_ENV};
   graph.resolveDependency(dep, nodeFromAssetGroup(req).value, '3');
 
   let dep1 = createDependency({

diff --git a/packages/core/core/test/PublicMutableBundleGraph.test.js b/packages/core/core/test/PublicMutableBundleGraph.test.js
@@ -151,7 +151,7 @@ function createMockAssetGraph() {
   });
 
   let filePath = toProjectPath('/', '/index.js');
-  let req1 = {filePath, env: DEFAULT_ENV, query: {}};
+  let req1 = {filePath, env: DEFAULT_ENV};
   graph.resolveDependency(dep1, nodeFromAssetGroup(req1).value, '5');
   graph.resolveAssetGroup(
     req1,
@@ -170,7 +170,7 @@ function createMockAssetGraph() {
   );
 
   filePath = toProjectPath('/', '/index2.js');
-  let req2 = {filePath, env: DEFAULT_ENV, query: {}};
+  let req2 = {filePath, env: DEFAULT_ENV};
   graph.resolveDependency(dep2, nodeFromAssetGroup(req2).value, '7');
   graph.resolveAssetGroup(
     req2,

diff --git a/...on-tests/test/integration/resolver-canDefer/node_modules/parcel-bundler-no-defer/index.js b/...on-tests/test/integration/resolver-canDefer/node_modules/parcel-bundler-no-defer/index.js
diff --git a/packages/core/package-manager/src/NodePackageManager.js b/packages/core/package-manager/src/NodePackageManager.js
@@ -18,7 +18,6 @@ import ThrowableDiagnostic, {
   md,
 } from '@parcel/diagnostic';
 import nativeFS from 'fs';
-// $FlowFixMe this is untyped
 import Module from 'module';
 import path from 'path';
 import semver from 'semver';

diff --git a/packages/core/types/index.js b/packages/core/types/index.js
@@ -25,8 +25,6 @@ export type ConfigResultWithFilePath<T> = {|
 /** <code>process.env</code> */
 export type EnvMap = typeof process.env;
 
-export type QueryParameters = {[key: string]: string, ...};
-
 export type JSONValue =
   | null
   | void // ? Is this okay?
@@ -634,7 +632,7 @@ export interface BaseAsset {
    */
   +type: string;
   /** The transformer options for the asset from the dependency query string. */
-  +query: QueryParameters;
+  +query: URLSearchParams;
   /** The environment of the asset. */
   +env: Environment;
   /**
@@ -1455,7 +1453,7 @@ export type ResolveResult = {|
   /** An optional named pipeline to use to compile the resolved file. */
   +pipeline?: ?string,
   /** Query parameters to be used by transformers when compiling the resolved file. */
-  +query?: QueryParameters,
+  +query?: URLSearchParams,
   /** Whether the resolved file should be excluded from the build. */
   +isExcluded?: boolean,
   /** Overrides the priority set on the dependency. */