OeditusCredo.Check.Warning.UnmanagedTask
(OeditusCredo v0.6.0)
View Source
Basics
This check is disabled by default.
Learn how to enable it via .credo.exs.
This check has a base priority of high and works with any version of Elixir.
Explanation
Use Task.Supervisor for spawning tasks to prevent memory leaks.
Unmanaged tasks can cause memory leaks if they crash or never complete.
Bad:
Task.async(fn -> do_work() end)
Task.start(fn -> background_job() end)Good:
Task.Supervisor.async_nolink(MyApp.TaskSupervisor, fn -> do_work() end)
Task.Supervisor.start_child(MyApp.TaskSupervisor, fn -> background_job() end)Check-Specific Parameters
Use the following parameters to configure this check:
:exclude_test_files
Set to true to skip test files (default: false)
This parameter defaults to nil.
General Parameters
Like with all checks, general params can be applied.
Parameters can be configured via the .credo.exs config file.