[PAGES-995] Deprecate support for magnolia-hosted SPA with templateScript for 6.2 Created: 11/Jan/23  Updated: 21/Mar/23  Resolved: 21/Mar/23

Status: Closed
Project: Magnolia pages module
Component/s: None
Affects Version/s: None
Fix Version/s: 6.2.26

Type: Story Priority: Neutral
Reporter: Christopher Zimmermann Assignee: Oanh Thai Hoang
Resolution: Fixed Votes: 0
Labels: None
Σ Remaining Estimate: Not Specified Remaining Estimate: Not Specified
Σ Time Spent: 2d Time Spent: 2d
Σ Original Estimate: Not Specified Original Estimate: Not Specified

Attachments: PNG File Screen Shot 2023-03-02 at 11.27.39.png     PNG File Screen Shot 2023-03-03 at 09.26.30.png    
Issue Links:
Relates
relates to PAGES-1101 Deprecate support for magnolia-hosted... Closed
documentation
to be documented by PAGES-1072 DOC: Deprecate support for magnolia-h... Closed
relation
is related to MGNLFE-403 Remove duplicated onFrameReady call Open
Sub-Tasks:
Key
Summary
Type
Status
Assignee
PAGES-996 Implementation in 6.2 Sub-task Closed Oanh Thai Hoang  
PAGES-997 Review in 6.2 Sub-task Completed Canh Nguyen  
PAGES-998 Pre-Integration QA in 6.2 Sub-task Completed Canh Nguyen  
PAGES-999 QA Sub-task Completed Phong Le Quoc  
Template:
Acceptance criteria:
Empty
Task DoD:
[X]* Doc/release notes changes? Comment present?
[X]* Downstream builds green?
[X]* Solution information and context easily available?
[X]* Tests
[X]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Release notes required:
Yes
Documentation update required:
Yes
Date of First Response:
Epic Link: SPA Editor Backlog
Sprint: DevX 33
Story Points: 1
Team: DeveloperX
Work Started:

 Description   

The Visual SPA Editor started out using a `templateScript` property in a page template definition.

The "External SPA" feature which introduced `baseUrll` and `routeTemplate` and is now the best practice approach.

In order to get our customers on the better featured External SPA, and to reduce maintenance effort and bugs we should deprecate the earlier approach.

 

To determine:

How should the deprecaation be implemented.

When should the stages be.

How to document.

How to support customers migrating to new approach.

Won't be supported with 6.3.
Deprecate in 6.2.x
NOT supported on SaaS

 

Docu will be in ticket of https://jira.magnolia-cms.com/browse/PAGES-1072



 Comments   
Comment by Jaroslav Simak [ 27/Feb/23 ]

To Discover:

Can we show message in Definitions app that the template script property is deprecated with magnolia hosted SPA?

Comment by Oanh Thai Hoang [ 02/Mar/23 ]

We can show a message deprecate with template render type is spa like below. Template basic from mtk2 ( renderType is freemarker) will not show deprecated msg

 

Comment by Christopher Zimmermann [ 02/Mar/23 ]

Nice - can the deprecation messaage be more specific (since templateScript is still supported for freemarker) - something like "...deprecated for usage with spa renderer". 

 

(I might have the terminology wrong, but you get the idea I think)

Comment by Oanh Thai Hoang [ 03/Mar/23 ]

Here is out put of specific msg from basic template with spa renderType.

 

Note: There are 2 sentences like above.

Configuration relies on a property: [templateScript] which is deprecated   --> I can not change this sentence

Deprecated since: 6.2.30 Description: deprecated for usage with spa renderer --> This Description: can be change

 

I add another log warning in #setTemplateScript func, so developer can see the warning in log when edit templating yaml file

 

And PR is created

Comment by Oanh Thai Hoang [ 21/Mar/23 ]

For release note: `Since version 6.2.26 of the Pages module, the templateScript property is deprecated for use with the SPA renderer.`

Generated at Mon Feb 12 06:24:08 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.