The future of Logbook

[whiskeysierra]

This discussion is an attempt to consolidate questions and suggestions made in different, currently open PRs about the status and future of this project.

/cc @agebhar1 @phejl

[whiskeysierra]

As said in #1375 (comment), I'd be willing to help maintaining a fork.
That fork could possibly be something that people will perceive as an official successor project.

I saw that the "logbook" org is already taken, but I reached out to see if we could get it:
logbook/logbook.github.io#1

[whiskeysierra]

See https://central.sonatype.org/publish/#individual-projects-open-source-software-repository-hosting-ossrh

you must choose a groupId for a Web Domain that you own

[agebhar1]

Hi, Github is also fine

In the case of Github, Gitee, Bitbucket or similar groupIds (io.github.username), you must create a temporary, public repository named OSSRH-TICKETNUMBER. Check the details in the Coordinates document.

github.com/yourusername -> io.github.yourusername

Did that once with https://github.com/agebhar1/micrometer-certs-expiration.

[whiskeysierra]

Yeah, it is. It just boils down to the same challenge then: Finding a good place to host the code 😉

[agebhar1]

I suggest you @whiskeysierra, should host the code, maybe with @phejl and me as collaborators. Because you already know and maintained the project.

[whiskeysierra]

@otrosien Given that Zalando no longer maintains this project, can we transfer the ownership (instead of creating a fork)?

[whiskeysierra]

@agebhar1 Let's create a separate thread in here about maven coordinates.

Let's say we settle on my github space for logbook, i.e. whiskeysierra/logbook.
That kind of implies we also change the groupId from org.zalando.logbook to io.github.whiskeysierra.logbook. Right?

The top-level package is a different story, where I'd actually suggest to use just logbook (no reverse DNS).

[agebhar1]

whiskeysierra/logbook ✔️
io.github.whiskeysierra.logbook ✔️

[marcindabrowski]

Why not create a new organization, for example, logbook-java or something similar?

[leviferreira]

Hey @jklingst The team is already working on it since two weeks now. You can see movements in PRs, etc.

[foobar-1337]

@leviferreira Do you have an estimated release date for these fixes?

[nhmarujo]

Hi @leviferreira 👋 I can see the project is getting some love again and is good to see it, so thank you all for that. I see version 2.14.0 was released LONG ago (Oct 12, 2021) and many things are merged on master that are not yet part of any release. This has been like that even before you started maintaining the project now.
I understand everyone here is craving for the SB3 support (ofc I am too) and you guys are kinda tidying up the house and paving the path to get there, so it takes a bit. But in the meantime, is there any planned release so we can get all the goodies that were already merged so far? Thanks

[kasmarian]

Hi @nhmarujo, yes, we do plan to do the 2.15.0 soon. To let all the clients get the latest updates before making any big steps, like SB3 support.

[nhmarujo]

Hi @kasmarian , thank you. That makes perfect sense. Looking forward to it 😄

[whiskeysierra]

If you come up with a good name, I'm all for it. Java is to restrictive, I'd say because with modern Spring there is quite some Kotlin projects out there that can an do still use Logbook. What about logbook-jvm?

…

On Fri, 2 Dec 2022, 20:00 Marcin Dąbrowski, ***@***.***> wrote: Why not create a new organization, for example, logbook-java or something similar? — Reply to this email directly, view it on GitHub <#1379 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AADI7HNS7CHV4GRSP5Z6PG3WLJBL7ANCNFSM6AAAAAASI7KHEE> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[marcindabrowski]

You are right. I forgot that java is a trademark of Oracle and that could be a problem.
What about http-logbook, or logbook-http?

[agebhar1]

😆 I had exactly the same idea.

[phejl]

logbook-http sounds great to me.

[whiskeysierra]

Yeah, agreed. It's so bound to HTTP, I don't ever see it expanding beyond that protocol.

…

On Sat, 3 Dec 2022, 17:48 Petr Hejl, ***@***.***> wrote: logbook-http sounds great to me. — Reply to this email directly, view it on GitHub <#1379 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AADI7HK76KI4F32NVEHEIVTWLN2WNANCNFSM6AAAAAASI7KHEE> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[maciejwalkowiak]

@whiskeysierra I am just checking if anything moved forward..? In case you need some support with Spring modules let me know.

[Ahli]

When you scroll up a bit and check other comments, you will see this posted last Friday:

Hi Everyone,

The people to maintain logbook is now selected and they are getting some onboarding and access next week. There will be 6 colleagues maintaining and contributing so I expect already some action next week. The initial goal is to make sure the PR's open are getting attention.

[hemju]

According to this comment: #1417 (comment) there is no ETA when logbook will support Spring 3. Going back to my comment here: #1379 (reply in thread)

As a community we depend on how Zalando actually uses Logbook internally, and not on what the community vision/requirements are. E.g. my guess is Zalando will have a Spring Boot 3 support when they upgrade to Spring Boot 3 internally. Not earlier. I do believe that something like Logbook would be a useful project for a wide variety of companies. Especially, when the requirements are not dictated by one consumer. So I want to raise again the discussion of created a community fork of Logbook. Is that still a possibility?

@maciejwalkowiak @whiskeysierra @agebhar1 @marcindabrowski & others

Btw. just to be clear, I really appreciate the work of all collaborators and also from Zalando to make Logbook Open Source in the first place.

[maciejwalkowiak]

I understand your concerns. Forking is easy, maintaining the fork is a challenge. In terms of community work i can help by providing an advice if such is needed, but for anything bigger would mean a paid contract the me. Feel free to drop me an email or message on Twitter if your company would be interested.

[agebhar1]

Hi,

I've updated the PR #1375 to the current master. As already mentioned in #1426 "The way to move forward with Spring 6 / Spring Boot 3" it's not clever and maintainable to copy ~5k of extra code. I hope to find some time next weekend to implement @maciejwalkowiak idea #1426 (comment) to use Maven Shade.

[agebhar1]

Already done in #1467 by @ChristianLohmann.

[ChristianLohmann]

Regarding Logbooks Spring 6 support there is a new (actually reopened) pull request #1467 as @agebhar1 already mentioned which enables logbook finally to run with Spring 6. Thanks to @maciejwalkowiak additional Spring 5 backwards compatibility has been added using a shaded logbook-servlet artifact. That reduced the effort to, more or less only one additional AutoConfiguration class.
We are looking forward to get this done very soon.

[nhmarujo]

Hi @ChristianLohmann . Yes, I noticed that and we have already used it on our own RCs. But are you suggesting to use your RC version on a production environment?

[ChristianLohmann]

For the time being if you already use Spring 6 in production envs you can use that release. We are planning to add some more breaking changes/features into the next RC which have been a bit forgotten.

[nhmarujo]

We are not using Spring 6 in production yet. We have everything ready in RC branches but we have been waiting for this to move to SB3. Can you please clarify what those breaking changes/features are about? Thanks

[ChristianLohmann]

We are planning to introduce JDK9 module support and Ktor 2.x support. If you don't use Spring 6 in prod yet then i suggest you to wait at least for the next RC as there is a fix to enable Spring 5 backwards compatibility in spring-security backed projects

[nhmarujo]

Thank for the feedback. Do you have any ETA for the next RC?