Script type & expression. #6702

Moderocky · 2024-05-17T16:58:24Z

Description

The first step towards supporting proper reflection & introspection: a type and object handles for scripts.

This adds:

A script type.
- Internal dummy Script objects for disabled/unlinked scripts.
A feature flag [script] reflection for most linked features & breaking changes.
Internal Validated interface to be used by scripts and other resources that could become obsolete. This is purely a testing API right now.
An expression for [the] [current] script, [the] script[s] [named] %strings%.
Handler for the name property of scripts.
- If the feature flag is disabled, returns exactly what name of script did, e.g. scripts/folder/MyScript.sk -> folder/MyScript.
- Otherwise, returns the name of the file without its path/extension, e.g. scripts/folder/MyScript.sk -> MyScript.
- The path-relative version is available by just stringifying a script object now.
The enable/disable/reload script effects now take in a script object in preference to a string (which equates to its original syntax).
- This uses the internal Script dummy object for disabled scripts.
The legacy enable/disable script pattern has been separated into a more reasonable arrangement.
- Technically, this is a breaking change, since you can no longer do enable skript "hello.sk"
- I found the mixing of skript and script to be unhelpful and confusing, people might mistake reload skript ... to mean reloading Skript, when it was actually for files.
- Now, it explicitly takes a skript file ..., or script... to make that clearer.
Tests for all of the above.

Breaking Changes

The enable|disable skript %string% pattern variation was removed. You can still use skript file or script.

Resource safety has been significantly improved: there were basically zero checks on what you tried to reload/disable previously. If it wasn't a valid file it would throw huge exceptions, and if it was it would just get processed without any kind of safety checks.

