Add realm limit settings (#151)

CHANGELOG.md

@@ -3,6 +3,13 @@
 This changelog documents all notable changes of the RealMQ Platform.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 
+## [Unreleased]
+
+### Added
+- Introduce limit settings on realm level ([#151]).
+
+[#151]: https://github.com/realmq/realmq-platform/issues/151
+
 ## [0.3.0] - 2023-07-06
 
 ### Added

src/api/admin/v1/mappers/index.js

@@ -3,6 +3,7 @@ const authList = require('./auth-list');
 const channel = require('./channel');
 const channelList = require('./channel-list');
 const realm = require('./realm');
+const realmDetails = require('./realm-details');
 const realmList = require('./realm-list');
 const subscription = require('./subscription');
 const subscriptionList = require('./subscription-list');
@@ -18,6 +19,7 @@ module.exports = {
   channel,
   channelList,
   realm,
+  realmDetails,
   realmList,
   subscription,
   subscriptionList,

src/api/admin/v1/mappers/realm-details.js

@@ -0,0 +1,30 @@
+const mapGenericEntity = require('../../../../lib/mappers/generic-entity');
+const mapRealm = require('./realm');
+
+/**
+ * @class RealmViewModel
+ * @property {string} id
+ * @property {string} name
+ * @property {Date} createdAt
+ * @property {Date} updatedAt
+ */
+/**
+ * Map a realm to detail response view model
+ * @param {object} args
+ * @param {RealmModel} args.realm The realm entity
+ * @param {RealmLimitsModel} args.realmLimits The realm limits entity
+ * @return {RealmViewModel} The realm view model
+ */
+module.exports = ({realm, realmLimits}) => ({
+  ...mapRealm(realm),
+  limits: mapGenericEntity({
+    entity: realmLimits,
+    propertyMap: {
+      maxConnections: 'maxConnections',
+      sessionMaxMessageRate: 'sessionMaxMessageRate',
+      sessionMaxConnectionLifetime: 'sessionMaxConnectionLifetime',
+      sessionMaxMessageSize: 'sessionMaxMessageSize',
+    },
+  }),
+});
+

src/api/admin/v1/mappers/realm.js

@@ -8,7 +8,7 @@ const mapGenericEntity = require('../../../../lib/mappers/generic-entity');
  * @property {Date} updatedAt
  */
 /**
- * Map an realm to response view model
+ * Map a realm to response view model
  * @param {RealmModel} realm The realm entity
  * @return {RealmViewModel} The realm view model
  */

src/api/admin/v1/openapi/definitions.yaml

@@ -74,13 +74,39 @@ TimestampsTrait:
 Realm:
   allOf:
     - $ref: '#/definitions/BaseEntity'
-    - properties:
+    - type: object
+      properties:
         name:
           type: string
       required:
         - name
     - $ref: '#/definitions/TimestampsTrait'
 
+RealmDetails:
+  allOf:
+    - $ref: '#/definitions/Realm'
+    - type: object
+      properties:
+        limits:
+          $ref: '#/definitions/RealmLimits'
+
+RealmLimits:
+  type: object
+  properties:
+    maxConnections:
+      description: Maximum number of simultaneously online connections
+      type: integer
+    sessionMaxMessageRate:
+      description: Maximum incoming publish rate per session per second
+      type: integer
+    sessionMaxConnectionLifetime:
+      description: Maximum lifetime of a connection in seconds
+      type: integer
+    sessionMaxMessageSize:
+      description: Maximum size of a message payload in bytes
+      type: integer
+  additionalProperties: false
+
 RealmList:
   allOf:
     - $ref: '#/definitions/BaseList'

src/api/admin/v1/routes/realms.js

@@ -16,13 +16,16 @@ module.exports = (tasks, mappers) => ({
   },
 
   async post(request, response) {
-    const {body: {name}} = request;
-    const {ok, result: realm, error} = await tasks.admin.createRealm({name});
+    const {body: {name, limits = {}}} = request;
+    const {ok, result, error} = await tasks.admin.createRealm({name, limits});
 
     if (!ok) {
       throw error;
     }
 
-    return response.status(201).json(mappers.realm(realm));
+    return response.status(201).json(mappers.realmDetails({
+      realm: result.realm,
+      realmLimits: result.realmLimits,
+    }));
   },
 });

src/api/admin/v1/routes/realms.yaml

@@ -40,11 +40,13 @@
             name:
               description: The name of the real, eg. project/org name
               type: string
+            limits:
+              $ref: '#/definitions/RealmLimits'
     responses:
       201:
         description: Realm was successfully created.
         schema:
-          $ref: '#/definitions/Realm'
+          $ref: '#/definitions/RealmDetails'
       400:
         description: Request validation failed.
       401:

src/api/admin/v1/routes/realms/{id}.js

@@ -8,18 +8,21 @@
 module.exports = (tasks, mappers) => ({
   async get(request, response) {
     const {params: {id}} = request;
-    const {ok, result: realm, error} = await tasks.admin.fetchRealm({id});
+    const {ok, result, error} = await tasks.admin.fetchRealm({id});
     if (!ok) {
       throw error;
     }
 
-    if (!realm) {
+    if (!result.realm) {
       return response.status(404).json({
         code: 'UnknownRealm',
         message: 'Cannot lookup the given realm.',
       });
     }
 
-    response.json(mappers.realm(realm));
+    response.json(mappers.realmDetails({
+      realm: result.realm,
+      realmLimits: result.realmLimits,
+    }));
   },
 });

src/api/admin/v1/routes/realms/{id}.yaml

@@ -18,7 +18,7 @@
       200:
         description: The realm was loaded sucessfully.
         schema:
-          $ref: '#/definitions/Realm'
+          $ref: '#/definitions/RealmDetails'
       400:
         description: Request validation failed.
       401:

src/api/broker/v1/routes/vmq/auth-on-register.js

@@ -1,3 +1,5 @@
+const stripUndefined = require('../../../../../lib/strip-undefined');
+
 /**
  *
  * @param {BrokerTasks#authorizeRegister} authorizeRegister Task
@@ -16,7 +18,19 @@ module.exports = ({authorizeRegister}) =>
       return response.status(400).send();
     }
 
-    const authorized = await authorizeRegister(clientId);
-    const result = authorized ? 'ok' : 'next';
-    response.json({result});
+    const {authorized, realmLimits} = await authorizeRegister(clientId);
+    if (!authorized) {
+      return response.json({result: 'next'});
+    }
+
+    const modifiers = stripUndefined({
+      // eslint-disable-next-line camelcase
+      max_message_size: realmLimits?.sessionMaxMessageSize,
+    });
+
+    response.json({
+      result: 'ok',
+      // VerneMQ fails if modifiers is an empty object
+      modifiers: Object.entries(modifiers).length > 0 ? modifiers : undefined,
+    });
   };

src/api/broker/v1/routes/vmq/auth-on-register.spec.js

@@ -12,7 +12,7 @@ describe('An auth-on-register handler', () => {
     beforeEach(() => {
       authOnRegister = initAuthOnRegister({
         async authorizeRegister(clientId) {
-          return clientId === authorizedClientId;
+          return {authorized: clientId === authorizedClientId};
         },
       });
       responseState = {};

src/bootstrap/repositories.js

@@ -12,6 +12,7 @@ module.exports = async ({db}) => {
     channelCollection,
     messageCollection,
     realmCollection,
+    realmLimitsCollection,
     realtimeConnectionCollection,
     subscriptionCollection,
     userCollection,
@@ -20,6 +21,7 @@ module.exports = async ({db}) => {
     db.collection('channels'),
     db.collection('messages'),
     db.collection('realms'),
+    db.collection('realm-limits'),
     db.collection('realtime-connections'),
     db.collection('subscriptions'),
     db.collection('users'),
@@ -29,6 +31,7 @@ module.exports = async ({db}) => {
     channelCollection,
     messageCollection,
     realmCollection,
+    realmLimitsCollection,
     realtimeConnectionCollection,
     subscriptionCollection,
     userCollection,

src/bootstrap/tasks.js

@@ -26,6 +26,7 @@ module.exports = ({
     channel: channelRepository,
     message: messageRepository,
     realm: realmRepository,
+    realmLimits: realmLimitsRepository,
     realtimeConnection: realtimeConnectionRepository,
     subscription: subscriptionRepository,
     user: userRepository,
@@ -45,6 +46,7 @@ module.exports = ({
       channelRepository,
       messageRepository,
       realmRepository,
+      realmLimitsRepository,
       subscriptionRepository,
       userRepository,
       sendSubscriptionSyncMessage,
@@ -55,6 +57,7 @@ module.exports = ({
       authRepository,
       channelRepository,
       subscriptionRepository,
+      realmLimitsRepository,
       realtimeConnectionRepository,
       messageRepository,
       userRepository,

src/index.js

@@ -34,3 +34,4 @@ const createLogger = require('./lib/logger');
     process.exit(1);
   }
 })();
+

src/models/realm-limits.js

@@ -0,0 +1,36 @@
+const stripUndefined = require('../lib/strip-undefined');
+
+/**
+ * @typedef {Object} RealmLimitsModel Specialized set of realm settings focused on connections/sessions
+ * @property {string} [id]
+ * @property {string} realmId
+ * @property {number} maxConnections Max number of simultaneously online connections
+ * @property {number} sessionMaxMessageRate Max incoming publish rate per session per second
+ * @property {number} sessionMaxConnectionLifetime Max lifetime of a connection in seconds
+ * @property {number} sessionMaxMessageSize Max message payload size in bytes
+ * @property {Date} [createdAt]
+ * @property {Date} [updatedAt]
+ */
+
+/**
+ * @return {RealmLimitsModel} The generalized realm model
+ */
+module.exports = ({
+  id,
+  realmId,
+  maxConnections,
+  sessionMaxMessageRate,
+  sessionMaxConnectionLifetime,
+  sessionMaxMessageSize,
+  createdAt,
+  updatedAt,
+}) => stripUndefined({
+  id,
+  realmId,
+  maxConnections,
+  sessionMaxMessageRate,
+  sessionMaxConnectionLifetime,
+  sessionMaxMessageSize,
+  createdAt,
+  updatedAt,
+});

src/repositories/index.js

@@ -2,6 +2,7 @@ const createAuthRepository = require('./auth');
 const createChannelRepository = require('./channel');
 const createMessageRepository = require('./message');
 const createRealmRepository = require('./realm');
+const createRealmLimitsRepository = require('./realm-limits');
 const createRealtimeConnectionRepository = require('./realtime-connection');
 const createSubscriptionRepository = require('./subscription');
 const createUserRepository = require('./user');
@@ -13,14 +14,20 @@ const createUserRepository = require('./user');
  * @param {Collection} channelCollection Dependency
  * @param {Collection} messageCollection Dependency
  * @param {Collection} realmCollection Dependency
+ * @param {Collection} realmLimitsCollection Dependency
  * @param {Collection} realtimeConnectionCollection Dependency
  * @param {Collection} subscriptionCollection Dependency
  * @param {Collection} userCollection Dependency
  * @return {Repositories} The repositories
  */
 module.exports = ({
-  authCollection, channelCollection, messageCollection,
-  realmCollection, subscriptionCollection, userCollection,
+  authCollection,
+  channelCollection,
+  messageCollection,
+  realmCollection,
+  realmLimitsCollection,
+  subscriptionCollection,
+  userCollection,
   realtimeConnectionCollection,
 }) =>
   /**
@@ -29,6 +36,7 @@ module.exports = ({
    * @property {ChannelRepository} channel
    * @property {MessageRepository} message
    * @property {RealmRepository} realm
+   * @property {RealmLimitsRepository} realmLimits
    * @property {RealtimeConnectionRepository} realtimeConnection
    * @property {SubscriptionRepository} subscription
    * @property {UserRepository} user
@@ -38,6 +46,7 @@ module.exports = ({
     channel: createChannelRepository({collection: channelCollection}),
     message: createMessageRepository({collection: messageCollection}),
     realm: createRealmRepository({collection: realmCollection}),
+    realmLimits: createRealmLimitsRepository({collection: realmLimitsCollection}),
     realtimeConnection: createRealtimeConnectionRepository({collection: realtimeConnectionCollection}),
     subscription: createSubscriptionRepository({collection: subscriptionCollection}),
     user: createUserRepository({collection: userCollection}),

src/repositories/realm-limits.js

@@ -0,0 +1,31 @@
+const createRealmLimitsModel = require('../models/realm-limits');
+const createMongoRepository = require('./lib/mongo');
+
+/**
+ * Create realm repository.
+ *
+ * @param {Collection} collection Mongodb collection
+ * @param {function} createModel Model factory
+ * @return {RealmLimitsRepository} The created realm repository
+ */
+module.exports = ({collection, createModel = createRealmLimitsModel}) => {
+  const mongoRepo = createMongoRepository({collection, createModel});
+
+  /**
+   * @class RealmLimitsRepository
+   * @extends MongoRepository
+   */
+  return {
+    ...mongoRepo,
+
+    /**
+     *
+     * @param {string} realmId
+     * @return {Promise<RealmLimitsModel|null>}
+     */
+    async findOneByRealmId(realmId) {
+      return mongoRepo.findOne({realmId});
+    },
+  };
+};
+