Funções do AEM Edge aem-edge-functions

O AEM Edge Functions permite executar o JavaScript na camada de CDN, aproximando o processamento de dados do usuário final. Isso reduz a latência e permite experiências responsivas e dinâmicas sem uma viagem de ida e volta à sua origem.

Casos de uso comuns incluem:

O AEM Edge Functions é compatível com o Java-stack do Edge Delivery Services e do AEM Cloud Service.

Principais benefícios key-benefits

Pré-requisitos prerequisites

Configurar setup

Instalar a CLI do Adobe install-adobe-cli

Instale a CLI do Adobe Developer (aio):

npm install -g @adobe/aio-cli

Instale o plug-in AEM Edge Functions:

aio plugins install @adobe/aio-cli-plugin-aem-edge-functions

Autentique e configure o plug-in para o seu ambiente:

aio login
aio aem edge-functions setup

O comando de configuração solicita que você faça logon e selecione o ambiente do AEM no qual deseja usar as funções do AEM Edge.

Clonar a chapa boilerplate

Copie o aem-edge-functions-boilerplate no seu próprio repositório e instale as dependências:

npm install

Crie sua primeira função create-your-function

Os serviços de função do AEM Edge são declarados em um arquivo de configuração YAML e implantados por meio do pipeline de configuração do Cloud Manager.

​1. Definir um pipeline de configuração configuration-pipeline

Antes de criar uma função de borda, verifique se existe um pipeline de configuração para o seu ambiente no Cloud Manager. Caso contrário, crie um pipeline de configuração primeiro.

​2. Declarar os serviços de função da Edge declare-services

Crie um arquivo chamado edgeFunctions.yaml no diretório de configuração:

kind: "EdgeFunctions"
version: "1"
data:
  services:
    - name: first-function
    - name: second-function
    # Uncomment to enable secrets
    # secrets:
    #   - key: API_TOKEN
    #     value: ${{ API_TOKEN_SECRET }}

A configuração aceita até três serviços. As teclas de nível superior são:

​3. Adicionar Regras do Seletor de Origem CDN cdn-routing

As funções do Edge são invocadas pelo roteamento de tráfego CDN para elas por meio de regras do seletor de origem. Adicione o seguinte ao arquivo de configuração cdn.yaml (ou crie um caso ele não exista):

kind: 'CDN'
version: '1'
data:
  originSelectors:
    rules:
      - name: route-to-first-function
        when: { reqProperty: path, equals: "/weather" }
        action:
          type: selectAemOrigin
          originName: edgefunction-first-function
      - name: route-to-second-function
        when: { reqProperty: path, equals: "/hello-world" }
        action:
          type: selectAemOrigin
          originName: edgefunction-second-function

As regras do seletor de origem permitem rotear o tráfego para suas funções de borda com base em qualquer condição disponível no mecanismo de regras CDN, como um caminho, domínio ou cabeçalho de solicitação específico. Consulte Seletores de Origem para obter a sintaxe de regra completa.

​4. Implantar a configuração deploy-configuration

Confirme edgeFunctions.yaml e cdn.yaml no repositório Git do Cloud Manager e acione o pipeline de configuração. Depois que o pipeline for concluído com êxito, seus pontos de extremidade de função de borda estarão disponíveis em:

onde pXXXXX-eYYYYY são as coordenadas do seu ambiente. Se um domínio personalizado estiver configurado, as funções também poderão ser acessadas nesses caminhos de domínio (por exemplo, example.com/weather).

Criar e implantar o código de função do AEM Edge build-deploy

Build build

Crie um pacote do código de função de borda para implantação:

aio aem edge-functions build

Implantar deploy

Implante o pacote criado em um serviço de função de borda nomeado. O argumento function-name deve corresponder ao valor name em edgeFunctions.yaml:

aio aem edge-functions deploy <function-name>

Desenvolvimento local local-development

Executar localmente local-run

Iniciar um servidor de desenvolvimento local em http://127.0.0.1:7676:

aio aem edge-functions serve

Consulte esta documentação do Compute JavaScript para obter detalhes sobre o que o tempo de execução local suporta.

Teste test

Execute o conjunto de testes com Mocha:

npm run test

Depuração remota remote-debugging

O Adobe Managed CDN não expõe um depurador remoto, mas expõe o fluxo de log. Siga os logs de uma função implantada para receber saída de console.log diretamente em seu terminal:

aio aem edge-functions tail-logs <function-name>

Referência da configuração configuration-reference

Origens origins

Por padrão, as funções de borda podem buscar de qualquer origem. Para restringir uma função a um conjunto definido de origens, declare-as em origins em edgeFunctions.yaml:

origins:
  - name: my-origin-name
    domain: example.com

Referencie a origem nomeada em seu código de função usando a opção de busca backend:

const request = new Request("https://example.com/test");
const response = await fetch(request, { backend: "my-origin-name" });

Configuração do serviço service-configuration

Exponha variáveis de ambiente a suas funções usando a chave configs em edgeFunctions.yaml. Os valores são armazenados em um repositório de configuração chamado config_default:

configs:
  - key: LOG_LEVEL
    value: DEBUG

Leia os valores de configuração no seu código de função:

import { ConfigStore } from "fastly:config-store";

const config = new ConfigStore('config_default');
const logLevel = config.get('LOG_LEVEL') || 'info';

Segredos do serviço service-secrets

Segredos são referenciados, não armazenados, em edgeFunctions.yaml. O campo value deve apontar para um segredo Cloud Manager usando a sintaxe ${{SECRET_REFERENCE}}. Primeiro defina o segredo subjacente no Cloud Manager — consulte Variáveis Secretas do Cloud Manager.

secrets:
  - key: API_TOKEN
    value: ${{ API_TOKEN_SECRET }}

Recupere segredos em seu código de função usando o auxiliar SecretStoreManager da chapa padrão:

import { SecretStoreManager } from "./lib/config";

const apiToken = await SecretStoreManager.getSecret('API_TOKEN');

Logs logging

O AEM Edge Functions é integrado ao recurso Encaminhamento de logs do AEM. Crie um arquivo logForwarding.yaml junto com seu edgeFunctions.yaml:

kind: "LogForwarding"
version: "1"
metadata:
  envTypes: ["rde", "dev", "stage", "prod"]
data:
  splunk:
    default:
      enabled: true
      host: "splunk-host.example.com"
      token: "${{SPLUNK_TOKEN}}"
      index: "AEMaaCS"

Use o agente de log no código da função para gravar entradas de log estruturadas:

import { Logger } from "fastly:logger";

const logger = new Logger("customerSplunk");
logger.log(JSON.stringify({
  method: event.request.method,
  url: event.request.url
}));