feat: waifu log watcher

[zaerald]

This PR implements watching of logs by keyword and triggers an alert once it's present in the runtime logs.

Demo

Settings

I planned to add this to Events tab but this would always be changed by the users so it was added at the second tab, I also plan to enhance this into something more intuitive, like adding action and make it a list of keywords where any keywords present in logs would trigger an alert, and more intuitive if we can select from the logs and add it to the list. But for now, one keyword should suffice the use cases.

Some of the use cases:

• Debugging - Most developers debug with classic System.out.println(), console.log(), and whatnot, these may not be the best debugging tool but it is one of the best ;). For instance, you've printed a log hacker: I'm in and add this keyword for waifu to watch and do your stuff without constantly checking the logs 😎
• Standby startup - There are large applications where the startup time takes almost a minute (e.g. large Spring Boot application) where only logs state if it finished starting.

[zaerald]

Added this to a tracked code style as ktlint gets mad at me as I was using 8 continuation indent.

[Unthrottled]

Oh yeh, how do you want to handle branch updates? Do you want me to rebase when I merge other PRs?

[zaerald]

It's fine for me if you want to do it, and it's also okay in my future PRs.

[Unthrottled]

It's fine for me if you want to do it, and it's also okay in my future PRs.

I guess since you are here, could you update please? I'll try to rebase when I can in the future (it also might depend on the amount of merge conflicts too, I might make you do it then 😉 )

[Unthrottled]

make it a list of keywords where any keywords present in logs

Yes please, I would like this feature ⭐

more intuitive if we can select from the logs and add it to the list

It would be cool if it was like a right-click menu item like Add to waifu watch list 👓

[Unthrottled]

I ❤️ this idea! Why stare at the logs when your waifu can do that for you?

I would like to see a solution the integration test issue though.

[Unthrottled]

What do you think about this?

data class AlertConfiguration(
    val isAlertEnabled: Boolean = false,
    val isDisplayNotificationEnabled: Boolean = false,
    val isSoundAlertEnabled: Boolean = false
) {
    companion object {
        fun allEnabled(): AlertConfiguration =
            AlertConfiguration(
                isAlertEnabled = true,
                isDisplayNotificationEnabled = true,
                isSoundAlertEnabled = true
            )
    }
}

Which in-turn enables AlertConfiguration.allEnabled()

[Unthrottled]

Should we be documenting the new features in the readme in the feature branches, or should that only happen when a release is cut?

[zaerald]

Oh right, if it's notable to our end users we should already include in PR for both README file and CHANGELOG, I'll update it.

[Unthrottled]

This isn't really an issue yet, but something to keep in mind about motivation density. I've got two spring boot servers and am watching for started on port.

[Unthrottled]

I changed my mind, this might be an issue...
I forgot about spring boot tests

@ExtendWith(SpringExtension::class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT,
		classes = [DemoApplication::class])

class DemoApplicationTests(
) {

	@Test
	fun contextLoads() {
	}

	@Test
	fun contextLoads2() {
	}

}

Just have a bunch of these guys running...

[Unthrottled]

I made this to help out https://github.com/Unthrottled/demo-spring

[Unthrottled]

I've got a temporary workaround, it will only do it once if I run it through the verify. But it might get annoying if I am debugging a test.

[Unthrottled]

_{ninja code change}

[Unthrottled]

IMO, I would just prefer it to be Ignore case

[Unthrottled]

Suggested change

	settings.log.watcher.header=I'll watch the logs for you senpai!
	settings.log.watcher.header=I'll watch the logs for you senpai! (๑•̀ㅂ•́)ง✧

😂

[zaerald]

Converted to draft to work on the ff:

• Document to README
• Multiple alerts for multiple consoles session
• Multiple alerts with Test integration
• Document feature in update notification

[Unthrottled]

So something that might make things a bit easier is if the log watcher is only active when a process is running and that process is not a test, wdyt?

[zaerald]

The issue might still show up if for what you've demo wherein there are more than 1 running process which is not a test. For instance, I'll start the application (1 proc), then I'll start a different maven run (2nd proc).

I'll set a time for finishing this up 🤞, it gets a bit busy before the holidays 🎅

[Unthrottled]

The issue might still show up if for what you've demo wherein there are more than 1 running process which is not a test.

While this is still an issue, only one notification will be present at a time avoiding this issue. See this comment for more details about notification collisions

I haven't used the feature as much as I have wanted over time (I haven't had the need to look at logs in a bit). So it may still have some weird edge cases I haven't observed!