-
Notifications
You must be signed in to change notification settings - Fork 171
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.
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
copilot: Add an extension point for credentials resolution #1260
Open
ScottGuymer
wants to merge
3
commits into
backstage:main
Choose a base branch
from
philips-forks:copilot/credentials_extenstion_point
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+234
−76
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
'@backstage-community/plugin-copilot-backend': minor | ||
--- | ||
|
||
Added plugin extension point for configuring the credentials provider. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
103 changes: 103 additions & 0 deletions
103
workspaces/copilot/plugins/copilot-backend/src/utils/CopilotCredentialsProvider.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,103 @@ | ||
/* | ||
* Copyright 2024 The Backstage Authors | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
import { Config } from '@backstage/config'; | ||
import { | ||
DefaultGithubCredentialsProvider, | ||
GithubCredentials, | ||
ScmIntegrations, | ||
} from '@backstage/integration'; | ||
|
||
/** | ||
* Information required to access the GitHub API | ||
* | ||
* @public | ||
*/ | ||
export type GithubInfo = { | ||
credentials: GithubCredentials; | ||
apiBaseUrl: string; | ||
enterprise: string; | ||
}; | ||
|
||
/** | ||
* Interface for providing credentials for accessing the copilot API | ||
* | ||
* @public | ||
*/ | ||
export interface CopilotCredentialsProvider { | ||
/** | ||
* Retrieve the credentials required to access the copilot API | ||
* | ||
* @public | ||
*/ | ||
getCredentials(): Promise<GithubInfo>; | ||
} | ||
|
||
export class DefaultCopilotCredentialsProvider | ||
implements CopilotCredentialsProvider | ||
{ | ||
private readonly host: string; | ||
private readonly enterprise: string; | ||
private readonly integrations: ScmIntegrations; | ||
private readonly credentialsProvider: DefaultGithubCredentialsProvider; | ||
|
||
constructor(options: { config: Config }) { | ||
const { config } = options; | ||
|
||
this.integrations = ScmIntegrations.fromConfig(config); | ||
this.credentialsProvider = | ||
DefaultGithubCredentialsProvider.fromIntegrations(this.integrations); | ||
|
||
this.host = config.getString('copilot.host'); | ||
this.enterprise = config.getString('copilot.enterprise'); | ||
|
||
if (!this.host) { | ||
throw new Error('The host configuration is missing from the config.'); | ||
} | ||
|
||
if (!this.enterprise) { | ||
throw new Error( | ||
'The enterprise configuration is missing from the config.', | ||
); | ||
} | ||
} | ||
|
||
async getCredentials(): Promise<GithubInfo> { | ||
const githubConfig = this.integrations.github.byHost(this.host)?.config; | ||
|
||
if (!githubConfig) { | ||
throw new Error( | ||
`GitHub configuration for host "${this.host}" is missing or incomplete.`, | ||
); | ||
} | ||
|
||
const apiBaseUrl = githubConfig.apiBaseUrl ?? 'https://api.github.com'; | ||
|
||
const credentials = await this.credentialsProvider.getCredentials({ | ||
url: apiBaseUrl, | ||
}); | ||
|
||
if (!credentials.headers) { | ||
throw new Error('Failed to retrieve credentials headers.'); | ||
} | ||
|
||
return { | ||
apiBaseUrl, | ||
credentials, | ||
enterprise: this.enterprise, | ||
}; | ||
} | ||
} |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this needs to change to work for most people.
For most users of github they have
github.com
as the host in their integrations config. The code here means that even if they configure github.com in the copilot section it will try to resolve api.github.com and fail (most people would not have this configured in their config)So i thin kthis needs to be
url: host
to make it work for most people.There is also the issue that the integrations config can be done with a github app which would not have access to the enterprise API at all. This is how we have it configured and probably most users of GH will use an app (I'm guessing).
I think that the default here could be to have a specific token in the copilot section as this token is specific to accessing the enterprise API.
@awanlin i know you suggested this change here but im not sure it works in this instance as this enterprise API is a bit specific and i dont think enterprise APIs are used anywhere else that i have seen in backstage (yet).