Desarrollar una aplicación personalizada develop

Antes de empezar a desarrollar una aplicación personalizada:

Creación de una aplicación personalizada create-custom-application

Asegúrese de tener Adobe aio-cli instalado localmente.

Consulte aplicaciones personalizadas de ejemplo para ver ejemplos e ideas de aplicaciones personalizadas.

Añadir credenciales add-credentials

Al iniciar sesión al crear la aplicación, la mayoría de las credenciales de App Builder se recopilan en el archivo ENV. Sin embargo, el uso de la herramienta para desarrolladores requiere credenciales adicionales.

Credenciales de almacenamiento de herramientas para desarrolladores developer-tool-credentials

La herramienta para que los desarrolladores evalúen las aplicaciones personalizadas que usan Asset Compute service necesita el uso de un contenedor de almacenamiento en la nube. Este contenedor es esencial para almacenar los archivos de prueba y para la recepción y presentación de las representaciones producidas por las aplicaciones.

Asegúrese de tener acceso a un contenedor de almacenamiento en la nube compatible. Varios desarrolladores utilizan este contenedor de forma colectiva para diferentes proyectos siempre que es necesario.

Agregar credenciales al archivo ENV add-credentials-env-file

Inserte las credenciales subsiguientes para la herramienta de desarrollo en el archivo .env. El archivo se encuentra en la raíz del proyecto de App Builder:

Ejecución de la aplicación run-custom-application

Antes de ejecutar la aplicación con la herramienta para desarrolladores de Assets computes, configure correctamente credentials.

Para ejecutar la aplicación en la herramienta para desarrolladores, utilice el comando aio app run. Implementa la acción en el Adobe I/O Runtime e inicia la herramienta de desarrollo en el equipo local. Esta herramienta se utiliza para probar las solicitudes de aplicación durante el desarrollo. Este es un ejemplo de solicitud de representación:

"renditions": [
    {
        "worker": "https://1234_my_namespace.adobeioruntime.net/api/v1/web/example-custom-worker-master/worker",
        "name": "image.jpg"
    }
]

Vea aquí cómo probar y depurar su aplicación. Cuando haya terminado de desarrollar su aplicación personalizada, implemente su aplicación personalizada.

Pruebe la aplicación de ejemplo proporcionada por Adobe. try-sample

A continuación se muestran ejemplos de aplicaciones personalizadas:

Aplicación personalizada de plantilla template-custom-application

worker-basic es una aplicación de plantilla. Genera una representación simplemente copiando el archivo de origen. El contenido de esta aplicación es la plantilla recibida al elegir Adobe Asset Compute en la creación de la aplicación AIO.

El archivo de aplicación worker-basic.js usa asset-compute-sdk para descargar el archivo de origen, organizar cada procesamiento de representación y cargar las representaciones resultantes de nuevo en el almacenamiento de la nube.

El renditionCallback definido dentro del código de aplicación es donde se debe realizar toda la lógica de procesamiento de la aplicación. La llamada de retorno de representación de worker-basic simplemente copia el contenido del archivo de origen en el archivo de representación.

const { worker } = require('@adobe/asset-compute-sdk');
const fs = require('fs').promises;

exports.main = worker(async (source, rendition) => {
    // copy source to rendition to transfer 1:1
    await fs.copyFile(source.path, rendition.path);
});

Llamar a una API externa call-external-api

En el código de la aplicación, puede realizar llamadas de API externas para ayudar con el procesamiento de la aplicación. A continuación encontrará un archivo de aplicación de ejemplo que invoca una API externa.

exports.main = worker(async function (source, rendition) {

    const response = await fetch('https://adobe.com', {
        method: 'GET',
        Authorization: params.AUTH_KEY
    })
});

Por ejemplo, worker-animal-pictures realiza una solicitud de captura a una dirección URL estática desde Wikimedia usando la biblioteca node-httptransfer.

Pasar parámetros personalizados pass-custom-parameters

Puede pasar parámetros definidos personalizados a través de los objetos de representación. Se puede hacer referencia a ellos dentro de la aplicación en rendition instrucciones. Un ejemplo de objeto de representación es el siguiente:

"renditions": [
    {
        "worker": "https://1234_my_namespace.adobeioruntime.net/api/v1/web/example-custom-worker-master/worker",
        "name": "image.jpg",
        "my-custom-parameter": "my-custom-parameter-value"
    }
]

Un ejemplo de archivo de aplicación que tiene acceso a un parámetro personalizado es el siguiente:

exports.main = worker(async function (source, rendition) {

    const customParam = rendition.instructions['my-custom-parameter'];
    console.log('Custom paramter:', customParam);
    // should print out `Custom parameter: "my-custom-parameter-value"`
});

example-worker-animal-pictures pasa un parámetro personalizado animal para determinar qué archivo se va a obtener de Wikimedia.

Compatibilidad con autenticación y autorización authentication-authorization-support

