#Script JavaScript

#Introduction

Le nœud Script JavaScript permet aux utilisateurs d'exécuter un script JavaScript personnalisé côté serveur dans un flux de travail. Le script peut utiliser des variables en amont du flux de travail comme paramètres, et sa valeur de retour peut être fournie aux nœuds en aval.

Le script s'exécute dans un thread de travail sur le serveur de l'application NocoBase et prend en charge la plupart des fonctionnalités de Node.js, mais présente quelques différences par rapport à l'environnement d'exécution natif, voir la Liste des fonctionnalités.

#Créer un nœud

Dans l'interface de configuration du flux de travail, cliquez sur le bouton plus (« + ») dans le flux pour ajouter un nœud « JavaScript » :

#Configuration du nœud

#Paramètres

Utilisés pour transmettre des variables du contexte du flux de travail ou des valeurs statiques au script afin d'être utilisées dans la logique du code. name est le nom du paramètre, qui devient le nom de la variable une fois transmis au script. value est la valeur du paramètre, vous pouvez choisir une variable ou saisir une constante.

#Contenu du script

Le contenu du script peut être considéré comme une fonction. Vous pouvez écrire n'importe quel code JavaScript pris en charge dans l'environnement Node.js et utiliser l'instruction return pour renvoyer une valeur comme résultat d'exécution du nœud, afin qu'elle soit utilisée comme variable par les nœuds suivants.

Après avoir écrit le code, vous pouvez cliquer sur le bouton de test sous la zone d'édition pour ouvrir une boîte de dialogue d'exécution de test, et utiliser des valeurs statiques pour les paramètres afin d'effectuer une simulation. Après l'exécution, vous pouvez voir la valeur de retour et le contenu de la sortie (logs) dans la boîte de dialogue.

#Paramètres de délai d'attente

L'unité est la milliseconde. Lorsqu'elle est définie sur 0, cela signifie qu'aucun délai d'attente n'est configuré.

#Continuer le flux de travail après une erreur

Si cette option est cochée, les nœuds suivants seront toujours exécutés même si le script rencontre une erreur ou un délai d'attente.

#Liste des fonctionnalités

#Version de Node.js

Identique à la version de Node.js exécutant l'application principale.

#Prise en charge des modules

Les modules peuvent être utilisés de manière limitée dans le script, conformément à CommonJS, en utilisant l'instruction require() pour importer des modules.

Prend en charge les modules natifs de Node.js et les modules installés dans node_modules (y compris les paquets de dépendances déjà utilisés par NocoBase). Les modules à mettre à disposition du code doivent être déclarés dans la variable d'environnement de l'application WORKFLOW_SCRIPT_MODULES, les noms de paquets étant séparés par des virgules, par exemple :

WORKFLOW_SCRIPT_MODULES=crypto,timers,lodash,dayjs

Dans un environnement qui n'est pas déployé à partir des sources, si un module n'est pas installé dans node_modules, vous pouvez installer manuellement le paquet nécessaire dans le répertoire storage. Par exemple, si vous avez besoin d'utiliser le paquet exceljs, vous pouvez effectuer les opérations suivantes :

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

Ensuite, ajoutez le chemin relatif (ou absolu) du paquet basé sur le CWD (répertoire de travail actuel) de l'application à la variable d'environnement WORKFLOW_SCRIPT_MODULES :

WORKFLOW_SCRIPT_MODULES=./storage/node_modules/exceljs

Vous pourrez alors utiliser le paquet exceljs dans le script (le nom dans require doit correspondre exactement à celui défini dans la variable d'environnement) :

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

#Variables globales

Ne prend pas en charge les variables globales telles que global, process, __dirname et __filename.

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

#Paramètres d'entrée

Les paramètres configurés dans le nœud serviront de variables globales dans le script et peuvent être utilisés directement. Les paramètres transmis au script ne prennent en charge que les types de base, tels que boolean, number, string, object et les tableaux. L'objet Date sera converti en une chaîne au format ISO après avoir été transmis. D'autres types complexes ne peuvent pas être transmis directement, comme les instances de classes personnalisées.

#Valeur de retour

L'instruction return permet de renvoyer des données de type de base (mêmes règles que pour les paramètres) au nœud en tant que résultat. Si l'instruction return n'est pas appelée dans le code, l'exécution du nœud n'aura pas de valeur de retour.

return 123;

#Sortie (Logs)

Prend en charge l'utilisation de console pour sortir des logs.

console.log('hello world!');

Lors de l'exécution du flux de travail, la sortie du nœud de script est également enregistrée dans le fichier de logs du flux de travail correspondant.

#Asynchrone

Prend en charge l'utilisation de async pour définir des fonctions asynchrones, ainsi que await pour appeler des fonctions asynchrones. Prend en charge l'utilisation de l'objet global Promise.

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

const value = await test();
return value;

#Minuteurs

Pour utiliser des méthodes telles que setTimeout, setInterval ou setImmediate, elles doivent être importées via le paquet timers de 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;