Referencia de funciones sin servidor

Last updated:

Nota: si estás creando una función sin servidor como parte de un proyecto de desarrollador, en su lugar visita la documentación de la función sin servidor del proyecto de desarrollador. La siguiente documentación es para crear funciones sin servidor fuera de la plataforma del proyecto de desarrollador.

APPLICABLE PRODUCTS
  • Content Hub
    • Enterprise

En este artículo, aprende sobre los archivos que se encuentran dentro de una carpeta .functions sin servidor y los comandos CLI que puedes utilizar con las funciones sin servidor.

Para obtener un resumen general de las funciones sin servidor, consulta la descripción general de las funciones sin servidor.

Para obtener más información sobre la creación de funciones sin servidor con proyectos para módulos renderizados y parciales de JavaScript, consulta la documentación de proyectos de desarrollador.

Serverless.json

En la carpeta .functions, el archivo serverless.json almacena la configuración de la función sin servidor. Este es un archivo obligatorio y asigna tus funciones a sus puntos de terminación.

// serverless.json { "runtime": "nodejs18.x", "version": "1.0", "environment": { "globalConfigKey": "some-value" }, "secrets": ["secretName"], "endpoints": { "events": { "file": "function1.js", "method":"GET" }, "events/update": { "method": "POST", "file": "action2.js", "environment": { "CONFIG_KEY": "some-other-value" }, "secrets": ["googleKeyName","otherkeyname"] } } }
Use this table to describe parameters / fields
ClaveTypeDescription
runtime
obligatorio
String

El entorno de ejecución. Admite las siguientes versiones de Node.js:

  • Nodo 18 (nodejs18.x) (recomendado)
  • Nodo 16 (nodejs16.x)
version
obligatorio
String

Versión del esquema de funciones sin servidor de HubSpot. (Versión actual 1.0)

environment
Objetos

Variables de configuración pasadas a la función ejecutante como variables de entorno en tiempo de ejecución. Puedes usar esto para agregar una lógica para usar una versión de prueba de una API en lugar de la real basada en una variable de entorno.

secrets
Matriz

Una matriz que contiene los nombres de los secretos que tu función sin servidor utilizará para la autenticación. No almacenes secretos directamente en este archivo, solo haz referencia a los nombres de los secretos. 

endpoints
obligatorio
Objetos

Los puntos de terminación definen las rutas que se exponen y tu asignación a archivos JavaScript específicos, dentro de tu carpeta de funciones. Obtén más información sobre puntos de terminación a continuación.

Nota: no asignes el mismo nombre a tus secretos y variables de entorno. Si lo haces, se producirán conflictos al devolver tus valores en la función.

Puntos de terminación

Cada punto de terminación puede tener sus propias variables de entorno y secretos. Las variables especificadas fuera de los puntos de terminación deben utilizarse para los ajustes de configuración que se aplican a todas las funciones y puntos de terminación.

"events/update": { "method": "POST", "file": "action2.js", "environment": { "configKey": "some-other-value" }, "secrets": ["googleAPIKeyName","otherKeyName"] }

Los puntos de terminación tienen un par de claves únicas.

Use this table to describe parameters / fields
ClaveTypeDescription
method
Cadena o matriz de cadenas

Método o métodos HTTP que admite el punto de terminación. El valor predeterminado es GET.

file
obligatorio
String

Ruta al archivo de la función JavaScript con la implementación para el punto de terminación.

Las funciones sin servidor se exponen a través de una ruta en el dominio de tu cuenta de HubSpot CMS. Esto incluye los subdominios predeterminados .hs-sites.com.

Puedes acceder a estas funciones en la siguiente URL: 

https://{domainName}/_hcms/api/{endpoint-name/path}?portalid={hubId}.

A continuación, conoce cada uno de los componentes de la URL:

Use this table to describe parameters / fields
ParameterDescription
domainName

Tu nombre de dominio.

/_hcms/api/

La ruta reservada para las funciones sin servidor. Todos los puntos de terminación existen dentro de esta ruta.

endpoint-name/path

El nombre del punto de terminación o la ruta que especificaste en el archivo serverless.json.

hubId

Tu ID de Hub Proporcionar esto en la solicitud te permitirá probar tus funciones dentro de las vistas previas de módulos y plantillas.

Archivo de funciones

Además del archivo de configuración serverless.json, la carpeta .functions también contendrá un archivo JavaScript Node.js que define la función. También puedes aprovechar la biblioteca de solicitudes para realizar solicitudes HTTP a las API de HubSpot y otras API.

Por ejemplo:

// Require axios library, to make API requests. const axios = require('axios'); // Environment variables from your serverless.json // process.env.globalConfigKey exports.main = (context, sendResponse) => { // your code called when the function is executed // context.params // context.body // context.accountId // context.limits // secrets created using the CLI are available in the environment variables. // process.env.secretName //sendResponse is what you will send back to services hitting your serverless function. sendResponse({body: {message:"my response"}, statusCode: 200}); };

