Feature: Extend Partial Perms

jsapp/js/components/permissions/permConstants.ts

@@ -81,21 +81,50 @@ type CheckboxNameRegular =
   | 'submissionsEdit'
   | 'submissionsValidate'
   | 'submissionsDelete';
-/** Names of checkboxes for partial permissions (the counterparts). */
+/** Names of checkboxes for "by users" partial permissions. */
 export type CheckboxNamePartialByUsers =
   | 'submissionsViewPartialByUsers'
   | 'submissionsEditPartialByUsers'
   | 'submissionsValidatePartialByUsers'
   | 'submissionsDeletePartialByUsers';
+/** Names of checkboxes for "by responses" partial permissions. */
+export type CheckboxNamePartialByResponses =
+  | 'submissionsViewPartialByResponses'
+  | 'submissionsEditPartialByResponses'
+  | 'submissionsValidatePartialByResponses'
+  | 'submissionsDeletePartialByResponses';
 /** All checkboxes names combined. */
-export type CheckboxNameAll = CheckboxNameRegular | CheckboxNamePartialByUsers;
-/** Name of lists of usernames for a partial permissions checkboxes. */
+export type CheckboxNameAll =
+  | CheckboxNameRegular
+  | CheckboxNamePartialByUsers
+  | CheckboxNamePartialByResponses;
+
+/** Name of lists of usernames for "by users" partial permissions checkboxes. */
 export type PartialByUsersListName =
   | 'submissionsViewPartialByUsersList'
   | 'submissionsEditPartialByUsersList'
   | 'submissionsDeletePartialByUsersList'
   | 'submissionsValidatePartialByUsersList';
 
+/**
+ * Name of select used by user to choose question for "by responses" partial
+ * permissions checkboxes.
+ */
+export type PartialByResponsesQuestionName =
+  | 'submissionsViewPartialByResponsesQuestion'
+  | 'submissionsEditPartialByResponsesQuestion'
+  | 'submissionsDeletePartialByResponsesQuestion'
+  | 'submissionsValidatePartialByResponsesQuestion';
+/**
+ * Name of textbox used by user to type the condition value for "by responses"
+ * partial permissions checkboxes.
+ */
+export type PartialByResponsesValueName =
+  | 'submissionsViewPartialByResponsesValue'
+  | 'submissionsEditPartialByResponsesValue'
+  | 'submissionsDeletePartialByResponsesValue'
+  | 'submissionsValidatePartialByResponsesValue';
+
 /**
  * This list contains the names of all the checkboxes in userAssetPermsEditor.
  * Every one of them is strictly connected to a permission, see the pairs at
@@ -108,17 +137,22 @@ export const CHECKBOX_NAMES = createEnum([
   'submissionsAdd',
   'submissionsView',
   'submissionsViewPartialByUsers',
+  'submissionsViewPartialByResponses',
   'submissionsEdit',
   'submissionsEditPartialByUsers',
+  'submissionsEditPartialByResponses',
   'submissionsValidate',
   'submissionsValidatePartialByUsers',
+  'submissionsValidatePartialByResponses',
   'submissionsDelete',
   'submissionsDeletePartialByUsers',
+  'submissionsDeletePartialByResponses',
 ]) as {[P in CheckboxNameAll]: CheckboxNameAll};
 Object.freeze(CHECKBOX_NAMES);
 
 /**
- * This is a map of pairs that connects a partial checkbox to a permission.
+ * This is a map of pairs that connects a partial "by users" checkbox to
+ * a matching permission.
  *
  * NOTE: a partial checkbox is using a "partial_submissions" permission, but
  * in the array of de facto permissions it is using these ones. So for example
@@ -127,15 +161,29 @@ Object.freeze(CHECKBOX_NAMES);
  * and a view_submissions permission - meaning that "Joe can view submissions,
  * but only for this limited list of users".
  */
