Skip to content

Commit

Permalink
Fix default value of show-stack-trace to false (#521)
Browse files Browse the repository at this point in the history
  • Loading branch information
@cy-by
cy-by authored Feb 22, 2024
1 parent 70c5f14 commit f0b366e
Show file tree
Hide file tree
Showing 2 changed files with 111 additions and 100 deletions.
199 changes: 103 additions & 96 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -350,9 +350,9 @@ Google address.
@Component
public class CheckGmailUser implements Condition {
public boolean run(Submission submission) {
return submission.getInputData().get("emailAddress").contains("gmail.com");
}
public boolean run(Submission submission) {
return submission.getInputData().get("emailAddress").contains("gmail.com");
}
}
```

Expand All @@ -366,9 +366,12 @@ More examples of conditions can be found in our

### Using Conditions in `flows-config.yaml`

Conditions can be configured at the screen level as a pre-condition or at the next screen level as a post-condition.
Depending on the scenario, it may be better to configure it in one way vs the other. In either case, the application
flow will behave the same way. The difference is that pre-conditions prevent the page from being viewed at all - the
Conditions can be configured at the screen level as a pre-condition or at the next screen level as a
post-condition.
Depending on the scenario, it may be better to configure it in one way vs the other. In either case,
the application
flow will behave the same way. The difference is that pre-conditions prevent the page from being
viewed at all - the
ScreenController will look for the next viewable page.

The following 2 examples of condition configuration result in the same flow behavior.
Expand Down Expand Up @@ -444,11 +447,11 @@ Here is an example of a `beforeSaveAction` Action class:
```java
public class CalculateBeforeSave implements Action {
public void run(Submission submission) {
float rate = 0.59;
int mileage = submission.getInputData().get("mileage");
submission.getInputData().put("reimbursement", mileage * rate);
}
public void run(Submission submission) {
float rate = 0.59;
int mileage = submission.getInputData().get("mileage");
submission.getInputData().put("reimbursement", mileage * rate);
}
}
```

Expand Down Expand Up @@ -494,39 +497,39 @@ An example `Submission` object can be seen below:
```java
class Submission {
@Id
@GeneratedValue
private UUID id;
@Id
@GeneratedValue
private UUID id;
@Column(name = "flow")
private String flow;
@Column(name = "flow")
private String flow;
@Type(JsonType.class)
@Column(name = "input_data", columnDefinition = "jsonb")
private Map<String, Object> inputData;
@Type(JsonType.class)
@Column(name = "input_data", columnDefinition = "jsonb")
private Map<String, Object> inputData;
@Type(JsonType.class)
@Column(name = "url_params", columnDefinition = "jsonb")
private Map<String, String> urlParams;
@Type(JsonType.class)
@Column(name = "url_params", columnDefinition = "jsonb")
private Map<String, String> urlParams;
@CreationTimestamp
@Temporal(TIMESTAMP)
@Column(name = "created_at")
private Date createdAt;
@CreationTimestamp
@Temporal(TIMESTAMP)
@Column(name = "created_at")
private Date createdAt;
@UpdateTimestamp
@Temporal(TIMESTAMP)
@Column(name = "updated_at")
private Date updatedAt;
@UpdateTimestamp
@Temporal(TIMESTAMP)
@Column(name = "updated_at")
private Date updatedAt;
@Temporal(TIMESTAMP)
@Column(name = "submitted_at")
private Date submittedAt;
@Temporal(TIMESTAMP)
@Column(name = "submitted_at")
private Date submittedAt;
public Submission() {
inputData = new HashMap<>();
urlParams = new HashMap<>();
}
public Submission() {
inputData = new HashMap<>();
urlParams = new HashMap<>();
}
}
```

Expand Down Expand Up @@ -565,18 +568,18 @@ can also be used as a field name in your inputs class**. Java will require that
```java
class ApplicationInformation extends FlowInputs {
@NotBlank(message = "{personal-info.provide-first-name}")
String firstName;
@NotBlank(message = "{personal-info.provide-first-name}")
String firstName;
@NotBlank(message = "{personal-info.provide-last-name}")
String lastName;
@NotBlank(message = "{personal-info.provide-last-name}")
String lastName;
String emailAddress;
String emailAddress;
String phoneNumber;
String phoneNumber;
@NotEmpty(message = "{personal-info.please-make-a-gender-selection}")
ArrayList<String> gender;
@NotEmpty(message = "{personal-info.please-make-a-gender-selection}")
ArrayList<String> gender;
}
```

Expand Down Expand Up @@ -621,14 +624,14 @@ what type of document it is (license, birth certificate, etc.).
```java
class ApplicationInformation extends FlowInputs {
MultipartFile documents;
MultipartFile documents;
@NotBlank
@DynamicField
String docTypeLabel;
@NotBlank
@DynamicField
String docTypeLabel;
@NotBlank(message = "{personal-info.provide-first-name}")
String someOtherField;
@NotBlank(message = "{personal-info.provide-first-name}")
String someOtherField;
}
```

Expand Down Expand Up @@ -684,6 +687,7 @@ Use them the same way you would any other JavaX validator.
#### @Money

```java
@Money(message = "Please make sure to enter a valid dollar amount.")
private String income;
```
Expand Down Expand Up @@ -712,6 +716,7 @@ Does not accept values such as:
Used to validate 10-digit phone numbers.

```java
@Phone(message = "{contact-info.invalid-phone-number}")
private String phoneNumber;
```
Expand Down Expand Up @@ -753,6 +758,7 @@ not have any validation associated with them; they may simply mark the field for
#### @Encrypted
```java
@Encrypted
private String socialSecurityNumber;
```
Expand Down Expand Up @@ -2152,20 +2158,20 @@ maps them to a single PDF field.
```java
public class ApplicantDateOfBirthPreparer implements SubmissionFieldPreparer {
@Override
public Map<String, SubmissionField> prepareSubmissionFields(Submission submission,
PdfMap pdfMap) {
Map<String, SubmissionField> submissionFields = new HashMap<>();
@Override
public Map<String, SubmissionField> prepareSubmissionFields(Submission submission,
PdfMap pdfMap) {
Map<String, SubmissionField> submissionFields = new HashMap<>();
String month = submission.getInputData().get("applicantBirthMonth").toString();
String day = submission.getInputData().get("applicantBirthDay").toString();
String year = submission.getInputData().get("applicantBirthYear").toString();
String month = submission.getInputData().get("applicantBirthMonth").toString();
String day = submission.getInputData().get("applicantBirthDay").toString();
String year = submission.getInputData().get("applicantBirthYear").toString();
submissionFields.put("applicantDateOfBirth",
new SingleField("applicantDateOfBirth", month + "/" + day + "/" + year, null));
submissionFields.put("applicantDateOfBirth",
new SingleField("applicantDateOfBirth", month + "/" + day + "/" + year, null));
return submissionFields;
}
return submissionFields;
}
}
```

Expand Down Expand Up @@ -2203,31 +2209,31 @@ we would update the above custom preparer example to this:
```java
public class DataBaseFieldPreparer implements SubmissionFieldPreparer {
@Override
public Map<String, SubmissionField> prepareSubmissionFields(Submission submission,
PdfMap pdfMap) {
Map<String, SubmissionField> submissionFields = new HashMap<>();
ArrayList<Map<String, Object>> houseHoldSubflow = (ArrayList<Map<String, Object>>) submission.getInputData()
.get("household");
// Note that we want to iterate up to the max number of iterations or the total iterations in the subflow, whichever is smaller
int maxIterations = Math.min(houseHoldSubflow.size(),
pdfMap.getSubflowInfo().get("householdAndIncome").getTotalIterations());
for (int i = 0; i < maxIterations; i++) {
String month = houseHoldSubflow.get(i).get("applicantBirthMonth").toString();
String day = houseHoldSubflow.get(i).get("applicantBirthDay").toString();
String year = houseHoldSubflow.get(i).get("applicantBirthYear").toString();
// Note that current iteration number is not 0 indexed, so we add 1 to the index from our for loop
int iterationNumber = i + 1;
submissionFields.put("householdMemberDateOfBirth_" + iterationNumber,
new SingleField("householdMemberDateOfBirth", month + "/" + day + "/" + year,
iterationNumber));
}
return submissionFields;
@Override
public Map<String, SubmissionField> prepareSubmissionFields(Submission submission,
PdfMap pdfMap) {
Map<String, SubmissionField> submissionFields = new HashMap<>();
ArrayList<Map<String, Object>> houseHoldSubflow = (ArrayList<Map<String, Object>>) submission.getInputData()
.get("household");
// Note that we want to iterate up to the max number of iterations or the total iterations in the subflow, whichever is smaller
int maxIterations = Math.min(houseHoldSubflow.size(),
pdfMap.getSubflowInfo().get("householdAndIncome").getTotalIterations());
for (int i = 0; i < maxIterations; i++) {
String month = houseHoldSubflow.get(i).get("applicantBirthMonth").toString();
String day = houseHoldSubflow.get(i).get("applicantBirthDay").toString();
String year = houseHoldSubflow.get(i).get("applicantBirthYear").toString();
// Note that current iteration number is not 0 indexed, so we add 1 to the index from our for loop
int iterationNumber = i + 1;
submissionFields.put("householdMemberDateOfBirth_" + iterationNumber,
new SingleField("householdMemberDateOfBirth", month + "/" + day + "/" + year,
iterationNumber));
}
return submissionFields;
}
}
```

Expand Down Expand Up @@ -2393,6 +2399,7 @@ It’s recommended that developers pass a list of strings representing email add
and/or **bcc:** fields. These stringed lists can be injected into class variables as seen below:

```java
@Value("${form-flow.flow.ubi.email.confirmation.cc:}")
private List<String> emailToCc;
Expand All @@ -2415,15 +2422,15 @@ Below is an example of a sendEmail() call being made by an application using the
Please note that pdfs is a list of files to be passed as attachments with the email.

```java
MessageResponse response=mailgunEmailClient.sendEmail(
emailSubject,
recipientEmail,
emailToCc,
emailToBcc,
emailBody,
pdfs,
requireTls
);
MessageResponse response = mailgunEmailClient.sendEmail(
emailSubject,
recipientEmail,
emailToCc,
emailToBcc,
emailBody,
pdfs,
requireTls
);
```

The `sendEmail()` method will send an email and return the `MessageResponse` object it receives from
Expand Down Expand Up @@ -2891,7 +2898,7 @@ server:

| Property | Default | Description |
|-----------------------------------------|------------|--------------------------------------------------------------------------------------------------------------------|
| `form-flow.error.show-stack-trace` | `true` | Show full the full stack trace and error codes on our '/error' template (on your local or staging env for example) |
| `form-flow.error.show-stack-trace` | `false` | Show full the full stack trace and error codes on our '/error' template (on your local or staging env for example) |
| `form-flow.error.pretty-print-packages` | `formflow` | A comma seperated list of packages that will be highlighted on the stacktrace for easier identification. |

We've chosen to use a yaml version of the application file, but you could also store this as a
Expand Down
12 changes: 8 additions & 4 deletions src/main/java/formflow/library/FormFlowErrorController.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,12 @@ public class FormFlowErrorController implements ErrorController {

/**
* Constructor for the {@link FormFlowErrorController} class
* @param showStackTrace The {@link Boolean} variable for determining an endpoint
* @param errorPath A {@link String} endpoint to a generic error screen
* @param prettyPrintPackages {@link String} a comma-separated list
* @param errorAttributes An {@link ErrorAttributes} object
*
* @param showStackTrace The {@link Boolean} variable for determining an endpoint. Default value is {@code false}.
* @param errorPath A {@link String} endpoint to a generic error screen. Default value is
* {@code "errors/genericError"}.
* @param prettyPrintPackages {@link String} a comma-separated list. Default value is {@code "formflow"}.
* @param errorAttributes An {@link ErrorAttributes} object
*/
public FormFlowErrorController(
@Value("${form-flow.error.show-stack-trace:false}") boolean showStackTrace,
Expand All @@ -50,6 +52,7 @@ public FormFlowErrorController(

/**
* Displays errors in a {@link WebRequest}
*
* @param webRequest Malformed {@link WebRequest}
* @return a {@link ModelAndView} class object
*/
Expand All @@ -71,6 +74,7 @@ public ModelAndView handleError(WebRequest webRequest) {

/**
* Method takes a {@link Throwable} object returns a {@link String} stacktrace with HTML formatting
*
* @param e {@link Throwable} error
* @return A formatted stack trace as a {@link String}
*/
Expand Down

0 comments on commit f0b366e

Please sign in to comment.