Adds an 'ide' url parameter for gk.dev links by sergeibbb · Pull Request #4934 · gitkraken/vscode-gitlens

sergeibbb · 2026-01-27T15:17:41Z

Description

Checklist

I have followed the guidelines in the Contributing document
My changes follow the coding style of this project
My changes build without any errors or warnings
My changes have been formatted and linted
My changes include any required corresponding changes to the documentation (including CHANGELOG.md and README.md)
My changes have been rebased and squashed to the minimal number (typically 1) of relevant commits
My changes have a descriptive commit message with a short title, including a Fixes $XXX - or Closes #XXX - prefix to auto-close the issue that your PR addresses

augmentcode · 2026-01-27T16:40:33Z

🤖 Augment PR Summary

Summary: This PR updates gk.dev link generation to include an ide query parameter so gk.dev can identify the originating editor.

Changes:

Makes UrlsProvider.getGkDevUrl async and appends ide=... based on the host app name
Centralizes automatic injection of source=gitlens into gk.dev URLs (removing duplicated/manual additions)
Updates call sites to await the new async URL builder (auth, subscriptions, integrations, launchpad)
Adds getGkDevUrlWithoutIdeArg for cases where ide should be omitted (e.g., drafts)

Technical Notes: The IDE identifier comes from getHostAppName() and defaults to unknown when it can’t be determined.

_{🤖 Was this summary useful? React with 👍 or 👎}

augmentcode

Review completed. 2 suggestions posted.

Comment augment review to trigger a new review at any time.

src/plus/gk/urlsProvider.ts

src/plus/drafts/draftsService.ts

augmentcode

Review completed. No suggestions at this time.

Comment augment review to trigger a new review at any time.

