chore: refactor common customization logic to a function and update corresponding CONTRIBUTION.md (#1281)

Co-authored-by: Paras <[email protected]>

Author: pras0131

CONTRIBUTING.md

@@ -431,6 +431,20 @@ npm link @aws/language-server-runtimes @aws/language-server-runtimes-types &&
 npm run compile -- --force
 ```
 
+### Customization
+#### Single Profile Customizations
+To request customization information for a selected developer profile, use the `aws/getConfigurationFromServer` LSP extension with the section field set to `aws.q.customizations`.
+
+#### Multiple Profile Customizations
+To request customization information for all valid developer profiles, use the same `aws/getConfigurationFromServer` LSP extension. However, this requires setting the following initialization parameters in the client: 
+1. `initializationOptions.aws.awsClientCapabilities.q.customizationsWithMetadata`
+2. `initializationOptions.aws.awsClientCapabilities.q.developerProfiles`
+
+Both the above-mentioned fields must be set to true.
+
+#### Testing Customizations
+When testing customizations with the minimal VSCode extension, set the `ENABLE_CUSTOMIZATIONS_WITH_METADATA` environment variable to `true` in your launch configuration.
+
 ### Endpoint and region override
 It is possible to override the default region and default endpoint utilized by the AWS SDK clients (e.g. for the Q developer backend api endpoint) when building the capabilities servers.
 

server/aws-lsp-codewhisperer/src/language-server/configuration/qConfigurationServer.ts

@@ -52,6 +52,27 @@ export const QConfigurationServerToken =
         let serverConfigurationProvider: ServerConfigurationProvider
         let enableCustomizationsWithMetadata = false
 
+        const isCustomizationsWithDeveloperProfileEnabled = (): boolean => {
+            return enableCustomizationsWithMetadata && amazonQServiceManager.getEnableDeveloperProfileSupport()
+        }
+
+        const enhancedCustomizationsWithMetadata = async (
+            token: CancellationToken
+        ): Promise<CustomizationWithMetadata[]> => {
+            logging.debug('Using enhanced customizations with metadata')
+
+            // Fetch profiles first
+            const developerProfiles = await serverConfigurationProvider.listAvailableProfiles(token)
+
+            // Then use those profiles to fetch customizations
+            const customizations = await serverConfigurationProvider.listAllAvailableCustomizationsWithMetadata(
+                developerProfiles,
+                token
+            )
+
+            return customizations
+        }
+
         lsp.addInitializer((params: InitializeParams) => {
             // Check for feature flag in client capabilities
             const qCapabilities = params.initializationOptions?.aws?.awsClientCapabilities?.q as
@@ -98,21 +119,8 @@ export const QConfigurationServerToken =
                 try {
                     switch (section) {
                         case Q_CONFIGURATION_SECTION:
-                            if (
-                                enableCustomizationsWithMetadata &&
-                                amazonQServiceManager.getEnableDeveloperProfileSupport()
-                            ) {
-                                logging.debug('Using enhanced customizations with metadata')
-
-                                // Fetch profiles first
-                                developerProfiles = await serverConfigurationProvider.listAvailableProfiles(token)
-
-                                // Then use those profiles to fetch customizations
-                                customizations =
-                                    await serverConfigurationProvider.listAllAvailableCustomizationsWithMetadata(
-                                        developerProfiles,
-                                        token
-                                    )
+                            if (isCustomizationsWithDeveloperProfileEnabled()) {
+                                customizations = await enhancedCustomizationsWithMetadata(token)
                             } else {
                                 ;[customizations, developerProfiles] = await Promise.all([
                                     serverConfigurationProvider.listAvailableCustomizations(),
@@ -126,21 +134,8 @@ export const QConfigurationServerToken =
                                 ? { customizations, developerProfiles }
                                 : { customizations }
                         case Q_CUSTOMIZATIONS_CONFIGURATION_SECTION:
-                            if (
-                                enableCustomizationsWithMetadata &&
-                                amazonQServiceManager.getEnableDeveloperProfileSupport()
-                            ) {
-                                logging.debug('Using enhanced customizations with metadata')
-
-                                // Fetch profiles first
-                                const profiles = await serverConfigurationProvider.listAvailableProfiles(token)
-
-                                // Then use those profiles to fetch customizations
-                                customizations =
-                                    await serverConfigurationProvider.listAllAvailableCustomizationsWithMetadata(
-                                        profiles,
-                                        token
-                                    )
+                            if (isCustomizationsWithDeveloperProfileEnabled()) {
+                                customizations = await enhancedCustomizationsWithMetadata(token)
                             } else {
                                 customizations = await serverConfigurationProvider.listAvailableCustomizations()
                             }