feat: conflict detection UI enhancement

packages/salesforcedx-vscode-core/src/commands/util/postconditionCheckers.ts

@@ -267,7 +267,7 @@ export class ConflictDetectionChecker implements PostconditionChecker<string> {
         )
       );
       results.different.forEach(file => {
-        channelService.appendLine(normalize(file));
+        channelService.appendLine(normalize(file.path));
       });
       channelService.showChannelOutput();
 
@@ -381,7 +381,7 @@ export class TimestampConflictChecker implements PostconditionChecker<string> {
         )
       );
       results.different.forEach(file => {
-        channelService.appendLine(normalize(file));
+        channelService.appendLine(normalize(file.path));
       });
 
       const choice = await notificationService.showWarningModal(

packages/salesforcedx-vscode-core/src/conflict/conflictDetectionService.ts

@@ -21,7 +21,8 @@ import { telemetryService } from '../telemetry';
 import {
   CommonDirDirectoryDiffer,
   DirectoryDiffer,
-  DirectoryDiffResults
+  DirectoryDiffResults,
+  TimestampFileProperties
 } from './directoryDiffer';
 import {
   MetadataCacheCallback,
@@ -42,7 +43,7 @@ export class ConflictDetector {
   private static EMPTY_DIFFS = {
     localRoot: '',
     remoteRoot: '',
-    different: new Set<string>(),
+    different: new Set<TimestampFileProperties>(),
     scannedLocal: 0,
     scannedRemote: 0
   };

packages/salesforcedx-vscode-core/src/conflict/conflictNode.ts

@@ -13,6 +13,8 @@ export type ConflictFile = {
   relPath: string;
   localPath: string;
   remotePath: string;
+  localLastModifiedDate: string | undefined;
+  remoteLastModifiedDate: string | undefined;
 };
 
 export class ConflictNode extends vscode.TreeItem {
@@ -23,11 +25,17 @@ export class ConflictNode extends vscode.TreeItem {
   constructor(
     label: string,
     collapsibleState: vscode.TreeItemCollapsibleState,
-    parent?: ConflictNode
+    parent?: ConflictNode,
+    description?: string | boolean
   ) {
     super(label, collapsibleState);
     this._children = [];
     this._parent = parent;
+    this.description = description;
+  }
+
+  public addChildConflictNode(conflictNode: ConflictNode) {
+    this._children.push(conflictNode);
   }
 
   get conflict() {
@@ -43,7 +51,24 @@ export class ConflictNode extends vscode.TreeItem {
   }
 
   get tooltip() {
-    return this._conflict ? this._conflict.relPath : this.label;
+    if (this._conflict) {
+      let tooltipMessage: string = '';
+      if (this._conflict.remoteLastModifiedDate) {
+        tooltipMessage += nls.localize(
+          'conflict_detect_remote_last_modified_date',
+          `${new Date(this._conflict.remoteLastModifiedDate).toLocaleString()}`
+        );
+      }
+      if (this._conflict.localLastModifiedDate) {
+        tooltipMessage += nls.localize(
+          'conflict_detect_local_last_modified_date',
+          `${new Date(this._conflict.localLastModifiedDate).toLocaleString()}`
+        );
+      }
+      return tooltipMessage;
+    } else {
+      return this.label;
+    }
   }
 }
 

packages/salesforcedx-vscode-core/src/conflict/conflictView.ts

@@ -77,10 +77,12 @@ export class ConflictView {
     diffResults.different.forEach(p => {
       conflicts.push({
         remoteLabel,
-        relPath: p,
-        fileName: path.basename(p),
+        relPath: p.path,
+        fileName: path.basename(p.path),
         localPath: diffResults.localRoot,
-        remotePath: diffResults.remoteRoot
+        remotePath: diffResults.remoteRoot,
+        localLastModifiedDate: p.localLastModifiedDate,
+        remoteLastModifiedDate: p.remoteLastModifiedDate
       } as ConflictFile);
     });
 

packages/salesforcedx-vscode-core/src/conflict/directoryDiffer.ts

@@ -8,8 +8,14 @@
 import * as fs from 'fs';
 import * as path from 'path';
 
+export interface TimestampFileProperties {
+  path: string;
+  localLastModifiedDate?: string | undefined;
+  remoteLastModifiedDate?: string | undefined;
+}
+
 export interface DirectoryDiffResults {
-  different: Set<string>;
+  different: Set<TimestampFileProperties>;
   localRoot: string;
   remoteRoot: string;
   scannedLocal?: number;
@@ -34,7 +40,7 @@ export class CommonDirDirectoryDiffer implements DirectoryDiffer {
     remoteSourcePath: string
   ): DirectoryDiffResults {
     const localSet = this.listFiles(localSourcePath);
-    const different = new Set<string>();
+    const different = new Set<TimestampFileProperties>();
 
     // process remote files to generate differences
     let scannedRemote = 0;
@@ -44,7 +50,9 @@ export class CommonDirDirectoryDiffer implements DirectoryDiffer {
         const file1 = path.join(localSourcePath, stats.relPath);
         const file2 = path.join(remoteSourcePath, stats.relPath);
         if (this.filesDiffer(file1, file2)) {
-          different.add(stats.relPath);
+          different.add({
+            path: stats.relPath
+          });
         }
       }
     });

packages/salesforcedx-vscode-core/src/conflict/timestampConflictDetector.ts

@@ -14,14 +14,15 @@ import {
   PersistentStorageService
 } from './';
 import { diffComponents } from './componentDiffer';
+import { TimestampFileProperties } from './directoryDiffer';
 import { CorrelatedComponent } from './metadataCacheService';
 
 export class TimestampConflictDetector {
   private diffs: DirectoryDiffResults;
   private static EMPTY_DIFFS = {
     localRoot: '',
     remoteRoot: '',
-    different: new Set<string>()
+    different: new Set<TimestampFileProperties>()
   };
 
   constructor() {
@@ -44,10 +45,10 @@ export class TimestampConflictDetector {
     data: CorrelatedComponent[]
   ) {
     const cache = PersistentStorageService.getInstance();
-    const conflicts: Set<string> = new Set<string>();
+    const conflicts: Set<TimestampFileProperties> = new Set<TimestampFileProperties>();
     data.forEach(component => {
-      let lastModifiedInOrg;
-      let lastModifiedInCache;
+      let lastModifiedInOrg: string | undefined;
+      let lastModifiedInCache: string | undefined;
 
       lastModifiedInOrg = component.lastModifiedDate;
       const key = cache.makeKey(component.cacheComponent.type.name, component.cacheComponent.fullName);
@@ -58,7 +59,11 @@ export class TimestampConflictDetector {
           const cachePathRelative = relative(this.diffs.remoteRoot, difference.cachePath);
           const projectPathRelative = relative(this.diffs.localRoot, difference.projectPath);
           if (cachePathRelative === projectPathRelative) {
-            conflicts.add(cachePathRelative);
+            conflicts.add({
+              path: cachePathRelative,
+              localLastModifiedDate: lastModifiedInCache,
+              remoteLastModifiedDate: lastModifiedInOrg
+            });
           }
         });
       }

packages/salesforcedx-vscode-core/src/messages/i18n.ts

@@ -570,6 +570,8 @@ export const messages = {
   conflict_detect_no_differences: 'No differences',
   conflict_detect_diff_title: '%s//%s ↔ local//%s',
   conflict_detect_diff_command_title: 'Compare Files',
+  conflict_detect_remote_last_modified_date: 'Org last modified date: %s \n',
+  conflict_detect_local_last_modified_date: 'Local last sync date: %s',
 
   force_source_diff_text: 'SFDX: Diff File Against Org',
   force_source_diff_components_not_in_org:

packages/salesforcedx-vscode-core/test/vscode-integration/commands/util/postconditionCheckers.test.ts

@@ -33,6 +33,7 @@ import {
   conflictView,
   DirectoryDiffResults
 } from '../../../../src/conflict';
+import { TimestampFileProperties } from '../../../../src/conflict/directoryDiffer';
 import { nls } from '../../../../src/messages';
 import { notificationService } from '../../../../src/notifications';
 import { sfdxCoreSettings } from '../../../../src/settings';
@@ -495,7 +496,7 @@ describe('Postcondition Checkers', () => {
       const response = await postChecker.handleConflicts(
         'manifest.xml',
         'admin@example.com',
-        { different: new Set<string>() } as DirectoryDiffResults
+        { different: new Set<TimestampFileProperties>() } as DirectoryDiffResults
       );
 
       expect(response.type).to.equal('CONTINUE');
@@ -508,10 +509,13 @@ describe('Postcondition Checkers', () => {
     it('Should post a warning and return CancelResponse when conflicts are detected and cancelled', async () => {
       const postChecker = new ConflictDetectionChecker(retrieveMessages);
       const results = {
-        different: new Set<string>([
-          'main/default/objects/Property__c/fields/Broker__c.field-meta.xml',
-          'main/default/aura/auraPropertySummary/auraPropertySummaryController.js'
-        ]),
+        different: new Set<TimestampFileProperties>([
+          {
+            path: 'main/default/objects/Property__c/fields/Broker__c.field-meta.xml'
+          },
+          {
+            path: 'main/default/aura/auraPropertySummary/auraPropertySummaryController.js'
+          }]),
         scannedLocal: 4,
         scannedRemote: 6
       } as DirectoryDiffResults;
@@ -546,7 +550,10 @@ describe('Postcondition Checkers', () => {
     it('Should post a warning and return ContinueResponse when conflicts are detected and overwritten', async () => {
       const postChecker = new ConflictDetectionChecker(retrieveMessages);
       const results = {
-        different: new Set<string>('MyClass.cls')
+        different: new Set<TimestampFileProperties>([
+          {
+            path: 'MyClass.cls'
+          }])
       } as DirectoryDiffResults;
       modalStub.returns(nls.localize('conflict_detect_override'));
 
@@ -566,7 +573,10 @@ describe('Postcondition Checkers', () => {
     it('Should post a warning and return CancelResponse when conflicts are detected and conflicts are shown', async () => {
       const postChecker = new ConflictDetectionChecker(retrieveMessages);
       const results = {
-        different: new Set<string>('MyClass.cls')
+        different: new Set<TimestampFileProperties>([
+          {
+            path: 'MyClass.cls'
+          }])
       } as DirectoryDiffResults;
       modalStub.returns(nls.localize('conflict_detect_show_conflicts'));
 
@@ -655,7 +665,7 @@ describe('Postcondition Checkers', () => {
         const response = await postChecker.handleConflicts(
           'manifest.xml',
           'admin@example.com',
-          { different: new Set<string>() } as DirectoryDiffResults
+          { different: new Set<TimestampFileProperties>() } as DirectoryDiffResults
         );
 
         expect(response.type).to.equal('CONTINUE');
@@ -668,10 +678,17 @@ describe('Postcondition Checkers', () => {
       it('Should post a warning and return CancelResponse when conflicts are detected and cancelled', async () => {
         const postChecker = new TimestampConflictChecker(false, retrieveMessages);
         const results = {
-          different: new Set<string>([
-            'main/default/objects/Property__c/fields/Broker__c.field-meta.xml',
-            'main/default/aura/auraPropertySummary/auraPropertySummaryController.js'
-          ])
+          different: new Set<TimestampFileProperties>([
+            {
+              path: 'main/default/objects/Property__c/fields/Broker__c.field-meta.xml',
+              localLastModifiedDate: 'Yesterday',
+              remoteLastModifiedDate: 'Today'
+            },
+            {
+              path: 'main/default/aura/auraPropertySummary/auraPropertySummaryController.js',
+              localLastModifiedDate: 'Yesterday',
+              remoteLastModifiedDate: 'Today'
+            }])
         } as DirectoryDiffResults;
         modalStub.returns('Cancel');
 
@@ -704,7 +721,12 @@ describe('Postcondition Checkers', () => {
       it('Should post a warning and return ContinueResponse when conflicts are detected and overwritten', async () => {
         const postChecker = new TimestampConflictChecker(false, retrieveMessages);
         const results = {
-          different: new Set<string>('MyClass.cls')
+          different: new Set<TimestampFileProperties>([
+            {
+              path: 'MyClass.cls',
+              localLastModifiedDate: 'Yesterday',
+              remoteLastModifiedDate: 'Today'
+            }])
         } as DirectoryDiffResults;
         modalStub.returns(nls.localize('conflict_detect_override'));
 
@@ -724,7 +746,12 @@ describe('Postcondition Checkers', () => {
       it('Should post a warning and return CancelResponse when conflicts are detected and conflicts are shown', async () => {
         const postChecker = new TimestampConflictChecker(false, retrieveMessages);
         const results = {
-          different: new Set<string>('MyClass.cls')
+          different: new Set<TimestampFileProperties>([
+            {
+              path: 'MyClass.cls',
+              localLastModifiedDate: 'Yesterday',
+              remoteLastModifiedDate: 'Today'
+            }])
         } as DirectoryDiffResults;
         modalStub.returns(nls.localize('conflict_detect_show_conflicts'));
 

packages/salesforcedx-vscode-core/test/vscode-integration/conflict/timestampConflictDetector.test.ts

@@ -15,6 +15,7 @@ import {
   PersistentStorageService
 } from '../../../src/conflict';
 import * as differ from '../../../src/conflict/componentDiffer';
+import { TimestampFileProperties } from '../../../src/conflict/directoryDiffer';
 import { MetadataCacheResult } from '../../../src/conflict/metadataCacheService';
 import { TimestampConflictDetector } from '../../../src/conflict/timestampConflictDetector';
 import { nls } from '../../../src/messages';
@@ -130,9 +131,11 @@ describe('Timestamp Conflict Detector Execution', () => {
       path.normalize('/a/b/c')
     ]);
 
-    expect(results.different).to.have.all.keys(
-      path.normalize('classes/HandlerCostCenter.cls')
-    );
+    expect(results.different).to.eql(new Set([{
+      path: path.normalize('classes/HandlerCostCenter.cls'),
+      localLastModifiedDate: 'Yesteday',
+      remoteLastModifiedDate: 'Today'
+    }]));
   });
 
   it('Should not report differences if the component is only local', async () => {
@@ -164,7 +167,7 @@ describe('Timestamp Conflict Detector Execution', () => {
     expect(executorSpy.callCount).to.equal(1);
     expect(cacheStub.callCount).to.equal(0);
     expect(differStub.callCount).to.equal(0);
-    expect(results.different).to.eql(new Set<string>());
+    expect(results.different).to.eql(new Set<TimestampFileProperties>());
   });
 
   it('Should not report differences if the component is only remote', async () => {
@@ -196,7 +199,7 @@ describe('Timestamp Conflict Detector Execution', () => {
     expect(executorSpy.callCount).to.equal(1);
     expect(cacheStub.callCount).to.equal(0);
     expect(differStub.callCount).to.equal(0);
-    expect(results.different).to.eql(new Set<string>());
+    expect(results.different).to.eql(new Set<TimestampFileProperties>());
   });
 
   it('Should not report differences if the timestamps match', async () => {
@@ -239,7 +242,7 @@ describe('Timestamp Conflict Detector Execution', () => {
     expect(executorSpy.callCount).to.equal(1);
     expect(cacheStub.callCount).to.equal(1);
     expect(differStub.callCount).to.equal(0);
-    expect(results.different).to.eql(new Set<string>());
+    expect(results.different).to.eql(new Set<TimestampFileProperties>());
   });
 
   it('Should not report differences if the files match', async () => {
@@ -303,7 +306,7 @@ describe('Timestamp Conflict Detector Execution', () => {
       path.normalize('/a/b/c')
     ]);
 
-    expect(results.different).to.eql(new Set<string>());
+    expect(results.different).to.eql(new Set<TimestampFileProperties>());
   });
 
   it('Should report an error during conflict detection', async () => {