feat: add optioal CLI option for setting a temporary file path

Author: nytamin

apps/appcontainer-node/packages/generic/src/__tests__/lib/setupEnv.ts

@@ -46,6 +46,7 @@ export async function setupAppContainer(partialAppContainerConfig: Partial<AppCo
 					networkIds: [],
 					resourceId: '',
 					windowsDriveLetters: [],
+					temporaryFolderPath: '',
 				},
 				workforceURL: null,
 			},

apps/appcontainer-node/packages/generic/src/appContainer.ts

@@ -300,6 +300,9 @@ export class AppContainer {
 				this.config.appContainer.worker.windowsDriveLetters
 					? `--windowsDriveLetters=${this.config.appContainer.worker.windowsDriveLetters?.join(';')}`
 					: '',
+				this.config.appContainer.worker.temporaryFolderPath
+					? `--temporaryFolderPath=${this.config.appContainer.worker.temporaryFolderPath}`
+					: '',
 				this.config.appContainer.worker.costMultiplier
 					? `--costMultiplier=${this.config.appContainer.worker.costMultiplier}`
 					: '',

shared/packages/api/src/appContainer.ts

@@ -22,6 +22,7 @@ export interface AppContainerConfig {
 		resourceId: string
 		networkIds: string[]
 		windowsDriveLetters: WorkerAgentConfig['windowsDriveLetters']
+		temporaryFolderPath: WorkerAgentConfig['temporaryFolderPath']
 		costMultiplier: number
 		considerCPULoad: number | null
 		failurePeriodLimit: number

shared/packages/api/src/config.ts

@@ -143,6 +143,11 @@ const workerArguments = defineArguments({
 		default: process.env.WORKER_WINDOWS_DRIVE_LETTERS || 'X;Y;Z',
 		describe: 'Which Windows Drive letters can be used to map shares. ("X;Y;Z") ',
 	},
+	temporaryFolderPath: {
+		type: 'string',
+		default: process.env.WORKER_TEMPORARY_FOLDER_PATH || '',
+		describe: 'A temporary, local file path where the worker can store temporary artifacts',
+	},
 	resourceId: {
 		type: 'string',
 		default: process.env.WORKER_NETWORK_ID || 'default',
@@ -240,6 +245,11 @@ const appContainerArguments = defineArguments({
 		default: process.env.WORKER_WINDOWS_DRIVE_LETTERS || 'X;Y;Z',
 		describe: 'Which Windows Drive letters can be used to map shares. ("X;Y;Z") ',
 	},
+	temporaryFolderPath: {
+		type: 'string',
+		default: process.env.WORKER_TEMPORARY_FOLDER_PATH || '',
+		describe: 'A temporary, local file path where the worker can store temporary artifacts',
+	},
 	costMultiplier: {
 		type: 'number',
 		default: process.env.WORKER_COST_MULTIPLIER || 1,
@@ -470,6 +480,7 @@ export async function getWorkerConfig(): Promise<WorkerConfig> {
 			resourceId: argv.resourceId,
 			networkIds: argv.networkIds ? argv.networkIds.split(';') : [],
 			windowsDriveLetters: argv.windowsDriveLetters ? argv.windowsDriveLetters.split(';') : [],
+			temporaryFolderPath: argv.temporaryFolderPath ? argv.temporaryFolderPath : undefined,
 			costMultiplier:
 				(typeof argv.costMultiplier === 'string' ? parseFloat(argv.costMultiplier) : argv.costMultiplier) || 1,
 			considerCPULoad:
@@ -514,6 +525,7 @@ export async function getAppContainerConfig(): Promise<AppContainerProcessConfig
 				resourceId: argv.resourceId,
 				networkIds: argv.networkIds ? argv.networkIds.split(';') : [],
 				windowsDriveLetters: argv.windowsDriveLetters ? argv.windowsDriveLetters.split(';') : [],
+				temporaryFolderPath: argv.temporaryFolderPath ? argv.temporaryFolderPath : undefined,
 				costMultiplier:
 					(typeof argv.costMultiplier === 'string' ? parseFloat(argv.costMultiplier) : argv.costMultiplier) ||
 					1,

shared/packages/api/src/worker.ts

@@ -70,6 +70,9 @@ export interface WorkerAgentConfig {
 	 * Example: ['X', 'Y', 'Z']
 	 */
 	windowsDriveLetters?: string[]
+
+	/** A temporary, local file path where the worker can store temporary artifacts */
+	temporaryFolderPath?: string
 }
 export type ReturnTypeDoYouSupportPackageContainer =
 	| {

shared/packages/worker/src/worker/accessorHandlers/__tests__/lib.ts

@@ -10,6 +10,7 @@ export class PassiveTestWorker extends BaseWorker {
 					workerId: protectString('test'),
 					sourcePackageStabilityThreshold: 0,
 					windowsDriveLetters: ['X', 'Y', 'Z'],
+					temporaryFolderPath: undefined,
 				},
 				location: {
 					// localComputerId?: string
@@ -62,4 +63,7 @@ export class PassiveTestWorker extends BaseWorker {
 	async setupPackageContainerMonitors(): Promise<any> {
 		throw new Error('Method not implemented.')
 	}
+	getTemporaryFolderPath(): string {
+		throw new Error('Method not implemented.')
+	}
 }

shared/packages/worker/src/worker/worker.ts

@@ -146,6 +146,9 @@ export abstract class BaseWorker {
 		}
 	}
 
+	/** Returns a local file path to a temporary folder */
+	abstract getTemporaryFolderPath(localPath?: string): string
+
 	private _accessorTemporaryCache: {
 		[accessorType: string]: {
 			[key: string]: {

shared/packages/worker/src/worker/workers/genericWorker/genericWorker.ts

@@ -151,4 +151,18 @@ export class GenericWorker extends BaseWorker {
 	): Promise<SetupPackageContainerMonitorsResult> {
 		return PackageContainerExpHandler.setupPackageContainerMonitors(packageContainer, this)
 	}
+
+	private hasEnsuredTemporaryFolderPath = new Set<string>()
+	getTemporaryFolderPath(localPath = ''): string {
+		const tempBasePath =
+			this.agentAPI.config.temporaryFolderPath ||
+			(process.platform === 'win32' ? 'C:\\temp\\package-manager' : '/tmp/package-manager')
+
+		const tempPath = path.join(tempBasePath, localPath)
+		if (!this.hasEnsuredTemporaryFolderPath.has(tempPath)) {
+			this.hasEnsuredTemporaryFolderPath.add(tempPath)
+			fs.mkdirSync(tempPath, { recursive: true })
+		}
+		return tempPath
+	}
 }

tests/internal-tests/src/__tests__/lib/setupEnv.ts

@@ -80,6 +80,7 @@ export const defaultTestConfig: SingleAppConfig = {
 		resourceId: '',
 		networkIds: [],
 		windowsDriveLetters: ['X', 'Y', 'Z'],
+		temporaryFolderPath: undefined,
 		sourcePackageStabilityThreshold: 0, // Disabling this to speed up the tests
 		costMultiplier: 1,
 		considerCPULoad: null,
@@ -104,6 +105,7 @@ export const defaultTestConfig: SingleAppConfig = {
 			resourceId: '',
 			networkIds: [],
 			windowsDriveLetters: ['X', 'Y', 'Z'],
+			temporaryFolderPath: undefined,
 			costMultiplier: 1,
 			considerCPULoad: null,
 			failurePeriod: 0,
@@ -274,7 +276,8 @@ export async function prepareTestEnvironment(debugLogging: boolean): Promise<Tes
 				packageId: ExpectedPackageId,
 				packageStatus: Omit<ExpectedPackageStatusAPI.PackageContainerPackageStatus, 'statusChanged'> | null
 			) => {
-				if (debugLogging) console.log('reportPackageContainerPackageStatus', containerId, packageId, packageStatus)
+				if (debugLogging)
+					console.log('reportPackageContainerPackageStatus', containerId, packageId, packageStatus)
 
 				let container = containerStatuses[containerId]
 				if (!container) {