HTTP API versioning

src/constants/constants.js

@@ -414,6 +414,62 @@ export const ARCHIVE_UPDATE_RESPONSES_FOLDER = 'update_responses';
  */
 export const COMMAND_QUEUE_PARALLELISM = 100;
 
+/**
+ * @constant {object} HTTP_API_ROUTES -
+ *  HTTP API Routes with parameters
+ */
+export const HTTP_API_ROUTES = {
+    v0: {
+        publish: {
+            method: 'post',
+            path: '/publish',
+            options: { rateLimit: true },
+        },
+        update: {
+            method: 'post',
+            path: '/update',
+            options: { rateLimit: true },
+        },
+        query: {
+            method: 'post',
+            path: '/query',
+            options: {},
+        },
+        'local-store': {
+            method: 'post',
+            path: '/local-store',
+            options: {},
+        },
+        get: {
+            method: 'post',
+            path: '/get',
+            options: { rateLimit: true },
+        },
+        result: {
+            method: 'get',
+            path: '/:operation/:operationId',
+            options: {},
+        },
+        info: {
+            method: 'get',
+            path: '/info',
+            options: {},
+        },
+        'bid-suggestion': {
+            method: 'get',
+            path: '/bid-suggestion',
+            options: {},
+        },
+    },
+    v1: {
+        info: {
+            method: 'get',
+            path: '/info',
+            options: {},
+        },
+    },
+};
+
 /**
  * @constant {object} NETWORK_PROTOCOLS -
  *  Network protocols

src/controllers/http-api/base-http-api-controller.js

@@ -1,5 +1,6 @@
 class BaseController {
     constructor(ctx) {
+        this.config = ctx.config;
         this.logger = ctx.logger;
     }
 

src/controllers/http-api/http-api-router.js

@@ -1,89 +1,89 @@
+import stringUtil from '../../service/util/string-util.js';
+import { HTTP_API_ROUTES } from '../../constants/constants.js';
+
 class HttpApiRouter {
     constructor(ctx) {
         this.config = ctx.config;
         this.httpClientModuleManager = ctx.httpClientModuleManager;
 
-        this.getHttpApiController = ctx.getHttpApiController;
-        this.publishHttpApiController = ctx.publishHttpApiController;
-        this.updateHttpApiController = ctx.updateHttpApiController;
-        this.localStoreHttpApiController = ctx.localStoreHttpApiController;
-        this.queryHttpApiController = ctx.queryHttpApiController;
-        this.resultHttpApiController = ctx.resultHttpApiController;
-        this.infoHttpApiController = ctx.infoHttpApiController;
-        this.bidSuggestionHttpApiController = ctx.bidSuggestionHttpApiController;
+        this.apiRoutes = HTTP_API_ROUTES;
+        this.apiVersions = Object.keys(this.apiRoutes);
+
+        this.routers = {};
+        for (const version of this.apiVersions) {
+            this.routers[version] = this.httpClientModuleManager.createRouterInstance();
+
+            const operations = Object.keys(this.apiRoutes[version]);
+
+            for (const operation of operations) {
+                const versionedController = `${stringUtil.toCamelCase(
+                    operation,
+                )}HttpApiController${stringUtil.capitalize(version)}`;
+                this[versionedController] = ctx[versionedController];
+            }
+        }
+        this.routers.latest = this.httpClientModuleManager.createRouterInstance();
 
         this.jsonSchemaService = ctx.jsonSchemaService;
     }
 
     async initialize() {
         this.initializeBeforeMiddlewares();
-        this.initializeListeners();
+        await this.initializeVersionedListeners();
+        this.initializeRouters();
         this.initializeAfterMiddlewares();
         await this.httpClientModuleManager.listen();
     }
 
-    initializeListeners() {
-        this.httpClientModuleManager.post(
-            '/publish',
-            (req, res) => {
-                this.publishHttpApiController.handlePublishRequest(req, res);
-            },
-            { rateLimit: true, requestSchema: this.jsonSchemaService.publishSchema() },
-        );
-
-        this.httpClientModuleManager.post(
-            '/update',
-            (req, res) => {
-                this.updateHttpApiController.handleUpdateRequest(req, res);
-            },
-            { rateLimit: true, requestSchema: this.jsonSchemaService.updateSchema() },
-        );
-
-        this.httpClientModuleManager.post(
-            '/query',
-            (req, res) => {
-                this.queryHttpApiController.handleQueryRequest(req, res);
-            },
-            { requestSchema: this.jsonSchemaService.querySchema() },
-        );
-
-        this.httpClientModuleManager.post(
-            '/local-store',
-            (req, res) => {
-                this.localStoreHttpApiController.handleLocalStoreRequest(req, res);
-            },
-            { requestSchema: this.jsonSchemaService.localStoreSchema() },
-        );
-
-        this.httpClientModuleManager.post(
-            '/get',
-            (req, res) => {
-                this.getHttpApiController.handleGetRequest(req, res);
-            },
-            { rateLimit: true, requestSchema: this.jsonSchemaService.getSchema() },
-        );
-
-        this.httpClientModuleManager.get('/:operation/:operationId', (req, res) => {
-            this.resultHttpApiController.handleOperationResultRequest(req, res);
-        });
-
-        this.httpClientModuleManager.get('/info', (req, res) => {
-            this.infoHttpApiController.handleInfoRequest(req, res);
-        });
-
-        this.httpClientModuleManager.get(
-            '/bid-suggestion',
-            (req, res) => {
-                this.bidSuggestionHttpApiController.handleBidSuggestionRequest(req, res);
-            },
-            { requestSchema: this.jsonSchemaService.bidSuggestionSchema() },
-        );
-    }
-
     initializeBeforeMiddlewares() {
         this.httpClientModuleManager.initializeBeforeMiddlewares();
     }
 
+    async initializeVersionedListeners() {
+        const descendingOrderedVersions = this.apiVersions.sort((a, b) => b.localeCompare(a));
+        const mountedLatestRoutes = new Set();
+
+        for (const version of descendingOrderedVersions) {
+            for (const [name, route] of Object.entries(this.apiRoutes[version])) {
+                const { method, path, options } = route;
+                const camelRouteName = stringUtil.toCamelCase(name);
+                const controller = `${camelRouteName}HttpApiController${stringUtil.capitalize(
+                    version,
+                )}`;
+                const schema = `${camelRouteName}Schema`;
+
+                if (
+                    schema in this.jsonSchemaService &&
+                    typeof this.jsonSchemaService[schema] === 'function'
+                ) {
+                    // eslint-disable-next-line no-await-in-loop
+                    options.requestSchema = await this.jsonSchemaService[schema](version);
+                }
+
+                const middlewares = this.httpClientModuleManager.selectMiddlewares(options);
+                const callback = (req, res) => {
+                    this[controller].handleRequest(req, res);
+                };
+
+                this.routers[version][method](path, ...middlewares, callback);
+
+                if (!mountedLatestRoutes.has(route.name)) {
+                    this.routers.latest[method](path, ...middlewares, callback);
+                    mountedLatestRoutes.add(route.name);
+                }
+            }
+        }
+    }
+
+    initializeRouters() {
+        for (const version of this.apiVersions) {
+            this.httpClientModuleManager.use(`/${version}`, this.routers[version]);
+        }
+
+        this.httpClientModuleManager.use('/latest', this.routers.latest);
+        this.httpClientModuleManager.use('/', this.routers.v0);
+    }
+
     initializeAfterMiddlewares() {
         this.httpClientModuleManager.initializeAfterMiddlewares();
     }

src/controllers/http-api/bid-suggestion-http-api-controller.js → src/controllers/http-api/v0/bid-suggestion-http-api-controller-v0.js

@@ -1,4 +1,4 @@
-import BaseController from './base-http-api-controller.js';
+import BaseController from '../base-http-api-controller.js';
 
 class BidSuggestionController extends BaseController {
     constructor(ctx) {
@@ -8,7 +8,7 @@ class BidSuggestionController extends BaseController {
         this.shardingTableService = ctx.shardingTableService;
     }
 
-    async handleBidSuggestionRequest(req, res) {
+    async handleRequest(req, res) {
         if ((await this.repositoryModuleManager.getPeersCount(req.query.blockchain)) === 0)
             this.returnResponse(res, 400, {
                 code: 400,

src/controllers/http-api/get-http-api-controller.js → src/controllers/http-api/v0/get-http-api-controller-v0.js

@@ -4,8 +4,8 @@ import {
     CONTENT_ASSET_HASH_FUNCTION_ID,
     DEFAULT_GET_STATE,
     ERROR_TYPE,
-} from '../../constants/constants.js';
-import BaseController from './base-http-api-controller.js';
+} from '../../../constants/constants.js';
+import BaseController from '../base-http-api-controller.js';
 
 class GetController extends BaseController {
     constructor(ctx) {
@@ -18,7 +18,7 @@ class GetController extends BaseController {
         this.validationService = ctx.validationService;
     }
 
-    async handleGetRequest(req, res) {
+    async handleRequest(req, res) {
         const operationId = await this.operationIdService.generateOperationId(
             OPERATION_ID_STATUS.GET.GET_START,
         );

src/controllers/http-api/info-http-api-controller.js → src/controllers/http-api/v0/info-http-api-controller-v0.js

@@ -1,11 +1,11 @@
 import { createRequire } from 'module';
-import BaseController from './base-http-api-controller.js';
+import BaseController from '../base-http-api-controller.js';
 
 const require = createRequire(import.meta.url);
-const { version } = require('../../../package.json');
+const { version } = require('../../../../package.json');
 
 class InfoController extends BaseController {
-    handleInfoRequest(req, res) {
+    handleRequest(_, res) {
         this.returnResponse(res, 200, {
             version,
         });

src/controllers/http-api/local-store-http-api-controller.js → src/controllers/http-api/v0/local-store-http-api-controller-v0.js

@@ -1,5 +1,5 @@
-import BaseController from './base-http-api-controller.js';
-import { OPERATION_ID_STATUS } from '../../constants/constants.js';
+import BaseController from '../base-http-api-controller.js';
+import { OPERATION_ID_STATUS } from '../../../constants/constants.js';
 
 class LocalStoreController extends BaseController {
     constructor(ctx) {
@@ -9,7 +9,7 @@ class LocalStoreController extends BaseController {
         this.dataService = ctx.dataService;
     }
 
-    async handleLocalStoreRequest(req, res) {
+    async handleRequest(req, res) {
         const operationId = await this.operationIdService.generateOperationId(
             OPERATION_ID_STATUS.LOCAL_STORE.LOCAL_STORE_INIT_START,
         );

src/controllers/http-api/publish-http-api-controller.js → src/controllers/http-api/v0/publish-http-api-controller-v0.js

@@ -1,11 +1,11 @@
-import BaseController from './base-http-api-controller.js';
+import BaseController from '../base-http-api-controller.js';
 import {
     ERROR_TYPE,
     OPERATION_ID_STATUS,
     OPERATION_STATUS,
     CONTENT_ASSET_HASH_FUNCTION_ID,
     LOCAL_STORE_TYPES,
-} from '../../constants/constants.js';
+} from '../../../constants/constants.js';
 
 class PublishController extends BaseController {
     constructor(ctx) {
@@ -16,7 +16,7 @@ class PublishController extends BaseController {
         this.repositoryModuleManager = ctx.repositoryModuleManager;
     }
 
-    async handlePublishRequest(req, res) {
+    async handleRequest(req, res) {
         const operationId = await this.operationIdService.generateOperationId(
             OPERATION_ID_STATUS.PUBLISH.PUBLISH_START,
         );

src/controllers/http-api/query-http-api-controller.js → src/controllers/http-api/v0/query-http-api-controller-v0.js

@@ -1,6 +1,6 @@
-import BaseController from './base-http-api-controller.js';
+import BaseController from '../base-http-api-controller.js';
 
-import { OPERATION_ID_STATUS } from '../../constants/constants.js';
+import { OPERATION_ID_STATUS } from '../../../constants/constants.js';
 
 class QueryController extends BaseController {
     constructor(ctx) {
@@ -9,7 +9,7 @@ class QueryController extends BaseController {
         this.operationIdService = ctx.operationIdService;
     }
 
-    async handleQueryRequest(req, res) {
+    async handleRequest(req, res) {
         const { query, type: queryType } = req.body;
 
         const operationId = await this.operationIdService.generateOperationId(

src/controllers/http-api/request-schema/bid-suggestion-schema.js → src/controllers/http-api/v0/request-schema/bid-suggestion-schema-v0.js

@@ -1,4 +1,4 @@
-export default (blockchainImplementationNames) => ({
+export default (argumentsObject) => ({
     type: 'object',
     required: [
         'blockchain',
@@ -10,7 +10,7 @@ export default (blockchainImplementationNames) => ({
     ],
     properties: {
         blockchain: {
-            enum: blockchainImplementationNames,
+            enum: argumentsObject.blockchainImplementationNames,
         },
         epochsNumber: {
             type: 'number',

src/controllers/http-api/request-schema/get-schema.js → src/controllers/http-api/v0/request-schema/get-schema-v0.js

@@ -1,4 +1,4 @@
-import { GET_STATES } from '../../../constants/constants.js';
+import { GET_STATES } from '../../../../constants/constants.js';
 
 export default () => ({
     type: 'object',

src/controllers/http-api/request-schema/local-store-schema.js → src/controllers/http-api/v0/request-schema/local-store-schema-v0.js

@@ -1,6 +1,6 @@
-import { LOCAL_STORE_TYPES } from '../../../constants/constants.js';
+import { LOCAL_STORE_TYPES } from '../../../../constants/constants.js';
 
-export default (blockchainImplementationNames) => ({
+export default (argumentsObject) => ({
     type: 'array',
     items: {
         type: 'object',
@@ -19,7 +19,7 @@ export default (blockchainImplementationNames) => ({
                 minItems: 1,
             },
             blockchain: {
-                enum: blockchainImplementationNames,
+                enum: argumentsObject.blockchainImplementationNames,
             },
             contract: {
                 type: 'string',

src/controllers/http-api/request-schema/publish-schema.js → src/controllers/http-api/v0/request-schema/publish-schema-v0.js

@@ -1,4 +1,4 @@
-export default (blockchainImplementationNames) => ({
+export default (argumentsObject) => ({
     type: 'object',
     required: ['assertionId', 'assertion', 'blockchain', 'contract', 'tokenId'],
     properties: {
@@ -15,7 +15,7 @@ export default (blockchainImplementationNames) => ({
             minItems: 1,
         },
         blockchain: {
-            enum: blockchainImplementationNames,
+            enum: argumentsObject.blockchainImplementationNames,
         },
         contract: {
             type: 'string',

src/controllers/http-api/request-schema/query-schema.js → src/controllers/http-api/v0/request-schema/query-schema-v0.js

@@ -1,4 +1,4 @@
-import { QUERY_TYPES, TRIPLE_STORE_REPOSITORIES } from '../../../constants/constants.js';
+import { QUERY_TYPES, TRIPLE_STORE_REPOSITORIES } from '../../../../constants/constants.js';
 
 export default () => ({
     type: 'object',