Enabling a non-disabled-script-file would just remove the first character of its name and try to parse it. Obviously, this has been corrected.
It was (previously) fine to enable or disable files outside the working directory. This could be open to significant exploit, so now file paths are checked vs. the canonical scripts/ directory (unless you're running in Test mode!)
- I'm sure some people were using this meaningfully to load external scripts, but it really just shouldn't be permissible. Fortunately, the next change should help with that.
Attempting to load a loaded script, unload a non-loaded script, etc. would previously throw a massive error. Now it will silently skip them.

With the experiment enabled, unloading is now considered different from disabling in syntax: disabling a script will unload it and prepend - to its file name. Unloading it will just unload it from memory (but not disable it, so it would load normally upon next restart).

Where Next?

This could be the start of some reflection.
I'd like to see a bit of introspection in the future (maybe looking at what structures are in a script, some features from Config, etc.)

There was some discussion about some other reflective stuff (like dynamic function calls) which would probably tie into this quite nicely. I've opened a branch for anybody who wants it.

This could move in the direction of runtime-parsed scripts, anonymous scripts, etc.

I'm also wondering about abstracting some kind of loadable interface (or maybe just use Config) so that we can permit the [re]loading of other Skript-related things that can be loaded (aliases, config, etc.)
I don't have any plans for the loading of non-script-provided files (e.g. a user-provided config .sk file) at this point, but if I abstracted this back a layer then it would be really easy (for an addon) to provide that in the future if somebody wants to.

Target Minecraft Versions: any
Requirements: none
Related Issues: none

APickledWalrus

quick first impressions

src/main/java/ch/njol/skript/expressions/ExprScript.java

src/test/skript/tests/misc/-disabled.sk

src/test/skript/tests/syntaxes/expressions/ExprName.sk

src/main/java/ch/njol/skript/expressions/ExprScript.java

src/main/java/ch/njol/skript/effects/EffScriptFile.java

src/main/java/ch/njol/skript/expressions/ExprScriptsNew.java

src/main/java/ch/njol/skript/expressions/ExprScript.java

Co-authored-by: Patrick Miller <apickledwalrus@gmail.com>

sovdeeth · 2024-11-15T23:54:30Z

damnit i can never merge properly
sorry kenzie

APickledWalrus

Looking very nice. This is a good candidate for a module. It should be able to go in org.skriptlang.skript.common.script.ScriptModule. License headers can be removed too.

src/main/java/ch/njol/skript/classes/data/SkriptClasses.java

src/main/java/ch/njol/skript/conditions/CondIsLoaded.java

src/main/resources/lang/default.lang

src/main/java/ch/njol/skript/expressions/ExprScript.java

src/main/java/ch/njol/skript/expressions/ExprScripts.java

Co-authored-by: Patrick Miller <apickledwalrus@gmail.com>

APickledWalrus

A few minor things. Looking good!

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

src/main/java/ch/njol/skript/effects/EffScriptFile.java

src/main/java/ch/njol/skript/expressions/ExprScript.java

src/main/java/ch/njol/skript/expressions/ExprScripts.java

Moderocky

Very good (approved)

* Create Script type. * Support script string/name conversion. * Script expression. * Add script lang entry. * Tests for script expression & names. * Support all scripts expression. * Script effects & tests. * Create dummy Script handle for disabled scripts. * Script reflection feature flag. * Restrict literal parsing to commands & parse. * Test feature flag for resolving name. * Split ExprScripts by feature to support disabled scripts. * Fix ExprName tests for new & old behaviour. * Add tests for disabled script handles. * Apply suggestions from code review Co-authored-by: Patrick Miller <apickledwalrus@gmail.com> * Improve script loading/unloading safety. * Add feature check for script hotswapping. * Use expression stream. * Conformity for file names and proper loading safety. * Document validity & add condition support. * Add script is loaded condition + tests. * Some changes from code review. * More changes. * Apply suggestions from code review Co-authored-by: Patrick Miller <apickledwalrus@gmail.com> * Clean up EffScriptFile and rename ExprScripts variations. * Finish code review changes. * Clean up script loader stuff. * Fix conflicts. * Suggested changes. * Apply suggestions from code review Co-authored-by: Patrick Miller <apickledwalrus@gmail.com> * Finished. --------- Co-authored-by: Patrick Miller <apickledwalrus@gmail.com> Co-authored-by: sovdee <10354869+sovdeeth@users.noreply.github.com>

Moderocky added enhancement Feature request, an issue about something that could be improved, or a PR improving something. breaking changes Pull or feature requests that contain breaking changes (API, syntax, etc.) labels May 17, 2024

Moderocky requested review from sovdeeth, AyhamAl-Ali, Pikachu920, APickledWalrus, TPGamesNL and UnderscoreTud May 17, 2024 16:58

APickledWalrus changed the base branch from master to dev/feature May 17, 2024 17:00

Moderocky changed the base branch from dev/feature to feature/script-reflection May 17, 2024 17:04

APickledWalrus requested changes May 17, 2024

View reviewed changes

Moderocky added 14 commits May 18, 2024 10:24

Create Script type.

106c555

Support script string/name conversion.

fe9a1fb

Script expression.

da4d4b1

Add script lang entry.

ef742cc

Tests for script expression & names.

571d302

Support all scripts expression.

5da3884

Script effects & tests.

deb484c

Create dummy Script handle for disabled scripts.

f1c0c72

Script reflection feature flag.

6c5a55a

Restrict literal parsing to commands & parse.

e0debc8

Test feature flag for resolving name.

5a692e3

Split ExprScripts by feature to support disabled scripts.

e9c7b74

Fix ExprName tests for new & old behaviour.

1b54e08

Add tests for disabled script handles.

064f1ce

Moderocky force-pushed the script-object-type branch from 609bac0 to 064f1ce Compare May 18, 2024 10:11

Moderocky requested a review from APickledWalrus May 18, 2024 10:12

Moderocky commented May 18, 2024

View reviewed changes

src/main/java/ch/njol/skript/expressions/ExprScriptsNew.java Outdated Show resolved Hide resolved

Moderocky commented May 18, 2024

View reviewed changes

src/main/java/ch/njol/skript/expressions/ExprScript.java Show resolved Hide resolved

Apply suggestions from code review

c46a5c9

Co-authored-by: Patrick Miller <apickledwalrus@gmail.com>

Moderocky and others added 3 commits August 19, 2024 15:15

Clean up EffScriptFile and rename ExprScripts variations.

463ee38

Finish code review changes.

3d3b327

Merge branch 'feature/script-reflection' into script-object-type

e9db79d

Moderocky requested review from Romitou, Efnilite, Pesekjak, cheeezburga and TenFont November 17, 2024 20:13

APickledWalrus requested changes Nov 20, 2024

View reviewed changes

Moderocky and others added 5 commits November 20, 2024 13:17

Merge branch 'feature/script-reflection' into script-object-type

7e54283

Clean up script loader stuff.

592439d

Fix conflicts.

e1e1317

Suggested changes.

de90877

Apply suggestions from code review

028b0da

Co-authored-by: Patrick Miller <apickledwalrus@gmail.com>

Moderocky requested a review from APickledWalrus November 20, 2024 13:47

APickledWalrus requested changes Nov 20, 2024

View reviewed changes

Finished.

e2564d5

Moderocky commented Nov 21, 2024

View reviewed changes

Moderocky merged commit 6099204 into SkriptLang:feature/script-reflection Nov 21, 2024
5 checks passed

Moderocky deleted the script-object-type branch November 21, 2024 08:03

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Script type & expression. #6702

Script type & expression. #6702

Moderocky commented May 17, 2024 •

edited

Loading

APickledWalrus left a comment

sovdeeth commented Nov 15, 2024

APickledWalrus left a comment

APickledWalrus left a comment

Moderocky left a comment

Script type & expression. #6702

Script type & expression. #6702

Conversation

Moderocky commented May 17, 2024 • edited Loading

Description

Breaking Changes

Where Next?

APickledWalrus left a comment

Choose a reason for hiding this comment

sovdeeth commented Nov 15, 2024

APickledWalrus left a comment

Choose a reason for hiding this comment

APickledWalrus left a comment

Choose a reason for hiding this comment

Moderocky left a comment

Choose a reason for hiding this comment

Moderocky commented May 17, 2024 •

edited

Loading