JS#
El módulo se utiliza para implementar manejadores en njs — un subconjunto del lenguaje JavaScript.
En nuestros repositorios, el módulo se compila de forma dinámica y está disponible como un paquete independiente llamado
angie-module-njs o angie-pro-module-njs.
Nota
También está disponible una versión ligera del paquete, llamada ...-njs-light;
sin embargo, no se puede utilizar junto con la versión normal.
Ejemplo de Configuración#
stream {
js_import stream.js;
js_set $bar stream.bar;
js_set $req_line stream.req_line;
server {
listen 12345;
js_preread stream.preread;
return $req_line;
}
server {
listen 12346;
js_access stream.access;
proxy_pass 127.0.0.1:8000;
js_filter stream.header_inject;
}
}
http {
server {
listen 8000;
location / {
return 200 $http_foo\n;
}
}
}
El archivo stream.js:
var line = '';
function bar(s) {
var v = s.variables;
s.log("hello from bar() handler!");
return "bar-var" + v.remote_port + "; pid=" + v.pid;
}
function preread(s) {
s.on('upload', function (data, flags) {
var n = data.indexOf('\n');
if (n != -1) {
line = data.substr(0, n);
s.done();
}
});
}
function req_line(s) {
return line;
}
// Read HTTP request line.
// Collect bytes in 'req' until
// request line is read.
// Inject HTTP header into a client's request
var my_header = 'Foo: foo';
function header_inject(s) {
var req = '';
s.on('upload', function(data, flags) {
req += data;
var n = req.search('\n');
if (n != -1) {
var rest = req.substr(n + 1);
req = req.substr(0, n + 1);
s.send(req + my_header + '\r\n' + rest, flags);
s.off('upload');
}
});
}
function access(s) {
if (s.remoteAddress.match('^192.*')) {
s.deny();
return;
}
s.allow();
}
export default {bar, preread, req_line, header_inject, access};
Directivas#
js_access#
Establece una función njs que será llamada en la fase de acceso. Se pueden referenciar funciones de módulos.
La función se llama una vez en el momento en que la sesión de stream alcanza la fase de acceso por primera vez. La función se llama con los siguientes argumentos:
| el objeto sesión de stream |
En esta fase, es posible realizar la inicialización o registrar un callback con el método s.on() para cada fragmento de datos entrante hasta que se llame a uno de los siguientes métodos: s.done(), s.decline(), s.allow(). Tan pronto como se llama a uno de estos métodos, el procesamiento de la sesión de stream cambia a la siguiente fase y se eliminan todos los callbacks actuales de s.on().
js_context_reuse#
Establece el número máximo de contextos JS que se reutilizarán para el motor QuickJS. Cada contexto se utiliza para una única sesión de stream. El contexto finalizado se coloca en un pool de contextos reutilizables. Si el pool está lleno, el contexto se destruye.
js_engine#
Establece el motor JavaScript que se utilizará para los scripts njs. El parámetro njs establece el motor njs, también utilizado por defecto. El parámetro qjs establece el motor QuickJS.
js_fetch_buffer_size#
Establece el tamaño del búfer utilizado para leer y escribir con Fetch API.
js_fetch_ciphers#
| |
Predeterminado |
|
stream, server |
Especifica los cifrados habilitados para conexiones HTTPS con Fetch API. Los cifrados se especifican en el formato entendido por la biblioteca OpenSSL.
La lista de cifrados depende de la versión de OpenSSL instalada.
La lista completa se puede ver usando el comando openssl ciphers.
js_fetch_max_response_buffer_size#
| |
Predeterminado |
|
stream, server |
Establece el tamaño máximo de la respuesta recibida con Fetch API.
js_fetch_protocols#
| |
Predeterminado |
|
stream, server |
Habilita los protocolos especificados para conexiones HTTPS con Fetch API.
js_fetch_timeout#
Define un tiempo de espera para lectura y escritura para Fetch API. El tiempo de espera se establece solo entre dos operaciones de lectura/escritura sucesivas, no para toda la respuesta. Si no se transmiten datos dentro de este tiempo, la conexión se cierra.
js_fetch_trusted_certificate#
Especifica un archivo con certificados CA de confianza en formato PEM utilizados para verificar el certificado HTTPS con Fetch API.
js_fetch_verify#
Habilita o deshabilita la verificación del certificado del servidor HTTPS con Fetch API.
js_fetch_verify_depth#
Establece la profundidad de verificación en la cadena de certificados del servidor HTTPS con Fetch API.
js_fetch_keepalive#
Activa la caché para conexiones a servidores de destino. Cuando el valor es mayor que 0, habilita conexiones keepalive para Fetch API.
El parámetro conexiones establece el número máximo de conexiones keepalive inactivas a servidores de destino que se conservan en la caché de cada proceso worker. Cuando se excede este número, se cierran las conexiones utilizadas menos recientemente.
Ejemplo:
server {
listen 12345;
js_fetch_keepalive 32;
js_fetch_trusted_certificate /path/to/ISRG_Root_X1.pem;
js_preread main.fetch_handler;
}
js_fetch_keepalive_requests#
| |
Predeterminado |
|
stream, server |
Establece el número máximo de solicitudes que se pueden servir a través de una conexión keepalive con Fetch API. Después de realizar el número máximo de solicitudes, la conexión se cierra.
Cerrar conexiones periódicamente es necesario para liberar asignaciones de memoria por conexión. Por lo tanto, usar un número máximo de solicitudes demasiado alto podría resultar en un uso excesivo de memoria y no se recomienda.
js_fetch_keepalive_time#
| |
Predeterminado |
|
stream, server |
Limita el tiempo máximo durante el cual las solicitudes se pueden procesar a través de una conexión keepalive con Fetch API. Después de alcanzar este tiempo, la conexión se cierra tras el procesamiento de la solicitud subsiguiente.
js_fetch_keepalive_timeout#
| |
Predeterminado |
|
stream, server |
Establece un tiempo de espera durante el cual una conexión keepalive inactiva a un servidor de destino permanecerá abierta con Fetch API.
js_filter#
Establece un filtro de datos. Se pueden referenciar funciones de módulos.
La función de filtro se llama una vez en el momento en que la sesión de stream alcanza la fase de contenido. La función de filtro se llama con los siguientes argumentos:
| el objeto sesión de stream |
En esta fase, es posible realizar la inicialización o registrar un callback con el método s.on() para cada fragmento de datos entrante. El método s.off() puede utilizarse para desregistrar un callback y detener el filtrado.
Nota
Como el manejador js_filter devuelve su resultado inmediatamente, solo admite operaciones síncronas. Por lo tanto, las operaciones asíncronas como ngx.fetch() o setTimeout() no son compatibles.
js_import#
Importa un módulo que implementa manejadores de ubicación y variables en njs. El export_name se utiliza como espacio de nombres para acceder a las funciones del módulo. Si no se especifica export_name, el nombre del módulo se utilizará como espacio de nombres.
js_import stream.js;
Aquí, el nombre del módulo stream se utiliza como espacio de nombres al acceder a las exportaciones. Si el módulo importado exporta foo(), entonces se utiliza stream.foo para acceder a él.
Se pueden especificar varias directivas js_import.
js_path#
Establece una ruta adicional para los módulos njs.
js_periodic#
| |
Predeterminado | — |
server |
Especifica un manejador de contenido para ejecutarse a intervalos regulares. El manejador recibe un objeto de sesión como su primer argumento, también tiene acceso a objetos globales como ngx.
El parámetro opcional interval establece el intervalo entre dos ejecuciones consecutivas, por defecto, 5 segundos.
El parámetro opcional jitter establece el tiempo dentro del cual el manejador de contenido de la ubicación se retrasará aleatoriamente, por defecto, no hay retraso.
Por defecto, el js_handler se ejecuta en el proceso worker 0. El parámetro opcional worker_affinity permite especificar procesos worker particulares donde el manejador de contenido de ubicación debe ejecutarse. Cada conjunto de procesos worker se representa mediante una máscara de bits de procesos worker permitidos. La máscara all permite que el manejador se ejecute en todos los procesos worker.
Ejemplo:
example.conf:
location @periodics {
# para ejecutarse a intervalos de 1 minuto en el proceso worker 0
js_periodic main.handler interval=60s;
# para ejecutarse a intervalos de 1 minuto en todos los procesos worker
js_periodic main.handler interval=60s worker_affinity=all;
# para ejecutarse a intervalos de 1 minuto en los procesos worker 1 y 3
js_periodic main.handler interval=60s worker_affinity=0101;
resolver 10.0.0.1;
js_fetch_trusted_certificate /path/to/ISRG_Root_X1.pem;
}
example.js:
async function handler(s) {
let reply = await ngx.fetch('https://example.com/');
let body = await reply.text();
ngx.log(ngx.INFO, body);
}
js_preload_object#
Precarga un objeto inmutable en tiempo de configuración. El name se utiliza como nombre de la variable global a través de la cual el objeto está disponible en el código njs. Si no se especifica name, se utilizará el nombre del archivo.
js_preload_object map.json;
Aquí, map se usa como nombre al acceder al objeto precargado.
Se pueden especificar varias directivas js_preload_object.
js_preread#
Establece una función njs que se llamará en la fase preread. Se pueden referenciar funciones de módulos.
La función se llama una vez en el momento en que la sesión de stream alcanza la fase preread por primera vez. La función se llama con los siguientes argumentos:
| el objeto sesión de stream |
En esta fase, es posible realizar la inicialización o registrar un callback con el método s.on() para cada fragmento de datos entrante hasta que se llame a uno de los siguientes métodos: s.done(), s.decline(), s.allow(). Cuando se llama a uno de estos métodos, la sesión de stream cambia a la siguiente fase y se eliminan todos los callbacks actuales de s.on().
Nota
Como el manejador js_preread devuelve su resultado inmediatamente, solo admite operaciones síncronas. Por lo tanto, las operaciones asíncronas como ngx.fetch() o setTimeout() no son compatibles. Sin embargo, las operaciones asíncronas son compatibles en los callbacks de s.on() en la fase preread.
js_set#
Establece una función njs para la variable especificada. Se pueden referenciar funciones de módulos.
La función se llama cuando la variable se referencia por primera vez para una solicitud dada. El momento exacto depende de la fase en la que se haga referencia a la variable. Esto se puede utilizar para realizar alguna lógica no relacionada con la evaluación de variables. Por ejemplo, si la variable se referencia solo en la directiva log_format, su manejador no se ejecutará hasta la fase de registro. Este manejador se puede utilizar para realizar alguna limpieza justo antes de que se libere la solicitud.
Desde njs 0.8.6, cuando se proporciona el argumento opcional nocache, el manejador se llama cada vez que se hace referencia a él. Debido a las limitaciones actuales del módulo rewrite, cuando una variable nocache es referenciada por la directiva set, su manejador siempre debe devolver un valor de longitud fija.
Nota
Como el manejador js_set devuelve su resultado inmediatamente, solo admite operaciones síncronas. Por lo tanto, las operaciones asíncronas como ngx.fetch() o setTimeout() no son compatibles.
js_var#
Declara una variable escribible. El valor puede contener texto, variables y su combinación.
Propiedades del Objeto de Sesión#
Cada manejador njs de stream recibe un argumento, un objeto sesión de stream.
Contenido