Feature: GitHub sync by Musicminion · Pull Request #27 · ayaka-notes/overleaf-pro

Musicminion · 2026-02-24T03:55:07Z

Description

We Need Github sync, this is a Feature we have been asked for a long time, but need paid on overleaf, not available for server-pro.

Todo

Add proxy for github fetch API (mainland user in China)
Add documents for github sync: https://overleaf-pro.ayaka.space/on-premises/configuration/overleaf-toolkit/github-synchronisation
Add env var to dis-allow github sync
Add support for CE (all in one edition)
Delete sync data after purge project

Env Var:

# Access token encryption settings
# used for encryptionn of github accesstoken
CIPHER_PASSWORD=0123456789ABCDEFG 

# Github Sync Settings
GITHUB_SYNC_ENABLED=true
GITHUB_SYNC_CLIENT_ID=xxxxx
GITHUB_SYNC_CLIENT_SECRET=xxxxxx
GITHUB_SYNC_CALLBACK_URL=http://localhost/github-sync/completeRegistration

Demo

Related issues / Pull Requests

Contributor Agreement

I confirm I have signed the Contributor License Agreement

…e doc

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: fa29536aa2

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

chatgpt-codex-connector · 2026-02-24T04:00:29Z

services/web/modules/github-sync/app/src/GitHubSyncController.mjs

+async function exportProject(req, res){
+
+}


Implement response logic in routed GitHub sync actions

These handlers are mounted in GitHubSyncRouter (/project/:Project_id/github-sync/export, /commits/unmerged, and /merge), but they currently do nothing and never send a response or call next, so requests to these endpoints will hang until timeout instead of returning success/error.

Useful? React with 👍 / 👎.

chatgpt-codex-connector · 2026-02-24T04:00:29Z

services/web/modules/github-sync/app/src/GitHubSyncHandler.mjs

+  const user = await User.findById(userId, 'githubSync.tokenEncrypted').lean()
+
+  if (!user?.githubSync?.tokenEncrypted) {
+    return null


Read OAuth token from credentials collection for sync ops

OAuth linking stores tokens in GitHubSyncUserCredentials via saveGitHubAccessTokenForUser, but getUserPat reads User.githubSync.tokenEncrypted instead; as a result, downstream sync paths that depend on getUserPat (configure/branch listing/push) will report "GitHub not connected" even after a successful OAuth registration.

Useful? React with 👍 / 👎.

chatgpt-codex-connector · 2026-02-24T04:00:29Z

services/web/modules/github-sync/app/src/GitHubSyncController.mjs

+    )
+
+    const ab = await response.arrayBuffer()
+    fs.writeFileSync(fsPath, Buffer.from(ab))


Remove temporary GitHub archive after import finishes

The imported repository zip is written to Settings.path.dumpFolder but never deleted in either success or error paths, so each import leaves a file behind and will steadily consume disk space on the web service over time.

Useful? React with 👍 / 👎.

- add reminder if user has not authorized github - add readme for API document

- fix repeated repo in github error display - add API for checking unmerged commits in github, with frontend dispaly - add commit message table in modal (ToDo: backend code)

- remove sync status for delete project (hard del) - remove branch for unneed sync - add GITHUB_SYNC_ENABLED to control module import

…thub default branch

- update README with Overleaf Pro features and add new screenshot - update GitHub Sync README

Musicminion · 2026-03-03T04:06:30Z

@codex, please review code

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 17c0e85666

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

chatgpt-codex-connector · 2026-03-03T04:12:18Z

services/github-sync/app/js/GitHubSyncHandler.js

+  if (!response.ok) {
+    const errorData = await response.json().catch(() => ({}))
+    logger.error('Failed to diff branches on GitHub', { repoFullName, baseBranch, compareBranch, error: errorData })
+    return []


Propagate compare API failures in branch-diff check

When the GitHub compare call fails (for example token revocation, rate limiting, or transient 5xx), this code logs and returns an empty diff, and mergeToGitHubAndPushback treats an empty diff as “conflict resolved”. That can incorrectly advance sync state as successful even though the branch comparison never succeeded, leaving unresolved changes silently ignored.

Useful? React with 👍 / 👎.

chatgpt-codex-connector · 2026-03-03T04:12:18Z

services/web/modules/github-sync/app/src/GitHubSyncHandler.mjs

+  let gitHubSyncUserCredentials = new GitHubSyncUserCredentials()
+  gitHubSyncUserCredentials.userId = userId
+  gitHubSyncUserCredentials.auth_token_encrypted = tokenEncrypted
+
+  // save tp database


Upsert GitHub credentials instead of always inserting

OAuth completion always creates and saves a new GitHubSyncUserCredentials document for the user; on a second linking attempt for the same account this can fail with a duplicate-key error (or create duplicate rows where indexes are missing), so re-linking after token problems can break instead of rotating the stored token.

Useful? React with 👍 / 👎.

chatgpt-codex-connector · 2026-03-03T04:12:18Z

services/github-sync/app/js/GitHubSyncController.js

+  } catch (err) {
+    res.status(500).json({ error: err.message })
+  }
+  res.status(200).json({ message: 'Merge to GitHub and push back process completed' })


