feat(functions): samples for typed function signature (#1866)

Author: garethgeorge

functions/typed_greeting/composer.json

@@ -0,0 +1,12 @@
+{
+    "require": {
+        "php": ">= 7.4",
+        "google/cloud-functions-framework": "^1.3"
+    },
+    "scripts": {
+        "start": [
+           "Composer\\Config::disableProcessTimeout",
+           "FUNCTION_TARGET=helloHttp php -S localhost:${PORT:-8080} vendor/google/cloud-functions-framework/router.php"
+        ]
+    }
+}

functions/typed_greeting/index.php

@@ -0,0 +1,84 @@
+<?php
+
+/**
+ * Copyright 2023 Google LLC.
+ *
+ * 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.
+ */
+
+// [START functions_typed_greeting]
+
+use Google\CloudFunctions\FunctionsFramework;
+
+class GreetingRequest
+{
+    /** @var string */
+    public $first_name;
+
+    /** @var string */
+    public $last_name;
+
+    public function __construct(string $first_name = '', string $last_name = '')
+    {
+        $this->first_name = $first_name;
+        $this->last_name = $last_name;
+    }
+
+    public function serializeToJsonString(): string
+    {
+        return json_encode([
+            'first_name' => $this->first_name,
+            'last_name' => $this->last_name,
+        ]);
+    }
+
+    public function mergeFromJsonString(string $body): void
+    {
+        $obj = json_decode($body);
+        $this->first_name = $obj['first_name'];
+        $this->last_name = $obj['last_name'];
+    }
+}
+
+class GreetingResponse
+{
+    /** @var string */
+    public $message;
+
+    public function __construct(string $message = '')
+    {
+        $this->message = $message;
+    }
+
+    public function serializeToJsonString(): string
+    {
+        return json_encode([
+            'message' => $message,
+        ]);
+    }
+
+    public function mergeFromJsonString(string $body): void
+    {
+        $obj = json_decode($body);
+        $this->message = $obj['message'];
+    }
+};
+
+function greeting(GreetingRequest $req): GreetingResponse
+{
+    return new GreetingResponse("Hello $req->first_name $req->last_name!");
+};
+
+FunctionsFramework::typed('greeting', 'greeting');
+
+// [END functions_typed_greeting]

functions/typed_greeting/phpunit.xml.dist

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Copyright 2023 Google LLC
+
+  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.
+-->
+<phpunit bootstrap="../../testing/bootstrap.php" convertWarningsToExceptions="false">
+    <testsuites>
+        <testsuite name="Cloud Functions Typed Greeting HTTP Test Suite">
+            <directory>.</directory>
+            <exclude>vendor</exclude>
+        </testsuite>
+    </testsuites>
+    <logging>
+        <log type="coverage-clover" target="build/logs/clover.xml"/>
+    </logging>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">.</directory>
+            <exclude>
+              <directory>./vendor</directory>
+            </exclude>
+        </whitelist>
+    </filter>
+</phpunit>

functions/typed_greeting/test/UnitTest.php

@@ -0,0 +1,67 @@
+<?php
+/**
+ * Copyright 2023 Google LLC.
+ *
+ * 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.
+ */
+
+declare(strict_types=1);
+
+namespace Google\Cloud\Samples\Functions\TypedGreeting\Test;
+
+use PHPUnit\Framework\TestCase;
+use GreetingRequest;
+use GreetingResponse;
+
+/**
+ * Unit tests for the Cloud Function.
+ */
+class UnitTest extends TestCase
+{
+    private static $entryPoint = 'greeting';
+
+    public static function setUpBeforeClass(): void
+    {
+        require_once __DIR__ . '/../index.php';
+    }
+
+    /**
+      * @dataProvider cases
+      */
+    public function testFunction(
+        $label,
+        $first_name,
+        $last_name,
+        $expected_message,
+    ): void {
+        $actual = $this->runFunction(self::$entryPoint, [new GreetingRequest($first_name, $last_name)]);
+        $this->assertEquals($expected_message, $actual->message, $label . ':');
+    }
+
+    private static function runFunction($functionName, array $params = []): GreetingResponse
+    {
+        return call_user_func_array($functionName, $params);
+    }
+
+    public static function cases(): array
+    {
+        return [
+            [
+                'label' => 'Default',
+                'first_name' => 'Jane',
+                'last_name' => 'Doe',
+                'expected_message' => 'Hello Jane Doe!',
+            ],
+        ];
+    }
+}