feat: enhance org selection and displaying all more org details

Codeneos · Dec 19, 2023 · cfab40e · cfab40e
1 parent c5ea42f
commit cfab40e
Show file tree

Hide file tree

Showing 11 changed files with 53 additions and 31 deletions.
diff --git a/packages/salesforce/src/queryService.ts b/packages/salesforce/src/queryService.ts
@@ -1,9 +1,9 @@
 import { DateTime } from 'luxon';
 import { Logger, injectable, LifecyclePolicy } from '@vlocode/core';
-import { CancellationToken } from '@vlocode/util';
+import { CancellationToken, PropertyAccessor } from '@vlocode/util';
 
 import { SalesforceConnectionProvider } from './connection';
-import { PropertyAccessor, SObjectRecord, Field, FieldType } from './types';
+import { SObjectRecord, FieldType } from './types';
 import { NamespaceService } from './namespaceService';
 import { QueryCache } from './queryCache';
 import { RecordFactory } from './queryRecordFactory';

diff --git a/packages/salesforce/src/recordBatch.ts b/packages/salesforce/src/recordBatch.ts
@@ -1,8 +1,7 @@
 import { LogManager } from '@vlocode/core';
-import { Timer, arrayMapPush, CancellationToken, groupBy } from '@vlocode/util';
+import { Timer, arrayMapPush, CancellationToken, groupBy, AwaitReturnType } from '@vlocode/util';
 import { RecordResult, BatchInfo } from 'jsforce';
 
-import { AwaitReturnType } from './types';
 import { SalesforceSchemaService } from './salesforceSchemaService';
 import { SalesforceConnection } from './connection';
 

diff --git a/packages/salesforce/src/salesforceLookupService.ts b/packages/salesforce/src/salesforceLookupService.ts
@@ -1,6 +1,5 @@
 import { Logger, injectable, LifecyclePolicy } from '@vlocode/core';
-import { asArray, joinLimit, isSalesforceId, CancellationToken, groupBy, Iterable, mapKeys, unique } from '@vlocode/util';
-import { PropertyAccessor } from './types';
+import { asArray, joinLimit, isSalesforceId, CancellationToken, groupBy, Iterable, mapKeys, PropertyAccessor } from '@vlocode/util';
 import { QueryService, QueryResult } from './queryService';
 import { SalesforceSchemaService } from './salesforceSchemaService';
 import { NamespaceService } from './namespaceService';

diff --git a/packages/salesforce/src/salesforceProfile.ts b/packages/salesforce/src/salesforceProfile.ts
@@ -1,5 +1,4 @@
-import { sortProperties, stringEquals, XML } from '@vlocode/util';
-import { ArrayElement } from './types';
+import { ArrayElement, sortProperties, stringEquals, XML } from '@vlocode/util';
 
 export enum SalesforceFieldPermission {
     editable = 'editable',

diff --git a/packages/salesforce/src/salesforceService.ts b/packages/salesforce/src/salesforceService.ts
@@ -1,6 +1,6 @@
 import * as jsforce from 'jsforce';
 import { FileSystem, injectable, Logger } from '@vlocode/core';
-import { cache, evalTemplate, mapAsyncParallel, XML, substringAfter, fileName, Timer, FileSystemUri, CancellationToken, asArray, groupBy, isSalesforceId, spreadAsync, filterUndefined } from '@vlocode/util';
+import { cache, evalTemplate, mapAsyncParallel, XML, substringAfter, fileName, Timer, FileSystemUri, CancellationToken, asArray, groupBy, isSalesforceId, spreadAsync, filterUndefined, PropertyAccessor } from '@vlocode/util';
 
 import { HttpMethod, HttpRequestInfo, SalesforceConnectionProvider } from './connection';
 import { SalesforcePackageBuilder, SalesforcePackageType } from './deploymentPackageBuilder';
@@ -10,7 +10,7 @@ import { SalesforceDeployService } from './salesforceDeployService';
 import { SalesforceLookupService } from './salesforceLookupService';
 import { SalesforceProfile } from './salesforceProfile';
 import { SalesforceSchemaService } from './salesforceSchemaService';
-import { SObjectRecord, PropertyAccessor } from './types';
+import { SObjectRecord } from './types';
 import { MetadataRegistry, MetadataType } from './metadataRegistry';
 import { NamespaceService } from './namespaceService';
 import { SoapClient, SoapDebuggingHeader } from './soapClient';
@@ -173,7 +173,7 @@ export class SalesforceService implements SalesforceConnectionProvider {
         }
         yield* batch.execute(await this.getJsForceConnection(), undefined, cancelToken);
     }
