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

Oleg-Komarov · 2024-06-04T16:37:00+02:00

Oleg-Komarov commented

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

This PR changes validation rules for permissions field of the manifest.
When present, the field is expected to represent a dictionary of {slug: reason}
key-value pairs. Previous format was a list of [slug].

Validation for these reason strings ensures that a reason is a non-empty string,
no longer than 64 characters, and doesn't end in punctuation.

No visible changes on the website are done in this PR.
/api/v1/extensions/ endpoint now returns permissions field as a dict
{slug: reason}, where reason is taken from VersionPermission.help field
managed via admin.

The new values are stored in metadata, but the Version.permissions model
is not changing yet, and thus it doesn't store the reason values.
We can decide to keep the model as is and lookup the reasons from
Version.file.metadata, but this needs more thought.

See #166 This PR changes validation rules for `permissions` field of the manifest. When present, the field is expected to represent a dictionary of {slug: reason} key-value pairs. Previous format was a list of [slug]. Validation for these reason strings ensures that a reason is a non-empty string, no longer than 64 characters, and doesn't end in punctuation. No visible changes on the website are done in this PR. `/api/v1/extensions/` endpoint now returns `permissions` field as a dict {slug: reason}, where reason is taken from `VersionPermission.help` field managed via admin. The new values are stored in metadata, but the `Version.permissions` model is not changing yet, and thus it doesn't store the reason values. We can decide to keep the model as is and lookup the reasons from `Version.file.metadata`, but this needs more thought.

Oleg-Komarov added 5 commits 2024-06-04 16:37:01 +02:00

update manifest PermissionsValidator, keep Version.permissions field as is 1d3cd0ee83

tests for reason validation 767added7e

test: permissions saved in file metadata dc298d5c8a

fix typo 656b4899ec

add comment about the permissions mismatch in model and manifest ad9761713c

Oleg-Komarov added 1 commit 2024-06-04 17:17:30 +02:00

better stub for api: use help text 944284520b

Anna Sirota approved these changes 2024-06-04 17:34:04 +02:00

Anna Sirota left a comment

LGTM

Oleg-Komarov merged commit e3ca4daed7 into main