Skip to content
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

fix: CallOptions should use transportOptions #513

Merged
merged 5 commits into from
Jan 18, 2024
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
16 changes: 12 additions & 4 deletions src/Options/CallOptions.php
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ class CallOptions implements ArrayAccess

private array $headers;
private ?int $timeoutMillis;
private array $transportSpecificOptions;
private array $transportOptions;

/** @var RetrySettings|array|null $retrySettings */
private $retrySettings;
Expand Down Expand Up @@ -86,7 +86,7 @@ private function fromArray(array $arr): void
{
$this->setHeaders($arr['headers'] ?? []);
$this->setTimeoutMillis($arr['timeoutMillis'] ?? null);
$this->setTransportSpecificOptions($arr['transportOptions'] ?? []);
$this->setTransportOptions($arr['transportOptions'] ?? []);
$this->setRetrySettings($arr['retrySettings'] ?? null);
}

Expand All @@ -107,7 +107,7 @@ public function setTimeoutMillis(?int $timeoutMillis)
}

/**
* @param array $transportSpecificOptions {
* @param array $transportOptions {
* Transport-specific call-time options.
*
* @type array $grpcOptions
Expand All @@ -125,9 +125,17 @@ public function setTimeoutMillis(?int $timeoutMillis)
* See {@link https://docs.guzzlephp.org/en/stable/request-options.html}.
* }
*/
public function setTransportOptions(array $transportOptions)
{
$this->transportOptions = $transportOptions;
}

/**
* @deprecated use CallOptions::setTransportOptions
*/
public function setTransportSpecificOptions(array $transportSpecificOptions)
{
$this->transportSpecificOptions = $transportSpecificOptions;
$this->setTransportOptions($transportSpecificOptions);
}

/**
Expand Down
3 changes: 2 additions & 1 deletion tests/Tests/Unit/GapicClientTraitTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -1834,7 +1834,8 @@ public function testCallOptionsForV2Surface()
'credentialsWrapper' => CredentialsWrapper::build([
'keyFile' => __DIR__ . '/testdata/json-key-file.json'
]),
'timeoutMillis' => null, // adds null timeoutMillis
'timeoutMillis' => null, // adds null timeoutMillis,
'transportOptions' => [],
])
)
->willReturn(new FulfilledPromise(new Operation()));
Expand Down