Skip to content

fix(updatenotification): fix ref diff parsing for fetch --dry-run #4138

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
khassel merged 1 commit into from
May 3, 2026
+56 −28
Merged

fix(updatenotification): fix ref diff parsing for fetch --dry-run #4138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 22 additions & 14 deletions defaultmodules/updatenotification/git_helper.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,26 @@ class GitHelper {
this.gitResultList = [];
}

getRefRegex (branch) {
return new RegExp(`s*([a-z,0-9]+[.][.][a-z,0-9]+) ${branch}`, "g");
/**
* Extract commit range (<from>..<to>) for the current branch from `git fetch -n --dry-run` output.
* Falls back to `<branch>..origin/<branch>` when no matching update line is found.
* @param {string} fetchOutput fetch dry-run stderr output
* @param {string} currentBranch currently checked local branch
* @returns {string} commit range for rev-list
*/
getRefDiffFromFetchDryRun (fetchOutput, currentBranch) {
const fallbackRefDiff = `${currentBranch}..origin/${currentBranch}`;

for (const line of fetchOutput.split("\n")) {
const columns = line.trim().split(/\s+/);
const [refDiff, branchName] = columns;

if (branchName === currentBranch && refDiff?.includes("..")) {
return refDiff;
}
}

return fallbackRefDiff;
}

async execGit (moduleFolder, ...args) {
Expand Down Expand Up @@ -123,20 +141,10 @@ class GitHelper {
return gitInfo;
}

// Git writes fetch dry-run updates to stderr.
const { stderr } = await this.execGit(repo.folder, "fetch", "-n", "--dry-run");

// example output:
// From https://github.com/MagicMirrorOrg/MagicMirror
// e40ddd4..06389e3 develop -> origin/develop
// here the result is in stderr (this is a git default, don't ask why ...)
const matches = stderr.match(this.getRefRegex(gitInfo.current));

// this is the default if there was no match from "git fetch -n --dry-run".
// Its a fallback because if there was a real "git fetch", the above "git fetch -n --dry-run" would deliver nothing.
let refDiff = `${gitInfo.current}..origin/${gitInfo.current}`;
if (matches && matches[0]) {
refDiff = matches[0];
}
const refDiff = this.getRefDiffFromFetchDryRun(stderr, gitInfo.current);

// get behind with refs
try {
Expand Down
48 changes: 34 additions & 14 deletions tests/unit/functions/updatenotification_spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,26 @@ describe("Updatenotification", () => {
vi.resetAllMocks();
});

describe("getRefDiffFromFetchDryRun", () => {
it("extracts only commit range from matching fetch line", () => {
const fetchOutput = "From github.com:MagicMirrorOrg/MagicMirror\n60e0377..332e429 develop -> origin/develop\n";

expect(gitHelper.getRefDiffFromFetchDryRun(fetchOutput, "develop")).toBe("60e0377..332e429");
});

it("matches branch name exactly", () => {
const fetchOutput = "From github.com:MagicMirrorOrg/MagicMirror\n1111111..2222222 main-feature -> origin/main-feature\n3333333..4444444 main -> origin/main\n";

expect(gitHelper.getRefDiffFromFetchDryRun(fetchOutput, "main")).toBe("3333333..4444444");
});

it("returns fallback range when matching line is missing", () => {
const fetchOutput = "From github.com:MagicMirrorOrg/MagicMirror\n";

expect(gitHelper.getRefDiffFromFetchDryRun(fetchOutput, "develop")).toBe("develop..origin/develop");
});
});

describe("MagicMirror on develop", () => {
const moduleName = "MagicMirror";

Expand All @@ -124,7 +144,7 @@ describe("Updatenotification", () => {
"rev-parse HEAD",
"status -sb",
"fetch -n --dry-run",
"rev-list --ancestry-path --count 60e0377..332e429 develop",
"rev-list --ancestry-path --count 60e0377..332e429",
]
`);
});
Expand Down Expand Up @@ -174,9 +194,9 @@ describe("Updatenotification", () => {
"rev-parse HEAD",
"status -sb",
"fetch -n --dry-run",
"rev-list --ancestry-path --count 60e0377..332e429 master",
"rev-list --ancestry-path --count 60e0377..332e429",
"ls-remote -q --tags --refs",
"rev-list --ancestry-path 60e0377..332e429 master",
"rev-list --ancestry-path 60e0377..332e429",
]
`);
});
Expand All @@ -191,9 +211,9 @@ describe("Updatenotification", () => {
"rev-parse HEAD",
"status -sb",
"fetch -n --dry-run",
"rev-list --ancestry-path --count 60e0377..332e429 master",
"rev-list --ancestry-path --count 60e0377..332e429",
"ls-remote -q --tags --refs",
"rev-list --ancestry-path 60e0377..332e429 master",
"rev-list --ancestry-path 60e0377..332e429",
]
`);
});
Expand Down Expand Up @@ -230,9 +250,9 @@ describe("Updatenotification", () => {
"rev-parse HEAD",
"status -sb",
"fetch -n --dry-run",
"rev-list --ancestry-path --count 60e0377..332e429 master",
"rev-list --ancestry-path --count 60e0377..332e429",
"ls-remote -q --tags --refs",
"rev-list --ancestry-path 60e0377..332e429 master",
"rev-list --ancestry-path 60e0377..332e429",
]
`);
});
Expand All @@ -247,9 +267,9 @@ describe("Updatenotification", () => {
"rev-parse HEAD",
"status -sb",
"fetch -n --dry-run",
"rev-list --ancestry-path --count 60e0377..332e429 master",
"rev-list --ancestry-path --count 60e0377..332e429",
"ls-remote -q --tags --refs",
"rev-list --ancestry-path 60e0377..332e429 master",
"rev-list --ancestry-path 60e0377..332e429",
]
`);
});
Expand Down Expand Up @@ -286,9 +306,9 @@ describe("Updatenotification", () => {
"rev-parse HEAD",
"status -sb",
"fetch -n --dry-run",
"rev-list --ancestry-path --count 60e0377..332e429 master",
"rev-list --ancestry-path --count 60e0377..332e429",
"ls-remote -q --tags --refs",
"rev-list --ancestry-path 60e0377..332e429 master",
"rev-list --ancestry-path 60e0377..332e429",
]
`);
});
Expand All @@ -303,9 +323,9 @@ describe("Updatenotification", () => {
"rev-parse HEAD",
"status -sb",
"fetch -n --dry-run",
"rev-list --ancestry-path --count 60e0377..332e429 master",
"rev-list --ancestry-path --count 60e0377..332e429",
"ls-remote -q --tags --refs",
"rev-list --ancestry-path 60e0377..332e429 master",
"rev-list --ancestry-path 60e0377..332e429",
]
`);
});
Expand Down Expand Up @@ -339,7 +359,7 @@ describe("Updatenotification", () => {
[
"status -sb",
"fetch -n --dry-run",
"rev-list --ancestry-path --count 19f7faf..9d83101 master",
"rev-list --ancestry-path --count 19f7faf..9d83101",
]
`);
});
Expand Down
Loading