KnpLabs / KnpLabs/php-github-api

Bug Report: downloadLogs() fails with Azure Authentication Error

Open
#1,156 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
PHP
Stars
2.2k
Forks
587
PR merge metrics
No merged PRs in 30d

Description

## Description
The `downloadLogs()` method in the WorkflowJobs and WorkflowRuns API fails when attempting to download GitHub Actions job logs. Instead of returning the log data, it fails with an Azure Blob Storage authentication error.

## Environment
- **Library version**: `knplabs/github-api` 3.16.0
- **PHP version**: 8.x
- **HTTP client**: Guzzle 7.10.0 (via PSR-18 discovery)

## Expected Behavior
Calling `downloadLogs()` should return the ZIP archive containing the job logs as documented in the library's API.

## Actual Behavior
The method throws an exception or returns an XML error response from Azure Blob Storage:

```xml

AuthenticationFailed
Server failed to authenticate the request. Make sure the value of Authorization header is formed correctly including the signature.

```

## Root Cause
The GitHub API endpoint `/repos/{owner}/{repo}/actions/jobs/{job_id}/logs` returns a **302 redirect** to an Azure Blob Storage URL with a pre-signed SAS token in the query parameters.

The issue occurs because:

1. **HTTPlug's `RedirectPlugin` is used** by default in the library (added in `Client.php`)
2. **The RedirectPlugin preserves ALL headers by default** (`preserve_header: true`)
3. When following the redirect to Azure Blob Storage, the **GitHub `Authorization` header is sent to Azure**
4. Azure Blob Storage doesn't understand GitHub's authentication format and rejects the request
5. Unlike Guzzle's native `RedirectMiddleware` (which strips `Authorization` and `Cookie` headers on cross-origin redirects), HTTPlug's `RedirectPlugin` has no such protection

## Reproduction Steps
1. Set up GitHub API client with valid authentication token
2. Get a valid job ID from a workflow run
3. Call `downloadLogs()` on that job ID
4. Observe the Azure authentication error

## References
- GitHub API docs: https://docs.github.com/en/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run
- Guzzle's RedirectMiddleware (strips auth headers): https://github.com/guzzle/guzzle/blob/master/src/RedirectMiddleware.php#L174-L177
- HTTPlug RedirectPlugin (preserves all headers): https://github.com/php-http/client-common/blob/master/src/Plugin/RedirectPlugin.php

Contributor guide

No contributing guide indexed for this repository

Research direction

Start in Client.php, where the HTTPlug RedirectPlugin is added, and review the linked RedirectPlugin and Guzzle RedirectMiddleware behavior. Reproduce downloadLogs() with a workflow job, then verify that following the Azure redirect no longer sends the GitHub Authorization header and returns the logs archive successfully.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, php
Domain
api
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.