Find invalid JSON environment entries in stored AYON applications settings

ayon_applications_find_invalid_environment_json.py

import ayon_api
import json

addon_name = "applications"
addons = ayon_api.get_addons_info()["addons"]
applications_addon = next(addon for addon in addons if addon["name"] == addon_name)
variants = ["production", "staging"]  # ignore dev bundles for now
for addon_version, version_info in applications_addon["versions"].items():
    if not version_info["hasSettings"]:
        continue
        
    for variant in variants:
        response = ayon_api.get(f"addons/{addon_name}/{addon_version}/rawOverrides", variant=variant)
        overrides = response.data
        if not overrides:
            continue
        
        # For the overrides, find all the 'environment' keys
        def traverse(d, path=""):
            """Simple settings dict traversal
            
            Yields each settings path with its value.
            """
            if isinstance(d, dict):
                for key, value in d.items():
                    for result in traverse(value, path=f"{path}/{key}"):
                        yield result
            elif isinstance(d, list):
                for i, value in enumerate(d):
                    for result in traverse(value, path=f"{path}/{i}"):
                        yield result
            yield path, d

        # Get invalid entries by testing a json decode
        invalid = []
        for path, data in traverse(overrides, path=f"ayon+settings://{addon_name}"):
            if path.endswith("/environment") and isinstance(data, str):
                # Assuming this is an enviroment value, let's validate it
                try:
                    json.loads(data)
                except json.JSONDecodeError as exc:
                    invalid.append((path, data, exc))
        
        # Print invalid entries  
        if invalid:
            print(f"### {addon_name} {addon_version} [{variant}]\n")
            for path, data, exc in invalid:
                print(f"Key: `{path}`")
                print("```json")
                print(data)
                print("```")
                print("Error:", exc)
                print("")

How to

You can run the above Python script in AYON Launcher's > Admin > Console.

Result

Example output is in Markdown, like:

### applications 1.1.0 [production]

Key: `ayon+settings://applications/applications/adsk_3dsmax/environment`
```json
{} dsa
```
Error: Extra data: line 1 column 4 (char 3)

### applications 1.1.0 [staging]

Key: `ayon+settings://applications/applications/adsk_3dsmax/environment`
```json
{} dsa
```
Error: Extra data: line 1 column 4 (char 3)

Which becomes:

applications 1.1.0 [production]

Key: ayon+settings://applications/applications/adsk_3dsmax/environment

{} dsa

Error: Extra data: line 1 column 4 (char 3)

applications 1.1.0 [staging]

Key: ayon+settings://applications/applications/adsk_3dsmax/environment

{} dsa

Error: Extra data: line 1 column 4 (char 3)

Still stuck?

You can paste the individual JSON blocks if they are invalid to e.g. https://jsonlint.com/ or just ask ChatGPT to find what's wrong with the JSON - most likely it'll do a fine job explaining what's wrong.