Lists changed custom object labels.

Author: cesarParra

src/core/changelog/__test__/processing-changelog.spec.ts

@@ -12,12 +12,19 @@ function apexTypeFromRawString(raw: string): Type {
 }
 
 class CustomObjectMetadataBuilder {
+  label: string = 'MyObject';
+
+  withLabel(label: string): CustomObjectMetadataBuilder {
+    this.label = label;
+    return this;
+  }
+
   build(): CustomObjectMetadata {
     return {
       type_name: 'customobject',
       deploymentStatus: 'Deployed',
       visibility: 'Public',
-      label: 'MyObject',
+      label: this.label,
       name: 'MyObject',
       description: null,
       fields: [],
@@ -133,7 +140,27 @@ describe('when generating a changelog', () => {
       expect(changeLog.removedCustomObjects).toEqual([oldObject.name]);
     });
 
-    // [] - Lists changed object labels
+    it('lists changed custom object labels', () => {
+      const oldObject = new CustomObjectMetadataBuilder().withLabel('OldLabel').build();
+      const newObject = new CustomObjectMetadataBuilder().withLabel('NewLabel').build();
+      const oldVersion = { types: [oldObject] };
+      const newVersion = { types: [newObject] };
+
+      const changeLog = processChangelog(oldVersion, newVersion);
+
+      expect(changeLog.customObjectModifications).toEqual([
+        {
+          typeName: oldObject.name,
+          modifications: [
+            {
+              __typename: 'LabelChanged',
+              name: 'NewLabel',
+            },
+          ],
+        },
+      ]);
+    });
+
     // [] - Lists all new fields of an object
     // [] - Lists all removed fields of an object
     // [] - Lists changed field labels

src/core/changelog/process-changelog.ts

@@ -17,7 +17,8 @@ type ModificationTypes =
   | 'NewProperty'
   | 'RemovedProperty'
   | 'NewField'
-  | 'RemovedField';
+  | 'RemovedField'
+  | 'LabelChanged';
 
 export type MemberModificationType = {
   __typename: ModificationTypes;
@@ -35,6 +36,7 @@ export type Changelog = {
   newOrModifiedApexMembers: NewOrModifiedMember[];
   newCustomObjects: string[];
   removedCustomObjects: string[];
+  customObjectModifications: NewOrModifiedMember[];
 };
 
 export function hasChanges(changelog: Changelog): boolean {
@@ -52,6 +54,7 @@ export function processChangelog(oldVersion: VersionManifest, newVersion: Versio
     newOrModifiedApexMembers: getNewOrModifiedApexMembers(oldVersion, newVersion),
     newCustomObjects: getNewCustomObjects(oldVersion, newVersion),
     removedCustomObjects: getRemovedCustomObjects(oldVersion, newVersion),
+    customObjectModifications: getModifiedCustomObjectLabels(oldVersion, newVersion),
   };
 }
 
@@ -95,7 +98,21 @@ function getNewOrModifiedApexMembers(oldVersion: VersionManifest, newVersion: Ve
   );
 }
 
-function getNewOrModifiedEnumValues(typesInBoth: TypeInBoth[]): NewOrModifiedMember[] {
+function getModifiedCustomObjectLabels(
+  oldVersion: VersionManifest,
+  newVersion: VersionManifest,
+): NewOrModifiedMember[] {
+  return pipe(getCustomObjectsInBothVersions(oldVersion, newVersion), (customObjectsInBoth) =>
+    customObjectsInBoth
+      .filter(({ oldType, newType }) => oldType.label.toLowerCase() !== newType.label.toLowerCase())
+      .map(({ newType }) => ({
+        typeName: newType.name,
+        modifications: [{ __typename: 'LabelChanged', name: newType.label }],
+      })),
+  );
+}
+
+function getNewOrModifiedEnumValues(typesInBoth: TypeInBoth<Type>[]): NewOrModifiedMember[] {
   return pipe(
     typesInBoth.filter((typeInBoth) => typeInBoth.oldType.type_name === 'enum'),
     (enumsInBoth) =>
@@ -113,7 +130,7 @@ function getNewOrModifiedEnumValues(typesInBoth: TypeInBoth[]): NewOrModifiedMem
   );
 }
 
-function getNewOrModifiedMethods(typesInBoth: TypeInBoth[]): NewOrModifiedMember[] {
+function getNewOrModifiedMethods(typesInBoth: TypeInBoth<Type>[]): NewOrModifiedMember[] {
   return pipe(
     typesInBoth.filter(
       (typeInBoth) => typeInBoth.oldType.type_name === 'class' || typeInBoth.oldType.type_name === 'interface',
@@ -146,7 +163,7 @@ function getNewOrModifiedMethods(typesInBoth: TypeInBoth[]): NewOrModifiedMember
   );
 }
 
-function getNewOrModifiedClassMembers(typesInBoth: TypeInBoth[]): NewOrModifiedMember[] {
+function getNewOrModifiedClassMembers(typesInBoth: TypeInBoth<Type>[]): NewOrModifiedMember[] {
   return pipe(
     typesInBoth.filter((typeInBoth) => typeInBoth.oldType.type_name === 'class'),
     (classesInBoth) =>
@@ -173,26 +190,40 @@ function getNewOrModifiedClassMembers(typesInBoth: TypeInBoth[]): NewOrModifiedM
   );
 }
 
-type TypeInBoth = {
-  oldType: Type;
-  newType: Type;
+type TypeInBoth<T extends Type | CustomObjectMetadata> = {
+  oldType: T;
+  newType: T;
 };
 
-function getApexTypesInBothVersions(oldVersion: VersionManifest, newVersion: VersionManifest): TypeInBoth[] {
+function getApexTypesInBothVersions(oldVersion: VersionManifest, newVersion: VersionManifest): TypeInBoth<Type>[] {
   return oldVersion.types
     .filter((newType): newType is Type => newType.type_name !== 'customobject')
     .map((oldType) => ({
       oldType,
       newType: newVersion.types.find((newType) => newType.name.toLowerCase() === oldType.name.toLowerCase()),
     }))
-    .filter((type) => type.newType !== undefined) as TypeInBoth[];
+    .filter((type): type is TypeInBoth<Type> => type.newType !== undefined);
+}
+
+function getCustomObjectsInBothVersions(
+  oldVersion: VersionManifest,
+  newVersion: VersionManifest,
+): TypeInBoth<CustomObjectMetadata>[] {
+  return oldVersion.types
+    .filter((newType): newType is CustomObjectMetadata => newType.type_name === 'customobject')
+    .map((oldType) => ({
+      oldType,
+      newType: newVersion.types.find((newType) => newType.name.toLowerCase() === oldType.name.toLowerCase()),
+    }))
+    .filter((type): type is TypeInBoth<CustomObjectMetadata> => type.newType !== undefined);
 }
 
 type NameAware = {
   name: string;
 };
 
 type AreEqualFn<T> = (oldValue: T, newValue: T) => boolean;
+
 function areEqualByName<T extends NameAware>(oldValue: T, newValue: T): boolean {
   return oldValue.name.toLowerCase() === newValue.name.toLowerCase();
 }