Upgrade naar SDK 0.6 en de nieuwe functieregels

Installeer de nieuwe versie:

npm install @aurabase/aurabase-js@0.6.0

De release bevat één beveiligingswijziging en verschillende oplossingen voor de manier waarop fouten en reacties worden gerapporteerd. De beveiligingswijziging zit ook in de functies service: deze is van toepassing op uw project zodra de service wordt bijgewerkt, welke SDK-versie u ook gebruikt.

Beheeroproepen hebben nu een service_role-sleutel nodig

functions.list(), get(), listJobs(), getJob(), enqueueJob(), listCronJobs(), createCronJob() en deleteCronJob() retourneren 403 naar een openbare sleutel of een ingelogde gebruiker. Voorheen stuurden list() en get() de broncode en de variabelen van elke functie terug naar iedereen die de publieke sleutel bezat. Zie het beveiligingsmodel.

const { data } = await aura.functions.list() // gewerkt met de publieke sleutel

// server/api/functions.ts
const admin = createClient(process.env.AURA_URL!, process.env.AURA_SERVICE_ROLE_KEY!)
export const GET = async () => Response.json((await admin.functions.list()).data?.map((f) => f.name))

Retourneer alleen wat uw frontend nodig heeft (namen bijvoorbeeld), nooit de hele definitie.

Een body die geen JSON kan zijn, wordt geweigerd

invoke(name, { body: new Blob(…) }), en hetzelfde met ArrayBuffer, getypte arrays, FormData, URLSearchParams of ReadableStream, retourneert nu de foutcode invalid_body. Voorheen ontving de functie {} en werd er geen fout gerapporteerd. Codeer binaire gegevens (base64) of upload deze naar Storage en stuur het pad ervan.

De eigen 502, 503 of 504 van een functie is een FunctionsHttpError

Voorheen werden deze statussen altijd geclassificeerd als FunctionsRelayError, zelfs als uw code deze retourneerde. Nu betekent FunctionsRelayError dat het -platform mislukt is. Als u het opnieuw hebt geprobeerd op FunctionsRelayError, controleer dan of uw logica voor opnieuw proberen nog steeds overeenkomt: zie fouten, time-outs en nieuwe pogingen.

FunctionDef is nauwkeuriger

env_vars is Record<string, string> (het was Record<string, unknown>) en permissions is toegevoegd. Code die deze velden leest, blijft werken; code die waarden van een ander type heeft toegewezen, wordt niet langer gecompileerd.

Nieuwe exports: FunctionsHttpError, FunctionsRelayError, isRelayStatus en FunctionsResponseType komen zowel van @aurabase/aurabase-js als van @aurabase/functions. Als je ze hebt geïmporteerd vanuit @aurabase/functions, blijft dat werken; met pnpm heb je dat pakket niet langer nodig als directe afhankelijkheid.

In @aurabase/auth is het type email in het resultaat van getClaims() nu string | null, wat de service retourneert voor een gebruiker zonder e-mailadres.

CLI. aura functions deploy wist niet langer de geheimen van een functie die al bestaat. aura functions invoke --data weigert ongeldige JSON in plaats van {} te verzenden. aura functions download werkt voor Deno-functies. aura functions serve luistert op de poort die het aankondigt. aura studio opent de Studio op poort 3000.

Als uw project draaide op een serviceversie die ouder was dan deze wijziging, kon elke houder van uw openbare sleutel de code en de variabelen van uw functies lezen. Stel dat ze zijn gelezen:

1. Maak een lijst van uw functies met een service_role-toets en open de variabelen van elke functie.
2. Roteer elk geheim dat ze bevatten: betalingssleutels, webhookgeheimen, tokens van derden.
3. Verwijder geheimen die rechtstreeks in index.ts zijn geschreven en verplaats ze naar variabelen.
4. Controleer de taken en waarschuwingsregels van het project voor vermeldingen die u niet heeft aangemaakt.

• Zoek in uw code naar functions.list(, functions.get(, listJobs(, getJob(, enqueueJob(, createCronJob(, deleteCronJob( en listCronJobs( in code die in een browser of met een openbare sleutel wordt uitgevoerd.
• Zoek naar body:-waarden die geen gewone JSON zijn.
• Controleer de logica voor nieuwe pogingen die afhankelijk is van FunctionsRelayError.
• Roteer de geheimen zoals hierboven beschreven.
• Werk de CLI bij.