Desenvolver um aplicativo personalizado develop

Antes de começar a desenvolver um aplicativo personalizado:

Criar um aplicativo personalizado create-custom-application

Verifique se o Adobe-cli está instalado localmente.

Consulte exemplos de aplicativos personalizados para obter exemplos e ideias de aplicativos personalizados.

Adicionar credenciais add-credentials

Conforme você faz logon ao criar o aplicativo, a maioria das credenciais do App Builder é coletada no arquivo ENV. No entanto, o uso da ferramenta de desenvolvedor requer credenciais adicionais.

Credenciais de armazenamento da ferramenta do desenvolvedor developer-tool-credentials

A ferramenta para desenvolvedores avaliarem aplicativos personalizados usando o Asset Compute service requer o uso de um contêiner de armazenamento na nuvem. Esse container é essencial para armazenar arquivos de teste e para o recebimento e a apresentação de representações produzidas pelos aplicativos.

Verifique se você tem acesso a um contêiner de armazenamento na nuvem com suporte. Esse contêiner é usado coletivamente por vários desenvolvedores para diferentes projetos sempre que necessário.

Adicionar credenciais ao arquivo ENV add-credentials-env-file

Insira as credenciais subsequentes da ferramenta de desenvolvimento no arquivo .env. O arquivo está localizado na raiz do projeto do App Builder:

Executar o aplicativo run-custom-application

Antes de executar o aplicativo com a ferramenta de desenvolvedor do Asset Compute, configure corretamente as credenciais.

Para executar o aplicativo na ferramenta de desenvolvedor, use o comando aio app run. Ele implanta a ação no Adobe I/O Runtime e inicia a ferramenta de desenvolvimento no computador local. Essa ferramenta é usada para testar solicitações de aplicativos durante o desenvolvimento. Este é um exemplo de solicitação de representação:

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

Veja aqui como testar e depurar seu aplicativo. Quando terminar de desenvolver o aplicativo personalizado, implante o aplicativo personalizado.

Experimente o aplicativo de amostra fornecido pelo Adobe try-sample

Veja a seguir exemplos de aplicativos personalizados:

Aplicativo personalizado de modelo template-custom-application

O worker-basic é um aplicativo modelo. Ele gera uma representação simplesmente copiando o arquivo de origem. O conteúdo deste aplicativo é o modelo recebido ao escolher Adobe Asset Compute na criação do aplicativo aio.

O arquivo de aplicativo, worker-basic.js usa asset-compute-sdk para baixar o arquivo de origem, orquestrar cada processamento de representação e carregar as representações resultantes de volta para o armazenamento na nuvem.

O renditionCallback definido dentro do código do aplicativo é onde executar toda a lógica de processamento do aplicativo. O retorno de chamada de representação em worker-basic simplesmente copia o conteúdo do arquivo de origem para o arquivo de representação.

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);
});

Chamar uma API externa call-external-api

No código do aplicativo, é possível fazer chamadas de API externas para ajudar no processamento do aplicativo. Um exemplo de arquivo de aplicativo que chama uma API externa está abaixo.

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

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

Por exemplo, o worker-animal-pictures faz uma solicitação de busca para uma URL estática da Wikimedia usando a biblioteca node-httptransfer.

Envio de parâmetros personalizados pass-custom-parameters

Você pode passar parâmetros definidos pelo cliente pelos objetos de representação. Eles podem ser referenciados dentro do aplicativo em rendition instruções. Um exemplo de um objeto de representação é:

"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"
    }
]

Este é um exemplo de um arquivo de aplicativo que acessa um parâmetro personalizado:

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"`
});

O example-worker-animal-pictures passa um parâmetro personalizado animal para determinar qual arquivo buscar na Wikimedia.

Suporte para autenticação e autorização authentication-authorization-support

Por padrão, os aplicativos personalizados do Asset Compute vêm com verificações de Autorização e Autenticação para o projeto do App Builder. Habilitado ao configurar a anotação require-adobe-auth como true em manifest.yml.

Acessar outras APIs Adobe access-adobe-apis

