feat: sync customObj when their fields sync

Author: mshanemc

package.json

@@ -27,7 +27,7 @@
     "test": "sf-test --require ts-node/register",
     "test:nuts": "nyc mocha \"**/*.nut.ts\" --slow 4500 --timeout 600000 --parallel",
     "test:nuts:commands": "nyc mocha \"**/commands/*.nut.ts\" --slow 4500 --timeout 600000 --parallel",
-    "test:nuts:commands:basics": "nyc mocha \"**/commands/basics.nut.ts\" --slow 4500 --timeout 600000 --parallel"
+    "test:nuts:commands:basics": "nyc mocha \"**/commands/basics.nut.ts\" --slow 4500 --timeout 600000"
   },
   "keywords": [
     "force",

src/shared/metadataKeys.ts

@@ -7,26 +7,37 @@
 import { RemoteSyncInput } from './types';
 import { getMetadataKey } from './remoteSourceTrackingService';
 
+// LWC can have child folders (ex: dynamic templates like /templates/noDataIllustration.html
+const pathAfterFullName = (fileResponse: RemoteSyncInput): string =>
+  fileResponse && fileResponse.filePath
+    ? fileResponse.filePath.substr(fileResponse.filePath.indexOf(fileResponse.fullName))
+    : '';
+
 // handle all "weird" type/name translation between SourceMember and SDR FileResponse
+// These get de-duplicated in a set later
 export const getMetadataKeyFromFileResponse = (fileResponse: RemoteSyncInput): string[] => {
-  // LWC can have child folders (ex: dynamic templates like LightningComponentResource__errorPanel/templates/noDataIllustration.html
-  const pathAfterFullName = (): string =>
-    fileResponse && fileResponse.filePath
-      ? fileResponse.filePath.substr(fileResponse.filePath.indexOf(fileResponse.fullName))
-      : '';
-
+  // also create an element for the parent object
+  if (fileResponse.type === 'CustomField' && fileResponse.filePath) {
+    const splits = fileResponse.filePath.split('/');
+    const objectFolderIndex = splits.indexOf('objects');
+    return [
+      getMetadataKey('CustomObject', splits[objectFolderIndex + 1]),
+      getMetadataKey(fileResponse.type, fileResponse.fullName),
+    ];
+  }
   // Aura/LWC need to have both the bundle level and file level keys
-  // These get de-duplicated in a set later
   if (fileResponse.type === 'LightningComponentBundle' && fileResponse.filePath) {
     return [
-      `LightningComponentResource__${pathAfterFullName()}`,
+      `LightningComponentResource__${pathAfterFullName(fileResponse)}`,
       getMetadataKey(fileResponse.type, fileResponse.fullName),
     ];
   }
   if (fileResponse.type === 'AuraDefinitionBundle' && fileResponse.filePath) {
-    return [`AuraDefinition__${pathAfterFullName()}`, getMetadataKey(fileResponse.type, fileResponse.fullName)];
+    return [
+      `AuraDefinition__${pathAfterFullName(fileResponse)}`,
+      getMetadataKey(fileResponse.type, fileResponse.fullName),
+    ];
   }
-
   // standard key
   return [getMetadataKey(fileResponse.type, fileResponse.fullName)];
 };

src/shared/remoteSourceTrackingService.ts

@@ -150,7 +150,7 @@ export class RemoteSourceTrackingService extends ConfigFile<RemoteSourceTracking
     try {
       await super.init();
     } catch (err) {
-      throw SfdxError.wrap(err);
+      throw SfdxError.wrap(err as Error);
     }
 
     const contents = this.getTypedContents();
@@ -169,9 +169,15 @@ export class RemoteSourceTrackingService extends ConfigFile<RemoteSourceTracking
         await this.write();
       } catch (e) {
         // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
-        if (e.name === 'INVALID_TYPE' && e.message.includes("sObject type 'SourceMember' is not supported")) {
+        if (
+          e instanceof SfdxError &&
+          e.name === 'INVALID_TYPE' &&
+          e.message.includes("sObject type 'SourceMember' is not supported")
+        ) {
           // non-source-tracked org E.G. DevHub or trailhead playground
           this.isSourceTrackedOrg = false;
+        } else {
+          throw e;
         }
       }
     }
@@ -195,20 +201,22 @@ export class RemoteSourceTrackingService extends ConfigFile<RemoteSourceTracking
     // this can be super-repetitive on a large ExperienceBundle where there is an element for each file but only one Revision for the entire bundle
     // any item in an aura/LWC bundle needs to represent the top (bundle) level and the file itself
     // so we de-dupe via a set
