Fix bug in handling actions returned from handle_tick. Deprecate handle_spec_started. #708
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This reverts commit 168f57e.
FelonEkonom
force-pushed
the
fix-handling-actions-bug
branch
from
0380d86 to
3630ef2
Compare
FelonEkonom
force-pushed
the
fix-handling-actions-bug
branch
from
3630ef2 to
0e40638
Compare
FelonEkonom
force-pushed
the
fix-handling-actions-bug
branch
from
927285a to
990172b
Compare
FelonEkonom
force-pushed
the
fix-handling-actions-bug
branch
from
4ec86bf to
47e97c9
Compare
mat-hek
requested changes
Feb 8, 2024
Comment on lines
40
to
43
| Membrane.Logger.warning(""" | ||
| Action :spec was returned from handle_spec_started/3 callback. It is suggested not to do this, | ||
| because it might lead to infinite loof of handle_spec_started/3 executions. | ||
| """) |
There was a problem hiding this comment.
I'd not make this a warning, as this may be a valid situation as well.
|
|
||
| @impl CallbackHandler | ||
| def handle_end_of_actions(state) do | ||
| ChildLifeController.trigger_specs(state) |
There was a problem hiding this comment.
This may be problematic, as we one can do [spec: child(:foo, Foo), notify_child: {:foo, :ping}]. I think we should only delay the callback execution.
| @@ -191,6 +192,9 @@ defmodule Membrane.Core.CallbackHandler do | |||
| was_handling_action? = state.handling_action? | |||
| state = %{state | handling_action?: true} | |||
|
|
|||
| was_supplying_demand? = Map.get(state, :supplying_demand?, false) | |||
There was a problem hiding this comment.
let's add a comment that it's a temporary fix
There was a problem hiding this comment.
FelonEkonom
changed the title
mat-hek
reviewed
Feb 13, 2024
lib/membrane/bin.ex
Outdated
Comment on lines
315
to
316
| require Membrane.Core.Parent | ||
| Membrane.Core.Parent.bring_after_compile_check() |
There was a problem hiding this comment.
Suggested change
| require Membrane.Core.Parent | |
| Membrane.Core.Parent.bring_after_compile_check() | |
| @after_compile {Membrane.Core.Parent, :check_for_deprecated_callbacks} |
lib/membrane/core/parent.ex
Outdated
Comment on lines
6
to
27
| defmacro bring_after_compile_check() do | ||
| quote do | ||
| @after_compile {__MODULE__, :__membrane_check_deprecated_functions__} | ||
|
|
||
| @spec __membrane_check_deprecated_functions__(Macro.Env.t(), binary) :: :ok | ||
| def __membrane_check_deprecated_functions__(env, _bytecode) do | ||
| modules_whitelist = [Membrane.Testing.Pipeline] | ||
|
|
||
| if env.module not in modules_whitelist and | ||
| Module.defines?(env.module, {:handle_spec_started, 3}, :def) do | ||
| warn_message = """ | ||
| Callback handle_spec_started/3 has been deprecated since \ | ||
| :membrane_core v1.0.1, but it is implemented in #{inspect(env.module)} | ||
| """ | ||
|
|
||
| IO.warn(warn_message, []) | ||
| end | ||
|
|
||
| :ok | ||
| end | ||
| end | ||
| end |
There was a problem hiding this comment.
Suggested change
| defmacro bring_after_compile_check() do | |
| quote do | |
| @after_compile {__MODULE__, :__membrane_check_deprecated_functions__} | |
| @spec __membrane_check_deprecated_functions__(Macro.Env.t(), binary) :: :ok | |
| def __membrane_check_deprecated_functions__(env, _bytecode) do | |
| modules_whitelist = [Membrane.Testing.Pipeline] | |
| if env.module not in modules_whitelist and | |
| Module.defines?(env.module, {:handle_spec_started, 3}, :def) do | |
| warn_message = """ | |
| Callback handle_spec_started/3 has been deprecated since \ | |
| :membrane_core v1.0.1, but it is implemented in #{inspect(env.module)} | |
| """ | |
| IO.warn(warn_message, []) | |
| end | |
| :ok | |
| end | |
| end | |
| end | |
| def check_for_deprecated_callbacks(env, _bytecode) do | |
| modules_whitelist = [Membrane.Testing.Pipeline] | |
| if env.module not in modules_whitelist and | |
| Module.defines?(env.module, {:handle_spec_started, 3}, :def) do | |
| warn_message = """ | |
| Callback handle_spec_started/3 has been deprecated since \ | |
| :membrane_core v1.0.1, but it is implemented in #{inspect(env.module)} | |
| """ | |
| IO.warn(warn_message, []) | |
| end | |
| :ok | |
| end |
lib/membrane/pipeline.ex
Outdated
| @@ -204,9 +204,11 @@ defmodule Membrane.Pipeline do | |||
| ) :: {[Action.common_actions()], state()} | |||
|
|
|||
| @doc """ | |||
| This callback is deprecated since v1.0.1. | |||
There was a problem hiding this comment.
If we deprecate the callback, I'd go for releasing the current master as v1.0.1 and release this as v1.1.0-rc0 with auto flow queues
mat-hek
approved these changes
Feb 14, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #695
Closes #752
Relates to #753