feat: new sample for storage upload chunked stream (GoogleCloudPlatform#1653)

Author: vishwarajanand

storage/src/upload_object.php

@@ -24,7 +24,6 @@
 namespace Google\Cloud\Samples\Storage;
 
 # [START storage_upload_file]
-# [START storage_stream_file_upload]
 use Google\Cloud\Storage\StorageClient;
 
 /**
@@ -48,7 +47,6 @@ function upload_object($bucketName, $objectName, $source)
     ]);
     printf('Uploaded %s to gs://%s/%s' . PHP_EOL, basename($source), $bucketName, $objectName);
 }
-# [END storage_stream_file_upload]
 # [END storage_upload_file]
 
 // The following 2 lines are only needed to run the samples

storage/src/upload_object_stream.php

@@ -0,0 +1,64 @@
+<?php
+/**
+ * Copyright 2022 Google Inc.
+ *
+ * Licensed 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.
+ */
+
+/**
+ * For instructions on how to run the full sample:
+ *
+ * @see https://github.com/GoogleCloudPlatform/php-docs-samples/tree/master/storage/README.md
+ */
+
+namespace Google\Cloud\Samples\Storage;
+
+# [START storage_stream_file_upload]
+use Google\Cloud\Storage\StorageClient;
+use Google\Cloud\Storage\WriteStream;
+
+/**
+ * Upload a chunked file stream.
+ *
+ * @param string $bucketName The name of your Cloud Storage bucket.
+ * @param string $objectName The name of your Cloud Storage object.
+ * @param string $contents The contents to upload via stream chunks.
+ */
+function upload_object_stream(string $bucketName, string $objectName, string $contents): void
+{
+    // $bucketName = 'my-bucket';
+    // $objectName = 'my-object';
+    // $contents = 'these are my contents';
+
+    $storage = new StorageClient();
+    $bucket = $storage->bucket($bucketName);
+    $writeStream = new WriteStream(null, [
+        'chunkSize' => 1024 * 256, // 256KB
+    ]);
+    $uploader = $bucket->getStreamableUploader($writeStream, [
+        'name' => $objectName,
+    ]);
+    $writeStream->setUploader($uploader);
+    $stream = fopen('data://text/plain,' . $contents, 'r');
+    while (($line = stream_get_line($stream, 1024 * 256)) !== false) {
+        $writeStream->write($line);
+    }
+    $writeStream->close();
+
+    printf('Uploaded %s to gs://%s/%s' . PHP_EOL, $contents, $bucketName, $objectName);
+}
+# [END storage_stream_file_upload]
+
+// The following 2 lines are only needed to run the samples from the CLI
+require_once __DIR__ . '/../../testing/sample_helpers.php';
+\Google\Cloud\Samples\execute_sample(__FILE__, __NAMESPACE__, $argv);

storage/test/ObjectsTest.php

@@ -30,6 +30,7 @@ class ObjectsTest extends TestCase
 
     private static $bucketName;
     private static $storage;
+    private static $contents;
 
     public static function setUpBeforeClass(): void
     {
@@ -38,6 +39,7 @@ public static function setUpBeforeClass(): void
             self::requireEnv('GOOGLE_STORAGE_BUCKET')
         );
         self::$storage = new StorageClient();
+        self::$contents = ' !"#$%&\'()*,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[]^_`abcdefghijklmnopqrstuvwxyz{|}~';
     }
 
     public function testListObjects()
@@ -184,12 +186,36 @@ public function testUploadAndDownloadObjectFromMemory()
     {
         $objectName = 'test-object-' . time();
         $bucket = self::$storage->bucket(self::$bucketName);
-        $contents = ' !"#$%&\'()*,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[]^_`abcdefghijklmnopqrstuvwxyz{|}~';
         $object = $bucket->object($objectName);
 
         $this->assertFalse($object->exists());
 
         $output = self::runFunctionSnippet('upload_object_from_memory', [
+            self::$bucketName,
+            $objectName,
+            self::$contents,
+        ]);
+
+        $object->reload();
+        $this->assertTrue($object->exists());
+
+        $output = self::runFunctionSnippet('download_object_into_memory', [
+            self::$bucketName,
+            $objectName,
+        ]);
+        $this->assertStringContainsString(self::$contents, $output);
+    }
+
+    public function testUploadAndDownloadObjectStream()
+    {
+        $objectName = 'test-object-stream-' . time();
+        // contents larger than atleast one chunk size
+        $contents = str_repeat(self::$contents, 1024 * 10);
+        $bucket = self::$storage->bucket(self::$bucketName);
+        $object = $bucket->object($objectName);
+        $this->assertFalse($object->exists());
+
+        $output = self::runFunctionSnippet('upload_object_stream', [
             self::$bucketName,
             $objectName,
             $contents,
@@ -200,7 +226,7 @@ public function testUploadAndDownloadObjectFromMemory()
 
         $output = self::runFunctionSnippet('download_object_into_memory', [
             self::$bucketName,
-            $objectName
+            $objectName,
         ]);
         $this->assertStringContainsString($contents, $output);
     }
@@ -209,19 +235,18 @@ public function testDownloadByteRange()
     {
         $objectName = 'test-object-download-byte-range-' . time();
         $bucket = self::$storage->bucket(self::$bucketName);
-        $contents = ' !"#$%&\'()*,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[]^_`abcdefghijklmnopqrstuvwxyz{|}~';
         $object = $bucket->object($objectName);
         $downloadTo = tempnam(sys_get_temp_dir(), '/tests');
         $downloadToBasename = basename($downloadTo);
         $startPos = 1;
-        $endPos = strlen($contents) - 2;
+        $endPos = strlen(self::$contents) - 2;
 
         $this->assertFalse($object->exists());
 
         $output = self::runFunctionSnippet('upload_object_from_memory', [
             self::$bucketName,
             $objectName,
-            $contents
+            self::$contents,
         ]);
 
         $object->reload();
@@ -236,7 +261,7 @@ public function testDownloadByteRange()
         ]);
 
         $this->assertTrue(file_exists($downloadTo));
-        $expectedContents = substr($contents, $startPos, $endPos - $startPos + 1);
+        $expectedContents = substr(self::$contents, $startPos, $endPos - $startPos + 1);
         $this->assertEquals($expectedContents, file_get_contents($downloadTo));
         $this->assertStringContainsString(
             sprintf(