Improvements for Web Components #1444

marschall · 2024-10-13T15:20:00Z

Improvements that allow applications with Web Components to run with a lower overhead.

Save only a single action continuation. Since the back button does not work with Web Components in general we only need to save a single action continuation. This should keep sessions smaller.
Dedicated action continuation. Since the back button does not work with Web Components in general we can make use of an optimized action continuation that:
- does not redirect.
- does not capture state.
- does not restore state.

In theory these classes could be used in general for "back button less" Seaside applications. However this is quite an advanced topic so I think it's ok to "burry" these in the WebComponents package. Let me know what you think.

Improvements that allow applications with Web Components to run with a lower overhead.

codecov · 2024-10-13T15:23:11Z

Codecov Report

Attention: Patch coverage is 75.70093% with 26 lines in your changes missing coverage. Please review.

Project coverage is 50.03%. Comparing base (0f7d6f7) to head (f6be4f2).

Files with missing lines	Patch %	Lines
...age/WASingleElementCache.class/instance/remove..st	0.00%	5 Missing ⚠️
...nContinuation.class/instance/basicPerformAction.st	0.00%	4 Missing ⚠️
...onentActionContinuation.class/instance/continue.st	0.00%	4 Missing ⚠️
...nSession.class/instance/createContinuationCache.st	0.00%	3 Missing ⚠️
...ActionContinuation.class/instance/jumpToAnchor..st	0.00%	3 Missing ⚠️
...tActionContinuation.class/instance/restoreState.st	0.00%	3 Missing ⚠️
...ctionContinuation.class/instance/shouldRedirect.st	0.00%	3 Missing ⚠️
...tsLibrary.class/instance/seasideWebComponentsJs.st	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1444      +/-   ##
==========================================
+ Coverage   49.42%   50.03%   +0.61%     
==========================================
  Files        9073     8946     -127     
  Lines       80086    79229     -857     
==========================================
+ Hits        39582    39645      +63     
+ Misses      40504    39584     -920

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

adriaon · 2024-10-17T14:35:25Z

Is there a typo or two in https://github.com/marschall/Seaside/blob/master/repository/Seaside-WebComponents-Core.package/WAHeadlessComponent.class/README.md ?

Also, I wouldn't mind if the classes that are useful for SPA's are not buried, but more generally available. Perhaps in a SPA package?

marschall · 2024-10-18T15:33:37Z

Is there a typo or two in https://github.com/marschall/Seaside/blob/master/repository/Seaside-WebComponents-Core.package/WAHeadlessComponent.class/README.md ?

Probably a rendering issue by GitHub. Check out the raw content

https://raw.githubusercontent.com/marschall/Seaside/refs/heads/master/repository/Seaside-WebComponents-Core.package/WAHeadlessComponent.class/README.md

Also, I wouldn't mind if the classes that are useful for SPA's are not buried, but more generally available. Perhaps in a SPA package?

What classes would you be interested in? WAWebComponentActionContinuation? Do you have a suggestion for a name?

Perhaps in a SPA package?

Maybe, but only if we have more than one class to go there.

adriaon · 2024-10-18T16:43:27Z

https://raw.githubusercontent.com/marschall/Seaside/refs/heads/master/repository/Seaside-WebComponents-Core.package/WAHeadlessComponent.class/README.md

Got it. Thanks

What classes would you be interested in? WAWebComponentActionContinuation? Do you have a suggestion for a name?

Perhaps in a SPA package?

Maybe, but only if we have more than one class to go there.

If I understand things correctly, i see

WAWebComponentActionContinuation
WASingleElementCache
WASingleContinuationSession

as candidates.

Maybe something like Seaside-SingleContinuation-Core as a name? Or maybe rename Seaside-WebComponents-Core as such?

Cheers,
Adriaan.

jbrichau

Looks good to me. Thanks for this!
I made a couple of code style suggestions in the detail comments.

I was first expecting a "single continuation session" to always reuse the same continuation, like what happens with ajax requests. I do a similar thing in WATurboRenderPhaseContinuation. However, I now realise that because the webcomponent re-renders its entire fragment, it's better to throw away the old rendercontext and indeed create an entire new continuation.

...ory/Seaside-Tests-WebComponents.package/WASingleElementCacheTest.class/instance/testClear.st

...easide-Tests-WebComponents.package/WASingleElementCacheTest.class/instance/testKeyAtValue.st

...e-Tests-WebComponents.package/WASingleElementCacheTest.class/instance/testKeysAndValuesDo.st

...tory/Seaside-Tests-WebComponents.package/WASingleElementCacheTest.class/instance/testSize.st

