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.

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

Removed lodash from data-manipulation and sanitize model plugins #22084

Merged
merged 1 commit into from
Feb 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion ghost/core/core/frontend/helpers/foreach.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ module.exports = function foreach(items, options) {
if (Object.values(items).length > 0 && checks.isPost(Object.values(items)[0])) {
visibility = visibility || 'all';
}
}
}

if (_.isArray(items) && items.length > 0 && checks.isNewsletter(items[0])) {
visibility = visibility || 'all';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,10 @@ const readingMinutes = require('@tryghost/helpers').utils.readingMinutes;
* @returns {void} - modifies attrs
*/
module.exports.forPost = (options, model, attrs) => {
const _ = require('lodash');
// This function is split up in 3 conditions for 3 different purposes:
// 1. Gets excerpt from post's plaintext. If custom_excerpt exists, it overrides the excerpt but the key remains excerpt.
if (Object.prototype.hasOwnProperty.call(options, 'columns') || _.includes(options.columns, 'excerpt') || _.includes(options.columns, 'excerpt') && options.formats && options.formats.includes('plaintext')) {
if (_.includes(options.columns, 'excerpt')) {
if (Object.prototype.hasOwnProperty.call(options, 'columns') || options.columns?.includes('excerpt') || (options.columns?.includes('excerpt') && options.formats?.includes('plaintext'))) {
if (options.columns?.includes('excerpt')) {
if (!attrs.custom_excerpt || attrs.custom_excerpt === null) {
let plaintext = model.get('plaintext');
if (plaintext) {
Expand All @@ -25,15 +24,15 @@ module.exports.forPost = (options, model, attrs) => {
}
} else {
attrs.excerpt = attrs.custom_excerpt;
if (!_.includes(options.columns, 'custom_excerpt')) {
if (!options.columns?.includes('custom_excerpt')) {
delete attrs.custom_excerpt;
}
}
}
}

// 2. Displays plaintext if requested by user as a field. Also works if used as format.
if (_.includes(options.columns, 'plaintext') || options.formats && options.formats.includes('plaintext')) {
if (options.columns?.includes('plaintext') || options.formats?.includes('plaintext')) {
let plaintext = model.get('plaintext');
if (plaintext) {
attrs.plaintext = plaintext;
Expand Down Expand Up @@ -62,7 +61,7 @@ module.exports.forPost = (options, model, attrs) => {
// reading_time still only works when used along with formats=html.

if (!Object.prototype.hasOwnProperty.call(options, 'columns') ||
(options.columns.includes('reading_time'))) {
(options.columns?.includes('reading_time'))) {
if (attrs.html) {
let additionalImages = 0;

Expand Down
35 changes: 21 additions & 14 deletions ghost/core/core/server/models/base/plugins/data-manipulation.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
const _ = require('lodash');
const moment = require('moment');

const schema = require('../../../data/schema');
Expand All @@ -25,18 +24,18 @@ module.exports = function (Bookshelf) {
/**
* before we insert dates into the database, we have to normalize
* date format is now in each db the same
*
* @param {object} attrs - attributes to convert
* @returns {object} attrs - converted attributes
*/
fixDatesWhenSave: function fixDatesWhenSave(attrs) {
const self = this;
const tableDef = schema.tables[this.tableName];

_.each(attrs, function each(value, key) {
if (value !== null
&& Object.prototype.hasOwnProperty.call(schema.tables, self.tableName)
&& Object.prototype.hasOwnProperty.call(schema.tables[self.tableName], key)
&& schema.tables[self.tableName][key].type === 'dateTime') {
attrs[key] = moment(value).format('YYYY-MM-DD HH:mm:ss');
for (const key in attrs) {
if (attrs[key] && tableDef?.[key]?.type === 'dateTime') {
attrs[key] = moment(attrs[key]).format('YYYY-MM-DD HH:mm:ss');
}
});
}

return attrs;
},
Expand All @@ -48,11 +47,14 @@ module.exports = function (Bookshelf) {
* - knex returns a UTC String (2018-04-12 20:50:35)
* mysql:
* - knex wraps the UTC value into a local JS Date
*
* @param {object} attrs - attributes to convert
* @returns {object} attrs - converted attributes
*/
fixDatesWhenFetch: function fixDatesWhenFetch(attrs) {
const tableDef = schema.tables[this.tableName];

Object.keys(attrs).forEach((key) => {
for (const key in attrs) {
if (attrs[key] && tableDef?.[key]?.type === 'dateTime') {
const dateMoment = moment(attrs[key]);

Expand All @@ -64,20 +66,25 @@ module.exports = function (Bookshelf) {
attrs[key] = moment().startOf('seconds').toDate();
}
}
});
}

return attrs;
},

// Convert integers to real booleans
/**
* Convert integers to real booleans
*
* @param {object} attrs - attributes to convert
* @returns {object} attrs - converted attributes
*/
fixBools: function fixBools(attrs) {
const tableDef = schema.tables[this.tableName];

Object.keys(attrs).forEach((key) => {
for (const key in attrs) {
if (tableDef?.[key]?.type === 'boolean') {
attrs[key] = !!attrs[key];
}
});
}

return attrs;
}
Expand Down
6 changes: 3 additions & 3 deletions ghost/core/core/server/models/base/plugins/overrides.js
Original file line number Diff line number Diff line change
Expand Up @@ -81,11 +81,11 @@ module.exports = function (Bookshelf) {
* removes null relations coming from `hasOne` - https://bookshelfjs.org/api.html#Model-instance-hasOne
* Based on https://github.com/bookshelf/bookshelf/issues/72#issuecomment-25164617
*/
_.each(this.relations, (value, key) => {
if (_.isEmpty(value)) {
for (const key in this.relations) {
if (_.isEmpty(this.relations[key])) {
delete this.relations[key];
}
});
}
// CASE: get JSON of previous attrs
if (options.previous) {
const clonedModel = _.cloneDeep(this);
Expand Down
2 changes: 1 addition & 1 deletion ghost/core/core/server/models/base/plugins/sanitize.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ module.exports = function (Bookshelf) {
Bookshelf.Model = Bookshelf.Model.extend({
// Ghost option handling - get permitted attributes from server/data/schema.js, where the DB schema is defined
permittedAttributes: function permittedAttributes() {
return _.keys(schema.tables[this.tableName])
return Object.keys(schema.tables[this.tableName] || {})
.filter(key => key.indexOf('@@') === -1);
}
}, {
Expand Down