Add light intermediate_solution

Author: braktar

api/v01/entities/vrp_input.rb

@@ -125,6 +125,8 @@ module VrpInput
 module VrpConfiguration
   extend Grape::API::Helpers
 
+  INTERMEDIATE_SOLUTION_VALUES = [false, true, 'light'].freeze
+
   params :vrp_request_configuration do
     optional(:preprocessing, type: Hash, desc: 'Parameters independent from the search') do
       use :vrp_request_preprocessing
@@ -208,7 +210,7 @@ module VrpConfiguration
                         'Specifies the geometry structures to be returned. Can be a subset of `[polylines encoded_polylines partitions]` or a boolean value to output all or no geometry. Polylines and encoded_polylines are not compatible together.' :
                         'Specifies the geometry structures to be returned. Can be `partitions` to generate geometry structure for each partition or `true` for generating the geometry structure under each route.')
     optional(:geometry_polyline, type: Boolean, documentation: { hidden: true }, desc: '[DEPRECATED] Use geometry instead, with :polylines or :encoded_polylines')
-    optional(:intermediate_solutions, type: Boolean, desc: 'Return intermediate solutions if available')
+    optional(:intermediate_solutions, types: [String, Boolean], desc: 'Return intermediate solutions if available', coerce_with: ->(i) { INTERMEDIATE_SOLUTION_VALUES.include?(i)} )
     optional(:csv, type: Boolean, desc: 'The output is a CSV file if you do not specify api format')
     optional(:use_deprecated_csv_headers, type: Boolean, desc: 'Forces API to ignore provided language to return old CSV headers')
     optional(:allow_empty_result, type: Boolean, desc: 'Allow no solution from the solver used')

api/v01/entities/vrp_result.rb

@@ -55,24 +55,24 @@ class VRPResultDetailedCosts < Grape::Entity
     end
 
     class VrpResultSolutionRouteActivities < Grape::Entity
-      expose :day_week_num, expose_nil: false, documentation: { type: String, desc: '' }
-      expose :day_week, expose_nil: false, documentation: { type: String, desc: '' }
+      expose :day_week_num, expose_nil: false, documentation: { type: String, desc: '' }, if: lambda { |instance, options| options[:detailed_solutions] == true }
+      expose :day_week, expose_nil: false, documentation: { type: String, desc: '' }, if: lambda { |instance, options| options[:detailed_solutions] == true }
       expose :point_id, documentation: { type: String, desc: 'Linked spatial point' }
-      expose :travel_distance, documentation: { type: Integer, desc: 'Travel distance from previous point (in m)' }
-      expose :travel_time, documentation: { type: Integer, desc: 'Travel time from previous point (in s)' }
-      expose :travel_value, documentation: { type: Integer, desc: 'Travel value from previous point' }
-      expose :waiting_time, documentation: { type: Integer, desc: 'Idle time (in s)' }
-      expose :setup_time, documentation: { type: Integer, desc: 'Effective setup duration (in s)'}
-      expose :begin_time, documentation: { type: Integer, desc: 'Time visit starts' }
-      expose :end_time, documentation: { type: Integer, desc: 'Time visit ends' }
-      expose :departure_time, documentation: { type: Integer, desc: '' }
+      expose :travel_distance, documentation: { type: Integer, desc: 'Travel distance from previous point (in m)' }, if: lambda { |instance, options| options[:detailed_solutions] == true }
+      expose :travel_time, documentation: { type: Integer, desc: 'Travel time from previous point (in s)' }, if: lambda { |instance, options| options[:detailed_solutions] == true }
+      expose :travel_value, documentation: { type: Integer, desc: 'Travel value from previous point' }, if: lambda { |instance, options| options[:detailed_solutions] == true }
+      expose :waiting_time, documentation: { type: Integer, desc: 'Idle time (in s)' }, if: lambda { |instance, options| options[:detailed_solutions] == true }
+      expose :setup_time, documentation: { type: Integer, desc: 'Effective setup duration (in s)'}, if: lambda { |instance, options| options[:detailed_solutions] == true }
+      expose :begin_time, documentation: { type: Integer, desc: 'Time visit starts' }, if: lambda { |instance, options| options[:detailed_solutions] == true }
+      expose :end_time, documentation: { type: Integer, desc: 'Time visit ends' }, if: lambda { |instance, options| options[:detailed_solutions] == true }
+      expose :departure_time, documentation: { type: Integer, desc: '' }, if: lambda { |instance, options| options[:detailed_solutions] == true }
       expose :service_id, expose_nil: false, documentation: { type: String, desc: 'Internal reference of the service' }
       expose :pickup_shipment_id, expose_nil: false, documentation: { type: String, desc: 'Internal reference of the shipment' }
       expose :delivery_shipment_id, expose_nil: false, documentation: { type: String, desc: 'Internal reference of the shipment' }
       expose :rest_id, expose_nil: false, documentation: { type: String, desc: 'Internal reference of the rest' }
-      expose :detail, using: VrpResultSolutionRouteActivityDetails, documentation: { desc: '' }
+      expose :detail, using: VrpResultSolutionRouteActivityDetails, documentation: { desc: '' }, if: lambda { |instance, options| options[:detailed_solutions] == true }
       expose :type, documentation: { type: String, desc: 'depot, rest, service, pickup or delivery' }
-      expose :current_distance, documentation: { type: Integer, desc: 'Travel distance from route start to current point (in m)' }
+      expose :current_distance, documentation: { type: Integer, desc: 'Travel distance from route start to current point (in m)' }, if: lambda { |instance, options| options[:detailed_solutions] == true }
       expose :alternative, documentation: { type: Integer, desc: 'When one service has alternative activities, index of the chosen one' }
       expose :visit_index, documentation: { type: Integer, desc: 'Index of the visit' }
     end
