Desarrollo de un trabajador de metadatos de Asset compute

Los trabajadores de Asset compute XMP AEM personalizadas pueden producir datos (XML) de la que se envían de vuelta a los recursos y se almacenan como metadatos en un recurso.

Los casos de uso comunes incluyen:

Qué va a hacer

En este tutorial crearemos un asistente de metadatos de Asset compute AEM que deriva los colores más utilizados en un recurso de imagen y escribe los nombres de los colores de nuevo en los metadatos del recurso en el formato de metadatos. Aunque el propio trabajador es básico, este tutorial lo utiliza para explorar cómo se pueden utilizar los trabajadores de Assets computes para escribir metadatos en los recursos de AEM as a Cloud Service.

Flujo lógico de una invocación del trabajador de metadatos de Asset compute

La invocación de los trabajadores de metadatos de Asset compute XMP es casi idéntica a la de los trabajadores que generan la representación binaria, con la diferencia principal de que el tipo de valor devuelto es una representación de tipo de datos (XML) cuyos valores también se escriben en los metadatos del recurso.

Los trabajadores de asset compute implementan el contrato de API de trabajo del SDK de Asset compute, en la función renditionCallback(...), que conceptualmente es:

Configuración de manifest.yml manifest

Todos los trabajadores de Asset compute deben estar registrados en manifest.yml.

Abra manifest.yml del proyecto y agregue una entrada de trabajo que configure el nuevo trabajador, en este caso metadata-colors.

Recuerde que .yml distingue entre espacios en blanco.

packages:
  __APP_PACKAGE__:
    license: Apache-2.0
    actions:
      worker:
        function: actions/worker/index.js
        web: 'yes'
        runtime: 'nodejs:12'
        limits:
          timeout: 60000 # in ms
          memorySize: 512 # in MB
          concurrency: 10
        annotations:
          require-adobe-auth: true
      metadata-colors:
        function: actions/metadata-colors/index.js
        web: 'yes'
        runtime: 'nodejs:12'
        limits:
          memorySize: 512 # in MB

function señala a la implementación de trabajador creada en el siguiente paso. Asigne un nombre semántico a los trabajadores (por ejemplo, actions/worker/index.js podría haberse denominado mejor actions/rendition-circle/index.js), tal como se muestra en la URL del trabajador y también determine el nombre de la carpeta del grupo de pruebas de worker.

limits y require-adobe-auth se configuran de forma discreta por trabajador. En este trabajador, se asigna 512 MB de memoria a medida que el código inspecciona (potencialmente) datos de imágenes binarias grandes. Los otros limits se han eliminado para utilizar los valores predeterminados.

Desarrollo de un trabajador de metadatos metadata-worker

Cree un nuevo archivo JavaScript de trabajo de metadatos en el proyecto de Asset compute en la ruta manifest.yml definido para el nuevo trabajador, en /actions/metadata-colors/index.js

Instalación de módulos npm

Instale los módulos npm adicionales (@adobe/asset-compute-xmp, get-image-colors y color-namer) que se utilizan en este trabajador de Asset compute.

$ npm install @adobe/asset-compute-xmp
$ npm install get-image-colors
$ npm install color-namer

Código de trabajo de metadatos

XMP AEM Este trabajador tiene un aspecto muy similar al trabajador que genera la representación, la diferencia principal es que escribe datos (XML) en el rendition.path para que se vuelvan a guardar en el.

"use strict";

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

// Require the @adobe/asset-compute-xmp module to create XMP
const { serializeXmp } = require("@adobe/asset-compute-xmp");

// Require supporting npm modules to derive image colors from image data
const getColors = require("get-image-colors");
// Require supporting npm modules to convert image colors to color names
const namer = require("color-namer");

