From a684bead928278add05c3fd575a134ad4e0f33ce Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Garc=C3=ADa=20Aubert?= Date: Fri, 4 Oct 2019 12:22:23 +0200 Subject: [PATCH] Rename method 'register' -> 'route' --- lib/cartodb/api/api-router.js | 14 ++++++------- .../api/map/analyses-catalog-controller.js | 2 +- .../api/map/analysis-layergroup-controller.js | 2 +- .../api/map/anonymous-map-controller.js | 2 +- .../map/attributes-layergroup-controller.js | 2 +- ...lustered-features-layergroup-controller.js | 2 +- .../api/map/dataview-layergroup-controller.js | 2 +- lib/cartodb/api/map/map-router.js | 20 +++++++++---------- .../api/map/preview-layergroup-controller.js | 2 +- .../api/map/preview-template-controller.js | 2 +- .../api/map/tile-layergroup-controller.js | 2 +- .../api/template/admin-template-controller.js | 2 +- .../api/template/named-template-controller.js | 2 +- lib/cartodb/api/template/template-router.js | 8 ++++---- .../api/template/tile-template-controller.js | 2 +- lib/cartodb/server-info-controller.js | 2 +- lib/cartodb/server.js | 4 ++-- 17 files changed, 35 insertions(+), 37 deletions(-) diff --git a/lib/cartodb/api/api-router.js b/lib/cartodb/api/api-router.js index 0081c0eb..08e5072d 100644 --- a/lib/cartodb/api/api-router.js +++ b/lib/cartodb/api/api-router.js @@ -196,7 +196,7 @@ module.exports = class ApiRouter { this.templateRouter = new TemplateRouter({ collaborators }); } - register (app, routes) { + route (app, routes) { // FIXME: we need a better way to reset cache while running tests if (process.env.NODE_ENV === 'test') { app.layergroupAffectedTablesCache = this.layergroupAffectedTablesCache; @@ -204,11 +204,9 @@ module.exports = class ApiRouter { routes.forEach(route => { const apiRouter = router({ mergeParams: true }); + const { paths, middlewares = [] } = route; - const apiPaths = route.paths; - const apiMiddlewares = route.middlewares || []; - - apiMiddlewares.forEach(middleware => apiRouter.use(middleware())); + middlewares.forEach(middleware => apiRouter.use(middleware())); apiRouter.use(logger(this.serverOptions)); apiRouter.use(initializeStatusCode()); @@ -222,14 +220,14 @@ module.exports = class ApiRouter { apiRouter.use(cors()); apiRouter.use(user()); - this.templateRouter.register(apiRouter, route.template); - this.mapRouter.register(apiRouter, route.map); + this.templateRouter.route(apiRouter, route.template); + this.mapRouter.route(apiRouter, route.map); apiRouter.use(sendResponse()); apiRouter.use(syntaxError()); apiRouter.use(errorMiddleware()); - apiPaths.forEach(path => app.use(path, apiRouter)); + paths.forEach(path => app.use(path, apiRouter)); }); } }; diff --git a/lib/cartodb/api/map/analyses-catalog-controller.js b/lib/cartodb/api/map/analyses-catalog-controller.js index f7f66346..8c75af63 100644 --- a/lib/cartodb/api/map/analyses-catalog-controller.js +++ b/lib/cartodb/api/map/analyses-catalog-controller.js @@ -17,7 +17,7 @@ module.exports = class AnalysesController { this.userLimitsBackend = userLimitsBackend; } - register (mapRouter) { + route (mapRouter) { mapRouter.get('/analyses/catalog', this.middlewares()); } diff --git a/lib/cartodb/api/map/analysis-layergroup-controller.js b/lib/cartodb/api/map/analysis-layergroup-controller.js index 0375d9ed..fe51e607 100644 --- a/lib/cartodb/api/map/analysis-layergroup-controller.js +++ b/lib/cartodb/api/map/analysis-layergroup-controller.js @@ -17,7 +17,7 @@ module.exports = class AnalysisLayergroupController { this.authBackend = authBackend; } - register (mapRouter) { + route (mapRouter) { mapRouter.get('/:token/analysis/node/:nodeId', this.middlewares()); } diff --git a/lib/cartodb/api/map/anonymous-map-controller.js b/lib/cartodb/api/map/anonymous-map-controller.js index ef47f5b6..32707b03 100644 --- a/lib/cartodb/api/map/anonymous-map-controller.js +++ b/lib/cartodb/api/map/anonymous-map-controller.js @@ -64,7 +64,7 @@ module.exports = class AnonymousMapController { this.layergroupMetadata = layergroupMetadata; } - register (mapRouter) { + route (mapRouter) { mapRouter.options('/'); mapRouter.get('/', this.middlewares()); mapRouter.post('/', this.middlewares()); diff --git a/lib/cartodb/api/map/attributes-layergroup-controller.js b/lib/cartodb/api/map/attributes-layergroup-controller.js index 9ab394d7..a9a26ada 100644 --- a/lib/cartodb/api/map/attributes-layergroup-controller.js +++ b/lib/cartodb/api/map/attributes-layergroup-controller.js @@ -32,7 +32,7 @@ module.exports = class AttributesLayergroupController { this.surrogateKeysCache = surrogateKeysCache; } - register (mapRouter) { + route (mapRouter) { mapRouter.get('/:token/:layer/attributes/:fid', this.middlewares()); } diff --git a/lib/cartodb/api/map/clustered-features-layergroup-controller.js b/lib/cartodb/api/map/clustered-features-layergroup-controller.js index 5c17c5b1..573436d8 100644 --- a/lib/cartodb/api/map/clustered-features-layergroup-controller.js +++ b/lib/cartodb/api/map/clustered-features-layergroup-controller.js @@ -32,7 +32,7 @@ module.exports = class AggregatedFeaturesLayergroupController { this.surrogateKeysCache = surrogateKeysCache; } - register (mapRouter) { + route (mapRouter) { mapRouter.get('/:token/:layer/:z/cluster/:clusterId', this.middlewares()); } diff --git a/lib/cartodb/api/map/dataview-layergroup-controller.js b/lib/cartodb/api/map/dataview-layergroup-controller.js index d82556b8..234e6106 100644 --- a/lib/cartodb/api/map/dataview-layergroup-controller.js +++ b/lib/cartodb/api/map/dataview-layergroup-controller.js @@ -47,7 +47,7 @@ module.exports = class DataviewLayergroupController { this.surrogateKeysCache = surrogateKeysCache; } - register (mapRouter) { + route (mapRouter) { // Undocumented/non-supported API endpoint methods. // Use at your own peril. diff --git a/lib/cartodb/api/map/map-router.js b/lib/cartodb/api/map/map-router.js index 2e17a59f..c5070627 100644 --- a/lib/cartodb/api/map/map-router.js +++ b/lib/cartodb/api/map/map-router.js @@ -126,7 +126,7 @@ module.exports = class MapRouter { ); } - register (apiRouter, routes) { + route (apiRouter, routes) { const mapRouter = router({ mergeParams: true }); routes.forEach(route => { @@ -134,15 +134,15 @@ module.exports = class MapRouter { middlewares.forEach(middleware => mapRouter.use(middleware())); - this.analysisLayergroupController.register(mapRouter); - this.attributesLayergroupController.register(mapRouter); - this.dataviewLayergroupController.register(mapRouter); - this.previewLayergroupController.register(mapRouter); - this.tileLayergroupController.register(mapRouter); - this.anonymousMapController.register(mapRouter); - this.previewTemplateController.register(mapRouter); - this.analysesController.register(mapRouter); - this.clusteredFeaturesLayergroupController.register(mapRouter); + this.analysisLayergroupController.route(mapRouter); + this.attributesLayergroupController.route(mapRouter); + this.dataviewLayergroupController.route(mapRouter); + this.previewLayergroupController.route(mapRouter); + this.tileLayergroupController.route(mapRouter); + this.anonymousMapController.route(mapRouter); + this.previewTemplateController.route(mapRouter); + this.analysesController.route(mapRouter); + this.clusteredFeaturesLayergroupController.route(mapRouter); paths.forEach(path => apiRouter.use(path, mapRouter)); }); diff --git a/lib/cartodb/api/map/preview-layergroup-controller.js b/lib/cartodb/api/map/preview-layergroup-controller.js index f8980866..698d94ff 100644 --- a/lib/cartodb/api/map/preview-layergroup-controller.js +++ b/lib/cartodb/api/map/preview-layergroup-controller.js @@ -35,7 +35,7 @@ module.exports = class PreviewLayergroupController { this.surrogateKeysCache = surrogateKeysCache; } - register (mapRouter) { + route (mapRouter) { mapRouter.get('/static/center/:token/:z/:lat/:lng/:width/:height.:format', this.middlewares({ validateZoom: true, previewType: 'centered' diff --git a/lib/cartodb/api/map/preview-template-controller.js b/lib/cartodb/api/map/preview-template-controller.js index e4f42cae..e4c0beed 100644 --- a/lib/cartodb/api/map/preview-template-controller.js +++ b/lib/cartodb/api/map/preview-template-controller.js @@ -46,7 +46,7 @@ module.exports = class PreviewTemplateController { this.userLimitsBackend = userLimitsBackend; } - register (mapRouter) { + route (mapRouter) { mapRouter.get('/static/named/:template_id/:width/:height.:format', this.middlewares()); } diff --git a/lib/cartodb/api/map/tile-layergroup-controller.js b/lib/cartodb/api/map/tile-layergroup-controller.js index 422fa8b6..18fe23be 100644 --- a/lib/cartodb/api/map/tile-layergroup-controller.js +++ b/lib/cartodb/api/map/tile-layergroup-controller.js @@ -43,7 +43,7 @@ module.exports = class TileLayergroupController { this.surrogateKeysCache = surrogateKeysCache; } - register (mapRouter) { + route (mapRouter) { // REGEXP: doesn't match with `val` const not = (val) => `(?!${val})([^\/]+?)`; diff --git a/lib/cartodb/api/template/admin-template-controller.js b/lib/cartodb/api/template/admin-template-controller.js index c8d2ba97..2416afe2 100644 --- a/lib/cartodb/api/template/admin-template-controller.js +++ b/lib/cartodb/api/template/admin-template-controller.js @@ -18,7 +18,7 @@ module.exports = class AdminTemplateController { this.userLimitsBackend = userLimitsBackend; } - register (templateRouter) { + route (templateRouter) { templateRouter.options(`/:template_id`); templateRouter.post('/', this.middlewares({ diff --git a/lib/cartodb/api/template/named-template-controller.js b/lib/cartodb/api/template/named-template-controller.js index b28143dd..7a7ee9d2 100644 --- a/lib/cartodb/api/template/named-template-controller.js +++ b/lib/cartodb/api/template/named-template-controller.js @@ -63,7 +63,7 @@ module.exports = class NamedMapController { this.layergroupMetadata = layergroupMetadata; } - register (templateRouter) { + route (templateRouter) { templateRouter.get('/:template_id/jsonp', this.middlewares()); templateRouter.post('/:template_id', this.middlewares()); } diff --git a/lib/cartodb/api/template/template-router.js b/lib/cartodb/api/template/template-router.js index 566dfec4..ecdc9802 100644 --- a/lib/cartodb/api/template/template-router.js +++ b/lib/cartodb/api/template/template-router.js @@ -54,7 +54,7 @@ module.exports = class TemplateRouter { ); } - register (apiRouter, routes) { + route (apiRouter, routes) { const templateRouter = router({ mergeParams: true }); routes.forEach(route => { @@ -62,9 +62,9 @@ module.exports = class TemplateRouter { middlewares.forEach(middleware => templateRouter.use(middleware())); - this.namedMapController.register(templateRouter); - this.tileTemplateController.register(templateRouter); - this.adminTemplateController.register(templateRouter); + this.namedMapController.route(templateRouter); + this.tileTemplateController.route(templateRouter); + this.adminTemplateController.route(templateRouter); paths.forEach(path => apiRouter.use(path, templateRouter)); }); diff --git a/lib/cartodb/api/template/tile-template-controller.js b/lib/cartodb/api/template/tile-template-controller.js index daf751e6..90904027 100644 --- a/lib/cartodb/api/template/tile-template-controller.js +++ b/lib/cartodb/api/template/tile-template-controller.js @@ -31,7 +31,7 @@ module.exports = class TileTemplateController { this.userLimitsBackend = userLimitsBackend; } - register (templateRouter) { + route (templateRouter) { templateRouter.get('/:template_id/:layer/:z/:x/:y.(:format)', this.middlewares()); } diff --git a/lib/cartodb/server-info-controller.js b/lib/cartodb/server-info-controller.js index d81051cb..5fbabb26 100644 --- a/lib/cartodb/server-info-controller.js +++ b/lib/cartodb/server-info-controller.js @@ -14,7 +14,7 @@ function ServerInfoController(versions) { module.exports = ServerInfoController; -ServerInfoController.prototype.register = function(monitorRouter) { +ServerInfoController.prototype.route = function(monitorRouter) { monitorRouter.get('/health', this.health.bind(this)); monitorRouter.get('/', this.welcome.bind(this)); monitorRouter.get('/version', this.version.bind(this)); diff --git a/lib/cartodb/server.js b/lib/cartodb/server.js index f02ee384..d434c48b 100644 --- a/lib/cartodb/server.js +++ b/lib/cartodb/server.js @@ -33,12 +33,12 @@ module.exports = function createServer (serverOptions) { app.set('json replacer', jsonReplacer()); const apiRouter = new ApiRouter({ serverOptions, environmentOptions: global.environment }); - apiRouter.register(app, serverOptions.routes.api); + apiRouter.route(app, serverOptions.routes.api); const versions = getAndValidateVersions(serverOptions); const serverInfoController = new ServerInfoController(versions); - serverInfoController.register(app); + serverInfoController.route(app); return app; };