refactor: recipe folder renamed and dataflows update

Author: baslu93

src/dataConnectionHelper.ts src/apiHelper.tssrc/dataConnectionHelper.ts renamed to src/apiHelper.ts

@@ -2,7 +2,7 @@ import { Connection } from '@salesforce/core';
 import { ChangedAndMissingFields, GetDataConnectors, GetReplicatedDatasets, PostReplicatedDataset, ReplicatedDataset } from './modules/upsert';
 import { GetReplicatedDatasetFields } from './modules/upsert';
 
-export class DataConnectionHelper {
+export class ApiHelper {
   public static readonly REPLICATED_DATASETS_API = '/wave/replicatedDatasets';
   public static readonly DATA_CONNECTORS_API = '/wave/dataConnectors';
   private conn: Connection;
@@ -14,7 +14,7 @@ export class DataConnectionHelper {
   public async getConnectors(): Promise<Map<string, string>> {
     const response = new Map<string, string>();
     const getDataConnectorsResponse = await this.conn.requestGet<GetDataConnectors>(
-      DataConnectionHelper.DATA_CONNECTORS_API
+      ApiHelper.DATA_CONNECTORS_API
     );
     for (const connector of getDataConnectorsResponse.dataConnectors) {
       response.set(connector.name, connector.id);
@@ -24,14 +24,14 @@ export class DataConnectionHelper {
 
   public async getReplicatedDatasets(): Promise<ReplicatedDataset[]> {
     const replicatedDatasets = await this.conn.requestGet<GetReplicatedDatasets>(
-      DataConnectionHelper.REPLICATED_DATASETS_API
+      ApiHelper.REPLICATED_DATASETS_API
     );
     return replicatedDatasets.replicatedDatasets;
   }
 
   public async createReplicatedDateset(connectorId: string, sourceObjectName: string): Promise<ReplicatedDataset> {
     const body: PostReplicatedDataset = { connectorId, sourceObjectName };
-    const result = await this.conn.requestPost<ReplicatedDataset>(DataConnectionHelper.REPLICATED_DATASETS_API, body);
+    const result = await this.conn.requestPost<ReplicatedDataset>(ApiHelper.REPLICATED_DATASETS_API, body);
     return result;
   }
 
@@ -60,7 +60,7 @@ export class DataConnectionHelper {
 
   private async getReplicatedDatasetFields(datasetId: string): Promise<GetReplicatedDatasetFields> {
     const result = await this.conn.requestGet<GetReplicatedDatasetFields>(
-      `${DataConnectionHelper.REPLICATED_DATASETS_API}/${datasetId}/fields`
+      `${ApiHelper.REPLICATED_DATASETS_API}/${datasetId}/fields`
     );
     return result;
   }
@@ -69,7 +69,7 @@ export class DataConnectionHelper {
     datasetId: string,
     replicatedDatasetFieldsObject: GetReplicatedDatasetFields
   ): Promise<void> {
-    await this.conn.requestPatch<object>(`${DataConnectionHelper.REPLICATED_DATASETS_API}/${datasetId}/fields`, {
+    await this.conn.requestPatch<object>(`${ApiHelper.REPLICATED_DATASETS_API}/${datasetId}/fields`, {
       fields: replicatedDatasetFieldsObject.fields,
     });
   }

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

@@ -2,8 +2,8 @@
 import { SfCommand, Flags, Progress } from '@salesforce/sf-plugins-core';
 import { Messages, SfError } from '@salesforce/core';
 import { blue, bold } from 'chalk';
-import { MetadataBuilder } from '../../../metadataBuilder';
-import { DataConnectionHelper } from '../../../dataConnectionHelper';
+import { MetadataHelper } from '../../../metadataHelper';
+import { ApiHelper } from '../../../apiHelper';
 import { RecipeDefinition, LoadDefinitionNodeParam, ReplicatedDataset } from '../../../modules/upsert';
 import { PrinterHelper } from '../../../printerHelper';
 
@@ -57,11 +57,11 @@ export default class ConnectedObjectUpsert extends SfCommand<ConnectedObjectUpse
   public async run(): Promise<ConnectedObjectUpsertResult[]> {
     const { flags } = await this.parse(ConnectedObjectUpsert);
     const conn = flags['target-org'].getConnection(flags['api-version']);
-    const service = new DataConnectionHelper(conn);
+    const service = new ApiHelper(conn);
 
     // get object and fields from recipes
     const entries = flags.all ? ['WaveRecipe'] : flags['recipe-names']?.map((name) => `WaveRecipe:${name}`);
-    const metadataResolver = new MetadataBuilder(flags['api-version']);
+    const metadataResolver = new MetadataHelper(flags['api-version']);
 
     const recipeDefinitions = await metadataResolver.getElements<RecipeDefinition>(entries ? entries : []);
     if (recipeDefinitions.length === 0) {

src/metadataBuilder.ts src/metadataHelper.tssrc/metadataBuilder.ts renamed to src/metadataHelper.ts

@@ -2,7 +2,7 @@ import * as fs from 'fs';
 import { ComponentSetBuilder } from '@salesforce/source-deploy-retrieve';
 import { SfProject } from '@salesforce/core';
 
-export class MetadataBuilder {
+export class MetadataHelper {
   private apiversion?: string;
 
   public constructor(apiversion?: string) {

test/commands/analytics/connected-objects/mocks/apis.ts

@@ -1,4 +1,4 @@
-import { DataConnectionHelper } from '../../../../../src/dataConnectionHelper';
+import { ApiHelper } from '../../../../../src/apiHelper';
 import { GetDataConnectors, GetReplicatedDatasets, ReplicatedDataset } from '../../../../../src/modules/upsert';
 import { GetReplicatedDatasetFields, ReplicatedDatasetField } from '../../../../../src/modules/upsert';
 
@@ -25,7 +25,7 @@ export function getReplicatedDatasetFields(fieldIsSkipped: Map<string, boolean>)
   for (const fieldName of fieldIsSkipped.keys()) {
     result.push(getReplicatedDatasetField(fieldName, fieldIsSkipped.get(fieldName) as boolean));
   }
-  return { fields: result, url: `${DataConnectionHelper.REPLICATED_DATASETS_API}/0Iu7Z00000001waSAA/fields` };
+  return { fields: result, url: `${ApiHelper.REPLICATED_DATASETS_API}/0Iu7Z00000001waSAA/fields` };
 }
 
 export const getDataConnectors: GetDataConnectors = {

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

@@ -6,9 +6,9 @@ import { TestContext, MockTestOrgData } from '@salesforce/core/lib/testSetup';
 import { ensureJsonMap, AnyJson } from '@salesforce/ts-types';
 import { Config } from '@oclif/core';
 import { ComponentSet, ComponentSetBuilder, LazyCollection, SourceComponent } from '@salesforce/source-deploy-retrieve';
-import { DataConnectionHelper } from '../../../../src/dataConnectionHelper';
+import { ApiHelper } from '../../../../src/apiHelper';
 import { PostReplicatedDataset } from '../../../../src/modules/upsert';
-import { MetadataBuilder } from '../../../../src/metadataBuilder';
+import { MetadataHelper } from '../../../../src/metadataHelper';
 import ConnectedObjectUpsert from '../../../../src/commands/analytics/connected-objects/upsert';
 import {
   createReplicatedDateset, getDataConnectors, getEmptyReplicatedDataset, getReplicatedDatasetFields, getReplicatedDatasets
@@ -28,11 +28,11 @@ describe('analytics recipe run', () => {
       let result = {};
       const requestMap = ensureJsonMap(request);
       const url = requestMap.url as string;
-      if (requestMap.method === 'GET' && url === DataConnectionHelper.REPLICATED_DATASETS_API) {
+      if (requestMap.method === 'GET' && url === ApiHelper.REPLICATED_DATASETS_API) {
         result = getEmptyReplicatedDataset();
-      } else if (requestMap.method === 'GET' && url === DataConnectionHelper.DATA_CONNECTORS_API) {
+      } else if (requestMap.method === 'GET' && url === ApiHelper.DATA_CONNECTORS_API) {
         result = getDataConnectors;
-      } else if (requestMap.method === 'POST' && url === DataConnectionHelper.REPLICATED_DATASETS_API) {
+      } else if (requestMap.method === 'POST' && url === ApiHelper.REPLICATED_DATASETS_API) {
         const body = JSON.parse(requestMap?.body as string) as PostReplicatedDataset;
         result = createReplicatedDateset(body.connectorId, body.sourceObjectName);
       } else {
@@ -47,7 +47,7 @@ describe('analytics recipe run', () => {
   after(async () => { $$.restore(); });
 
   it('should mark multiple fields and return a json', async () => {
-    stubMethodsInMetadataBuilder($$, simpleRecipe);
+    stubMethodsInMetadataHelper($$, simpleRecipe);
     const cmd = new ConnectedObjectUpsert([...commandParams, '--json'], config);
     const result = await cmd.run();
     expect(result).to.deep.equal([
@@ -62,14 +62,14 @@ describe('analytics recipe run', () => {
   });
 
   it('should mark a single field and return a json', async () => {
-    $$.SANDBOX.stub(MetadataBuilder.prototype, 'getElements').resolves([simpleRecipe]);
-    $$.SANDBOX.stub(DataConnectionHelper.prototype, 'getReplicatedDatasets').resolves(
+    $$.SANDBOX.stub(MetadataHelper.prototype, 'getElements').resolves([simpleRecipe]);
+    $$.SANDBOX.stub(ApiHelper.prototype, 'getReplicatedDatasets').resolves(
       getReplicatedDatasets(['User']).replicatedDatasets
     );
     const fieldIsSkipped = new Map(recipeFields.map((field) => [field, false]));
     const USERNAME = 'Username';
     fieldIsSkipped.set(USERNAME, true);
-    $$.SANDBOX.stub(DataConnectionHelper.prototype, 'getReplicatedDatasetFields' as any).resolves(
+    $$.SANDBOX.stub(ApiHelper.prototype, 'getReplicatedDatasetFields' as any).resolves(
       getReplicatedDatasetFields(fieldIsSkipped)
     );
     const cmd = new ConnectedObjectUpsert([...commandParams, '--json'], config);
@@ -86,27 +86,27 @@ describe('analytics recipe run', () => {
   });
 
   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(
+    $$.SANDBOX.stub(MetadataHelper.prototype, 'getElements').resolves([simpleRecipe]);
+    $$.SANDBOX.stub(ApiHelper.prototype, 'getReplicatedDatasets').resolves(
       getReplicatedDatasets(['User']).replicatedDatasets
     );
     const fieldIsSkipped = new Map(recipeFields.map((field) => [field, true]));
     recipeFields.push('Extra__c');
-    $$.SANDBOX.stub(DataConnectionHelper.prototype, 'getReplicatedDatasetFields' as any).resolves(
+    $$.SANDBOX.stub(ApiHelper.prototype, 'getReplicatedDatasetFields' as any).resolves(
       getReplicatedDatasetFields(fieldIsSkipped)
     );
     const cmd = new ConnectedObjectUpsert([...commandParams, '--verbose'], config);
     await cmd.run();
   });
 
   it('should make no changes and return a json', async () => {
-    $$.SANDBOX.stub(MetadataBuilder.prototype, 'getElements').resolves([simpleRecipe]);
-    $$.SANDBOX.stub(DataConnectionHelper.prototype, 'getReplicatedDatasets').resolves(
+    $$.SANDBOX.stub(MetadataHelper.prototype, 'getElements').resolves([simpleRecipe]);
+    $$.SANDBOX.stub(ApiHelper.prototype, 'getReplicatedDatasets').resolves(
       getReplicatedDatasets(['User']).replicatedDatasets
     );
     const fieldIsSkipped = new Map(recipeFields.map((field) => [field, false]));
     recipeFields.push('Extra__c');
-    $$.SANDBOX.stub(DataConnectionHelper.prototype, 'getReplicatedDatasetFields' as any).resolves(
+    $$.SANDBOX.stub(ApiHelper.prototype, 'getReplicatedDatasetFields' as any).resolves(
       getReplicatedDatasetFields(fieldIsSkipped)
     );
     const cmd = new ConnectedObjectUpsert([...commandParams, '--json', '--verbose'], config);
@@ -115,7 +115,7 @@ describe('analytics recipe run', () => {
   });
 });
 
-function stubMethodsInMetadataBuilder(testContext: TestContext, result: unknown): void {
+function stubMethodsInMetadataHelper(testContext: TestContext, result: unknown): void {
   testContext.setConfigStubContents('SfProjectJson', {
     contents: { packageDirectories: [{ path: 'force-app', default: true }], pushPackageDirectoriesSequentially: true },
   });