Tiempo de ejecución personalizado

Escenarios

Un tiempo de ejecución ejecuta el código de una función, lee el nombre del controlador de una variable de entorno y lee los eventos de invocación de las API de tiempo de ejecución de FunctionGraph. El tiempo de ejecución pasa los datos de evento al controlador de función y devuelve la respuesta del controlador a FunctionGraph.

FunctionGraph admite tiempos de ejecución personalizados. Puede utilizar un archivo ejecutable denominado bootstrap para incluir un tiempo de ejecución en el paquete de implementación de funciones. El tiempo de ejecución ejecuta el método manejador de la función cuando se invoca la función.

El tiempo de ejecución se ejecuta en el entorno de ejecución de FunctionGraph. Puede ser un script de shell o un archivo ejecutable binario que se compila en Linux.

Después de la programación, simplemente empaqueta tus códigos en un archivo ZIP (Java, Node.js, Python y Go) o un archivo JAR (Java), y sube el archivo a FunctionGraph para su ejecución. Cuando cree un archivo ZIP, coloque el archivo de controlador bajo el directorio root para asegurarse de que su código puede ejecutarse normalmente después de ser descomprimido.

Si edita código en Go, comprima el archivo compilado y asegúrese de que el nombre del archivo de biblioteca dinámica sea coherente con el nombre del complemento del controlador. Por ejemplo, si el nombre del archivo de biblioteca dinámica es testplugin.so, establezca el nombre del controlador en testplugin.Handler.

tiempo de ejecución de archivo bootstrap

Si hay un archivo llamado bootstrap en su paquete de implementación de funciones, el FunctionGraph ejecuta ese archivo. Si el archivo bootstrap no se encuentra o no es ejecutable, su función devolverá un error cuando se invoque.

El código de tiempo de ejecución es responsable de completar las tareas de inicialización. Él procesa eventos de invocación en un bucle hasta que sea terminado.

Las tareas de inicialización se ejecutan una vez por cada instancia de la función para preparar el entorno para el manejo de invocaciones.

API de tiempo de ejecución

FunctionGraph proporciona API de tiempo de ejecución HTTP para recibir eventos de invocación de funciones y devuelve datos de respuesta en el entorno de ejecución.

• Siguiente Invocación

  Método – Get

  Ruta – http://$RUNTIME_API_ADDR/v1/runtime/invocation/request

  Esta API se utiliza para recuperar un evento de invocación. El cuerpo de la respuesta contiene los datos del evento. En la siguiente tabla se describen datos adicionales sobre la invocación contenida en el encabezado de respuesta.

  Tabla 1 Información del encabezado de respuesta

  Parámetro	Descripción
  X-Cff-Request-Id	ID de solicitud.
  X-CFF-Access-Key	Llave de acceso de la cuenta. Se debe configurar una agencia para la función si se utiliza esta variable.
  X-CFF-Auth-Token	Token de la cuenta. Se debe configurar una agencia para la función si se utiliza esta variable.
  X-CFF-Invoke-Type	Tipo de invocación de la función.
  X-CFF-Secret-Key	Llave secreta de la cuenta. Se debe configurar una agencia para la función si se utiliza esta variable.
  X-CFF-Security-Token	Token de seguridad de la cuenta. Se debe configurar una agencia para la función si se utiliza esta variable.

• Respuesta de invocación

  Método – POST

  Ruta – http://$RUNTIME_API_ADDR/v1/runtime/invocation/response/$REQUEST_ID

  Esta API se utiliza para enviar una respuesta de invocación correcta a FunctionGraph. Después de que el tiempo de ejecución invoque al manejador de función, envía la respuesta de la función a la ruta de respuesta de invocación.

• Error de invocación

  Método – POST

  Ruta – http://$RUNTIME_API_ADDR/v1/runtime/invocation/error/$REQUEST_ID

  $REQUEST_ID es el valor de la variable X-Cff-Request-Id en el encabezado de una respuesta de recuperación de evento. Para obtener más información, consulte Tabla 1.

  $RUNTIME_API_ADDR es una variable de entorno del sistema. Para obtener más información, consulte Tabla 2.

  Esta API se utiliza para enviar una respuesta de invocación de error a FunctionGraph. Después de que el tiempo de ejecución invoque al manejador de función, envía la respuesta de la función a la ruta de respuesta de invocación.

Variables de entorno en tiempo de ejecución

Puede usar variables de entorno personalizadas y en tiempo de ejecución en el código de función. En la siguiente tabla se enumeran las variables de entorno en tiempo de ejecución que se utilizan en el entorno de ejecución del FunctionGraph.

El valor de una variable de entorno personalizada se puede recuperar de la misma manera como el valor de una variable de entorno de FunctionGraph.

Ejemplo

Este ejemplo contiene un archivo llamado bootstrap. El archivo se implementa en Bash.

El tiempo de ejecución carga el script de función desde el paquete de implementación por el uso de dos variables.

El archivo bootstrap es como el siguiente:

#!/bin/sh

set -o pipefail

#Processing requests loop
while true
do
HEADERS="$(mktemp)"
  # Get an event
  EVENT_DATA=$(curl
-sS -LD "$HEADERS" -X GET
"http://$RUNTIME_API_ADDR/v1/runtime/invocation/request")
  # Get request id
from response header
  REQUEST_ID=$(grep
-Fi x-cff-request-id "$HEADERS" | tr -d '[:space:]' | cut -d: -f2)
  if [ -z
"$REQUEST_ID" ]; then
    continue
  fi
  # Process request
data
RESPONSE="Echoing request: '$EVENT_DATA'"
  # Put response
  curl -X POST
"http://$RUNTIME_API_ADDR/v1/runtime/invocation/response/$REQUEST_ID"
-d "$RESPONSE"
done