-    [...new Set(elements.map((element) => getMetadataKeyFromFileResponse(element)).flat())].map((metadataKey) => {
-      const revision = revisions[metadataKey];
-      if (revision && revision.lastRetrievedFromServer !== revision.serverRevisionCounter) {
-        if (!quiet) {
-          this.logger.debug(
-            `Syncing ${metadataKey} revision from ${revision.lastRetrievedFromServer} to ${revision.serverRevisionCounter}`
-          );
+    Array.from(new Set(elements.map((element) => getMetadataKeyFromFileResponse(element)).flat())).map(
+      (metadataKey) => {
+        const revision = revisions[metadataKey];
+        if (revision && revision.lastRetrievedFromServer !== revision.serverRevisionCounter) {
+          if (!quiet) {
+            this.logger.debug(
+              `Syncing ${metadataKey} revision from ${revision.lastRetrievedFromServer} to ${revision.serverRevisionCounter}`
+            );
+          }
+          revision.lastRetrievedFromServer = revision.serverRevisionCounter;
+          this.setMemberRevision(metadataKey, revision);
+        } else {
+          this.logger.warn(`found no matching revision for ${metadataKey}`);
         }
-        revision.lastRetrievedFromServer = revision.serverRevisionCounter;
-        this.setMemberRevision(metadataKey, revision);
-      } else {
-        this.logger.warn(`found no matching revision for ${metadataKey}`);
       }
-    });
+    );
 
     await this.write();
   }

src/sourceTracking.ts

@@ -64,13 +64,13 @@ export class SourceTracking {
     this.logger = Logger.childFromRoot('SourceTracking');
   }
 
-  public async deployLocalChanges({ overwrite = false, ignoreWarnings = false, wait = 33 }): Promise<void> {
-    // TODO: this is basically the logic for a push
-  }
+  // public async deployLocalChanges({ overwrite = false, ignoreWarnings = false, wait = 33 }): Promise<void> {
+  //   // TODO: this is basically the logic for a push
+  // }
 
-  public async retrieveRemoteChanges(): Promise<void> {
-    // TODO: this is basically the logic for a pull
-  }
+  // public async retrieveRemoteChanges(): Promise<void> {
+  //   // TODO: this is basically the logic for a pull
+  // }
 
   /**
    * Get metadata changes made locally and in the org.
@@ -342,8 +342,8 @@ export class SourceTracking {
       }
     });
     return excludeUnresolvable
-      ? [...new Set(elementMap.values())].filter((changeResult) => changeResult.name && changeResult.type)
-      : [...new Set(elementMap.values())];
+      ? Array.from(new Set(elementMap.values())).filter((changeResult) => changeResult.name && changeResult.type)
+      : Array.from(new Set(elementMap.values()));
   }
 
   public async getConflicts(): Promise<ChangeResult[]> {
@@ -377,7 +377,7 @@ export class SourceTracking {
       });
     });
     // deeply de-dupe
-    return [...conflicts];
+    return Array.from(conflicts);
   }
 
   private ensureRelative(filePath: string): string {

test/nuts/commands/basics.nut.ts

@@ -50,15 +50,17 @@ describe('end-to-end-test for tracking with an org (single packageDir)', () => {
 
       const remoteResult = execCmd<StatusResult[]>('source:status --json --remote', { ensureExitCode: 0 }).jsonOutput
         .result;
-      console.log(remoteResult);
+      // console.log(remoteResult);
       expect(remoteResult.length).to.equal(1);
       expect(remoteResult.some((item) => item.type === 'Profile')).to.equal(true);
+      // expect(remoteResult.some((item) => item.type === 'FieldRestrictionRule')).to.equal(true);
+      // expect(remoteResult.some((item) => item.type === 'Audience')).to.equal(true);
     });
 
     it('can pull the remote profile', () => {
-      const pushResult = execCmd<FileResponse[]>('source:pull --json', { ensureExitCode: 0 }).jsonOutput.result;
-      console.log(pushResult);
-      expect(pushResult.some((item) => item.type === 'Profile')).to.equal(true);
+      const pullResult = execCmd<FileResponse[]>('source:pull --json', { ensureExitCode: 0 }).jsonOutput.result;
+      console.log(pullResult);
+      expect(pullResult.some((item) => item.type === 'Profile')).to.equal(true);
     });
 
     it('sees no local or remote changes', () => {

test/unit/metadataKeys.test.ts

@@ -62,4 +62,19 @@ describe('metadataKeys', () => {
       ]);
     });
   });
+
+  describe('object children', () => {
+    it('creates a key for the object from a field', () => {
+      const fileResponse = {
+        fullName: 'Case.Product__c',
+        type: 'CustomField',
+        state: 'Created',
+        filePath: 'force-app/main/default/objects/Case/fields/Product__c.field-meta.xml',
+      };
+      expect(getMetadataKeyFromFileResponse(fileResponse)).to.deep.equal([
+        'CustomObject__Case',
+        'CustomField__Case.Product__c',
+      ]);
+    });
+  });
 });

tsconfig.json

@@ -3,5 +3,5 @@
   "compilerOptions": {
     "outDir": "./lib"
   },
-  "include": ["src/**/*.ts", "test/unit/metadataKeys.test.ts"]
+  "include": ["src/**/*.ts"]
 }