Return after sending the merge error response

In the outer catch, a 500 response is written but execution continues to the trailing 200 response send, which triggers “headers already sent” on any thrown error path. This obscures the original failure and can produce noisy runtime errors during sync failures.

Useful? React with 👍 / 👎.

chatgpt-codex-connector · 2026-03-03T04:12:18Z

services/web/config/settings.defaults.js

+      Path.resolve(
+        __dirname,
+        '../modules/github-sync/frontend/js/components/github-integration-card.tsx'
+      ),


Gate GitHub integration card behind feature enablement

The GitHub integration UI is registered unconditionally here, but the backend router is only mounted when GITHUB_SYNC_ENABLED is true (modules/github-sync/index.mjs). On deployments with the flag off, users still see the card and hit missing endpoints (or a stuck loading modal), so the disable flag does not actually disable the user-facing feature.

Useful? React with 👍 / 👎.

Musicminion · 2026-03-03T16:00:44Z

@codex, please review code.

ps: We don't mind if github-sync is displayed in the frontend, we only remove backend code if not needed.

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 0886af21c0

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

chatgpt-codex-connector · 2026-03-03T16:08:39Z

services/github-sync/app/js/GitHubSyncHandler.js

+    throw new Error(`GitHub API error: ${errorData.message || response.statusText}`)
+  }
+
+  const mergeData = await response.json()


Handle 204 merge responses without JSON parsing

mergeBranchToDefaultBranch unconditionally parses the merge response body as JSON, but GitHub returns 204 No Content when the head is already merged into the base branch. In that case response.json() throws, and mergeToGitHubAndPushback treats it as a merge failure (setting merge_status: 'failure' and unmerged_branch), so users can be incorrectly pushed into a conflict state even though no conflict exists.

Useful? React with 👍 / 👎.

Not possible, we have just called createOrUpdateBranchRef to create a new branch, then, exportChangesToGitHub, now, this branch can be merged absolutely. It can't be merged in the past,

chatgpt-codex-connector · 2026-03-03T16:08:39Z

services/web/modules/github-sync/app/src/GitHubSyncHandler.mjs

