Add FunctionObject::getScriptId() method

Author: pinepain

Diff for: src/php_v8_function.cc

@@ -541,6 +541,27 @@ static PHP_METHOD(Function, getScriptColumnNumber) {
     RETURN_LONG((zend_long) column_number);
 }
 
+static PHP_METHOD(Function, getScriptId) {
+
+    if (zend_parse_parameters_none() == FAILURE) {
+        return;
+    }
+
+    PHP_V8_VALUE_FETCH_WITH_CHECK(getThis(), php_v8_value);
+    PHP_V8_ENTER_STORED_ISOLATE(php_v8_value);
+    PHP_V8_ENTER_STORED_CONTEXT(php_v8_value);
+
+    v8::Local<v8::Function> local_function = php_v8_value_get_local_as<v8::Function>(php_v8_value);
+
+    int script_id = local_function->ScriptId();
+
+    if (script_id == v8::Message::kNoScriptIdInfo) {
+        RETURN_NULL();
+    }
+
+    RETURN_LONG((zend_long) script_id);
+}
+
 static PHP_METHOD(Function, getBoundFunction) {
     if (zend_parse_parameters_none() == FAILURE) {
         return;
@@ -610,6 +631,9 @@ ZEND_END_ARG_INFO()
 PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_getScriptColumnNumber, ZEND_RETURN_VALUE, 0, IS_LONG, 1)
 ZEND_END_ARG_INFO()
 
+PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_getScriptId, ZEND_RETURN_VALUE, 0, IS_LONG, 1)
+ZEND_END_ARG_INFO()
+
 PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(arginfo_getBoundFunction, ZEND_RETURN_VALUE, 0, V8\\Value, 0)
 ZEND_END_ARG_INFO()
 
@@ -626,6 +650,7 @@ static const zend_function_entry php_v8_object_methods[] = {
         PHP_V8_ME(Function, getDisplayName,        ZEND_ACC_PUBLIC)
         PHP_V8_ME(Function, getScriptLineNumber,   ZEND_ACC_PUBLIC)
         PHP_V8_ME(Function, getScriptColumnNumber, ZEND_ACC_PUBLIC)
+        PHP_V8_ME(Function, getScriptId,           ZEND_ACC_PUBLIC)
         PHP_V8_ME(Function, getBoundFunction,      ZEND_ACC_PUBLIC)
         PHP_V8_ME(Function, getScriptOrigin,       ZEND_ACC_PUBLIC)
 

Diff for: stubs/src/FunctionObject.php

@@ -113,16 +113,19 @@ public function getScriptColumnNumber(): ?int
     }
 
 