...ory/Seaside-Tests-WebComponents.package/WASingleElementCacheTest.class/instance/testStore.st

jbrichau · 2024-10-19T11:50:22Z

...itory/Seaside-WebComponents-Core.package/WASingleElementCache.class/instance/at.ifAbsent..st

+at: aKey ifAbsent: aBlock
+	^ key = aKey
+		ifTrue: [ value ]
+		ifFalse: [ aBlock value ]


Suggested change

ifFalse: [ aBlock value ]

ifFalse: aBlock

If I do this I get a code critic warning in Pharo

ifTrue: ifFalse: ifTrue:ifFalse: ifFalse:ifTrue: is used in a way that it can not be optimized.

jbrichau · 2024-10-19T11:51:12Z

...aside-WebComponents-Core.package/WASingleElementCache.class/instance/keyAtValue.ifAbsent..st

+keyAtValue: anObject ifAbsent: aBlock
+	^ value = anObject
+		ifTrue: [ key ]
+		ifFalse: [ aBlock value ]


Suggested change

ifFalse: [ aBlock value ]

ifFalse: aBlock

Some Pharo code critic warning if I do this.

jbrichau · 2024-10-19T12:59:17Z

...aside-WebComponents-Core.package/WAWebComponentActionContinuation.class/instance/continue.st

@@ -0,0 +1,4 @@
+processing
+continue
+	"do not capture state"


Side-note: since we do not capture state, do we need the contents of the states instvar in this class?

I see what you meant. The question comes down to how much we want to tie WAFragmentRenderPhaseContinuation to WAFragmentRenderPhaseContinuation. Right now the states inst vars are still filled with WASnapshot instances due to two reasons:

WAFragmentRenderPhaseContinuation inheritsWARenderLoopContinuation >> #createActionContinuationWithContext: and send #snapshot:renderContext: to the action phase continuation class

WAWebComponentActionContinuation >> #handle: still sends ends up in WASessionContinuation >> #handle:

marschall

Added responses to review comments

marschall · 2024-10-19T13:48:26Z

...itory/Seaside-WebComponents-Core.package/WASingleElementCache.class/instance/at.ifAbsent..st

+at: aKey ifAbsent: aBlock
+	^ key = aKey
+		ifTrue: [ value ]
+		ifFalse: [ aBlock value ]


If I do this I get a code critic warning in Pharo

ifTrue: ifFalse: ifTrue:ifFalse: ifFalse:ifTrue: is used in a way that it can not be optimized.

marschall · 2024-10-19T13:49:27Z

...aside-WebComponents-Core.package/WASingleElementCache.class/instance/keyAtValue.ifAbsent..st

+keyAtValue: anObject ifAbsent: aBlock
+	^ value = anObject
+		ifTrue: [ key ]
+		ifFalse: [ aBlock value ]


Some Pharo code critic warning if I do this.

Improvements for Web Components

7e9dd66

Improvements that allow applications with Web Components to run with a lower overhead.

marschall added the enhancement label Oct 13, 2024

fix typo

2f53e95

jbrichau previously approved these changes Oct 19, 2024

View reviewed changes

Review comments

f6be4f2

marschall dismissed jbrichau’s stale review via f6be4f2 October 20, 2024 14:37

marschall force-pushed the web-components-improvements branch from 9078882 to f6be4f2 Compare October 20, 2024 14:37

marschall commented Oct 20, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improvements for Web Components #1444

Improvements for Web Components #1444

marschall commented Oct 13, 2024

codecov bot commented Oct 13, 2024 •

edited

Loading

adriaon commented Oct 17, 2024 •

edited

Loading

marschall commented Oct 18, 2024

adriaon commented Oct 18, 2024

jbrichau left a comment

jbrichau Oct 19, 2024

marschall Oct 19, 2024

jbrichau Oct 19, 2024

marschall Oct 19, 2024

jbrichau Oct 19, 2024

marschall Oct 19, 2024

marschall left a comment

marschall Oct 19, 2024

marschall Oct 19, 2024

Improvements for Web Components #1444

Are you sure you want to change the base?

Improvements for Web Components #1444

Conversation

marschall commented Oct 13, 2024

codecov bot commented Oct 13, 2024 • edited Loading

Codecov Report

adriaon commented Oct 17, 2024 • edited Loading

marschall commented Oct 18, 2024

adriaon commented Oct 18, 2024

jbrichau left a 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

marschall left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Oct 13, 2024 •

edited

Loading

adriaon commented Oct 17, 2024 •

edited

Loading