feat: support psg update awaiter timeout

resources/schemas/sfdx-project.schema.json

@@ -730,7 +730,13 @@
                         "additionalProperties": false,
                         "properties": {
                             "adapter": {
-                                "enum": ["mixedContent", "matchingContentFile", "decomposed", "bundle", "default"],
+                                "enum": [
+                                    "mixedContent",
+                                    "matchingContentFile",
+                                    "decomposed",
+                                    "bundle",
+                                    "default"
+                                ],
                                 "type": "string"
                             },
                             "decomposition": {
@@ -1149,6 +1155,18 @@
                     "description": "Disable Entitlement filtering in source package,which skips entitlements that are already in the target org",
                     "default": false
                 },
+              "permissionsetGroupStatusCheckInterval": {
+                "title": "Permission set group status check interval",
+                "type": "integer",
+                "description": "Interval in milliseconds between permission set group update status checks",
+                "default": 60000
+              },
+                "permissionsetGroupTimeout": {
+                    "title": "Permission set group recalculation timeout",
+                    "type": "integer",
+                    "description": "Permission set group recalculation timeout",
+                    "default": false
+                },
                 "disableTransitiveDependencyResolver": {
                     "title": "Disable Transitive Dependency Resolver",
                     "type": "boolean",
@@ -1183,4 +1201,4 @@
             }
         }
     }
-}
+}

src/core/package/packageInstallers/InstallPackage.ts

@@ -98,7 +98,7 @@ export abstract class InstallPackage {
             };
         }
     }
-    
+
     checkPackageDirectoryExists() {
         let absPackageDirectory: string = path.join(this.sfpPackage.sourceDir, this.packageDirectory);
         if (!fs.existsSync(absPackageDirectory)) {
@@ -107,11 +107,14 @@ export abstract class InstallPackage {
     }
 
     private async waitTillAllPermissionSetGroupIsUpdated() {
+        const projectConfig = ProjectConfig.getSFDXProjectConfig(this.sfpPackage.sourceDir);
         try {
             //Package Has Permission Set Group
             let permissionSetGroupUpdateAwaiter: PermissionSetGroupUpdateAwaiter = new PermissionSetGroupUpdateAwaiter(
                 this.connection,
-                this.logger
+                this.logger,
+                projectConfig.plugins.sfp.permissionsetGroupStatusCheckInterval,
+                projectConfig.plugins.sfp.permissionsetGroupTimeout
             );
             await permissionSetGroupUpdateAwaiter.waitTillAllPermissionSetGroupIsUpdated();
         } catch (error) {
@@ -222,15 +225,15 @@ export abstract class InstallPackage {
         if (skipIfPackageInstalled) {
             let installationStatus = await this.sfpOrg.isArtifactInstalledInOrg(this.logger, this.sfpPackage);
             return !installationStatus.isInstalled;
-        } else if(this.sfpPackage.packageType == PackageType.Diff) 
+        } else if(this.sfpPackage.packageType == PackageType.Diff)
         {
           // If diff package, check if there are any changes to be deployed, else skip
            if(!this.sfpPackage.destructiveChanges && this.sfpPackage.metadataCount==0)
-           { 
+           {
             return false;
            }
         }
-        
+
          return true; // Always install packages if skipIfPackageInstalled is false
     }
 
@@ -363,7 +366,7 @@ export abstract class InstallPackage {
 
         let analyzers = AnalyzerRegistry.getAnalyzers();
         for (const analyzer of analyzers) {
-            if(await analyzer.isEnabled(this.sfpPackage, this.logger)) 
+            if(await analyzer.isEnabled(this.sfpPackage, this.logger))
             {
               SFPLogger.log(`Executing ${COLOR_KEY_MESSAGE(analyzer.getName())}`, LoggerLevel.INFO, this.logger);
               this.sfpPackage = await analyzer.analyze(this.sfpPackage,componentSet, this.logger);
@@ -489,7 +492,7 @@ export abstract class InstallPackage {
         deploymentOptions.rollBackOnError = true;
         return deploymentOptions;
     }
-    
+
     private getAStringOfSpecificTestClasses(apexTestClassses: string[]) {
         let specifedTests = apexTestClassses.join();
         return specifedTests;

src/core/permsets/PermissionSetGroupUpdateAwaiter.ts

@@ -6,16 +6,36 @@
 const psGroupQuery = `SELECT Id,MasterLabel,Status FROM PermissionSetGroup WHERE Status IN ('Updating', 'Outdated')`;
 
 export default class PermissionSetGroupUpdateAwaiter {
-    constructor(private connection: Connection, private logger: Logger, private intervalBetweenRepeats = 60000) {}
+    private startTime: number;
+
+    constructor(
+        private connection: Connection,
+        private logger: Logger,
+        private intervalBetweenRepeats = 60000,
+        private timeoutInMs = 30 * 60 * 1000 // Default timeout of 30 minutes
+    ) {
+        this.startTime = Date.now();
+    }
 
     async waitTillAllPermissionSetGroupIsUpdated() {
         SFPLogger.log(
             `Checking status of permission sets group..`,
             LoggerLevel.INFO,
             this.logger
         );
+
         while (true) {
             try {
+                // Check if timeout has been reached
+                if (Date.now() - this.startTime >= this.timeoutInMs) {
+                    SFPLogger.log(
+                        `Timeout of ${this.timeoutInMs/1000} seconds reached. Proceeding with deployment regardless of PermissionSetGroup status`,
+                        LoggerLevel.WARN,
+                        this.logger
+                    );
+                    break;
+                }
+
                 let records = await QueryHelper.query(psGroupQuery, this.connection, false);
                 if (records.length > 0) {
                     SFPLogger.log(

tests/core/permsets/PermissionSetGroupUpdateAwaiter.test.ts

@@ -4,6 +4,7 @@ import { AnyJson } from '@salesforce/ts-types';
 const $$ = new TestContext();
 import PermissionSetGroupUpdateAwaiter from '../../../src/core/permsets/PermissionSetGroupUpdateAwaiter';
 import { expect } from '@jest/globals';
+import ProjectConfig from '../../../src/core/project/ProjectConfig';
 
 describe('Await till permissionsets groups are updated', () => {
     it('should return if all permsets groups are updated', async () => {
@@ -14,6 +15,7 @@ describe('Await till permissionsets groups are updated', () => {
         $$.setConfigStubContents('AuthInfoConfig', {
             contents: await testData.getConfig(),
         });
+        $$.stubAliases({});
 
         let records: AnyJson = {
             records: [],
@@ -26,9 +28,22 @@ describe('Await till permissionsets groups are updated', () => {
             authInfo: await AuthInfo.create({ username: testData.username }),
         });
 
+        // Stub the ProjectConfig.getSFDXProjectConfig method
+        const projectConfig = {
+            plugins: {
+                sfp: {
+                    permissionsetGroupStatusCheckInterval: 6000,
+                    permissionsetGroupTimeout: 60000
+                }
+            }
+        };
+        $$.SANDBOX.stub(ProjectConfig, 'getSFDXProjectConfig').returns(projectConfig);
+
         let permissionSetGroupUpdateAwaiter: PermissionSetGroupUpdateAwaiter = new PermissionSetGroupUpdateAwaiter(
             connection,
-            null
+            null,
+            projectConfig.plugins.sfp.permissionsetGroupStatusCheckInterval,
+            projectConfig.plugins.sfp.permissionsetGroupTimeout
         );
         await expect(permissionSetGroupUpdateAwaiter.waitTillAllPermissionSetGroupIsUpdated()).resolves.toBeUndefined();
     });