Skip to content
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.

Sign up for GitHub

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

Jump to bottom

src: use stricter compile-time guidance #46509

Merged
merged 1 commit into from Apr 4, 2023
Merged

src: use stricter compile-time guidance #46509

merged 1 commit into from Apr 4, 2023

Conversation

tniessen
Copy link
Member

@tniessen tniessen commented Feb 5, 2023 •
edited

SnapshotSerializerDeserializer::GetName() appears to confuse static analysis such as Coverity.

This changes the function structure to a sequence of if-else blocks and marks all branch conditions as constexpr. (Unfortunately, this results in a dangling else keyword in the V macro.)

As a side effect, this change ensures that GetName<T>() can only be called for known types T (instead of returning an empty string). As per a request in the PR discussion, this change does not ensure that GetName<T>() can only be called for known types T and instead still returns an empty string in that case.

Also use std::is_unsigned_v instead of !std::is_signed_v.

@tniessen tniessen added the c++ Issues and PRs that require attention from people who are familiar with C++. label Feb 5, 2023
@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/startup

@nodejs-github-bot nodejs-github-bot added the needs-ci PRs that need a full CI run. label Feb 5, 2023
@joyeecheung
Copy link
Member

joyeecheung commented Feb 5, 2023 •
edited

As a side effect, this change ensures that GetName() can only be called for known types T (instead of returning an empty string).

