models initialization refactored, better dev experience as backend hmr is working

2022-12-23 01:08:14 +01:00
parent 380eaa87ca
commit cbed0288fe
43 changed files with 624 additions and 707 deletions
--- a/server/api/models/announcement.js
+++ b/server/api/models/announcement.js
@@ -1,12 +1,6 @@
-const sequelize = require('./index').sequelize
-const { Model, DataTypes } = require('sequelize')
-
-class Announcement extends Model {}
-
-Announcement.init({
-  title: DataTypes.STRING,
-  announcement: DataTypes.STRING,
-  visible: DataTypes.BOOLEAN
-}, { sequelize, modelName: 'announcement' })
-
-module.exports = Announcement
+module.exports = (sequelize, DataTypes) => 
+  sequelize.define('announcement', {
+    title: DataTypes.STRING,
+    announcement: DataTypes.STRING,
+    visible: DataTypes.BOOLEAN
+  })
--- a/server/api/models/ap_user.js
+++ b/server/api/models/ap_user.js
@@ -1,9 +1,6 @@
-const sequelize = require('./index').sequelize
-const { Model, DataTypes } = require('sequelize')

-class APUser extends Model {}
-
-APUser.init({
+module.exports = (sequelize, DataTypes) =>
+  sequelize.define('ap_user', {
  ap_id: {
    type: DataTypes.STRING,
    primaryKey: true
@@ -11,6 +8,4 @@ APUser.init({
  follower: DataTypes.BOOLEAN,
  blocked: DataTypes.BOOLEAN,
  object: DataTypes.JSON
-}, { sequelize, modelName: 'ap_user' })
-
-module.exports = APUser
+})
--- a/server/api/models/collection.js
+++ b/server/api/models/collection.js
@@ -1,28 +1,20 @@
-const { Model, DataTypes } = require('sequelize')
-const sequelize = require('./index').sequelize
-
-class Collection extends Model {}
-
-// TODO: slugify!
-Collection.init({
-  id: {
-    type: DataTypes.INTEGER,
-    autoIncrement: true,
-    primaryKey: true,
-  },
-  name: {
-    type: DataTypes.STRING,
-    unique: true,
-    index: true,
-    allowNull: false
-  },
-  isActor: {
-    type: DataTypes.BOOLEAN
-  },
-  isTop: {
-    type: DataTypes.BOOLEAN
-  }
-}, { sequelize, modelName: 'collection', timestamps: false })
-
-
-module.exports = Collection
+module.exports = (sequelize, DataTypes) => 
+  sequelize.define('collection', {
+    id: {
+      type: DataTypes.INTEGER,
+      autoIncrement: true,
+      primaryKey: true,
+    },
+    name: {
+      type: DataTypes.STRING,
+      unique: true,
+      index: true,
+      allowNull: false
+    },
+    isActor: {
+      type: DataTypes.BOOLEAN
+    },
+    isTop: {
+      type: DataTypes.BOOLEAN
+    }
+  }, { timestamps: false })
--- a/server/api/models/event.js
+++ b/server/api/models/event.js
@@ -1,18 +1,5 @@
 const config = require('../../config')
 const { htmlToText } = require('html-to-text')
-
-const { Model, DataTypes } = require('sequelize')
-const SequelizeSlugify = require('sequelize-slugify')
-
-const sequelize = require('./index').sequelize
-
-const Resource = require('./resource')
-const Notification = require('./notification')
-const EventNotification = require('./eventnotification')
-const Place = require('./place')
-const User = require('./user')
-const Tag = require('./tag')
-
 const dayjs = require('dayjs')
 const timezone = require('dayjs/plugin/timezone')
 const utc = require('dayjs/plugin/utc')
@@ -20,108 +7,88 @@ const utc = require('dayjs/plugin/utc')
 dayjs.extend(utc)
 dayjs.extend(timezone)

-class Event extends Model {}
-
-Event.init({
-  id: {
-    allowNull: false,
-    type: DataTypes.INTEGER,
-    primaryKey: true,
-    autoIncrement: true
-  },
-  title: DataTypes.STRING,
-  slug: {
-    type: DataTypes.STRING,
-    index: true,
-    unique: true
-  },
-  description: DataTypes.TEXT,
-  multidate: DataTypes.BOOLEAN,
-  start_datetime: {
-    type: DataTypes.INTEGER,
-    index: true
-  },
-  end_datetime: {
-    type: DataTypes.INTEGER,
-    index: true
-  },
-  image_path: DataTypes.STRING,
-  media: DataTypes.JSON,
-  is_visible: DataTypes.BOOLEAN,
-  recurrent: DataTypes.JSON,
-  likes: { type: DataTypes.JSON, defaultValue: [] },
-  boost: { type: DataTypes.JSON, defaultValue: [] }
-}, { sequelize, modelName: 'event' })
-
-Event.belongsTo(Place)
-Place.hasMany(Event)
-
-Event.belongsTo(User)
-User.hasMany(Event)
-
-Event.belongsToMany(Tag, { through: 'event_tags' })
-Tag.belongsToMany(Event, { through: 'event_tags' })
-
-Event.belongsToMany(Notification, { through: EventNotification })
-Notification.belongsToMany(Event, { through: EventNotification })
-
-Event.hasMany(Resource)
-Resource.belongsTo(Event)
-
-Event.hasMany(Event, { as: 'child', foreignKey: 'parentId' })
-Event.belongsTo(Event, { as: 'parent' })
-
-SequelizeSlugify.slugifyModel(Event, { source: ['title'], overwrite: false })
-
-Event.prototype.toAP = function (username, locale, to = []) {
-  const tags = this.tags && this.tags.map(t => t.tag.replace(/[ #]/g, '_'))
-  const plainDescription = htmlToText(this.description && this.description.replace('\n', '').slice(0, 1000))
-  const content = `
+// class Event extends Model {}
+module.exports = (sequelize, DataTypes) => {
+  const Event = sequelize.define('event', {
+    id: {
+      allowNull: false,
+      type: DataTypes.INTEGER,
+      primaryKey: true,
+      autoIncrement: true
+    },
+    title: DataTypes.STRING,
+    slug: {
+      type: DataTypes.STRING,
+      index: true,
+      unique: true
+    },
+    description: DataTypes.TEXT,
+    multidate: DataTypes.BOOLEAN,
+    start_datetime: {
+      type: DataTypes.INTEGER,
+      index: true
+    },
+    end_datetime: {
+      type: DataTypes.INTEGER,
+      index: true
+    },
+    image_path: DataTypes.STRING,
+    media: DataTypes.JSON,
+    is_visible: DataTypes.BOOLEAN,
+    recurrent: DataTypes.JSON,
+    likes: { type: DataTypes.JSON, defaultValue: [] },
+    boost: { type: DataTypes.JSON, defaultValue: [] }
+  })
+  
+  Event.prototype.toAP = function (username, locale, to = []) {
+    const tags = this.tags && this.tags.map(t => t.tag.replace(/[ #]/g, '_'))
+    const plainDescription = htmlToText(this.description && this.description.replace('\n', '').slice(0, 1000))
+    const content = `
    📍 ${this.place && this.place.name}
    📅 ${dayjs.unix(this.start_datetime).tz().locale(locale).format('dddd, D MMMM (HH:mm)')}
-
+    
    ${plainDescription}
-  `
-
-  const attachment = []
-  if (this.media && this.media.length) {
-    attachment.push({
-      type: 'Document',
-      mediaType: 'image/jpeg',
-      url: `${config.baseurl}/media/${this.media[0].url}`,
-      name: this.media[0].name || this.title || '',
-      blurHash: null,
-      focalPoint: this.media[0].focalPoint || [0, 0]
-    })
+    `
+    
+    const attachment = []
+    if (this.media && this.media.length) {
+      attachment.push({
+        type: 'Document',
+        mediaType: 'image/jpeg',
+        url: `${config.baseurl}/media/${this.media[0].url}`,
+        name: this.media[0].name || this.title || '',
+        blurHash: null,
+        focalPoint: this.media[0].focalPoint || [0, 0]
+      })
+    }
+    
+    
+    return {
+      id: `${config.baseurl}/federation/m/${this.id}`,
+      name: this.title,
+      url: `${config.baseurl}/event/${this.slug || this.id}`,
+      type: 'Event',
+      startTime: dayjs.unix(this.start_datetime).tz().locale(locale).format(),
+      endTime: this.end_datetime ? dayjs.unix(this.end_datetime).tz().locale(locale).format() : null,
+      location: {
+        name: this.place.name,
+        address: this.place.address,
+        latitude: this.place.latitude,
+        longitude: this.place.longitude
+      },
+      attachment,
+      tag: tags && tags.map(tag => ({
+        type: 'Hashtag',
+        name: '#' + tag,
+        href: `${config.baseurl}/tag/${tag}`
+      })),
+      published: dayjs(this.createdAt).utc().format(),
+      attributedTo: `${config.baseurl}/federation/u/${username}`,
+      to: ['https://www.w3.org/ns/activitystreams#Public'],
+      cc: [`${config.baseurl}/federation/u/${username}/followers`],
+      content,
+      summary: content
+    }
  }
-
-
-  return {
-    id: `${config.baseurl}/federation/m/${this.id}`,
-    name: this.title,
-    url: `${config.baseurl}/event/${this.slug || this.id}`,
-    type: 'Event',
-    startTime: dayjs.unix(this.start_datetime).tz().locale(locale).format(),
-    endTime: this.end_datetime ? dayjs.unix(this.end_datetime).tz().locale(locale).format() : null,
-    location: {
-      name: this.place.name,
-      address: this.place.address,
-      latitude: this.place.latitude,
-      longitude: this.place.longitude
-    },
-    attachment,
-    tag: tags && tags.map(tag => ({
-      type: 'Hashtag',
-      name: '#' + tag,
-      href: `${config.baseurl}/tag/${tag}`
-    })),
-    published: dayjs(this.createdAt).utc().format(),
-    attributedTo: `${config.baseurl}/federation/u/${username}`,
-    to: ['https://www.w3.org/ns/activitystreams#Public'],
-    cc: [`${config.baseurl}/federation/u/${username}/followers`],
-    content,
-    summary: content
-  }
-}
-
-module.exports = Event
+  return Event
+}
--- a/server/api/models/eventnotification.js
+++ b/server/api/models/eventnotification.js
@@ -1,15 +1,9 @@
-const sequelize = require('./index').sequelize
-const { Model, DataTypes } = require('sequelize')
-
-class EventNotification extends Model {}
-
-EventNotification.init({
+module.exports = (sequelize, DataTypes) => 
+  sequelize.define('event_notification', {
  status: {
    type: DataTypes.ENUM,
    values: ['new', 'sent', 'error', 'sending'],
    defaultValue: 'new',
    index: true
  }
-}, { sequelize, modelName: 'event_notification' })
-
-module.exports = EventNotification
+})
--- a/server/api/models/filter.js
+++ b/server/api/models/filter.js
@@ -1,24 +1,20 @@
-const { Model, DataTypes } = require('sequelize')
-const Collection = require('./collection')
-const sequelize = require('./index').sequelize
-
-class Filter extends Model {}
-
-Filter.init({
-  id: {
-    type: DataTypes.INTEGER,
-    primaryKey: true,
-    autoIncrement: true,
-  },
-  tags: {
-    type: DataTypes.JSON,
-  },
-  places: {
-    type: DataTypes.JSON,
-  }
-}, { sequelize, modelName: 'filter', timestamps: false })
-
-Filter.belongsTo(Collection)
-Collection.hasMany(Filter)
-
-module.exports = Filter
+module.exports = (sequelize, DataTypes) => 
+  sequelize.define('filter', 
+  {
+    id: {
+      type: DataTypes.INTEGER,
+      primaryKey: true,
+      autoIncrement: true,
+    },
+    tags: {
+      type: DataTypes.JSON,
+    },
+    places: {
+      type: DataTypes.JSON,
+    }
+  }, {
+    indexes: [
+      { fields: ['collectionId', 'tags', 'places'], unique: true }
+    ],
+    timestamps: false
+  })
--- a/server/api/models/index.js
+++ b/server/api/models/index.js
@@ -4,10 +4,78 @@ const Umzug = require('umzug')
 const path = require('path')
 const config = require('../../config')
 const log = require('../../log')
-const settingsController = require('../controller/settings')
+const SequelizeSlugify = require('sequelize-slugify')
+const DB = require('./models')
+
+const models = {
+  Announcement: require('./announcement'),
+  APUser: require('./ap_user'),
+  Collection: require('./collection'),
+  Event: require('./event'),
+  EventNotification: require('./eventnotification'),
+  Filter: require('./filter'),
+  Instance: require('./instance'),
+  Notification: require('./notification'),
+  OAuthClient: require('./oauth_client'),
+  OAuthCode: require('./oauth_code'),
+  OAuthToken: require('./oauth_token'),
+  Place: require('./place'),
+  Resource: require('./resource'),
+  Setting: require('./setting'),
+  Tag: require('./tag'),
+  User: require('./user'),
+}

 const db = {
  sequelize: null,
+  loadModels () {
+
+    for (const modelName in models) {
+      const m = models[modelName](db.sequelize, Sequelize.DataTypes)
+      DB[modelName] = m
+    }
+
+  },
+  associates () {
+    const { Filter, Collection, APUser, Instance, User, Event, EventNotification, Tag,
+      OAuthCode, OAuthClient, OAuthToken, Resource, Place, Notification } = DB
+
+    Filter.belongsTo(Collection)
+    Collection.hasMany(Filter)
+
+    Instance.hasMany(APUser)
+    APUser.belongsTo(Instance)
+    
+    OAuthCode.belongsTo(User)
+    OAuthCode.belongsTo(OAuthClient, { as: 'client' })
+    
+    OAuthToken.belongsTo(User)
+    OAuthToken.belongsTo(OAuthClient, { as: 'client' })
+
+    APUser.hasMany(Resource)
+    Resource.belongsTo(APUser)
+
+    Event.belongsTo(Place)
+    Place.hasMany(Event)
+    
+    Event.belongsTo(User)
+    User.hasMany(Event)
+    
+    Event.belongsToMany(Tag, { through: 'event_tags' })
+    Tag.belongsToMany(Event, { through: 'event_tags' })
+    
+    Event.belongsToMany(Notification, { through: EventNotification })
+    Notification.belongsToMany(Event, { through: EventNotification })
+    
+    Event.hasMany(Resource)
+    Resource.belongsTo(Event)
+    
+    Event.hasMany(Event, { as: 'child', foreignKey: 'parentId' })
+    Event.belongsTo(Event, { as: 'parent' })
+    
+    SequelizeSlugify.slugifyModel(Event, { source: ['title'], overwrite: false })
+
+  },
  close() {
    if (db.sequelize) {
      return db.sequelize.close()
@@ -28,7 +96,6 @@ const db = {
      }
    }
    db.sequelize = new Sequelize(dbConf)
-    return db.sequelize.authenticate()
  },
  async isEmpty() {
    try {
@@ -57,13 +124,12 @@ const db = {
    })
    return umzug.up()
  },
-  async initialize() {
+  initialize() {
    if (config.status === 'CONFIGURED') {
      try {
-        await db.connect()
-        log.debug('Running migrations')
-        await db.runMigrations()
-        return settingsController.load()
+        db.connect()
+        db.loadModels()
+        db.associates()
      } catch (e) {
        log.warn(` ⚠️ Cannot connect to db, check your configuration => ${e}`)
        process.exit(1)
--- a/server/api/models/instance.js
+++ b/server/api/models/instance.js
@@ -1,11 +1,5 @@
-
-const sequelize = require('./index').sequelize
-const { Model, DataTypes } = require('sequelize')
-const APUser = require('./ap_user')
-
-class Instance extends Model {}
-
-Instance.init({
+module.exports = (sequelize, DataTypes) => 
+  sequelize.define('instance', {
  domain: {
    primaryKey: true,
    allowNull: false,
@@ -14,9 +8,4 @@ Instance.init({
  name: DataTypes.STRING,
  blocked: DataTypes.BOOLEAN,
  data: DataTypes.JSON
-}, { sequelize, modelName: 'instance' })
-
-Instance.hasMany(APUser)
-APUser.belongsTo(Instance)
-
-module.exports = Instance
+})
--- a/server/api/models/models.js
+++ b/server/api/models/models.js
@@ -0,0 +1,2 @@
+// export default models
+module.exports = {}
--- a/server/api/models/notification.js
+++ b/server/api/models/notification.js
@@ -1,10 +1,5 @@
-
-const sequelize = require('./index').sequelize
-const { Model, DataTypes } = require('sequelize')
-
-class Notification extends Model {}
-
-Notification.init({
+module.exports = (sequelize, DataTypes) => 
+  sequelize.define('notification', {
  filters: DataTypes.JSON,
  email: DataTypes.STRING,
  remove_code: DataTypes.STRING,
@@ -24,6 +19,4 @@ Notification.init({
    unique: true,
    fields: ['action', 'type']
  }]
-})
-
-module.exports = Notification
+})
--- a/server/api/models/oauth_client.js
+++ b/server/api/models/oauth_client.js
@@ -1,10 +1,5 @@
-
-const sequelize = require('./index').sequelize
-const { Model, DataTypes } = require('sequelize')
-
-class OAuthClient extends Model {}
-
-OAuthClient.init({
+module.exports = (sequelize, DataTypes) => 
+sequelize.define('oauth_client', {
  id: {
    type: DataTypes.STRING,
    primaryKey: true,
@@ -15,6 +10,4 @@ OAuthClient.init({
  scopes: DataTypes.STRING,
  redirectUris: DataTypes.STRING,
  website: DataTypes.STRING
-}, { sequelize, modelName: 'oauth_client' })
-
-module.exports = OAuthClient
+})
--- a/server/api/models/oauth_code.js
+++ b/server/api/models/oauth_code.js
@@ -1,13 +1,5 @@
-
-const sequelize = require('./index').sequelize
-const { Model, DataTypes } = require('sequelize')
-
-const User = require('./user')
-const OAuthClient = require('./oauth_client')
-
-class OAuthCode extends Model {}
-
-OAuthCode.init({
+module.exports = (sequelize, DataTypes) => 
+  sequelize.define('oauth_code', {
  authorizationCode: {
    type: DataTypes.STRING,
    primaryKey: true
@@ -15,9 +7,4 @@ OAuthCode.init({
  expiresAt: DataTypes.DATE,
  scope: DataTypes.STRING,
  redirect_uri: DataTypes.STRING
-}, { sequelize, modelName: 'oauth_code' })
-
-OAuthCode.belongsTo(User)
-OAuthCode.belongsTo(OAuthClient, { as: 'client' })
-
-module.exports = OAuthCode
+})
--- a/server/api/models/oauth_token.js
+++ b/server/api/models/oauth_token.js
@@ -1,13 +1,5 @@
-
-const sequelize = require('./index').sequelize
-const { Model, DataTypes } = require('sequelize')
-
-const User = require('./user')
-const OAuthClient = require('./oauth_client')
-
-class OAuthToken extends Model {}
-
-OAuthToken.init({
+module.exports = (sequelize, DataTypes) => 
+  sequelize.define('oauth_token', {
  accessToken: {
    type: DataTypes.STRING,
    allowNull: false,
@@ -27,9 +19,4 @@ OAuthToken.init({
    }
  },
  scope: DataTypes.STRING
-}, { sequelize, modelName: 'oauth_token' })
-
-OAuthToken.belongsTo(User)
-OAuthToken.belongsTo(OAuthClient, { as: 'client' })
-
-module.exports = OAuthToken
+})
--- a/server/api/models/place.js
+++ b/server/api/models/place.js
@@ -1,9 +1,5 @@
-const { Model, DataTypes } = require('sequelize')
-const sequelize = require('./index').sequelize
-
-class Place extends Model {}
-
-Place.init({
+module.exports = (sequelize, DataTypes) => 
+  sequelize.define('place', {
  name: {
    type: DataTypes.STRING,
    unique: true,
@@ -13,6 +9,4 @@ Place.init({
  address: DataTypes.STRING,
  latitude: DataTypes.FLOAT,
  longitude: DataTypes.FLOAT,
-}, { sequelize, modelName: 'place' })
-
-module.exports = Place
+})
--- a/server/api/models/resource.js
+++ b/server/api/models/resource.js
@@ -1,11 +1,5 @@
-const { Model, DataTypes } = require('sequelize')
-const sequelize = require('./index').sequelize
-
-const APUser = require('./ap_user')
-
-class Resource extends Model {}
-
-Resource.init({
+module.exports = (sequelize, DataTypes) => 
+  sequelize.define('resource', {
  activitypub_id: {
    type: DataTypes.STRING,
    index: true,
@@ -13,9 +7,4 @@ Resource.init({
  },
  hidden: DataTypes.BOOLEAN,
  data: DataTypes.JSON
-}, { sequelize, modelName: 'resource' })
-
-APUser.hasMany(Resource)
-Resource.belongsTo(APUser)
-
-module.exports = Resource
+})
--- a/server/api/models/setting.js
+++ b/server/api/models/setting.js
@@ -1,9 +1,5 @@
-const { Model, DataTypes } = require('sequelize')
-const sequelize = require('./index').sequelize
-
-class Setting extends Model {}
-
-Setting.init({
+module.exports = (sequelize, DataTypes) => 
+  sequelize.define('setting', {
  key: {
    type: DataTypes.STRING,
    primaryKey: true,
@@ -12,6 +8,4 @@ Setting.init({
  },
  value: DataTypes.JSON,
  is_secret: DataTypes.BOOLEAN
-}, { sequelize, modelName: 'setting' })
-
-module.exports = Setting
+})
--- a/server/api/models/tag.js
+++ b/server/api/models/tag.js
@@ -1,15 +1,9 @@
-const { Model, DataTypes } = require('sequelize')
-const sequelize = require('./index').sequelize
-
-class Tag extends Model {}
-
-Tag.init({
+module.exports = (sequelize, DataTypes) => 
+  sequelize.define('tag', {
  tag: {
    type: DataTypes.STRING,
    allowNull: false,
    index: true,
    primaryKey: true
  }
-}, { sequelize, modelName: 'tag' })
-
-module.exports = Tag
+})
--- a/server/api/models/user.js
+++ b/server/api/models/user.js
@@ -1,53 +1,49 @@

 const bcrypt = require('bcryptjs')
-const { Model, DataTypes } = require('sequelize')
-const sequelize = require('./index').sequelize

-class User extends Model {}
-
-User.init({
-  settings: {
-    type: DataTypes.JSON,
-    defaultValue: []
-  },
-  email: {
-    type: DataTypes.STRING,
-    unique: { msg: 'error.email_taken' },
-    validate: {
-      notEmpty: true
+module.exports = (sequelize, DataTypes) => {
+  const User = sequelize.define('user', {
+    settings: {
+      type: DataTypes.JSON,
+      defaultValue: []
    },
-    index: true,
-    allowNull: false
-  },
-  description: DataTypes.TEXT,
-  password: DataTypes.STRING,
-  recover_code: DataTypes.STRING,
-  is_admin: DataTypes.BOOLEAN,
-  is_active: DataTypes.BOOLEAN
-}, {
-  sequelize,
-  modelName: 'user',
-  scopes: {
-    withoutPassword: {
-      attributes: { exclude: ['password', 'recover_code'] }
+    email: {
+      type: DataTypes.STRING,
+      unique: { msg: 'error.email_taken' },
+      validate: {
+        notEmpty: true
+      },
+      index: true,
+      allowNull: false
    },
-    withRecover: {
-      attributes: { exclude: ['password'] }
+    description: DataTypes.TEXT,
+    password: DataTypes.STRING,
+    recover_code: DataTypes.STRING,
+    is_admin: DataTypes.BOOLEAN,
+    is_active: DataTypes.BOOLEAN
+  }, {
+    scopes: {
+      withoutPassword: {
+        attributes: { exclude: ['password', 'recover_code'] }
+      },
+      withRecover: {
+        attributes: { exclude: ['password'] }
+      }
    }
+  })
+  
+  User.prototype.comparePassword = async function (pwd) {
+    if (!this.password) { return false }
+    return bcrypt.compare(pwd, this.password)
  }
-})
+  
+  User.beforeSave(async (user, _options) => {
+    if (user.changed('password')) {
+      const salt = await bcrypt.genSalt(10)
+      const hash = await bcrypt.hash(user.password, salt)
+      user.password = hash
+    }
+  })

-User.prototype.comparePassword = async function (pwd) {
-  if (!this.password) { return false }
-  return bcrypt.compare(pwd, this.password)
+  return User
 }
-
-User.beforeSave(async (user, _options) => {
-  if (user.changed('password')) {
-    const salt = await bcrypt.genSalt(10)
-    const hash = await bcrypt.hash(user.password, salt)
-    user.password = hash
-  }
-})
-
-module.exports = User