De forma predeterminada, las aplicaciones personalizadas de Asset Compute incluyen comprobaciones de autorización y autenticación para el proyecto de App Builder. Se habilitó al establecer la anotación require-adobe-auth en true en manifest.yml.

Acceso a otras API de Adobe access-adobe-apis

Agregue los servicios API al área de trabajo de la consola Asset Compute creada durante la instalación. Estos servicios forman parte del token de acceso JWT generado por Asset Compute Service. Se puede acceder al token y a otras credenciales dentro del objeto de acción params de la aplicación.

const accessToken = params.auth.accessToken; // JWT token for Technical Account with entitlements from the console workspace to the API service
const clientId = params.auth.clientId; // Technical Account client Id
const orgId = params.auth.orgId; // Experience Cloud Organization

Pasar credenciales para sistemas de terceros pass-credentials-for-tp

Para gestionar las credenciales de otros servicios externos, páselas como parámetros predeterminados en las acciones. Se cifran automáticamente en tránsito. Para obtener más información, consulte creación de acciones en la guía para desarrolladores de Adobe I/O Runtime. A continuación, configúrelos mediante variables de entorno durante la implementación. Se puede tener acceso a estos parámetros en el objeto params dentro de la acción.

Establecer los parámetros predeterminados dentro de inputs en manifest.yml:

packages:
  __APP_PACKAGE__:
    actions:
      worker:
        function: 'index.js'
        runtime: 'nodejs:10'
        web: true
        inputs:
           secretKey: $SECRET_KEY
        annotations:
          require-adobe-auth: true

La expresión $VAR lee el valor de una variable de entorno denominada VAR.

Al desarrollar, puede asignar el valor en el archivo .env local. El motivo es que aio importa automáticamente variables de entorno de .env archivos, junto con las variables establecidas por el shell iniciador. En este ejemplo, el archivo .env tiene el siguiente aspecto:

#...
SECRET_KEY=secret-value

Para la implementación de producción se pueden establecer las variables de entorno en el sistema de CI, por ejemplo, usando secretos en las acciones de GitHub. Por último, acceda a los parámetros predeterminados dentro de la aplicación como tal:

const key = params.secretKey;

Tamaño de aplicaciones sizing-workers

Se ejecuta una aplicación en un contenedor del Adobe I/O Runtime con límites que se pueden configurar a través de manifest.yml:

    actions:
      myworker:
        function: /actions/myworker/index.js
        limits:
          timeout: 300000
          memorySize: 512
          concurrency: 1

Debido al amplio procesamiento realizado por las aplicaciones de Asset compute, debe ajustar estos límites para obtener un rendimiento óptimo (lo suficientemente grande como para gestionar recursos binarios) y una mayor eficacia (sin desperdiciar recursos debido a la memoria contenedora no utilizada).

El tiempo de espera predeterminado para las acciones en tiempo de ejecución es de un minuto, pero se puede aumentar estableciendo el límite de timeout (en milisegundos). Si espera procesar archivos más grandes, aumente este tiempo. Considere el tiempo total que tarda en descargar el origen, procesar el archivo y cargar la representación. Si se agota el tiempo de espera de una acción, es decir, no se devuelve la activación antes del límite de tiempo de espera especificado, Runtime descarta el contenedor y no lo vuelve a utilizar.

Las aplicaciones de asset compute por naturaleza tienden a estar enlazadas a la red y a la entrada o salida del disco. El archivo de origen debe descargarse primero. El procesamiento suele consumir muchos recursos y, a continuación, las representaciones resultantes se cargan de nuevo.

Puede especificar la memoria asignada a un contenedor de acciones en megabytes mediante el parámetro memorySize. Actualmente, este parámetro también define cuánto acceso de CPU obtiene el contenedor y, lo que es más importante, es un elemento clave del coste de utilizar Runtime (los contenedores más grandes cuestan más). Utilice un valor mayor aquí cuando el procesamiento requiera más memoria o CPU, pero tenga cuidado de no desperdiciar recursos, ya que cuanto más grandes sean los contenedores, menor será el rendimiento general.

Además, es posible controlar la concurrencia de acciones dentro de un contenedor mediante la configuración concurrency. Esta configuración es el número de activaciones simultáneas que obtiene un solo contenedor (de la misma acción). En este modelo, el contenedor de acciones es como un servidor Node.js que recibe varias solicitudes simultáneas, hasta ese límite. El valor predeterminado memorySize en tiempo de ejecución se establece en 200 MB, lo que resulta ideal para acciones de App Builder más pequeñas. En el caso de las aplicaciones de Asset compute, este valor predeterminado puede ser excesivo debido a que utilizan más recursos de disco y procesamiento local. Según su implementación, es posible que algunas aplicaciones no funcionen bien con la actividad simultánea. El SDK de Asset Compute garantiza que las activaciones estén separadas por la escritura de archivos en diferentes carpetas únicas.

Probar aplicaciones para encontrar los números óptimos de concurrency y memorySize. Contenedores más grandes = un límite de memoria más alto podría permitir una mayor concurrencia, pero también podría ser un derroche para un tráfico más bajo.