#JavaScript

#Úvod

Node JavaScript umožňuje uživatelům spouštět vlastní serverový JavaScriptový skript v rámci Workflow. Skript může jako parametry používat proměnné z předchozích kroků Workflow a jeho návratová hodnota může být poskytnuta následným Node.

Skript se spouští v pracovním vlákně na serveru aplikace NocoBase a podporuje většinu funkcí Node.js. Existují však určité rozdíly oproti nativnímu spouštěcímu prostředí. Podrobnosti naleznete v Seznamu funkcí.

#Vytvoření uzlu

V rozhraní Interface Configuration pro Workflow klikněte na tlačítko plus („+“) v toku a přidejte Node „JavaScript“:

#Konfigurace Node

#Parametry

Slouží k předávání proměnných nebo statických hodnot z kontextu Workflow do skriptu pro použití v logice kódu. name je název parametru, který se po předání do skriptu stane názvem proměnné. value je hodnota parametru, kterou můžete vybrat jako proměnnou nebo zadat jako konstantu.

#Obsah skriptu

Obsah skriptu lze považovat za funkci. Můžete napsat libovolný JavaScriptový kód podporovaný v prostředí Node.js a použít příkaz return k vrácení hodnoty jako výsledku spuštění Node, kterou pak mohou následné Node použít jako proměnnou.

Po napsání kódu můžete kliknout na tlačítko „Test“ pod editorem, čímž otevřete dialogové okno pro testovací spuštění. Zde můžete vyplnit parametry statickými hodnotami pro simulované spuštění. Po provedení se v dialogovém okně zobrazí návratová hodnota a obsah výstupu (logu).

#Nastavení časového limitu

Jednotkou jsou milisekundy. Hodnota 0 znamená, že není nastaven žádný časový limit.

#Pokračovat ve Workflow při chybě

Pokud je tato možnost zaškrtnuta, následné Node se budou provádět i v případě, že skript narazí na chybu nebo vyprší časový limit.

#Seznam funkcí

#Verze Node.js

Stejná jako verze Node.js, na které běží hlavní aplikace.

#Podpora modulů

Moduly lze ve skriptu používat s omezeními, v souladu s CommonJS, pomocí direktivy require() pro import modulů.

Podporuje nativní moduly Node.js a moduly nainstalované v node_modules (včetně závislostí již používaných NocoBase). Moduly, které mají být dostupné pro kód, musí být deklarovány v proměnné prostředí aplikace WORKFLOW_SCRIPT_MODULES, přičemž více názvů balíčků je odděleno čárkami, například:

WORKFLOW_SCRIPT_MODULES=crypto,timers,lodash,dayjs

V prostředí, kde není nasazení ze zdrojového kódu, pokud modul není nainstalován v node_modules, můžete požadovaný balíček ručně nainstalovat do adresáře storage. Například, pokud potřebujete použít balíček exceljs, můžete provést následující kroky:

cd storage
npm i --no-save --no-package-lock --prefix . exceljs

Poté přidejte relativní (nebo absolutní) cestu k tomuto balíčku, vzhledem k CWD (aktuálnímu pracovnímu adresáři) aplikace, do proměnné prostředí WORKFLOW_SCRIPT_MODULES:

WORKFLOW_SCRIPT_MODULES=./storage/node_modules/exceljs

Poté můžete balíček exceljs použít ve svém skriptu:

const ExcelJS = require('./storage/node_modules/exceljs');
// ...

#Globální proměnné

Nepodporuje globální proměnné jako global, process, __dirname a __filename.

console.log(global); // will throw error: "global is not defined"

#Vstupní parametry

Parametry nakonfigurované v Node se stávají globálními proměnnými ve skriptu a lze je přímo používat. Parametry předávané skriptu podporují pouze základní typy, jako jsou boolean, number, string, object a pole. Objekt Date bude po předání převeden na řetězec ve formátu ISO. Jiné komplexní typy, jako jsou instance vlastních tříd, nelze přímo předávat.

#Návratová hodnota

Pomocí příkazu return lze vrátit data základních typů (stejná pravidla jako pro parametry) zpět do Node jako jeho výsledek. Pokud v kódu není volán příkaz return, spuštění Node nebude mít žádnou návratovou hodnotu.

return 123;

#Výstup (Log)

Podporuje použití console pro výstup logů.

console.log('hello world!');

Při spuštění Workflow je výstup JavaScript Node také zaznamenán do souboru protokolu odpovídajícího pracovního postupu.

#Asynchronní operace

Podporuje použití async pro definování asynchronních funkcí a await pro jejich volání. Podporuje použití globálního objektu Promise.

async function test() {
  return Promise.resolve(1);
}

const value = await test();
return value;

#Časovače

Pokud potřebujete použít metody jako setTimeout, setInterval nebo setImmediate, je nutné je importovat z balíčku timers Node.js.

const { setTimeout, setInterval, setImmediate, clearTimeout, clearInterval, clearImmediate } = require('timers');

async function sleep(time) {
  return new Promise((resolve) => setTimeout(resolve, time));
}

await sleep(1000);

return 123;