Extensions: Permissions + explanations #166

New Issue

Dalai Felinto · 2024-06-04T11:58:35+02:00

Dalai Felinto commented

2024-06-04 11:58:35 +02:00

We want to support (require even) each required permission to be presented with the justification for that particular resource.

Excert from the proposed manifest schema:

   ## Optional: add-ons can list which resources they will require:
   ## * files (for access of any filesystem operations)
   ## * network (for internet access) - Remember to also check `bpy.app.online_access`
   ## * clipboard (to read and/or write the system clipboard)
   ## * camera (to capture photos and videos)
   ## * microphone (to capture audio)
   ##
   ## For each permission it is important to also specify the reason why it is required.
   ## Keep this a single short sentence without a period (.) at the end.
   ## For longer explanations use the documentation or detail page.
   #
   # [permissions]
   # network = "Need to sync motion-capture data to server"
   # files = "Import/export FBX from/to disk"
   # clipboard = "Copy and paste bone transforms"

While having permissions is optional, once you declare one its reasoning is also required.
The reason is a mandatory string, max length=64 (same as the extension tagline), without a period(.) at the end.

We want to support (require even) each required permission to be presented with the justification for that particular resource. Excert from the proposed manifest schema: ``` ## Optional: add-ons can list which resources they will require: ## * files (for access of any filesystem operations) ## * network (for internet access) - Remember to also check `bpy.app.online_access` ## * clipboard (to read and/or write the system clipboard) ## * camera (to capture photos and videos) ## * microphone (to capture audio) ## ## For each permission it is important to also specify the reason why it is required. ## Keep this a single short sentence without a period (.) at the end. ## For longer explanations use the documentation or detail page. # # [permissions] # network = "Need to sync motion-capture data to server" # files = "Import/export FBX from/to disk" # clipboard = "Copy and paste bone transforms" ``` While having permissions is optional, once you declare one its reasoning is also required. The reason is a mandatory string, max length=64 (same as the extension tagline), without a period(.) at the end.

Dalai Felinto referenced this issue

2024-06-04 12:02:34 +02:00

Extensions Website - Backend Road to Beta #70

Dalai Felinto referenced this issue from blender/blender

2024-06-04 12:02:59 +02:00

Extensions Platform: beta launch #119521

Oleg-Komarov commented

2024-06-04 12:07:00 +02:00

Should the permission descriptions be shown anywhere on the website? This would require more changes to the model and design.

Dalai Felinto commented

2024-06-04 12:45:24 +02:00

I would expect so, yes (otherwise it would be pointless to have them).

Oleg-Komarov commented

2024-06-04 13:19:06 +02:00

we should fix the example: file should be files

we should fix the example: `file` should be `files`

Oleg-Komarov commented

2024-06-04 16:04:15 +02:00

We should also settle on the vocabulary - it will be used in error messages and should be the same in the docs:
how do we call the string - is it reason or explanation or description?

I started using word "reason" in the validation code, but can change it if we want rephrase the docs.

We should also settle on the vocabulary - it will be used in error messages and should be the same in the docs: how do we call the string - is it reason or explanation or description? I started using word "reason" in the validation code, but can change it if we want rephrase the docs.

Oleg-Komarov referenced this issue

2024-06-04 16:37:00 +02:00

Permissions: change from list to key/value pairs in manifest #168

Oleg-Komarov referenced this issue from a commit

2024-06-04 17:34:33 +02:00

Permissions: change from list to key/value pairs in manifest (#168)

Oleg-Komarov commented

2024-06-04 17:38:08 +02:00

deployed #168

Pablo Vazquez commented

2024-06-05 19:25:56 +02:00

we should fix the example: file should be files

Fixed.

https://docs.blender.org/manual/en/dev/advanced/extensions/getting_started.html#manifest

> we should fix the example: `file` should be `files` [Fixed](https://projects.blender.org/blender/blender-manual/commit/6c0a76526e69cde268bfd6b8f47a7f43fa538293). https://docs.blender.org/manual/en/dev/advanced/extensions/getting_started.html#manifest

Oleg-Komarov commented

2024-06-06 10:23:29 +02:00

Next steps:

update the metadata field for extensions that already have permissions defined in the old format, so we don't expect both cases in the code that looks it up
replace the Permission.help used in templates and API with the reason stored in Version.file.metadata (populated from manifest on version upload)

used this script to update metadata:

from extensions.models import Version, VersionPermission

permission_help = {p.slug: p.help for p in VersionPermission.objects.all()}
versions = Version.objects.select_related('file').all()

for version in versions:
    if 'permissions' in version.file.metadata and not isinstance(version.file.metadata['permissions'], dict):
        old = version.file.metadata['permissions']
        new = dict()
        for permission in old:
            new[permission] = permission_help[permission]
        version.file.metadata['permissions'] = new
        print(f"updating Version pk={version.pk} from {old} to {new}")
        version.file.save(update_fields={'metadata'})

Next steps: - [x] update the metadata field for extensions that already have permissions defined in the old format, so we don't expect both cases in the code that looks it up - [x] replace the Permission.help used in templates and API with the reason stored in Version.file.metadata (populated from manifest on version upload) used this script to update metadata: ``` from extensions.models import Version, VersionPermission permission_help = {p.slug: p.help for p in VersionPermission.objects.all()} versions = Version.objects.select_related('file').all() for version in versions: if 'permissions' in version.file.metadata and not isinstance(version.file.metadata['permissions'], dict): old = version.file.metadata['permissions'] new = dict() for permission in old: new[permission] = permission_help[permission] version.file.metadata['permissions'] = new print(f"updating Version pk={version.pk} from {old} to {new}") version.file.save(update_fields={'metadata'}) ```

Oleg-Komarov referenced this issue from a commit

2024-06-06 11:59:54 +02:00

API: use permission reasons stored in manifest #166

Oleg-Komarov self-assigned this 2024-06-06 12:11:44 +02:00

Oleg-Komarov commented

2024-06-06 12:54:24 +02:00

All fixes deployed

Oleg-Komarov closed this issue

2024-06-06 12:54:25 +02:00

Sign in to join this conversation.