Infrastructure/ghost
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-01-06 22:40:14 -05:00
Code Issues Activity

Removed posts from Collections API

Browse source 
The correct mechanism for fetching posts from a collection is via the Posts API.
This removes all functionality of getting posts from the Collections API.

Co-authored-by: Naz <hi@nazavo.com>
This commit is contained in:
Fabien 'egg' O'Carroll 2023-07-25 15:19:19 +02:00 committed by GitHub
parent adc3f8e8ee
commit 63ab254e33
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 519 additions and 623 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
ghost/core/core/server/api/endpoints/utils/serializers/output/mappers/collections.js
View file

@ -6,23 +6,10 @@
*/
const mapper = (collection) => {
let json;
let posts;
if (collection.toJSON) {
json = collection.toJSON();
posts = json.posts.map((postId, index) => {
return {
id: postId,
sort_order: index
};
});
} else {
json = collection;
posts = json.posts.map((post) => {
return {
id: post.id,
sort_order: post.sort_order
};
});
}
const serialized = {
@ -34,8 +21,7 @@ const mapper = (collection) => {
filter: json.filter,
feature_image: json.feature_image || json.featureImage || null,
created_at: (json.created_at || json.createdAt).toISOString().replace(/\d{3}Z$/, '000Z'),
updated_at: (json.updated_at || json.updatedAt).toISOString().replace(/\d{3}Z$/, '000Z'),
posts
updated_at: (json.updated_at || json.updatedAt).toISOString().replace(/\d{3}Z$/, '000Z')
};
return serialized;

1048
ghost/core/test/e2e-api/admin/__snapshots__/collections.test.js.snap
View file

File diff suppressed because one or more lines are too long

78
ghost/core/test/e2e-api/admin/collections.test.js
View file

@ -12,7 +12,6 @@ const {
anyLocationFor,
anyObjectId,
anyISODateTime,
anyNumber,
anyString,
anyUuid,
anyArray,
@ -25,12 +24,6 @@ const matchCollection = {
updated_at: anyISODateTime
};
const tierSnapshot = {
id: anyObjectId,
created_at: anyISODateTime,
updated_at: anyISODateTime
};
const tagSnapshotMatcher = {
id: anyObjectId,
created_at: anyISODateTime,
@ -44,32 +37,15 @@ const matchPostShallowIncludes = {
url: anyString,
authors: anyArray,
primary_author: anyObject,
tags: Array(2).fill(tagSnapshotMatcher),
tags: anyArray,
primary_tag: anyObject,
tiers: Array(2).fill(tierSnapshot),
tiers: anyArray,
created_at: anyISODateTime,
updated_at: anyISODateTime,
published_at: anyISODateTime,
post_revisions: anyArray
};
/**
*
* @param {number} postCount
*/
const buildMatcher = (postCount, opts = {}) => {
let obj = {
id: anyObjectId
};
if (opts.withSortOrder) {
obj.sort_order = anyNumber;
}
return {
...matchCollection,
posts: Array(postCount).fill(obj)
};
};
describe('Collections API', function () {
let agent;
@ -117,9 +93,9 @@ describe('Collections API', function () {
})
.matchBodySnapshot({
collections: [
buildMatcher(13, {withSortOrder: true}),
buildMatcher(2, {withSortOrder: true}),
buildMatcher(0)
matchCollection,
matchCollection,
matchCollection
]
});
});
@ -312,6 +288,7 @@ describe('Collections API', function () {
it('Creates an automatic Collection with a featured filter', async function () {
const collection = {
title: 'Test Featured Collection',
slug: 'featured-filter',
description: 'Test Collection Description',
type: 'automatic',
filter: 'featured:true'
@ -329,13 +306,24 @@ describe('Collections API', function () {
location: anyLocationFor('collections')
})
.matchBodySnapshot({
collections: [buildMatcher(2)]
collections: [matchCollection]
});
await agent.get(`posts/?collection=${collection.slug}`)
.expectStatus(200)
.matchHeaderSnapshot({
'content-version': anyContentVersion,
etag: anyEtag
})
.matchBodySnapshot({
posts: new Array(2).fill(matchPostShallowIncludes)
});
});
it('Creates an automatic Collection with a published_at filter', async function () {
const collection = {
title: 'Test Collection with published_at filter',
slug: 'published-at-filter',
description: 'Test Collection Description with published_at filter',
type: 'automatic',
filter: 'published_at:>=2022-05-25'
@ -353,14 +341,24 @@ describe('Collections API', function () {
location: anyLocationFor('collections')
})
.matchBodySnapshot({
collections: [buildMatcher(9)]
collections: [matchCollection]
});
await agent.get(`posts/?collection=${collection.slug}`)
.expectStatus(200)
.matchHeaderSnapshot({
'content-version': anyContentVersion,
etag: anyEtag
})
.matchBodySnapshot({
posts: new Array(7).fill(matchPostShallowIncludes)
});
});
it('Creates an automatic Collection with a tags filter', async function () {
const collection = {
title: 'Test Collection with tags filter',
slug: 'bacon',
title: 'Test Collection with tag filter',
slug: 'tag-filter',
description: 'BACON!',
type: 'automatic',
filter: 'tags:[\'bacon\']'
@ -378,7 +376,7 @@ describe('Collections API', function () {
location: anyLocationFor('collections')
})
.matchBodySnapshot({
collections: [buildMatcher(2)]
collections: [matchCollection]
});
await agent.get(`posts/?collection=${collection.slug}`)
@ -388,7 +386,10 @@ describe('Collections API', function () {
etag: anyEtag
})
.matchBodySnapshot({
posts: new Array(2).fill(matchPostShallowIncludes)
posts: new Array(2).fill({
...matchPostShallowIncludes,
tags: new Array(2).fill(tagSnapshotMatcher)
})
});
});
@ -413,7 +414,7 @@ describe('Collections API', function () {
location: anyLocationFor('collections')
})
.matchBodySnapshot({
collections: [buildMatcher(2)]
collections: [matchCollection]
});
await agent.get(`posts/?collection=${collection.slug}`)
@ -423,7 +424,10 @@ describe('Collections API', function () {
etag: anyEtag
})
.matchBodySnapshot({
posts: new Array(2).fill(matchPostShallowIncludes)
posts: new Array(2).fill({
...matchPostShallowIncludes,
tags: new Array(2).fill(tagSnapshotMatcher)
})
});
});
});