Updates `getGkDevUrl` to asynchronously fetch and include the host IDE (e.g., VS Code) as an `ide` query parameter. It should be used for all register, connect, and upgrade flows. Introduces `getGkDevUrlWithoutIdeArg` for cases where the `ide` parameter is not required, such as draft URLs. Updates all existing call sites to `await` the now-asynchronous `getGkDevUrl` method. Refactors query parameter generation for `source` and `ide` into dedicated helper methods for improved consistency. (#4905, #4934)

Cleans up GitKraken-related URLs by removing the `source=gitlens` query parameter from authentication, referral, and subscription management flows. This parameter is substituted by `getGkDevUrl()` automatically. (#4905, #4934)

ramin-t · 2026-02-02T14:58:22Z

src/plus/gk/urlsProvider.ts

+	async getGkDevUrl(pathSegments?: string | string[], query?: string | URLSearchParams): Promise<string> {
+		const ide = (await getHostAppName()) ?? 'unknown';
+		query = this.provideQueryWithIdeArg(query, ide);
+		query = this.provideQueryWithSourceArg(query);
+		const uri = this.buildGkDevUri(pathSegments, query);
+		return uri.toString(true);
+	}
+
+	getGkDevUrlWithoutIdeArg(pathSegments?: string | string[], query?: string | URLSearchParams): string {


Why do we have two functions? Is there some technical reason we can't make it async in every case and just provide the option in the params to include IDE?

@axosoft-ramint

Yes, you're right.
ViewNode.getUrl supports both async and sync signatures, so I can just update it and it does not require massive changes.

@axosoft-ramint

Done

Updates `getGkDevUrl` to asynchronously fetch and include the host IDE (e.g., VS Code) as an `ide` query parameter. It should be used for all register, connect, and upgrade flows. Introduces `getGkDevUrlWithoutIdeArg` for cases where the `ide` parameter is not required, such as draft URLs. Updates all existing call sites to `await` the now-asynchronous `getGkDevUrl` method. Refactors query parameter generation for `source` and `ide` into dedicated helper methods for improved consistency. (#4905, #4934)

Cleans up GitKraken-related URLs by removing the `source=gitlens` query parameter from authentication, referral, and subscription management flows. This parameter is substituted by `getGkDevUrl()` automatically. (#4905, #4934)

Updates `getGkDevUrl` to asynchronously fetch and include the host IDE (e.g., VS Code) as an `ide` query parameter. It should be used for all register, connect, and upgrade flows. Introduces `getGkDevUrlWithoutIdeArg` for cases where the `ide` parameter is not required, such as draft URLs. Updates all existing call sites to `await` the now-asynchronous `getGkDevUrl` method. Refactors query parameter generation for `source` and `ide` into dedicated helper methods for improved consistency. (#4905, #4934)

Cleans up GitKraken-related URLs by removing the `source=gitlens` query parameter from authentication, referral, and subscription management flows. This parameter is substituted by `getGkDevUrl()` automatically. (#4905, #4934)

Updates `getGkDevUrl` to asynchronously fetch and include the host IDE (e.g., VS Code) as an `ide` query parameter. It should be used for all register, connect, and upgrade flows. Introduces `getGkDevUrlWithoutIdeArg` for cases where the `ide` parameter is not required, such as draft URLs. Updates all existing call sites to `await` the now-asynchronous `getGkDevUrl` method. Refactors query parameter generation for `source` and `ide` into dedicated helper methods for improved consistency. (#4905, #4934)

Cleans up GitKraken-related URLs by removing the `source=gitlens` query parameter from authentication, referral, and subscription management flows. This parameter is substituted by `getGkDevUrl()` automatically. (#4905, #4934)

ramin-t · 2026-02-13T17:52:29Z

@sergeibbb I just got back to this PR after a while off of it, and tried to follow the PR description, the GitHub issue description, and the Jira issue description to understand why this field is needed, and I still do not understand. What would this "ide" parameter encode that's not already a part of the scheme/protocol/completion link encoded in a deep link to GitLens?

sergeibbb · 2026-02-13T19:49:29Z

Hi @axosoft-ramint It is a really good question. I'll ask Trevor.

Possible answers are:

These links do not contain redirect_uri:

These have different argument success_uri and redirect_uri:

So, maybe having one unified argument for all links simplifies handling those on the server.

sergeibbb · 2026-02-13T20:21:23Z

@axosoft-ramint
Here is some explanation: https://gitkraken.atlassian.net/jira/polaris/projects/PLG/ideas/view/9745072?selectedIssue=PLG-163&issueViewSection=comments&focusedCommentId=165957

(Unfortunately Jira has stopped focusing on the linked comment).

sergeibbb · 2026-02-18T16:37:44Z

Hi @axosoft-ramint
Is here anything else that stops us from merging?

Updates `getGkDevUrl` to asynchronously fetch and include the host IDE (e.g., VS Code) as an `ide` query parameter. It should be used for all register, connect, and upgrade flows. Introduces `getGkDevUrlWithoutIdeArg` for cases where the `ide` parameter is not required, such as draft URLs. Updates all existing call sites to `await` the now-asynchronous `getGkDevUrl` method. Refactors query parameter generation for `source` and `ide` into dedicated helper methods for improved consistency. (#4905, #4934)

Cleans up GitKraken-related URLs by removing the `source=gitlens` query parameter from authentication, referral, and subscription management flows. This parameter is substituted by `getGkDevUrl()` automatically. (#4905, #4934)

ramin-t

LGTM after the explanation provided. I suggest confirming that the changelog entry is in the right place before merging, and confirm that always including the ide param in all gkdev urls we use doesn't pose any issues for url flows that are not yet ready for it (as long as it is ignored in those cases, I don't see any harm in including it).

ramin-t · 2026-02-19T19:12:16Z

src/plus/gk/urlsProvider.ts

 		let uri = pathSegments.length ? Uri.joinPath(this.baseGkDevUri, ...pathSegments) : this.baseGkDevUri;

-		query ??= 'source=gitlens';
+		const ide = (await getHostAppName()) ?? 'unknown';


One other thought: are all possible outputs of getHostAppName url-friendly? If we put the string output of that function directly into the query, just confirming we won't have any issues downstream or upstream.

@axosoft-ramint

are all possible outputs of getHostAppName url-friendly?

No, because we can read it from env.appRoot, 'product.json' where everything can be contained.

If we put the string output of that function directly into the query

We should not put directly to the query string we should always wrap it:

??= `source=gitlens&ide=${encodeURIComponent(ide)}`

However if we put it to the query object, it's wrapped automatically:

query = new URLSearchParams(query); query.set('ide', "co=de");

the output is:
ide=co%3Dde

Updates `getGkDevUrl` to asynchronously fetch and include the host IDE (e.g., VS Code) as an `ide` query parameter. It should be used for all register, connect, and upgrade flows. Introduces `getGkDevUrlWithoutIdeArg` for cases where the `ide` parameter is not required, such as draft URLs. Updates all existing call sites to `await` the now-asynchronous `getGkDevUrl` method. Refactors query parameter generation for `source` and `ide` into dedicated helper methods for improved consistency. (#4905, #4934)

Cleans up GitKraken-related URLs by removing the `source=gitlens` query parameter from authentication, referral, and subscription management flows. This parameter is substituted by `getGkDevUrl()` automatically. (#4905, #4934)

Updates `getGkDevUrl` to asynchronously fetch and include the host IDE (e.g., VS Code) as an `ide` query parameter. It should be used for all register, connect, and upgrade flows. Introduces `getGkDevUrlWithoutIdeArg` for cases where the `ide` parameter is not required, such as draft URLs. Updates all existing call sites to `await` the now-asynchronous `getGkDevUrl` method. Refactors query parameter generation for `source` and `ide` into dedicated helper methods for improved consistency. (#4905, #4934)

Cleans up GitKraken-related URLs by removing the `source=gitlens` query parameter from authentication, referral, and subscription management flows. This parameter is substituted by `getGkDevUrl()` automatically. (#4905, #4934)

Updates `getGkDevUrl` to asynchronously fetch and include the host IDE (e.g., VS Code) as an `ide` query parameter. It should be used for all register, connect, and upgrade flows. Introduces `getGkDevUrlWithoutIdeArg` for cases where the `ide` parameter is not required, such as draft URLs. Updates all existing call sites to `await` the now-asynchronous `getGkDevUrl` method. Refactors query parameter generation for `source` and `ide` into dedicated helper methods for improved consistency. (#4905, #4934)

sergeibbb linked an issue Jan 27, 2026 that may be closed by this pull request

Add an 'ide' url parameter for gk.dev links #4905

Closed

2 tasks

sergeibbb marked this pull request as ready for review January 27, 2026 16:35

augmentcode bot reviewed Jan 27, 2026

View reviewed changes

src/plus/gk/urlsProvider.ts Outdated Show resolved Hide resolved

src/plus/drafts/draftsService.ts Outdated Show resolved Hide resolved

sergeibbb force-pushed the 4905-add-ide-parameter-to-gkdev-links branch from 936d004 to 0209c58 Compare January 27, 2026 16:54

sergeibbb marked this pull request as draft January 27, 2026 16:57

sergeibbb marked this pull request as ready for review January 27, 2026 16:57

augmentcode bot reviewed Jan 27, 2026

View reviewed changes

sergeibbb requested review from eamodio, ianhattendorf and ramin-t January 27, 2026 17:32

sergeibbb force-pushed the 4905-add-ide-parameter-to-gkdev-links branch from 0209c58 to d24cb30 Compare January 27, 2026 19:03

ramin-t reviewed Feb 2, 2026

View reviewed changes

sergeibbb force-pushed the 4905-add-ide-parameter-to-gkdev-links branch from d24cb30 to 8d61774 Compare February 2, 2026 16:06

sergeibbb force-pushed the 4905-add-ide-parameter-to-gkdev-links branch from 8d61774 to c7b8c20 Compare February 2, 2026 16:08

sergeibbb force-pushed the 4905-add-ide-parameter-to-gkdev-links branch from c7b8c20 to fdf0658 Compare February 2, 2026 16:15

sergeibbb requested a review from ramin-t February 2, 2026 16:15

sergeibbb force-pushed the 4905-add-ide-parameter-to-gkdev-links branch from fdf0658 to 9fe1042 Compare February 18, 2026 16:53

ramin-t approved these changes Feb 19, 2026

View reviewed changes

ramin-t reviewed Feb 19, 2026

View reviewed changes

sergeibbb force-pushed the 4905-add-ide-parameter-to-gkdev-links branch from 9fe1042 to 1e94c73 Compare February 23, 2026 17:30

sergeibbb added 2 commits February 23, 2026 18:31

Removes redundant 'source' query parameters

05b8bb2

Cleans up GitKraken-related URLs by removing the `source=gitlens` query parameter from authentication, referral, and subscription management flows. This parameter is substituted by `getGkDevUrl()` automatically. (#4905, #4934)

sergeibbb force-pushed the 4905-add-ide-parameter-to-gkdev-links branch from 1e94c73 to 05b8bb2 Compare February 23, 2026 17:31

sergeibbb merged commit b8ebfd3 into main Feb 23, 2026
6 checks passed

sergeibbb deleted the 4905-add-ide-parameter-to-gkdev-links branch February 23, 2026 17:42

Conversation

sergeibbb commented Jan 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

augmentcode bot commented Jan 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

augmentcode bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

augmentcode bot left a comment

Choose a reason for hiding this comment

Uh oh!

ramin-t Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

sergeibbb Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

sergeibbb Feb 2, 2026

Choose a reason for hiding this comment

Uh oh!

ramin-t commented Feb 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sergeibbb commented Feb 13, 2026

Uh oh!

sergeibbb commented Feb 13, 2026

Uh oh!

sergeibbb commented Feb 18, 2026

Uh oh!

ramin-t left a comment

Choose a reason for hiding this comment

Uh oh!

ramin-t Feb 19, 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!

sergeibbb Feb 23, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

sergeibbb commented Jan 27, 2026 •

edited

Loading

augmentcode bot commented Jan 27, 2026 •

edited

Loading

ramin-t commented Feb 13, 2026 •

edited

Loading

ramin-t Feb 19, 2026 •

edited

Loading