Detect and handle broken config

[nukeop]

A broken config file can easily crash the program. Nuclear should be able to detect this problem and either reset the config, or fix the broken parts. Somewhere within the code that loads the config should be a try-catch block that does this.

[haidang666]

can u give more detail like where exactly like where config file

[nukeop]

The config is managed by electron-store. Loading happens here: https://github.com/nukeop/nuclear/blob/master/packages/main/src/services/store/index.ts

[mariuscernescu]

Hi, Anybody working on this?

[nukeop]

I don't think anyone is working on it yet, do you want to take it?

[mariuscernescu]

I will give it a try, thanks.

[Pranjal-dew]

Hi, is this issue still open? Care if I take it?

[nukeop]

@Pranjal-dew how are you going to approach this?

[nukeop]

Sure, that would be great. You can find a description of the architecture here: https://nukeop.gitbook.io/nuclear/developer-resources/architecture

And the docs also have a section about contribution guidelines.

[c-jm]

Sure, that would be great. You can find a description of the architecture here: https://nukeop.gitbook.io/nuclear/developer-resources/architecture

And the docs also have a section about contribution guidelines.

On second thought I think I will have to drop the isseu for the time being.

I will reevalute a bit later.

Thanks.

[Andres-Ventura]

@nukeop Just to confirm, is anyone working on this?

[Andres-Ventura]

@nukeop I'm going to work on this.

[nukeop]

Great, I was thinking this could be solved better with versioning (this would require storing the version number in the config and allow defining migrations). Other things that will need to be versioned at some point are db schemes and the local library index.

[Andres-Ventura]

I see, I'll keep you updated if anything comes up.

[Andres-Ventura]

@nukeop Can you give me an example of the config breaking? I text you on discord too in the help channel.

[nukeop]

As the first step, you can try using JSON.parse (https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse) and checking if it returns an error.

If it does, fallback to an empty config with default values.

As a next step, we could define a schema for the config (including settings, playlists, and favorites) and check if it complies with it. If there are errors, then that part of the config can either be migrated, or reset. You can use yup for this: https://www.npmjs.com/package/yup

[nukeop]

the config should also contain a "version" key that defines what schema it should follow

[Andres-Ventura]

I see, thankyou.