Fix dev dep request missing 'invalidateOnCreate'

Fixes #8375

Ported from Atlaspack: atlassian-labs/atlaspack#185

Co-authored-by: Pedro Yamada <tacla.yamada@gmail.com>

Author: devongovett

packages/core/core/src/PackagerRunner.js

@@ -14,6 +14,7 @@ import type {
   Bundle as InternalBundle,
   Config,
   DevDepRequest,
+  DevDepRequestRef,
   ParcelOptions,
   ReportFn,
   RequestInvalidation,
@@ -74,7 +75,7 @@ type Opts = {|
 export type RunPackagerRunnerResult = {|
   bundleInfo: BundleInfo[],
   configRequests: Array<ConfigRequest>,
-  devDepRequests: Array<DevDepRequest>,
+  devDepRequests: Array<DevDepRequest | DevDepRequestRef>,
   invalidations: Array<RequestInvalidation>,
 |};
 
@@ -107,7 +108,7 @@ export default class PackagerRunner {
   distExists: Set<FilePath>;
   report: ReportFn;
   previousDevDeps: Map<string, string>;
-  devDepRequests: Map<string, DevDepRequest>;
+  devDepRequests: Map<string, DevDepRequest | DevDepRequestRef>;
   invalidations: Map<string, RequestInvalidation>;
   previousInvalidations: Array<RequestInvalidation>;
 

packages/core/core/src/Transformation.js

@@ -15,6 +15,7 @@ import type {
   TransformationRequest,
   Config,
   DevDepRequest,
+  DevDepRequestRef,
   ParcelOptions,
   InternalDevDepOptions,
   Invalidations,
@@ -89,13 +90,13 @@ export type TransformationResult = {|
   error?: Array<Diagnostic>,
   configRequests: Array<ConfigRequest>,
   invalidations: Invalidations,
-  devDepRequests: Array<DevDepRequest>,
+  devDepRequests: Array<DevDepRequest | DevDepRequestRef>,
 |};
 
 export default class Transformation {
   request: TransformationRequest;
   configs: Map<string, Config>;
-  devDepRequests: Map<string, DevDepRequest>;
+  devDepRequests: Map<string, DevDepRequest | DevDepRequestRef>;
   pluginDevDeps: Array<InternalDevDepOptions>;
   options: ParcelOptions;
   pluginOptions: PluginOptions;

packages/core/core/src/applyRuntimes.js

@@ -9,6 +9,7 @@ import type {
   Bundle as InternalBundle,
   Config,
   DevDepRequest,
+  DevDepRequestRef,
   ParcelOptions,
 } from './types';
 import type ParcelConfig from './ParcelConfig';
@@ -59,7 +60,7 @@ export default async function applyRuntimes<TResult: RequestResult>({
   pluginOptions: PluginOptions,
   api: RunAPI<TResult>,
   previousDevDeps: Map<string, string>,
-  devDepRequests: Map<string, DevDepRequest>,
+  devDepRequests: Map<string, DevDepRequest | DevDepRequestRef>,
   configs: Map<string, Config>,
 |}): Promise<Map<string, Asset>> {
   let runtimes = await config.getRuntimes();

packages/core/core/src/requests/BundleGraphRequest.js

@@ -10,6 +10,7 @@ import type {
   Bundle as InternalBundle,
   Config,
   DevDepRequest,
+  DevDepRequestRef,
   ParcelOptions,
 } from '../types';
 import type {ConfigAndCachePath} from './ParcelConfigRequest';
@@ -173,7 +174,7 @@ class BundlerRunner {
   pluginOptions: PluginOptions;
   api: RunAPI<BundleGraphResult>;
   previousDevDeps: Map<string, string>;
-  devDepRequests: Map<string, DevDepRequest>;
+  devDepRequests: Map<string, DevDepRequest | DevDepRequestRef>;
   configs: Map<string, Config>;
   cacheKey: string;
 
@@ -236,7 +237,7 @@ class BundlerRunner {
     this.configs.set(plugin.name, config);
   }
 
-  async runDevDepRequest(devDepRequest: DevDepRequest) {
+  async runDevDepRequest(devDepRequest: DevDepRequest | DevDepRequestRef) {
     let {specifier, resolveFrom} = devDepRequest;
     let key = `${specifier}:${fromProjectPathRelative(resolveFrom)}`;
     this.devDepRequests.set(key, devDepRequest);

packages/core/core/src/requests/DevDepRequest.js

@@ -7,6 +7,7 @@ import type {
 import type ParcelConfig from '../ParcelConfig';
 import type {
   DevDepRequest,
+  DevDepRequestRef,
   ParcelOptions,
   InternalDevDepOptions,
 } from '../types';
@@ -34,7 +35,7 @@ export async function createDevDependency(
   opts: InternalDevDepOptions,
   requestDevDeps: Map<string, string>,
   options: ParcelOptions,
-): Promise<DevDepRequest> {
+): Promise<DevDepRequest | DevDepRequestRef> {
   let {specifier, resolveFrom, additionalInvalidations} = opts;
   let key = `${specifier}:${fromProjectPathRelative(resolveFrom)}`;
 
@@ -44,6 +45,7 @@ export async function createDevDependency(
   let hash = requestDevDeps.get(key);
   if (hash != null) {
     return {
+      type: 'ref',
       specifier,
       resolveFrom,
       hash,
@@ -189,12 +191,17 @@ export type DevDepRequestResult = {|
 
 export async function runDevDepRequest<TResult: RequestResult>(
   api: RunAPI<TResult>,
-  devDepRequest: DevDepRequest,
+  devDepRequestRef: DevDepRequest | DevDepRequestRef,
 ) {
   await api.runRequest<null, DevDepRequestResult | void>({
-    id: 'dev_dep_request:' + devDepRequest.specifier + ':' + devDepRequest.hash,
+    id:
+      'dev_dep_request:' +
+      devDepRequestRef.specifier +
+      ':' +
+      devDepRequestRef.hash,
     type: requestTypes.dev_dep_request,
     run: ({api}) => {
+      let devDepRequest = resolveDevDepRequestRef(devDepRequestRef);
       for (let filePath of nullthrows(
         devDepRequest.invalidateOnFileChange,
         'DevDepRequest missing invalidateOnFileChange',
@@ -225,19 +232,43 @@ export async function runDevDepRequest<TResult: RequestResult>(
   });
 }
 
+const devDepRequests: Map<string, DevDepRequest> = createBuildCache();
+export function resolveDevDepRequestRef(
+  devDepRequestRef: DevDepRequest | DevDepRequestRef,
+): DevDepRequest {
+  const devDepRequest =
+    devDepRequestRef.type === 'ref'
+      ? devDepRequests.get(devDepRequestRef.hash)
+      : devDepRequestRef;
+  if (devDepRequest == null) {
+    throw new Error(
+      `Worker send back a reference to a missing dev dep request.
+This might happen due to internal in-memory build caches not being cleared
+between builds or due a race condition.
+This is a bug in Parcel.`,
+    );
+  }
+
+  if (devDepRequestRef.type !== 'ref') {
+    devDepRequests.set(devDepRequest.hash, devDepRequest);
+  }
+
+  return devDepRequest;
+}
+
 // A cache of plugin dependency hashes that we've already sent to the main thread.
 // Automatically cleared before each build.
 const pluginCache = createBuildCache();
 
 export function getWorkerDevDepRequests(
-  devDepRequests: Array<DevDepRequest>,
-): Array<DevDepRequest> {
+  devDepRequests: Array<DevDepRequest | DevDepRequestRef>,
+): Array<DevDepRequest | DevDepRequestRef> {
   return devDepRequests.map(devDepRequest => {
     // If we've already sent a matching transformer + hash to the main thread during this build,
     // there's no need to repeat ourselves.
     let {specifier, resolveFrom, hash} = devDepRequest;
     if (hash === pluginCache.get(specifier)) {
-      return {specifier, resolveFrom, hash};
+      return {type: 'ref', specifier, resolveFrom, hash};
     } else {
       pluginCache.set(specifier, hash);
       return devDepRequest;

packages/core/core/src/requests/PathRequest.js

@@ -12,6 +12,7 @@ import type {
   Config,
   Dependency,
   DevDepRequest,
+  DevDepRequestRef,
   ParcelOptions,
 } from '../types';
 import type {ConfigAndCachePath} from './ParcelConfigRequest';
@@ -163,7 +164,7 @@ export class ResolverRunner {
   options: ParcelOptions;
   pluginOptions: PluginOptions;
   previousDevDeps: Map<string, string>;
-  devDepRequests: Map<string, DevDepRequest>;
+  devDepRequests: Map<string, DevDepRequest | DevDepRequestRef>;
   configs: Map<string, Config>;
 
   constructor({config, options, previousDevDeps}: ResolverRunnerOpts) {
@@ -237,7 +238,7 @@ export class ResolverRunner {
     }
   }
 
-  runDevDepRequest(devDepRequest: DevDepRequest) {
+  runDevDepRequest(devDepRequest: DevDepRequest | DevDepRequestRef) {
     let {specifier, resolveFrom} = devDepRequest;
     let key = `${specifier}:${fromProjectPathRelative(resolveFrom)}`;
     this.devDepRequests.set(key, devDepRequest);

packages/core/core/src/types.js

@@ -258,16 +258,23 @@ export type DevDepRequest = {|
   specifier: DependencySpecifier,
   resolveFrom: ProjectPath,
   hash: string,
-  invalidateOnFileCreate?: Array<InternalFileCreateInvalidation>,
-  invalidateOnFileChange?: Set<ProjectPath>,
-  invalidateOnStartup?: boolean,
+  invalidateOnFileCreate: Array<InternalFileCreateInvalidation>,
+  invalidateOnFileChange: Set<ProjectPath>,
+  invalidateOnStartup: boolean,
   additionalInvalidations?: Array<{|
     specifier: DependencySpecifier,
     resolveFrom: ProjectPath,
     range?: ?SemverRange,
   |}>,
 |};
 
+export type DevDepRequestRef = {|
+  type: 'ref',
+  specifier: DependencySpecifier,
+  resolveFrom: ProjectPath,
+  hash: string,
+|};
+
 declare type GlobPattern = string;
 
 export type ParcelOptions = {|

packages/core/core/test/requests/DevDepRequest.test.js

@@ -0,0 +1,62 @@
+// @flow strict-local
+
+// eslint-disable-next-line @parcel/no-self-package-imports
+import {clearBuildCaches} from '@parcel/core/src/buildCache';
+import {resolveDevDepRequestRef} from '../../src/requests/DevDepRequest';
+import type {DevDepRequest, DevDepRequestRef} from '../../src/types';
+import {toProjectPath} from '../../src/projectPath';
+import assert from 'assert';
+
+describe('DevDepRequest', () => {
+  beforeEach(() => {
+    clearBuildCaches();
+  });
+
+  describe('resolveDevDepRequestRef', () => {
+    it('will return requests as is', () => {
+      const request: DevDepRequest = {
+        specifier: 'test',
+        hash: 'hash',
+        invalidateOnFileChange: new Set(),
+        invalidateOnFileCreate: [],
+        invalidateOnStartup: false,
+        resolveFrom: toProjectPath('', 'path.js'),
+      };
+      const result = resolveDevDepRequestRef(request);
+      assert.equal(result, request);
+    });
+
+    it('will return cached requests for refs', () => {
+      const request: DevDepRequest = {
+        specifier: 'test',
+        hash: 'hash',
+        invalidateOnFileChange: new Set(),
+        invalidateOnFileCreate: [],
+        invalidateOnStartup: false,
+        resolveFrom: toProjectPath('', 'path.js'),
+      };
+      resolveDevDepRequestRef(request);
+
+      const devDepRequestRef: DevDepRequestRef = {
+        type: 'ref',
+        specifier: 'test',
+        hash: 'hash',
+        resolveFrom: toProjectPath('', 'path.js'),
+      };
+      const result = resolveDevDepRequestRef(devDepRequestRef);
+      assert.equal(result, request);
+    });
+
+    it('will throw for uncached refs', () => {
+      const devDepRequestRef: DevDepRequestRef = {
+        type: 'ref',
+        specifier: 'test',
+        hash: 'hash',
+        resolveFrom: toProjectPath('', 'path.js'),
+      };
+      assert.throws(() => {
+        resolveDevDepRequestRef(devDepRequestRef);
+      });
+    });
+  });
+});