Why would this be necessary? This is a debugging facility that decorates the log output, it would be fine to just give up if "I don't know what it's called, so I won't attempt to tell you what the type name is, because RTTI is disallowed" (I think I relied on this when developing deserialization/serialization of new types, which was fine because it's possible to guess the name from the context anyway).

@tniessen
Copy link
Member Author

tniessen commented Feb 5, 2023 •
edited

Why would this be necessary?

It's certainly not necessary. I can change it to allow unknown types, but unless I'm missing something, I don't really see the point. Wouldn't it only take a one-line change to add new non-arithmetic types?

@tniessen
Copy link
Member Author

@joyeecheung is your comment blocking?

@tniessen tniessen added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. request-ci Add this label to start a Jenkins CI on a PR. labels Feb 19, 2023
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Feb 19, 2023
@nodejs-github-bot

This comment was marked as outdated.

Sign in to view
@nodejs-github-bot

This comment was marked as outdated.

Sign in to view
@joyeecheung
Copy link
Member

joyeecheung commented Feb 19, 2023 •
edited

Sorry for missing the ping. I wouldn't say it's a hill that I'd die on but it's also weird that this restriction exists. The function is just a utility that attempts to assemble a human-readable name for a type (or it's just poor-man's RTTI). Returning an empty string for a type that we don't special case is totally acceptable. Does the static analyzer complain about it? If it does it would make more sense to do if (!std::is_arithmetic_v<T>) { return ""; /* gives up */ } than adding a static assert.

@github-actions github-actions bot mentioned this pull request Feb 20, 2023
Open
24 tasks
@joyeecheung joyeecheung mentioned this pull request Feb 20, 2023
Closed
@github-actions github-actions bot mentioned this pull request Feb 21, 2023
Open
26 tasks
@tniessen
src: use stricter compile-time guidance
8ddfb52 
SnapshotSerializerDeserializer::GetName() appears to confuse static
analysis such as Coverity.

This changes the function structure to a sequence of if-else blocks and
marks all branch conditions as constexpr. (Unfortunately, this results
in a dangling 'else' keyword in the V macro.)

As per a request in the PR discussion, this change does _not_ ensure
that GetName<T>() can only be called for known types T and instead still
returns an empty string in that case.

Also use std::is_unsigned_v instead of !std::is_signed_v.
@tniessen tniessen force-pushed the src-snapshotable-getname-constexpr branch from 451850a to 8ddfb52 Compare March 29, 2023 12:26
@tniessen
Copy link
Member Author

@joyeecheung Sorry about the delay, I've updated the PR as requested. PTAL.

@aduh95 aduh95 added the request-ci Add this label to start a Jenkins CI on a PR. label Mar 29, 2023
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Mar 29, 2023
@nodejs-github-bot

This comment was marked as outdated.

Sign in to view
@github-actions github-actions bot mentioned this pull request Mar 30, 2023
Open
18 tasks
@nodejs-github-bot

This comment was marked as outdated.

Sign in to view
mhdawson
mhdawson approved these changes Mar 30, 2023
View reviewed changes
Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

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

LGTM

@nodejs-github-bot

This comment was marked as outdated.

Sign in to view
@nodejs-github-bot
Copy link
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/50720/

This was referenced Mar 31, 2023
Open
Open
Open
@tniessen tniessen added the commit-queue Add this label to land a pull request using GitHub Actions. label Apr 4, 2023
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Apr 4, 2023
@nodejs-github-bot nodejs-github-bot merged commit aa3dbe3 into nodejs:main Apr 4, 2023
55 checks passed
@nodejs-github-bot
Copy link
Collaborator

Landed in aa3dbe3

RafaelGSS pushed a commit that referenced this pull request Apr 5, 2023
@tniessen @RafaelGSS
src: use stricter compile-time guidance
8fe9a14 
SnapshotSerializerDeserializer::GetName() appears to confuse static
analysis such as Coverity.

This changes the function structure to a sequence of if-else blocks and
marks all branch conditions as constexpr. (Unfortunately, this results
in a dangling 'else' keyword in the V macro.)

As per a request in the PR discussion, this change does _not_ ensure
that GetName<T>() can only be called for known types T and instead still
returns an empty string in that case.

Also use std::is_unsigned_v instead of !std::is_signed_v.

PR-URL: #46509
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
RafaelGSS pushed a commit that referenced this pull request Apr 5, 2023
@tniessen @RafaelGSS
src: use stricter compile-time guidance
a4e5ae7 
SnapshotSerializerDeserializer::GetName() appears to confuse static
analysis such as Coverity.

This changes the function structure to a sequence of if-else blocks and
marks all branch conditions as constexpr. (Unfortunately, this results
in a dangling 'else' keyword in the V macro.)

As per a request in the PR discussion, this change does _not_ ensure
that GetName<T>() can only be called for known types T and instead still
returns an empty string in that case.

Also use std::is_unsigned_v instead of !std::is_signed_v.

PR-URL: #46509
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
@RafaelGSS RafaelGSS mentioned this pull request Apr 6, 2023
Merged
RafaelGSS pushed a commit that referenced this pull request Apr 6, 2023
@tniessen @RafaelGSS
src: use stricter compile-time guidance
93392a0 
SnapshotSerializerDeserializer::GetName() appears to confuse static
analysis such as Coverity.

This changes the function structure to a sequence of if-else blocks and
marks all branch conditions as constexpr. (Unfortunately, this results
in a dangling 'else' keyword in the V macro.)

As per a request in the PR discussion, this change does _not_ ensure
that GetName<T>() can only be called for known types T and instead still
returns an empty string in that case.

Also use std::is_unsigned_v instead of !std::is_signed_v.

PR-URL: #46509
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
RafaelGSS pushed a commit that referenced this pull request Apr 7, 2023
@tniessen @RafaelGSS
src: use stricter compile-time guidance
b748b69 
SnapshotSerializerDeserializer::GetName() appears to confuse static
analysis such as Coverity.

This changes the function structure to a sequence of if-else blocks and
marks all branch conditions as constexpr. (Unfortunately, this results
in a dangling 'else' keyword in the V macro.)

As per a request in the PR discussion, this change does _not_ ensure
that GetName<T>() can only be called for known types T and instead still
returns an empty string in that case.

Also use std::is_unsigned_v instead of !std::is_signed_v.

PR-URL: #46509
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
RafaelGSS pushed a commit that referenced this pull request Apr 8, 2023
@tniessen @RafaelGSS
src: use stricter compile-time guidance
4405fc8 
SnapshotSerializerDeserializer::GetName() appears to confuse static
analysis such as Coverity.

This changes the function structure to a sequence of if-else blocks and
marks all branch conditions as constexpr. (Unfortunately, this results
in a dangling 'else' keyword in the V macro.)

As per a request in the PR discussion, this change does _not_ ensure
that GetName<T>() can only be called for known types T and instead still
returns an empty string in that case.

Also use std::is_unsigned_v instead of !std::is_signed_v.

PR-URL: #46509
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
RafaelGSS pushed a commit that referenced this pull request Apr 13, 2023
@tniessen @RafaelGSS
src: use stricter compile-time guidance
52a01e2 
SnapshotSerializerDeserializer::GetName() appears to confuse static
analysis such as Coverity.

This changes the function structure to a sequence of if-else blocks and
marks all branch conditions as constexpr. (Unfortunately, this results
in a dangling 'else' keyword in the V macro.)

As per a request in the PR discussion, this change does _not_ ensure
that GetName<T>() can only be called for known types T and instead still
returns an empty string in that case.

Also use std::is_unsigned_v instead of !std::is_signed_v.

PR-URL: #46509
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
danielleadams pushed a commit that referenced this pull request Jul 6, 2023
@tniessen @danielleadams
src: use stricter compile-time guidance
3c28a18 
SnapshotSerializerDeserializer::GetName() appears to confuse static
analysis such as Coverity.

This changes the function structure to a sequence of if-else blocks and
marks all branch conditions as constexpr. (Unfortunately, this results
in a dangling 'else' keyword in the V macro.)

As per a request in the PR discussion, this change does _not_ ensure
that GetName<T>() can only be called for known types T and instead still
returns an empty string in that case.

Also use std::is_unsigned_v instead of !std::is_signed_v.

PR-URL: #46509
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
MoLow pushed a commit to MoLow/node that referenced this pull request Jul 6, 2023
@tniessen @MoLow
src: use stricter compile-time guidance
0fbfb28 
SnapshotSerializerDeserializer::GetName() appears to confuse static
analysis such as Coverity.

This changes the function structure to a sequence of if-else blocks and
marks all branch conditions as constexpr. (Unfortunately, this results
in a dangling 'else' keyword in the V macro.)

As per a request in the PR discussion, this change does _not_ ensure
that GetName<T>() can only be called for known types T and instead still
returns an empty string in that case.

Also use std::is_unsigned_v instead of !std::is_signed_v.

PR-URL: nodejs#46509
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
@danielleadams danielleadams mentioned this pull request Jul 10, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jasnell jasnell jasnell approved these changes

@mhdawson mhdawson mhdawson approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. c++ Issues and PRs that require attention from people who are familiar with C++. needs-ci PRs that need a full CI run.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@tniessen @nodejs-github-bot @joyeecheung @jasnell @mhdawson @aduh95