kjivan

Spring Boot Debugging

Enable actuators and values

management.endpoints.web.exposure.include=*
management.endpoint.env.show-values=ALWAYS

Enable SQL Logging

kjivan

Feature Implementation Best Practices

kjivan

Debugging Best Practices

Preparation

• Establish a clear understanding of the issue
  • Ask issue reporter/lead about issue if needed
• Reproduce the issue
  • Is it a workflow that is causing the issue
  • Is it particular data that is causing the issue
  • Is it a combination of the above
• Is there a timing issue or a race condition issue

kjivan

Error Handling Best Practices

• System Errors
  • eg null pointers/failed db query/failed api calls
  • Log this at the error level
  • Log stack trace if possible
  • Log any relevant identifiers if possible
  • Don't log any unapproved sensitive data
• User errors
• eg invalid zip code/name length

kjivan

Logging Best Practices

This assumes you have a fast memory logging system.

Use 4 logging levels

• error - Log critical system errors only (not user errors)
• warn - Log things that are potential errors or can become errors
• info(default) - Logs info about events in the system
• debug - Log more detailed info about debugging

kjivan

name: Pipeline
on:
  push:

jobs:
  log-json:
    name: Run test command & log github json
    runs-on:
      - self-hosted
    steps:

kjivan

Lombok Best Practices

Entities

• Do not use @Data and @EqualsAndHashCode
• Use @Getter and @Setter
• Don't forget to exclude lazy attributes if you use @ToString
• Don't forget to add @NoArgsConstructor if you use @Builder or @FullArgsConstructor or @RequiredArgsConstructor
• Explanation for rules above: Lombok and JPA: What may go wrong?
• Use @Builder if setting lots of different fields

kjivan

Flaky Test Loop

for i in {1..10}; do
   ./gradlew integrationTest || {echo "Failed after $i attempts" && break}
done

kjivan

Github Actions

Running github actions repeatedly

gc -m "Whatever" -a; \
gp; \
gh pr create --fill; \
gh pr merge -m

kjivan

apply plugin: 'com.diffplug.spotless'
spotless {
  java {
    removeUnusedImports()
    prettier(['prettier': 'latest', 'prettier-plugin-java': 'latest']).config(['parser': 'java', 'useTabs': true])
  }
  groovyGradle {
    greclipse()
  }
}