Deprecate displayServerURL

FoalTS · Aug 3, 2024 · 3d5c845 · 3d5c845
1 parent 9489962
commit 3d5c845
Show file tree

Hide file tree

Showing 7 changed files with 37 additions and 14 deletions.
diff --git a/docs/docs/common/websockets.md b/docs/docs/common/websockets.md
@@ -48,13 +48,14 @@ import * as http from 'http';
 
 async function main() {
   const serviceManager = new ServiceManager();
+  const logger = serviceManager.get(Logger);
 
   const app = await createApp(AppController, { serviceManager });
 
   const httpServer = http.createServer(app);
   // Instanciate, init and connect websocket controllers.
   await serviceManager.get(WebsocketController).attachHttpServer(httpServer);
-  httpServer.listen(port, () => displayServerURL(port));
+  httpServer.listen(port, () => logger.info(`Listening on port ${port}...`));
 }
 
 ```

diff --git a/docs/docs/security/rate-limiting.md b/docs/docs/security/rate-limiting.md
@@ -15,7 +15,7 @@ npm install express express-rate-limit
 *src/index.ts*
 ```typescript
 // 3p
-import { Config, createApp, displayServerURL } from '@foal/core';
+import { Config, createApp, Logger, ServiceManager } from '@foal/core';
 import * as express from 'express';
 import * as rateLimit from 'express-rate-limit';
 
@@ -41,11 +41,14 @@ async function main() {
       res.status(this.statusCode || 429).send(this.message);
     }
   }));
+
+  const serviceManager = new ServiceManager();
+  const logger = serviceManager.get(Logger);
 
   const app = await createApp(AppController, { expressInstance: expressApp });
 
   const port = Config.get('port', 'number', 3001);
-  app.listen(port, () => displayServerURL(port));
+  app.listen(port, () => logger.info(`Listening on port ${port}...`));
 }
 
 main()

diff --git a/packages/acceptance-tests/src/docs/security/limit-repeated-requests.spec.ts b/packages/acceptance-tests/src/docs/security/limit-repeated-requests.spec.ts
@@ -1,5 +1,5 @@
 // 3p
-import { Config, createApp, displayServerURL } from '@foal/core';
+import { Config, createApp, Logger, ServiceManager } from '@foal/core';
 import * as express from 'express';
 import * as rateLimit from 'express-rate-limit';
 
@@ -28,9 +28,12 @@ it('[Docs] Cookbook > Limit Repeated Requests', () => {
       }
     }));
 
+    const serviceManager = new ServiceManager();
+    const logger = serviceManager.get(Logger);
+
     const app = await createApp(AppController, { expressInstance: expressApp });
 
     const port = Config.get('port', 'number', 3001);
-    app.listen(port, () => displayServerURL(port));
+    app.listen(port, () => logger.info(`Listening on port ${port}...`));
   }
 });
diff --git a/packages/cli/src/generate/specs/app/src/index.ts b/packages/cli/src/generate/specs/app/src/index.ts
@@ -1,7 +1,7 @@
 import 'source-map-support/register';
 
 // 3p
-import { Config, createApp, displayServerURL } from '@foal/core';
+import { Config, createApp, Logger, ServiceManager } from '@foal/core';
 
 // App
 import { AppController } from './app/app.controller';
@@ -10,10 +10,13 @@ import { dataSource } from './db';
 async function main() {
   await dataSource.initialize();
 
-  const app = await createApp(AppController);
+  const serviceManager = new ServiceManager();
+  const logger = serviceManager.get(Logger);
+
+  const app = await createApp(AppController, { serviceManager });
 
   const port = Config.get('port', 'number', 3001);
-  app.listen(port, () => displayServerURL(port));
+  app.listen(port, () => logger.info(`Listening on port ${port}...`));
 }
 
 main()

diff --git a/packages/cli/src/generate/templates/app/src/index.ts b/packages/cli/src/generate/templates/app/src/index.ts
@@ -1,7 +1,7 @@
 import 'source-map-support/register';
 
 // 3p
-import { Config, createApp, displayServerURL } from '@foal/core';
+import { Config, createApp, Logger, ServiceManager } from '@foal/core';
 
 // App
 import { AppController } from './app/app.controller';
@@ -10,10 +10,13 @@ import { dataSource } from './db';
 async function main() {
   await dataSource.initialize();
 
-  const app = await createApp(AppController);
+  const serviceManager = new ServiceManager();
+  const logger = serviceManager.get(Logger);
+
+  const app = await createApp(AppController, { serviceManager });
 
   const port = Config.get('port', 'number', 3001);
-  app.listen(port, () => displayServerURL(port));
+  app.listen(port, () => logger.info(`Listening on port ${port}...`));
 }
 
 main()

diff --git a/packages/core/src/common/utils/display-server-url.util.ts b/packages/core/src/common/utils/display-server-url.util.ts
@@ -1,3 +1,10 @@
+/**
+ * Display server URL in console
+ *
+ * This function is deprecated. Use "services.get(Logger).info(`Listening on port ${port}...`)" instead.
+ *
+ * @deprecated
+ */
 export function displayServerURL(port: number, log = console.log) {
   log();
   log('\x1b[32m -------------------------------------- \x1b[0m');

diff --git a/packages/examples/src/index.ts b/packages/examples/src/index.ts
@@ -7,7 +7,7 @@
 import 'source-map-support/register';
 
 // 3p
-import { Config, createApp, displayServerURL } from '@foal/core';
+import { Config, createApp, Logger, ServiceManager } from '@foal/core';
 
 // App
 import { AppController } from './app/app.controller';
@@ -16,10 +16,13 @@ import { dataSource } from './db';
 async function main() {
   await dataSource.initialize();
 
-  const app = await createApp(AppController);
+  const serviceManager = new ServiceManager();
+  const logger = serviceManager.get(Logger);
+
+  const app = await createApp(AppController, { serviceManager });
 
   const port = Config.get('port', 'number', 3001);
-  app.listen(port, () => displayServerURL(port));
+  app.listen(port, () => logger.info(`Listening on port ${port}...`));
 }
 
 main()