Updating guide - parent/children communication and childrenspecs #474

varsill · 2022-11-15T09:31:28Z

Describe changes concerning:

Membrane.Time functions
parent/children communication
childrenspecs

…nspecs

mat-hek · 2022-11-16T12:04:59Z

guides/upgrading/v0.11.md

+Change the signature of:
+* `Membrane.Bin.handle_element_start_of_stream/3` into `Membrane.Bin.handle_element_start_of_stream/4`
+* `Membrane.Bin.handle_element_end_of_stream/3` into `Membrane.Bin.handle_element_end_of_stream/4`
+* `Membrane.Pipeline.handle_element_start_of_stream/3` into `Membrane.Pipeline.handle_element_start_of_stream/4`
+* `Membrane.Pipeline.handle_element_end_of_stream/3` into `Membrane.Pipeline.handle_element_end_of_stream/4`


Suggested change

Change the signature of:

* `Membrane.Bin.handle_element_start_of_stream/3` into `Membrane.Bin.handle_element_start_of_stream/4`

* `Membrane.Bin.handle_element_end_of_stream/3` into `Membrane.Bin.handle_element_end_of_stream/4`

* `Membrane.Pipeline.handle_element_start_of_stream/3` into `Membrane.Pipeline.handle_element_start_of_stream/4`

* `Membrane.Pipeline.handle_element_end_of_stream/3` into `Membrane.Pipeline.handle_element_end_of_stream/4`

I'd remove that, I think that explanation below and the example is enough

indeed, done

mat-hek · 2022-11-16T12:05:41Z

guides/upgrading/v0.11.md

+```
+
+
+## Update the signatures of `handle_element_start_of_stream` and `handle_element_end_of_stream`


Since these are callbacks, I'd move them to the callbacks section, just mention that this applies to pipelines and bins only

mat-hek · 2022-11-16T12:06:12Z

guides/upgrading/v0.11.md

+ def handle_element_end_of_stream(child_name, pad_ref, context, state)
+```
+
+## Update functions used for children <-> parent communication


let's move that to callbacks and actions, respectively

mat-hek · 2022-11-16T12:06:42Z

guides/upgrading/v0.11.md

+
+## Update the children definitions
+Children defintions syntax (previously known as `ParentSpec`, after the name of a structure used to define children), that was used in `Membrane.Pipeline.Action.spec_t` and `Membrane.Bin.Action.spec_t` actions, has changed.
+Since there are quite a few changed concerning children definition, we have decided to present them in the subsections below.


Suggested change

Since there are quite a few changed concerning children definition, we have decided to present them in the subsections below.

Since there are quite a few changes concerning children definition, we have decided to present them in the subsections below.

mat-hek · 2022-11-16T12:10:26Z

guides/upgrading/v0.11.md

+ children = [child(:source, SomeSource), child(:filter, SomeFilter)]
+ links = [get_child(:source) |> child(:another_filter, SomeFilter) |> get_child(:filter) |> child(:sink, SomeSink)]


Suggested change

+ children = [child(:source, SomeSource), child(:filter, SomeFilter)]

+ links = [get_child(:source) |> child(:another_filter, SomeFilter) |> get_child(:filter) |> child(:sink, SomeSink)]

+ structure = [

+ child(:source, SomeSource),

+ child(:filter, SomeFilter),

+ get_child(:source) |> child(:another_filter, SomeFilter) |> get_child(:filter) |> child(:sink, SomeSink)

+ ]

mat-hek · 2022-11-16T12:11:17Z

guides/upgrading/v0.11.md

+children = ...
+links = ...
+ structure = children ++ links


Suggested change

children = ...

links = ...

+ structure = children ++ links

mat-hek · 2022-11-16T12:12:06Z

guides/upgrading/v0.11.md

+### Update the crash group definition
+Crash groups has become inextricably connected with a new concept - `children groups`. The name of a crash group is now the name of a children group.
+Update the following:
+* remove the `crash_group: {crash_group_name, crash_group_mode}` option from the specification options 
+* add the `children_group_id` option to the specification options, with the value being the name of the former crash group: `children_group_id: crash_group_name`
+* add the `crash_group_mode` option to the specification options, with the value being the mode of the former crash group: `crash_group_mode: crash_group_mode`
+
+```diff
+- options = [crash_group: {:first, :temporary}]
+ options = [children_group_id: :first, crash_group_mode: :temporary]
+```


I think we decided to move that to 1.0

indeed, I've removed that

mat-hek · 2022-11-16T12:13:23Z

guides/upgrading/v0.11.md

+ children = [child(:source, SomeSource), child(:filter, SomeFilter)]
+ links = [get_child(:source) |> child(:another_filter, SomeFilter) |> get_child(:filter) |> child(:sink, SomeSink)]
+ spec = {children ++ links, children_group_id: :first_group, crash_group_mode: :temporary, node: another_node}


As above, I would encourage creating both children and links in the same list

… sections

guides/upgrading/v0.11.md

Co-authored-by: Feliks Pobiedziński <38541925+FelonEkonom@users.noreply.github.com>

…on_and_children_spec

…e_core into updating_guide/children_parent_communication_and_children_spec

…the n-ary function specification

…play and the changes in options of the testing pipeline

…en_spec' of https://github.com/membraneframework/membrane_core into updating_guide/children_parent_communication_and_children_spec

