JS#
El módulo se utiliza para implementar manejadores en njs — un subconjunto del lenguaje JavaScript.
En nuestros repositorios, el módulo se construye dinámicamente dinámicamente y está disponible como un paquete separado 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 usar junto con la versión regular.
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.
// Injects 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. Las funciones de módulos pueden ser referenciadas.
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_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_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 de la sesión de stream <https://nginx.org/en/docs/njs/reference.html#stream> |
En esta fase, es posible realizar la inicialización o registrar un callback con el método s.on() <https://nginx.org/en/docs/njs/reference.html#s_on> para cada fragmento de datos entrante. El método s.off() <https://nginx.org/en/docs/njs/reference.html#s_off> puede usarse para desregistrar un callback y detener el filtrado.
Nota
Como el controlador js_filter devuelve su resultado de inmediato, solo admite operaciones síncronas. Por lo tanto, no se admiten operaciones asíncronas como ngx.fetch() o setTimeout().
js_import#
Importa un módulo que implementa manejadores de ubicación y de variables en njs. El export_name se utiliza como un 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 utilizará 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_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 la referencia. 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 de registro s_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.
Nota
Como el manejador js_set devuelve su resultado de inmediato, 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