@selfcommunity/react-core
Version:
React Core Components useful for integrating UI Community components (react-ui).
274 lines (272 loc) • 11.4 kB
JavaScript
import { useEffect, useMemo, useRef } from 'react';
import { Endpoints, http } from '@selfcommunity/api-services';
import { SCFeatureName, SCGroupPrivacyType, SCGroupSubscriptionStatusType, SCNotificationTopicType, SCNotificationTypologyType, } from '@selfcommunity/types';
import useSCCachingManager from './useSCCachingManager';
import { SCOPE_SC_CORE } from '../constants/Errors';
import { Logger } from '@selfcommunity/utils';
import { useSCPreferences } from '../components/provider/SCPreferencesProvider';
import { SCNotificationMapping } from '../constants/Notification';
import { CONFIGURATIONS_GROUPS_ENABLED } from '../constants/Preferences';
import { useDeepCompareEffectNoCheck } from 'use-deep-compare-effect';
import PubSub from 'pubsub-js';
/**
:::info
This custom hook is used to manage the groups followed.
:::
:::tip How to use it:
Follow these steps:
```jsx
1. const scUserContext: SCUserContextType = useSCUser();
2. const scSubscribedGroupsManager: SCSubscribedGroupsManagerType = scUserContext.manager.groups;
3. scSubscribedGroupsManager.isSubscribed(group)
```
:::
*/
export default function useSCSubscribedGroupsManager(user) {
const { cache, updateCache, emptyCache, data, setData, loading, setLoading, setUnLoading, isLoading } = useSCCachingManager();
const { preferences, features } = useSCPreferences();
const authUserId = user ? user.id : null;
const groupsEnabled = useMemo(() => preferences &&
features &&
features.includes(SCFeatureName.TAGGING) &&
features.includes(SCFeatureName.GROUPING) &&
CONFIGURATIONS_GROUPS_ENABLED in preferences &&
preferences[CONFIGURATIONS_GROUPS_ENABLED].value, [preferences, features]);
const notificationInvitedToJoinGroup = useRef(null);
const notificationRequestedToJoinGroup = useRef(null);
const notificationAcceptedToJoinGroup = useRef(null);
const notificationAddedToGroup = useRef(null);
/**
* Subscribe to notification types user_follow, user_unfollow
*/
useDeepCompareEffectNoCheck(() => {
notificationInvitedToJoinGroup.current = PubSub.subscribe(`${SCNotificationTopicType.INTERACTION}.${SCNotificationTypologyType.USER_INVITED_TO_JOIN_GROUP}`, notificationSubscriber);
notificationRequestedToJoinGroup.current = PubSub.subscribe(`${SCNotificationTopicType.INTERACTION}.${SCNotificationTypologyType.USER_REQUESTED_TO_JOIN_GROUP}`, notificationSubscriber);
notificationAcceptedToJoinGroup.current = PubSub.subscribe(`${SCNotificationTopicType.INTERACTION}.${SCNotificationTypologyType.USER_ACCEPTED_TO_JOIN_GROUP}`, notificationSubscriber);
notificationAddedToGroup.current = PubSub.subscribe(`${SCNotificationTopicType.INTERACTION}.${SCNotificationTypologyType.USER_ADDED_TO_GROUP}`, notificationSubscriber);
return () => {
PubSub.unsubscribe(notificationInvitedToJoinGroup.current);
PubSub.unsubscribe(notificationRequestedToJoinGroup.current);
PubSub.unsubscribe(notificationAcceptedToJoinGroup.current);
PubSub.unsubscribe(notificationAddedToGroup.current);
};
}, [data]);
/**
* Notification subscriber handler
* @param msg
* @param dataMsg
*/
const notificationSubscriber = (msg, dataMsg) => {
if (dataMsg.data.group !== undefined) {
let _status;
switch (SCNotificationMapping[dataMsg.data.activity_type]) {
case SCNotificationTypologyType.USER_INVITED_TO_JOIN_GROUP:
_status = SCGroupSubscriptionStatusType.INVITED;
break;
case SCNotificationTypologyType.USER_REQUESTED_TO_JOIN_GROUP:
_status = SCGroupSubscriptionStatusType.REQUESTED;
break;
case SCNotificationTypologyType.USER_ACCEPTED_TO_JOIN_GROUP:
_status = SCGroupSubscriptionStatusType.SUBSCRIBED;
break;
case SCNotificationTypologyType.USER_ADDED_TO_GROUP:
_status = SCGroupSubscriptionStatusType.SUBSCRIBED;
break;
}
updateCache([dataMsg.data.group.id]);
setData((prev) => getDataUpdated(prev, dataMsg.data.group.id, _status));
}
};
/**
* Memoized refresh all groups
* It makes a single request to the server and retrieves
* all the groups followed by the user in a single solution
* It might be useful for multi-tab sync
*/
const refresh = useMemo(() => () => {
emptyCache();
if (user) {
// Only if user is authenticated
http
.request({
url: Endpoints.GetUserGroups.url(),
method: Endpoints.GetUserGroups.method,
})
.then((res) => {
if (res.status >= 300) {
return Promise.reject(res);
}
const groupsIds = res.data.results.map((g) => g.id);
updateCache(groupsIds);
setData(res.data.results.map((g) => ({ [g.id]: g.subscription_status })));
return Promise.resolve(res.data);
})
.catch((e) => {
Logger.error(SCOPE_SC_CORE, 'Unable to refresh the authenticated user groups.');
Logger.error(SCOPE_SC_CORE, e);
});
}
}, [data, user, cache]);
/**
* Memoized subscribe Group
* Toggle action
*/
const subscribe = useMemo(() => (group, userId) => {
setLoading(group.id);
if (userId) {
return http
.request({
url: Endpoints.InviteOrAcceptGroupRequest.url({ id: group.id }),
method: Endpoints.InviteOrAcceptGroupRequest.method,
data: { users: [userId] },
})
.then((res) => {
if (res.status >= 300) {
return Promise.reject(res);
}
updateCache([group.id]);
setData((prev) => getDataUpdated(prev, group.id, SCGroupSubscriptionStatusType.SUBSCRIBED));
setUnLoading(group.id);
return Promise.resolve(res.data);
});
}
else {
return http
.request({
url: Endpoints.SubscribeToGroup.url({ id: group.id }),
method: Endpoints.SubscribeToGroup.method,
})
.then((res) => {
if (res.status >= 300) {
return Promise.reject(res);
}
updateCache([group.id]);
setData((prev) => getDataUpdated(prev, group.id, group.privacy === SCGroupPrivacyType.PRIVATE && group.subscription_status !== SCGroupSubscriptionStatusType.INVITED
? SCGroupSubscriptionStatusType.REQUESTED
: SCGroupSubscriptionStatusType.SUBSCRIBED));
setUnLoading(group.id);
return Promise.resolve(res.data);
});
}
}, [data, loading, cache]);
/**
* Memoized subscribe Group
* Toggle action
*/
const unsubscribe = useMemo(() => (group) => {
if (group.subscription_status !== SCGroupSubscriptionStatusType.REQUESTED) {
setLoading(group.id);
return http
.request({
url: Endpoints.UnsubscribeFromGroup.url({ id: group.id }),
method: Endpoints.UnsubscribeFromGroup.method,
})
.then((res) => {
if (res.status >= 300) {
return Promise.reject(res);
}
updateCache([group.id]);
setData((prev) => getDataUpdated(prev, group.id, null));
setUnLoading(group.id);
return Promise.resolve(res.data);
});
}
}, [data, loading, cache]);
/**
* Check the authenticated user subscription status to the group
* Update the groups cached
* Update groups subscription statuses
* @param group
*/
const checkGroupSubscriptionStatus = (group) => {
setLoading(group.id);
return http
.request({
url: Endpoints.GetGroupSubscriptionStatus.url({ id: group.id }),
method: Endpoints.GetGroupSubscriptionStatus.method,
})
.then((res) => {
if (res.status >= 300) {
return Promise.reject(res);
}
setData((prev) => getDataUpdated(prev, group.id, res.data.status));
updateCache([group.id]);
setUnLoading(group.id);
return Promise.resolve(res.data);
})
.catch((e) => {
setUnLoading(group.id);
return Promise.reject(e);
});
};
/**
* Get updated data
* @param data
* @param groupId
* @param subscriptionStatus
*/
const getDataUpdated = (data, groupId, subscriptionStatus) => {
const _index = data.findIndex((k) => parseInt(Object.keys(k)[0]) === groupId);
let _data;
if (_index < 0) {
_data = [...data, ...[{ [groupId]: subscriptionStatus }]];
}
else {
_data = data.map((k, i) => {
if (parseInt(Object.keys(k)[0]) === groupId) {
return { [Object.keys(k)[0]]: subscriptionStatus };
}
return { [Object.keys(k)[0]]: data[i][Object.keys(k)[0]] };
});
}
return _data;
};
/**
* Return current group subscription status if exists,
* otherwise return null
*/
const getCurrentGroupCacheStatus = useMemo(() => (group) => {
const d = data.filter((k) => parseInt(Object.keys(k)[0]) === group.id);
return d.length ? d[0][group.id] : !data.length ? group.subscription_status : null;
}, [data]);
/**
* Bypass remote check if the group is subscribed
*/
const getSubscriptionStatus = useMemo(() => (group) => {
updateCache([group.id]);
setData((prev) => getDataUpdated(prev, group.id, group.subscription_status));
return group.subscription_status;
}, [data, cache]);
/**
* Memoized subscriptionStatus
* If group is already in cache -> check if the group is in groups,
* otherwise, check if user subscribe the group
*/
const subscriptionStatus = useMemo(() => (group) => {
// Cache is valid also for anonymous user
if (cache.includes(group.id)) {
return getCurrentGroupCacheStatus(group);
}
if (authUserId) {
if ('subscription_status' in group) {
return getSubscriptionStatus(group);
}
if (!isLoading(group)) {
checkGroupSubscriptionStatus(group);
}
}
return null;
}, [loading, cache, authUserId]);
/**
* Empty cache on logout
*/
useEffect(() => {
if (!authUserId) {
emptyCache();
}
}, [authUserId]);
if (!groupsEnabled || !user) {
return { groups: data, loading, isLoading };
}
return { groups: data, loading, isLoading, subscribe, unsubscribe, subscriptionStatus, refresh, emptyCache };
}