adde Folia support #3617

ColdeZhang · 2024-05-14T08:33:53Z

Your checklist for this pull request

🚨 Please review the guidelines for contributing to this repository.

Make sure your name is added to Contributors file /Plan/common/src/main/java/com/djrapitops/plan/delivery/rendering/html/Contributors.java
If PR:ing locale changes also add a LangCode with your name /Plan/common/src/main/java/com/djrapitops/plan/settings/locale/LangCode.java

Description

Add support for folia!

Noted: It needs to merge mu update for Platform-abstraction-layer it add an new abstract layer for folia.

AuroraLS3 · 2024-05-14T09:41:20Z

This is an interesting surprise, thanks!

Looks like there are ~100-200 bukkit based servers running Java version <17 which this PR drops support for.

If there is some way to retain support for them I'd like to consider it - one option could be placing the folia code in new gradle module and using reflection to create the FoliaPlatformLayer instance in the bukkit module - I'm not 100% sure if gradle allows that sort of thing

I'll review these two PRs when I have the time, thanks!

ColdeZhang · 2024-05-14T09:58:37Z

one option could be placing the folia code in new gradle module and using reflection to create the FoliaPlatformLayer instance in the bukkit module

That's a good idea. I will try this method later!

ColdeZhang · 2024-05-14T15:13:40Z

After consulting the relevant information and making some attempts...

Yes, maybe it could be compatible both 11 and 17 with different libs, but it's too complicateed to done. In contrast, the effort made is much higher than the harvest, and the cost performance is too low.

I choose to give up on this attemption, it's more than I can handle. :(

If Plan insist on looking back to under java17 servers, mybe this merge should be postponed, until the number of servers using older versions of Java is negligible.

AuroraLS3 · 2024-05-14T15:17:21Z

Thanks for trying it out! Could you tell me what you attempted so that I can avoid repeating those attempts? :)

ColdeZhang · 2024-05-14T15:23:02Z

Thanks for trying it out! Could you tell me what you attempted so that I can avoid repeating those attempts? :)

Sure, I'll get back to you when I'm tidying it up。

ColdeZhang · 2024-05-14T16:32:38Z

do not compile shadow "net.playeranalytics:platform-abstraction-layer-folia:$palVersion", but package it in to jar.
change codes into below, use reflection to load this class when java version is 17 and running on folia server.

    public void onLoad() {
        if (isJava17OrLater() && isFolia()) {
            try {
                // Attempt to load and use the Folia library for Java 17
                Class<?> foliaPlatformLayer = Class.forName("net.playeranalytics.plugin.FoliaPlatformLayer");
                abstractionLayer = (PlatformAbstractionLayer) foliaPlatformLayer.getConstructor(PlanPlugin.class).newInstance(this);
            } catch (Exception e) {
                this.getLogger().log(Level.SEVERE, "Failed to load FoliaPlatformLayer", e);
                abstractionLayer = new BukkitPlatformLayer(this);
            }
        } else {
            abstractionLayer = new BukkitPlatformLayer(this);
        }
        pluginLogger = abstractionLayer.getPluginLogger();
        runnableFactory = abstractionLayer.getRunnableFactory();
    }

Theoretically, this is possible.

Howerver, here is the problem I encountered......

I didnt figure out how to controll gradle just 'package' lib instead of 'compile' it. Whatever I tried, gradle still check the java versions and then throw errs.
I tried to put lib into servers 'libriries' folder directly, I assume mc should load libs in that folder. But it still doesnt work.

:(

Here is my trial.

AuroraLS3 · 2024-05-14T16:57:13Z

Alright, I think trying this option in the folia module might do something, not sure https://docs.gradle.org/current/kotlin-dsl/gradle/org.gradle.api.plugins/-java-plugin-convention/disable-auto-target-jvm.html

It might also be possible to try include the folia module in the plugin module instead of bukkit module

(This whole comment assumes a new folia module is added to Plan project)

ColdeZhang · 2024-05-15T01:56:43Z

Alright, I think trying this option in the folia module might do something, not sure https://docs.gradle.org/current/kotlin-dsl/gradle/org.gradle.api.plugins/-java-plugin-convention/disable-auto-target-jvm.html

It might also be possible to try include the folia module in the plugin module instead of bukkit module

(This whole comment assumes a new folia module is added to Plan project)

wow, thanks for this information. it works now. I tested it on paper 1.16.5(java11) and folia 1.20.4(java21), both of them can loaded Plan proply.

now this can be compiled by CI-CD(workflow)

…folia-support

ColdeZhang · 2024-05-16T12:32:10Z

I did some test about CI-CD, it failed on 'aggregateJavadocs' step.
The problem is still about the jvm versions,

* What went wrong:
Execution failed for task ':aggregateJavadocs'.
> Could not resolve all files for configuration ':plugin:compileClasspath'.
   > Could not resolve net.playeranalytics:platform-abstraction-layer-folia:5.2.0.
     Required by:
         project :plugin > project :bukkit
      > No matching variant of net.playeranalytics:platform-abstraction-layer-folia:5.2.0 was found. The consumer was configured to find a library for use during compile-time, compatible with Java 11, preferably in the form of class files, preferably optimized for standard JVMs, and its dependencies declared externally but:
          - Variant 'apiElements' declares a library for use during compile-time, packaged as a jar, and its dependencies declared externally:
              - Incompatible because this component declares a component, compatible with Java 17 and the consumer needed a component, compatible with Java 11
              - Other compatible attribute:
                  - Doesn't say anything about its target Java environment (preferred optimized for standard JVMs)
          - Variant 'runtimeElements' declares a library for use during runtime, packaged as a jar, and its dependencies declared externally:
              - Incompatible because this component declares a component, compatible with Java 17 and the consumer needed a component, compatible with Java 11
              - Other compatible attribute:
                  - Doesn't say anything about its target Java environment (preferred optimized for standard JVMs)

AuroraLS3 · 2024-05-16T12:34:21Z

Javadoc building fails, folia needs it's own gradle module, with pal-folia as dependency, and then that module would be shadowed in :plugin module, so that :bukkit module doesn't have Java 17 dependencies

The folia module doesn't need any Java files inside it as far as I'm aware

This should work at runtime since plugin module outputs the jar and bukkit module can still access the class via reflection at that point

AnttiMK · 2024-05-16T14:04:34Z

Do we want to move Folia's PAL into this repository as was done with Fabric, or keep it as is?

AuroraLS3 · 2024-05-16T14:21:02Z

It's fine to keep as is, just the dependency needs to be moved :)

I think fabric was more involved since it included all sorts of other things on top of PAL that would make it seem disingenuous if PAL contained fabric, while it seems to work fine for Folia

so javadoc gen may success

AnttiMK

Some little things, also have to make sure all scheduled stuff works correctly but code-wise lgtm

Plan/build.gradle

AnttiMK · 2024-05-16T18:06:12Z

Plan/folia/build.gradle

+
+dependencies {
+ shadow "net.playeranalytics:platform-abstraction-layer-folia:$palVersion"
+}


Suggested change

}

}

Plan/bukkit/src/main/java/com/djrapitops/plan/Plan.java

ColdeZhang · 2024-05-16T18:32:07Z

Some little things, also have to make sure all scheduled stuff works correctly but code-wise lgtm

There still have javadoc problem, folia module can't pass 'aggregateJavadocs' step.

AuroraLS3 · 2024-05-17T17:31:59Z

Alright, Looks like the folia module is redundant (and can be removed).

All the funky dependency business can be done in the plugin module

dependencies {
    ...
    shadow "net.playeranalytics:platform-abstraction-layer-folia:$palVersion"
}

java {
    // This is required to prevent the shadow plugin from
    // adding the folia platform abstraction layer to the runtime classpath
    disableAutoTargetJvm()
}

I didn't have Folia installed so I couldn't test if that starts up, but at least Plan starts with Java 11 with this setup, and aggregateJavadocs works too.

ColdeZhang · 2024-05-18T02:53:13Z

Alright, Looks like the folia module is redundant (and can be removed).

All the funky dependency business can be done in the plugin module
dependencies {
    ...
    shadow "net.playeranalytics:platform-abstraction-layer-folia:$palVersion"
}

java {
    // This is required to prevent the shadow plugin from
    // adding the folia platform abstraction layer to the runtime classpath
    disableAutoTargetJvm()
}
I didn't have Folia installed so I couldn't test if that starts up, but at least Plan starts with Java 11 with this setup, and aggregateJavadocs works too.

1

This will also work. But I think disabling jvm inspections directly in the plugin is too aggressive and potentially dangerous.

With specificed jvm version, now we don't need to disable jvm check in folia module too.

2

To pass javadocs aggregate, I changed shadow to runtimeOnly:

dependencies {
    shadow "net.playeranalytics:platform-abstraction-layer-folia:$palVersion"
}

⬇️

dependencies {
    runtimeOnly "net.playeranalytics:platform-abstraction-layer-folia:$palVersion"
}

So this pal won't be involved in to aggregateJavadocs progress.

ColdeZhang · 2024-05-18T07:09:28Z

It looks like chrome driver got updated to be more shit, I'll try to sort out the problems with the AccessControlVisibilityTest

I think that's the real problem I encountered.

https://pastes.dev/oobEreU7Lv

AuroraLS3 · 2024-05-18T07:46:04Z

You can merge master to this branch and that should sort out the issue

…into folia-support

ColdeZhang · 2024-05-18T10:32:44Z

You can merge master to this branch and that should sort out the issue

Great, it works now.

AuroraLS3

Great work! :) I'll merge this after testing that it works one more time.

Building folia itself seems to be an hour job so feel free to test it as well 😅

I'd be interested in error free behavior of:

Plugin enable on Folia
Plugin reload /plan reload
Plugin disable
Player join + Player leave adding a Session to the website
Player join + Gamemode change + Nether portal + Player leave adding a Session with overworld time data in Survival and Creative, and nether data in creative
Player join + Server shutdown + Server start adding a Session
Server running for few minutes adding Player online count, TPS and other performance data to Performance tab

ColdeZhang · 2024-05-18T15:41:52Z

Great work! :) I'll merge this after testing that it works one more time.

Building folia itself seems to be an hour job so feel free to test it as well 😅

I'd be interested in error free behavior of:

Plugin enable on Folia

Plugin reload /plan reload

Plugin disable

Player join + Player leave adding a Session to the website

Player join + Gamemode change + Nether portal + Player leave adding a Session with overworld time data in Survival and Creative, and nether data in creative

Player join + Server shutdown + Server start adding a Session

Server running for few minutes adding Player online count, TPS and other performance data to Performance tab

Here is the folia I built my self, if you want you can use this for test.

Three of begining I have tested:

Plugin enable on Folia
Plugin reload /plan reload
Plugin disable

rest of those you can check on my own server. I am using it for several days. Eveything looks great fine,

AnttiMK · 2024-05-18T15:46:16Z

Folia is well available from official sources through PaperMC's downloads API, see for example https://api.papermc.io/v2/projects/folia/versions/1.20.4/builds/31/downloads/folia-1.20.4-31.jar

Per PaperMC, the downloads are intentionally API-only since the platform is still very experimental.

AuroraLS3 · 2024-05-18T15:47:41Z

Tested:

Plugin enable on Folia
Plugin reload /plan reload
Plugin disable
Player join + Player leave adding a Session to the website
Player join + Gamemode change + Nether portal + Player leave adding a Session with overworld time data in Survival and Creative, and nether data in creative
- ⚠️ world change event doesn't seem to trigger, leaving behind a Session with only one world, I don't know if this is due to Folia related changes
Player join + Server shutdown + Server start adding a Session
Server running for few minutes adding Player online count, TPS and other performance data to Performance tab
Plugin enabled with Java 11

ColdeZhang · 2024-05-18T15:50:44Z

Tested:

Plugin enable on Folia

Plugin reload /plan reload

Plugin disable

Player join + Player leave adding a Session to the website

Player join + Gamemode change + Nether portal + Player leave adding a Session with overworld time data in Survival and Creative, and nether data in creative

⚠️ world change event doesn't seem to trigger, leaving behind a Session with only one world, I don't know if this is due to Folia related changes

Player join + Server shutdown + Server start adding a Session

Server running for few minutes adding Player online count, TPS and other performance data to Performance tab

⚠️ world change event doesn't seem to trigger, leaving behind a Session with only one world, I don't know if this is due to Folia related changes

Yes, this event is disabled on folia currently.

AuroraLS3 · 2024-05-18T15:51:12Z

Alright then everything seems to be working as intended :)

AuroraLS3 · 2024-05-18T15:53:46Z

Thank you for all the correspondence and quick changes, it has made it easy to get this PR to the finish line & Thanks to @AnttiMK for PR review :)

ColdeZhang · 2024-05-18T15:58:20Z

The whole changeDimension was rewrited by folia. So PlayerChangedWorldEvent will not be called.

AuroraLS3 · 2024-05-18T15:59:52Z

Hopefully they will eventually sort that out, until then I'll just put a disclaimer to the change log and wiki for Folia about this data being wrong

ColdeZhang added 2 commits May 14, 2024 16:25

folia support finished

6437056

add Contributors

dca3813

ColdeZhang mentioned this pull request May 14, 2024

Folia support #2962

Closed

ColdeZhang changed the title ~~Folia support~~ adde Folia support May 14, 2024

try to use reflection to load class

8e7f6eb

finish the compatible for java11 and java 17+ (folia)

d456585

ColdeZhang added 2 commits May 16, 2024 19:20

change pal version to 5.2.0, due to the merge of folia-layer.

88e5c92

now this can be compiled by CI-CD(workflow)

Merge remote-tracking branch 'origin/folia-support-with-java11' into …

ca701f1

…folia-support

ColdeZhang added 2 commits May 17, 2024 01:19

separate folia pal to standalone gradle module

7d96865

so javadoc gen may success

made folia module skip javadoc compile

5a7d3b2

AnttiMK suggested changes May 16, 2024

View reviewed changes

take advise from AnttiMK. Thank u :)

41e878e

This comment was marked as resolved.

Sign in to view

ColdeZhang added 2 commits May 17, 2024 15:58

make folia pal with runtimeOnly

702aaa1

make folia pal with runtimeOnly

d1ba130

change jvm option

9119821

extend FileWatcherTest time await up to 5 sec

7cc597f

This comment was marked as outdated.

Sign in to view

Merge branch 'master' of https://github.com/plan-player-analytics/Plan …

71d3f3f

…into folia-support

AuroraLS3 approved these changes May 18, 2024

View reviewed changes

AuroraLS3 merged commit fefbd9a into plan-player-analytics:master May 18, 2024
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

adde Folia support #3617

adde Folia support #3617

ColdeZhang commented May 14, 2024

AuroraLS3 commented May 14, 2024

ColdeZhang commented May 14, 2024

ColdeZhang commented May 14, 2024

AuroraLS3 commented May 14, 2024

ColdeZhang commented May 14, 2024

ColdeZhang commented May 14, 2024 •

edited

AuroraLS3 commented May 14, 2024 •

edited

ColdeZhang commented May 15, 2024 •

edited

ColdeZhang commented May 16, 2024

AuroraLS3 commented May 16, 2024 •

edited

AnttiMK commented May 16, 2024

AuroraLS3 commented May 16, 2024

AnttiMK left a comment

AnttiMK May 16, 2024

ColdeZhang commented May 16, 2024

This comment was marked as resolved.

AuroraLS3 commented May 17, 2024

ColdeZhang commented May 18, 2024 •

edited

This comment was marked as outdated.

This comment was marked as outdated.

ColdeZhang commented May 18, 2024

This comment was marked as outdated.

This comment was marked as outdated.

AuroraLS3 commented May 18, 2024

ColdeZhang commented May 18, 2024

AuroraLS3 left a comment •

edited

ColdeZhang commented May 18, 2024 •

edited

AnttiMK commented May 18, 2024 •

edited

AuroraLS3 commented May 18, 2024 •

edited

ColdeZhang commented May 18, 2024

AuroraLS3 commented May 18, 2024

AuroraLS3 commented May 18, 2024

ColdeZhang commented May 18, 2024 •

edited

AuroraLS3 commented May 18, 2024

adde Folia support #3617

adde Folia support #3617

Conversation

ColdeZhang commented May 14, 2024

Your checklist for this pull request

Description

AuroraLS3 commented May 14, 2024

ColdeZhang commented May 14, 2024

ColdeZhang commented May 14, 2024

AuroraLS3 commented May 14, 2024

ColdeZhang commented May 14, 2024

ColdeZhang commented May 14, 2024 • edited

AuroraLS3 commented May 14, 2024 • edited

ColdeZhang commented May 15, 2024 • edited

ColdeZhang commented May 16, 2024

AuroraLS3 commented May 16, 2024 • edited

AnttiMK commented May 16, 2024

AuroraLS3 commented May 16, 2024

AnttiMK left a comment

Choose a reason for hiding this comment

AnttiMK May 16, 2024

Choose a reason for hiding this comment

ColdeZhang commented May 16, 2024

This comment was marked as resolved.

AuroraLS3 commented May 17, 2024

ColdeZhang commented May 18, 2024 • edited

1

2

This comment was marked as outdated.

This comment was marked as outdated.

ColdeZhang commented May 18, 2024

This comment was marked as outdated.

This comment was marked as outdated.

AuroraLS3 commented May 18, 2024

ColdeZhang commented May 18, 2024

AuroraLS3 left a comment • edited

Choose a reason for hiding this comment

ColdeZhang commented May 18, 2024 • edited

AnttiMK commented May 18, 2024 • edited

AuroraLS3 commented May 18, 2024 • edited

ColdeZhang commented May 18, 2024

AuroraLS3 commented May 18, 2024

AuroraLS3 commented May 18, 2024

ColdeZhang commented May 18, 2024 • edited

AuroraLS3 commented May 18, 2024

ColdeZhang commented May 14, 2024 •

edited

AuroraLS3 commented May 14, 2024 •

edited

ColdeZhang commented May 15, 2024 •

edited

AuroraLS3 commented May 16, 2024 •

edited

ColdeZhang commented May 18, 2024 •

edited

AuroraLS3 left a comment •

edited

ColdeZhang commented May 18, 2024 •

edited

AnttiMK commented May 18, 2024 •

edited

AuroraLS3 commented May 18, 2024 •

edited

ColdeZhang commented May 18, 2024 •

edited