Después de cargar el script, el tiempo de ejecución procesa los eventos de invocación en un bucle hasta que sea terminado. Utiliza la API para recuperar eventos de invocación de FunctionGraph, pasa los eventos al controlador y luego envía las respuestas a FunctionGraph.

Para obtener el ID de solicitud, el tiempo de ejecución guarda el encabezado de respuesta de la API en un archivo temporal y luego lee el ID de solicitud del campo de encabezado x-cff-request-id. El tiempo de ejecución procesa los datos de eventos recuperados y envía una respuesta a FunctionGraph.

El siguiente es un ejemplo del código fuente en Go. Solo se puede ejecutar después de la compilación.

package main

import (
    "bytes"
    "encoding/json"
    "fmt"
    "io"
    "io/ioutil"
    "log"
    "net"
    "net/http"
    "os"
    "strings"
    "time"
)

var (
    getRequestUrl           = os.ExpandEnv("http://${RUNTIME_API_ADDR}/v1/runtime/invocation/request")
    putResponseUrl          = os.ExpandEnv("http://${RUNTIME_API_ADDR}/v1/runtime/invocation/response/{REQUEST_ID}")
    putErrorResponseUrl     = os.ExpandEnv("http://${RUNTIME_API_ADDR}/v1/runtime/invocation/error/{REQUEST_ID}")
    requestIdInvalidError   = fmt.Errorf("request id invalid")
    noRequestAvailableError = fmt.Errorf("no request available")
    putResponseFailedError  = fmt.Errorf("put response failed")
    functionPackage         = os.Getenv("RUNTIME_PACKAGE")
    functionName            = os.Getenv("RUNTIME_FUNC_NAME")
    functionVersion         = os.Getenv("RUNTIME_FUNC_VERSION")

    client = http.Client{
        Transport: &http.Transport{
            DialContext: (&net.Dialer{
                Timeout: 3 * time.Second,
            }).DialContext,
        },
    }
)

func main() {
    // main loop for processing requests.
    for {
        requestId, header, payload, err := getRequest()
        if err != nil {
            time.Sleep(50 * time.Millisecond)
            continue
        }

        result, err := processRequestEvent(requestId, header, payload)
        err = putResponse(requestId, result, err)
        if err != nil {
            log.Printf("put response failed, err: %s.", err.Error())
        }
    }
}

// event processing function
func processRequestEvent(requestId string, header http.Header, evtBytes []byte) ([]byte, error) {
    log.Printf("processing request '%s'.", requestId)
    result := fmt.Sprintf("function: %s:%s:%s, request id: %s, headers: %+v, payload: %s", functionPackage, functionName,
        functionVersion, requestId, header, string(evtBytes))
    var event FunctionEvent
    err := json.Unmarshal(evtBytes, &event)
    if err != nil {
        return (&ErrorMessage{ErrorType: "invalid event", ErrorMessage: "invalid json formated event"}).toJsonBytes(), err
    }

    return (&APIGFormatResult{StatusCode: 200, Body: result}).toJsonBytes(), nil
}

func getRequest() (string, http.Header, []byte, error) {
    resp, err := client.Get(getRequestUrl)
    if err != nil {
        log.Printf("get request error, err: %s.", err.Error())
        return "", nil, nil, err
    }
    defer resp.Body.Close()

    // get request id from response header
    requestId := resp.Header.Get("X-CFF-Request-Id")
    if requestId == "" {
        log.Printf("request id not found.")
        return "", nil, nil, requestIdInvalidError
    }

    payload, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        log.Printf("read request body error, err: %s.", err.Error())
        return "", nil, nil, err
    }

    if resp.StatusCode != 200 {
        log.Printf("get request failed, status: %d, message: %s.", resp.StatusCode, string(payload))
        return "", nil, nil, noRequestAvailableError
    }

    log.Printf("get request ok.")
    return requestId, resp.Header, payload, nil
}

func putResponse(requestId string, payload []byte, err error) error {
    var body io.Reader
    if payload != nil && len(payload) > 0 {
        body = bytes.NewBuffer(payload)
    }

    url := ""
    if err == nil {
        url = strings.Replace(putResponseUrl, "{REQUEST_ID}", requestId, -1)
    } else {
        url = strings.Replace(putErrorResponseUrl, "{REQUEST_ID}", requestId, -1)
    }

    resp, err := client.Post(strings.Replace(url, "{REQUEST_ID}", requestId, -1), "", body)
    if err != nil {
        log.Printf("put response error, err: %s.", err.Error())
        return err
    }
    defer resp.Body.Close()

    responsePayload, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        log.Printf("read request body error, err: %s.", err.Error())
        return err
    }

    if resp.StatusCode != 200 {
        log.Printf("put response failed, status: %d, message: %s.", resp.StatusCode, string(responsePayload))
        return putResponseFailedError
    }

    return nil
}

type FunctionEvent struct {
    Type string `json:"type"`
    Name string `json:"name"`
}

type APIGFormatResult struct {
    StatusCode      int               `json:"statusCode"`
    IsBase64Encoded bool              `json:"isBase64Encoded"`
    Headers         map[string]string `json:"headers,omitempty"`
    Body            string            `json:"body,omitempty"`
}

func (result *APIGFormatResult) toJsonBytes() []byte {
    data, err := json.MarshalIndent(result, "", "  ")
    if err != nil {
        return nil
    }

    return data
}

type ErrorMessage struct {
    ErrorType     string `json:"errorType"`
    ErrorMessage  string `json:"errorMessage"`
}

func (errMsg *ErrorMessage) toJsonBytes() []byte {
    data, err := json.MarshalIndent(errMsg, "", "  ")
    if err != nil {
        return nil
    }

    return data
}

Tabla 3 describe las variables de entorno utilizadas en el código anterior.