exports.main = worker(async (source, rendition, params) => {
  // Perform any necessary source (input) checks
  const stats = await fs.stat(source.path);
  if (stats.size === 0) {
    // Throw appropriate errors whenever an erring condition is met
    throw new SourceCorruptError("source file is empty");
  }
  const MAX_COLORS = 10;
  const DEFAULT_COLORS_FAMILY = 'basic';

  // Read the color family parameter to use to derive the color names
  let colorsFamily = rendition.instructions.colorsFamily || DEFAULT_COLORS_FAMILY;

  if (['basic', 'hex', 'html', 'ntc', 'pantone', 'roygbiv'].indexOf(colorsFamily) === -1) {
      colorsFamily = DEFAULT_COLORS_FAMILY;
  }

  // Use the `get-image-colors` module to derive the most common colors from the image
  let colors = await getColors(source.path, { options: MAX_COLORS });

  // Convert the color Chroma objects to their closest names
  let colorNames = colors.map((color) => getColorName(colorsFamily, color));

  // Serialize the data to XMP metadata
  // These properties are written to the [dam:Asset]/jcr:content/metadata resource
  // This stores
  // - The list of color names is stored in a JCR property named `wknd:colors`
  // - The colors family used to derive the color names is stored in a JCR property named `wknd:colorsFamily`
  const xmp = serializeXmp({
      // Use a Set to de-duplicate color names
      "wknd:colors": [...new Set(colorNames)],
      "wknd:colorsFamily": colorsFamily
    }, {
      // Define any property namespaces used in the above property/value definition
      // These namespaces are automatically registered in AEM if they do not yet exist
      namespaces: {
        wknd: "https://wknd.site/assets/1.0/",
      },
    }
  );

  // Save the XMP metadata to be written back to the asset's metadata node
  await fs.writeFile(rendition.path, xmp, "utf-8");
});

/**
 * Helper function that derives the closest color name for the color, based on the colors family
 *
 * @param {*} colorsFamily the colors name family to use
 * @param {*} color the color to convert to a name
 */
function getColorName(colorsFamily, color) {
    if ('hex' === colorsFamily) {  return color; }

    let names = namer(color.rgb())[colorsFamily];

    if (names.length >= 1) { return names[0].name; }
}

Ejecute el trabajador de metadatos localmente development-tool

Una vez completado el código de trabajo, se puede ejecutar mediante la herramienta de desarrollo de Assets computes local.

Debido a que nuestro proyecto de Asset compute contiene dos empleados (la representación circular anterior y este metadata-colors), la definición de perfil Herramienta de desarrollo de Asset compute enumera los perfiles de ejecución de ambos. La segunda definición de perfil apunta al nuevo trabajador metadata-colors.

Prueba del trabajador test

Los trabajadores de metadatos se pueden probar con el mismo marco de pruebas de Asset compute que las representaciones binarias. XMP La única diferencia es que el archivo rendition.xxx en el caso de prueba debe ser la representación esperada de los archivos de datos (XML) de los archivos de datos (XML).

Implementación del trabajador en Adobe I/O Runtime deploy

Para invocar este nuevo trabajador de metadatos desde AEM Assets, debe implementarse en Adobe I/O Runtime mediante el comando:

$ aio app deploy

Tenga en cuenta que esto implementará todos los trabajadores del proyecto. Revise las instrucciones de implementación sin abreviar para ver cómo implementar en los espacios de trabajo de ensayo y producción.

AEM Integración con Perfiles de procesamiento de processing-profile

AEM Invoque el trabajador desde la creación de un nuevo servicio de perfil de procesamiento personalizado, o modifique uno existente, que invoque este trabajador implementado.

Actualizar el esquema de metadatos metadata-schema

Para revisar los metadatos de colores, asigne dos nuevos campos del esquema de metadatos de la imagen a las nuevas propiedades de datos de metadatos que rellena el trabajador.

Procesando recursos

Con los metadatos de color escritos en los metadatos del recurso, en el recurso [dam:Asset]/jcr:content/metadata, estos metadatos se indexan con una mayor capacidad de detección de recursos mediante estos términos mediante la búsqueda, y se pueden volver a escribir en el archivo binario del recurso si, después, se invoca el flujo de trabajo DAM Metadata Writeback en él.

Representación de metadatos en AEM Assets

XMP El archivo de datos generado por el trabajador de metadatos de Asset compute también se almacena como una representación discreta en el recurso. AEM Este archivo no se utiliza generalmente, sino que se utilizan los valores aplicados al nodo de metadatos del recurso, pero la salida XML sin procesar del trabajador está disponible en el modo de ejecución de la.

código de trabajo metadata-colors en Github

El metadata-colors/index.js final está disponible en Github en:

El grupo de pruebas test/asset-compute/metadata-colors final está disponible en Github en: