10420909904

Committed 16 Aug 2024 01:39PM UTC coverage: 0.43% (-15.3%) from 15.76%

Build # 10420909904

Build Type

Pull #8227

github

Committed by

web-flow

Commit Message

Merge f7273abe9 into 969511eb5

Pull Request Pull Request #8227: Added custom domain functions to admin panel

Run Details

70 of 14433 branches covered (0.48%)

Branch coverage included in aggregate %.

0 of 17 new or added lines in 5 files covered. (0.0%)

3214 existing lines in 290 files now uncovered.

111 of 27703 relevant lines covered (0.4%)

0.01 hits per line

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

0.0

/packages/commonwealth/server/controllers/server_communities_methods/update_community.ts

/* eslint-disable no-continue */
import { AppError } from '@hicommonwealth/core';
import {
  checkSnapshotObjectExists,
  commonProtocol,
  CommunityAttributes,
  UserInstance,
} from '@hicommonwealth/model';
import { ChainBase } from '@hicommonwealth/shared';
import { MixpanelCommunityInteractionEvent } from '../../../shared/analytics/types';
import { urlHasValidHTTPPrefix } from '../../../shared/utils';
import { ALL_COMMUNITIES } from '../../middleware/databaseValidationService';
import { TrackOptions } from '../server_analytics_controller';
import { ServerCommunitiesController } from '../server_communities_controller';

export const Errors = {
  NotLoggedIn: 'Not signed in',
  NoCommunityId: 'Must provide community ID',
  ReservedId: 'The id is reserved and cannot be used',
  CantChangeCustomDomain: 'Custom domain change not permitted',
  CantChangeNetwork: 'Cannot change community network',
  NotAdmin: 'Not an admin',
  NoCommunityFound: 'Community not found',
  InvalidSocialLink: 'Social Link must begin with http(s)://',
  InvalidCustomDomain: 'Custom domain may not include "commonwealth"',
  InvalidSnapshot: 'Snapshot must fit the naming pattern of *.eth or *.xyz',
  SnapshotOnlyOnEthereum:
    'Snapshot data may only be added to chains with Ethereum base',
  InvalidTerms: 'Terms of Service must begin with https://',
  InvalidDefaultPage: 'Default page does not exist',
  InvalidTransactionHash: 'Valid transaction hash required to verify namespace',
};

export type UpdateCommunityOptions = CommunityAttributes & {
  user: UserInstance;
  featuredTopics?: string[];
  snapshot?: string[];
  transactionHash?: string;
};
export type UpdateCommunityResult = CommunityAttributes & {
  snapshot: string[];
  analyticsOptions: TrackOptions;
};

export async function __updateCommunity(
  this: ServerCommunitiesController,
  { user, id, network, ...rest }: UpdateCommunityOptions,
): Promise<UpdateCommunityResult> {
  if (!user) {
    throw new AppError(Errors.NotLoggedIn);
  }
  if (!id) {
    throw new AppError(Errors.NoCommunityId);
  }
  if (id === ALL_COMMUNITIES) {
    throw new AppError(Errors.ReservedId);
  }
  if (network) {
    throw new AppError(Errors.CantChangeNetwork);
  }

  const community = await this.models.Community.findOne({
    where: { id },
    include: [
      {
        model: this.models.ChainNode,
        attributes: ['url', 'eth_chain_id', 'cosmos_chain_id'],
      },
    ],
  });

  if (!community) {
    throw new AppError(Errors.NoCommunityFound);
  }

  const communityAdmins = await user.getAddresses({
    where: {
      community_id: community.id,
      role: 'admin',
    },
  });

  if (!user.isAdmin && communityAdmins.length === 0) {
    throw new AppError(Errors.NotAdmin);
  }

  // TODO: what do we do to select the proper admin to deploy namespace further down?
  const communityAdmin = communityAdmins[0];

  const {
    active,
    icon_url,
    default_symbol,
    type,
    name,
    description,
    social_links,
    hide_projects,
    stages_enabled,
    custom_stages,
    custom_domain,
    default_summary_view,
    default_page,
    has_homepage,
    terms,
    chain_node_id,
    directory_page_enabled,
    directory_page_chain_node_id,
    namespace,
    transactionHash,
  } = rest;

  // Handle single string case and undefined case
  let { snapshot } = rest;
  if (snapshot !== undefined && typeof snapshot === 'string') {
    snapshot = [snapshot];
  } else if (snapshot === undefined) {
    snapshot = [];
  }

  const nonEmptySocialLinks = social_links?.filter((s) => s && s !== '');
  const invalidSocialLinks = nonEmptySocialLinks?.filter(
    (s) => !urlHasValidHTTPPrefix(s),
  );
  if (nonEmptySocialLinks && invalidSocialLinks.length > 0) {
    throw new AppError(`${invalidSocialLinks[0]}: ${Errors.InvalidSocialLink}`);
  } else if (custom_domain && custom_domain.includes('commonwealth')) {
    throw new AppError(Errors.InvalidCustomDomain);
  } else if (
    snapshot.some((snapshot_space) => {
      const lastFour = snapshot_space.slice(snapshot_space.length - 4);
      return (
        snapshot_space !== '' && lastFour !== '.eth' && lastFour !== '.xyz'
      );
    })
  ) {
    throw new AppError(Errors.InvalidSnapshot);
  } else if (snapshot.length > 0 && community.base !== ChainBase.Ethereum) {
    throw new AppError(Errors.SnapshotOnlyOnEthereum);
  } else if (terms && !urlHasValidHTTPPrefix(terms)) {
    throw new AppError(Errors.InvalidTerms);
  }

  const newSpaces = snapshot.filter((space) => {
    return !community.snapshot_spaces.includes(space);
  });
  for (const space of newSpaces) {
    if (!(await checkSnapshotObjectExists('space', space))) {
      throw new AppError(Errors.InvalidSnapshot);
    }
  }

  community.snapshot_spaces = snapshot;

  if (name) community.name = name;
  if (description) community.description = description;
  if (default_symbol) community.default_symbol = default_symbol;
  if (icon_url) community.icon_url = icon_url;
  if (active !== undefined) community.active = active;
  if (type) community.type = type;
  if (nonEmptySocialLinks !== undefined && nonEmptySocialLinks.length >= 0)
    community.social_links = nonEmptySocialLinks;
  if (hide_projects) community.hide_projects = hide_projects;
  if (typeof stages_enabled === 'boolean')
    community.stages_enabled = stages_enabled;
  if (Array.isArray(custom_stages)) {
    community.custom_stages = custom_stages;
  }
  if (typeof terms === 'string') community.terms = terms;
  if (has_homepage === 'true') community.has_homepage = has_homepage;
  if (default_page) {
    if (has_homepage !== 'true') {
      throw new AppError(Errors.InvalidDefaultPage);
    } else {
      community.default_page = default_page;
    }
  }
  if (chain_node_id) {
    community.chain_node_id = chain_node_id;
  }

  let mixpanelEvent: MixpanelCommunityInteractionEvent;
  let communitySelected = null;

  if (community.directory_page_enabled !== directory_page_enabled) {
    mixpanelEvent = directory_page_enabled
      ? MixpanelCommunityInteractionEvent.DIRECTORY_PAGE_ENABLED
      : MixpanelCommunityInteractionEvent.DIRECTORY_PAGE_DISABLED;

    if (directory_page_enabled) {
      // @ts-expect-error StrictNullChecks
      communitySelected = await this.models.Community.findOne({
        where: { chain_node_id: directory_page_chain_node_id! },
      });
    }
  }

  if (directory_page_enabled !== undefined) {
    community.directory_page_enabled = directory_page_enabled;
  }
  if (directory_page_chain_node_id !== undefined) {
    community.directory_page_chain_node_id = directory_page_chain_node_id;
  }
  if (namespace !== undefined) {
    if (!transactionHash) {
      throw new AppError(Errors.InvalidTransactionHash);
    }

    // we only permit the community admin and not the site admin to create namespace
    if (!communityAdmin) {
      throw new AppError(Errors.NotAdmin);
    }

    const namespaceAddress =
      await commonProtocol.newNamespaceValidator.validateNamespace(
        namespace!,
        transactionHash,
        communityAdmin.address,
        community,
      );

    community.namespace = namespace;
    community.namespace_address = namespaceAddress;
  }

  // TODO Graham 3/31/22: Will this potentially lead to undesirable effects if toggle
  // is left un-updated? Is there a better approach?
  community.default_summary_view = default_summary_view || false;

  // Only permit site admins to update custom domain field on communities, as it requires
  // external configuration (via heroku + whitelists).
  // Currently does not permit unsetting the custom domain; must be done manually.
  if (user.isAdmin && custom_domain) {
    community.custom_domain = custom_domain;
  } else if (custom_domain && custom_domain !== community.custom_domain) {
    throw new AppError(Errors.CantChangeCustomDomain);
  }

  await community.save();

  // Suggested solution for serializing BigInts
  // https://github.com/GoogleChromeLabs/jsbi/issues/30#issuecomment-1006086291
  (BigInt.prototype as any).toJSON = function () {
    return this.toString();
  };

  const analyticsOptions = {
    // @ts-expect-error StrictNullChecks
    event: mixpanelEvent,
    community: community.id,
    userId: user.id,
    isCustomDomain: null,
    // @ts-expect-error StrictNullChecks
    ...(communitySelected && { communitySelected: communitySelected.id }),
  };

  return { ...community.toJSON(), snapshot, analyticsOptions };
}

1	/* eslint-disable no-continue */
2	import { AppError } from '@hicommonwealth/core';
3	import {
4	checkSnapshotObjectExists,
5	commonProtocol,
6	CommunityAttributes,
7	UserInstance,
8	} from '@hicommonwealth/model';
9	import { ChainBase } from '@hicommonwealth/shared';
10	import { MixpanelCommunityInteractionEvent } from '../../../shared/analytics/types';
11	import { urlHasValidHTTPPrefix } from '../../../shared/utils';
12	import { ALL_COMMUNITIES } from '../../middleware/databaseValidationService';
13	import { TrackOptions } from '../server_analytics_controller';
14	import { ServerCommunitiesController } from '../server_communities_controller';
15
UNCOV 16	export const Errors = {	×
17	NotLoggedIn: 'Not signed in',
18	NoCommunityId: 'Must provide community ID',
19	ReservedId: 'The id is reserved and cannot be used',
20	CantChangeCustomDomain: 'Custom domain change not permitted',
21	CantChangeNetwork: 'Cannot change community network',
22	NotAdmin: 'Not an admin',
23	NoCommunityFound: 'Community not found',
24	InvalidSocialLink: 'Social Link must begin with http(s)://',
25	InvalidCustomDomain: 'Custom domain may not include "commonwealth"',
26	InvalidSnapshot: 'Snapshot must fit the naming pattern of .eth or .xyz',
27	SnapshotOnlyOnEthereum:
28	'Snapshot data may only be added to chains with Ethereum base',
29	InvalidTerms: 'Terms of Service must begin with https://',
30	InvalidDefaultPage: 'Default page does not exist',
31	InvalidTransactionHash: 'Valid transaction hash required to verify namespace',
32	};
33
34	export type UpdateCommunityOptions = CommunityAttributes & {
35	user: UserInstance;
36	featuredTopics?: string[];
37	snapshot?: string[];
38	transactionHash?: string;
39	};
40	export type UpdateCommunityResult = CommunityAttributes & {
41	snapshot: string[];
42	analyticsOptions: TrackOptions;
43	};
44
45	export async function __updateCommunity(
46	this: ServerCommunitiesController,
47	{ user, id, network, ...rest }: UpdateCommunityOptions,
48	): Promise<UpdateCommunityResult> {
UNCOV 49	if (!user) {	×
50	throw new AppError(Errors.NotLoggedIn);	×
51	}
UNCOV 52	if (!id) {	×
UNCOV 53	throw new AppError(Errors.NoCommunityId);	×
54	}
UNCOV 55	if (id === ALL_COMMUNITIES) {	×
56	throw new AppError(Errors.ReservedId);	×
57	}
UNCOV 58	if (network) {	×
UNCOV 59	throw new AppError(Errors.CantChangeNetwork);	×
60	}
61
UNCOV 62	const community = await this.models.Community.findOne({	×
63	where: { id },
64	include: [
65	{
66	model: this.models.ChainNode,
67	attributes: ['url', 'eth_chain_id', 'cosmos_chain_id'],
68	},
69	],
70	});
71
UNCOV 72	if (!community) {	×
UNCOV 73	throw new AppError(Errors.NoCommunityFound);	×
74	}
75
UNCOV 76	const communityAdmins = await user.getAddresses({	×
77	where: {
78	community_id: community.id,
79	role: 'admin',
80	},
81	});
82
UNCOV 83	if (!user.isAdmin && communityAdmins.length === 0) {	×
UNCOV 84	throw new AppError(Errors.NotAdmin);	×
85	}
86
87	// TODO: what do we do to select the proper admin to deploy namespace further down?
UNCOV 88	const communityAdmin = communityAdmins[0];	×
89
90	const {
91	active,
92	icon_url,
93	default_symbol,
94	type,
95	name,
96	description,
97	social_links,
98	hide_projects,
99	stages_enabled,
100	custom_stages,
101	custom_domain,
102	default_summary_view,
103	default_page,
104	has_homepage,
105	terms,
106	chain_node_id,
107	directory_page_enabled,
108	directory_page_chain_node_id,
109	namespace,
110	transactionHash,
UNCOV 111	} = rest;	×
112
113	// Handle single string case and undefined case
UNCOV 114	let { snapshot } = rest;	×
UNCOV 115	if (snapshot !== undefined && typeof snapshot === 'string') {	×
116	snapshot = [snapshot];	×
UNCOV 117	} else if (snapshot === undefined) {	×
UNCOV 118	snapshot = [];	×
119	}
120
UNCOV 121	const nonEmptySocialLinks = social_links?.filter((s) => s && s !== '');	×
UNCOV 122	const invalidSocialLinks = nonEmptySocialLinks?.filter(	×
UNCOV 123	(s) => !urlHasValidHTTPPrefix(s),	×
124	);
UNCOV 125	if (nonEmptySocialLinks && invalidSocialLinks.length > 0) {	×
126	throw new AppError(`${invalidSocialLinks[0]}: ${Errors.InvalidSocialLink}`);	×
UNCOV 127	} else if (custom_domain && custom_domain.includes('commonwealth')) {	×
128	throw new AppError(Errors.InvalidCustomDomain);	×
UNCOV 129	} else if (	×
130	snapshot.some((snapshot_space) => {
131	const lastFour = snapshot_space.slice(snapshot_space.length - 4);	×
UNCOV 132	return (	×
133	snapshot_space !== '' && lastFour !== '.eth' && lastFour !== '.xyz'	×
134	);
135	})
136	) {
137	throw new AppError(Errors.InvalidSnapshot);	×
UNCOV 138	} else if (snapshot.length > 0 && community.base !== ChainBase.Ethereum) {	×
139	throw new AppError(Errors.SnapshotOnlyOnEthereum);	×
UNCOV 140	} else if (terms && !urlHasValidHTTPPrefix(terms)) {	×
141	throw new AppError(Errors.InvalidTerms);	×
142	}
143
UNCOV 144	const newSpaces = snapshot.filter((space) => {	×
145	return !community.snapshot_spaces.includes(space);	×
146	});
UNCOV 147	for (const space of newSpaces) {	×
148	if (!(await checkSnapshotObjectExists('space', space))) {	×
149	throw new AppError(Errors.InvalidSnapshot);	×
150	}
151	}
152
UNCOV 153	community.snapshot_spaces = snapshot;	×
154
UNCOV 155	if (name) community.name = name;	×
UNCOV 156	if (description) community.description = description;	×
UNCOV 157	if (default_symbol) community.default_symbol = default_symbol;	×
UNCOV 158	if (icon_url) community.icon_url = icon_url;	×
UNCOV 159	if (active !== undefined) community.active = active;	×
UNCOV 160	if (type) community.type = type;	×
UNCOV 161	if (nonEmptySocialLinks !== undefined && nonEmptySocialLinks.length >= 0)	×
UNCOV 162	community.social_links = nonEmptySocialLinks;	×
UNCOV 163	if (hide_projects) community.hide_projects = hide_projects;	×
UNCOV 164	if (typeof stages_enabled === 'boolean')	×
165	community.stages_enabled = stages_enabled;	×
UNCOV 166	if (Array.isArray(custom_stages)) {	×
167	community.custom_stages = custom_stages;	×
168	}
UNCOV 169	if (typeof terms === 'string') community.terms = terms;	×
UNCOV 170	if (has_homepage === 'true') community.has_homepage = has_homepage;	×
UNCOV 171	if (default_page) {	×
172	if (has_homepage !== 'true') {	×
173	throw new AppError(Errors.InvalidDefaultPage);	×
174	} else {
175	community.default_page = default_page;	×
176	}
177	}
UNCOV 178	if (chain_node_id) {	×
UNCOV 179	community.chain_node_id = chain_node_id;	×
180	}
181
182	let mixpanelEvent: MixpanelCommunityInteractionEvent;
UNCOV 183	let communitySelected = null;	×
184
UNCOV 185	if (community.directory_page_enabled !== directory_page_enabled) {	×
UNCOV 186	mixpanelEvent = directory_page_enabled	×
187	? MixpanelCommunityInteractionEvent.DIRECTORY_PAGE_ENABLED
188	: MixpanelCommunityInteractionEvent.DIRECTORY_PAGE_DISABLED;
189
UNCOV 190	if (directory_page_enabled) {	×
191	// @ts-expect-error StrictNullChecks
UNCOV 192	communitySelected = await this.models.Community.findOne({	×
193	where: { chain_node_id: directory_page_chain_node_id! },
194	});
195	}
196	}
197
UNCOV 198	if (directory_page_enabled !== undefined) {	×
UNCOV 199	community.directory_page_enabled = directory_page_enabled;	×
200	}
UNCOV 201	if (directory_page_chain_node_id !== undefined) {	×
UNCOV 202	community.directory_page_chain_node_id = directory_page_chain_node_id;	×
203	}
UNCOV 204	if (namespace !== undefined) {	×
UNCOV 205	if (!transactionHash) {	×
UNCOV 206	throw new AppError(Errors.InvalidTransactionHash);	×
207	}
208
209	// we only permit the community admin and not the site admin to create namespace
UNCOV 210	if (!communityAdmin) {	×
211	throw new AppError(Errors.NotAdmin);	×
212	}
213
214	const namespaceAddress =
UNCOV 215	await commonProtocol.newNamespaceValidator.validateNamespace(	×
216	namespace!,
217	transactionHash,
218	communityAdmin.address,
219	community,
220	);
221
222	community.namespace = namespace;	×
223	community.namespace_address = namespaceAddress;	×
224	}
225
226	// TODO Graham 3/31/22: Will this potentially lead to undesirable effects if toggle
227	// is left un-updated? Is there a better approach?
UNCOV 228	community.default_summary_view = default_summary_view \|\| false;	×
229
230	// Only permit site admins to update custom domain field on communities, as it requires
231	// external configuration (via heroku + whitelists).
232	// Currently does not permit unsetting the custom domain; must be done manually.
UNCOV 233	if (user.isAdmin && custom_domain) {	×
UNCOV 234	community.custom_domain = custom_domain;	×
UNCOV 235	} else if (custom_domain && custom_domain !== community.custom_domain) {	×
UNCOV 236	throw new AppError(Errors.CantChangeCustomDomain);	×
237	}
238
UNCOV 239	await community.save();	×
240
241	// Suggested solution for serializing BigInts
242	// https://github.com/GoogleChromeLabs/jsbi/issues/30#issuecomment-1006086291
UNCOV 243	(BigInt.prototype as any).toJSON = function () {	×
244	return this.toString();	×
245	};
246
UNCOV 247	const analyticsOptions = {	×
248	// @ts-expect-error StrictNullChecks
249	event: mixpanelEvent,
250	community: community.id,
251	userId: user.id,
252	isCustomDomain: null,
253	// @ts-expect-error StrictNullChecks
254	...(communitySelected && { communitySelected: communitySelected.id }),	×
255	};
256
UNCOV 257	return { ...community.toJSON(), snapshot, analyticsOptions };	×
258	}

hicommonwealth / commonwealth / 10420909904

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