Add core extensions: UserCSS, UserJS #6267

hkcomori · 2024-04-06T12:14:44Z

Closes FreshRSS/Extensions#227

Changes proposed in this pull request:

Add UserCSS, which is based on CustomCSS and changes the file storage location to the user's directory
Add UserJS, which is based on CustomJS and changes the file storage location to the user's directory

How to test the feature manually:

Confirmed that extensions can be enabled
Confirmed that CSS and JS can be written from the settings page
Confirmed that the written contents are saved in data/users/extensions/<extension-name>.
Confirmed that the written contents can be read by reopening the settings page
Confirmed that the written CSS and JS are referenced from <head>.

Pull request checklist:

clear commit messages
code manually tested
unit tests written (optional if too hard)
documentation updated

Additional information can be found in the documentation.

Original: FreshRSS/Extensions@9f21984

The name is used for the directory where the configuration is stored and should not contain spaces. Since the name was changed, I reset the version number and changed to semantic versioning.

Changed the location of the configuration file to the user data directory, because it is not `static`. That way, the user's configurations are gathered in the user directory, which makes it easier to backup them.

Remove procedures to install the extension because it is no longer necessary.

Remove permission error indication because the storage location is now in the user data directory managed by the application.

lib/core-extensions/xExtension-UserCSS/README.md

lib/core-extensions/xExtension-UserJS/metadata.json

Alkarex · 2024-04-06T13:41:32Z

Thanks! We will first issue FreshRSS 1.24 relatively soon and then address bigger changes such as this one in the edge version towards the next release

Alkarex · 2024-04-06T16:01:39Z

I have done some refactoring. Please double-check.

lib/core-extensions/UserCSS/mobile_resolution.png

lib/core-extensions/UserCSS/desktop_resolution.png

Alkarex · 2024-04-06T16:03:55Z

lib/core-extensions/UserCSS/README.md

+- 1.0.0 change rules location to user data folder; promoted to core extension
+- 0.0.1 initial version
+
+## Examples


We could consider adding something in our documentation for core extensions

OK, let's move the description to that document.
Please let me know a few things.

Can I add it to here in the "Extensions" section?

Is it acceptable to add only English, because I cannot use French?

Can I reduce some of the configuration examples, as I don't think we need many of them?

Can I remove the README for this extension?

I updated docs.

Alkarex · 2024-04-06T16:24:17Z

lib/Minz/Extension.php

+
+	/** Return the user-specific, extension-specific, file content, or null if it does not exist */
+	protected final function getFile(string $filename): ?string {
+		$content = @file_get_contents($this->getExtensionUserPath() . '/' . $filename);


In the future, we could try to see whether we could reduce the permissions for the extensions, so they can only call inherited functions

Version 0.0.1 will not be merged, so only version 1.0.0 will remain.

hkcomori · 2024-04-07T05:22:02Z

I have done some refactoring. Please double-check.

Thanks, nice refactoring.
I found some descriptions that are no longer used and I removed them.

I think it is a good idea to make some functions protected.
But I don't know if all of existing third-party extensions will not be broken.
Can we assume that they are guaranteed by unit tests?

Alkarex · 2024-04-07T12:14:32Z

Can we assume that they are guaranteed by unit tests

All the extensions of https://github.com/FreshRSS/Extensions are tested automatically, at least

Alkarex · 2024-04-07T15:07:44Z

I have made a new command to automatically test all known third-party FreshRSS extensions FreshRSS/Extensions#228

math-GH · 2024-04-08T12:38:49Z

lib/core-extensions/UserCSS/metadata.json

@@ -0,0 +1,8 @@
+{
+	"name": "UserCSS",


Could we give a better name here?
Something like "Tweak UI with CSS" or "UI Tweaker"? Please with spaces instead of CamelCases.

I do not really mind. For me something with CSS in the name would be most obvious, such as "Custom CSS"

I like CSS Tweaks and JS Tweaks, but User CSS / UserCSS and User JS / UserJS are decent enough names.

I don't mind if it is not named "UserCSS", but I did not put a space because this name will be used for the configuration file directory name.
I don't want to include spaces in any file paths.

Although the specifications will be changed, could we use $this->getEntrypoint instead of $this->getName() for the configuration file directory name?

@hkcomori That is a reasonable suggestion, thanks

Some AI suggestions:

CSS Customizer

CSS Personalizer

Flexible CSS Tuner

CSS Overwriter

CSS Remixer

Those suggestions are worse to much worse imho. :-)

OK, I changed the directory name to entrypoint and added a space to the name.

math-GH · 2024-04-11T07:15:59Z

lib/Minz/Extension.php

-		return USERS_PATH . "/{$username}/extensions/{$this->getName()}";
+		return USERS_PATH . "/{$username}/extensions/{$this->getEntrypoint()}";


Will this cause a new entry in the update.php that changes existing paths?

Could, if anyone is motivated in doing so. Might be a bit tricky to do safely, though. Another option could be to have a migration code in

FreshRSS/lib/Minz/Extension.php

Line 83 in 7aaed60

abstract public function init();

If we expect version jumps, I think it is better method suggested by @Alkarex.
But we can't have a common migration code in init(), because it will be overwritten by each extension.
So how about adding a new method that is called just before init()?

Ideally, the extensions should call the parent method parent::init() when overriding. We could fix those we know like I did in FreshRSS/Extensions#228

Ok, then I will implement the migration code in init().

It was also necessary to add migration code in handleConfigureAction() to support the use case of opening the configuration view before enabling the extension.

hkcomori added 7 commits April 6, 2024 21:38

Copy CustomCSS and CustomJS

cfec75d

Original: FreshRSS/Extensions@9f21984

Rename CustomCSS -> UserCSS

0df3bc2

Rename CustomJS -> UserJS

75915d9

Change metadata

7fd4b4f

The name is used for the directory where the configuration is stored and should not contain spaces. Since the name was changed, I reset the version number and changed to semantic versioning.

Change data directory

31231db

Changed the location of the configuration file to the user data directory, because it is not `static`. That way, the user's configurations are gathered in the user directory, which makes it easier to backup them.

Edit documentations

5b9e4de

Remove procedures to install the extension because it is no longer necessary.

Fix wrong variables in the configuration page

94a4c05

Remove permission error indication because the storage location is now in the user data directory managed by the application.

hkcomori force-pushed the user-css branch from 3dc0bc5 to 94a4c05 Compare April 6, 2024 12:38

hkcomori mentioned this pull request Apr 6, 2024

[Feature] Save CustomCSS settings to user data FreshRSS/Extensions#227

Open

Alkarex added this to the 1.25.0 milestone Apr 6, 2024

Alkarex added the Extension 🔌 label Apr 6, 2024

Alkarex reviewed Apr 6, 2024

View reviewed changes

lib/core-extensions/xExtension-UserCSS/README.md Outdated Show resolved Hide resolved

Alkarex reviewed Apr 6, 2024

View reviewed changes

lib/core-extensions/xExtension-UserJS/metadata.json Outdated Show resolved Hide resolved

Alkarex requested a review from Frenzie April 6, 2024 13:41

hkcomori added 2 commits April 6, 2024 23:15

Remove the xExtension- prefix for core extensions

0e3c2f1

Set version to 1.0.0 for UserCSS, UserJS

3fec23a

Alkarex mentioned this pull request Apr 6, 2024

Add support for extension user files #3433

Merged

4 tasks

Refactoring

a003337

Alkarex reviewed Apr 6, 2024

View reviewed changes

lib/core-extensions/UserCSS/mobile_resolution.png Outdated Show resolved Hide resolved

Alkarex reviewed Apr 6, 2024

View reviewed changes

lib/core-extensions/UserCSS/desktop_resolution.png Outdated Show resolved Hide resolved

Alkarex reviewed Apr 6, 2024

View reviewed changes

Alkarex requested a review from aledeg April 6, 2024 16:04

Alkarex reviewed Apr 6, 2024

View reviewed changes

hkcomori added 2 commits April 7, 2024 10:49

Remove unused variables

877b9b4

Remove version 0.0.1 in Changelog

bc3a6c7

Version 0.0.1 will not be merged, so only version 1.0.0 will remain.

Alkarex added 2 commits April 7, 2024 14:12

public getFileUrl

44ec83f

Merge branch 'edge' into user-css

cf5bb4f

Revert more protected

9208deb

Alkarex mentioned this pull request Apr 8, 2024

[Bug] Table styles should not affect the content #6263

Closed

Merge branch 'edge' into user-css

3e6bf3f

math-GH reviewed Apr 8, 2024

View reviewed changes

hkcomori added 6 commits April 10, 2024 23:54

Use entrypoint for extension user path instead of name

149e318

Add space to extension name

44b7aed

Add #[\Override]

3dbf035

Add explains of User CSS and User JS to docs

6133383

Remove README of User CSS and User JS

23ffc8f

Merge branch 'edge' into user-css

2829d18

math-GH reviewed Apr 11, 2024

View reviewed changes

Add migration code for extension user path

c942616

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add core extensions: UserCSS, UserJS #6267

Add core extensions: UserCSS, UserJS #6267

hkcomori commented Apr 6, 2024 •

edited

Alkarex commented Apr 6, 2024

Alkarex commented Apr 6, 2024

Alkarex Apr 6, 2024

hkcomori Apr 7, 2024

hkcomori Apr 11, 2024

Alkarex Apr 6, 2024

hkcomori commented Apr 7, 2024

Alkarex commented Apr 7, 2024

Alkarex commented Apr 7, 2024

math-GH Apr 8, 2024

Alkarex Apr 8, 2024

Frenzie Apr 8, 2024

hkcomori Apr 8, 2024

Alkarex Apr 8, 2024

hkcomori Apr 8, 2024

Frenzie Apr 8, 2024

hkcomori Apr 10, 2024

math-GH Apr 11, 2024

Alkarex Apr 11, 2024

hkcomori Apr 11, 2024

Alkarex Apr 11, 2024

hkcomori Apr 11, 2024

hkcomori Apr 11, 2024 •

edited

		return USERS_PATH . "/{$username}/extensions/{$this->getName()}";
		return USERS_PATH . "/{$username}/extensions/{$this->getEntrypoint()}";

Add core extensions: UserCSS, UserJS #6267

Are you sure you want to change the base?

Add core extensions: UserCSS, UserJS #6267

Conversation

hkcomori commented Apr 6, 2024 • edited

Alkarex commented Apr 6, 2024

Alkarex commented Apr 6, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hkcomori commented Apr 7, 2024

Alkarex commented Apr 7, 2024

Alkarex commented Apr 7, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hkcomori Apr 11, 2024 • edited

Choose a reason for hiding this comment

hkcomori commented Apr 6, 2024 •

edited

hkcomori Apr 11, 2024 •

edited