fix: regex for multiline notes

electron · Oct 22, 2024 · 144725a · 144725a
1 parent b1b021a
commit 144725a
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 1 deletion.
diff --git a/src/note-utils.ts b/src/note-utils.ts
@@ -6,7 +6,7 @@ const debug = d('note-utils');
 
 export const findNoteInPRBody = (body: string): string | null => {
   const onelineMatch = /(?:(?:\r?\n)|^)notes: (.+?)(?:(?:\r?\n)|$)/gi.exec(body);
-  const multilineMatch = /(?:(?:\r?\n)Notes:(?:\r?\n+)((?:\*.+(?:(?:\r?\n)|$))+))/gi.exec(body);
+  const multilineMatch = /(?:(?:\r?\n?)Notes:(?:\r?\n+)((?:\*.+(?:(?:\r?\n)|$))+))/gi.exec(body);
 
   let notes: string | null = null;
   if (onelineMatch && onelineMatch[1]) {

diff --git a/test/note.test.ts b/test/note.test.ts
@@ -80,6 +80,21 @@ describe('comment generation', () => {
 
     expect(comment).toEqual(expect.stringContaining(expected));
   });
+
+  it('can handle a PR body only containing a note', () => {
+    const note = noteUtils.findNoteInPRBody(prBodyWithOnlyNotes);
+    const comment = noteUtils.createPRCommentFromNotes(note);
+    expect(comment).toEqual(expect.stringContaining(constants.NOTES_LEAD));
+
+    const expected = `
+> * Security: backported fix for CVE-2024-7965.
+> * Security: backported fix for CVE-2024-7966.
+> * Security: backported fix for CVE-2024-7967.
+> * Security: backported fix for CVE-2024-8198.
+> * Security: backported fix for CVE-2024-8193.`;
+
+    expect(comment).toEqual(expect.stringContaining(expected));
+  });
 });
 
 /* Test PR Bodies */
@@ -199,3 +214,12 @@ See that PR for details.
 Notes: Fixed an issue where packages could not be selected with <input file="type"> on macOS.
 `;
 /* tslint:enable */
+
+const prBodyWithOnlyNotes = `
+Notes:
+* Security: backported fix for CVE-2024-7965.
+* Security: backported fix for CVE-2024-7966.
+* Security: backported fix for CVE-2024-7967.
+* Security: backported fix for CVE-2024-8198.
+* Security: backported fix for CVE-2024-8193.
+`;