-    
+
     /**
      * Delete one or more records based on a SOQL filter condition. Returns array of deleted record-ids
      * @param type SObject type to delete
@@ -424,12 +424,13 @@ export class SalesforceService implements SalesforceConnectionProvider {
         return this.connectionProvider.getApiVersion();
     }
 
+
     /**
      * Get a list of available API version on the connected server
      */
     public async getApiVersions(count: number = 10) {
         const connection = await this.getJsForceConnection();
-        const version = parseFloat(connection.version);
+        const version = await connection.getMaxApiVersion();
         const versions: string[] = [];
         for (let i = 0; i < count; i++) {
             versions.push((version - i).toFixed(1));

diff --git a/packages/salesforce/src/types/index.ts b/packages/salesforce/src/types/index.ts
@@ -3,4 +3,3 @@ export * from './metadata';
 export * from './sobjectField';
 export * from './sobjectInfo';
 export * from './sobjectRecord';
-export * from './utilityTypes';
diff --git a/packages/salesforce/src/types/utilityTypes.ts b/packages/salesforce/src/types/utilityTypes.ts
diff --git a/packages/util/src/index.ts b/packages/util/src/index.ts
@@ -27,6 +27,7 @@ export * from './sfdx';
 export * from './singleton';
 export * from './string';
 export * from './task';
+export * from './types';
 export * from './timer';
 export * from './transactionalMap';
 export * from './validate';

diff --git a/packages/util/src/sfdx.ts b/packages/util/src/sfdx.ts
@@ -15,7 +15,11 @@ export interface SalesforceAuthResult {
 }
 
 export interface SalesforceOrgInfo extends SalesforceAuthResult {
+    isSandbox: boolean;
+    lastAccessed?: Date;
+    orgName: string;
     alias?: string;
+    aliases: string[];
 }
 
 interface FileSystem {
@@ -220,16 +224,29 @@ export namespace sfdx {
                         continue;
                     }
 
+                    const allAliases = stateAggregator.aliases.getAll(authFields.username);
+
+                    // Find org name from instance URL
+                    const orgNameFromUrl = authFields.instanceUrl
+                        .replace(/^https?:\/\//i, '')
+                        .replace(/(\.sandbox)?(\.my)?.salesforce\.com$/i, '');
+                    const isSandbox = /\.sandbox\./i.test(authFields.instanceUrl) || /test\.salesforce\.com/i.test(authFields.loginUrl ?? '');
+                    const lastAccessed = authFields.instanceApiVersionLastRetrieved ? new Date(authFields.instanceApiVersionLastRetrieved) : undefined;
+
                     yield {
                         orgId: authFields.accessToken.split('!').shift()!,
+                        orgName: orgNameFromUrl,
+                        isSandbox: isSandbox,
+                        lastAccessed: lastAccessed,
                         accessToken: authFields.accessToken,
                         instanceUrl: authFields.instanceUrl,
                         loginUrl: authFields.loginUrl ?? authFields.instanceUrl,
                         username: authFields.username,
                         clientId: authFields.clientId!,
                         clientSecret: authFields.clientSecret,
                         refreshToken: authFields.refreshToken!,
-                        alias: stateAggregator.aliases.get(authFields.username) || undefined
+                        alias: allAliases[0] || undefined,
+                        aliases: allAliases
                     };
                 } catch(err) {
                     logger.warn(`Error while reading SFDX auth for "${username}"`, err);

diff --git a/packages/vscode-extension/src/commands/selectOrgCommand.ts b/packages/vscode-extension/src/commands/selectOrgCommand.ts
@@ -57,9 +57,26 @@ export default class SelectOrgCommand extends CommandBase {
         }
     }
 
-    protected async getAuthorizedOrgs() : Promise<SelectOrgQuickPickItem[]> {
+    private async getAuthorizedOrgs() : Promise<SelectOrgQuickPickItem[]> {
         const orgList = await sfdx.getAllKnownOrgDetails();
-        return orgList.map(orgInfo => ({ label: orgInfo.alias ? `${orgInfo.alias} - ${orgInfo.username}` : orgInfo.username, description: orgInfo.instanceUrl, orgInfo }));
+        return orgList.map(orgInfo => ({
+            label: this.getOrgLabel(orgInfo),
+            description: this.getOrgDescription(orgInfo),
+            orgInfo
+        }));
+    }
+
+    private getOrgDescription(org: SalesforceOrgInfo) {
+        return `${org.orgName} (${org.orgId})`;
+    }
+
+    private getOrgLabel(org: SalesforceOrgInfo) {
+        const prefix = !org.refreshToken ? '$(warning) ' : '';
+        if (org.aliases?.length) {
+            const aliases = [...org.aliases].sort().join(', ');
+            return `${prefix}${aliases} - ${org.username}`;
+        }
+        return `${prefix}${org.username}`;
     }
 
     public async execute() : Promise<void> {
@@ -95,7 +112,7 @@ export default class SelectOrgCommand extends CommandBase {
         }
     }
 
-    protected async authorizeNewOrg() : Promise<SalesforceOrgInfo | undefined> {
+    protected async authorizeNewOrg() : Promise<SalesforceAuthResult | undefined> {
         const flowType = await vscode.window.showQuickPick(this.authFlows,
             { placeHolder: 'Select the authorization flows you want use' });
 
@@ -130,7 +147,7 @@ export default class SelectOrgCommand extends CommandBase {
         }
     }
 
-    protected async authorizeDeviceLogin(options: { instanceUrl: string, alias?: string }) : Promise<SalesforceOrgInfo | undefined> {
+    protected async authorizeDeviceLogin(options: { instanceUrl: string, alias?: string }) : Promise<SalesforceAuthResult | undefined> {
         const authInfo = await this.vlocode.withActivity({
             location: vscode.ProgressLocation.Notification,
             progressTitle: 'Salesforce Device Login',
@@ -181,7 +198,7 @@ export default class SelectOrgCommand extends CommandBase {
         return this.processAuthinfo(authInfo, options);
     }
 
-    protected async authorizeWebLogin(options: { instanceUrl: string, alias?: string }) : Promise<SalesforceOrgInfo | undefined> {
+    protected async authorizeWebLogin(options: { instanceUrl: string, alias?: string }) : Promise<SalesforceAuthResult | undefined> {
         this.logger.log(`Opening '${options.instanceUrl}' in a new browser window`);
         const authInfo = await this.vlocode.withActivity({
             location: vscode.ProgressLocation.Notification,
@@ -194,7 +211,7 @@ export default class SelectOrgCommand extends CommandBase {
         return this.processAuthinfo(authInfo, options);
     }
 
-    private async processAuthinfo(authInfo: SalesforceAuthResult | undefined, options: { instanceUrl: string, alias?: string }): Promise<SalesforceOrgInfo | undefined>{
+    private async processAuthinfo(authInfo: SalesforceAuthResult | undefined, options: { instanceUrl: string, alias?: string }): Promise<SalesforceAuthResult | undefined>{
         if (!authInfo || !authInfo.accessToken) {
             this.logger.error(`Unable to authorize at '${options.instanceUrl}'`);
             void vscode.window.showErrorMessage('Failed to authorize new org, see the log for more details');

diff --git a/packages/vscode-extension/src/lib/commandBase.ts b/packages/vscode-extension/src/lib/commandBase.ts
@@ -32,4 +32,4 @@ export abstract class CommandBase implements Command {
     private getName() : string {
         return this.constructor?.name || 'Command';
     }
-}
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -32,4 +32,4 @@ export abstract class CommandBase implements Command { @@
         private getName() : string {
             return this.constructor?.name || 'Command';
         }
-    }
+    }