Adicione os serviços de API ao espaço de trabalho do Console Asset Compute criado na configuração. Esses serviços fazem parte do token de acesso JWT gerado por Asset Compute Service. O token e outras credenciais podem ser acessados dentro do objeto de ação de aplicativo params.

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

Transmita credenciais para sistemas de terceiros pass-credentials-for-tp

Para manipular credenciais para outros serviços externos, passe-as como parâmetros padrão nas ações. Eles são criptografados automaticamente em trânsito. Para obter mais informações, consulte criando ações no guia do desenvolvedor do Adobe I/O Runtime. Em seguida, defina-as usando variáveis de ambiente durante a implantação. Esses parâmetros podem ser acessados no objeto params dentro da ação.

Definir os parâmetros padrão dentro de inputs em manifest.yml:

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

A expressão $VAR lê o valor de uma variável de ambiente chamada VAR.

Durante o desenvolvimento, você pode atribuir o valor no arquivo local .env. O motivo é porque aio importa automaticamente variáveis de ambiente de .env arquivos, juntamente com as variáveis definidas pelo shell iniciador. Neste exemplo, o arquivo .env tem a seguinte aparência:

#...
SECRET_KEY=secret-value

Para implantação em produção, é possível definir as variáveis de ambiente no sistema CI, por exemplo, usando segredos em Ações do GitHub. Por fim, acesse os parâmetros padrão dentro do aplicativo da seguinte maneira:

const key = params.secretKey;

Dimensionamento de aplicativos sizing-workers

Um aplicativo é executado em um contêiner no Adobe I/O Runtime com limites que podem ser configurados por meio do manifest.yml:

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

Devido ao processamento extensivo feito pelos aplicativos do Asset Compute, você deve ajustar esses limites para obter o desempenho ideal (grande o suficiente para lidar com ativos binários) e eficiência (não desperdiçando recursos devido à memória do contêiner não utilizada).

O tempo limite padrão para ações em Tempo de Execução é de um minuto, mas pode ser aumentado definindo o limite de timeout (em milissegundos). Se você espera processar arquivos maiores, aumente esse tempo. Considere o tempo total necessário para baixar a origem, processar o arquivo e fazer upload da representação. Se uma ação atingir o tempo limite, ou seja, não retornar a ativação antes do tempo limite especificado, o Tempo de execução descartará o contêiner e não o reutilizará.

Por natureza, os aplicativos de asset compute tendem a ser vinculados à rede e à entrada ou saída de disco. O arquivo de origem deve ser baixado primeiro. O processamento geralmente consome muitos recursos e as representações resultantes são carregadas novamente.

Você pode especificar a memória alocada para um contêiner de ação em megabytes usando o parâmetro memorySize. Atualmente, esse parâmetro também define quanto acesso à CPU o contêiner recebe e, mais importante, é um elemento essencial do custo do uso do Tempo de execução (contêineres maiores custam mais). Use um valor maior aqui quando o processamento exigir mais memória ou CPU, mas tenha cuidado para não desperdiçar recursos, pois quanto maior for o contêiner, menor será o throughput geral.

Além disso, é possível controlar a simultaneidade da ação em um contêiner usando a configuração concurrency. Essa configuração é o número de ativações simultâneas que um único contêiner (da mesma ação) obtém. Nesse modelo, o container de ação é como um servidor Node.js que recebe várias solicitações simultâneas, até esse limite. O memorySize padrão no tempo de execução está definido como 200 MB, ideal para ações App Builder menores. Para aplicativos Asset Compute, esse padrão pode ser excessivo devido ao processamento local mais intenso e ao uso de disco. Alguns aplicativos, dependendo de sua implementação, também podem não funcionar bem com a atividade simultânea. O SDK do Asset Compute garante que as ativações sejam separadas gravando arquivos em pastas exclusivas diferentes.

Teste aplicativos para encontrar os números ideais para concurrency e memorySize. Contêineres maiores = limite de memória mais alto pode permitir mais simultaneidade, mas também pode ser um desperdício para tráfego mais baixo.