Utveckla ett anpassat program develop

Innan du börjar utveckla ett anpassat program:

Skapa ett anpassat program create-custom-application

Kontrollera att Adobe aio-cli är installerat lokalt.

Se exempel på anpassade program för exempel och idéer på anpassade program.

Lägg till autentiseringsuppgifter add-credentials

När du loggar in när du skapar programmet samlas de flesta App Builder-inloggningsuppgifterna in i din ENV-fil. Om du använder utvecklingsverktyget måste du dock ha ytterligare autentiseringsuppgifter.

Lagringsuppgifter för utvecklingsverktyget developer-tool-credentials

Verktyget för utvecklare att utvärdera anpassade appar med Asset Compute service kräver att en molnlagringsbehållare används. Den här behållaren är viktig för att lagra testfiler och för att ta emot och presentera återgivningar som produceras av programmen.

Kontrollera att du har åtkomst till en molnlagringsbehållare som stöds. Den här behållaren används tillsammans av olika utvecklare för olika projekt när det behövs.

Lägg till autentiseringsuppgifter i ENV-filen add-credentials-env-file

Infoga de efterföljande autentiseringsuppgifterna för utvecklingsverktyget i filen .env. Filen finns i roten av ditt App Builder-projekt:

Kör programmet run-custom-application

Innan du kör programmet med utvecklarverktyget i Asset Compute måste du konfigurera inloggningsuppgifterna korrekt.

Om du vill köra programmet i utvecklingsverktyget använder du kommandot aio app run. Den distribuerar åtgärden till Adobe I/O Runtime och startar utvecklingsverktyget på den lokala datorn. Det här verktyget används för att testa programbegäranden under utveckling. Här är ett exempel på en renderingsförfrågan:

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

Se här om hur du testar och felsöker programmet. När du är klar med utvecklingen av ditt anpassade program distribuerar du ditt anpassade program.

Prova exempelprogrammet från Adobe try-sample

Följande är exempel på anpassade program:

Anpassat mallprogram template-custom-application

worker-basic är ett mallprogram. Det genererar en återgivning genom att bara kopiera källfilen. Innehållet i det här programmet är den mall som togs emot när Adobe Asset Compute valdes när AIR-programmet skapades.

Programfilen, worker-basic.js, använder asset-compute-sdk för att hämta källfilen, ordna varje återgivningsbearbetning och överföra de återgivningar som blir resultatet tillbaka till molnlagringen.

renditionCallback som definieras i programkoden är var all programbearbetningslogik ska utföras. Återgivningsåteranropet i worker-basic kopierar bara källfilens innehåll till återgivningsfilen.

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

Anropa ett externt API call-external-api

I programkoden kan du göra externa API-anrop som hjälp vid programbearbetning. Ett exempel på en programfil som anropar ett externt API visas nedan.

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

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

worker-animal-pictures skapar till exempel en hämtningsbegäran till en statisk URL från Wikimedia med hjälp av biblioteket node-httptransfer.

Skicka egna parametrar pass-custom-parameters

Du kan skicka egna definierade parametrar via återgivningsobjekten. De kan refereras inuti programmet i rendition instruktioner. Ett exempel på ett återgivningsobjekt är:

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

Ett exempel på en programfil som använder en anpassad parameter är följande:

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 skickar en anpassad parameter animal för att avgöra vilken fil som ska hämtas från Wikimedia.

Stöd för autentisering och auktorisering authentication-authorization-support

Som standard innehåller anpassade program från Asset Compute autentisering och autentisering för App Builder-projektet. Aktiveras genom att require-adobe-auth-anteckningen ställs in på true i manifest.yml.

Åtkomst till andra Adobe-API:er access-adobe-apis

Lägg till API-tjänsterna på arbetsytan för konsolen Asset Compute som skapades i konfigurationen. De här tjänsterna ingår i JWT-åtkomsttoken som genererats av Asset Compute Service. Token och andra autentiseringsuppgifter är tillgängliga inuti programåtgärdsobjektet 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

Skicka autentiseringsuppgifter för system från tredje part pass-credentials-for-tp

Om du vill hantera autentiseringsuppgifter för andra externa tjänster skickar du dem som standardparametrar för åtgärderna. De krypteras automatiskt vid transitering. Mer information finns i Skapa åtgärder i utvecklarhandboken för Adobe I/O Runtime. Ange dem sedan med hjälp av miljövariabler under distributionen. De här parametrarna kan nås i params-objektet inuti åtgärden.

Ange standardparametrarna i inputs i manifest.yml:

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

Uttrycket $VAR läser värdet från en miljövariabel med namnet VAR.

Under utvecklingen kan du tilldela värdet i den lokala .env-filen. Orsaken är att aio automatiskt importerar miljövariabler från .env-filer, tillsammans med de variabler som anges av det inledande skalet. I det här exemplet ser filen .env ut så här:

#...
SECRET_KEY=secret-value

För produktionsdistribution kan du ange miljövariabler i CI-systemet, till exempel med hjälp av hemligheter i GitHub-åtgärder. Slutligen får du tillgång till standardparametrarna i själva programmet:

const key = params.secretKey;

Storleksändra program sizing-workers

Ett program körs i en behållare i Adobe I/O Runtime med limits som kan konfigureras via manifest.yml:

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

På grund av omfattande bearbetning i Asset Compute-program måste du justera dessa gränser för optimala prestanda (tillräckligt stor för att hantera binära resurser) och effektivitet (inte slösa resurser på grund av oanvänt behållarminne).

Standardtidsgränsen för åtgärder i körtid är en minut, men den kan ökas genom att timeout-gränsen anges (i millisekunder). Om du förväntar dig att bearbeta större filer ökar du den här tiden. Tänk på hur lång tid det tar att hämta källan, bearbeta filen och överföra återgivningen. Om en åtgärd gör timeout, d.v.s. inte returnerar aktiveringen före den angivna tidsgränsen, tas behållaren bort och används inte igen.

Asset compute-applikationer är till sin natur ofta nätverks- och diskingångs- eller utdatabunden. Källfilen måste hämtas först. Bearbetningen är ofta resurskrävande och återgivningarna överförs sedan igen.

Du kan ange det minne som tilldelats en åtgärdsbehållare i megabyte med parametern memorySize. För närvarande definierar den här parametern också hur mycket processoråtkomst behållaren får, och viktigast av allt är det en viktig del av kostnaden för att använda körningsversionen (större behållare kostar mer). Använd ett större värde här när bearbetningen kräver mer minne eller processorkapacitet, men var försiktig så att du inte slösar bort resurser eftersom ju större behållare det är, desto lägre blir den totala genomströmningen.

Dessutom är det möjligt att kontrollera åtgärdssamtidighet i en behållare med inställningen concurrency. Den här inställningen är antalet samtidiga aktiveringar som en enskild behållare (av samma åtgärd) får. I den här modellen fungerar åtgärdsbehållaren som en Node.js-server som tar emot flera samtidiga begäranden, upp till den gränsen. Standardvärdet memorySize i körningsversionen är 200 MB, vilket är idealiskt för mindre App Builder-åtgärder. För Asset compute-program kan det här standardvärdet bli för stort på grund av att de har mer lokal bearbetning och använder mer disk. Vissa program kanske inte fungerar bra med samtidig aktivitet beroende på implementering. Asset compute SDK säkerställer att aktiveringarna separeras genom att filer skrivs till olika unika mappar.

Testa program för att hitta de optimala siffrorna för concurrency och memorySize. Större behållare = högre minnesgräns kan möjliggöra mer samtidighet men kan också vara onödigt för lägre trafik.