-    ///**
-    // * Returns scriptId.
-    // */
-    //int ScriptId() const;
+    /**
+     * Returns script id where function was created and null if no information available.
+     *
+     * @return int
+     */
+    public function getScriptId(): ?int
+    {
+    }
 
     /**
-     * Returns the original function if this function is bound, else returns
-     * v8::Undefined.
+     * Returns the original function if this function is bound, else returns UndefinedValue.
      *
-     * @return Value
+     * @return FunctionObject|UndefinedValue|Value
      */
     public function getBoundFunction(): Value
     {

Diff for: tests/.testsuite.php

@@ -197,11 +197,17 @@ public function method_matches_instanceof($object, $method, $expected, array $ar
         echo get_class($object), '::', $method, '() result', ($object->$method(...$args) instanceof $expected ? ' is' : ' not an'), ' instance of ', $expected, PHP_EOL;
     }
 
-
     public function method_matches_with_output($object, $method, $expected, array $args = [])
     {
-        echo get_class($object), '::', $method, '()', ' ', ($expected === $object->$method(...$args) ? 'matches' : 'doesn\'t match'), ' expected ', var_export($expected,
-            true), PHP_EOL;
+        echo get_class($object), '::', $method, '()', ' ';
+        echo ($expected === ($res = $object->$method(...$args)) ? 'matches' : 'doesn\'t match');
+        echo ' expected ', var_export($expected, true);
+
+        if ($expected !== $res) {
+            echo ', given ', var_export($res, true);
+        }
+
+        echo  PHP_EOL;
     }
 
     public function method_matches_with_dump($object, $method, $expected, array $args = [])

Diff for: tests/001-verify_extension_entities.phpt

@@ -721,6 +721,7 @@ class V8\FunctionObject
     public function getDisplayName(): V8\Value
     public function getScriptLineNumber(): ?int
     public function getScriptColumnNumber(): ?int
+    public function getScriptId(): ?int
     public function getBoundFunction(): V8\Value
     public function getScriptOrigin(): V8\ScriptOrigin
 

Diff for: tests/FunctionObject.phpt

@@ -15,9 +15,9 @@ $v8_helper = new PhpV8Helpers($helper);
 
 require '.tracking_dtors.php';
 
-$isolate = new v8Tests\TrackingDtors\Isolate();
+$isolate         = new v8Tests\TrackingDtors\Isolate();
 $global_template = new V8\ObjectTemplate($isolate);
-$context = new V8\Context($isolate, $global_template);
+$context         = new V8\Context($isolate, $global_template);
 
 
 $func = new v8Tests\TrackingDtors\FunctionObject($context, function (\V8\FunctionCallbackInfo $info) {
@@ -33,24 +33,32 @@ $helper->space();
 $helper->assert('FunctionObject extends ObjectValue', $func instanceof \V8\ObjectValue);
 $helper->assert('FunctionObject implements AdjustableExternalMemoryInterface', $func instanceof \V8\AdjustableExternalMemoryInterface);
 $helper->assert('FunctionObject is instanceof Function', $func->instanceOf($context, $context->globalObject()->get($context, new \V8\StringValue($isolate, 'Function'))));
+$helper->assert('Function created from php holds no script id', $func->getScriptId() === null);
 $helper->line();
 
 $v8_helper->run_checks($func, 'Checkers');
 
 $context->globalObject()->set($context, new \V8\StringValue($isolate, 'print'), $func);
 
-$source = 'print("Hello, world"); delete print; "Script done"';
+$source    = 'print("Hello, world"); delete print; "Script done"';
 $file_name = 'test.js';
 
 
 $script = new V8\Script($context, new \V8\StringValue($isolate, $source), new \V8\ScriptOrigin($file_name));
 
 $helper->dump($script->run($context)->toString($context)->value());
+
+$helper->assert('Function created from php still holds no script id after been passed to script', $func->getScriptId() === null);
+
 $helper->line();
 
 $helper->dump_object_methods($func, [], new ArrayMapFilter(['getScriptOrigin' => true]));
 $helper->line();
 
+$helper->line();
+$fnc2 = $v8_helper->CompileRun($context, 'function test() {}; test');
+$helper->assert('Function from script holds script id', $fnc2->getScriptId() !== null);
+
 echo 'We are done for now', PHP_EOL;
 
 ?>
@@ -73,6 +81,7 @@ object(v8Tests\TrackingDtors\FunctionObject)#6 (2) {
 FunctionObject extends ObjectValue: ok
 FunctionObject implements AdjustableExternalMemoryInterface: ok
 FunctionObject is instanceof Function: ok
+Function created from php holds no script id: ok
 
 Checkers:
 ---------
@@ -132,17 +141,18 @@ v8Tests\TrackingDtors\FunctionObject(V8\Value)->isProxy(): bool(false)
 
 Should output Hello World string
 string(11) "Script done"
+Function created from php still holds no script id after been passed to script: ok
 
 v8Tests\TrackingDtors\FunctionObject(V8\FunctionObject)->getScriptOrigin():
-    object(V8\ScriptOrigin)#128 (6) {
+    object(V8\ScriptOrigin)#129 (6) {
       ["resource_name":"V8\ScriptOrigin":private]=>
       string(0) ""
       ["resource_line_offset":"V8\ScriptOrigin":private]=>
       int(0)
       ["resource_column_offset":"V8\ScriptOrigin":private]=>
       int(0)
       ["options":"V8\ScriptOrigin":private]=>
-      object(V8\ScriptOriginOptions)#132 (4) {
+      object(V8\ScriptOriginOptions)#133 (4) {
         ["is_shared_cross_origin":"V8\ScriptOriginOptions":private]=>
         bool(false)
         ["is_opaque":"V8\ScriptOriginOptions":private]=>
@@ -158,6 +168,8 @@ v8Tests\TrackingDtors\FunctionObject(V8\FunctionObject)->getScriptOrigin():
       string(0) ""
     }
 
+
+Function from script holds script id: ok
 We are done for now
 FunctionObject dies now!
 Isolate dies now!