Reverted "Deprecated models.init pattern for initializing models"

ref https://linear.app/ghost/issue/ENG-2071/remove-modelsinit-pattern

- this reverts commit da101af

Author: daniellockyer

ghost/core/core/boot.js

@@ -91,6 +91,12 @@ async function initCore({ghostServer, config, frontend}) {
     require('./shared/url-utils');
     debug('End: Load urlUtils');
 
+    // Models are the heart of Ghost - this is a syncronous operation
+    debug('Begin: models');
+    const models = require('./server/models');
+    models.init();
+    debug('End: models');
+
     // Settings are a core concept we use settings to store key-value pairs used in critical pathways as well as public data like the site title
     debug('Begin: settings');
     const settings = require('./server/services/settings/settings-service');

ghost/core/core/cli/generate-data.js

@@ -21,6 +21,8 @@ module.exports = class DataGeneratorCommand extends Command {
         const models = require('../server/models');
         const knex = require('../server/data/db/connection');
 
+        models.init();
+
         context.models = models;
         context.m = models;
         context.knex = knex;

ghost/core/core/cli/repl.js

@@ -12,6 +12,8 @@ module.exports = class REPL extends Command {
         const models = require('../server/models');
         const knex = require('../server/data/db/connection');
 
+        models.init();
+
         context.models = models;
         context.m = models;
         context.knex = knex;

ghost/core/core/server/data/migrations/hooks/init/before.js

@@ -1,3 +1,6 @@
+const models = require('../../../../models');
+
 module.exports = function before() {
+    models.init();
     return Promise.resolve();
 };

ghost/core/core/server/models/base/listeners.js

@@ -1,12 +1,10 @@
 const moment = require('moment-timezone');
 const _ = require('lodash');
+const models = require('../../models');
 const logging = require('@tryghost/logging');
 const errors = require('@tryghost/errors');
 const {sequence} = require('@tryghost/promise');
 
-const {Post: PostModel} = require('../post');
-const {Settings: SettingsModel} = require('../settings');
-
 // Listen to settings.timezone.edited and settings.notifications.edited to bind extra logic to settings, similar to the bridge and member service
 const events = require('../../lib/common/events');
 
@@ -38,13 +36,12 @@ events.on('settings.timezone.edited', function (settingModel, options) {
      * We lock the target row on fetch by using the `forUpdate` option.
      * Read more in models/post.js - `onFetching`
      */
-
-    return PostModel.transaction(async function (transacting) {
+    return models.Base.transaction(async function (transacting) {
         options.transacting = transacting;
         options.forUpdate = true;
 
         try {
-            const results = await PostModel.findAll(_.merge({filter: 'status:scheduled'}, options));
+            const results = await models.Post.findAll(_.merge({filter: 'status:scheduled'}, options));
             if (!results.length) {
                 return;
             }
@@ -70,7 +67,7 @@ events.on('settings.timezone.edited', function (settingModel, options) {
                 }
 
                 try {
-                    await PostModel.edit(post.toJSON(), _.merge({id: post.id}, options));
+                    await models.Post.edit(post.toJSON(), _.merge({id: post.id}, options));
                 } catch (err) {
                     logging.error(new errors.InternalServerError({
                         err
@@ -114,7 +111,7 @@ events.on('settings.notifications.edited', function (settingModel) {
         return;
     }
 
-    return SettingsModel.edit({
+    return models.Settings.edit({
         key: 'notifications',
         value: JSON.stringify(allNotifications)
     }, options).catch(function (err) {

ghost/core/core/server/models/index.js

@@ -1,87 +1,35 @@
-/* eslint-disable max-lines */
+/**
+ * Dependencies
+ */
+
+const _ = require('lodash');
+const debug = require('@tryghost/debug')('models');
+const glob = require('glob');
 
 // enable event listeners
 require('./base/listeners');
 
 /**
  * Expose all models
  */
-module.exports = {
-    // `base` file does not export a Base model
-    Base: require('./base'),
+exports = module.exports;
 
-    ...require('./action'),
-    ...require('./author'),
-    ...require('./api-key'),
-    ...require('./benefit'),
-    ...require('./collection-post'),
-    ...require('./collection'),
-    ...require('./comment-like'),
-    ...require('./comment-report'),
-    ...require('./comment'),
-    ...require('./custom-theme-setting'),
-    ...require('./donation-payment-event'),
-    ...require('./email-batch'),
-    ...require('./email-recipient-failure'),
-    ...require('./email-recipient'),
-    ...require('./email-spam-complaint-event'),
-    ...require('./email'),
-    ...require('./integration'),
-    ...require('./invite'),
-    ...require('./job'),
-    ...require('./label'),
-    ...require('./mail-event'),
-    ...require('./member-cancel-event'),
-    ...require('./member-click-event'),
-    ...require('./member-created-event'),
-    ...require('./member-email-change-event'),
-    ...require('./member-feedback'),
-    ...require('./member-login-event'),
-    ...require('./member-newsletter'),
-    ...require('./member-paid-subscription-event'),
-    ...require('./member-payment-event'),
-    ...require('./member-product-event'),
-    ...require('./member-status-event'),
-    ...require('./member-stripe-customer'),
-    ...require('./member-subscribe-event'),
-    ...require('./member'),
-    ...require('./mention'),
-    ...require('./milestone'),
-    ...require('./mobiledoc-revision'),
-    ...require('./newsletter'),
-    ...require('./offer-redemption'),
-    ...require('./offer'),
-    ...require('./permission'),
-    ...require('./post-revision'),
-    ...require('./post'),
-    ...require('./posts-meta'),
-    ...require('./product'),
-    ...require('./recommendation-click-event'),
-    ...require('./recommendation-subscribe-event'),
-    ...require('./recommendation'),
-    ...require('./redirect'),
-    ...require('./role'),
-    ...require('./session'),
-    ...require('./settings'),
-    ...require('./single-use-token'),
-    ...require('./snippet'),
-    ...require('./stripe-customer-subscription'),
-    ...require('./stripe-price'),
-    ...require('./stripe-product'),
-    ...require('./subscription-created-event'),
-    ...require('./suppression'),
-    ...require('./tag-public'),
-    ...require('./tag'),
-    ...require('./user'),
-    ...require('./webhook')
-};
+function init() {
+    const baseNow = Date.now();
+    exports.Base = require('./base');
+    debug(`${Date.now() - baseNow}ms - Base.js require`);
+
+    let modelsFiles = glob.sync('!(index).js', {cwd: __dirname});
+    modelsFiles.forEach((model) => {
+        const name = model.replace(/.js$/, '');
+        const modelNow = Date.now();
+        _.extend(exports, require('./' + name));
+        debug(`${Date.now() - modelNow}ms - ${model} require`);
+    });
+}
 
 /**
- * @deprecated: remove this once we've removed it from everywhere
+ * Expose `init`
  */
-module.exports.init = function init() {
-    if (process.env.NODE_ENV !== 'production') {
-        // eslint-disable-next-line no-console
-        console.warn('@deprecated: models.init() is deprecated. Models are now automatically required.');
-    }
-};
+
+exports.init = init;

ghost/core/core/server/models/user.js

@@ -9,6 +9,7 @@ const errors = require('@tryghost/errors');
 const security = require('@tryghost/security');
 const {pipeline} = require('@tryghost/promise');
 const validatePassword = require('../lib/validate-password');
+const permissions = require('../services/permissions');
 const urlUtils = require('../../shared/url-utils');
 const activeStates = ['active', 'warn-1', 'warn-2', 'warn-3', 'warn-4'];
 const ASSIGNABLE_ROLES = ['Administrator', 'Editor', 'Author', 'Contributor'];
@@ -904,7 +905,6 @@ User = ghostBookshelf.Model.extend({
                         // @NOTE: your role is not the same than the role you try to change (!)
                         // e.g. admin can assign admin role to a user, but not owner
 
-                        const permissions = require('../services/permissions');
                         return permissions.canThis(context).assign.role(role)
                             .then(() => {
                                 if (hasUserPermission && hasApiKeyPermission) {

ghost/core/core/server/services/update-check/run-update-check.js

@@ -31,6 +31,10 @@ if (parentPort) {
 (async () => {
     const updateCheck = require('./');
 
+    // INIT required services
+    const models = require('../../models');
+    models.init();
+
     const permissions = require('../permissions');
     await permissions.init();
 

ghost/core/core/server/web/api/testmode/jobs/graceful-job.js

@@ -25,6 +25,8 @@ const internalContext = {context: {internal: true}};
 (async () => {
     const models = require('../../../../models');
 
+    await models.init();
+
     postParentPortMessage(`Fetching tags`);
     const tags = await models.Tag.findPage(internalContext);
 

ghost/core/test/integration/url_service.test.js

@@ -2,11 +2,16 @@ const should = require('should');
 const sinon = require('sinon');
 const testUtils = require('../utils');
 const configUtils = require('../utils/configUtils');
+const models = require('../../core/server/models');
 const UrlService = require('../../core/server/services/url/UrlService');
 
 describe('Integration: services/url/UrlService', function () {
     let urlService;
 
+    before(function () {
+        models.init();
+    });
+
     before(testUtils.teardownDb);
     before(testUtils.setup('users:roles', 'posts'));
     after(testUtils.teardownDb);

ghost/core/test/regression/api/admin/schedules.test.js

@@ -15,6 +15,8 @@ describe('Schedules API', function () {
     let request;
 
     before(function () {
+        models.init();
+
         // @NOTE: mock the post scheduler, otherwise it will auto publish the post
         sinon.stub(SchedulingDefault.prototype, '_pingUrl').resolves();
     });

ghost/core/test/regression/models/model_settings.test.js

@@ -8,6 +8,7 @@ const models = require('../../../core/server/models');
 const SETTINGS_LENGTH = 94;
 
 describe('Settings Model', function () {
+    before(models.init);
     afterEach(testUtils.teardownDb);
 
     describe('defaults', function () {

ghost/core/test/unit/api/cache-invalidation.test.js

@@ -3,8 +3,15 @@ const path = require('path');
 
 const glob = require('glob');
 
+const models = require('../../../core/server/models');
+
 describe('API', function () {
     describe('Cache Invalidation', function () {
+        before(async function () {
+            // Initialise models - Utilised by various endpoints to reference static fields (i.e models.Post.allowedFormats) when required in
+            models.init();
+        });
+
         it('Controller actions explicitly declare cacheInvalidate header', async function () {
             const controllersRootPath = path.join(__dirname, '../../../core/server/api/endpoints');
             const controllerPaths = glob.sync('*.js', {

ghost/core/test/unit/api/canary/session.test.js

@@ -8,6 +8,10 @@ const sessionController = require('../../../../core/server/api/endpoints/session
 const sessionServiceMiddleware = require('../../../../core/server/services/auth/session');
 
 describe('Session controller', function () {
+    before(function () {
+        models.init();
+    });
+
     afterEach(function () {
         sinon.restore();
     });

ghost/core/test/unit/api/canary/utils/validators/input/pages.test.js

@@ -5,6 +5,10 @@ const validators = require('../../../../../../../core/server/api/endpoints/utils
 const models = require('../../../../../../../core/server/models');
 
 describe('Unit: endpoints/utils/validators/input/pages', function () {
+    before(function () {
+        return models.init();
+    });
+
     beforeEach(function () {
         const memberFindPageStub = sinon.stub(models.Member, 'findPage').returns(Promise.reject());
         memberFindPageStub.withArgs({filter: 'label:vip', limit: 1}).returns(Promise.resolve());

ghost/core/test/unit/api/canary/utils/validators/input/posts.test.js

@@ -5,6 +5,10 @@ const validators = require('../../../../../../../core/server/api/endpoints/utils
 const models = require('../../../../../../../core/server/models');
 
 describe('Unit: endpoints/utils/validators/input/posts', function () {
+    before(function () {
+        models.init();
+    });
+
     beforeEach(function () {
         const memberFindPageStub = sinon.stub(models.Member, 'findPage').returns(Promise.reject());
         memberFindPageStub.withArgs({filter: 'label:vip', limit: 1}).returns(Promise.resolve());

ghost/core/test/unit/frontend/helpers/authors.test.js

@@ -2,9 +2,14 @@ const should = require('should');
 const sinon = require('sinon');
 const urlService = require('../../../../core/server/services/url');
 const authorsHelper = require('../../../../core/frontend/helpers/authors');
+const models = require('../../../../core/server/models');
 const testUtils = require('../../../utils');
 
 describe('{{authors}} helper', function () {
+    before(function () {
+        models.init();
+    });
+
     beforeEach(function () {
         sinon.stub(urlService, 'getUrlByResourceId');
     });

ghost/core/test/unit/frontend/helpers/get.test.js

@@ -7,6 +7,7 @@ const loggingLib = require('@tryghost/logging');
 
 // Stuff we are testing
 const get = require('../../../../core/frontend/helpers/get');
+const models = require('../../../../core/server/models');
 const proxy = require('../../../../core/frontend/services/proxy');
 const api = require('../../../../core/server/api').endpoints;
 
@@ -16,6 +17,10 @@ describe('{{#get}} helper', function () {
     let locals = {};
     let logging;
 
+    before(function () {
+        models.init();
+    });
+
     beforeEach(function () {
         fn = sinon.spy();
         inverse = sinon.spy();

ghost/core/test/unit/frontend/helpers/ghost_head.test.js

@@ -6,6 +6,7 @@ const _ = require('lodash');
 const moment = require('moment');
 const testUtils = require('../../../utils');
 const configUtils = require('../../../utils/configUtils');
+const models = require('../../../../core/server/models');
 const imageLib = require('../../../../core/server/lib/image');
 const routing = require('../../../../core/frontend/services/routing');
 const urlService = require('../../../../core/server/services/url');
@@ -357,6 +358,9 @@ describe('{{ghost_head}} helper', function () {
     };
 
     before(function () {
+        // @TODO: remove when visibility is refactored out of models
+        models.init();
+
         keyStub = sinon.stub().resolves('xyz');
         const dataService = {
             getFrontendKey: keyStub
@@ -1543,7 +1547,7 @@ describe('{{ghost_head}} helper', function () {
             }));
 
             rendered.should.match(/data-datasource="analytics_events_json_v1"/);
-        });
+        }); 
     });
     describe('respects values from excludes: ', function () {
         it('when excludes is empty', async function () {

ghost/core/test/unit/frontend/helpers/recommendations.test.js

@@ -1,5 +1,6 @@
 const should = require('should');
 const sinon = require('sinon');
+const models = require('../../../../core/server/models');
 const api = require('../../../../core/server/api').endpoints;
 const hbs = require('../../../../core/frontend/services/theme-engine/engine');
 const configUtils = require('../../../utils/configUtils');
@@ -20,6 +21,8 @@ describe('{{#recommendations}} helper', function () {
     let logging;
 
     before(function () {
+        models.init();
+
         hbs.express4({
             partialsDir: [configUtils.config.get('paths').helperTemplates]
         });