WebContainer displayCustomizedExceptionText property needs to be documented

wtlucy commented 3 years ago

Description of the high level feature, including any external spec links:

The description needs to be detailed enough such that it can be prioritized on the backlog and implemented by the development team.

RFE: https://bigblue.aha.io/ideas/ideas/TWAS-I-40

Previously support was added for customizing the error page text for when the server encounters SRVE0232E and SRVE0218E errors. Those error messages can be customized via

<webContainer displaycustomizedexceptiontext="Replace_with_Your_New_Message_Here"/>

This displayCustomizedExceptionText property needs to be properly documented so it shows up in doc pages like https://openliberty.io/docs/21.0.0.3/reference/config/webContainer.html

In addition move the test that exists to Open Liberty

When complete & mandatory, add links to the UFO (Upcoming Feature Overview) document, FTS (Feature Test Summary), and Aha (externally raised RFEs):

UFO:
FTS:
Aha:
- Do NOT add a comment into the Aha idea linking to this issue, or any other internal links.
List of Steps to complete or get approvals / sign-offs for onboarding to the Liberty release (GM date)

Instructions:

Do the actions below and mark them complete in the checklist when they are done.
Make sure all feature readiness approvers put the appropriate tag on the epic to indicate their approval.

Design

Before Development Starts or 8 weeks before Onboarding

[ ] POC Design / UFO Review Scheduled (David Chang) or N/A.
[ ] POC Design / UFO Reviewed (Feature Owner) or N/A.
[ ] Complete any follow-ons from the POC Review.
[ ] Design / UFO Approval (Alasdair Nottingham) or N/A.
[ ] No Design / No UFO Approval (Arthur De Magalhaes - cloud / Alasdair Nottingham - server) or N/A.
[ ] SVT Requirements identified. (Epic owner / Feature owner with SVT focal point)
[ ] ID Requirements identified (Documenting WebSphere Liberty & tWAS). (Epic owner / Feature owner with ID focal point)
[ ] Create a child task of this epic entitled "Feature Test Summary" via this template. Add the link in above.

Before proceeding to any items below (active development), this feature must be prioritized on the backlog, and have been socialized (e.g., UFO Review). Follow the Feature and UFO (WAD) Approval Process.

Development

When active development has begun

[ ] Add the "In Progress" label to this issue.

Legal

3 weeks before Onboarding

[ ] Identify all open source libraries that are changing or are new. Work with Legal Release Services (Cass Tucker or Release PM) to get open source cleared and approved. Or N/A. (Epic Owner). New or changed open source impacts license and Certificate of Originality.

Translation

3 weeks before Onboarding

[ ] All new or changed PII messages are checked into the integration branch, before the last translation shipment out. (Epic Owner)

Feature Complete

2 weeks before Onboarding

[ ] Implementation complete. (Epic owner / Feature owner)
[ ] All function tests complete. Ready for FAT Approval. (Epic owner / Feature owner)
[ ] Review all known issues for Stop Ship. (Epic owner / Feature owner / PM)

Focal Point Approvals

2 to 1 week before Onboarding

You MUST have the Design Approved or No Design Approved label before requesting focal point approvals.

All features (both "Design Approved" and "No Design Approved")

[ ] FAT - (websphere/fat-approvers). SOE FATS are running successfully or N/A . Approver adds label focalApproved:fat to the Epic in Github.
[ ] Demo - (Tom Evans or Chuck Bridgham). Demo is scheduled for an upcoming EOI. Approver adds label focalApproved:demo to the Epic in Github.
[ ] Globalization (Sam Wong - Liberty / Simy Cheeran - tWAS). Translation is complete or N/A. TVT - complete or N/A. Approver adds label focalApproved:globalization to the Epic in Github.

"Design Approved" features

[ ] Accessibility - (Steven Zvonek). Accessibility testing is complete or N/A. Approver adds label focalApproved:accessibility to the Epic in Github.
[ ] ID - (Karen Deen). Documentation work is complete or N/A . Approver adds label focalApproved:id to the Epic in Github.
[ ] Performance - (Jared Anderson). Performance testing is complete with no high severity defects or N/A . Approver adds label focalApproved:performance to the Epic in Github.
[ ] Serviceability - (Don Bourne). Serviceability has been addressed.
[ ] STE - (Swati Kasundra). STE chart deck is complete or N/A . Approver adds label focalApproved:ste to the Epic in Github.
[ ] SVT - (Brian Hanczaryk - APS). SVT is complete or N/A . Approver adds label focalApproved:svt to the Epic in Github.

Ready for GA

1 week before Onboarding

[ ] No Stop Ship issues for the feature. (Epic owner / Feature owner / Release PM)
[ ] Ship Readiness Review and Release Notes completed (Epic owner / Feature owner / Release PM)
[ ] Github Epic and Epic's issues are closed / complete. All PRs are committed to the master branch. (Epic owner / Feature owner / Backlog Subtribe PM)

Other deliverbles

[ ] WDT - (Leonard Theivendra). WDT work complete or N/A.

pnicolucci commented 3 years ago

I'd also like to see a test case for this if possible if one does not already exist.

wtlucy commented 3 years ago

I'd also like to see a test case for this if possible if one does not already exist.

We have a test in the other repo under com.ibm.ws.webcontainer_fat_lWAS which tests that some text specified in this prop is sent in response to an error case (invalid character % in the request URI): test_PI68061_WebContainerException_Customized_Text

malincoln commented 1 year ago

Per @pnicolucci still valid

OpenLiberty / open-liberty