Repository navigation
THRIFT-2950: Fix PHP scalar set serialization #3787
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
Draft
sveneld
wants to merge
1
commit into
apache:master
Choose a base branch
from
sveneld:THRIFT-2950
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| --TEST-- | ||
| Scalar sets accept value lists and preserve legacy keyed sets | ||
| --SKIPIF-- | ||
| <?php | ||
| if (!extension_loaded('thrift_protocol')) { | ||
| echo 'skip thrift_protocol extension not loaded'; | ||
| } | ||
| ?> | ||
| --FILE-- | ||
| <?php | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| use Thrift\Protocol\TBinaryProtocol; | ||
| use Thrift\Transport\TMemoryBuffer; | ||
| use Thrift\Type\TType; | ||
|
|
||
| spl_autoload_register(function ($class) { | ||
| if (strpos($class, 'Thrift\\') === 0) { | ||
| require __DIR__ . '/../../../../lib/' | ||
| . str_replace('\\', '/', substr($class, 7)) . '.php'; | ||
| } | ||
| }); | ||
|
|
||
| class ScalarSetPayload | ||
| { | ||
| public static $tspec; | ||
| public static $isValidate = false; | ||
| public $items; | ||
| } | ||
|
|
||
| $cases = [ | ||
| 'empty' => [TType::I32, [], []], | ||
| 'integer list' => [TType::I32, [42, -7, 19], [42, -7, 19]], | ||
| 'legacy sequential keys' => [TType::I32, [0 => true, 1 => true], [0, 1]], | ||
| 'string list' => [TType::STRING, ['a', '123'], ['a', '123']], | ||
| 'legacy numeric string' => [TType::STRING, ['123' => true], ['123']], | ||
| 'bool list' => [TType::BOOL, [true, false], [true, false]], | ||
| 'ambiguous bool' => [TType::BOOL, [true], [false]], | ||
| 'legacy bool' => [TType::BOOL, [1 => true], [true]], | ||
| ]; | ||
| foreach ($cases as $name => [$type, $input, $elements]) { | ||
| ScalarSetPayload::$tspec = [1 => [ | ||
| 'var' => 'items', 'type' => TType::SET, | ||
| 'etype' => $type, 'elem' => ['type' => $type], | ||
| ]]; | ||
| $payload = new ScalarSetPayload(); | ||
| $payload->items = $input; | ||
| $actual = new TMemoryBuffer(); | ||
| thrift_protocol_write_binary(new TBinaryProtocol($actual), 'test', 1, $payload, 0, true); | ||
|
|
||
| $expected = new TMemoryBuffer(); | ||
| $protocol = new TBinaryProtocol($expected); | ||
| $protocol->writeMessageBegin('test', 1, 0); | ||
| $protocol->writeStructBegin('ScalarSetPayload'); | ||
| $protocol->writeFieldBegin('items', TType::SET, 1); | ||
| $protocol->writeSetBegin($type, count($elements)); | ||
| $writer = [TType::I32 => 'writeI32', TType::STRING => 'writeString', TType::BOOL => 'writeBool'][$type]; | ||
| foreach ($elements as $element) { | ||
| $protocol->$writer($element); | ||
| } | ||
| $protocol->writeSetEnd(); | ||
| $protocol->writeFieldEnd(); | ||
| $protocol->writeFieldStop(); | ||
| $protocol->writeStructEnd(); | ||
| $protocol->writeMessageEnd(); | ||
| echo $name, ': ', $actual->getBuffer() === $expected->getBuffer() ? 'OK' : 'FAIL', "\n"; | ||
| } | ||
| ?> | ||
| --EXPECT-- | ||
| empty: OK | ||
| integer list: OK | ||
| legacy sequential keys: OK | ||
| string list: OK | ||
| legacy numeric string: OK | ||
| bool list: OK | ||
| ambiguous bool: OK | ||
| legacy bool: OK |
111 changes: 111 additions & 0 deletions
111
lib/php/test/Integration/Lib/Protocol/ScalarSetTest.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Test\Thrift\Integration\Lib\Protocol; | ||
|
|
||
| use Classmap\ThriftTest\ThriftTestIf; | ||
| use Classmap\ThriftTest\ThriftTestRest; | ||
| use Classmap\ThriftTest\ThriftTest_testSet_args; | ||
| use PHPUnit\Framework\Attributes\DataProvider; | ||
| use PHPUnit\Framework\TestCase; | ||
| use Thrift\ClassLoader\ThriftClassLoader; | ||
| use Thrift\Protocol\TBinaryProtocol; | ||
| use Thrift\Transport\TMemoryBuffer; | ||
|
|
||
| class ScalarSetTest extends TestCase | ||
| { | ||
| #[DataProvider('scalarSetCoercionProvider')] | ||
| public function testScalarSetCoercionIsConsistent( | ||
| string $class, | ||
| array $fields, | ||
| array $values, | ||
| array $expected, | ||
| bool $inlined | ||
| ): void { | ||
| $value = new $class(array_fill_keys($fields, $values)); | ||
| $restored = new $class(); | ||
| if ($inlined) { | ||
| $buffer = ''; | ||
| $value->write($buffer); | ||
| $restored->read(new TMemoryBuffer($buffer)); | ||
| } else { | ||
| $protocol = new TBinaryProtocol(new TMemoryBuffer()); | ||
| $value->write($protocol); | ||
| $restored->read($protocol); | ||
| } | ||
|
|
||
| foreach ($fields as $field) { | ||
| $this->assertSame($expected, $restored->$field); | ||
| } | ||
| } | ||
|
|
||
| public static function scalarSetCoercionProvider(): iterable | ||
| { | ||
| foreach (['Basic', 'BasicInline', 'ValidateOop'] as $namespace) { | ||
| $inlined = $namespace === 'BasicInline'; | ||
| yield $namespace . ' numeric strings' => [ | ||
| $namespace . '\\ThriftTest\\ThriftTest_testSet_args', | ||
| ['thing'], ['10', '20'], [10 => true, 20 => true], $inlined, | ||
| ]; | ||
| yield $namespace . ' integer booleans' => [ | ||
| $namespace . '\\TestValidators\\BoolSetTest', | ||
| ['direct', 'aliased', 'chained'], [1, 0], [1 => true, 0 => true], $inlined, | ||
| ]; | ||
| } | ||
| } | ||
|
|
||
| #[DataProvider('restSetProvider')] | ||
| public function testRestSetPreservesElementsThroughSerialization(array $elements): void | ||
| { | ||
| $loader = new ThriftClassLoader(); | ||
| $loader->registerDefinition('Classmap', __DIR__ . '/../../../Resources/packages/phpcm'); | ||
| $loader->register(); | ||
|
|
||
| try { | ||
| $expected = array_fill_keys($elements, true); | ||
| $handler = $this->createMock(ThriftTestIf::class); | ||
| $handler->expects($this->once())->method('testSet') | ||
| ->willReturnCallback(function (array $values): array { | ||
| $protocol = new TBinaryProtocol(new TMemoryBuffer()); | ||
| $args = new ThriftTest_testSet_args(['thing' => $values]); | ||
| $args->write($protocol); | ||
| $restored = new ThriftTest_testSet_args(); | ||
| $restored->read($protocol); | ||
| return $restored->thing; | ||
| }); | ||
|
|
||
| $rest = new ThriftTestRest($handler); | ||
| $this->assertSame($expected, $rest->testSet(['thing' => json_encode($elements)])); | ||
| } finally { | ||
| spl_autoload_unregister([$loader, 'loadClass']); | ||
| } | ||
| } | ||
|
|
||
| public static function restSetProvider(): iterable | ||
| { | ||
| yield 'empty' => [[]]; | ||
| yield 'zero and one' => [[0, 1]]; | ||
| yield 'zero through two' => [[0, 1, 2]]; | ||
| yield 'nonsequential' => [[-5, 10]]; | ||
| } | ||
| } |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.