Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create behavior reference for Lifecycle for Edge Network extension #649

Merged

Conversation

timkimadobe
Copy link
Contributor

@timkimadobe timkimadobe commented Jul 19, 2024

Description

This PR creates a new Lifecycle for Edge Network reference doc that explains in depth the different lifecycle event flows and pitfalls commonly seen when implementing Lifecycle for Edge Network.

It is similar to the Lifecycle behavior reference created in #568, but for Lifecycle for Edge Network's specific behavior.

  • Similar diagram intents etc as explained in linked PR

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@timkimadobe timkimadobe requested a review from calebk1 July 19, 2024 01:01
class E incorrectBox;
-->

## Expected Lifecycle scenarios
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd suggest to swap the ordering of this section with the previous "Consecutive Lifecycle API Calls" so the expected scenarios are listed first.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you! I think that organization makes more sense - swapped their positions


This scenario shows the standard Lifecycle workflow, with expected Lifecycle API calls.

![](./assets/index/lifecycle-app-launch-and-close.svg)
Copy link
Contributor

Choose a reason for hiding this comment

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

In this image lifecycle-app-launch-and-close.svg, can you include "(Close type close)" under "Application Close (Background)", similar to how you have "(Close type unknown)" in the lifecycle-crash.svg image?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated! I also added a colon to help emphasize that close and unknown are values of Close type


As a consequence of this shift in not relying on a session timeout window to consider new sessions, the potential Lifecycle states are greatly simplified:

### Consecutive Lifecycle API calls
Copy link
Contributor

@cacheung cacheung Jul 26, 2024

Choose a reason for hiding this comment

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

The heading size here is confusing.
Is Consecutive Lifecycle API calls under General behavior?

Why it is
"##"
"####"
"###"?

For
"As a consequence of this shift in not relying on a session timeout window to consider new sessions, the potential Lifecycle states are greatly simplified:"
Is it part of Data payloads? I can't tell by reading with the headings.

@cacheung
Copy link
Contributor

I wonder if there is a way to identify between the lifecycleStart or Pause was dispatched by result of an API and the lifecycleStart or Pause was dispatched by SDK due to other reasons. (may be different text color?)

Copy link
Contributor Author

@timkimadobe timkimadobe left a comment

Choose a reason for hiding this comment

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

Thanks for the reviews @cacheung and @kevinlind! Updated based on feedback - hopefully the organization and diagrams are more clear

class E incorrectBox;
-->

## Expected Lifecycle scenarios
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you! I think that organization makes more sense - swapped their positions


This scenario shows the standard Lifecycle workflow, with expected Lifecycle API calls.

![](./assets/index/lifecycle-app-launch-and-close.svg)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated! I also added a colon to help emphasize that close and unknown are values of Close type

Copy link
Contributor

@calebk1 calebk1 left a comment

Choose a reason for hiding this comment

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

LGTM!

@timkimadobe timkimadobe merged commit a20ea12 into AdobeDocs:main Aug 1, 2024
2 checks passed
@timkimadobe timkimadobe deleted the lifecycle-for-edge-behavior-reference branch August 1, 2024 22:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants