Fix OrgsUpdater identifying new releases as old (#516)

* Fix OrgsUpdater picking up new releases as old Pass the releaseWithMatchingHashId to OrgsUpdater instead of determining itself whether is new release Fix branch flag on changelog:generate so that it's not required * Update OrgUpdater tests Co-authored-by: Azlam <[email protected]>
dxatscale · May 10, 2021 · 318415b · 318415b
1 parent 0cc4988
commit 318415b
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 33 deletions.
diff --git a/packages/sfpowerscripts-cli/src/commands/sfpowerscripts/changelog/generate.ts b/packages/sfpowerscripts-cli/src/commands/sfpowerscripts/changelog/generate.ts
@@ -48,7 +48,7 @@ export default class GenerateChangelog extends SfdxCommand {
       description: messages.getMessage('repoUrlFlagDescription')
     }),
     branchname: flags.string({
-      required: true,
+      required: false,
       char: "b",
       description: messages.getMessage('branchNameFlagDescription'),
       deprecated: { messageOverride: "--branchname has been deprecated" },

diff --git a/packages/sfpowerscripts-cli/src/impl/changelog/OrgsUpdater.ts b/packages/sfpowerscripts-cli/src/impl/changelog/OrgsUpdater.ts
@@ -2,32 +2,24 @@ import { ReleaseChangelog, Release, ReleaseId } from "./ReleaseChangelogInterfac
 import lodash = require("lodash");
 
 export default class OrgsUpdater {
-  private isNewRelease: boolean;
-  private releaseWithMatchingHashId: ReleaseId;
   private latestReleaseId: ReleaseId;
+  private idOfReleaseWithMatchingHashId: ReleaseId;
 
   constructor(
     private releaseChangelog: ReleaseChangelog,
     private latestRelease: Release,
-    private org: string
+    private org: string,
+    private releaseWithMatchingHashId: Release
   ) {
-    this.isNewRelease = true;
-    if (releaseChangelog.releases.length > 0) {
-      for (let release of releaseChangelog.releases) {
-        if (release.hashId === latestRelease.hashId) {
-          console.log(`Found previous release with identical hash Id ${release.hashId}`);
-          this.isNewRelease = false;
-          this.releaseWithMatchingHashId = this.convertReleaseToId(release);
-          break;
-        }
-      }
-    }
-
     this.latestReleaseId = this.convertReleaseToId(this.latestRelease);
+
+    if (this.releaseWithMatchingHashId) {
+      this.idOfReleaseWithMatchingHashId = this.convertReleaseToId(this.releaseWithMatchingHashId);
+    }
   }
 
   update(): void {
-    if (this.isNewRelease) {
+    if (!this.idOfReleaseWithMatchingHashId) {
       if (this.releaseChangelog.orgs) {
         let org = this.releaseChangelog.orgs.find((org) => org.name === this.org);
 
@@ -48,36 +40,36 @@ export default class OrgsUpdater {
           let org = this.releaseChangelog.orgs.find((org) => org.name === this.org);
 
           if (org) {
-            let indexOfReleaseToOrg = org.releases.findIndex((orgRelease) => orgRelease.hashId === this.releaseWithMatchingHashId.hashId);
-            if (org.latestRelease.hashId !== this.releaseWithMatchingHashId.hashId) {
+            let indexOfReleaseToOrg = org.releases.findIndex((orgRelease) => orgRelease.hashId === this.idOfReleaseWithMatchingHashId.hashId);
+            if (org.latestRelease.hashId !== this.idOfReleaseWithMatchingHashId.hashId) {
               if ( indexOfReleaseToOrg >= 0 ) {
                 // Update release names in releases to org
-                org.releases[indexOfReleaseToOrg] = this.releaseWithMatchingHashId;
+                org.releases[indexOfReleaseToOrg] = this.idOfReleaseWithMatchingHashId;
               } else {
                 // Add releaseId in releases to org
-                org.releases.push(this.releaseWithMatchingHashId);
+                org.releases.push(this.idOfReleaseWithMatchingHashId);
               }
 
               // Update latest release
-              org.latestRelease = this.releaseWithMatchingHashId;
+              org.latestRelease = this.idOfReleaseWithMatchingHashId;
               org.retryCount = 0;
             } else {
-              if (lodash.isEqual(org.releases[indexOfReleaseToOrg], this.releaseWithMatchingHashId)) {
+              if (lodash.isEqual(org.releases[indexOfReleaseToOrg], this.idOfReleaseWithMatchingHashId)) {
                 org.retryCount++;
               } else {
                 org.retryCount = 0;
               }
 
               // Update releases names in releases to org & latestRelease
-              org.releases[indexOfReleaseToOrg] = this.releaseWithMatchingHashId;
-              org.latestRelease = this.releaseWithMatchingHashId;
+              org.releases[indexOfReleaseToOrg] = this.idOfReleaseWithMatchingHashId;
+              org.latestRelease = this.idOfReleaseWithMatchingHashId;
             }
 
             console.log(`Updating ${this.org} org with`, org.latestRelease.names[org.latestRelease.names.length - 1] + "-" + org.latestRelease.buildNumber + `(${org.retryCount})`);
           } else {
             // new org
-            this.releaseChangelog.orgs.push({ name: this.org, releases: [this.releaseWithMatchingHashId], latestRelease: this.releaseWithMatchingHashId, retryCount: 0 });
-            console.log(`Updating ${this.org} org with`, `${this.releaseWithMatchingHashId.names[this.releaseWithMatchingHashId.names.length - 1]}-${this.releaseWithMatchingHashId.buildNumber}(0)`);
+            this.releaseChangelog.orgs.push({ name: this.org, releases: [this.idOfReleaseWithMatchingHashId], latestRelease: this.idOfReleaseWithMatchingHashId, retryCount: 0 });
+            console.log(`Updating ${this.org} org with`, `${this.idOfReleaseWithMatchingHashId.names[this.idOfReleaseWithMatchingHashId.names.length - 1]}-${this.idOfReleaseWithMatchingHashId.buildNumber}(0)`);
           }
     }
   }

diff --git a/packages/sfpowerscripts-cli/src/impl/changelog/ReleaseChangelogUpdater.ts b/packages/sfpowerscripts-cli/src/impl/changelog/ReleaseChangelogUpdater.ts
@@ -62,7 +62,6 @@ export default class ReleaseChangelogUpdater {
 
       this.releaseChangelog.releases.push(latestRelease);
     } else {
-
       if (!this.containsLatestReleaseName(releaseWithMatchingHashId.names, latestRelease.names[0])) {
         // append latestReleaseName
         releaseWithMatchingHashId.names.push(latestRelease.names[0]);
@@ -73,7 +72,8 @@ export default class ReleaseChangelogUpdater {
       new OrgsUpdater(
         this.releaseChangelog,
         latestRelease,
-        this.org
+        this.org,
+        releaseWithMatchingHashId
       ).update();
     }
 

diff --git a/packages/sfpowerscripts-cli/tests/impl/changelog/OrgUpdater.test.ts b/packages/sfpowerscripts-cli/tests/impl/changelog/OrgUpdater.test.ts
@@ -19,7 +19,8 @@ describe("Given an OrgsUpdater", () => {
     new OrgsUpdater(
       releaseChangelog,
       newRelease,
-      "DEV"
+      "DEV",
+      null
     ).update()
 
     let newReleaseId = convertReleaseToId(newRelease);
@@ -46,7 +47,8 @@ describe("Given an OrgsUpdater", () => {
     new OrgsUpdater(
       releaseChangelog,
       newRelease,
-      "DEV"
+      "DEV",
+      null
     ).update();
 
     let newReleaseId = convertReleaseToId(newRelease);
@@ -92,7 +94,8 @@ describe("Given an OrgsUpdater", () => {
     new OrgsUpdater(
       releaseChangelog,
       oldRelease1,
-      "SIT"
+      "SIT",
+      releaseChangelog.releases[1]
     ).update();
 
     expect(releaseChangelog).toEqual(expectedResult);
@@ -116,7 +119,8 @@ describe("Given an OrgsUpdater", () => {
     new OrgsUpdater(
       releaseChangelog,
       oldRelease2,
-      "DEV"
+      "DEV",
+      releaseChangelog.releases[0]
     ).update();
 
     expect(releaseChangelog).toEqual(expectedResult);