Support on_problems=Problem_Behavior.Report_Warning and Map_Error wrapping in Vector.map (#8595)

Implements `Warnings.get_all wrap_errors=True` which wraps warnings attached to values inside vectors with `Map_Error`, which includes the position of the value within the vector. See [the documentation](https://github.com/enso-org/enso/blob/develop/docs/semantics/wrapped-errors.md) for more details.

`get_all wrap_errors=True` does not change the warnings that are attached to values -- it wraps them before returning them to the caller, but does not change the original warnings attached to the values.

Wrapped warnings only appear attached to the vector itself. The values inside the vector do not have their warnings wrapped.

Warning propagation is not changed at all; `Warnings.get_all` (with default `wrap_errors=False`) behaves as before. `get_all wrap_errors=True` is meant to be used primarily by the IDE, although it can be used anywhere this wrapping is desired.

Author: GregoryTravis

CHANGELOG.md

@@ -599,6 +599,7 @@
 - [Support for loading big Excel files.][8403]
 - [Added new `Filter_Condition`s - `Equal_Ignore_Case`, `Is_Nan`, `Is_Infinite`
   and `Is_Finite`.][8539]
+- [Support `on_problems=Problem_Behavior.Report_Warning` in `Vector.map`.][8595]
 - [Added text_length to Column][8606]
 - [Added none delimiter option for Data.Read][8627]
 - [Added text_left and text_right to Column][8691]
@@ -861,6 +862,7 @@
 [8403]: https://github.com/enso-org/enso/pull/8403
 [8539]: https://github.com/enso-org/enso/pull/8539
 [8564]: https://github.com/enso-org/enso/pull/8564
+[8595]: https://github.com/enso-org/enso/pull/8595
 [8606]: https://github.com/enso-org/enso/pull/8606
 [8627]: https://github.com/enso-org/enso/pull/8627
 [8691]: https://github.com/enso-org/enso/pull/8691

distribution/lib/Standard/Base/0.0.0-dev/src/Data/Statistics.enso

@@ -154,7 +154,7 @@ type Statistic
        - statistics: Set of statistics to calculate.
     compute_bulk : Vector -> Vector Statistic -> Vector Any
     compute_bulk data statistics=[Statistic.Count, Statistic.Sum] =
-        moment_order = statistics.map on_problems=No_Wrap.Value .order
+        moment_order = statistics.map on_problems=No_Wrap .order
         has_min_max = statistics.any (s-> s == Statistic.Minimum || s == Statistic.Maximum)
         max_moment_order = moment_order.filter (v-> v != Nothing) . fold 0 .max
         counter = data.fold (Accumulator.new has_min_max max_moment_order) current-> value-> compute_fold current value
@@ -165,7 +165,7 @@ type Statistic
             Error.throw (Illegal_Argument.Error ("Can only compute " + stat.to_text + " on numerical data sets."))
 
         if max_moment_order > 0 && counter.moments.is_nothing then report_error statistics else
-            statistics.map on_problems=No_Wrap.Value statistic-> case statistic of
+            statistics.map on_problems=No_Wrap statistic-> case statistic of
                 Statistic.Covariance series -> check_if_empty counter.count <| calculate_correlation_statistics data series . covariance
                 Statistic.Pearson series -> check_if_empty counter.count <| calculate_correlation_statistics data series . pearsonCorrelation
                 Statistic.R_Squared series -> check_if_empty counter.count <| calculate_correlation_statistics data series . rSquared
@@ -198,7 +198,7 @@ type Statistic
             _ -> False
 
         if statistics.any is_unsupported then Error.throw (Illegal_Argument.Error ("Unsupported Statistics ( " + (statistics.filter is_unsupported . to_text) ") for running calculations.")) else
-            moment_order = statistics.map on_problems=No_Wrap.Value .order
+            moment_order = statistics.map on_problems=No_Wrap .order
             has_min_max = statistics.any (s-> s == Statistic.Minimum || s == Statistic.Maximum)
             max_moment_order = moment_order.filter (v-> v != Nothing) . fold 0 .max
 
@@ -209,7 +209,7 @@ type Statistic
                 data.fold counter current->value->
                     result = compute_fold current value
 
-                    row = Panic.throw_wrapped_if_error <| statistics.map on_problems=No_Wrap.Value s-> case s of
+                    row = Panic.throw_wrapped_if_error <| statistics.map on_problems=No_Wrap s-> case s of
                         Statistic.Maximum -> if result.count == 0 then Nothing else result.maximum
                         Statistic.Minimum -> if result.count == 0 then Nothing else result.minimum
                         _ -> result.compute s

distribution/lib/Standard/Base/0.0.0-dev/src/Data/Vector.enso

@@ -1354,11 +1354,17 @@ type Builder
         Vector.from_polyglot_array self.java_builder.toArray
 
 ## PRIVATE
-   Describes an error produced by a function mapped over a Vector. Includes the
-   function argument's position in the vector.
+   Describes an error attached to a value within a `Vector`. The `index` field
+   contains the index into the `Vector` at which the error occurred.
+
+   If a value is nested within multiple `Vector`s, its warnings are wrapped
+   with `Map_Error` multiple times. The outermost `Map_Error` index indicates
+   the index into the outermost `Vector`, the second `Map_Error` index the index
+   into the sub-`Vector` within the outermost `Vector`, and so on.
 
    An error that is wrapped as a `Map_Error` can be caught as a `Map_Error`, or
    as itself. In the latter case, the `Map_Error` wrapper is stripped off.
+@Builtin_Type
 type Map_Error
     ## PRIVATE
        Creates a new `Map_Error` from the given index and underlying error.
@@ -1371,8 +1377,6 @@ type Map_Error
 ## PRIVATE
    Indicates that a method should not wrap thrown errors in `Map_Error`.
 type No_Wrap
-    ## PRIVATE
-    Value
 
 ## PRIVATE
 Wrapped_Error.from (that : Map_Error) = Wrapped_Error.Value that that.inner_error

distribution/lib/Standard/Base/0.0.0-dev/src/Error.enso

@@ -142,21 +142,13 @@ type Error
                         Maybe.Some inner_error -> handler inner_error
 
     ## PRIVATE
-       Convert a wrapped error to a Wrapped_Error. If the argument is not a
-       wrapped error, Nothing is returned.
-    as_wrapped_error : Any -> Wrapped_Error | Nothing
-    as_wrapped_error error_value =
-        Panic.catch No_Such_Conversion (Wrapped_Error.from error_value) _->Nothing
-
-    ## PRIVATE
-       Determines if this is the specified error wrapper, and, if so, returns
-       the inner error. This only unwraps once.
-    unwrap_error : Any -> Any -> Maybe Any
-    unwrap_error wrapper_error_type error_value =
-        case Error.as_wrapped_error error_value of
-            Wrapped_Error.Value wrapping_error inner_error ->
-                if wrapping_error.is_a wrapper_error_type then Maybe.Some inner_error else Maybe.None
-            Nothing -> Maybe.None
+       Remove all wrapping errors, returning the inner error. If the argument is
+       not a wrapping error, it is returned unchanged.
+    unwrap : Any -> Any
+    unwrap error_value =
+        Panic.catch No_Such_Conversion handler=_->error_value <|
+            wrapped_error = Wrapped_Error.from error_value
+            @Tail_Call Error.unwrap wrapped_error.inner_error
 
     ## Transforms an error.
 

distribution/lib/Standard/Base/0.0.0-dev/src/Internal/Array_Like_Helpers.enso

@@ -66,35 +66,23 @@ vector_from_function_primitive length constructor = @Builtin_Method "Array_Like_
        ignored.
 vector_from_function : Integer -> (Integer -> Any) -> Problem_Behavior | No_Wrap -> Vector Any
 vector_from_function length function on_problems=Problem_Behavior.Report_Error =
-    if on_problems == Problem_Behavior.Report_Warning then
-        Unimplemented.throw "on_problems=Problem_Behavior.Report_Warning is unimplemented for `Vector.map`"
     num_errors = Ref.new 0
     wrapped_function i =
         result = function i
-        case result.is_error of
-            False ->
-                ## TODO: implement this correctly.
-                   See https://github.com/enso-org/enso/issues/8371
-
-                    if Warning.has_warnings result . not then result else
-                        Warning.map_attached_warnings (w-> Maybe.Some (Map_Error.Error i w)) result
-                result
-            True ->
-                case on_problems of
-                    Problem_Behavior.Ignore ->
-                        Nothing
-                    Problem_Behavior.Report_Error ->
+        if result.is_error.not then result else
+            case on_problems of
+                Problem_Behavior.Ignore ->
+                    Nothing
+                Problem_Behavior.Report_Error ->
+                    result.catch_primitive caught->
+                        Error.throw (Map_Error.Error i caught)
+                No_Wrap -> result
+                Problem_Behavior.Report_Warning ->
+                    with_error_maybe = if num_errors.get >= MAX_MAP_WARNINGS then Nothing else
                         result.catch_primitive caught->
-                            Error.throw (Map_Error.Error i caught)
-                    No_Wrap.Value -> result
-                    ## TODO: implement this correctly.
-                       See https://github.com/enso-org/enso/issues/8371
-                        Problem_Behavior.Report_Warning ->
-                            with_error_maybe = if num_errors.get >= MAX_MAP_WARNINGS then Nothing else
-                                result.catch_primitive caught->
-                                    Warning.attach (Map_Error.Error i caught) Nothing
-                            num_errors.modify (_+1)
-                            with_error_maybe
+                            Warning.attach caught Nothing
+                    num_errors.modify (_+1)
+                    with_error_maybe
     results = vector_from_function_primitive length wrapped_function
     if num_errors.get <= MAX_MAP_WARNINGS then results else
         err = Additional_Warnings.Error num_errors.get-MAX_MAP_WARNINGS

distribution/lib/Standard/Base/0.0.0-dev/src/Main.enso

@@ -49,7 +49,6 @@ import project.Data.Time.Period.Period
 import project.Data.Time.Time_Of_Day.Time_Of_Day
 import project.Data.Time.Time_Period.Time_Period
 import project.Data.Time.Time_Zone.Time_Zone
-import project.Data.Vector.Map_Error
 import project.Data.Vector.Vector
 import project.Data.XML.XML_Document
 import project.Data.XML.XML_Element
@@ -145,7 +144,6 @@ export project.Data.Time.Period.Period
 export project.Data.Time.Time_Of_Day.Time_Of_Day
 export project.Data.Time.Time_Period.Time_Period
 export project.Data.Time.Time_Zone.Time_Zone
-export project.Data.Vector.Map_Error
 export project.Data.Vector.Vector
 export project.Data.XML.XML_Document
 export project.Data.XML.XML_Element

distribution/lib/Standard/Base/0.0.0-dev/src/Network/HTTP.enso

@@ -120,7 +120,7 @@ type HTTP
                     boundary = body_publisher_and_boundary.second
                     boundary_header_list = if boundary.is_nothing then [] else [Header.multipart_form_data boundary]
                     all_headers = headers + boundary_header_list
-                    mapped_headers = all_headers.map on_problems=No_Wrap.Value .to_java_pair
+                    mapped_headers = all_headers.map on_problems=No_Wrap .to_java_pair
 
                     response = Response.Value (EnsoSecretHelper.makeRequest self.internal_http_client builder req.uri.to_java_representation mapped_headers)
                     if error_on_failure_code.not || response.code.is_success then response else
@@ -178,7 +178,7 @@ type HTTP
 ## PRIVATE
 parse_headers : Vector (Header | Pair Text Text) -> Vector Header
 parse_headers headers =
-    headers . map on_problems=No_Wrap.Value h-> case h of
+    headers . map on_problems=No_Wrap h-> case h of
         _ : Vector -> Header.new (h.at 0) (h.at 1)
         _ : Pair -> Header.new (h.at 0) (h.at 1)
         _ : Header -> h

distribution/lib/Standard/Base/0.0.0-dev/src/Warning.enso

@@ -4,6 +4,8 @@ import project.Data.Index_Sub_Range.Index_Sub_Range
 import project.Data.Maybe.Maybe
 import project.Data.Numbers.Integer
 import project.Data.Pair.Pair
+import project.Data.Set.Set
+import project.Data.Vector.Map_Error
 import project.Data.Vector.No_Wrap
 import project.Data.Vector.Vector
 import project.Error.Error
@@ -58,8 +60,13 @@ type Warning
        ADVANCED
        Gets all the warnings attached to the given value. Warnings are returned in the
        reverse-chronological order with respect to their attachment time.
-    get_all : Any -> Vector Warning
-    get_all value = Vector.from_polyglot_array (get_all_array value)
+
+       Arguments:
+       - value: The value to get the attached warnings of.
+       - wrap_errors: If true, warnings attached to elements in array-likes are
+         wrapped in Map_Error.
+    get_all : Any -> Boolean -> Vector Warning
+    get_all value wrap_errors:Boolean=False = Vector.from_polyglot_array (get_all_array value wrap_errors)
 
     ## PRIVATE
        ADVANCED
@@ -288,8 +295,8 @@ attach_with_stacktrace value warning origin = @Builtin_Method "Warning.attach_wi
 ## PRIVATE
 
    Builtin function that gets all the warnings attached to the given value.
-get_all_array : Any -> Array Warning
-get_all_array value = @Builtin_Method "Warning.get_all_array"
+get_all_array : Any -> Boolean -> Array Warning
+get_all_array value should_wrap = @Builtin_Method "Warning.get_all_array"
 
 ## PRIVATE
 
@@ -309,7 +316,7 @@ set_array value warnings = @Builtin_Method "Warning.set_array"
 map_attached_warnings_helper : (Any -> Maybe Any) -> Any -> Integer -> Any
 map_attached_warnings_helper mapper value frames_to_drop =
     warnings = Warning.get_all value
-    mapped_warnings = warnings.map on_problems=No_Wrap.Value warning->
+    mapped_warnings = warnings.map on_problems=No_Wrap warning->
         case mapper warning.value of
             Maybe.Some new_payload ->
                 self_call_name = "Warning.map_attached_warnings_helper"

distribution/lib/Standard/Database/0.0.0-dev/src/Data/Take_Drop_Helpers.enso

@@ -33,7 +33,7 @@ take_drop_helper take_drop table selector =
             row_column_name = table.make_temp_column_name
             table_with_row_number = table.add_row_number name=row_column_name from=0
 
-            subqueries = ranges.map on_problems=No_Wrap.Value range->
+            subqueries = ranges.map on_problems=No_Wrap range->
                 generate_subquery table_with_row_number row_column_name range
             combined = subqueries.reduce (a-> b-> a.union b)
             combined.remove_columns row_column_name

distribution/lib/Standard/Database/0.0.0-dev/src/Internal/IR/Context.enso

@@ -163,8 +163,8 @@ type Context
         rewrite_internal_column column =
             Internal_Column.Value column.name column.sql_type_reference (SQL_Expression.Column alias column.name)
 
-        new_columns = column_lists.map on_problems=No_Wrap.Value columns->
-            columns.map on_problems=No_Wrap.Value rewrite_internal_column
+        new_columns = column_lists.map on_problems=No_Wrap columns->
+            columns.map on_problems=No_Wrap rewrite_internal_column
 
         encapsulated_columns = column_lists.flat_map columns->
             columns.map column-> [column.name, column.expression]

distribution/lib/Standard/Database/0.0.0-dev/src/Internal/Upload_Table.enso

@@ -188,7 +188,7 @@ verify_structure_hint structure_hint column_names =
 resolve_primary_key structure primary_key = case primary_key of
     Nothing -> Nothing
     _ : Vector -> if primary_key.is_empty then Nothing else
-        validated = primary_key.map on_problems=No_Wrap.Value key->
+        validated = primary_key.map on_problems=No_Wrap key->
             if key.is_a Text then key else
                 Error.throw (Illegal_Argument.Error ("Primary key must be a vector of column names, instead got a " + (Meta.type_of key . to_display_text)))
         validated.if_not_error <|
@@ -303,7 +303,7 @@ first_column_name_in_structure structure = case structure of
 prepare_create_table_statement : Connection -> Text -> Vector Column_Description -> Vector Text -> Boolean -> Problem_Behavior -> SQL_Statement
 prepare_create_table_statement connection table_name columns primary_key temporary on_problems =
     type_mapping = connection.dialect.get_type_mapping
-    column_descriptors = columns.map on_problems=No_Wrap.Value def->
+    column_descriptors = columns.map on_problems=No_Wrap def->
         sql_type = type_mapping.value_type_to_sql def.value_type on_problems
         sql_type_text = type_mapping.sql_type_to_text sql_type
         Create_Column_Descriptor.Value def.name sql_type_text def.constraints
@@ -485,7 +485,7 @@ check_update_arguments_structure_match source_table target_table key_columns upd
                 if missing_target_key_columns.not_empty then Error.throw (Missing_Input_Columns.Error missing_target_key_columns.to_vector "the target table") else
                     if (update_action != Update_Action.Insert) && key_columns.is_empty then Error.throw (Illegal_Argument.Error "For the `update_action = "+update_action.to_text+"`, the `key_columns` must be specified to define how to match the records.") else
                         # Verify type matching
-                        problems = source_table.columns.flat_map on_problems=No_Wrap.Value check_source_column
+                        problems = source_table.columns.flat_map on_problems=No_Wrap check_source_column
                         problems.if_not_error <|
                             on_problems.attach_problems_before problems action
 

distribution/lib/Standard/Table/0.0.0-dev/src/Data/Column.enso

@@ -1919,7 +1919,7 @@ type Column
     map : (Any -> Any) -> Boolean -> Value_Type | Auto -> Column ! Invalid_Value_Type
     map self function skip_nothing=True expected_value_type=Auto =
         new_fn = if skip_nothing then (x-> if x.is_nothing then Nothing else function x) else function
-        new_st = self.to_vector.map on_problems=No_Wrap.Value new_fn
+        new_st = self.to_vector.map on_problems=No_Wrap new_fn
         Column.from_vector self.name new_st value_type=expected_value_type
 
     ## ALIAS combine, join by row position, merge
@@ -1967,7 +1967,7 @@ type Column
                             function x y
             False -> function
         new_name = naming_helper.binary_operation_name "x" self that
-        vec = self.to_vector.zip on_problems=No_Wrap.Value that.to_vector new_fn
+        vec = self.to_vector.zip on_problems=No_Wrap that.to_vector new_fn
         Column.from_vector new_name vec value_type=expected_value_type
 
     ## GROUP Standard.Base.Metadata

distribution/lib/Standard/Table/0.0.0-dev/src/Data/Data_Formatter.enso

@@ -125,7 +125,7 @@ type Data_Formatter
             vector = case formats of
                 v : Vector -> v
                 singleton -> [singleton]
-            converted = vector.map on_problems=No_Wrap.Value elem->
+            converted = vector.map on_problems=No_Wrap elem->
                 ## Ensure the element is a `Date_Time_Formatter` or is converted to it.
                    We need to convert _each_ element - we cannot perform a 'bulk' conversion like `vector : Vector Date_Time_Formatter` because of erasure.
                 checked = elem : Date_Time_Formatter
@@ -210,17 +210,17 @@ type Data_Formatter
     ## PRIVATE
     make_date_parser self = self.wrap_base_parser <|
         Panic.catch Java_Exception handler=(caught_panic-> Error.throw (Illegal_Argument.Error caught_panic.payload.getMessage)) <|
-            DateParser.new (self.date_formats.map on_problems=No_Wrap.Value .get_java_formatter_for_parsing)
+            DateParser.new (self.date_formats.map on_problems=No_Wrap .get_java_formatter_for_parsing)
 
     ## PRIVATE
     make_date_time_parser self = self.wrap_base_parser <|
         Panic.catch Java_Exception handler=(caught_panic-> Error.throw (Illegal_Argument.Error caught_panic.payload.getMessage)) <|
-            DateTimeParser.new (self.datetime_formats.map on_problems=No_Wrap.Value  .get_java_formatter_for_parsing)
+            DateTimeParser.new (self.datetime_formats.map on_problems=No_Wrap  .get_java_formatter_for_parsing)
 
     ## PRIVATE
     make_time_of_day_parser self = self.wrap_base_parser <|
         Panic.catch Java_Exception handler=(caught_panic-> Error.throw (Illegal_Argument.Error caught_panic.payload.getMessage)) <|
-            TimeOfDayParser.new (self.time_formats.map on_problems=No_Wrap.Value .get_java_formatter_for_parsing)
+            TimeOfDayParser.new (self.time_formats.map on_problems=No_Wrap .get_java_formatter_for_parsing)
 
     ## PRIVATE
     make_identity_parser self = self.wrap_base_parser IdentityParser.new