ffi: accept safe integer numbers for int64 and uint64 arguments
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Facilidade para iniciantes
- 25/100
- Tipo de issue
- Funcionalidade
- Clareza
- Razoavelmente clara
- Status de atividade
- Estagnada
- Stack de tecnologia
- javascript, node.js
- Domínio
- backend-api-design
Direção de pesquisa
Start by reviewing related PR #66197 and the FFI argument conversion paths it changes. Check the Fast API, SharedBuffer, and generic argument conversion tests described in the issue. Done means safe integer numbers are accepted for int64 and uint64 arguments with the stated range checks, while bigint behavior, return values, and existing tests remain correct.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
What is the problem this feature will solve?
Currently, int64 and uint64 FFI arguments require JavaScript bigint values. Passing a number is rejected even when it is a small integer that can be represented exactly by both JavaScript and the native type.
This adds an explicit conversion at the call site when the value is already available as a number. A common example is passing a buffer and its length to a native function:
uint64_t sum_buffer(const uint8_t* buffer, uint64_t length);
const { functions } = ffi.dlopen(libraryPath, {
sum_buffer: {
arguments: ['buffer', 'u64'],
return: 'u64',
},
});
const bytes = new Uint8Array([1, 2, 3]);
functions.sum_buffer(bytes, bytes.byteLength); // ERR_INVALID_ARG_VALUE
functions.sum_buffer(bytes, BigInt(bytes.byteLength)); // 6n
bytes.byteLength is 3, but the caller still needs to wrap it in BigInt() because the native parameter is declared as uint64_t.
The same issue applies to arguments unrelated to buffers, such as counters or offsets:
const { functions } = ffi.dlopen(libraryPath, {
set_counter: {
arguments: ['u64'],
return: 'void',
},
});
const count = 100;
functions.set_counter(count); // ERR_INVALID_ARG_VALUE
functions.set_counter(BigInt(count)); // 100
Requiring bigint makes sense when a value is outside JavaScript's safe integer range. For values already within that range, however, it seems useful to let the runtime validate and convert them rather than requiring callers to do so explicitly.
What is the feature you are proposing to solve the problem?
Allow safe integer numbers as int64 and uint64 FFI arguments, alongside the existing bigint support.
The accepted number ranges would be:
- int64 / i64:
Number.MIN_SAFE_INTEGERthroughNumber.MAX_SAFE_INTEGER. - uint64 / u64: 0 through
Number.MAX_SAFE_INTEGER.
Node.js would validate the number before converting it internally. Fractional numbers, NaN, infinities, and numbers outside the accepted range would throw ERR_INVALID_ARG_VALUE. Negative numbers would also be rejected for uint64.
functions.sum_buffer(bytes, bytes.byteLength);
functions.set_counter(100);
Existing bigint arguments would continue to work, including values beyond the safe integer range that fit within the declared native type:
functions.set_counter(100); // Accepted
functions.set_counter(100n); // Still accepted
functions.set_counter((2n ** 64n) - 1n); // Still accepted
functions.set_counter(-1); // Rejected
functions.set_counter(1.5); // Rejected
functions.set_counter(Number.MAX_SAFE_INTEGER + 1); // Rejected
functions.set_counter(2n ** 64n); // Rejected
The number restriction is intentional: converting an unsafe number to bigint cannot recover precision that may already have been lost. Callers would still need bigint for integers outside the safe integer range.
This proposal only changes which values are accepted as native function arguments. It does not change 64-bit return values, which would remain bigint, or infer a buffer length automatically.
I've opened a related PR #66197 with the implementation, documentation, and tests covering the Fast API, SharedBuffer, and generic argument conversion paths. A review of the proposed behavior and implementation would be appreciated.
What alternatives have you considered?
I haven't identified another approach that addresses this without changing the accepted argument types. Callers can continue using BigInt() explicitly, or put those conversions in their own wrapper functions.
Both approaches work, but callers still need to handle the conversion whenever an existing number is passed to an int64 or uint64 parameter. For example, passing buffer.byteLength requires an extra BigInt() call even though the length is already a suitable integer.
Accepting safe integer numbers would remove that extra step for common calls while retaining explicit range checks and bigint support for larger values.
- Linguagem predominante
- JavaScript
- Estrelas
- 122k
- Forks
- 37.4k
- Merge médio
- 4d 2h
- PRs com merge (30d)
- 277
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de nodejs/node
-
doc
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 65/100
-
build
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 88/100
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 90/100
-
feature request
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
Todas as issues de nodejs/node
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 82/100
-
area-deployment area-integrations triage:bot-seen
Dificuldade 2/5 Meio dia Facilidade para iniciantes 86/100
-
Issue-Bug
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
sugarlabs/musicblocks#8924 ·
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 90/100
ArduPilot/ardupilot_wiki#8088 ·
-
[BUG] createTool tools cannot be registered with Mastra when exactOptionalPropertyTypes is enabled Abertacustomer-eng status: needs triage
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100