* upgrade guide improvements * upgrade guide: reorder callbacks * upgrade guide: add bin_input and bin_output * add makeup_diff to color diffs in docs * update guide: put return values before callbacks * updating guide: resolve conflicts * Update guides/upgrading/v0.11.md Co-authored-by: Łukasz Kita <lukasz.kita0@gmail.com> Co-authored-by: Łukasz Kita <lukasz.kita0@gmail.com>

…on_and_children_spec

* Describe changes concerning parent/children communication and childrenspecs * Move the actions and callbacks changes description to the appropriate sections * Update guides/upgrading/v0.11.md Co-authored-by: Feliks Pobiedziński <38541925+FelonEkonom@users.noreply.github.com> * Remove backtips from the function links which do not exists. Improve the n-ary function specification * Add information about import Membrane.ChildrenSpec * fix upgrade guide markdown syntax * Add missing information about changes - handle_info, assert_pipeline_play and the changes in options of the testing pipeline * Remove missusages of handle_other * Update v0.11.md * Updating guide: refactor (#480) * upgrade guide improvements * upgrade guide: reorder callbacks * upgrade guide: add bin_input and bin_output * add makeup_diff to color diffs in docs * update guide: put return values before callbacks * updating guide: resolve conflicts * Update guides/upgrading/v0.11.md Co-authored-by: Łukasz Kita <lukasz.kita0@gmail.com> Co-authored-by: Łukasz Kita <lukasz.kita0@gmail.com> Co-authored-by: Feliks Pobiedziński <38541925+FelonEkonom@users.noreply.github.com> Co-authored-by: Mateusz Front <mateusz.front@swmansion.com> Co-authored-by: Karol Konkol <56369082+Karolk99@users.noreply.github.com>

Describe changes concerning parent/children communication and childre…

0c83e43

…nspecs

varsill added the no-changelog This label has to be added if changes from the PR are not meant to be placed in the CHANGELOG.md label Nov 15, 2022

varsill marked this pull request as ready for review November 15, 2022 09:38

varsill requested a review from mat-hek as a code owner November 15, 2022 09:39

mat-hek requested changes Nov 16, 2022

View reviewed changes

Move the actions and callbacks changes description to the appropriate…

e355c11

… sections

varsill requested a review from mat-hek November 16, 2022 14:00

FelonEkonom reviewed Nov 16, 2022

View reviewed changes

guides/upgrading/v0.11.md Outdated Show resolved Hide resolved

varsill and others added 11 commits November 17, 2022 10:13

Update guides/upgrading/v0.11.md

c298e7b

Co-authored-by: Feliks Pobiedziński <38541925+FelonEkonom@users.noreply.github.com>

Merge branch 'master' into updating_guide/children_parent_communicati…

37758dc

…on_and_children_spec

Merge branch 'master' into updating_guide/children_parent_communicati…

9260dc5

…on_and_children_spec

Merge branch 'master' of https://github.com/membraneframework/membran…

f2f2746

…e_core into updating_guide/children_parent_communication_and_children_spec

Remove backtips from the function links which do not exists. Improve …

5172784

…the n-ary function specification

Add information about import Membrane.ChildrenSpec

0181d93

fix upgrade guide markdown syntax

579544a

Add missing information about changes - handle_info, assert_pipeline_…

7a9d495

…play and the changes in options of the testing pipeline

Remove missusages of handle_other

bf3ee2e

Merge branch 'updating_guide/children_parent_communication_and_childr…

14554c0

…en_spec' of https://github.com/membraneframework/membrane_core into updating_guide/children_parent_communication_and_children_spec

Update v0.11.md

6c49f78

mat-hek force-pushed the updating_guide/children_parent_communication_and_children_spec branch 2 times, most recently from e734266 to 6c49f78 Compare November 18, 2022 14:07

mat-hek and others added 2 commits November 21, 2022 10:41

Merge branch 'master' into updating_guide/children_parent_communicati…

f97e73d

…on_and_children_spec

mat-hek approved these changes Nov 21, 2022

View reviewed changes

mat-hek merged commit 8995c4c into master Nov 21, 2022

mat-hek deleted the updating_guide/children_parent_communication_and_children_spec branch November 21, 2022 09:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updating guide - parent/children communication and childrenspecs #474

Updating guide - parent/children communication and childrenspecs #474

varsill commented Nov 15, 2022 •

edited

Loading

mat-hek Nov 16, 2022

varsill Nov 16, 2022

mat-hek Nov 16, 2022

varsill Nov 16, 2022

mat-hek Nov 16, 2022

varsill Nov 16, 2022

mat-hek Nov 16, 2022

varsill Nov 16, 2022

mat-hek Nov 16, 2022

varsill Nov 16, 2022

mat-hek Nov 16, 2022

varsill Nov 16, 2022

mat-hek Nov 16, 2022

varsill Nov 16, 2022

mat-hek Nov 16, 2022

varsill Nov 16, 2022

		```


		## Update the signatures of `handle_element_start_of_stream` and `handle_element_end_of_stream`

	Since there are quite a few changed concerning children definition, we have decided to present them in the subsections below.
	Since there are quite a few changes concerning children definition, we have decided to present them in the subsections below.

		+ children = [child(:source, SomeSource), child(:filter, SomeFilter)]
		+ links = [get_child(:source) \|> child(:another_filter, SomeFilter) \|> get_child(:filter) \|> child(:sink, SomeSink)]

Updating guide - parent/children communication and childrenspecs #474

Updating guide - parent/children communication and childrenspecs #474

Conversation

varsill commented Nov 15, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

varsill commented Nov 15, 2022 •

edited

Loading