Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion src/Traits/Plugins/HasApiVersion.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

namespace Saloon\Traits\Plugins;

use Saloon\Helpers\Helpers;
use InvalidArgumentException;
use Saloon\Enums\VersionMode;
use Saloon\Http\PendingRequest;
Expand Down Expand Up @@ -48,6 +49,14 @@ public function getApiVersion(): ?string
return $this->apiVersion;
}

/**
* Get where the API version is applied to the request
*/
public function getVersionMode(): VersionMode
{
return $this->versionMode;
}

/**
* Boot HasApiVersion plugin.
*/
Expand All @@ -61,11 +70,32 @@ public function bootHasApiVersion(PendingRequest $pendingRequest): void
VersionMode::Header => $pendingRequest->headers()->add($this->versionKey, $this->apiVersion),
VersionMode::QueryParam => $pendingRequest->query()->add($this->versionKey, $this->apiVersion),
VersionMode::Url => $pendingRequest->setUrl(
str_replace('{version}', $this->ensureVersionIsSafeForUrl($this->apiVersion), $pendingRequest->getUrl())
str_replace('{version}', $this->ensureVersionIsSafeForUrl($this->resolveUrlApiVersion($pendingRequest)), $pendingRequest->getUrl())
),
};
}

/**
* Resolve which version to substitute into `{version}` for URL mode.
*/
protected function resolveUrlApiVersion(PendingRequest $pendingRequest): string
{
if ($pendingRequest->getConnector() === $this) {
$request = $pendingRequest->getRequest();

if (in_array(HasApiVersion::class, Helpers::classUsesRecursive($request), true)
&& $request->getVersionMode() === VersionMode::Url) {
$requestVersion = $request->getApiVersion();

if (is_string($requestVersion) && $requestVersion !== '') {
return $requestVersion;
}
}
}

return $this->apiVersion;
}

/**
* Ensure the version can only ever form a single subdomain label or path segment.
*
Expand Down
59 changes: 59 additions & 0 deletions tests/Unit/Concerns/HasApiVersionTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,65 @@
return true;
});
});

test('the request can override the connector api version in the url', function () {
$mockClient = sendVersionedRequest(
makeVersionedConnector('https://api.provider.com/{version}', VersionMode::Url, 'v1'),
makeVersionedRequest('beta', VersionMode::Url),
);

$mockClient->assertSent(function (Request $request, $response) {
expect($response->getPendingRequest()->getUrl())->toBe('https://api.provider.com/beta');

return true;
});
});

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add a test for this scenario?

Connector still uses VersionMode::Url with v1, but the request only overrides via header, makeVersionedRequest('beta', VersionMode::Header). Here setApiVersion('beta') must not change the URL; the path should stay https://api.provider.com/v1, and the header should be api-version: beta.


test('a request versioned by header leaves the connector api version in the url', function () {
$mockClient = sendVersionedRequest(
makeVersionedConnector('https://api.provider.com/{version}', VersionMode::Url, 'v1'),
makeVersionedRequest('beta', VersionMode::Header),
);

$mockClient->assertSent(function (Request $request, $response) {
expect($response->getPendingRequest()->getUrl())->toBe('https://api.provider.com/v1');
expect($response->getPsrRequest()->getHeaderLine('api-version'))->toBe('beta');

return true;
});
});

test('a request with its own version methods but not the trait leaves the connector api version in the url', function () {
$request = new class extends Request {
protected Method $method = Method::GET;

public function resolveEndpoint(): string
{
return '';
}

public function getApiVersion(): string
{
return 'beta';
}

public function getVersionMode(): VersionMode
{
return VersionMode::Url;
}
};

$mockClient = sendVersionedRequest(
makeVersionedConnector('https://api.provider.com/{version}', VersionMode::Url, 'v1'),
$request,
);

$mockClient->assertSent(function (Request $request, $response) {
expect($response->getPendingRequest()->getUrl())->toBe('https://api.provider.com/v1');

return true;
});
});
});

describe('Without A Version', function () {
Expand Down
Loading