10743954062

Committed 06 Sep 2024 07:14PM UTC coverage: 14.309% (-0.1%) from 14.438%

Build # 10743954062

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #9136 from hicommonwealth/rotorsoft/8935-create-comment-reaction

Refactors create comment reaction

Run Details

3064 of 19737 branches covered (15.52%)

Branch coverage included in aggregate %.

68 of 94 new or added lines in 20 files covered. (72.34%)

5 existing lines in 2 files now uncovered.

4014 of 29730 relevant lines covered (13.5%)

4.06 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

18.18

/packages/commonwealth/server/util/requirementsModule/validateTopicGroupsMembership.ts

import {
  AddressAttributes,
  DB,
  GroupInstance,
  MembershipRejectReason,
} from '@hicommonwealth/model';
import { GroupPermissionAction } from '@hicommonwealth/schemas';
import { QueryTypes } from 'sequelize';
import { refreshMembershipsForAddress } from './refreshMembershipsForAddress';

/**
 * Validates if a given user address passes a set of requirements and grants access for
 * all groups of the given topic.
 * @param models DB handle
 * @param topicId ID of the topic
 * @param communityId ID of the community of the groups
 * @param address Address to check against requirements
 * @param action The type of permission allowed_action it is checking for
 * @returns validity with optional error message
 */
export async function validateTopicGroupsMembership(
  models: DB,
  topicId: number,
  communityId: string,
  address: AddressAttributes,
  action: GroupPermissionAction,
): Promise<{ isValid: boolean; message?: string }> {
  // check via new TBC with groups

  // get all groups of topic
  const topic = await models.Topic.findOne({
    where: {
      community_id: communityId,
      id: topicId,
    },
  });
  if (!topic) {
    return { isValid: false, message: 'Topic not found' };
  }

  if (topic?.group_ids?.length === 0) {
    return { isValid: true };
  }

  const groups: (GroupInstance & {
    allowed_actions?: GroupPermissionAction[];
  })[] = await models.sequelize.query(
    `
        SELECT g.*, gp.allowed_actions FROM "Groups" as g LEFT JOIN "GroupPermissions" gp ON g.id = gp.group_id
        WHERE g.community_id = :communityId AND g.id IN(:groupIds);
      `,
    {
      type: QueryTypes.SELECT,
      raw: true,
      replacements: { communityId, groupIds: topic.group_ids },
    },
  );

  // There are 2 cases here. We either have the old group permission system where the group doesn't have
  // any allowed_actions, or we have the new fine-grained permission system where the action must be in
  // the allowed_actions list.
  const permissionedGroups = groups.filter(
    (g) => !g.allowed_actions || g.allowed_actions.includes(action),
  );

  if (permissionedGroups.length === 0) {
    return {
      isValid: false,
      message: `User does not have permission to perform action ${action}`,
    };
  }

  // check membership for all groups of topic
  let numValidGroups = 0;
  const allErrorMessages: MembershipRejectReason[] = [];

  const memberships = await refreshMembershipsForAddress(
    models,
    address,
    permissionedGroups,
    false, // use cached balances
  );

  for (const membership of memberships) {
    if (membership.reject_reason) {
      allErrorMessages.push(membership.reject_reason);
    } else {
      numValidGroups++;
    }
  }

  if (numValidGroups === 0) {
    return { isValid: false, message: allErrorMessages.join('\n') };
  }

  return { isValid: true };
}

1	import {
2	AddressAttributes,
3	DB,
4	GroupInstance,
5	MembershipRejectReason,
6	} from '@hicommonwealth/model';
7	import { GroupPermissionAction } from '@hicommonwealth/schemas';
8	import { QueryTypes } from 'sequelize';
9	import { refreshMembershipsForAddress } from './refreshMembershipsForAddress';
10
11	/**
12	* Validates if a given user address passes a set of requirements and grants access for
13	* all groups of the given topic.
14	* @param models DB handle
15	* @param topicId ID of the topic
16	* @param communityId ID of the community of the groups
17	* @param address Address to check against requirements
18	* @param action The type of permission allowed_action it is checking for
19	* @returns validity with optional error message
20	*/
21	export async function validateTopicGroupsMembership(
22	models: DB,
23	topicId: number,
24	communityId: string,
25	address: AddressAttributes,
26	action: GroupPermissionAction,
27	): Promise<{ isValid: boolean; message?: string }> {
28	// check via new TBC with groups
29
30	// get all groups of topic
31	const topic = await models.Topic.findOne({	2✔
32	where: {
33	community_id: communityId,
34	id: topicId,
35	},
36	});
37	if (!topic) {	2!
38	return { isValid: false, message: 'Topic not found' };	×
39	}
40
41	if (topic?.group_ids?.length === 0) {	2!
42	return { isValid: true };	2✔
43	}
44
45	const groups: (GroupInstance & {
46	allowed_actions?: GroupPermissionAction[];
UNCOV 47	})[] = await models.sequelize.query(	×
48	`
49	SELECT g.*, gp.allowed_actions FROM "Groups" as g LEFT JOIN "GroupPermissions" gp ON g.id = gp.group_id
50	WHERE g.community_id = :communityId AND g.id IN(:groupIds);
51	`,
52	{
53	type: QueryTypes.SELECT,
54	raw: true,
55	replacements: { communityId, groupIds: topic.group_ids },
56	},
57	);
58
59	// There are 2 cases here. We either have the old group permission system where the group doesn't have
60	// any allowed_actions, or we have the new fine-grained permission system where the action must be in
61	// the allowed_actions list.
UNCOV 62	const permissionedGroups = groups.filter(	×
63	(g) => !g.allowed_actions \|\| g.allowed_actions.includes(action),	×
64	);
65
UNCOV 66	if (permissionedGroups.length === 0) {	×
UNCOV 67	return {	×
68	isValid: false,
69	message: `User does not have permission to perform action ${action}`,
70	};
71	}
72
73	// check membership for all groups of topic
74	let numValidGroups = 0;	×
75	const allErrorMessages: MembershipRejectReason[] = [];	×
76
77	const memberships = await refreshMembershipsForAddress(	×
78	models,
79	address,
80	permissionedGroups,
81	false, // use cached balances
82	);
83
84	for (const membership of memberships) {	×
85	if (membership.reject_reason) {	×
86	allErrorMessages.push(membership.reject_reason);	×
87	} else {
88	numValidGroups++;	×
89	}
90	}
91
92	if (numValidGroups === 0) {	×
93	return { isValid: false, message: allErrorMessages.join('\n') };	×
94	}
95
96	return { isValid: true };	×
97	}

hicommonwealth / commonwealth / 10743954062

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous