Detalles internos de una aplicación personalizada how-custom-application-works

Utilice la siguiente ilustración para comprender el flujo de trabajo de extremo a extremo cuando un cliente procesa un recurso digital mediante una aplicación personalizada.

Imagen: pasos necesarios para procesar un recurso mediante Asset Compute Service.

Registro registration

El cliente debe llamar a /register una vez antes de la primera solicitud a /process para configurar y recuperar la URL del diario para recibir Adobe I/O Eventos de Asset compute de Adobe.

curl -X POST \
  https://asset-compute.adobe.io/register \
  -H "x-ims-org-id: $ORG_ID" \
  -H "x-gw-ims-org-id: $ORG_ID" \
  -H "Authorization: Bearer $JWT_TOKEN" \
  -H "x-api-key: $API_KEY"

El @adobe/asset-compute-client La biblioteca JavaScript de se puede utilizar en aplicaciones NodeJS para gestionar todos los pasos necesarios desde el registro, el procesamiento y el control asincrónico de eventos. Para obtener más información sobre los encabezados obligatorios, consulte Autenticación y autorización.

Procesando processing

El cliente envía un procesamiento solicitud.

curl -X POST \
  https://asset-compute.adobe.io/process \
  -H "x-ims-org-id: $ORG_ID" \
  -H "x-gw-ims-org-id: $ORG_ID" \
  -H "Authorization: Bearer $JWT_TOKEN" \
  -H "x-api-key: $API_KEY" \
  -d "<RENDITION_JSON>

El cliente es responsable de dar formato correcto a las representaciones con direcciones URL firmadas previamente. El @adobe/node-cloud-blobstore-wrapper La biblioteca JavaScript de se puede utilizar en aplicaciones NodeJS para firmar previamente las direcciones URL. Actualmente, la biblioteca solo admite el almacenamiento de Azure Blob y los contenedores de AWS S3.

La solicitud de procesamiento devuelve un requestId que se puede utilizar para sondear Adobe I/O Eventos.

A continuación encontrará un ejemplo de solicitud de procesamiento de aplicaciones personalizadas.

{
    "source": "https://www.adobe.com/some-source-file.jpg",
    "renditions" : [
        {
            "worker": "https://my-project-namespace.adobeioruntime.net/api/v1/web/my-namespace-version/my-worker",
            "name": "rendition1.jpg",
            "target": "https://some-presigned-put-url-for-rendition1.jpg",
        }
    ],
    "userData": {
        "my-asset-id": "1234567890"
    }
}

El Asset Compute Service envía las solicitudes de representación de aplicaciones personalizadas a la aplicación personalizada. Utiliza un POST HTTP para la URL de aplicación proporcionada, que es la URL de acción web segura desde App Builder. Todas las solicitudes utilizan el protocolo HTTPS para maximizar la seguridad de los datos.

El ASSET COMPUTE SDK utilizado por una aplicación personalizada administra la solicitud del POST HTTP. También gestiona la descarga del origen, la carga de representaciones y el envío Adobe I/O eventos y gestión de errores.

Código de aplicación application-code

El código personalizado solo necesita proporcionar una llamada de retorno que tome el archivo de origen disponible localmente (source.path). El rendition.path es la ubicación para colocar el resultado final de una solicitud de procesamiento de recursos. La aplicación personalizada utiliza la llamada de retorno para convertir los archivos de origen disponibles localmente en un archivo de representación utilizando el nombre pasado (rendition.path). Una aplicación personalizada debe escribir en rendition.path para crear una representación:

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

// worker() is the entry point in the SDK "framework".
// The asynchronous function defined is the rendition callback.
exports.main = worker(async (source, rendition) => {

    // Tip: custom worker parameters are available in rendition.instructions.
    console.log(rendition.instructions.name); // should print out `rendition.jpg`.

    // Simplest example: copy the source file to the rendition file destination so as to transfer the asset as is without processing.
    await fs.copyFile(source.path, rendition.path);
});

Descargar archivos de origen download-source

Una aplicación personalizada solo trata los archivos locales. La descarga del archivo de origen se administra mediante el ASSET COMPUTE SDK.

Creación de representación rendition-creation

El SDK llama a un función de devolución de llamada de representación para cada representación.

La función de llamada de retorno tiene acceso a origen y representación objetos. El source.path ya existe y es la ruta a la copia local del archivo de origen. El rendition.path es la ruta en la que se debe almacenar la representación procesada. A menos que Indicador disableSourceDownload se configura, la aplicación debe utilizar exactamente el rendition.path. De lo contrario, el SDK no podrá localizar ni identificar el archivo de representación y producirá un error.

La simplificación excesiva del ejemplo se realiza para ilustrar y centrarse en la anatomía de una aplicación personalizada. La aplicación solo copia el archivo de origen en el destino de la representación.

Para obtener más información sobre los parámetros de devolución de llamada de representación, consulte API DE SDK DE ASSET COMPUTE.

Cargar representaciones upload-rendition

Después de cada representación se crea y se almacena en un archivo con la ruta proporcionada por rendition.path, el ASSET COMPUTE SDK carga cada representación en un almacenamiento en la nube (AWS o Azure). Una aplicación personalizada obtiene varias representaciones al mismo tiempo si, y solo si, la solicitud entrante tiene varias representaciones que apuntan a la misma dirección URL de aplicación. La carga en el almacenamiento en la nube se realiza después de cada representación y antes de ejecutar la llamada de retorno para la siguiente representación.

El batchWorker() tiene un comportamiento diferente, ya que en realidad procesa todas las representaciones y solo después de que todas se hayan procesado, las carga.

Adobe I/O Eventos aio-events

El SDK envía Adobe I/O Eventos para cada representación. Estos eventos son de cualquier tipo rendition_created o rendition_failed en función del resultado. Consulte Asset compute de eventos asincrónicos para obtener detalles de los eventos.

Recibir Adobe I/O Eventos receive-aio-events

El cliente sondea el Adobe I/O Diario de eventos según su lógica de consumo. La dirección URL inicial del diario es la que se proporciona en el /register Respuesta de API. Los eventos se pueden identificar mediante el requestId que está presente en los eventos y es el mismo que se devuelve en /process. Cada representación tiene un evento independiente que se envía en cuanto se carga (o falla) la representación. Una vez que recibe un evento coincidente, el cliente puede mostrar o administrar de otro modo las representaciones resultantes.

La biblioteca JavaScript asset-compute-client simplifica el sondeo de diarios utilizando waitActivation() para obtener todos los eventos.

const events = await assetCompute.waitActivation(requestId);
await Promise.all(events.map(event => {
    if (event.type === "rendition_created") {
        // get rendition from cloud storage location
    }
    else if (event.type === "rendition_failed") {
        // failed to process
    }
    else {
        // other event types
        // (could be added in the future)
    }
}));

Para obtener más información sobre cómo obtener eventos de diario, consulte Adobe I/O API de eventos.