Skip to content

n-api: refactoring a previous commit #28848

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

Closed
octaviansoldea wants to merge 2 commits into from
Closed

n-api: refactoring a previous commit #28848

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7723333
n-api: refactoring a previous commit
Jul 18, 2019
34a8e10
n-api: refactoring a previous commit - answer 1
Jul 24, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions test/js-native-api/common.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
#include <js_native_api.h>
#include "common.h"

#include <stdio.h>

void add_returned_status(napi_env env,
const char* key,
napi_value object,
napi_status expected_status,
Comment thread
gabrielschulhof marked this conversation as resolved.
napi_status actual_status) {

char p_napi_message[100] = "";
napi_value prop_value;

if (actual_status == expected_status) {
snprintf(p_napi_message, 99, "Invalid argument");
Copy link
Copy Markdown
Member

@addaleax addaleax Jul 24, 2019

Choose a reason for hiding this comment

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

Suggested change
snprintf(p_napi_message, 99, "Invalid argument");
snprintf(p_napi_message, sizeof(p_napi_message), "Invalid argument");

(Side note: why the p_? Do you know that?)

Copy link
Copy Markdown
Author

@octaviansoldea octaviansoldea Jul 24, 2019

Choose a reason for hiding this comment

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

Hi @addaleax

Thank you for your message. Usually I use p_ for a name that indicates a pointer. Could you please suggest a better name?

Thank you in advance,
@octaviansoldea

Copy link
Copy Markdown
Member

@addaleax addaleax Jul 24, 2019

Choose a reason for hiding this comment

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

Usually I use p_ for a name that indicates a pointer.

Okay, that makes sense, but we generally don’t to this elsewhere 🙂. How about just napi_message, or if you want to be explicit about the type, napi_message_string?

} else {
snprintf(p_napi_message, 99, "Invalid status [%d]", actual_status);
Copy link
Copy Markdown
Member

@addaleax addaleax Jul 24, 2019

Choose a reason for hiding this comment

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

Suggested change
snprintf(p_napi_message, 99, "Invalid status [%d]", actual_status);
snprintf(p_napi_message, sizeof(p_napi_message), "Invalid status [%d]", actual_status);

}

NAPI_CALL_RETURN_VOID(env,
napi_create_string_utf8(env,
p_napi_message,
NAPI_AUTO_LENGTH,
&prop_value));
NAPI_CALL_RETURN_VOID(env,
napi_set_named_property(env,
object,
key,
prop_value));
}

void add_last_status(napi_env env, const char* key, napi_value return_value) {
napi_value prop_value;
const napi_extended_error_info* p_last_error;
NAPI_CALL_RETURN_VOID(env, napi_get_last_error_info(env, &p_last_error));

NAPI_CALL_RETURN_VOID(env,
napi_create_string_utf8(env,
(p_last_error->error_message == NULL ?
"napi_ok" :
p_last_error->error_message),
NAPI_AUTO_LENGTH,
&prop_value));
NAPI_CALL_RETURN_VOID(env, napi_set_named_property(env,
return_value,
key,
prop_value));
}
8 changes: 8 additions & 0 deletions test/js-native-api/common.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,3 +58,11 @@

#define DECLARE_NAPI_GETTER(name, func) \
{ (name), NULL, NULL, (func), NULL, NULL, napi_default, NULL }

void add_returned_status(napi_env env,
const char* key,
napi_value object,
napi_status expected_status,
napi_status actual_status);

