including new custom objects section

Author: cesarParra

src/core/changelog/__test__/generating-change-log.spec.ts

@@ -1,4 +1,4 @@
-import { UnparsedApexBundle } from '../../shared/types';
+import { UnparsedApexBundle, UnparsedCustomObjectBundle } from '../../shared/types';
 import { ChangeLogPageData, generateChangeLog } from '../generate-change-log';
 import { assertEither } from '../../test-helpers/assert-either';
 import { isSkip } from '../../shared/utils';
@@ -13,7 +13,19 @@ const config = {
   skipIfNoChanges: false,
 };
 
-// TODO: new integration tests here
+export function customObjectGenerator(
+  config: { deploymentStatus: string; visibility: string } = { deploymentStatus: 'Deployed', visibility: 'Public' },
+) {
+  return `
+    <?xml version="1.0" encoding="UTF-8"?>
+    <CustomObject xmlns="http://soap.sforce.com/2006/04/metadata">
+        <deploymentStatus>${config.deploymentStatus}</deploymentStatus>
+        <description>test object for testing</description>
+        <label>MyTestObject</label>
+        <pluralLabel>MyFirstObjects</pluralLabel>
+        <visibility>${config.visibility}</visibility>
+    </CustomObject>`;
+}
 
 describe('when generating a changelog', () => {
   it('should not skip when skipIfNoChanges, even if there are no changes', async () => {
@@ -185,6 +197,21 @@ describe('when generating a changelog', () => {
     });
   });
 
+  describe('that include new custom objects', () => {
+    it('should include a section for new custom objects', async () => {
+      const newObjectSource = customObjectGenerator();
+
+      const oldBundle: UnparsedCustomObjectBundle[] = [];
+      const newBundle: UnparsedCustomObjectBundle[] = [
+        { type: 'customobject', name: 'MyTestObject', content: newObjectSource, filePath: 'MyTestObject.object' },
+      ];
+
+      const result = await generateChangeLog(oldBundle, newBundle, config)();
+
+      assertEither(result, (data) => expect((data as ChangeLogPageData).content).toContain('## New Custom Objects'));
+    });
+  });
+
   describe('that includes new types out of scope', () => {
     it('should not include them', async () => {
       const newClassSource = 'class Test {}';

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

@@ -17,7 +17,7 @@ class CustomFieldMetadataBuilder {
     return {
       type: 'Text',
       type_name: 'customfield',
-      label: 'My Field',
+      label: 'MyField',
       name: 'MyField',
       description: null,
       parentName: 'MyObject',
@@ -173,7 +173,7 @@ describe('when generating a changelog', () => {
           typeName: oldObject.name,
           modifications: [
             {
-              __typename: 'LabelChanged',
+              __typename: 'CustomObjectLabelChanged',
               name: 'NewLabel',
             },
           ],
@@ -224,7 +224,6 @@ describe('when generating a changelog', () => {
         },
       ]);
     });
-    // [] - Lists changed field labels
   });
 
   describe('with enum code', () => {

src/core/changelog/process-changelog.ts

@@ -18,7 +18,7 @@ type ModificationTypes =
   | 'RemovedProperty'
   | 'NewField'
   | 'RemovedField'
-  | 'LabelChanged';
+  | 'CustomObjectLabelChanged';
 
 export type MemberModificationType = {
   __typename: ModificationTypes;
@@ -114,7 +114,7 @@ function getModifiedCustomObjectLabels(typesInBoth: TypeInBoth<CustomObjectMetad
     .filter(({ oldType, newType }) => oldType.label.toLowerCase() !== newType.label.toLowerCase())
     .map(({ newType }) => ({
       typeName: newType.name,
-      modifications: [{ __typename: 'LabelChanged', name: newType.label }],
+      modifications: [{ __typename: 'CustomObjectLabelChanged', name: newType.label }],
     }));
 }
 

src/core/changelog/renderable-changelog.ts

@@ -9,7 +9,7 @@ type NewTypeRenderable = {
   description?: RenderableContent[];
 };
 
-type NewTypeSection<T extends 'class' | 'interface' | 'enum'> = {
+type NewTypeSection<T extends 'class' | 'interface' | 'enum' | 'customobject'> = {
   __type: T;
   heading: string;
   description: string;
@@ -39,19 +39,25 @@ export type RenderableChangelog = {
   newEnums: NewTypeSection<'enum'> | null;
   removedTypes: RemovedTypeSection | null;
   newOrModifiedMembers: NewOrModifiedMembersSection | null;
+  newCustomObjects: NewTypeSection<'customobject'> | null;
+  // todo: removed custom objects
+  // todo: changed custom objects
 };
 
 export function convertToRenderableChangelog(
   changelog: Changelog,
   newManifest: (Type | CustomObjectMetadata)[],
 ): RenderableChangelog {
-  const allNewTypes = changelog.newApexTypes.map(
+  const allNewTypes = [...changelog.newApexTypes, ...changelog.newCustomObjects].map(
     (newType) => newManifest.find((type) => type.name.toLowerCase() === newType.toLowerCase())!,
   );
 
   const newClasses = allNewTypes.filter((type): type is ClassMirror => type.type_name === 'class');
   const newInterfaces = allNewTypes.filter((type): type is InterfaceMirror => type.type_name === 'interface');
   const newEnums = allNewTypes.filter((type): type is EnumMirror => type.type_name === 'enum');
+  const newCustomObjects = allNewTypes.filter(
+    (type): type is CustomObjectMetadata => type.type_name === 'customobject',
+  );
 
   return {
     newClasses:
@@ -93,6 +99,18 @@ export function convertToRenderableChangelog(
             modifications: changelog.newOrModifiedApexMembers.map(toRenderableModification),
           }
         : null,
+    newCustomObjects:
+      newCustomObjects.length > 0
+        ? {
+            __type: 'customobject',
+            heading: 'New Custom Objects',
+            description: 'These custom objects are new.',
+            types: newCustomObjects.map((type) => ({
+              name: type.name,
+              description: type.description ? [type.description] : undefined,
+            })),
+          }
+        : null,
   };
 }
 
@@ -137,7 +155,7 @@ function toRenderableModificationDescription(memberModificationType: MemberModif
       return `New Type: ${memberModificationType.name}`;
     case 'RemovedType':
       return `Removed Type: ${memberModificationType.name}`;
-    case 'LabelChanged':
+    case 'CustomObjectLabelChanged':
       return `Label Changed to ${memberModificationType.name}`;
   }
 }

src/core/changelog/templates/changelog-template.ts

@@ -37,6 +37,18 @@ export const changelogTemplate = `
 {{/each}}
 {{/if}}
 
+{{#if newCustomObjects}}
+## {{newCustomObjects.heading}}
+
+{{newCustomObjects.description}}
+
+{{#each newCustomObjects.types}}
+### {{this.name}}
+
+{{{renderContent this.description}}}
+{{/each}}
+{{/if}}
+
 {{#if removedTypes}}
 ## Removed Types