#373

Committed 25 Aug 2025 12:03PM UTC coverage: 46.341% (+0.9%) from 45.458%

Build # #373

Build Type

Pull #58

github

Committed by

GiuliaNardicchia

Commit Message

feat: update CLI and controller logic to return simulation state and improve output

Pull Request Pull Request #58: feat: command line interface and dsl simulation

Run Details

57 of 112 new or added lines in 13 files covered. (50.89%)

5 existing lines in 3 files now uncovered.

1178 of 2542 relevant lines covered (46.34%)

6.51 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/src/main/scala/io/github/srs/controller/ControllerModule.scala

package io.github.srs.controller

import scala.concurrent.duration.{ DurationInt, FiniteDuration, MILLISECONDS }
import scala.language.postfixOps

import cats.effect.std.Queue
import cats.effect.{ Clock, IO }
import cats.syntax.all.*
import io.github.srs.controller.message.RobotProposal
import io.github.srs.controller.protocol.Event
import io.github.srs.model.*
import io.github.srs.model.SimulationConfig.SimulationStatus.{ PAUSED, RUNNING, STOPPED }
import io.github.srs.model.UpdateLogic.*
import io.github.srs.model.entity.dynamicentity.Robot
import io.github.srs.model.entity.dynamicentity.sensor.Sensor.senseAll
import io.github.srs.model.logic.*
import io.github.srs.utils.SimulationDefaults.debugMode
import io.github.srs.utils.EqualityGivenInstances.given_CanEqual_Event_Event

/**
 * Module that defines the controller logic for the Scala Robotics Simulator.
 */
