Lifecycle 2.0 with new design #376

kevinshahfws · 2025-03-11T20:39:58Z

No description provided.

alkalinecoffee · 2025-03-12T15:06:06Z

src/openrpc/discovery.json

+			"name": "getNavigationIntent",
+			"tags": [
+				{
+					"name": "property:immutable"


is property:immutable necessary? Could it just be left off and treated as a basic getter?

The response can change so immutable might not be appropriate--I'd expect that to be used on truly immutable properties like a serial number.

I added the immutable because there won't be any setter or event for this method.. Yes, I can change that

alkalinecoffee · 2025-03-12T16:47:43Z

src/openrpc/lifecycle.json

+			],
+			"summary": "Listen to the start event",
+			"params": [
+        {


the spacing here is off

jlacivita · 2025-03-20T13:47:12Z

src/schemas/intents.json

+          {
+              "action": "preload",
+              "context": {
+                  "source": "voice"


Minor detail, but "voice" is an odd example of a preload intent source. we have a value of "other" that is probably more appropriate for this use case.

jlacivita · 2025-03-20T13:50:32Z

src/openrpc/lifecycle.json

+    ],
+    "components": {
+        "schemas": {
+            "LifecycleEvent": {


This schema can go away. None of the Lifecycle events have parameters now, except for onDestroy.
We don't tell the app the "previous" and current state, because the event names are unique depending on where you came from.

jlacivita · 2025-03-20T13:51:13Z

src/openrpc/lifecycle.json

+                "description": "An object describing state of destroy with reason, and previous state",
+                "type": "object",
+                "required": [
+                    "reason",


We don't want previous here either.

jlacivita · 2025-03-20T13:53:38Z

src/openrpc/lifecycle.json

+                }
+            ],
+            "summary": "Listen to the destroy event \n\nHowever, this event is unreliable and app may not get this notification in the event of platform needs to kill the app quickly",
+            "params": [


Notifiers don't have a "listen" param, that's for the subscriber, onDestroy.
The parameter here should be the destroy reason.

jlacivita · 2025-03-20T13:54:05Z

src/openrpc/lifecycle.json

+                    }
+                }
+            ],
+            "result": {


Notifiers have no result, you should remove it entirely, which is in fact how OpenRPC knows it's a notification, not a method

jlacivita · 2025-03-20T13:57:48Z

src/openrpc/lifecycle.json

+            "summary": "Listen to the start event",
+            "params": [
+                {
+                    "name": "listen",


notifiers don't have a listen param, they just have the event payload(s). These events all have no payloads except for destroy

jlacivita · 2025-03-20T13:58:28Z

src/openrpc/lifecycle.json

+            "result": {
+                "name": "value",
+                "schema": {
+                    "$ref": "#/components/schemas/LifecycleEvent"


Notifiers have no result, that's how OpenRPC knows that they're notifiers and not methods. You should remove the result from all of the notifiers.

alkalinecoffee · 2025-05-14T15:02:28Z

src/schemas/intents.json

      ]
    },
+    "PreLoadIntent": {
+      "description": "A Firebolt compliant representation of a user intention to pre-load an app.",


We can probably remove the 'user intention' part as a user wouldn't be responsible for pre-loading an app.

jlacivita · 2025-05-14T15:35:25Z

src/openrpc/lifecycle.json

+                    ]
+                },
+                {
+                    "name": "exclude-from-sdk"


We need this to be in the C++ SDK, so I don't think this tag is correct, unless we want to say C++ includes all APIs even with this tag.

I was imagining something more like a list of capabilities to exclude from each language, somewhere inside the sdk.config.json, e.g.:

{ "languages": { "javascript": { "excludeModules": [ "Lifecycle" ] } } }

Yea @kevinshahfws let's sync up on how resolve this and come up with a quick solution.

We'll probably need more granular, API-specific configs (e.g. the W3C media caps API should be excluded from the JS SDK, but the other MC APIs should still be there).

jlacivita · 2025-05-14T15:38:54Z

src/openrpc/lifecycle.json

+                {
+                    "name": "Default Example",
+                    "params": [],
+                    "result": {


notifiers have no results.

jlacivita · 2025-05-14T15:39:37Z

src/openrpc/lifecycle.json

+                    "name": "Default Example",
+                    "params": [],
+                    "result": {
+                        "name": "Default Result",


notifiers have no result. Does this pass validation via firebolt-openrpc? If so we should fix that.

jlacivita · 2025-05-14T15:40:05Z

src/openrpc/lifecycle.json

+                    "name": "Default Example",
+                    "params": [],
+                    "result": {
+                        "name": "Default Result",


notifiers have no results.

jlacivita · 2025-05-14T15:40:21Z

src/openrpc/lifecycle.json

+                    "name": "Default Example",
+                    "params": [],
+                    "result": {
+                        "name": "Default Result",


jlacivita · 2025-05-14T15:42:24Z

src/openrpc/lifecycle.json

+                {
+                    "name": "Default Example",
+                    "params": [],
+                    "result": {


jlacivita · 2025-05-14T15:42:49Z

src/openrpc/lifecycle.json

+                        }
+                    ],
+                    "result": {
+                        "name": "Default Result",


jlacivita · 2025-05-14T15:43:09Z

src/schemas/intents.json

      ]
    },
+    "PreLoadIntent": {
+      "description": "A Firebolt compliant representation of a user intention to pre-load an app.",


jlacivita · 2025-05-14T15:44:31Z

src/sdks/core/src/js/sdk/Lifecycle/defaults.mjs

 export default {
  ready: function() {
-    inactive.previous = 'initializing'
+    paused.previous = 'initializing'


we need to remove all of these xxx.previous = lines from this class, as it's not part of the schema anymore.

actually, this entire class can go away, as we don't have the module in JS any longer.

Not sure if that's a separate PR?

jlacivita · 2025-05-14T15:46:29Z

src/sdks/core/src/js/sdk/Lifecycle/index.mjs

-    throw 'Cannot call finished() except when in the unloading transition'
-  }
-}
+// function finished() {


we can get rid of this entire class, too, but not sure what your plan is for turning off Lifecycle in JS.

If you're keeping it around temporarily, why did you only drop finished?

kevinshahfws added 2 commits March 11, 2025 16:39

Lifecycle 2.0 with new design

cb2a5f1

Lifecycle 2.0 with new design with bidirectional tags

2a833c9

kevinshahfws requested review from alkalinecoffee and jlacivita March 12, 2025 14:58

alkalinecoffee reviewed Mar 12, 2025

View reviewed changes

src/openrpc/lifecycle.json Outdated

],

"summary": "Listen to the start event",

"params": [

{

Copy link

Contributor

alkalinecoffee Mar 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the spacing here is off

alkalinecoffee approved these changes Mar 12, 2025

View reviewed changes

Corrected spacing issue

7635700

jlacivita suggested changes Mar 20, 2025

View reviewed changes

kevinshahfws added 5 commits March 20, 2025 11:49

Addressed review comments

8a4b55c

Addressed review comments

40fc0a7

Resolved conflicts

29c584b

Resolved conflicts

cd8d407

Resolved conflicts

6f986c8

alkalinecoffee reviewed May 14, 2025

View reviewed changes

jlacivita suggested changes May 14, 2025

View reviewed changes

kevinshahfws added 5 commits May 16, 2025 11:35

Addressed review comments

27c3d63

Updated ci node version

0ca9bcc

Updated ci node version

493d8dc

Resolved conflicts

2b3ce80

Resolved conflicts

02dd8a1

Lifecycle 2.0 with new design #376

Are you sure you want to change the base?

Lifecycle 2.0 with new design #376

Uh oh!

Conversation

kevinshahfws commented Mar 11, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alkalinecoffee May 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

alkalinecoffee May 14, 2025 •

edited

Loading