Objeto de contexto

El objeto de contexto contiene información contextual sobre la ejecución de la función, almacenada en los siguientes parámetros.

Claves de objeto de contexto
ParameterDescription
accountId

El ID de la cuenta de HubSpot que contiene la función.

body

Lleno si la solicitud se envía como POST con un tipo de contenido application/json.

contact

Si la solicitud proviene de un contacto con cookies, el objeto contacto estará lleno con un conjunto de propiedades básicas del contacto junto con la siguiente información:

  • vid: El ID de visitante del contacto.
  • isLoggedIn: cuando se utiliza CMS Memberships, esto será true si el contacto está registrado en el dominio
  • listMemberships: una matriz de ID de listas de contactos de las que este contacto es miembro
headers

Contiene los títulos enviados por el cliente que llega a tu punto de terminación.

params

Rellenado con valores de cadena de consulta junto con cualquier valor HTML Form-POSTed. Se estructuran como un mapa con cadenas como claves y una matriz de cadenas para cada valor.

context.params.yourvalue

limits

Devuelve lo cerca que estás de alcanzar los límites de velocidad de las funciones sin servidor.

  • executionsRemaining: cuántas ejecuciones por minuto quedan.
  • timeRemaining: cuánto tiempo de ejecución permitido queda.

Encabezados

Si necesitas conocer los encabezados del cliente que está llegando a tu punto de terminación, puedes acceder a ellos a través de context.headers, similar a cómo accederías a la información a través de context.body.

A continuación, revisa algunos de los encabezados comunes que proporciona HubSpot. Para obtener una lista completa, consulta la documentación de encabezados HTTP de MDN.

Use this table to describe parameters / fields
encabezadoDescription
accept

Comunica qué tipos de contenido, expresados como tipos MIME, entiende el cliente. Consulta MDN.

accept-encoding

Comunica la codificación del contenido que el cliente entiende. Consulta MDN.

accept-language

Comunica qué idioma humano y localización se prefiere. Consulta MDN.

cache-control

Contiene directivas para el almacenamiento en caché. Consulta MDN.

connection

Comunica si la conexión de red permanece abierta. Consulta MDN.

cookie

Contiene las cookies enviadas por el cliente. Consulta MDN.

host

Comunica el nombre de dominio y el número de puerto TCP de un servidor de escucha. Consulta MDN.

true-client-ip

Dirección IP del usuario final. Consulta Cloudflare true-client-ip.

upgrade-insecure-requests

Comunica la preferencia del cliente por una respuesta cifrada y autentificada. Consulta MDN.

user-agent

Cadena definida por el proveedor que identifica la aplicación, el sistema operativo, el proveedor de la aplicación y la versión. Consulta MDN.

x-forwarded-for

Identifica la dirección IP de origen de un cliente a través de un proxy o equilibrador de carga. Consulta MDN.

Redirigir enviando una encabezado

Puedes realizar una redirección desde tu función sin servidor enviando una respuesta con un encabezado location y un statusCode 301.

sendResponse({ statusCode: 301, headers: { "Location": "https://www.example.com" } });

Establecer las cookies desde tu punto de terminación

Desde tu función sin servidor puedes decirle al cliente (navegador web) que establezca una cookie.

exports.main = (context, sendResponse) => { sendResponse({ body: { ... }, 'Set-Cookie': 'myCookie1=12345; expires=...; Max-Age=...', statusCode: 200 }); }

Establecer varios valores para un solo encabezado

En el caso de los encabezados que admiten múltiples valores, puedes utilizar multiValueHeaders, para pasar los valores. Por ejemplo: puedes decirle al navegador que establezca varias cookies.

exports.main = (context, sendResponse) => { sendResponse({ body: { ... }, multiValueHeaders: { 'Set-Cookie': [ 'myCookie1=12345; expires=...; Max-Age=...', 'myCookie2=56789; expires=...; Max-Age=...' ] }, statusCode: 200 }); }

Secretos

Cuando necesites autenticar una solicitud de función sin servidor, usarás secretos para almacenar valores como claves de API o tokens de acceso a aplicaciones privadas. Con la CLI, puedes agregar secretos a tu cuenta de HubSpot para almacenar esos valores, a los que luego podrás acceder a través de variables de entorno (process.env.secretName). Los secretos se gestionan a través de la CLI de HubSpot utilizando los siguientes comandos:

Una vez agregados a través de la CLI, los secretos pueden ponerse a disposición de las funciones mediante la inclusión de una matriz de secretos que contenga el nombre del secreto. Esto le permite almacenar tu código de función en el control de versiones y usar secretos sin exponerlos. Sin embargo, nunca debes devolver el valor de tu secreto a través del registro de la consola o como respuesta, ya que esto expondrá el secreto en los registros o en las páginas del front-end que llaman a tu función sin servidor.

