Utveckla ett anpassat program develop

Innan du börjar utveckla ett anpassat program:

Skapa ett anpassat program create-custom-application

Se till att du har Adobe I/O CLI installeras lokalt.

Se exempel på anpassade program för exempel och idéer för 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

Det utvecklarverktyg som används för att testa anpassade program med det faktiska Asset Compute service kräver en lagringsbehållare i molnet för testfiler och för att ta emot och visa återgivningar som genererats av program.

Se till att du har tillgång till en molnlagringsbehållare som stöds. Den här behållaren kan delas av flera utvecklare i olika projekt efter behov.

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

Lägg till följande autentiseringsuppgifter för utvecklingsverktyget i ENV-filen i roten för ditt App Builder-projekt:

Kör programmet run-custom-application

Innan du kör programmet med utvecklarverktyget i Asset compute måste du konfigurera autentiseringsuppgifter.

Om du vill köra programmet i utvecklingsverktyget använder du aio app run -kommando. Den implementerar åtgärden på Adobe I/O Kör och starta 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 hur du testar och felsöker programmet. När du är klar med utvecklingen av ditt anpassade program distribuera ditt anpassade program.

Prova exempelprogrammet från Adobe try-sample

Följande är exempel på anpassade program:

Anpassat mallprogram template-custom-application

The 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 tas emot när du väljer Adobe Asset Compute när du skapar AIR-appen.

Programfilen, worker-basic.js använder asset-compute-sdk om du vill hämta källfilen, samordna varje renderingsbearbetning och överföra de resulterande renderingarna tillbaka till molnlagringen.

The renditionCallback som definieras inuti programkoden, är var all programbearbetningslogik ska utföras. Återgivningsåteranrop 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
    })
});

Till exempel worker-animal-pictures gör en hämtningsbegäran till en statisk URL från Wikimedia med node-httptransfer bibliotek.

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:

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

The 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 levereras anpassade Asset compute-program med behörighets- och autentiseringskontroller för App Builder-projekt. Det här är aktiverat genom att ställa in require-adobe-auth anteckning till true i manifest.yml.

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

Lägg till API-tjänsterna i Asset Compute Konsolens arbetsyta skapades i konfigurationen. Dessa tjänster är en del av JWT-åtkomsttoken som genereras av Asset Compute Service. Token och andra inloggningsuppgifter är tillgängliga inuti programåtgärden params -objekt.

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 dessa som standardparametrar för åtgärderna. Dessa krypteras automatiskt under överföring. Mer information finns i skapa åtgärder i utvecklarhandboken för Runtime. Ange dem sedan med hjälp av miljövariabler under distributionen. Dessa parametrar finns i params -objekt inuti funktionsmakrot.

Ange standardparametrar 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

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

Under utvecklingen kan värdet anges i den lokala ENV-filen som aio läser automatiskt miljövariabler från ENV-filer utöver de variabler som anges i anropsgränssnittet. I det här exemplet ser ENV-filen 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 Körning med gränser som kan konfigureras via manifest.yml:

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

På grund av den mer omfattande bearbetning som vanligtvis utförs av Asset compute-program är det troligare att man måste justera dessa gränsvärden 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 ställa in timeout gräns (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, ignoreras behållaren och återanvänds inte.

Asset compute-applikationer är till sin natur ofta nätverks- och diskingångs- eller utdatabunden. Källfilen måste först laddas ned, bearbetningen är ofta resurskrävande och sedan överförs de resulterande återgivningarna igen.

Minnet som är tillgängligt för en åtgärdsbehållare anges av memorySize i MB. För närvarande definierar detta även 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 noga med att inte slösa bort resurser eftersom ju större behållare det är, desto lägre blir den totala genomströmningen.

Dessutom är det möjligt att styra åtgärdssamtidighet i en behållare med concurrency inställning. Detta ä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. Om den inte anges är standardvärdet 200, vilket är bra för mindre App Builder-åtgärder, men vanligtvis för stort för Asset compute-program med tanke på deras mer intensiva lokala bearbetning och diskaktivitet. 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 det optimala antalet 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.