path: root/tests/unit-core/test-symbol.c

/* Copyright JS Foundation and other contributors, http://js.foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include "jerryscript-port-default.h"
#include "jerryscript-port.h"
#include "jerryscript.h"

#include "test-common.h"

/* foo string */
#define STRING_FOO ((const jerry_char_t *) "foo")

/* bar string */
#define STRING_BAR ((const jerry_char_t *) "bar")

/* Symbol(bar) desciptive string */
#define SYMBOL_DESCIPTIVE_STRING_BAR "Symbol(bar)"

/* bar string desciption */
#define SYMBOL_DESCIPTION_BAR "bar"

int
main (void)
{
  if (!jerry_is_feature_enabled (JERRY_FEATURE_SYMBOL))
  {
    jerry_port_log (JERRY_LOG_LEVEL_ERROR, "Symbol support is disabled!\n");
    return 0;
  }

  jerry_init (JERRY_INIT_EMPTY);

  jerry_value_t object = jerry_create_object ();

  /* Test for that each symbol is unique independently from their descriptor strings */
  jerry_value_t symbol_desc_1 = jerry_create_string (STRING_FOO);
  jerry_value_t symbol_desc_2 = jerry_create_string (STRING_FOO);

  jerry_value_t symbol_1 = jerry_create_symbol (symbol_desc_1);
  TEST_ASSERT (!jerry_value_is_error (symbol_1));
  TEST_ASSERT (jerry_value_is_symbol (symbol_1));

  jerry_value_t symbol_2 = jerry_create_symbol (symbol_desc_2);
  TEST_ASSERT (!jerry_value_is_error (symbol_2));
  TEST_ASSERT (jerry_value_is_symbol (symbol_2));

  /* The descriptor strings are no longer needed */
  jerry_release_value (symbol_desc_1);
  jerry_release_value (symbol_desc_2);

  jerry_value_t value_1 = jerry_create_number (1);
  jerry_value_t value_2 = jerry_create_number (2);

  jerry_value_t result_val = jerry_set_property (object, symbol_1, value_1);
  TEST_ASSERT (jerry_value_is_boolean (result_val));
  TEST_ASSERT (jerry_value_is_true (jerry_has_property (object, symbol_1)));
  TEST_ASSERT (jerry_value_is_true (jerry_has_own_property (object, symbol_1)));

  result_val = jerry_set_property (object, symbol_2, value_2);
  TEST_ASSERT (jerry_value_is_boolean (result_val));
  TEST_ASSERT (jerry_value_is_true (jerry_has_property (object, symbol_2)));
  TEST_ASSERT (jerry_value_is_true (jerry_has_own_property (object, symbol_2)));

  jerry_value_t get_value_1 = jerry_get_property (object, symbol_1);
  TEST_ASSERT (jerry_get_number_value (get_value_1) == jerry_get_number_value (value_1));
  jerry_release_value (get_value_1);

  jerry_value_t get_value_2 = jerry_get_property (object, symbol_2);
  TEST_ASSERT (jerry_get_number_value (get_value_2) == jerry_get_number_value (value_2));
  jerry_release_value (get_value_2);

  /* Test delete / has_{own}_property */
  TEST_ASSERT (jerry_delete_property (object, symbol_1));
  TEST_ASSERT (!jerry_value_is_true (jerry_has_property (object, symbol_1)));
  TEST_ASSERT (!jerry_value_is_true (jerry_has_own_property (object, symbol_1)));

  jerry_release_value (value_1);
  jerry_release_value (symbol_1);

  /* Test {get, define}_own_property_descriptor */
  jerry_property_descriptor_t prop_desc;
  TEST_ASSERT (jerry_get_own_property_descriptor (object, symbol_2, &prop_desc));
  TEST_ASSERT (prop_desc.flags & JERRY_PROP_IS_VALUE_DEFINED);
  TEST_ASSERT (value_2 == prop_desc.value);
  TEST_ASSERT (jerry_get_number_value (value_2) == jerry_get_number_value (prop_desc.value));
  TEST_ASSERT (prop_desc.flags & JERRY_PROP_IS_WRITABLE);
  TEST_ASSERT (prop_desc.flags & JERRY_PROP_IS_ENUMERABLE);
  TEST_ASSERT (prop_desc.flags & JERRY_PROP_IS_CONFIGURABLE);
  TEST_ASSERT (!(prop_desc.flags & JERRY_PROP_IS_GET_DEFINED));
  TEST_ASSERT (jerry_value_is_undefined (prop_desc.getter));
  TEST_ASSERT (!(prop_desc.flags & JERRY_PROP_IS_SET_DEFINED));
  TEST_ASSERT (jerry_value_is_undefined (prop_desc.setter));
  jerry_property_descriptor_free (&prop_desc);

  /* Modify the descriptor fields */
  prop_desc = jerry_property_descriptor_create ();
  jerry_value_t value_3 = jerry_create_string (STRING_BAR);

  prop_desc.flags |= JERRY_PROP_IS_VALUE_DEFINED | JERRY_PROP_IS_WRITABLE_DEFINED | JERRY_PROP_IS_ENUMERABLE_DEFINED
                     | JERRY_PROP_IS_CONFIGURABLE_DEFINED;
  prop_desc.value = jerry_acquire_value (value_3);
  TEST_ASSERT (jerry_value_is_true (jerry_define_own_property (object, symbol_2, &prop_desc)));
  jerry_property_descriptor_free (&prop_desc);

  /* Check the modified fields */
  TEST_ASSERT (jerry_get_own_property_descriptor (object, symbol_2, &prop_desc));
  TEST_ASSERT (prop_desc.flags & JERRY_PROP_IS_VALUE_DEFINED);
  TEST_ASSERT (value_3 == prop_desc.value);
  TEST_ASSERT (jerry_value_is_string (prop_desc.value));
  TEST_ASSERT (prop_desc.flags & JERRY_PROP_IS_WRITABLE_DEFINED);
  TEST_ASSERT (!(prop_desc.flags & JERRY_PROP_IS_WRITABLE));
  TEST_ASSERT (prop_desc.flags & JERRY_PROP_IS_ENUMERABLE_DEFINED);
  TEST_ASSERT (!(prop_desc.flags & JERRY_PROP_IS_ENUMERABLE));
  TEST_ASSERT (prop_desc.flags & JERRY_PROP_IS_CONFIGURABLE_DEFINED);
  TEST_ASSERT (!(prop_desc.flags & JERRY_PROP_IS_CONFIGURABLE));
  TEST_ASSERT (!(prop_desc.flags & JERRY_PROP_IS_GET_DEFINED));
  TEST_ASSERT (jerry_value_is_undefined (prop_desc.getter));
  TEST_ASSERT (!(prop_desc.flags & JERRY_PROP_IS_SET_DEFINED));
  TEST_ASSERT (jerry_value_is_undefined (prop_desc.setter));
  jerry_property_descriptor_free (&prop_desc);

  jerry_release_value (value_3);
  jerry_release_value (value_2);
  jerry_release_value (symbol_2);
  jerry_release_value (object);

  /* Test creating symbol with a symbol description */
  jerry_value_t empty_symbol_desc = jerry_create_string ((const jerry_char_t *) "");

  jerry_value_t empty_symbol = jerry_create_symbol (empty_symbol_desc);
  TEST_ASSERT (!jerry_value_is_error (empty_symbol));
  TEST_ASSERT (jerry_value_is_symbol (empty_symbol));

  jerry_release_value (empty_symbol_desc);

  jerry_value_t symbol_symbol = jerry_create_symbol (empty_symbol);
  TEST_ASSERT (!jerry_value_is_symbol (symbol_symbol));
  TEST_ASSERT (jerry_value_is_error (symbol_symbol));

  jerry_value_t error_obj = jerry_get_value_from_error (symbol_symbol, true);

  TEST_ASSERT (jerry_get_error_type (error_obj) == JERRY_ERROR_TYPE);

  jerry_release_value (error_obj);
  jerry_release_value (empty_symbol);

  /* Test symbol to string operation with symbol argument */
  jerry_value_t bar_symbol_desc = jerry_create_string (STRING_BAR);

  jerry_value_t bar_symbol = jerry_create_symbol (bar_symbol_desc);
  TEST_ASSERT (!jerry_value_is_error (bar_symbol));
  TEST_ASSERT (jerry_value_is_symbol (bar_symbol));

  jerry_release_value (bar_symbol_desc);

  jerry_value_t bar_symbol_string = jerry_get_symbol_descriptive_string (bar_symbol);
  TEST_ASSERT (jerry_value_is_string (bar_symbol_string));

  jerry_size_t bar_symbol_string_size = jerry_get_string_size (bar_symbol_string);
  TEST_ASSERT (bar_symbol_string_size == (sizeof (SYMBOL_DESCIPTIVE_STRING_BAR) - 1));
  JERRY_VLA (jerry_char_t, str_buff, bar_symbol_string_size);

  jerry_string_to_char_buffer (bar_symbol_string, str_buff, bar_symbol_string_size);
  TEST_ASSERT (memcmp (str_buff, SYMBOL_DESCIPTIVE_STRING_BAR, sizeof (SYMBOL_DESCIPTIVE_STRING_BAR) - 1) == 0);

  jerry_release_value (bar_symbol_string);

  /* Test symbol get description operation with string description */
  bar_symbol_string = jerry_get_symbol_description (bar_symbol);
  TEST_ASSERT (jerry_value_is_string (bar_symbol_string));

  bar_symbol_string_size = jerry_get_string_size (bar_symbol_string);
  TEST_ASSERT (bar_symbol_string_size == (sizeof (SYMBOL_DESCIPTION_BAR) - 1));

  jerry_string_to_char_buffer (bar_symbol_string, str_buff, bar_symbol_string_size);
  TEST_ASSERT (memcmp (str_buff, STRING_BAR, sizeof (SYMBOL_DESCIPTION_BAR) - 1) == 0);

  jerry_release_value (bar_symbol_string);
  jerry_release_value (bar_symbol);

  /* Test symbol get description operation with undefined description */
  jerry_value_t undefined_value = jerry_create_undefined ();
  jerry_value_t undefined_symbol = jerry_create_symbol (undefined_value);
  jerry_release_value (undefined_value);
  TEST_ASSERT (!jerry_value_is_error (bar_symbol));
  TEST_ASSERT (jerry_value_is_symbol (bar_symbol));

  undefined_value = jerry_get_symbol_description (undefined_symbol);
  TEST_ASSERT (jerry_value_is_undefined (undefined_value));
  jerry_release_value (undefined_value);
  jerry_release_value (undefined_symbol);

  /* Test symbol to string operation with non-symbol argument */
  jerry_value_t null_value = jerry_create_null ();
  jerry_value_t to_string_value = jerry_get_symbol_descriptive_string (null_value);
  TEST_ASSERT (jerry_value_is_error (to_string_value));

  error_obj = jerry_get_value_from_error (to_string_value, true);

  TEST_ASSERT (jerry_get_error_type (error_obj) == JERRY_ERROR_TYPE);

  jerry_release_value (error_obj);
  jerry_release_value (null_value);

  const jerry_char_t obj_src[] = ""
                                 "({"
                                 "  [Symbol.asyncIterator]: 1,"
                                 "  [Symbol.hasInstance]: 2,"
                                 "  [Symbol.isConcatSpreadable]: 3,"
                                 "  [Symbol.iterator]: 4,"
                                 "  [Symbol.match]: 5,"
                                 "  [Symbol.replace]: 6,"
                                 "  [Symbol.search]: 7,"
                                 "  [Symbol.species]: 8,"
                                 "  [Symbol.split]: 9,"
                                 "  [Symbol.toPrimitive]: 10,"
                                 "  [Symbol.toStringTag]: 11,"
                                 "  [Symbol.unscopables]: 12,"
                                 "  [Symbol.matchAll]: 13,"
                                 "})";

  const char *symbols[] = {
    "asyncIterator", "hasInstance", "isConcatSpreadable", "iterator",    "match",       "replace",  "search",
    "species",       "split",       "toPrimitive",        "toStringTag", "unscopables", "matchAll",
  };

  jerry_value_t obj = jerry_eval (obj_src, sizeof (obj_src) - 1, JERRY_PARSE_NO_OPTS);
  TEST_ASSERT (jerry_value_is_object (obj));

  jerry_value_t global_obj = jerry_get_global_object ();
  jerry_value_t symbol_str = jerry_create_string ((const jerry_char_t *) "Symbol");
  jerry_value_t builtin_symbol = jerry_get_property (global_obj, symbol_str);
  TEST_ASSERT (jerry_value_is_object (builtin_symbol));

  double expected = 1.0;
  uint32_t prop_index = 0;

  for (jerry_well_known_symbol_t id = JERRY_SYMBOL_ASYNC_ITERATOR; id <= JERRY_SYMBOL_MATCH_ALL;
       id++, expected++, prop_index++)
  {
    jerry_value_t well_known_symbol = jerry_get_well_known_symbol (id);

    jerry_value_t prop_str = jerry_create_string ((const jerry_char_t *) symbols[prop_index]);
    jerry_value_t current_global_symbol = jerry_get_property (builtin_symbol, prop_str);
    jerry_release_value (prop_str);

    jerry_value_t relation =
      jerry_binary_operation (JERRY_BIN_OP_STRICT_EQUAL, well_known_symbol, current_global_symbol);

    TEST_ASSERT (jerry_value_is_boolean (relation) && jerry_value_is_true (relation));

    jerry_release_value (relation);

    jerry_value_t prop_result_wn = jerry_get_property (obj, well_known_symbol);
    jerry_value_t prop_result_global = jerry_get_property (obj, current_global_symbol);

    TEST_ASSERT (jerry_value_is_number (prop_result_wn));
    double number_wn = jerry_get_number_value (prop_result_wn);
    TEST_ASSERT (number_wn == expected);

    TEST_ASSERT (jerry_value_is_number (prop_result_global));
    double number_global = jerry_get_number_value (prop_result_global);
    TEST_ASSERT (number_global == expected);

    jerry_release_value (prop_result_global);
    jerry_release_value (prop_result_wn);
    jerry_release_value (current_global_symbol);
    jerry_release_value (well_known_symbol);
  }

  jerry_release_value (builtin_symbol);

  /* Deletion of the 'Symbol' builtin makes the well-known symbols unaccessible from JS context
     but the symbols still can be obtained via 'jerry_get_well_known_symbol' */
  const jerry_char_t deleter_src[] = "delete Symbol";

  jerry_value_t deleter = jerry_eval (deleter_src, sizeof (deleter_src) - 1, JERRY_PARSE_NO_OPTS);
  TEST_ASSERT (jerry_value_is_boolean (deleter) && jerry_value_is_true (deleter));
  jerry_release_value (deleter);

  builtin_symbol = jerry_get_property (global_obj, symbol_str);
  TEST_ASSERT (jerry_value_is_undefined (builtin_symbol));
  jerry_release_value (builtin_symbol);

  expected = 1.0;
  prop_index = 0;

  for (jerry_well_known_symbol_t id = JERRY_SYMBOL_ASYNC_ITERATOR; id <= JERRY_SYMBOL_MATCH_ALL;
       id++, expected++, prop_index++)
  {
    jerry_value_t well_known_symbol = jerry_get_well_known_symbol (id);
    jerry_value_t prop_result_wn = jerry_get_property (obj, well_known_symbol);

    TEST_ASSERT (jerry_value_is_number (prop_result_wn));
    double number_wn = jerry_get_number_value (prop_result_wn);
    TEST_ASSERT (number_wn == expected);

    jerry_release_value (prop_result_wn);
    jerry_release_value (well_known_symbol);
  }

  jerry_well_known_symbol_t invalid_symbol = (jerry_well_known_symbol_t) (JERRY_SYMBOL_MATCH_ALL + 1);
  jerry_value_t invalid_well_known_symbol = jerry_get_well_known_symbol (invalid_symbol);
  TEST_ASSERT (jerry_value_is_undefined (invalid_well_known_symbol));
  jerry_release_value (invalid_well_known_symbol);

  invalid_symbol = (jerry_well_known_symbol_t) (JERRY_SYMBOL_ASYNC_ITERATOR - 1);
  invalid_well_known_symbol = jerry_get_well_known_symbol (invalid_symbol);
  TEST_ASSERT (jerry_value_is_undefined (invalid_well_known_symbol));
  jerry_release_value (invalid_well_known_symbol);

  jerry_release_value (symbol_str);
  jerry_release_value (global_obj);
  jerry_release_value (obj);

  jerry_cleanup ();

  return 0;
} /* main */