-export const PARTIAL_PERM_PAIRS: {
+export const PARTIAL_BY_USERS_PERM_PAIRS: {
   [key in CheckboxNamePartialByUsers]: PermissionCodename;
 } = {
   submissionsViewPartialByUsers: 'view_submissions',
   submissionsEditPartialByUsers: 'change_submissions',
   submissionsValidatePartialByUsers: 'validate_submissions',
   submissionsDeletePartialByUsers: 'delete_submissions',
 };
-Object.freeze(PARTIAL_PERM_PAIRS);
+Object.freeze(PARTIAL_BY_USERS_PERM_PAIRS);
+
+/**
+ * This is a map of pairs that connects a partial "by responses" checkbox to
+ * a matching permission.
+ */
+export const PARTIAL_BY_RESPONSES_PERM_PAIRS: {
+  [key in CheckboxNamePartialByResponses]: PermissionCodename;
+} = {
+  submissionsViewPartialByResponses: 'view_submissions',
+  submissionsEditPartialByResponses: 'change_submissions',
+  submissionsValidatePartialByResponses: 'validate_submissions',
+  submissionsDeletePartialByResponses: 'delete_submissions',
+};
+Object.freeze(PARTIAL_BY_RESPONSES_PERM_PAIRS);
 
 /**
  * This is a map of pairs that connect a checkbox name to a permission name.
@@ -149,12 +197,16 @@ export const CHECKBOX_PERM_PAIRS: {
   submissionsAdd: 'add_submissions',
   submissionsView: 'view_submissions',
   submissionsViewPartialByUsers: 'partial_submissions',
+  submissionsViewPartialByResponses: 'partial_submissions',
   submissionsEdit: 'change_submissions',
   submissionsEditPartialByUsers: 'partial_submissions',
+  submissionsEditPartialByResponses: 'partial_submissions',
   submissionsValidate: 'validate_submissions',
   submissionsValidatePartialByUsers: 'partial_submissions',
+  submissionsValidatePartialByResponses: 'partial_submissions',
   submissionsDelete: 'delete_submissions',
   submissionsDeletePartialByUsers: 'partial_submissions',
+  submissionsDeletePartialByResponses: 'partial_submissions',
 };
 Object.freeze(CHECKBOX_PERM_PAIRS);
 
@@ -164,6 +216,8 @@ Object.freeze(CHECKBOX_PERM_PAIRS);
  */
 export const PARTIAL_IMPLIED_CHECKBOX_PAIRS = {
   [CHECKBOX_NAMES.submissionsEditPartialByUsers]: CHECKBOX_NAMES.submissionsAdd,
+  [CHECKBOX_NAMES.submissionsEditPartialByResponses]:
+    CHECKBOX_NAMES.submissionsAdd,
 };
 Object.freeze(PARTIAL_IMPLIED_CHECKBOX_PAIRS);
 
@@ -180,19 +234,39 @@ export const CHECKBOX_LABELS: {[key in CheckboxNameAll]: string} = {
   submissionsAdd: t('Add submissions'),
   submissionsView: t('View submissions'),
   submissionsViewPartialByUsers: t('View submissions only from specific users'),
+  submissionsViewPartialByResponses: t('View submissions based on a condition'),
   submissionsEdit: t('Edit submissions'),
   submissionsEditPartialByUsers: t('Edit submissions only from specific users'),
+  submissionsEditPartialByResponses: t('Edit submissions based on a condition'),
   submissionsValidate: t('Validate submissions'),
   submissionsValidatePartialByUsers: t(
     'Validate submissions only from specific users'
   ),
+  submissionsValidatePartialByResponses: t(
+    'Validate submissions based on a condition'
+  ),
   submissionsDelete: t('Delete submissions'),
   submissionsDeletePartialByUsers: t(
     'Delete submissions only from specific users'
   ),
+  submissionsDeletePartialByResponses: t(
+    'Delete submissions based on a condition'
+  ),
 };
 Object.freeze(CHECKBOX_LABELS);
 
-export const PARTIAL_BY_USERS_DEFAULT_LABEL = t(
+export const PARTIAL_BY_USERS_LABEL = t(
   'Act on submissions only from specific users'
 );
+
+export const PARTIAL_BY_RESPONSES_LABEL = t(
+  'Act on submissions based on a condition'
+);
+
+// To be used when there are multiple filters in single permission - e.g. it has
+// both "by users" and "by responses" defined.
+export const PARTIAL_BY_MULTIPLE_LABEL = t(
+  'Act on submissions based on multiple conditions'
+);
+
+export const CHECKBOX_DISABLED_SUFFIX = 'Disabled';

jsapp/js/components/permissions/permParser.mocks.ts

@@ -1,4 +1,8 @@
-import type {PermissionsConfigResponse} from 'js/dataInterface';
+import type {
+  PermissionsConfigResponse,
+  PaginatedResponse,
+  PermissionResponse,
+} from 'js/dataInterface';
 
 /**
  * Mock permissions endpoints responses for tests.
@@ -111,7 +115,7 @@ const permissions: PermissionsConfigResponse = {
 };
 
 // /api/v2/assets/<uid>/permission-assignments/
-const assetWithAnonymousUser = {
+const assetWithAnonymousUser: PaginatedResponse<PermissionResponse> = {
   count: 7,
   next: null,
   previous: null,
@@ -162,7 +166,7 @@ const assetWithAnonymousUser = {
 };
 
 // /api/v2/assets/<uid>/permission-assignments/
-const assetWithMultipleUsers = {
+const assetWithMultipleUsers: PaginatedResponse<PermissionResponse> = {
   count: 9,
   next: null,
   previous: null,
@@ -231,7 +235,7 @@ const assetWithMultipleUsers = {
 };
 
 // /api/v2/assets/<uid>/permission-assignments/
-const assetWithPartial = {
+const assetWithPartial: PaginatedResponse<PermissionResponse> = {
   count: 8,
   next: null,
   previous: null,
@@ -288,7 +292,74 @@ const assetWithPartial = {
           url: '/api/v2/permissions/view_submissions/',
           filters: [{_submitted_by: {$in: ['john', 'olivier']}}],
         },
+        {
+          url: '/api/v2/permissions/change_submissions/',
+          filters: [{Where_are_you_from: 'Poland'}],
+        },
+      ],
+    },
+  ],
+};
+
+// /api/v2/assets/<uid>/permission-assignments/
+const assetWithMultiplePartial: PaginatedResponse<PermissionResponse> = {
+  count: 3,
+  next: null,
+  previous: null,
+  results: [
+    {
+      url: '/api/v2/assets/abc123/permission-assignments/asd123/',
+      user: '/api/v2/users/gwyneth/',
+      permission: '/api/v2/permissions/add_submissions/',
+      label: 'Add submissions',
+    },
+    {
+      url: '/api/v2/assets/abc123/permission-assignments/vbn123/',
+      user: '/api/v2/users/gwyneth/',
+      permission: '/api/v2/permissions/partial_submissions/',
+      partial_permissions: [
+        // This permission is the AND one, which is the only case supported by
+        // Front-end code
+        {
+          url: '/api/v2/permissions/view_submissions/',
+          filters: [
+            {
+              Where_are_you_from: 'Poland',
+              _submitted_by: {$in: ['dave', 'krzysztof']},
+            },
+          ],
+        },
+        {
+          url: '/api/v2/permissions/change_submissions/',
+          filters: [{Your_color: 'blue'}],
+        },
+        {
+          url: '/api/v2/permissions/delete_submissions/',
+          filters: [{_submitted_by: {$in: ['kate', 'joshua']}}],
+        },
+        // This permission is the OR one, which is not supported by Front-end
+        // code and should be treated as AND
+        {
+          url: '/api/v2/permissions/validate_submissions/',
+          filters: [
+            {What_is_your_fav_animal: 'Racoon'},
+            {_submitted_by: 'zachary'},
+          ],
+        },
       ],
+      label: {
+        default: 'Act on submissions only from specific users',
+        view_submissions: 'View submissions only from specific users',
+        change_submissions: 'Edit submissions only from specific users',
+        delete_submissions: 'Delete submissions only from specific users',
+        validate_submissions: 'Validate submissions only from specific users',
+      },
+    },
+    {
+      url: '/api/v2/assets/abc123/permission-assignments/zxc123/',
+      user: '/api/v2/users/gwyneth/',
+      permission: '/api/v2/permissions/view_asset/',
+      label: 'View form',
     },
   ],
 };
@@ -298,4 +369,5 @@ export const endpoints = {
   assetWithAnonymousUser,
   assetWithMultipleUsers,
   assetWithPartial,
+  assetWithMultiplePartial,
 };