@salesforce/source-tracking 0.4.2 → 0.4.3

package/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [0.4.3](https://github.com/forcedotcom/source-tracking/compare/v0.4.2...v0.4.3) (2021-11-11)
+
+
+### Features
+
+* emit warnings for types not pulled ([fdeabbf](https://github.com/forcedotcom/source-tracking/commit/fdeabbfb11bb4ba1fd17931adedc49f9cb5ae658))
+
+
+### Bug Fixes
+
+* don't pull remote changes where type isn't in SDR registry ([46250ee](https://github.com/forcedotcom/source-tracking/commit/46250eef09e29dfa0d06af984bbfcc3e88765968))
+* don't pull things not in the registry ([38136bb](https://github.com/forcedotcom/source-tracking/commit/38136bbbf1e44c8e58bc06621957819913273b4e))
+
 ### [0.4.2](https://github.com/forcedotcom/source-tracking/compare/v0.4.1...v0.4.2) (2021-10-28)
 
 ### [0.4.1](https://github.com/forcedotcom/source-tracking/compare/v0.4.0...v0.4.1) (2021-10-28)

package/lib/shared/guards.d.ts

@@ -1,3 +1,4 @@
-import { SourceComponent } from '@salesforce/source-deploy-retrieve';
+import { SourceComponent, MetadataMember } from '@salesforce/source-deploy-retrieve';
 export declare const stringGuard: (input: string | undefined) => input is string;
 export declare const sourceComponentGuard: (input: SourceComponent | undefined) => input is SourceComponent;
+export declare const metadataMemberGuard: (input: MetadataMember | undefined) => input is MetadataMember;

package/lib/shared/guards.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sourceComponentGuard = exports.stringGuard = void 0;
+exports.metadataMemberGuard = exports.sourceComponentGuard = exports.stringGuard = void 0;
 /*
  * Copyright (c) 2020, salesforce.com, inc.
  * All rights reserved.
@@ -16,4 +16,8 @@ const sourceComponentGuard = (input) => {
     return input instanceof source_deploy_retrieve_1.SourceComponent;
 };
 exports.sourceComponentGuard = sourceComponentGuard;
+const metadataMemberGuard = (input) => {
+    return input !== undefined && typeof input.fullName === 'string' && typeof input.type === 'string';
+};
+exports.metadataMemberGuard = metadataMemberGuard;
 //# sourceMappingURL=guards.js.map

package/lib/sourceTracking.d.ts

@@ -21,6 +21,7 @@ export declare class SourceTracking extends AsyncCreatable {
     private packagesDirs;
     private username;
     private logger;
+    private registry;
     private localRepo;
     private remoteSourceTrackingService;
     private forceIgnore;
@@ -107,6 +108,7 @@ export declare class SourceTracking extends AsyncCreatable {
      */
     private populateTypesAndNames;
     private getLocalStatusRows;
+    private registrySupportsType;
     /**
      * uses SDR to translate remote metadata records into local file paths
      */

package/lib/sourceTracking.js

@@ -28,6 +28,7 @@ const functions_1 = require("./shared/functions");
 class SourceTracking extends kit_1.AsyncCreatable {
     constructor(options) {
         super(options);
+        this.registry = new source_deploy_retrieve_1.RegistryAccess();
         this.orgId = options.org.getOrgId();
         this.username = options.org.getUsername();
         this.projectPath = options.project.getPath();
@@ -147,7 +148,10 @@ class SourceTracking extends kit_1.AsyncCreatable {
             await this.ensureRemoteTracking();
             const remoteChanges = await this.remoteSourceTrackingService.retrieveUpdates();
             this.logger.debug('remoteChanges', remoteChanges);
-            const filteredChanges = remoteChanges.filter(remoteFilterByState[options.state]);
+            const filteredChanges = remoteChanges
+                .filter(remoteFilterByState[options.state])
+                // skip any remote types not in the registry.  Will emit node warnings
+                .filter((rce) => this.registrySupportsType(rce.type));
             if (options.format === 'ChangeResult') {
                 return filteredChanges.map((change) => (0, remoteSourceTrackingService_1.remoteChangeElementToChangeResult)(change));
             }
@@ -456,6 +460,13 @@ class SourceTracking extends kit_1.AsyncCreatable {
         results = results.concat(localAdds.flatMap((item) => this.localChangesToOutputRow(item, 'add')), localModifies.flatMap((item) => this.localChangesToOutputRow(item, 'modify')), localDeletes.flatMap((item) => this.localChangesToOutputRow(item, 'delete')));
         return results;
     }
+    registrySupportsType(type) {
+        if (this.registry.findType((metadataType) => metadataType.name === type)) {
+            return true;
+        }
+        process.emitWarning(`Unable to find type ${type} in registry`);
+        return false;
+    }
     /**
      * uses SDR to translate remote metadata records into local file paths
      */
@@ -464,12 +475,19 @@ class SourceTracking extends kit_1.AsyncCreatable {
             return [];
         }
         this.logger.debug('populateFilePaths for change elements', elements);
-        // component set generated from an array of ComponentLike from all the remote changes
-        const remoteChangesAsComponentLike = elements.map((element) => ({
-            type: element === null || element === void 0 ? void 0 : element.type,
-            fullName: element === null || element === void 0 ? void 0 : element.name,
-        }));
-        const remoteChangesAsComponentSet = new source_deploy_retrieve_1.ComponentSet(remoteChangesAsComponentLike);
+        // component set generated from an array of MetadataMember from all the remote changes
+        // but exclude the ones that aren't in the registry
+        const remoteChangesAsMetadataMember = elements
+            .map((element) => {
+            if (typeof element.type === 'string' && typeof element.name === 'string') {
+                return {
+                    type: element.type,
+                    fullName: element.name,
+                };
+            }
+        })
+            .filter(guards_1.metadataMemberGuard);
+        const remoteChangesAsComponentSet = new source_deploy_retrieve_1.ComponentSet(remoteChangesAsMetadataMember);
         this.logger.debug(` the generated component set has ${remoteChangesAsComponentSet.size.toString()} items`);
         if (remoteChangesAsComponentSet.size < elements.length) {
             // iterate the elements to see which ones didn't make it into the component set

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@salesforce/source-tracking",
   "description": "API for tracking local and remote Salesforce metadata changes",
-  "version": "0.4.2",
+  "version": "0.4.3",
   "author": "Salesforce",
   "license": "BSD-3-Clause",
   "main": "lib/index.js",
@@ -85,7 +85,7 @@
     "sinon": "^10.0.0",
     "ts-node": "^10.1.0",
     "ts-prune": "^0.10.0",
-    "typescript": "^4.3.5"
+    "typescript": "^4.4.4"
   },
   "oclif": {
     "commands": "./lib/commands",