feat(docs): Event handling in JS #96
Open
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
added 2 commits
February 7, 2024 17:05
akim-bow
force-pushed
the
event-handling-in-js
branch
from
0adb2c6
to
30c5ae0
Compare
There was a problem hiding this comment.
i added some changes to the event-handling-edit repo in the https://github.com/fluencelabs/docs/blob/event-handling-edit/docs/build-mvm/tutorials/js_uses.md file.
please have a look. i think adding the code examples and instructions from what you already ave should be trivial.
i think we can drop the ipfs section for now from this JS chapter.
nivedano
reviewed
Feb 22, 2024
|
|
||
| Fluence Cloud Functions are hosted on distributed peers in the Fluence network waiting to be called. That is, your functions need to be triggered in order to do some work. Event triggers may arise from a multitude of sources ranging from browser click-events to changes in a database column. Regardless of the source, the event needs to trigger the function(s) which, as you already know from the introduction and quickstart chapters, requires Aqua to orchestrate the invocation of your distributed compute function(s). | ||
|
|
||
| One way of triggering the orchestration of your function(s) is interactively with the Fluence CLI: `fluence run -f 'your function(args)'`. However, events may require (near) real-time processing which in turn requires the orchestration of your function(s) immediately after the event occurred. Whether this is in the browser or some other application, we need to trigger the appropriate Aqua script from a (embedded) client peer. |
There was a problem hiding this comment.
Suggested change
| One way of triggering the orchestration of your function(s) is interactively with the Fluence CLI: `fluence run -f 'your function(args)'`. However, events may require (near) real-time processing which in turn requires the orchestration of your function(s) immediately after the event occurred. Whether this is in the browser or some other application, we need to trigger the appropriate Aqua script from a (embedded) client peer. | |
| One way of triggering the orchestration of your functions is interactively with the Fluence CLI: `fluence run -f 'your function(args)'`. However, events may require near real-time processing which in turn requires the orchestration of your functions immediately after the event occurred. Whether this is in the browser or some other application, we need to trigger the appropriate Aqua script from a embedded client peer. |
There was a problem hiding this comment.
I'd recommend not to use the excessive braces like that. There's no semantic advantages in hinting at alternatives (like singular/plural), or may even mislead, but extra syntactic elements get in the way when reading.
There was a problem hiding this comment.
Need to ask @boneyard93501 is there any specific meaning in these braces.
| ### Motivation | ||
| Imagine you've deployed your services to Fluence Network and now wondering how to interact with them, e.g., call Aqua function. | ||
|
|
||
| Let's forget about CLI for a minute because CLI relies on the described below event handling process. |
There was a problem hiding this comment.
Suggested change
| Let's forget about CLI for a minute because CLI relies on the described below event handling process. | |
| Let's forget about CLI for a minute, because CLI relies on the described below event handling process. |
| To interact with peers of Fluence network, i.e., to execute an Aqua functions, the "client" has to be a peer. | ||
| Such client peers don't have to be publicly accessible or long-running in nature, but they need to follow the protocol. | ||
|
|
||
| For this reason, Fluence provides thin and simple client peer for interacting with Fluence network - JS client. |
There was a problem hiding this comment.
Suggested change
| For this reason, Fluence provides thin and simple client peer for interacting with Fluence network - JS client. | |
| For this reason, Fluence provides thin and simple JS client peer for interacting with Fluence network. |
There was a problem hiding this comment.
Client peer could be JS or Python or could be written in any other language
|
|
||
| > Make sure you've read ***Getting Started*** and ***Quickstart*** pages. | ||
|
|
||
| Fluence Cloud Functions are hosted on distributed peers in the Fluence network waiting to be called. That is, your functions need to be triggered in order to do some work. Event triggers may arise from a multitude of sources ranging from browser click-events to changes in a database column. Regardless of the source, the event needs to trigger the function(s) which, as you already know from the introduction and quickstart chapters, requires Aqua to orchestrate the invocation of your distributed compute function(s). |
There was a problem hiding this comment.
Suggested change
| Fluence Cloud Functions are hosted on distributed peers in the Fluence network waiting to be called. That is, your functions need to be triggered in order to do some work. Event triggers may arise from a multitude of sources ranging from browser click-events to changes in a database column. Regardless of the source, the event needs to trigger the function(s) which, as you already know from the introduction and quickstart chapters, requires Aqua to orchestrate the invocation of your distributed compute function(s). | |
| Fluence Cloud Functions are hosted on distributed peers in the Fluence Network waiting to be called. That is, your functions need to be triggered in order to do some work. Event triggers may arise from a multitude of sources ranging from browser click-events to changes in a database column. Regardless of the source, the event needs to trigger the functions which, as you already know from the introduction and quickstart chapters, requires Aqua to orchestrate the invocation of your distributed compute functions. |
docs/build-mvm/tutorials/event-handling-in-js/1-event-handling.md
Outdated
Show resolved
Hide resolved
Co-authored-by: nivedano <26411464+nivedano@users.noreply.github.com>
Co-authored-by: nivedano <26411464+nivedano@users.noreply.github.com>
|
|
||
| > Make sure you've read ***Getting Started*** and ***Quickstart*** pages. | ||
|
|
||
| Fluence Cloud Functions are hosted on distributed peers in the Fluence network waiting to be called. That is, your functions need to be triggered in order to do some work. Event triggers may arise from a multitude of sources ranging from browser click-events to changes in a database column. Regardless of the source, the event needs to trigger the function(s) which, as you already know from the introduction and quickstart chapters, requires Aqua to orchestrate the invocation of your distributed compute function(s). |
There was a problem hiding this comment.
terminology is outdated and needs to be updated through out. see https://github.com/fluencelabs/docs/tree/res-32-glossary.
also, for denver all we need is the concept piece not the tutorial. there is no need and no capacity.
There was a problem hiding this comment.
This is too broad comment
- Which part are you considering tutorial? Exchanging events between clients paragraph?
- Where exactly does glossary not match?
I would like to see more details from you.
There was a problem hiding this comment.
You also have kind of events-in-js doc in main branch already and it makes me confused.
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.
Notes for reviewer:
advanced-ipfsexample doesn't belong here. Agree. I think we can keep the file for some time without actually including it to the doc. If we will create additional section e.g. advanced tutorials, i will put the doc there.