Infrastructure/ghost
0
Fork 0
mirror of https://github.com/TryGhost/Ghost.git synced 2025-04-01 02:41:39 -05:00
Code Issues Activity

Added test coverage for sitemap base generator

Browse source 
refs https://github.com/TryGhost/Toolbox/issues/503

- The "updateURL" method was not covered during implementation. Covering the gap with basic tests for the "updateURL" method
This commit is contained in:
Naz 2023-01-23 16:10:12 +08:00
parent 4aacd50fee
commit 2a01dd0481
No known key found for this signature in database
2 changed files with 39 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
ghost/core/core/frontend/services/sitemap/base-generator.js
View file

@ -55,7 +55,7 @@ class BaseSiteMapGenerator {
// Generate full xml
let sitemapXml = localUtils.getDeclarations() + xml(data);
// Perform url transformatons
// Perform url transformations
// - Necessary because sitemap data is supplied by the router which
// uses knex directly bypassing model-layer attribute transforms
sitemapXml = urlUtils.transformReadyToAbsolute(sitemapXml);
@ -64,9 +64,12 @@ class BaseSiteMapGenerator {
}
updateURL(datum) {
const url = this.nodeLookup[datum.id].url[0].loc;
this.removeUrl(url, datum);
this.addUrl(url, datum);
const url = this.nodeLookup[datum.id]?.url[0].loc;
if (url) {
this.removeUrl(url, datum);
this.addUrl(url, datum);
}
}
addUrl(url, datum) {

34
ghost/core/test/unit/frontend/services/sitemap/generator.test.js
View file

@ -2,6 +2,8 @@ const should = require('should');
const sinon = require('sinon');
const ObjectId = require('bson-objectid').default;
const _ = require('lodash');
const moment = require('moment');
const assert = require('assert');
const testUtils = require('../../../../utils');
const urlUtils = require('../../../../../core/shared/url-utils');
const IndexGenerator = require('../../../../../core/frontend/services/sitemap/index-generator');
@ -97,7 +99,7 @@ describe('Generators', function () {
generator.types.pages.addUrl('http://my-ghost-blog.com/home/', {id: 'identifier1', staticRoute: true});
generator.types.tags.addUrl('http://my-ghost-blog.com/home/', {id: 'identifier1', staticRoute: true});
generator.types.authors.addUrl('http://my-ghost-blog.com/home/', {id: 'identifier1', staticRoute: true});
const xml = generator.getXml();
xml.should.match(/sitemap-tags.xml/);
@ -108,7 +110,7 @@ describe('Generators', function () {
it('does not create entries for pages with no content', function () {
generator.types.tags.addUrl('http://my-ghost-blog.com/episode-1/', {id: 'identifier1', staticRoute: true});
const xml = generator.getXml();
xml.should.match(/sitemap-tags.xml/);
@ -244,6 +246,34 @@ describe('Generators', function () {
});
});
describe('fn: updateURL', function () {
it('updates existing url', function () {
const postDatumToUpdate = testUtils.DataGenerator.forKnex.createPost({
updated_at: (Date.UTC(2014, 11, 22, 12) - 360000) + 100
});
generator.addUrl('http://my-ghost-blog.com/url/100/', postDatumToUpdate);
assert.equal(generator.nodeLookup[postDatumToUpdate.id].url[0].loc, 'http://my-ghost-blog.com/url/100/');
const postWithUpdatedDatum = Object.assign({}, {
updated_at: (Date.UTC(2023, 11, 22, 12) - 360000)
}, postDatumToUpdate);
const updatedISOString = moment(postWithUpdatedDatum.updated_at).toISOString();
generator.updateURL(postWithUpdatedDatum);
assert.equal(generator.nodeLookup[postDatumToUpdate.id].url[0].loc, 'http://my-ghost-blog.com/url/100/');
assert.equal(generator.nodeLookup[postDatumToUpdate.id].url[1].lastmod, updatedISOString);
});
it('does not thrown when trying to update a non-existing url', function () {
const postDatumToUpdate = testUtils.DataGenerator.forKnex.createPost();
generator.updateURL(postDatumToUpdate);
assert.equal(generator.nodeLookup[postDatumToUpdate.id], undefined);
});
});
describe('fn: removeUrl', function () {
let post;