Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ensure that staging sites display a Staging sticker from the moment they are created #897

Merged
merged 2 commits into from
Feb 10, 2025
Merged

Ensure that staging sites display a Staging sticker from the moment they are created #897

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
517441c
Include `isStaging` prop in `reconcileConnectedSites` logic
fredrikekelund Feb 5, 2025
d52e7ee
Use wpcom_staging_blog_ids to determine if a site is a staging site
fredrikekelund Feb 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/hooks/sync-sites/use-listen-deep-link-connection.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ export function useListenDeepLinkConnection( {
}
const newConnectedSite = transformSingleSiteResponse(
newConnectedSiteResponse,
'already-connected'
'already-connected',
false
);
await connectSite( newConnectedSite, studioSiteId );
if ( selectedTab !== 'sync' ) {
Expand Down
50 changes: 25 additions & 25 deletions src/hooks/tests/reconcile-connected-sites.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { reconcileConnectedSites } from '../use-fetch-wpcom-sites/reconcile-conn
import type { SyncSite } from '../use-fetch-wpcom-sites/types';

describe( 'reconcileConnectedSites', () => {
test( 'should update name, url, syncSupport properties', () => {
test( 'should update relevant properties', () => {
const connectedSites: SyncSite[] = [
{
id: 1,
Expand All @@ -16,21 +16,21 @@ describe( 'reconcileConnectedSites', () => {
lastPushTimestamp: null,
},
];
const originalSitesFromWpCom: SyncSite[] = [
const freshWpComSites: SyncSite[] = [
{
id: 1,
stagingSiteIds: [],
localSiteId: 'local-site-id',
isStaging: false,
isStaging: true,
name: 'site1-updated',
url: 'site1-updated.com',
syncSupport: 'unsupported',
lastPullTimestamp: null,
lastPushTimestamp: null,
},
];
const result = reconcileConnectedSites( connectedSites, originalSitesFromWpCom );
expect( result.updatedConnectedSites ).toEqual( [ originalSitesFromWpCom[ 0 ] ] );
const result = reconcileConnectedSites( connectedSites, freshWpComSites );
expect( result.updatedConnectedSites ).toEqual( [ freshWpComSites[ 0 ] ] );
} );

test( 'should add staging site, if it was added in wordpress.com', () => {
Expand All @@ -47,7 +47,7 @@ describe( 'reconcileConnectedSites', () => {
lastPushTimestamp: null,
},
];
const originalSitesFromWpCom: SyncSite[] = [
const freshWpComSites: SyncSite[] = [
{
id: 1,
stagingSiteIds: [ 2 ],
Expand All @@ -71,10 +71,10 @@ describe( 'reconcileConnectedSites', () => {
lastPushTimestamp: null,
},
];
const result = reconcileConnectedSites( connectedSites, originalSitesFromWpCom );
const result = reconcileConnectedSites( connectedSites, freshWpComSites );
expect( result.stagingSitesToAdd ).toEqual( [
{
...originalSitesFromWpCom[ 1 ],
...freshWpComSites[ 1 ],
syncSupport: 'already-connected',
},
] );
Expand Down Expand Up @@ -106,7 +106,7 @@ describe( 'reconcileConnectedSites', () => {
lastPushTimestamp: null,
},
];
const originalSitesFromWpCom: SyncSite[] = [
const freshWpComSites: SyncSite[] = [
{
id: 1,
stagingSiteIds: [],
Expand All @@ -119,7 +119,7 @@ describe( 'reconcileConnectedSites', () => {
lastPushTimestamp: null,
},
];
const result = reconcileConnectedSites( connectedSites, originalSitesFromWpCom );
const result = reconcileConnectedSites( connectedSites, freshWpComSites );
expect( result.stagingSitesToDelete ).toEqual( [ { id: 2, localSiteId: 'local-site-id' } ] );
expect( result.stagingSitesToAdd ).toEqual( [] );
} );
Expand Down Expand Up @@ -149,7 +149,7 @@ describe( 'reconcileConnectedSites', () => {
lastPushTimestamp: null,
},
];
const originalSitesFromWpCom: SyncSite[] = [
const freshWpComSites: SyncSite[] = [
{
id: 1,
stagingSiteIds: [ 3 ],
Expand All @@ -173,11 +173,11 @@ describe( 'reconcileConnectedSites', () => {
lastPushTimestamp: null,
},
];
const result = reconcileConnectedSites( connectedSites, originalSitesFromWpCom );
const result = reconcileConnectedSites( connectedSites, freshWpComSites );
expect( result.stagingSitesToDelete ).toEqual( [ { id: 2, localSiteId: 'local-site-id' } ] );
expect( result.stagingSitesToAdd ).toEqual( [
{
...originalSitesFromWpCom[ 1 ],
...freshWpComSites[ 1 ],
syncSupport: 'already-connected',
},
] );
Expand Down Expand Up @@ -208,7 +208,7 @@ describe( 'reconcileConnectedSites', () => {
lastPushTimestamp: null,
},
];
const originalSitesFromWpCom: SyncSite[] = [
const freshWpComSites: SyncSite[] = [
{
id: 1,
stagingSiteIds: [ 2 ],
Expand All @@ -232,7 +232,7 @@ describe( 'reconcileConnectedSites', () => {
lastPushTimestamp: null,
},
];
const result = reconcileConnectedSites( connectedSites, originalSitesFromWpCom );
const result = reconcileConnectedSites( connectedSites, freshWpComSites );
expect( result.stagingSitesToDelete ).toEqual( [] );
expect( result.stagingSitesToAdd ).toEqual( [] );
} );
Expand Down Expand Up @@ -262,7 +262,7 @@ describe( 'reconcileConnectedSites', () => {
lastPushTimestamp: null,
},
];
const originalSitesFromWpCom: SyncSite[] = [
const freshWpComSites: SyncSite[] = [
{
id: 1,
stagingSiteIds: [ 2 ],
Expand Down Expand Up @@ -308,25 +308,25 @@ describe( 'reconcileConnectedSites', () => {
lastPushTimestamp: null,
},
];
const result = reconcileConnectedSites( connectedSites, originalSitesFromWpCom );
const result = reconcileConnectedSites( connectedSites, freshWpComSites );
expect( result.stagingSitesToAdd ).toEqual( [
{
...originalSitesFromWpCom[ 2 ],
...freshWpComSites[ 2 ],
syncSupport: 'already-connected',
},
{
...originalSitesFromWpCom[ 3 ],
...freshWpComSites[ 3 ],
syncSupport: 'already-connected',
},
] );
expect( result.stagingSitesToDelete ).toEqual( [] );
expect( result.updatedConnectedSites ).toEqual( [
{
...originalSitesFromWpCom[ 0 ],
...freshWpComSites[ 0 ],
syncSupport: 'already-connected',
},
{
...originalSitesFromWpCom[ 1 ],
...freshWpComSites[ 1 ],
syncSupport: 'already-connected',
},
] );
Expand Down Expand Up @@ -378,7 +378,7 @@ describe( 'reconcileConnectedSites', () => {
lastPushTimestamp: null,
},
];
const originalSitesFromWpCom: SyncSite[] = [
const freshWpComSites: SyncSite[] = [
{
id: 1,
stagingSiteIds: [],
Expand All @@ -402,14 +402,14 @@ describe( 'reconcileConnectedSites', () => {
lastPushTimestamp: null,
},
];
const result = reconcileConnectedSites( connectedSites, originalSitesFromWpCom );
const result = reconcileConnectedSites( connectedSites, freshWpComSites );
expect( result.updatedConnectedSites ).toEqual( [
{
...originalSitesFromWpCom[ 0 ],
...freshWpComSites[ 0 ],
syncSupport: 'already-connected',
},
{
...originalSitesFromWpCom[ 1 ],
...freshWpComSites[ 1 ],
syncSupport: 'already-connected',
},
{
Expand Down
22 changes: 13 additions & 9 deletions src/hooks/use-fetch-wpcom-sites/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import type { SyncSite, SyncSupport } from './types';
type SitesEndpointSite = {
ID: number;
is_wpcom_atomic: boolean;
is_wpcom_staging_site: boolean;
name: string;
URL: string;
jetpack?: boolean;
Expand Down Expand Up @@ -67,22 +66,23 @@ function getSyncSupport( site: SitesEndpointSite, connectedSiteIds: number[] ):

export function transformSingleSiteResponse(
site: SitesEndpointSite,
syncSupport: SyncSupport
syncSupport: SyncSupport,
isStaging: boolean
): SyncSite {
return {
id: site.ID,
localSiteId: '',
name: site.name,
url: site.URL,
isStaging: site.is_wpcom_staging_site,
isStaging,
stagingSiteIds: site.options?.wpcom_staging_blog_ids ?? [],
syncSupport,
lastPullTimestamp: null,
lastPushTimestamp: null,
};
}

function transformSiteResponse(
function transformSitesResponse(
sites: SitesEndpointSite[],
connectedSiteIds: number[]
): SyncSite[] {
Expand All @@ -91,7 +91,12 @@ function transformSiteResponse(
return acc;
}

acc.push( transformSingleSiteResponse( site, getSyncSupport( site, connectedSiteIds ) ) );
const syncSupport = getSyncSupport( site, connectedSiteIds );
// The API returns the wrong value for the `is_wpcom_staging_site` prop while staging sites
// are being created. Hence the check in other sites' `wpcom_staging_blog_ids` arrays.
const isStaging = sites.some( ( s ) => s.options?.wpcom_staging_blog_ids?.includes( site.ID ) );

acc.push( transformSingleSiteResponse( site, syncSupport, isStaging ) );

return acc;
}, [] );
Expand Down Expand Up @@ -132,15 +137,14 @@ export const useFetchWpComSites = ( connectedSiteIdsOnlyForSelectedSite: number[
path: `/me/sites`,
},
{
fields:
'name,ID,URL,plan,is_wpcom_staging_site,is_wpcom_atomic,options,jetpack,is_deleted',
fields: 'name,ID,URL,plan,is_wpcom_atomic,options,jetpack,is_deleted',
filter: 'atomic,wpcom',
options: 'created_at,wpcom_staging_blog_ids',
site_activity: 'active',
}
);

const syncSites = transformSiteResponse(
const syncSites = transformSitesResponse(
response.sites,
allConnectedSites.map( ( { id } ) => id )
);
Expand Down Expand Up @@ -186,7 +190,7 @@ export const useFetchWpComSites = ( connectedSiteIdsOnlyForSelectedSite: number[
}, [ fetchSites ] );

const syncSitesWithSyncSupportForSelectedSite = useMemo(
() => transformSiteResponse( rawSyncSites, memoizedConnectedSiteIds ),
() => transformSitesResponse( rawSyncSites, memoizedConnectedSiteIds ),
[ rawSyncSites, memoizedConnectedSiteIds ]
);

Expand Down
1 change: 1 addition & 0 deletions src/hooks/use-fetch-wpcom-sites/reconcile-connected-sites.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ export const reconcileConnectedSites = (
url: site.url,
syncSupport: site.syncSupport,
stagingSiteIds: site.stagingSiteIds,
isStaging: site.isStaging,
};
}, [] );

Expand Down
Loading