[heft] Create parent temp folder for phase

Author: dmichon-msft

apps/heft/src/operations/runners/PhaseOperationRunner.ts

@@ -10,7 +10,6 @@ import {
 import { deleteFilesAsync, type IDeleteOperation } from '../../plugins/DeleteFilesPlugin';
 import type { HeftPhase } from '../../pluginFramework/HeftPhase';
 import type { HeftPhaseSession } from '../../pluginFramework/HeftPhaseSession';
-import type { HeftTaskSession } from '../../pluginFramework/HeftTaskSession';
 import type { InternalHeftSession } from '../../pluginFramework/InternalHeftSession';
 
 export interface IPhaseOperationRunnerOptions {
@@ -53,10 +52,14 @@ export class PhaseOperationRunner implements IOperationRunner {
     const deleteOperations: IDeleteOperation[] = Array.from(phase.cleanFiles);
 
     // Delete all temp folders for tasks by default
-    for (const task of phase.tasks) {
-      const taskSession: HeftTaskSession = phaseSession.getSessionForTask(task);
-      deleteOperations.push({ sourcePath: taskSession.tempFolderPath });
-    }
+    const tempFolderGlobs: string[] = [
+      /* heft@>0.60.0 */ phase.phaseName,
+      /* heft@<=0.60.0 */ `${phase.phaseName}.*`
+    ];
+    deleteOperations.push({
+      sourcePath: internalHeftSession.heftConfiguration.tempFolderPath,
+      includeGlobs: tempFolderGlobs
+    });
 
     // Delete the files if any were specified
     if (deleteOperations.length) {

apps/heft/src/pluginFramework/HeftTaskSession.ts

@@ -287,13 +287,14 @@ export class HeftTaskSession implements IHeftTaskSession {
     };
 
     // Guaranteed to be unique since phases are uniquely named, tasks are uniquely named within
-    // phases, and neither can have '.' in their names. We will also use the phase name and
+    // phases, and neither can have '/' in their names. We will also use the phase name and
     // task name as the folder name (instead of the plugin name) since we want to enable re-use
     // of plugins in multiple phases and tasks while maintaining unique temp/cache folders for
     // each task.
-    const uniqueTaskFolderName: string = `${phase.phaseName}.${task.taskName}`;
+    // Having a parent folder for the phase simplifies interaction with the Rush build cache.
+    const uniqueTaskFolderName: string = `${phase.phaseName}/${task.taskName}`;
 
-    // <projectFolder>/temp/<phaseName>.<taskName>
+    // <projectFolder>/temp/<phaseName>/<taskName>
     this.tempFolderPath = path.join(tempFolder, uniqueTaskFolderName);
 
     this._options = options;

build-tests/heft-parameter-plugin-test/src/test/customParameter.test.ts

@@ -4,7 +4,7 @@ import { FileSystem } from '@rushstack/node-core-library';
 describe('CustomParameterOutput', () => {
   it('parses command line arguments and prints output.', async () => {
     const outputContent: string = await FileSystem.readFileAsync(
-      `${dirname(dirname(__dirname))}/temp/test.write-parameters/custom_output.txt`
+      `${dirname(dirname(__dirname))}/temp/test/write-parameters/custom_output.txt`
     );
     expect(outputContent).toBe(
       'customIntegerParameter: 5\n' +

common/changes/@rushstack/heft/heft-temp-folder-pattern_2023-09-20-00-47.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/heft",
+      "comment": "(BREAKING CHANGE): Rename task temp folder from \"<phase>.<task>\" to \"<phase>/<task>\" to simplify caching phase outputs.",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@rushstack/heft"
+}