🐛 Copilot: Not reading the App token

[skeletonz28]

Workspace

copilot

📜 Description

We have set out our config to read the GitHub App tokens as part of our setup
This has always been working for our Backstage application
Yet when we installed this plugin, it complains that it cannot find a token
The understanding is that it would read the application and use that to auth
The only difference in how we implement it is using a file as reference, but this shouldn't be an issue

integrations:
github:
- host: github.com
apiBaseUrl: https://api.github.com
apps:
- $include: gh-rnd.yaml
clientId: {cID}
clientSecret: {cs}
allowedInstallationOwners:
-rnd

The include file has the required fields:

appId: {appid}
clientId: {cid}
clientSecret: {cs}
webhookSecret: some-secret
privateKey: |
{pk}
org: {org}
installationId: {iid}

As mentioned, this setup works perfectly within the main application of Backstage
Yet when promoting the CoPilot plugin, the app fails stating there is no PAT available

👍 Expected behavior

It should use the GitHub application token

👎 Actual Behavior with Screenshots

On a local, while debugging. Same as in our RnD

ForwardedError: Plugin 'copilot' startup failed; caused by Error: Enterprise API for copilot only works with "classic PAT" tokens. No token is configured for "github.com" in the config.
[1] at (/Users/github/backstage-application/node_modules/@backstage/backend-app-api/src/wiring/BackendInitializer.ts:392:21)
[1] at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
[1] at (/Users/github/backstage-application/node_modules/@backstage/backend-app-api/src/wiring/BackendInitializer.ts:391:13)
[1] ... 3 lines matching cause stack trace ...
[1] at BackstageBackend.start (/Users/github/backstage-application/node_modules/@backstage/backend-app-api/src/wiring/BackstageBackend.ts:38:11) {
[1] cause: Error: Enterprise API for copilot only works with "classic PAT" tokens. No token is configured for "github.com" in the config.
[1] at Object.getCopilotConfig (/Users/github/backstage-application/node_modules/@backstage-community/plugin-copilot-backend/src/utils/GithubUtils.ts:52:11)
[1] at Function.fromConfig (/Users/github/backstage-application/node_modules/@backstage-community/plugin-copilot-backend/src/client/GithubClient.ts:52:18)
[1] at createRouter (/Users/github/backstage-application/node_modules/@backstage-community/plugin-copilot-backend/src/service/router.ts:126:34)
[1] at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
[1] at Object.init (/Users/github/backstage-application/node_modules/@backstage-community/plugin-copilot-backend/src/plugin.ts:40:11)
[1] at (/Users/github/backstage-application/node_modules/@backstage/backend-app-api/src/wiring/BackendInitializer.ts:391:13)
[1] at async Promise.allSettled (index 23)
[1] at BackendInitializer.#doStart (/Users/github/backstage-application/node_modules/@backstage/backend-app-api/src/wiring/BackendInitializer.ts:331:21)
[1] at BackendInitializer.start (/Users/github/backstage-application/node_modules/@backstage/backend-app-api/src/wiring/BackendInitializer.ts:245:5)
[1] at BackstageBackend.start (/Users/github/backstage-application/node_modules/@backstage/backend-app-api/src/wiring/BackstageBackend.ts:38:11)
[1] }

👟 Reproduction steps

In integrations config, use the includes for the app auth, and remove user and token for the PAT

📃 Provide the context for the Bug.

Pasted in actual behaviour
Can provide more if needed

👀 Have you spent some time to check if this bug has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct

Are you willing to submit PR?

No, I don't have time to work on this right now

[henrikedegrd]

From what I see, you are missing the "token" property in your config.
Since the api does not work with a Github App or fine-graded PAT:s if you are using and enterprise.

So you need to add a classic personal access token and provide that in the config:
https://github.com/backstage/community-plugins/blob/main/workspaces/copilot/plugins/copilot-backend/README.md#how-to-configure-token-scopes

your included file should have:
token: <YOUR_PAT_GOES_HERE>

[skeletonz28]

Forgive me, but in that very page, it states you can use a GitHub app, which negates the need for using a PAT

[henrikedegrd]

Forgive me, but in that very page, it states you can use a GitHub app, which negates the need for using a PAT

Yes, but not for Enterprises; Generate a Personal Access Token (PAT) (Entperise only supports "classic" PAT tokens)

[skeletonz28]

Alright. Is there a way we can disable the enterprise and only show the org metrics?
I see commenting out the config for copilot is not working as I thought it would

copilot:
scheduler:
frequency:
hours: 2
timeout:
minutes: 2
initialDelay:
seconds: 15
host: github.com

enterprise: {ghEnt}

organization: {ghOrg}

[skeletonz28]

Apologies, formatting

 copilot:
  scheduler:
    frequency:
      hours: 2
    timeout:
      minutes: 2
    initialDelay:
      seconds: 15
  host: github.com
  # enterprise: {ghEnt}
  organization: {ghOrg}

Shouldn't this then allow the no-PAT in the integrations? I see it still wants the PAT

[henrikedegrd]

Yes, that would allow you to use a Github APP. The error you got however indicates that you have specified that you are using a enterprise in your copilot-config

[skeletonz28]

Alright cool
I had to check all the configs and have removed the option for Enterprise
It is now using the app for auth for the Org, which is what I wanted, and the Ent option is "disabled" for us
Thanks for clearing this up

[04kash]

Hey @skeletonz28 are we good to close this issue?

[skeletonz28]

Hi, yes thanks