File size: 7,554 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 |
import { useMutation, useQueryClient } from '@tanstack/react-query';
import { buildQueryKey, callApi, getSubscriptionMutationParams, isValidId } from '../helpers';
import { useCacheKey, useIsLoggedIn } from '../hooks';
import {
SiteSubscriptionsPages,
SubscriptionManagerSubscriptionsCount,
SiteSubscriptionDetails,
} from '../types';
type UnsubscribeParams = {
subscriptionId: number;
url?: string;
blog_id?: number | string;
doNotInvalidateSiteSubscriptions?: boolean;
emailId?: string;
onSuccess?: () => void;
onError?: ( e: Error ) => void;
};
type UnsubscribeResponse = {
success?: boolean;
subscribed?: boolean;
subscription?: null;
};
const buildSiteSubscriptionDetailsByBlogIdQueryKey = (
blogId: number | string,
isLoggedIn: boolean,
userId?: number
) => {
return buildQueryKey(
[ 'read', 'site-subscription-details', String( blogId ) ],
isLoggedIn,
userId
);
};
const buildSiteSubscriptionDetailsQueryKey = (
subscriptionId: number,
isLoggedIn: boolean,
userId?: number
) => {
return [ 'read', 'subscriptions', subscriptionId, isLoggedIn, userId ];
};
const useSiteUnsubscribeMutation = () => {
const { isLoggedIn, id: userId } = useIsLoggedIn();
const queryClient = useQueryClient();
const siteSubscriptionsQueryKey = useCacheKey( [ 'read', 'site-subscriptions' ] );
const subscriptionsCountQueryKey = useCacheKey( [ 'read', 'subscriptions-count' ] );
return useMutation( {
mutationFn: async ( params: UnsubscribeParams ) => {
const { path, apiVersion, body } = getSubscriptionMutationParams(
'delete',
isLoggedIn,
params.blog_id,
params.url,
params.emailId,
params.subscriptionId
);
const response = await callApi< UnsubscribeResponse >( {
path,
method: 'POST',
isLoggedIn,
apiVersion,
body,
} );
if (
'success' in response &&
response.success === false &&
'subscribed' in response &&
response.subscribed === true
) {
throw new Error(
// reminder: translate this string when we add it to the UI
'Something went wrong while unsubscribing.'
);
}
return response;
},
onMutate: async ( params ) => {
const siteSubscriptionDetailsQueryKey = buildSiteSubscriptionDetailsQueryKey(
params.subscriptionId,
isLoggedIn,
userId
);
await queryClient.cancelQueries( { queryKey: siteSubscriptionsQueryKey } );
await queryClient.cancelQueries( { queryKey: subscriptionsCountQueryKey } );
await queryClient.cancelQueries( { queryKey: siteSubscriptionDetailsQueryKey } );
const previousSiteSubscriptions =
queryClient.getQueryData< SiteSubscriptionsPages >( siteSubscriptionsQueryKey );
// remove blog from site subscriptions
if ( previousSiteSubscriptions ) {
queryClient.setQueryData( siteSubscriptionsQueryKey, {
...previousSiteSubscriptions,
pages: previousSiteSubscriptions.pages.map( ( page ) => {
return {
...page,
total_subscriptions: page.total_subscriptions - 1,
subscriptions: page.subscriptions.map( ( siteSubscription ) =>
Number( siteSubscription.ID ) === params.subscriptionId ||
( isValidId( params.blog_id ) && siteSubscription.blog_ID === params.blog_id ) //siteSubscription.blog_ID is not valid ID for non-wpcom subscriptions, so when unsubscribing from such site, the param.blog_id will also be not valid, this would create false positive
? {
...siteSubscription,
isDeleted: true,
resubscribed: false,
}
: siteSubscription
),
};
} ),
} );
}
const previousSubscriptionsCount =
queryClient.getQueryData< SubscriptionManagerSubscriptionsCount >(
subscriptionsCountQueryKey
);
// decrement the blog count
if ( previousSubscriptionsCount ) {
queryClient.setQueryData< SubscriptionManagerSubscriptionsCount >(
subscriptionsCountQueryKey,
{
...previousSubscriptionsCount,
blogs: previousSubscriptionsCount?.blogs ? previousSubscriptionsCount?.blogs - 1 : null,
}
);
}
const previousSiteSubscriptionDetails = queryClient.getQueryData< SiteSubscriptionDetails >(
siteSubscriptionDetailsQueryKey
);
if ( previousSiteSubscriptionDetails ) {
queryClient.setQueryData( siteSubscriptionDetailsQueryKey, {
...previousSiteSubscriptionDetails,
subscriber_count: previousSiteSubscriptionDetails.subscriber_count - 1,
} );
}
let previousSiteSubscriptionDetailsByBlogId: SiteSubscriptionDetails | undefined;
if ( isValidId( params.blog_id ) ) {
const siteSubscriptionDetailsCacheKey = buildSiteSubscriptionDetailsByBlogIdQueryKey(
params.blog_id,
isLoggedIn,
userId
);
await queryClient.cancelQueries( { queryKey: siteSubscriptionDetailsCacheKey } );
previousSiteSubscriptionDetailsByBlogId = queryClient.getQueryData(
siteSubscriptionDetailsCacheKey
);
if ( previousSiteSubscriptionDetailsByBlogId ) {
queryClient.setQueryData( siteSubscriptionDetailsCacheKey, {
...previousSiteSubscriptionDetailsByBlogId,
subscriber_count: previousSiteSubscriptionDetailsByBlogId.subscriber_count - 1,
} );
}
}
return {
previousSiteSubscriptions,
previousSubscriptionsCount,
previousSiteSubscriptionDetails,
previousSiteSubscriptionDetailsByBlogId,
};
},
onError: ( _error, params, context ) => {
if ( context?.previousSiteSubscriptions ) {
queryClient.setQueryData( siteSubscriptionsQueryKey, context.previousSiteSubscriptions );
}
if ( context?.previousSubscriptionsCount ) {
queryClient.setQueryData< SubscriptionManagerSubscriptionsCount >(
subscriptionsCountQueryKey,
context.previousSubscriptionsCount
);
}
if ( context?.previousSiteSubscriptionDetails ) {
queryClient.setQueryData(
buildSiteSubscriptionDetailsQueryKey( params.subscriptionId, isLoggedIn, userId ),
{
...context.previousSiteSubscriptionDetails,
subscriber_count: context.previousSiteSubscriptionDetails.subscriber_count + 1,
}
);
}
if ( context?.previousSiteSubscriptionDetailsByBlogId && isValidId( params.blog_id ) ) {
const siteSubscriptionDetailsCacheKey = buildSiteSubscriptionDetailsByBlogIdQueryKey(
params.blog_id,
isLoggedIn,
userId
);
queryClient.setQueryData(
siteSubscriptionDetailsCacheKey,
context.previousSiteSubscriptionDetailsByBlogId
);
}
params.onError?.( _error );
},
onSettled: ( _data, _error, params ) => {
if ( params.doNotInvalidateSiteSubscriptions !== true ) {
queryClient.invalidateQueries( { queryKey: siteSubscriptionsQueryKey } );
}
if ( isValidId( params.blog_id ) ) {
const siteSubscriptionDetailsByBlogIdQueryKey =
buildSiteSubscriptionDetailsByBlogIdQueryKey( params.blog_id, isLoggedIn, userId );
queryClient.invalidateQueries( {
queryKey: siteSubscriptionDetailsByBlogIdQueryKey,
refetchType: 'none',
} );
queryClient.invalidateQueries( {
queryKey: [ 'read', 'sites', Number( params.blog_id ) ],
} );
}
queryClient.invalidateQueries( { queryKey: subscriptionsCountQueryKey } );
queryClient.invalidateQueries( {
queryKey: [ 'read', 'feed', 'search' ],
} );
queryClient.invalidateQueries( {
queryKey: buildSiteSubscriptionDetailsQueryKey( params.subscriptionId, isLoggedIn, userId ),
} );
},
onSuccess: ( data, params ) => {
params.onSuccess?.();
},
} );
};
export default useSiteUnsubscribeMutation;
|