Crea y, también, implementa una función de HTTP de Cloud Run con PHP (1ª gen.)

Nota: Este contenido se aplica solo a funciones de Cloud Run (1ª gen.), antes Cloud Functions (1ª gen.).

Para obtener la versión de Cloud Run Functions de este documento, consulta Crea y, también, implementa una función de HTTP de Cloud Run con PHP.

En esta guía, se explica el proceso para escribir una función de Cloud Run con el entorno de ejecución de PHP. Existen dos tipos de funciones de Cloud Run:

• Una función de HTTP que se invoca a partir de solicitudes HTTP estándar.
• La otra es una función controlada por eventos que se usa para manejar los eventos de la infraestructura de tu nube, como mensajes en un tema de Cloud Pub/Sub o cambios en un bucket de Cloud Storage.

En el ejemplo, se muestra cómo crear una función de HTTP simple.

Más información: Para obtener más detalles, lee sobre las funciones de HTTP y las funciones controladas por eventos.

Antes de comenzar

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Cloud Functions and Cloud Build APIs.

   Enable the APIs

5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

6. Make sure that billing is enabled for your Google Cloud project.

7. Enable the Cloud Functions and Cloud Build APIs.

   Enable the APIs

8. Instala e inicializa gcloud CLI
9. Instala y actualiza componentes de gcloud:

   gcloud components update

Nota: ¿Necesitas un símbolo del sistema? Puedes usar Cloud Shell. Google Cloud Shell es un entorno de línea de comandos que ya incluye Google Cloud CLI, por lo que no es necesario que lo instales. Google Cloud CLI también viene preinstalado en las máquinas virtuales de Google Compute Engine.
10. Prepara tu entorno de desarrollo.

    Comienza a usar PHP

Crea una función

1. Crea un directorio en tu sistema local para el código de función:

   Linux o Mac OS X

   mkdir ~/helloworld_http
   cd ~/helloworld_http
   

   Windows

   mkdir %HOMEPATH%\helloworld_http
   cd %HOMEPATH%\helloworld_http
   

2. Crea un archivo index.php en el directorio helloworld_http con el siguiente contenido:

   <?php
   
   use Google\CloudFunctions\FunctionsFramework;
   use Psr\Http\Message\ServerRequestInterface;
   
   // Register the function with Functions Framework.
   // This enables omitting the `FUNCTIONS_SIGNATURE_TYPE=http` environment
   // variable when deploying. The `FUNCTION_TARGET` environment variable should
   // match the first parameter.
   FunctionsFramework::http('helloHttp', 'helloHttp');
   
   function helloHttp(ServerRequestInterface $request): string
   {
       $name = 'World';
       $body = $request->getBody()->getContents();
       if (!empty($body)) {
           $json = json_decode($body, true);
           if (json_last_error() != JSON_ERROR_NONE) {
               throw new RuntimeException(sprintf(
                   'Could not parse body: %s',
                   json_last_error_msg()
               ));
           }
           $name = $json['name'] ?? $name;
       }
       $queryString = $request->getQueryParams();
       $name = $queryString['name'] ?? $name;
   
       return sprintf('Hello, %s!', htmlspecialchars($name));
   }
   

   Esta función de ejemplo toma un nombre proporcionado en la solicitud HTTP y muestra un saludo o “Hello World!” cuando no se proporciona ningún nombre.

   Nota: Cloud Run Functions busca funciones que se puedan implementar en index.php de forma predeterminada. Usa la marca --source cuandoimplementes la función a través degcloud para especificar un directorio diferente que contenga un archivo index.php.

Especificar dependencias

Usa Composer para administrar las dependencias en PHP. Si aún no tienes Composer instalado, puedes hacerlo de la siguiente manera:

1. Descarga Composer en cualquier ubicación que desees.

2. Una vez descargado, mueve el composer.phar archivo a un directorio que esté en la ruta de tu sistema, por ejemplo:

   mv composer.phar /usr/local/bin/composer
   