void add_last_status(napi_env env, const char* key, napi_value return_value);
1 change: 1 addition & 0 deletions test/js-native-api/test_constructor/binding.gyp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
{
"target_name": "test_constructor",
"sources": [
"../common.c",
"../entry_point.c",
"test_constructor.c"
]
Expand Down
49 changes: 7 additions & 42 deletions test/js-native-api/test_constructor/test_constructor.c
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,35 +1,13 @@
#include <js_native_api.h>
#include "../common.h"

#include <stdio.h>

static double value_ = 1;
static double static_value_ = 10;

static void
add_named_status(napi_env env, const char* key, napi_value return_value) {
napi_value prop_value;
const napi_extended_error_info* p_last_error;
NAPI_CALL_RETURN_VOID(env, napi_get_last_error_info(env, &p_last_error));

NAPI_CALL_RETURN_VOID(env,
napi_create_string_utf8(env,
(p_last_error->error_message == NULL ?
"napi_ok" :
p_last_error->error_message),
NAPI_AUTO_LENGTH,
&prop_value));
NAPI_CALL_RETURN_VOID(env, napi_set_named_property(env,
return_value,
key,
prop_value));
}

static napi_value TestDefineClass(napi_env env,
napi_callback_info info) {
napi_status status;
napi_value result, return_value, prop_value;
char p_napi_message[100] = "";
napi_value result, return_value;

napi_property_descriptor property_descriptor = {
"TestDefineClass",
Expand All @@ -52,20 +30,7 @@ static napi_value TestDefineClass(napi_env env,
&property_descriptor,
&result);

if (status == napi_invalid_arg) {
snprintf(p_napi_message, 99, "Invalid argument");
} else {
snprintf(p_napi_message, 99, "Invalid status [%d]", status);
}

NAPI_CALL(env, napi_create_string_utf8(env,
p_napi_message,
NAPI_AUTO_LENGTH,
&prop_value));
NAPI_CALL(env, napi_set_named_property(env,
return_value,
"envIsNull",
prop_value));
add_returned_status(env, "envIsNull", return_value, napi_invalid_arg, status);

napi_define_class(env,
NULL,
Expand All @@ -76,7 +41,7 @@ static napi_value TestDefineClass(napi_env env,
&property_descriptor,
&result);

add_named_status(env, "nameIsNull", return_value);
add_last_status(env, "nameIsNull", return_value);

napi_define_class(env,
"TrackedFunction",
Expand All @@ -87,7 +52,7 @@ static napi_value TestDefineClass(napi_env env,
&property_descriptor,
&result);

add_named_status(env, "cbIsNull", return_value);
add_last_status(env, "cbIsNull", return_value);

napi_define_class(env,
"TrackedFunction",
Expand All @@ -98,7 +63,7 @@ static napi_value TestDefineClass(napi_env env,
&property_descriptor,
&result);

add_named_status(env, "cbDataIsNull", return_value);
add_last_status(env, "cbDataIsNull", return_value);

napi_define_class(env,
"TrackedFunction",
Expand All @@ -109,7 +74,7 @@ static napi_value TestDefineClass(napi_env env,
NULL,
&result);

add_named_status(env, "propertiesIsNull", return_value);
add_last_status(env, "propertiesIsNull", return_value);


napi_define_class(env,
Expand All @@ -121,7 +86,7 @@ static napi_value TestDefineClass(napi_env env,
&property_descriptor,
NULL);

add_named_status(env, "resultIsNull", return_value);
add_last_status(env, "resultIsNull", return_value);

return return_value;
}
Expand Down
1 change: 1 addition & 0 deletions test/js-native-api/test_object/binding.gyp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
{
"target_name": "test_object",
"sources": [
"../common.c",
"../entry_point.c",
"test_object.c"
]
Expand Down
24 changes: 12 additions & 12 deletions test/js-native-api/test_object/test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,26 +229,26 @@ assert.strictEqual(newObject.test_string, 'test string');
// Verify that passing NULL to napi_set_property() results in the correct
// error.
assert.deepStrictEqual(test_object.TestSetProperty(), {
envIsNull: 'pass',
objectIsNull: 'pass',
keyIsNull: 'pass',
valueIsNull: 'pass'
envIsNull: 'Invalid argument',
objectIsNull: 'Invalid argument',
keyIsNull: 'Invalid argument',
valueIsNull: 'Invalid argument'
});

// Verify that passing NULL to napi_has_property() results in the correct
// error.
assert.deepStrictEqual(test_object.TestHasProperty(), {
envIsNull: 'pass',
objectIsNull: 'pass',
keyIsNull: 'pass',
resultIsNull: 'pass'
envIsNull: 'Invalid argument',
objectIsNull: 'Invalid argument',
keyIsNull: 'Invalid argument',
resultIsNull: 'Invalid argument'
});

// Verify that passing NULL to napi_get_property() results in the correct
// error.
assert.deepStrictEqual(test_object.TestGetProperty(), {
envIsNull: 'pass',
objectIsNull: 'pass',
keyIsNull: 'pass',
resultIsNull: 'pass'
envIsNull: 'Invalid argument',
objectIsNull: 'Invalid argument',
keyIsNull: 'Invalid argument',
resultIsNull: 'Invalid argument'
});
Loading