object ControllerModule:

  /**
   * Controller trait that defines the interface for the controller.
   *
   * @tparam S
   *   the type of the state, which must extend [[ModelModule.State]].
   */
  trait Controller[S <: ModelModule.State]:
    /**
     * Starts the controller with the initial state.
     *
     * @param initialState
     *   the initial state of the simulation.
     */
    def start(initialState: S): IO[S]

    /**
     * Runs the simulation loop, processing events from the queue and updating the state.
     *
     * @param s
     *   the current state of the simulation.
     * @param queue
     *   a concurrent queue that holds events to be processed.
     * @return
     *   an [[IO]] task that completes when the simulation loop ends.
     */
    def simulationLoop(s: S, queue: Queue[IO, Event]): IO[S]

  end Controller

  /**
   * Provider trait that defines the interface for providing a controller.
   *
   * @tparam S
   *   the type of the state, which must extend [[ModelModule.State]].
   */
  trait Provider[S <: ModelModule.State]:
    val controller: Controller[S]

  /**
   * Defines the dependencies required by the controller module. In particular, it requires a
   * [[io.github.srs.view.ViewModule.Provider]] and a [[io.github.srs.model.ModelModule.Provider]].
   */
  type Requirements[S <: ModelModule.State] =
    io.github.srs.view.ViewModule.Provider[S] & io.github.srs.model.ModelModule.Provider[S]

  /**
   * Component trait that defines the interface for creating a controller.
   *
   * @tparam S
   *   the type of the simulation state, which must extend [[ModelModule.State]].
   */
  trait Component[S <: ModelModule.State]:
    context: Requirements[S] =>

    object Controller:

      /**
       * Creates a controller instance.
       *
       * @return
       *   a [[Controller]] instance.
       */
      def apply()(using bundle: LogicsBundle[S]): Controller[S] = new ControllerImpl

      /**
       * Private controller implementation that delegates the simulation loop to the provided model and view.
       */
      private class ControllerImpl(using bundle: LogicsBundle[S]) extends Controller[S]:

        /**
         * Starts the controller with the initial state.
         * @param initialState
         *   the initial state of the simulation.
         * @return
         *   an [[IO]] task that completes when the controller is started.
         */
        override def start(initialState: S): IO[S] =
          for
            queueSim <- Queue.unbounded[IO, Event]
            _ <- context.view.init(queueSim)
            _ <- runBehavior(queueSim, initialState)
            result <- simulationLoop(initialState, queueSim)
          yield result

        /**
         * Runs the simulation loop, processing events from the queue and updating the state.
         * @param s
         *   the current state of the simulation.
         * @param queue
         *   a concurrent queue that holds events to be processed.
         * @return
         *   an [[IO]] task that completes when the simulation loop ends.
         */
        override def simulationLoop(s: S, queue: Queue[IO, Event]): IO[S] =
          def loop(state: S): IO[S] =
            for
              startTime <- Clock[IO].realTime.map(_.toMillis)
              _ <- runBehavior(queue, state).whenA(state.simulationStatus == RUNNING)
              events <- queue.tryTakeN(Some(50))
              newState <- handleEvents(state, events)
              _ <- context.view.render(newState)
              result <-
                if stopCondition(newState) then IO.pure(newState)
                else
                  for
                    nextState <- nextStep(newState, startTime)
                    endTime <- Clock[IO].realTime.map(_.toMillis)
                    _ <- if debugMode then IO.println(s"Simulation loop took ${endTime - startTime} ms") else IO.unit
                    res <- loop(nextState)
                  yield res
            yield result

          loop(s)

        end simulationLoop

        /**
         * Checks if the simulation should stop based on the current state.
         * @param state
         *   the current state of the simulation.
         * @return
         *   a boolean indicating whether the simulation should stop.
         */
        private def stopCondition(state: S): Boolean =
          state.simulationStatus == STOPPED ||
            elapsedTimeReached(state.simulationTime, state.elapsedTime)

        /**
         * Checks if the elapsed time has reached the maximum simulation time.
         * @param simulationTime
         *   the maximum simulation time, if defined.
         * @param elapsedTime
         *   the elapsed time since the simulation started.
         * @return
         *   a boolean indicating whether the elapsed time has reached the maximum simulation time.
         */
        private def elapsedTimeReached(simulationTime: Option[FiniteDuration], elapsedTime: FiniteDuration): Boolean =
          simulationTime.exists(max => elapsedTime >= max)

        /**
         * Processes the next step in the simulation based on the current state and start time.
         * @param state
         *   the current state of the simulation.
         * @param startTime
         *   the start time of the current simulation step in milliseconds.
         * @return
         *   the next state of the simulation wrapped in an [[IO]] task.
         */
        private def nextStep(state: S, startTime: Long): IO[S] =
          state.simulationStatus match
            case RUNNING =>
              tickEvents(startTime, state.simulationSpeed.tickSpeed, state)

            case PAUSED =>
              IO.sleep(50.millis).as(state)

            case STOPPED =>
              IO.pure(state)

        /**
         * Runs the behavior of all robots in the environment and collects their action proposals.
         * @param queue
         *   the queue to which the proposals will be offered through the [[Event.RobotActionProposals]] event.
         * @param state
         *   the current state of the simulation.
         * @return
         *   an [[IO]] task that completes when the behavior has been run.
         */
        private def runBehavior(queue: Queue[IO, Event], state: S): IO[Unit] =
          for
            proposals <- state.environment.entities.collect { case robot: Robot => robot }.toList.parTraverse { robot =>
              for
                sensorReadings <- robot.senseAll[IO](state.environment)
                action = robot.behavior.run(sensorReadings)
              yield RobotProposal(robot, action)
            }
            _ <- queue.offer(Event.RobotActionProposals(proposals))
          yield ()

        /**
         * Processes tick events, adjusting the tick speed based on the elapsed time since the last tick.
         * @param start
         *   the start time of the current tick in milliseconds.
         * @param tickSpeed
         *   the speed of the tick in [[FiniteDuration]].
         * @param state
         *   the current state of the simulation.
         * @return
         *   the next state of the simulation wrapped in an [[IO]] task.
         */
        private def tickEvents(start: Long, tickSpeed: FiniteDuration, state: S): IO[S] =
          for
            now <- Clock[IO].realTime.map(_.toMillis)
            timeToNextTick = tickSpeed.toMillis - (now - start)
            adjustedTickSpeed = if timeToNextTick > 0 then timeToNextTick else 0L
            sleepTime = FiniteDuration(adjustedTickSpeed, MILLISECONDS)
            _ <- IO.sleep(sleepTime)
            tick <- handleEvent(state, Event.Tick(tickSpeed))
          yield tick

        /**
         * Handles a sequence of events, processing them in the order they were received.
         * @param state
         *   the current state of the simulation.
         * @param events
         *   the sequence of events to be processed.
         * @return
         *   the final state of the simulation after processing all events, wrapped in an [[IO]] task.
         */
        private def handleEvents(state: S, events: Seq[Event]): IO[S] =
          for finalState <- events.foldLeft(IO.pure(state)) { (taskState, event) =>
              for
                currentState <- taskState
                newState <- handleEvent(currentState, event)
              yield newState
            }
          yield finalState

        /**
         * Handles a single event and updates the state accordingly.
         * @param state
         *   the current state of the simulation.
         * @param event
         *   the event to be processed.
         * @return
         *   the updated state of the simulation after processing the event, wrapped in an [[IO]] task.
         */
        private def handleEvent(state: S, event: Event): IO[S] =
          event match
            case Event.Tick(deltaTime) => context.model.tick(state, deltaTime)
            case Event.TickSpeed(speed) => context.model.tickSpeed(state, speed)
            case Event.Random(rng) => context.model.random(state, rng)
            case Event.Pause => context.model.pause(state)
            case Event.Resume => context.model.resume(state)
            case Event.Stop => context.model.stop(state)
            case Event.RobotActionProposals(proposals) => context.model.handleRobotActionsProposals(state, proposals)

      end ControllerImpl

    end Controller

  end Component

  /**
   * Interface trait that combines the provider and component traits for the controller module.
   *
   * @tparam S
   *   the type of the simulation state, which must extend [[ModelModule.State]].
   */
  trait Interface[S <: ModelModule.State] extends Provider[S] with Component[S]:
    self: Requirements[S] =>
