feat(storage): add Object Contexts samples and system tests#1
feat(storage): add Object Contexts samples and system tests#1salilg-eng wants to merge 5 commits intomainfrom
Conversation
|
/Gemini review |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces new PHP code samples for managing Google Cloud Storage object contexts, including scripts to set, retrieve, and list objects based on custom context metadata. It also adds a comprehensive test case in storageTest.php. The review feedback identifies several inaccuracies in the docstrings and output messages for the retrieval and listing functions, which currently incorrectly describe their purpose as attaching or modifying contexts.
| use Google\Cloud\Storage\StorageClient; | ||
|
|
||
| /** | ||
| * Attach or modify contexts to an existing object. |
There was a problem hiding this comment.
The docstring for this function is incorrect. It describes attaching or modifying contexts, but this function is intended to retrieve them.
* Retrieve contexts for an existing object.|
|
||
| $info = $object->info(); | ||
| if (isset($info['contexts']['custom'])) { | ||
| printf('Contexts for object %s were updated:' . PHP_EOL, $objectName); |
There was a problem hiding this comment.
The output message "were updated" is misleading for a retrieval sample. It should reflect that the contexts are being displayed or retrieved.
printf('Contexts for object %s:' . PHP_EOL, $objectName);| use Google\Cloud\Storage\StorageClient; | ||
|
|
||
| /** | ||
| * Attach or modify contexts to an existing object. |
There was a problem hiding this comment.
The docstring for this function is incorrect. It describes attaching or modifying contexts, but this function is intended to list objects using a filter.
* List objects with a filter based on contexts.
There was a problem hiding this comment.
Code Review
This pull request introduces new sample scripts for managing Google Cloud Storage object contexts, including functionality for setting, retrieving, and listing objects using context filters. It also includes a new test case to verify these operations. The review feedback identifies several documentation errors where docstrings were likely copied from other functions and a misleading output message in the retrieval script that incorrectly implies an update operation.
| use Google\Cloud\Storage\StorageClient; | ||
|
|
||
| /** | ||
| * Attach or modify contexts to an existing object. |
There was a problem hiding this comment.
The docstring for this function is incorrect. It appears to be a copy-paste from the set_object_contexts function. It should describe the retrieval of contexts.
* Retrieve contexts of an existing object.|
|
||
| $info = $object->info(); | ||
| if (isset($info['contexts']['custom'])) { | ||
| printf('Contexts for object %s were updated:' . PHP_EOL, $objectName); |
There was a problem hiding this comment.
The output message says 'were updated', which is misleading for a retrieval (GET) operation. It should simply state that these are the contexts for the object.
printf('Contexts for object %s:' . PHP_EOL, $objectName);| use Google\Cloud\Storage\StorageClient; | ||
|
|
||
| /** | ||
| * Attach or modify contexts to an existing object. |
There was a problem hiding this comment.
The docstring for this function is incorrect. It should describe listing objects using a context filter rather than attaching or modifying them.
* List objects with a specific context filter.1 participant
Add set_object_contexts.php to demonstrate upload contexts.
Add get_object_contexts.php to show retrieval of structured metadata.
Add list_object_contexts.js to demonstrate server-side filtering.
Implement comprehensive system tests in storageTest.php covering presence, absence (-), and existence (:) filter operators.
Ensure samples use the correct 'contexts' field with 'custom' map structure.