@@ -89,8 +89,8 @@ class VrpResultSolutionRoute < Grape::Entity
       expose :total_waiting_time, documentation: { type: Integer, desc: 'Sum of every idle time within the route (in s)' }
       expose :start_time, documentation: { type: Integer, desc: 'Give the actual start time of the current route if provided by the solve' }
       expose :end_time, documentation: { type: Integer, desc: 'Give the actual end time of the current route if provided by the solver' }
-      expose :geometry, documentation: { type: String, desc: 'Contains the geometry of the route, if asked in first place' }
-      expose :initial_loads, using: VrpResultDetailQuantities, documentation: { is_array: true, desc: 'Give the actual initial loads of the route' }
+      expose :geometry, documentation: { type: String, desc: 'Contains the geometry of the route, if asked in first place' }, if: lambda { |instance, options| options[:detailed_solutions] == true }
+      expose :initial_loads, using: VrpResultDetailQuantities, documentation: { is_array: true, desc: 'Give the actual initial loads of the route' }, if: lambda { |instance, options| options[:detailed_solutions] == true }
       expose :cost_details, using: VRPResultDetailedCosts, documentation: { desc: 'The impact of the current route within the solution cost' }
     end
 
@@ -100,7 +100,7 @@ class VrpResultSolutionUnassigned < Grape::Entity
       expose :pickup_shipment_id, expose_nil: false, documentation: { type: String, desc: 'Internal reference of the shipment' }
       expose :delivery_shipment_id, expose_nil: false, documentation: { type: String, desc: 'Internal reference of the shipment' }
       expose :rest_id, expose_nil: false, documentation: { type: String, desc: 'Internal reference of the rest' }
-      expose :detail, using: VrpResultSolutionRouteActivityDetails, documentation: { desc: '' }
+      expose :detail, using: VrpResultSolutionRouteActivityDetails, documentation: { desc: '' }, if: lambda { |instance, options| options[:detailed_solutions] == true }
       expose :type, documentation: { type: String, desc: 'depot, rest, service, pickup or delivery' }
       expose :reason, documentation: { type: String, desc: 'Unassigned reason. Only available when activity was rejected within preprocessing fase or periodic first_solution_strategy.' }
     end

api/v01/vrp.rb

@@ -235,7 +235,7 @@ class Vrp < APIBase
                   graph: result_object[:graph]
                 },
                 geojsons: OutputHelper::Result.generate_geometry(result_object)
-              }, with: VrpResult)
+              }, with: VrpResult, detailed_solutions: job&.status&.to_sym == :completed || result_object.dig(:configuration, :intermediate_solutions))
             end
             # set nil to release memory because puma keeps the grape api endpoint object alive
             stored_result = nil # rubocop:disable Lint/UselessAssignment

models/solution/parsers/solution_parser.rb

@@ -34,6 +34,7 @@ def self.parse(solution, vrp, options = {})
       compute_result_total_dimensions_and_round_route_stats(solution)
       solution.configuration.geometry = vrp.configuration.restitution.geometry
       solution.configuration.schedule_start_date = vrp.configuration.schedule&.start_date
+      solution.configuration.detailed_solutions = vrp.configuration.restitution.intermediate_solutions
 
       log "solution - unassigned rate: #{solution.unassigned_stops.size} of (ser: #{vrp.visits} " \
           "(#{(solution.unassigned_stops.size.to_f / vrp.visits * 100).round(1)}%)"

models/solution/solution_configuration.rb

@@ -24,13 +24,15 @@ class Configuration < Base
       field :geometry, default: false
       field :deprecated_headers, default: false
       field :schedule_start_date
+      field :detailed_solutions, default: true
 
       def +(other)
         Configuration.create(
           csv: csv || other.csv,
           geometry: (geometry + other.geometry).uniq,
           deprecated_headers: deprecated_headers || other.deprecated_headers,
-          schedule_start_date: schedule_start_date
+          schedule_start_date: schedule_start_date,
+          detailed_solutions: detailed_solutions
         )
       end
     end

test/api/v01/with_solver_test.rb

@@ -39,6 +39,34 @@ def test_deleted_job
     delete_completed_job @job_id, api_key: 'ortools' if @job_id
   end
 
+  def test_light_intemediate_solution
+    # using ORtools to make sure that optimization takes enough time to be cut before ending
+    asynchronously start_worker: true do
+      vrp = VRP.lat_lon.deep_merge!({ configuration: { restitution: { intermediate_solutions: 'light' }}})
+
+      @job_id = submit_vrp api_key: 'ortools', vrp: vrp
+      response = wait_avancement_match @job_id, /run optimization, iterations [0-9]+/, api_key: 'ortools'
+      refute_empty response['solutions'].to_a, "Solution is missing from the response body: #{response}"
+
+      response['solutions'].to_a.each{ |solution|
+        solution['routes'].each{ |route|
+          route['activities'].each{ |activity|
+            refute_nil activity['point_id']
+            refute_nil activity['type']
+            refute_nil activity['service_id'] if activity['type'] == 'service'
+            assert_nil activity['travel_time']
+            assert_nil activity['travel_distance']
+            assert_nil activity['detail']
+          }
+        }
+      }
+
+      response = delete_job @job_id, api_key: 'ortools'
+      refute_empty response['solutions'].to_a, "Solution is missing from the response body: #{response}"
+    end
+    delete_completed_job @job_id, api_key: 'ortools' if @job_id
+  end
+
   def test_using_two_solver
     asynchronously start_worker: true do
       problem = VRP.lat_lon