feat: log OAuth setup guide if System.AccessToken is undefined (#587)

hayemaxi · web-flow · commit 8dd9a087f7d7 · 2025-01-06T11:52:15.000-05:00
diff --git a/.changes/next-release/Feature-c7b2b19f-87cf-440e-9b21-1f56e1d624b5.json b/.changes/next-release/Feature-c7b2b19f-87cf-440e-9b21-1f56e1d624b5.json
@@ -0,0 +1,4 @@
+{
+	"type": "Feature",
+	"description": "Auth: Add helpful log message if OIDC is used but OAuth is not enabled for the agent."
+}
diff --git a/src/lib/awsConnectionParameters.ts b/src/lib/awsConnectionParameters.ts
@@ -477,7 +477,9 @@ export async function getOIDCToken(connectedService: string): Promise<string> {
     const token = tl.getVariable('System.AccessToken')
 
     if (token == undefined) {
-        throw new Error('System.AccessToken is undefined')
+        throw new Error(
+            'System.AccessToken is undefined. Ensure that you have enabled OAuth token access for your pipeline/agent job: https://learn.microsoft.com/en-us/azure/devops/pipelines/build/variables?view=azure-devops&tabs=classic#systemaccesstoken'
+        )
     }
 
     const authHandler = getHandlerFromToken(token)

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +	"type": "Feature",
 +	"description": "Auth: Add helpful log message if OIDC is used but OAuth is not enabled for the agent."
 +}
Original file line number	Diff line number	Diff line change
`@@ -477,7 +477,9 @@ export async function getOIDCToken(connectedService: string): Promise<string> {`
`477`	`477`	`const token = tl.getVariable('System.AccessToken')`
`478`	`478`
`479`	`479`	`if (token == undefined) {`
`480`		`- throw new Error('System.AccessToken is undefined')`
	`480`	`+ throw new Error(`
	`481`	`+ 'System.AccessToken is undefined. Ensure that you have enabled OAuth token access for your pipeline/agent job: https://learn.microsoft.com/en-us/azure/devops/pipelines/build/variables?view=azure-devops&tabs=classic#systemaccesstoken'`
	`482`	`+ )`
`481`	`483`	`}`
`482`	`484`
`483`	`485`	`const authHandler = getHandlerFromToken(token)`