A continuación, especifica las dependencias de tu función:

1. Agrega un archivo composer.json que contenga dependencias al directorio del código de tu función, en el que FUNCTION_TARGET=FUNCTION_NAME indica el nombre de la función. En este ejemplo, FUNCTION_NAME es helloHttp:

   {
       "require": {
           "php": ">= 8.1",
           "google/cloud-functions-framework": "^1.1"
       },
       "scripts": {
           "start": [
              "Composer\\Config::disableProcessTimeout",
              "FUNCTION_TARGET=helloHttp php -S localhost:${PORT:-8080} vendor/google/cloud-functions-framework/router.php"
           ]
       }
   }
   

2. En el directorio que contiene el código de tu función (que también debe contener el archivo composer.json que acabas de crear), ejecuta el siguiente comando:

   composer require google/cloud-functions-framework
   

   Esto agrega Functions Framework a tu composer.json. También crea un directorio vendor/ en el directorio del código de tu función que contiene las dependencias.

Más información: Para obtener más detalles, lee acerca de la especificación de dependencias.

Compila y prueba de manera local

Una vez que hayas completado los pasos en Especificar dependencias, puedes compilar y probar la función de manera local.

El siguiente comando sirve para crear un servidor web local que ejecuta tu helloHttp función:

export FUNCTION_TARGET=helloHttp
php -S localhost:8080 vendor/bin/router.php

Si la función se compila correctamente, mostrará una URL. Puedes visitar esta URL con tu navegador web: http://localhost:8080/. Deberías ver un mensaje Hello World!.

Como alternativa, puedes enviar solicitudes a esta función mediante curl desde otra ventana de la terminal:

curl localhost:8080
# Output: Hello World!

Implementa la función

Ejecuta el siguiente comando en el directorio helloworld_http para implementar la función con un activador HTTP:

gcloud functions deploy helloHttp --no-gen2 --runtime php82 --trigger-http --allow-unauthenticated

La marca --allow-unauthenticated te permite acceder a la función sin autenticación. Para solicitar la autenticación, omite la marca.

Más información: Para obtener más detalles, lee acerca de la implementación de funciones de Cloud Run Functions.

Prueba la función implementada

1. Cuando la función termine de implementarse, toma nota de la propiedad httpsTrigger.url o búscala con el siguiente comando:

   gcloud functions describe helloHttp
   

   Se verá de la siguiente manera:

   https://GCP_REGION-PROJECT_ID.cloudfunctions.net/helloHttp

2. Visita esta URL en tu navegador. Deberías ver el mensaje “Hello World!”.

   Intenta pasar un nombre en la solicitud HTTP, como se muestra en esta URL de ejemplo:

   https://GCP_REGION-PROJECT_ID.cloudfunctions.net/helloHttp?name=NAME

   Deberías ver el mensaje “Hola, NAME”

Ver registros

Los registros de Cloud Run Functions pueden verse con Google Cloud CLI y en la IU de Cloud Logging.

Usa la herramienta de línea de comandos

Para visualizar los registros de tu función con gcloud  CLI, usa el comando gcloud logs read seguido por el nombre de la función:

gcloud functions logs read helloHttp

El resultado debe parecerse al siguiente:

LEVEL  NAME       EXECUTION_ID  TIME_UTC                 LOG
D      helloHttp  rvb9j0axfclb  2019-09-18 22:06:25.983  Function execution started
D      helloHttp  rvb9j0axfclb  2019-09-18 22:06:26.001  Function execution took 19 ms, finished with status code: 200

Nota: Por lo general, hay un ligero retraso entre el momento en que se crean las entradas de registro y el momento en que se muestran en Cloud Logging.

Usa el panel de Logging

También puedes ver los registros de Cloud Run Functions desde la consola de Google Cloud.

Más información: Para obtener más detalles, lea acerca de cómo escribir, visualizar y responder a los registros.