Nota: debido al almacenamiento en caché, puede tardar aproximadamente un minuto en ver los valores secretos actualizados. Si acabas de actualizar un secreto pero todavía estás viendo el valor anterior, vuelve a comprobarlo después de aproximadamente un minuto.

Uso de funciones sin servidor con el elemento de formulario

Al enviar funciones sin servidor, utiliza javascript para manejar el envío del formulario y utiliza el encabezado "contentType" : "application/json" en tu solicitud. No utilices el atributo action de los elementos <form>.

CORS

Intercambio de recursos de origen cruzado (CORS) es una función de seguridad del navegador. Por opción predeterminada, los navegadores restringen las solicitudes de origen cruzado iniciadas por javascript. Esto evita que el código malicioso que se ejecuta en un dominio diferente, afecte a tu sitio. Esto se denomina política del mismo origen. Dado que el envío y la recuperación de datos de otros servidores es a veces una necesidad, el servidor externo, puede suministrar encabezados HTTP que comunican qué orígenes están autorizados a leer la información de un navegador.

No deberías tener problemas de CORS al llamar a tu función sin servidor dentro de tus páginas alojadas en HubSpot. Si lo haces, verifica que estás utilizando el protocolo correcto.

¿Recibes este error CORS?
"El acceso a la búsqueda en [tu url de función] desde el origen [solicitud de creación de página] ha sido bloqueado por la política de CORS: la respuesta a la solicitud de prefiltro no pasa la verificación de control de acceso: no hay encabezado 'Access-Control-Allow-Origin' presente en el recurso solicitado. Si una respuesta opaca sirve a tus necesidades, establece el modo de la solicitud como 'no-cors' para obtener el recurso con CORS desactivado"

¿Tu solicitud se dirige a un origen diferente al del sitio que la llama?

  • Si el nombre de dominio es diferente, sí.
  • Si utilizas un protocolo diferente (http, https), sí.

Si utilizas un protocolo diferente, simplemente cambia el protocolo para que coincida y eso lo arreglará. 

En este momento no se puede modificar el encabezado Access-Control-Allow-Origin de HubSpot.

Consulta el MDN para obtener más detalles sobre la solución de errores de CORS.

Solicitudes Get

Las solicitudes Get pueden hacer solicitudes CORS dependiendo del cliente. No hagas que las peticiones GET escriban nada, solo que devuelvan datos.

Paquetes precargados

Las funciones sin servidor de HubSpot vienen actualmente precargadas con los siguientes paquetes:

Para utilizar la última versión compatible de un paquete precargado, o para utilizar un paquete recién agregado:

  1. Clona o copia tu archivo de funciones.
  2. Cambia el punto de terminación de tu función en el archivo serverless.json para que apunte a tu nuevo archivo de función. Puedes eliminar la versión antigua con seguridad.

Si quieres incluir paquetes fuera del conjunto de paquetes precargados, puedes usar webpack para combinar tus módulos de node y hacer que tus archivos agrupados sean tus archivos de función.

Límites

Las funciones sin servidor están previstas para ser rápidas y tener un enfoque limitado. Para permitir llamadas y respuestas rápidas, las funciones sin servidor de HubSpot tienen los siguientes límites:

  • 50 secretos por cuenta.
  • 128 MB de memoria.
  • No más de 100 puntos de terminación por cuenta de HubSpot.
  • Debes usar contentType application/json cuando se llama a una función.
  • Los registros de las funciones sin servidor se almacenan durante 90 días.
  • 6MB en una carga útil de invocación de AWS Lambda.

Límites de ejecución

  • Cada función tiene un tiempo máximo de ejecución de 10 segundos
  • Cada cuenta está limitada a un total de 600 segundos de ejecución por minuto.

Esto significa que cualquiera de estos escenarios puede ocurrir:

  • 60 ejecuciones de funciones que tardan 10 segundos cada una en completarse.
  • 6000 ejecuciones de funciones que tardan 100 milisegundos en completarse.

Las funciones que superen esos límites arrojarán un error. El recuento de ejecuciones y los límites de tiempo devolverán una respuesta 429. El tiempo de ejecución de cada función se incluye en los registros de funciones sin servidor.

Para ayudar a evitar estos límites, los datos de los límites se proporcionan automáticamente al contexto de la función durante la ejecución. Puedes utilizarlo para influir en tu solicitud para mantenerse dentro de esos límites. Por ejemplo, si tu aplicación requiere sondear tu punto de terminación, entonces puedes devolver con tus datos una variable para influir en la frecuencia del sondeo. De este modo, cuando el tráfico es elevado, se puede reducir el ritmo de sondeo para evitar que se alcancen los límites, y luego volver a aumentarlo cuando el tráfico sea escaso.


¿Te resultó útil este artículo?
Con este formulario puedes enviar tu opinión sobre nuestros documentos para desarrolladores. Si tienes comentarios sobre el producto de HubSpot, puedes enviarlos al Foro de ideas.