Kavi Jivan kjivan

Set environment variables from .env file

# Export .env variables if .env file exists
# https://stackoverflow.com/a/34093548
set -a
[ -f .env ] && source .env
set +a

Unfortunately Oracle databases aren’t compatible with the new Apple Silicon CPU architecture. Due to this fact you’re not able to run an Oracle XE image with TestContainers on your brand-new MacBook, but there’s a workaround!

TLDR;

Install colima

Run colima start --arch x86_64 --memory 4

Set TestContainers env vars

Spring Boot Debugging

Enable actuators and values

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

Enable SQL Logging

Feature Implementation Best Practices

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

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

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

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 @AllArgsConstructor or @RequiredArgsConstructor
Explanation for rules above: Lombok and JPA: What may go wrong?
Use @Builder if setting lots of different fields

Flaky Test Loop

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

	name: Pipeline
	on:
	push:

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