feat: warning messages when fields are missing in the org

Author: baslu93

messages/connected-objects.upsert.md

@@ -50,3 +50,7 @@ Nothing changed
 # connector.not.found
 
 Connector named %s not found. Create an empty data connection to proceed
+
+# fields.not.found
+
+The following field/s of %s (%s) is/are missing and cannot be updated: %s

src/commands/analytics/connected-objects/upsert.ts

@@ -98,6 +98,8 @@ export default class ConnectedObjectUpsert extends SfCommand<ConnectedObjectUpse
     const progressBar = new Progress(!this.jsonEnabled());
     progressBar.start(total, {}, { format: '%s | {bar} | {value}/{total} Objects' });
 
+    const warnMessages = new Array<string>();
+
     // Create / Update connected-objects
     const resultMap = new Map<string, ConnectedObjectUpsertResult>();
     for (const connectorName of connectorObjectFields.keys()) {
@@ -112,7 +114,12 @@ export default class ConnectedObjectUpsert extends SfCommand<ConnectedObjectUpse
           resultMap.set(objectName, { objectName, isNew: false, connectorName });
         }
         const fieldSet = objectFields.get(dataset.sourceObjectName) as Set<string>;
-        const changedFields = await service.updateReplicatedDatasetFields(dataset.id, fieldSet);
+        const {changedFields, missingFields} = await service.updateReplicatedDatasetFields(dataset.id, fieldSet);
+
+        if(missingFields.length > 0){
+          const message = messages.getMessage('fields.not.found', [objectName, connectorName, missingFields.join(', ')]); 
+          warnMessages.push(message);
+        }
         if (changedFields.length > 0) {
           const item = resultMap.get(dataset.sourceObjectName) as ConnectedObjectUpsertResult;
           item.fields = changedFields;
@@ -124,6 +131,15 @@ export default class ConnectedObjectUpsert extends SfCommand<ConnectedObjectUpse
     }
     progressBar.stop();
 
+    if(warnMessages.length > 0){
+      if(!flags.json){
+        warnMessages[warnMessages.length -1] += '\n'; // Last warning line break 
+      }
+      for(const warnMessage of warnMessages){
+        this.warn(warnMessage);
+      }
+    }
+
     const result: ConnectedObjectUpsertResult[] = Array.from(resultMap.values()).filter(
       (x) => x.fields && x.fields.length > 0
     );

src/dataConnectionHelper.ts

@@ -1,5 +1,5 @@
 import { Connection } from '@salesforce/core';
-import { GetDataConnectors, GetReplicatedDatasets, PostReplicatedDataset, ReplicatedDataset } from './modules/upsert';
+import { ChangedAndMissingFields, GetDataConnectors, GetReplicatedDatasets, PostReplicatedDataset, ReplicatedDataset } from './modules/upsert';
 import { GetReplicatedDatasetFields } from './modules/upsert';
 
 export class DataConnectionHelper {
@@ -35,19 +35,27 @@ export class DataConnectionHelper {
     return result;
   }
 
-  public async updateReplicatedDatasetFields(datasetId: string, repositoryFieldSet: Set<string>): Promise<string[]> {
+  public async updateReplicatedDatasetFields(datasetId: string, repositoryFieldSet: Set<string>): Promise<ChangedAndMissingFields> {
     const replicatedDatasetFieldsObject = await this.getReplicatedDatasetFields(datasetId);
-    const result = new Array<string>();
+    const changedFields = new Array<string>();
+    const orgFieldSet = new Set<string>();
     for (const field of replicatedDatasetFieldsObject.fields) {
+      orgFieldSet.add(field.name);
       if (repositoryFieldSet?.has(field.name) && field.skipped) {
         field.skipped = false;
-        result.push(field.name);
+        changedFields.push(field.name);
       }
     }
-    if (result.length > 0) {
+    if (changedFields.length > 0) {
       await this.patchReplicatedDatasetFields(datasetId, replicatedDatasetFieldsObject);
     }
-    return result;
+    const missingFields = new Array<string>();
+    for (const field of Array.from(repositoryFieldSet)){
+      if(!orgFieldSet.has(field)){
+        missingFields.push(field);
+      }
+    }
+    return {changedFields, missingFields};
   }
 
   private async getReplicatedDatasetFields(datasetId: string): Promise<GetReplicatedDatasetFields> {

src/modules/upsert.d.ts

@@ -80,3 +80,8 @@ export type GetDataConnectors = {
   dataConnectors: DataConnector[];
   url: string;
 };
+
+export type ChangedAndMissingFields = {
+  changedFields: string[];
+  missingFields: string[];
+}

test/commands/analytics/connected-objects/upsert.nut.ts

@@ -1,8 +1,12 @@
 import * as path from 'path';
 import { expect } from 'chai';
 import { TestSession, execCmd } from '@salesforce/cli-plugins-testkit';
+import { Messages } from '@salesforce/core';
 import ConnectedObjectUpsertResult from '../../../../src/commands/analytics/connected-objects/upsert';
 
+Messages.importMessagesDirectory(__dirname);
+const messages = Messages.loadMessages('plugin-analytics-connected-objects', 'connected-objects.upsert');
+
 describe('analytics connected-objects upsert NUTs', () => {
   let session: TestSession;
   let defaultUsername: string | undefined;
@@ -37,12 +41,13 @@ describe('analytics connected-objects upsert NUTs', () => {
     ]);
   });
 
-  it('should evaluate multiple recipes and upsert the respective connected-objects', () => {
+  it('should evaluate multiple recipes and upsert the respective connected-objects (warn: 1 extra field found)', () => {
     const name = 'Simple_Recipe,Complex_Recipe';
     const command = `analytics connected-objects upsert --recipe-names ${name} -o ${defaultUsername} --json`;
-    const result = execCmd<ConnectedObjectUpsertResult[]>(command, { ensureExitCode: 0, cli: 'sf' }).jsonOutput?.result;
-    expect(result).to.deep.equal([
-      {
+    const output = execCmd<ConnectedObjectUpsertResult[]>(command, { ensureExitCode: 0, cli: 'sf' }).jsonOutput;
+    expect(output).to.deep.equal({
+      status: 0,
+      result: [{
         connectorName: 'SFDC_LOCAL',
         objectName: 'User',
         isNew: false,
@@ -68,7 +73,10 @@ describe('analytics connected-objects upsert NUTs', () => {
         isNew: true,
         fields: ['Id', 'Name'],
         fieldsCount: 2,
-      },
-    ]);
+      }],
+      warnings: [
+        messages.getMessage('fields.not.found', [ 'User', 'SFDC_LOCAL' , 'Extra__c'])
+      ]
+    });
   });
 });

test/commands/analytics/connected-objects/upsert.test.ts

@@ -11,18 +11,15 @@ import { PostReplicatedDataset } from '../../../../src/modules/upsert';
 import { MetadataBuilder } from '../../../../src/metadataBuilder';
 import ConnectedObjectUpsert from '../../../../src/commands/analytics/connected-objects/upsert';
 import {
-  createReplicatedDateset,
-  getDataConnectors,
-  getEmptyReplicatedDataset,
-  getReplicatedDatasetFields,
-  getReplicatedDatasets,
+  createReplicatedDateset, getDataConnectors, getEmptyReplicatedDataset, getReplicatedDatasetFields, getReplicatedDatasets
 } from './mocks/apis';
 import { recipeFields, simpleRecipe } from './mocks/recipes';
 
 describe('analytics recipe run', () => {
   const $$ = new TestContext();
   const testOrg = new MockTestOrgData();
   const config = new Config({ root: resolve(__dirname, '../../../package.json') });
+  const commandParams = ['--target-org', 'test@org.com', '--recipe-names', 'Simple_Recipe'];
 
   beforeEach('prepare session', async () => {
     await $$.stubAuths(testOrg);
@@ -40,50 +37,42 @@ describe('analytics recipe run', () => {
         result = createReplicatedDateset(body.connectorId, body.sourceObjectName);
       } else {
         // Replicated Data Fields API
-        const fieldIsSkipped = new Map([...recipeFields, 'Extra'].map((field) => [field, true]));
+        const fieldIsSkipped = new Map(recipeFields.map((field) => [field, true]));
         result = getReplicatedDatasetFields(fieldIsSkipped);
       }
       return Promise.resolve(result);
     };
   });
 
-  after(async () => {
-    $$.restore();
-  });
-
-  it('should create a new connected-object with all recipe fields (except "Extra"), return a json', async () => {
+  after(async () => { $$.restore(); });
+  
+  it('should mark multiple fields and return a json', async () => {
     stubMethodsInMetadataBuilder($$, simpleRecipe);
-    const cmd = new ConnectedObjectUpsert(
-      ['--target-org', 'test@org.com', '--recipe-names', 'Simple_Recipe', '--json'],
-      config
-    );
+    const cmd = new ConnectedObjectUpsert([...commandParams, '--json'], config);
     const result = await cmd.run();
     expect(result).to.deep.equal([
       {
         objectName: 'User',
         isNew: true,
         fields: recipeFields,
         fieldsCount: recipeFields.length,
-        connectorName: 'SFDC_LOCAL',
-      },
+        connectorName: 'SFDC_LOCAL'
+      }
     ]);
   });
 
-  it('should update a single connected-object with 1 changed fields, return a json', async () => {
+  it('should mark a single field and return a json', async () => {
     $$.SANDBOX.stub(MetadataBuilder.prototype, 'getElements').resolves([simpleRecipe]);
     $$.SANDBOX.stub(DataConnectionHelper.prototype, 'getReplicatedDatasets').resolves(
       getReplicatedDatasets(['User']).replicatedDatasets
     );
-    const fieldIsSkipped = new Map([...recipeFields, 'Extra'].map((field) => [field, false]));
+    const fieldIsSkipped = new Map(recipeFields.map((field) => [field, false]));
     const USERNAME = 'Username';
     fieldIsSkipped.set(USERNAME, true);
     $$.SANDBOX.stub(DataConnectionHelper.prototype, 'getReplicatedDatasetFields' as any).resolves(
       getReplicatedDatasetFields(fieldIsSkipped)
     );
-    const cmd = new ConnectedObjectUpsert(
-      ['--target-org', 'test@org.com', '--recipe-names', 'Simple_Recipe', '--json', '--verbose'],
-      config
-    );
+    const cmd = new ConnectedObjectUpsert([...commandParams, '--json'], config);
     const result = await cmd.run();
     expect(result).to.deep.equal([
       {
@@ -92,39 +81,35 @@ describe('analytics recipe run', () => {
         fields: [USERNAME],
         fieldsCount: 1,
         connectorName: 'SFDC_LOCAL',
-      },
+      }
     ]);
   });
 
-  it('should update a single connected-object with 1 changed field, print result', async () => {
+  it('should mark multiple fields and print result (warn: 1 extra field found)', async () => {
     $$.SANDBOX.stub(MetadataBuilder.prototype, 'getElements').resolves([simpleRecipe]);
     $$.SANDBOX.stub(DataConnectionHelper.prototype, 'getReplicatedDatasets').resolves(
       getReplicatedDatasets(['User']).replicatedDatasets
     );
-    const fieldIsSkipped = new Map([...recipeFields, 'Extra'].map((field) => [field, true]));
+    const fieldIsSkipped = new Map(recipeFields.map((field) => [field, true]));
+    recipeFields.push('Extra__c');
     $$.SANDBOX.stub(DataConnectionHelper.prototype, 'getReplicatedDatasetFields' as any).resolves(
       getReplicatedDatasetFields(fieldIsSkipped)
     );
-    const cmd = new ConnectedObjectUpsert(
-      ['--target-org', 'test@org.com', '--recipe-names', 'Simple_Recipe', '--verbose'],
-      config
-    );
+    const cmd = new ConnectedObjectUpsert([...commandParams, '--verbose'], config);
     await cmd.run();
   });
 
-  it('should make no change and return a json', async () => {
+  it('should make no changes and return a json', async () => {
     $$.SANDBOX.stub(MetadataBuilder.prototype, 'getElements').resolves([simpleRecipe]);
     $$.SANDBOX.stub(DataConnectionHelper.prototype, 'getReplicatedDatasets').resolves(
       getReplicatedDatasets(['User']).replicatedDatasets
     );
-    const fieldIsSkipped = new Map([...recipeFields, 'Extra'].map((field) => [field, false]));
+    const fieldIsSkipped = new Map(recipeFields.map((field) => [field, false]));
+    recipeFields.push('Extra__c');
     $$.SANDBOX.stub(DataConnectionHelper.prototype, 'getReplicatedDatasetFields' as any).resolves(
       getReplicatedDatasetFields(fieldIsSkipped)
     );
-    const cmd = new ConnectedObjectUpsert(
-      ['--target-org', 'test@org.com', '--recipe-names', 'Simple_Recipe', '--json', '--verbose'],
-      config
-    );
+    const cmd = new ConnectedObjectUpsert([...commandParams, '--json', '--verbose'], config);
     const result = await cmd.run();
     expect(result).to.lengthOf(0);
   });