end ControllerModule

1	package io.github.srs.controller
2
3	import scala.concurrent.duration.{ DurationInt, FiniteDuration, MILLISECONDS }
4	import scala.language.postfixOps
5
6	import cats.effect.std.Queue
7	import cats.effect.{ Clock, IO }
8	import cats.syntax.all.*
9	import io.github.srs.controller.message.RobotProposal
10	import io.github.srs.controller.protocol.Event
11	import io.github.srs.model.*
12	import io.github.srs.model.SimulationConfig.SimulationStatus.{ PAUSED, RUNNING, STOPPED }
13	import io.github.srs.model.UpdateLogic.*
14	import io.github.srs.model.entity.dynamicentity.Robot
15	import io.github.srs.model.entity.dynamicentity.sensor.Sensor.senseAll
16	import io.github.srs.model.logic.*
17	import io.github.srs.utils.SimulationDefaults.debugMode
18	import io.github.srs.utils.EqualityGivenInstances.given_CanEqual_Event_Event
19
20	/**
21	* Module that defines the controller logic for the Scala Robotics Simulator.
22	*/
23	object ControllerModule:
24		×
25	/**
26	* Controller trait that defines the interface for the controller.
27	*
28	* @tparam S
29	* the type of the state, which must extend [[ModelModule.State]].
30	*/
31	trait Controller[S <: ModelModule.State]:
32	/**	×
33	* Starts the controller with the initial state.
34	*
35	* @param initialState
36	* the initial state of the simulation.
37	*/
38	def start(initialState: S): IO[S]
39
40	/**
41	* Runs the simulation loop, processing events from the queue and updating the state.
42	*
43	* @param s
44	* the current state of the simulation.
45	* @param queue
46	* a concurrent queue that holds events to be processed.
47	* @return
48	* an [[IO]] task that completes when the simulation loop ends.
49	*/
50	def simulationLoop(s: S, queue: Queue[IO, Event]): IO[S]
51
52	end Controller
53
54	/**
55	* Provider trait that defines the interface for providing a controller.
56	*
57	* @tparam S
58	* the type of the state, which must extend [[ModelModule.State]].
59	*/
60	trait Provider[S <: ModelModule.State]:
61	val controller: Controller[S]
62
63	/**
64	* Defines the dependencies required by the controller module. In particular, it requires a
65	* [[io.github.srs.view.ViewModule.Provider]] and a [[io.github.srs.model.ModelModule.Provider]].
66	*/
67	type Requirements[S <: ModelModule.State] =
68	io.github.srs.view.ViewModule.Provider[S] & io.github.srs.model.ModelModule.Provider[S]
69
70	/**
71	* Component trait that defines the interface for creating a controller.
72	*
73	* @tparam S
74	* the type of the simulation state, which must extend [[ModelModule.State]].
75	*/
76	trait Component[S <: ModelModule.State]:
77	context: Requirements[S] =>	×
78
79	object Controller:
80		×
81	/**
82	* Creates a controller instance.
83	*
84	* @return
85	* a [[Controller]] instance.
86	*/
87	def apply()(using bundle: LogicsBundle[S]): Controller[S] = new ControllerImpl
88		×
89	/**
90	* Private controller implementation that delegates the simulation loop to the provided model and view.
91	*/
92	private class ControllerImpl(using bundle: LogicsBundle[S]) extends Controller[S]:
93		×
94	/**
95	* Starts the controller with the initial state.
96	* @param initialState
97	* the initial state of the simulation.
98	* @return
99	* an [[IO]] task that completes when the controller is started.
100	*/
101	override def start(initialState: S): IO[S] =
102	for	×
103	queueSim <- Queue.unbounded[IO, Event]	×
104	_ <- context.view.init(queueSim)	×
105	_ <- runBehavior(queueSim, initialState)
106	result <- simulationLoop(initialState, queueSim)
107	yield result
UNCOV 108		×
109	/**
110	* Runs the simulation loop, processing events from the queue and updating the state.
111	* @param s
112	* the current state of the simulation.
113	* @param queue
114	* a concurrent queue that holds events to be processed.
115	* @return
116	* an [[IO]] task that completes when the simulation loop ends.
117	*/
118	override def simulationLoop(s: S, queue: Queue[IO, Event]): IO[S] =
NEW 119	def loop(state: S): IO[S] =	×
120	for	×
121	startTime <- Clock[IO].realTime.map(_.toMillis)	×
122	_ <- runBehavior(queue, state).whenA(state.simulationStatus == RUNNING)	×
123	events <- queue.tryTakeN(Some(50))	×
124	newState <- handleEvents(state, events)
125	_ <- context.view.render(newState)
126	result <-
127	if stopCondition(newState) then IO.pure(newState)
128	else
129	for
130	nextState <- nextStep(newState, startTime)
131	endTime <- Clock[IO].realTime.map(_.toMillis)
132	_ <- if debugMode then IO.println(s"Simulation loop took ${endTime - startTime} ms") else IO.unit
133	res <- loop(nextState)
134	yield res
135	yield result
UNCOV 136		×
137	loop(s)
138		×
139	end simulationLoop
140
141	/**
142	* Checks if the simulation should stop based on the current state.
143	* @param state
144	* the current state of the simulation.
145	* @return
146	* a boolean indicating whether the simulation should stop.
147	*/
148	private def stopCondition(state: S): Boolean =
149	state.simulationStatus == STOPPED \|\|	×
150	elapsedTimeReached(state.simulationTime, state.elapsedTime)	×
151		×
152	/**
153	* Checks if the elapsed time has reached the maximum simulation time.
154	* @param simulationTime
155	* the maximum simulation time, if defined.
156	* @param elapsedTime
157	* the elapsed time since the simulation started.
158	* @return
159	* a boolean indicating whether the elapsed time has reached the maximum simulation time.
160	*/
161	private def elapsedTimeReached(simulationTime: Option[FiniteDuration], elapsedTime: FiniteDuration): Boolean =
162	simulationTime.exists(max => elapsedTime >= max)	×
163		×
164	/**
165	* Processes the next step in the simulation based on the current state and start time.
166	* @param state
167	* the current state of the simulation.
168	* @param startTime
169	* the start time of the current simulation step in milliseconds.
170	* @return
171	* the next state of the simulation wrapped in an [[IO]] task.
172	*/
173	private def nextStep(state: S, startTime: Long): IO[S] =
174	state.simulationStatus match	×
175	case RUNNING =>	×
176	tickEvents(startTime, state.simulationSpeed.tickSpeed, state)	×
177		×
178	case PAUSED =>
179	IO.sleep(50.millis).as(state)	×
180		×
181	case STOPPED =>
182	IO.pure(state)	×
183		×
184	/**
185	* Runs the behavior of all robots in the environment and collects their action proposals.
186	* @param queue
187	* the queue to which the proposals will be offered through the [[Event.RobotActionProposals]] event.
188	* @param state
189	* the current state of the simulation.
190	* @return
191	* an [[IO]] task that completes when the behavior has been run.
192	*/
193	private def runBehavior(queue: Queue[IO, Event], state: S): IO[Unit] =
194	for	×
195	proposals <- state.environment.entities.collect { case robot: Robot => robot }.toList.parTraverse { robot =>	×
196	for	×
197	sensorReadings <- robot.senseAll[IO](state.environment)
198	action = robot.behavior.run(sensorReadings)
199	yield RobotProposal(robot, action)
200	}
201	_ <- queue.offer(Event.RobotActionProposals(proposals))	×
202	yield ()
203		×
204	/**
205	* Processes tick events, adjusting the tick speed based on the elapsed time since the last tick.
206	* @param start
207	* the start time of the current tick in milliseconds.
208	* @param tickSpeed
209	* the speed of the tick in [[FiniteDuration]].
210	* @param state
211	* the current state of the simulation.
212	* @return
213	* the next state of the simulation wrapped in an [[IO]] task.
214	*/
215	private def tickEvents(start: Long, tickSpeed: FiniteDuration, state: S): IO[S] =
216	for	×
217	now <- Clock[IO].realTime.map(_.toMillis)	×
218	timeToNextTick = tickSpeed.toMillis - (now - start)	×
219	adjustedTickSpeed = if timeToNextTick > 0 then timeToNextTick else 0L
220	sleepTime = FiniteDuration(adjustedTickSpeed, MILLISECONDS)
221	_ <- IO.sleep(sleepTime)	×
222	tick <- handleEvent(state, Event.Tick(tickSpeed))
223	yield tick
224		×
225	/**
226	* Handles a sequence of events, processing them in the order they were received.
227	* @param state
228	* the current state of the simulation.
229	* @param events
230	* the sequence of events to be processed.
231	* @return
232	* the final state of the simulation after processing all events, wrapped in an [[IO]] task.
233	*/
234	private def handleEvents(state: S, events: Seq[Event]): IO[S] =
235	for finalState <- events.foldLeft(IO.pure(state)) { (taskState, event) =>	×
236	for	×
237	currentState <- taskState
238	newState <- handleEvent(currentState, event)
239	yield newState
240	}
241	yield finalState	×
242		×
243	/**
244	* Handles a single event and updates the state accordingly.
245	* @param state
246	* the current state of the simulation.
247	* @param event
248	* the event to be processed.
249	* @return
250	* the updated state of the simulation after processing the event, wrapped in an [[IO]] task.
251	*/
252	private def handleEvent(state: S, event: Event): IO[S] =
253	event match	×
254	case Event.Tick(deltaTime) => context.model.tick(state, deltaTime)	×
255	case Event.TickSpeed(speed) => context.model.tickSpeed(state, speed)	×
256	case Event.Random(rng) => context.model.random(state, rng)	×
257	case Event.Pause => context.model.pause(state)	×
258	case Event.Resume => context.model.resume(state)	×
259	case Event.Stop => context.model.stop(state)	×
260	case Event.RobotActionProposals(proposals) => context.model.handleRobotActionsProposals(state, proposals)	×
261		×
262	end ControllerImpl
263
264	end Controller
265
266	end Component
267
268	/**
269	* Interface trait that combines the provider and component traits for the controller module.
270	*
271	* @tparam S
272	* the type of the simulation state, which must extend [[ModelModule.State]].
273	*/
274	trait Interface[S <: ModelModule.State] extends Provider[S] with Component[S]:
275	self: Requirements[S] =>
276	end ControllerModule

Scala-Robotics-Simulator / PPS-22-srs / #373

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous