refactor: reconstruct option management

[wxharry]

Brief Information

This pull request is in the type of (more info about types):

• build
• ci
• docs
• feat
• fix
• perf
• refactor
• test

Related issues (all available keywords):

• resolve [Feature] an extensible option management system #474

Details

• use val-loader to get imported features from here
• refactor options management
  • replace class with functions
  • add all imported features to the option list
  • control on/off from the feature-manager
• use webext-options-sync-per-domain to improve the option management (?)
• need consistent feature ID, especially for locale
• cache related
• docs and comments

Checklist

• I have read the CONTRIBUTING doc
• I have signed the CLA

Others

[l1tok]

Nice work! It works as soon as I cancel the option button，but there is a small problem that all the options are re-selected after refreshing.

Settings.-.Google.Chrome.2023-04-25.20-34-27.mp4

[wxharry]

Nice work! It works as soon as I cancel the option button，but there is a small problem that all the options are re-selected after refreshing.

Thank you for pointing that out. Since this pr is still WIP, i will fix it in the next few commits.

[tyn1998]

Hi @wxharry, I have learnt your code especially the "importedFeatures" part and I totally figured out the way you extracted the imported features from index.ts and injected them into a webpack module during build.

I learnt a lot about webpack loaders as well, finding that val-loader is not so necessary and features-loader.js should not be treated as a webpack module, rather it should be used as a webpack loader as its name suggests.

So I changed the code a bit, treating README.md as a module (this is how rgh does, though for now we don't extract feature list from README.md), and used features-loader.cjs to convert the README.md module so its content will be export const importedFeatures = ... after being processed by the loader. Then we can import {importedFeatures} from 'path/of/README.md' anywhere in code.

[tyn1998]

There is still a lot of room for code improvement, working in progress...

[tyn1998]

Actually, what I did last week (those 4 commits) didn't work right because I found several checked checkbox would be unchecked after page refresh this morning.

However hours work later, I hope the option manager now works. I did:

• refactored a more cohesive options-storage.ts (a single instance and be consumed everywhere, this time I vote for Class rather several functions)
• to use multiple keys to store all options, rather a single "settings" key whose value is a serialized stirng
• use chrome.storage.sync.set/get so options can be synced by google account. (we can pass [default options via get(defaults))
• other changes

More info for options-storage.ts:

Currently this file is bundled into ContentScript and Options since both require it to access option storage. ContentScript only read options, while Options read and write options.

I mentioned single above to stress that one application only needs to instantiate its configuration class (in our case, i.e. OptionsStorage) once rather multiple times as old Hypercrx did before. In fact there are two instances of OptionsStorage class for both CS and Options, because CS and Options run in different context so they are independent in terms of runtime environment.

Hi @lhbvvvvv, could you help to test this PR again?

[l1tok]

On my personal computer, the feature oss-gpt is missing whether I select it on the options list or not.

Also, I think perceptor-layout, perceptor-tab, and repo-networks can be combined into one option. The Perceptor button at the top is still displayed when the perceptor-layout and repo-networks options are not selected, however perceptor-tab option works well.

Except for those mentioned above, everything is working fine！

[tyn1998]

@lhbvvvvv Thank you for your test! I know what causes the bug and will fix it ASAP.

Also, I think perceptor-layout, perceptor-tab, and repo-networks can be combined into one option.

Considered this, but maybe improve it later :) thanks for your suggestion!

[tyn1998]

@lhbvvvvv fixed it, please verify if my patch works.

Hi @wxharry, could you give a review on my code?

[wxharry]

Hi @wxharry, could you give a review on my code?

LGTM

[l1tok]

@lhbvvvvv fixed it, please verify if my patch works.

It ran successfully without problems.

[l1tok]

LGTM! Thank you @wxharry @tyn1998