Adding support of transient federates #2213

ChadliaJerad · 2024-02-20T21:38:07Z

This PR replaces #1695.
The companion PR in reactor-c is lf-lang/reactor-c#358.

It implements the transient feature in the federation execution. Details of the implementation are documented in Discussion #2212.

…t attribute

…ut the coordination and the target

edwardalee

Looks great! The tests are quite nice. I wonder whether they will prove flaky, since there is always a risk of the launched federates taking an indeterminate amount of time to launch. Have you seen any flaky failures?

core/src/main/java/org/lflang/federated/launcher/FedLauncherGenerator.java

core/src/main/java/org/lflang/validation/LFValidator.java

test/C/src/federated/transient/TransientDownstreamWithTimer.lf

test/C/src/federated/transient/TransientDownstreamWithTwoUpstream.lf

test/C/src/federated/transient/TransientHotSwap.lf

edwardalee · 2024-02-21T23:15:12Z

test/C/src/federated/transient/TransientHotSwap.lf

+=}
+
+/** Persistent federate that is responsible for lauching the transient federate */
+reactor TransientExec(offset: time = 0, period: time = 0, fed_instance_name: char* = "instance") {


Same comment about offset and period. These seem identical across files. Wouldn't it be better to import them from just one file?

When TransientExec is imported, the execution fails with a segmentation fault when launching mid.
Having a char * as a parameter (fed_instance_name) when instantiating an imported federate causes this.
Any idea about how to fix this?

…nerator.java Co-authored-by: Edward A. Lee <[email protected]>

Co-authored-by: Edward A. Lee <[email protected]>

cmnrd

I have significant concerns about this approach, and I don't think that we should merge this lightheartedly without being clear about the benefits and the costs. See my comment in the discussion thread for an explanation.

test/C/src/federated/transient/TransientHotSwap.lf

…sts and reduce redundancy

… of launching time in transient federates. This is simply done by increasing the timeout to 3s instead of 2s, and adjusting the check accordingly

ChadliaJerad · 2024-02-22T09:58:42Z

Looks great! The tests are quite nice. I wonder whether they will prove flaky, since there is always a risk of the launched federates taking an indeterminate amount of time to launch. Have you seen any flaky failures?

I agree that there are chances of having the tests prove flaky... But I have not encountered such a case so far on my machine. As a proactive workaround, I increased the timeout in this commit 3503ee1.

…tor-c

coderabbitai · 2024-06-20T08:55:52Z

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

ChadliaJerad added 10 commits February 20, 2024 21:47

Add isTransient member to a federated instance and parse the transien…

b7104b4

…t attribute

Set the transient indicator

d01b2bf

Make federates bin directory visible

ccc6b6a

Add support of transient attribute

5d23ac0

Transient annotation is only allowed for federates + Leave fixmes abo…

d49a7ed

…ut the coordination and the target

Align reactor-c

4908b60

Add the number of transients option to the fderation launcher script

70ea192

Fix script identation

55e5413

Add transients tests

cf39668

Align reactor-c

b311402

ChadliaJerad changed the title ~~Adding support of transient federates #358~~ Adding support of transient federates Feb 20, 2024

ChadliaJerad mentioned this pull request Feb 20, 2024

Transient federates #1695

Closed

ChadliaJerad added c Related to C target federated feature New feature labels Feb 20, 2024

ChadliaJerad added 3 commits February 20, 2024 22:56

Apply spotless

bed73cf

Align reactor-c

41ba62a

Apply spotless

f45ae31

lhstrh requested a review from cmnrd February 21, 2024 00:32

Fix accidentally removed line from FederateInstance.java

e18eb02

edwardalee approved these changes Feb 21, 2024

View reviewed changes

ChadliaJerad and others added 2 commits February 22, 2024 09:22

Update core/src/main/java/org/lflang/federated/launcher/FedLauncherGe…

eb6fe81

…nerator.java Co-authored-by: Edward A. Lee <[email protected]>

Update test/C/src/federated/transient/TransientHotSwap.lf

3c6802d

Co-authored-by: Edward A. Lee <[email protected]>

cmnrd requested changes Feb 22, 2024

View reviewed changes

test/C/src/federated/transient/TransientHotSwap.lf Outdated Show resolved Hide resolved

ChadliaJerad added 3 commits February 22, 2024 10:44

Address review by removing FIXMEs and open an issue instead

0989e72

Address review by removing period from TransientExec in transients te…

1bc4a6c

…sts and reduce redundancy

Reduce the probability of flaky failiures due to indeterminate amount…

3503ee1

… of launching time in transient federates. This is simply done by increasing the timeout to 3s instead of 2s, and adjusting the check accordingly

ChadliaJerad added 2 commits February 22, 2024 11:12

Fix TransientHotSwap documentation based on review

c7e1bef

Apply spotless

8b8920c

ChadliaJerad added 18 commits March 19, 2024 00:05

Minor updates to transient tests

6610247

Align reactor-c (transient-fed-use-pqueue)

316a809

Merge branch 'master' into transient-fed

9c5725f

Merge branch 'master' into transient-fed

aa94f96

Align reactor-c

7466603

Align reactor-c

e482e49

Merge branch 'master' into transient-fed

84a075c

Add authentication to TransientDownstreamWithTimer.lf test

9a53f26

Merge branch 'master' into transient-fed

56a2be1

TransientHotSwap test uses authentication + Align reactorC

c8f8315

Align reator-c

ba63421

Merge branch 'master' into transient-fed

5083f35

Merge branch 'master' into transient-fed

a6be23d

Fix the usage of authentication is transient tests

928067b

Align reactor-c

b72bfe1

Merge branch 'master' into transient-fed

43b7008

Align reactor-c

142930a

Include LF_FEDERATES_BIN_DIRECTORY is cmake for federaes + Align reac…

855fffa

…tor-c

ChadliaJerad added 11 commits June 21, 2024 08:37

Merge branch 'master' into transient-fed

e0b595e

Merge branch 'master' into transient-fed

49b79cf

Merge branch 'master' into transient-fed

b10515e

Merge branch 'master' into transient-fed

da29219

Merge branch 'master' into transient-fed

d49fba3

Merge branch 'master' into transient-fed

d0ee79f

Merge branch 'master' into transient-fed

970855d

Align reactor-c

917d259

Merge branch 'master' into transient-fed

918cd80

Merge branch 'master' into transient-fed

1a5a35d

Merge branch 'master' into transient-fed

fc6c4e3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding support of transient federates #2213

Adding support of transient federates #2213

ChadliaJerad commented Feb 20, 2024

edwardalee left a comment

edwardalee Feb 21, 2024

ChadliaJerad Feb 22, 2024

cmnrd left a comment

ChadliaJerad commented Feb 22, 2024

coderabbitai bot commented Jun 20, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

Adding support of transient federates #2213

Are you sure you want to change the base?

Adding support of transient federates #2213

Conversation

ChadliaJerad commented Feb 20, 2024

edwardalee left a comment

Choose a reason for hiding this comment

edwardalee Feb 21, 2024

Choose a reason for hiding this comment

ChadliaJerad Feb 22, 2024

Choose a reason for hiding this comment

cmnrd left a comment

Choose a reason for hiding this comment

ChadliaJerad commented Feb 22, 2024

coderabbitai bot commented Jun 20, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

CodeRabbit Configration File (`.coderabbit.yaml`)