Skip to content

util: add types.isFloat16Array() #57879

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

Conversation

LiviaMedeiros
Copy link
Member

Float16Array is expected to become a thing in upcoming major release, and it's already available with --js-float16array runtime v8 flag.

@nodejs-github-bot nodejs-github-bot added needs-ci PRs that need a full CI run. util Issues and PRs related to the built-in util module. labels Apr 14, 2025
@LiviaMedeiros LiviaMedeiros force-pushed the util-types-isfloat16array branch from 1d0b220 to 2096f20 Compare April 14, 2025 22:14
Copy link
Member

@BridgeAR BridgeAR left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with the linter issues addressed

@nodejs-github-bot
Copy link
Collaborator

Copy link

codecov bot commented Apr 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.24%. Comparing base (b2405e9) to head (e66b702).
Report is 14 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #57879   +/-   ##
=======================================
  Coverage   90.23%   90.24%           
=======================================
  Files         630      630           
  Lines      185688   185693    +5     
  Branches    36405    36402    -3     
=======================================
+ Hits       167559   167578   +19     
- Misses      11000    11001    +1     
+ Partials     7129     7114   -15     
Files with missing lines Coverage Δ
lib/internal/util/types.js 100.00% <100.00%> (ø)

... and 22 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@@ -3102,6 +3102,23 @@ types.isExternal(new String('foo')); // returns false
For further information on `napi_create_external`, refer to
[`napi_create_external()`][].

### `util.types.isFloat16Array(value)`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be done fully on user land , why are we exposing it?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wouldn't it be inconsistent to not expose the 16 bit version next to all others?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure consistency should be enough to expand the API surface. Is there any other reasoning for adding this other than consistency?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the scope of this PR, the aim is on having this particular function on node:internal/util/types. It is re-exported as node:util/types as is.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It can't be done in userland easily, though, because you'd have to extract the Symbol.toStringTag getter. Consistency is a pretty strong justification for extending any API surface, on its own merits.

@@ -1,4 +1,5 @@
// Flags: --experimental-vm-modules --expose-internals --allow-natives-syntax
// Flags: --experimental-vm-modules --expose-internals --allow-natives-syntax --js-float16array
// TODO(LiviaMedeiros): once `Float16Array` is unflagged in v8, remove `--js-float16array` above
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also think we shouldn't land this until this becomes stable.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think doing it the other way around is actually good so that the new method is available as soon as it becomes stable. It will likely not be used before that anyway.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is already stable, it is stage 4 – and if you meant the V8 implementation, that's really not necessary IMO, precisely because we can trust it will follow the spec.

Copy link
Member

@anonrig anonrig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we should add this when it is still not exposed globally in V8. We also shouldn't backport this to any other release lines.

@LiviaMedeiros
Copy link
Member Author

I don't think we should add this when it is still not exposed globally in V8.

Why? It is under runtime flag yet, but it already can be used in currently supported release lines. The worst that can happen from using it without the flag is the function returning false (but before that, new Float16Array() would throw anyway).

I understand possible concern of "it is confusing for users if we provide typecheck function for something that doesn't exist without runtime flag", but I can't come up with a scenario where this would actually hurt or be misused.

We also shouldn't backport this to any other release lines.

On the contrary, I'd like to have it as semver-patch and be included/backported in past release lines. The reason is that this would unblock other patches (e.g. #57880).

@ljharb
Copy link
Member

ljharb commented Apr 15, 2025

@LiviaMedeiros minor, not patch, since it's adding something :-)

@LiviaMedeiros LiviaMedeiros added the semver-minor PRs that contain new features and should be released in the next minor version. label Apr 15, 2025
@nodejs-github-bot

This comment was marked as outdated.

@aduh95 aduh95 added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Apr 15, 2025
@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Apr 15, 2025

@aduh95 aduh95 added commit-queue Add this label to land a pull request using GitHub Actions. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. labels Apr 15, 2025
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Apr 16, 2025
@nodejs-github-bot nodejs-github-bot merged commit e61937b into nodejs:main Apr 16, 2025
67 checks passed
@nodejs-github-bot
Copy link
Collaborator

Landed in e61937b

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. needs-ci PRs that need a full CI run. semver-minor PRs that contain new features and should be released in the next minor version. util Issues and PRs related to the built-in util module.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants