Add Module System #4573

APickledWalrus · 2022-02-03T23:18:17Z

Description

The purpose of this PR is to start discussion on implementing a new package / syntax organization system for Skript. I created this as a PR as I wanted to be able to show an idea I had.

The actual proposal in this PR is to implement a new Module class. All SkriptAddon's would have one or more modules that contain syntax, classinfos, converters, and more. Skript itself would use this module system to reorganize its syntax. Here's an example:

org.skriptlang.skript.potion
- PotionModule (loads syntax, classinfos, etc.)
- elements (subpackage)
  - ExprPotionEffects
  - EffPoison
  - etc.

What this PR changes:

Skript
- Loads any modules in new package (org.skriptlang.skript)
- Now loads hook classes (ch.njol.skript.hooks) using updated SkriptAddon load methods
SkriptAddon
- Cleaned up a lot of stuff
- Implemented new, more detailed loading methods (gives greater control over how the search is handled and how classes are loaded)
- loadClasses method can no longer throw an IOException - This change is up for debate, but I personally don't see a reason to not handle it internally (it is unlikely to ever happen anyways) - however, it it were to happen, addons no longer have a way to handle it which could be a downside
- Added a loadModules method
Module (A module is a part of a SkriptAddon containing related syntax, classinfos, converters, etc.)
- register(SkriptAddon) method
  - Called when this module is loaded, passing the SkriptAddon responsible for loading it as a parameter.
- loadSyntax methods
  - A shortcut to load syntax elements from this module
    - For example, instead of writing addon.loadClasses("org.skriptlang.skript.potion.elements") you could write loadSyntax(addon)
  - I am unsure if it is a good idea for Skript to be calling loadClasses so frequently. Perhaps it would be better off if syntax was "manually" initialized via new MySyntaxElement()

Please share any questions, feedback or ideas! This proposal is certainly not perfect, so I am looking for any ideas you may have :)

Target Minecraft Versions: N/A
Requirements: None
Related Issues:

[suggestion] - Reorganize Skript's packages #4326 (non-fixing)
🚀 Long-term plans on Skript #121 (non-fixing, this PR is just related as it (could) lay groundwork for a new Addon API)
Rework Potions #4183 (this PR is on hold as I would like it to use a new package system)

bluelhf · 2022-02-04T11:08:26Z

On the topic of modules, are there plans to modularise Skript further using JPMS?

Moderocky · 2022-02-04T11:23:32Z

JPMS

No, this is incompatible with Spigot/CB.

bluelhf · 2022-02-04T13:01:12Z

Ah, of course

Moderocky · 2022-02-10T15:44:47Z

Concerning this, we could revive Shane's old suggestion of allowing addons to be registered directly to Skript (as Modules) rather than as Bukkit plugins. Addons like skript-yaml, etc. don't need to be plugins and could save resources by just being our modules.

Moderocky · 2022-02-10T15:46:26Z

src/main/java/ch/njol/skript/Skript.java

@@ -518,42 +513,23 @@ public void onEnable() {
 			@Override
 			public void run() {
 				assert Bukkit.getWorlds().get(0).getFullTime() == tick;


What is this actually for? It's a test-only action but I can't see a comment explaining it.

Moderocky · 2022-02-10T15:47:42Z

src/main/java/ch/njol/skript/Skript.java

+				getAddonInstance().loadClasses(c -> {
+					if (Hook.class.isAssignableFrom(c) && !c.isInterface() && !Modifier.isAbstract(c.getModifiers())) {
+						try {
+							c.getDeclaredConstructor().newInstance();


I'd like to move away from using newInstance here - it's the slowest and least-reliable way of creating instances.

Moderocky · 2022-02-10T15:51:15Z

src/main/java/ch/njol/skript/SkriptAddon.java

+
+		try (final JarFile jar = new JarFile(file)) {
+			boolean hasWithClass = withClass != null;
+			for (JarEntry e : new EnumerationIterable<>(jar.entries())) {


I've been exploring a more efficient way of getting all classes within a package, will let you know on discord if it's a viable alternative.

Moderocky · 2022-02-10T15:53:58Z

src/main/java/ch/njol/skript/SkriptAddon.java

+		return loadClasses(c -> {
+			if (Module.class.isAssignableFrom(c) && !c.isInterface() && !Modifier.isAbstract(c.getModifiers())) {
+				try {
+					((Module) c.getConstructor().newInstance()).register(this);


Again, we may be able to find a better option for this.

APickledWalrus · 2022-03-05T02:09:09Z

Concerning this, we could revive Shane's old suggestion of allowing addons to be registered directly to Skript (as Modules) rather than as Bukkit plugins. Addons like skript-yaml, etc. don't need to be plugins and could save resources by just being our modules.

This a good idea but can likely be done in another PR as it requires removing SkriptAddon's dependency on JavaPlugin.

APickledWalrus · 2022-03-05T03:08:19Z

I've implemented a cache for the jar entries so that the loadClasses method is more performant when being called multiple times. Every SkriptAddon has a cache, and all caches are cleared when Skript stops accepting registrations.

src/main/java/ch/njol/skript/SkriptAddon.java

src/main/java/org/skriptlang/skript/registration/Module.java

This implements the "current" behavior

APickledWalrus · 2022-12-11T21:49:38Z

My most recent commit makes a large change to Skript's general organization. I'm proposing two new main packages: org.skriptlang.skript and org.skriptlang.skriptbukkit

In the future, skriptbukkit would contain all of the plugin related stuff whereas skript would contain the base language + any default syntax (ex: math). I'm proposing that default skript syntax would go in syntax subpackage as well.

I'd certainly like to hear thoughts on this :)

Forgot to update for Structure API

Moderocky · 2022-12-12T06:32:45Z

org.skriptlang.skript and org.skriptlang.skriptbukkit

Packages should reference the dependency ID so that it is clear where code comes from.
For example org.skriptlang.skript.maths tells us it's from skriptlang.org, it's from the skript dependency and it's about maths.
If the Bukkit parts are going to end up in their own dependency then skriptbukkit is okay, but if they're going to be part of skript they ought to go within the skript package.

It's not guaranteed

src/main/java/org/skriptlang/skript/registration/Module.java

and formatting improvements

"common" and "bukkit"

APickledWalrus · 2023-01-21T00:07:12Z

I've decided to move syntax into two primary locations within org.skriptlang.skript:

common (this is for default syntax like math)
bukkit (this is for bukkit specific syntax)

TheLimeGlass · 2023-01-26T07:22:17Z

Don't you think this should target 2.8? We should have a full package change to com.skriptlang in a major version, not just a module system, but the planned package naming all done in one version.

APickledWalrus · 2023-01-26T07:31:11Z

Don't you think this should target 2.8? We should have a full package change to com.skriptlang in a major version, not just a module system, but the planned package naming all done in one version.

We can target this for 2.8 now yes. I did not plan to move all syntax with a simple rename. It should happen over time through targeted PRs (like my potions rework) to ensure that all syntax can be updated to current standards :)

kiip1 · 2023-02-09T19:48:15Z

src/main/java/ch/njol/skript/SkriptAddon.java

+	/**
+	 * Loads all module classes found in the package search.
+	 * @param basePackage The base package to start searching in (e.g. 'ch.njol.skript').
+	 * @param subPackages Specific subpackages to search in (e.g. 'conditions').
+	 * If no subpackages are provided, all subpackages will be searched.
+	 * Note that the search will go no further than the first layer of subpackages.
+	 * @return This SkriptAddon.
+	 */
+	@SuppressWarnings("ThrowableNotThrown")
+	public SkriptAddon loadModules(String basePackage, String... subPackages) {
+		return loadClasses(basePackage, false, false, c -> {
+			if (Module.class.isAssignableFrom(c) && !c.isInterface() && !Modifier.isAbstract(c.getModifiers())) {
+				try {
+					((Module) c.getConstructor().newInstance()).register(this);
+				} catch (Exception e) {
+					Skript.exception(e, "Failed to load module " + c);
+				}
+			}
+		}, subPackages);
+	}


I would prefer an alternative to this:
a) Code generation of module registration
b) Manual module registration

If the addon discovery thing we talked about on Discord will become mainstream, a modules: ["org.example.addon.math.MathModule", ...] field can be added to addon.json.

APickledWalrus · 2023-11-20T21:30:19Z

Closing as I am planning to reintegrate this system in a more meaningful manner in #5331

Implement initial design

adaa688

APickledWalrus added feature Pull request adding a new feature. up for debate When the decision is yet to be debated on the issue in question labels Feb 3, 2022

Merge branch 'master' into feature/modules

0328f2b

Moderocky reviewed Feb 10, 2022

View reviewed changes

Merge branch 'master' into feature/modules

0e44435

Implement entry cache

78b61ca

Use an array instead for the cache

d2f75b7

APickledWalrus added the 2.7 Targeting a 2.7.X version release label Mar 23, 2022

APickledWalrus marked this pull request as draft June 3, 2022 18:40

APickledWalrus added 2 commits June 3, 2022 15:23

Merge branch 'master' into feature/modules

72e5797

It should actually build now

9a51f9f

APickledWalrus marked this pull request as ready for review June 3, 2022 19:37

Further documentation updates

3767632

Moderocky approved these changes Jul 12, 2022

View reviewed changes

APickledWalrus added 2 commits July 22, 2022 21:59

Merge branch 'master' into feature/modules

7305653

Merge branch 'master' into feature/modules

d4e01a4

TPGamesNL self-requested a review August 5, 2022 12:43

TPGamesNL requested changes Aug 5, 2022

View reviewed changes

APickledWalrus added 3 commits August 5, 2022 13:57

Improvements and fixes from review

2a3f6d0

Only open JarFile if necessary

803eeb9

Make entry cache not contain null elements

c08c4a6

This implements the "current" behavior

APickledWalrus requested a review from TPGamesNL August 21, 2022 18:48

APickledWalrus mentioned this pull request Sep 28, 2022

Rework Potions #4183

Draft

APickledWalrus added 2 commits December 11, 2022 16:37

Merge remote-tracking branch 'upstream/master' into feature/modules

3038c51

Change default syntax locations

10973c4

Fix loading

d6206e2

Forgot to update for Structure API

Moderocky requested a review from UnderscoreTud December 26, 2022 18:51

Remove throws clause

4ac2d16

It's not guaranteed

APickledWalrus commented Jan 5, 2023

View reviewed changes

src/main/java/org/skriptlang/skript/registration/Module.java Outdated Show resolved Hide resolved

APickledWalrus added 2 commits January 20, 2023 19:02

Convert Module to Interface

2712285

and formatting improvements

Change default syntax locations

66de7cd

"common" and "bukkit"

APickledWalrus requested a review from TheLimeGlass January 21, 2023 00:07

APickledWalrus mentioned this pull request Jan 26, 2023

Adds back the JUnit testing system #4979

Merged

APickledWalrus added 2.8 Targeting a 2.8.X version release and removed 2.7 Targeting a 2.7.X version release labels Jan 26, 2023

kiip1 reviewed Feb 9, 2023

View reviewed changes

Moderocky force-pushed the master branch 2 times, most recently from bd134d0 to 3f08853 Compare September 16, 2023 16:59

APickledWalrus changed the base branch from master to dev/feature September 16, 2023 18:17

APickledWalrus closed this Nov 20, 2023

APickledWalrus mentioned this pull request Dec 22, 2023

New Registration API #6246

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Module System #4573

Add Module System #4573

APickledWalrus commented Feb 3, 2022

bluelhf commented Feb 4, 2022

Moderocky commented Feb 4, 2022 •

edited

bluelhf commented Feb 4, 2022

Moderocky commented Feb 10, 2022

Moderocky Feb 10, 2022

Moderocky Feb 10, 2022

Moderocky Feb 10, 2022

Moderocky Feb 10, 2022

APickledWalrus commented Mar 5, 2022

APickledWalrus commented Mar 5, 2022

APickledWalrus commented Dec 11, 2022 •

edited

Moderocky commented Dec 12, 2022 •

edited

APickledWalrus commented Jan 21, 2023

TheLimeGlass commented Jan 26, 2023

APickledWalrus commented Jan 26, 2023

kiip1 Feb 9, 2023

kiip1 Feb 9, 2023

APickledWalrus commented Nov 20, 2023

Add Module System #4573

Add Module System #4573

Conversation

APickledWalrus commented Feb 3, 2022

Description

Please share any questions, feedback or ideas! This proposal is certainly not perfect, so I am looking for any ideas you may have :)

bluelhf commented Feb 4, 2022

Moderocky commented Feb 4, 2022 • edited

bluelhf commented Feb 4, 2022

Moderocky commented Feb 10, 2022

Moderocky Feb 10, 2022

Choose a reason for hiding this comment

Moderocky Feb 10, 2022

Choose a reason for hiding this comment

Moderocky Feb 10, 2022

Choose a reason for hiding this comment

Moderocky Feb 10, 2022

Choose a reason for hiding this comment

APickledWalrus commented Mar 5, 2022

APickledWalrus commented Mar 5, 2022

APickledWalrus commented Dec 11, 2022 • edited

Moderocky commented Dec 12, 2022 • edited

APickledWalrus commented Jan 21, 2023

TheLimeGlass commented Jan 26, 2023

APickledWalrus commented Jan 26, 2023

kiip1 Feb 9, 2023

Choose a reason for hiding this comment

kiip1 Feb 9, 2023

Choose a reason for hiding this comment

APickledWalrus commented Nov 20, 2023

Moderocky commented Feb 4, 2022 •

edited

APickledWalrus commented Dec 11, 2022 •

edited

Moderocky commented Dec 12, 2022 •

edited