Snippets

Was Snippets sind

Snippets sind wiederverwendbare JavaScript-Bausteine, die Sie einmal definieren und mit require() in Ihre Check-Skripte einbinden. Statt dieselbe Hilfsfunktion, Token-Signierung oder Setup-Logik in jeden Check zu kopieren, speichern Sie sie als Snippet und binden sie über ihren Namen ein — ändern Sie sie an einer Stelle, und jeder Check, der sie verwendet, übernimmt die Änderung.

Ein Snippet ist einfach ein kleines JavaScript-Modul. Alles, was es mit module.exports exportiert, steht überall dort zur Verfügung, wo Sie es per require einbinden:

require('./snippets/name');

Snippets sind an Ihr Team gebunden, sodass alle im Team dieselben Helfer in ihren Checks verwenden können.

Snippets verwalten

Öffnen Sie die Snippets-Seite, um Snippets zu erstellen, zu bearbeiten und zu löschen.

Ein Snippet erstellen

Klicken Sie auf New Snippet.
Geben Sie einen Snippet-Namen ein — das ist der Name, den Sie in Ihren Skripten einbinden (zum Beispiel auth oder format-date). Namen dürfen nur Buchstaben, Zahlen, Bindestriche und Unterstriche enthalten.
Schreiben Sie Ihr JavaScript im Editor. Exportieren Sie das, was Sie wiederverwenden möchten, mit module.exports.
Klicken Sie auf Save Snippet.

Jeder Snippet-Name muss innerhalb Ihres Teams eindeutig sein.

Ein Snippet bearbeiten oder löschen

Verwenden Sie die Zeilenaktionen auf der Snippets-Seite, um den Code eines Snippets zu aktualisieren oder es zu entfernen. Wenn ein Snippet aktuell von einem oder mehreren Checks verwendet wird, warnt LoadFocus Sie vor dem Speichern oder Löschen, da sich die Änderung auf jeden Check auswirkt, der es einbindet. Eine Aktualisierung wird beim nächsten Lauf jedes Checks wirksam, der es verwendet.

Ein Snippet in einem Check-Skript verwenden

Binden Sie ein Snippet über seinen Namen aus dem Pfad ./snippets/ innerhalb eines Check-Skripts ein:

const auth = require('./snippets/auth');

Der zurückgegebene Wert ist genau das, was das Snippet exportiert.

Beispiel

Erstellen Sie ein Snippet namens auth, das einen Authorization-Header erzeugt:

// snippet: auth
module.exports = function bearer(token) {
  return { Authorization: 'Bearer ' + token };
};

Verwenden Sie es dann in einem Check-Skript:

const bearer = require('./snippets/auth');

const headers = bearer(process.env.API_TOKEN);
// `headers` an Ihren Request übergeben

Sie können beliebige wiederverwendbare Logik in einem Snippet ablegen — Request-Signierung, Payload-Builder, Datums- und String-Helfer oder gemeinsame Assertions — und es in so vielen Checks einbinden, wie Sie möchten.

Snippets vs. Variablen und Secrets

Verwenden Sie Snippets für wiederverwendbaren Code — Hilfsfunktionen und Logik, die über mehrere Check-Skripte hinweg geteilt werden.

Verwenden Sie Variablen für wiederverwendbare Werte wie Basis-URLs und Konto-IDs, eingebunden mit {{VARIABLE_NAME}}.

Verwenden Sie Secrets für sensible Werte wie API-Tokens und Passwörter. Secrets sind in der Oberfläche nur schreibbar und werden mit {{SECRET_NAME}} eingebunden.

Tipp: Bewahren Sie sensible Werte in Secrets auf, statt sie fest in einem Snippet zu hinterlegen. Übergeben Sie sie stattdessen zur Laufzeit an die Funktionen Ihres Snippets.