+  // test if the token is still valid by making an API call to GitHub
+  const token = await SecretsHelper.decryptAccessToken(credentials.auth_token_encrypted)
+  try {
+    await GitHubApiClient.listRepos(token, { per_page: 1 })


Pass numeric pagination args when checking token validity

getUserGitHubStatus calls GitHubApiClient.listRepos(token, { per_page: 1 }), but listRepos expects positional numeric arguments (pat, page, perPage). This sends page=[object Object] and leaves per_page at its default 100, which can make /user/github-sync/status checks slower and can misclassify valid tokens as invalid if GitHub rejects the malformed page parameter.

Useful? React with 👍 / 👎.

chatgpt-codex-connector · 2026-03-03T16:08:39Z

services/github-sync/app/js/GitHubSyncHandler.js

+  for (const item of tree) {
+    let obj = {
+      name: item.path,
+    }


Filter non-blob tree entries from generated sync file list

generateRespURL emits every node from the Git tree, including directory (type: "tree") entries, as if they were files. The web updater later treats each name as a present file path when computing deletions, so file-to-directory transitions (e.g., foo becoming foo/bar) can leave stale file paths undeleted and cause path conflicts during apply.

Useful? React with 👍 / 👎.

…ty check in getUserGitHubStatus

Musicminion · 2026-03-03T16:34:20Z

@codex, review code again

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: bc23e17936

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

chatgpt-codex-connector · 2026-03-03T16:41:16Z

services/web/modules/github-sync/app/src/GitHubSyncController.mjs

+  if (!projectStatus) {
+    return res.status(400).json({ error: 'Project is not linked to a GitHub repository' })
+  }
+  const ownerId = projectStatus.ownerId


Check project sync enabled before merge flow

getProjectGitHubSyncStatus returns { enabled: false } for unlinked projects, so this if (!projectStatus) guard never fires and the code proceeds with ownerId as undefined. In that case /project/:Project_id/github-sync/merge calls the github-sync service with an invalid user id and returns a 500 instead of the expected “project not linked” client error, which makes unlinked projects hit a broken merge path.

Useful? React with 👍 / 👎.

chatgpt-codex-connector · 2026-03-03T16:41:16Z

services/github-sync/app/js/GitHubSyncHandler.js

+    // treat 404 as no diff.
+    if (errorData.status === '404') {
+      return []


Detect HTTP 404 using response status

The fallback for deleted unmerged branches is intended to treat a compare 404 as “no diff,” but this check inspects errorData.status === '404' instead of response.status. GitHub’s error payload does not reliably provide this string field, so a real 404 still throws and keeps conflict recovery failing even after the branch is removed on GitHub.

Useful? React with 👍 / 👎.

chatgpt-codex-connector · 2026-03-03T16:41:16Z

services/web/config/settings.defaults.js

+    integrationLinkingWidgets: [
+      Path.resolve(
+        __dirname,
+        '../modules/github-sync/frontend/js/components/github-sync-widget.tsx'
+      ),


Gate GitHub UI imports on feature flag

These module imports are always enabled in overleafModuleImports, so GitHub UI surfaces even when GITHUB_SYNC_ENABLED is false. In that configuration the backend router is not mounted, so users still see GitHub actions but hit missing endpoints (for example status/auth routes), which breaks the intended disable switch for this feature.

Useful? React with 👍 / 👎.

…ponse status

Musicminion added 2 commits February 24, 2026 03:49

tmp: A naive github-sync framework

e6df30e

dev: update dev yml for github sync, also added with ldap test, Readm…

fa29536

…e doc

chatgpt-codex-connector bot reviewed Feb 24, 2026

View reviewed changes

Musicminion added 12 commits February 24, 2026 05:59

web: update passport-ldapauth to 3.0.1

a48fef0

optimize: clean unused code and fix unauthorized github reminder

382d914

- add reminder if user has not authorized github - add readme for API document

feat: support import and export for github

8ae6703

github-sync: bug fix and new features:

9d06105

- fix repeated repo in github error display - add API for checking unmerged commits in github, with frontend dispaly - add commit message table in modal (ToDo: backend code)

feature: support github sync with merge API, also frontend code

76654fb

fix: add clean up for github-sync

9c96646

- remove sync status for delete project (hard del) - remove branch for unneed sync - add GITHUB_SYNC_ENABLED to control module import

frontend: optimize import while loading

e17d2c5

fix: use fast-forward to apply changes in overleaf if no update in gi…

9094979

…thub default branch

ce: add github-sync to server-ce

5ababd6

feat: add proxy for github sync

370bf05

fix: proxy import from github-sync

37f8b84

fix: enhance GitHub sync Modal with need-auth modal for new user

7f1a7b7

Musicminion force-pushed the feat-github-sync branch from 229ef49 to 37e03fe Compare March 2, 2026 03:29

docs: update README

ff2527a

- update README with Overleaf Pro features and add new screenshot - update GitHub Sync README

Musicminion force-pushed the feat-github-sync branch from 37e03fe to ff2527a Compare March 2, 2026 03:34

Musicminion added 3 commits March 2, 2026 16:07

fix: refactor GitHub sync module imports to use dynamic loading

dd03d8f

fix: add fetchJson import for GitHub sync in handler

edd28de

github-sync: remove dev router

17c0e85

chatgpt-codex-connector bot reviewed Mar 3, 2026

View reviewed changes

Musicminion added 2 commits March 3, 2026 15:17

ci: add github-sync to dev image

4511f94

fix: improve error handling in GitHub sync and optimize token storage

0886af2

Musicminion self-assigned this Mar 3, 2026

chatgpt-codex-connector bot reviewed Mar 3, 2026

View reviewed changes

fix: filter non-blob items in generateRespURL and update token validi…

bc23e17

…ty check in getUserGitHubStatus

chatgpt-codex-connector bot reviewed Mar 3, 2026

View reviewed changes

Musicminion added 4 commits March 3, 2026 16:51

fix: enhance validation for GitHub sync state and improve error handling

b0c869e

fix: update OLModal properties to disable initialFocus

34f0013

fix: enhance error handling for GitHub branch diffing by checking res…

be50d34

…ponse status

Add Star History section to README

8745430

Musicminion mentioned this pull request Mar 8, 2026

About Git & Github integration yu-i-i/overleaf-cep#141

Closed

M0rtzz mentioned this pull request Mar 13, 2026

Inquiry regarding the merging timeline for recent PRs #35

Open

Conversation

Musicminion commented Feb 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Todo

Env Var:

Demo

Related issues / Pull Requests

Contributor Agreement

Uh oh!

chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

chatgpt-codex-connector bot Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

chatgpt-codex-connector bot Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

chatgpt-codex-connector bot Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

Musicminion commented Mar 3, 2026

Uh oh!

chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

chatgpt-codex-connector bot Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

chatgpt-codex-connector bot Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

chatgpt-codex-connector bot Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

chatgpt-codex-connector bot Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Musicminion commented Mar 3, 2026

Uh oh!

chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

chatgpt-codex-connector bot Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Musicminion Mar 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chatgpt-codex-connector bot Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

chatgpt-codex-connector bot Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Musicminion commented Mar 3, 2026

Uh oh!

chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

chatgpt-codex-connector bot Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

chatgpt-codex-connector bot Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

chatgpt-codex-connector bot Mar 3, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Musicminion commented Feb 24, 2026 •

edited

Loading

Musicminion Mar 3, 2026 •

edited

Loading