feat(storage): add Object Contexts samples and system tests by salilg-eng · Pull Request #2200 · GoogleCloudPlatform/php-docs-samples

salilg-eng · 2026-04-20T13:32:10Z

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 ObjectTest.php covering presence, absence, and existence filter operators.
Ensure samples use the correct 'contexts' field with 'custom' map structure.

snippet-bot · 2026-04-20T13:32:16Z

Here is the summary of changes.

You are about to add 3 region tags.

storage/src/get_object_contexts.php:26, tag storage_get_object_contexts
storage/src/list_object_contexts.php:26, tag storage_list_object_contexts
storage/src/set_object_contexts.php:26, tag storage_set_object_contexts

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

Refresh this comment

google-cla · 2026-04-20T13:32:38Z

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

gemini-code-assist

Code Review

This pull request introduces three new PHP samples for managing Cloud Storage object contexts: get_object_contexts, list_object_contexts, and set_object_contexts. It also includes a comprehensive test case in ObjectsTest.php to verify these functionalities. Feedback highlights several issues in the test implementation, including the use of an uninitialized project ID variable which results in invalid bucket names, a resource leak due to buckets not being deleted after tests, and redundant variable assignments. Additionally, it is recommended to use null coalescing operators in the samples for better robustness and to include missing filter operator test cases mentioned in the PR description.

gemini-code-assist · 2026-04-20T13:34:10Z

+    public function testObjectContexts()
+    {
+        $objectContextsBucket = self::$storage->createBucket(
+            sprintf('%s-test-bucket-%s', self::$projectId, time())


The variable self::$projectId is uninitialized in this test class, which will cause the bucket name to start with a hyphen (e.g., -test-bucket-...). This is an invalid bucket name in Cloud Storage and will cause the test to fail. Additionally, using uniqid() is preferred over time() to avoid collisions during parallel test runs.

sprintf('%s-test-bucket-%s', self::$storage->projectId(), uniqid())

Since we are using the testTrait file and have the $projectId defined, I believe this approach is correct. However, following your feedback, I have updated time() to uniqid()

gemini-code-assist · 2026-04-20T13:34:10Z

+        $objectContextsBucket = self::$storage->createBucket(
+            sprintf('%s-test-bucket-%s', self::$projectId, time())
+        );
+        $bucketName = $objectContextsBucket->name();
+        $objectName = 'object-contexts-'.uniqid();
+        $object = $objectContextsBucket->upload('test', [
+            'name' => $objectName,
+        ]);
+        $objectName = $object->info()['name'];
+
+        // Set Object Contexts
+        $setOutput = $this->runFunctionSnippet('set_object_contexts', [
+            $bucketName,
+            $objectName,
+        ]);
+
+        $this->assertStringContainsString("Contexts for object $objectName were updated", $setOutput);
+
+        // Get Object Contexts
+        $getOutput = $this->runFunctionSnippet('get_object_contexts', [
+            $bucketName,
+            $objectName
+        ]);
+
+        $this->assertStringContainsString('Key: department, Value: finance', $getOutput);
+        $this->assertStringContainsString('Key: priority, Value: high', $getOutput);
+
+        // List Object Contexts using filter
+        $listOutput = $this->runFunctionSnippet('list_object_contexts', [
+            $bucketName
+        ]);
+        $this->assertStringContainsString("Found object: $objectName", $listOutput);
+
+        // Clear all contexts on the object.
+        $object->update([
+            'contexts' => [
+                'custom' => null,
+            ],
+        ]);
+        $object->reload();
+
+        $clearedGetOutput = $this->runFunctionSnippet('get_object_contexts', [
+            $bucketName,
+            $objectName
+        ]);
+
+        $this->assertStringNotContainsString('Key: department, Value: finance', $clearedGetOutput);
+        $this->assertStringNotContainsString('Key: priority, Value: high', $clearedGetOutput);
+
+        $clearedInfo = $object->info();
+        $this->assertTrue(empty($clearedInfo['contexts']['custom'] ?? []));
+
+        // List again with filter after clearing contexts.
+        $clearedListOutput = $this->runFunctionSnippet('list_object_contexts', [
+            $bucketName
+        ]);
+        $this->assertEmpty(trim($clearedListOutput));
+    }


The bucket created for this test is never deleted, leading to resource leaks in the test project. Ensure the bucket is deleted at the end of the test, or consider using the shared bucket self::$bucketName if isolation is not strictly required.

Yes both object and bucket deleted

gemini-code-assist · 2026-04-20T13:34:10Z

        self::$contents = ' !"#$%&\'()*,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[]^_`abcdefghijklmnopqrstuvwxyz{|}~';
    }

+    public function testObjectContexts()


The PR description mentions implementing comprehensive system tests covering presence, absence (-), and existence (:) filter operators in storageTest.php. However, these tests are missing from the current changes in ObjectsTest.php. Please include the promised test cases to ensure full coverage of the filtering logic.

That is my bad above description mentioned storageTest.php actually made changes in ObjectTest.php file.

gemini-code-assist · 2026-04-20T13:34:10Z

+        ]);
+        $objectName = $object->info()['name'];


This assignment is redundant as $objectName is already defined on line 51 and its value remains unchanged after the upload. Removing this line improves code clarity and avoids an unnecessary call to the info() method.

]);

Variable name changed.

gemini-code-assist · 2026-04-20T13:34:10Z

+            printf(' - Key: %s, Value: %s' . PHP_EOL, $key, $data['value']);
+            printf(' - Created: %s' . PHP_EOL, $data['createTime']);
+            printf(' - Updated: %s' . PHP_EOL, $data['updateTime']);


Consider using the null coalescing operator (??) when accessing context fields to make the sample more robust against unexpected API response structures or missing metadata fields.

printf(' - Key: %s, Value: %s' . PHP_EOL, $key, $data['value'] ?? ''); printf(' - Created: %s' . PHP_EOL, $data['createTime'] ?? ''); printf(' - Updated: %s' . PHP_EOL, $data['updateTime'] ?? '');

salilg-eng added 7 commits April 13, 2026 10:45

Object Contexts Sample

10f5d6f

Final code

3083a83

Final code

d1c784b

Final code

9cf1530

Final code

e061129

Comments resolved

7b2aeac

Update object contexts

60200fd

salilg-eng requested review from a team as code owners April 20, 2026 13:32

product-auto-label bot added api: storage Issues related to the Cloud Storage API. samples Issues that are directly related to samples. labels Apr 20, 2026

gemini-code-assist bot reviewed Apr 20, 2026

View reviewed changes

Fixes as per gemini review

6553999

Conversation

salilg-eng commented Apr 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

snippet-bot bot commented Apr 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

google-cla bot commented Apr 20, 2026

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

salilg-eng Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

salilg-eng Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

salilg-eng Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

salilg-eng Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

salilg-eng Apr 21, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

salilg-eng commented Apr 20, 2026 •

edited

Loading

snippet-bot bot commented Apr 20, 2026 •

edited

Loading