feat(core-plugins): remove kuzzle-plugin-logger from core plugins and…

… mark its config as deprecated
kuzzleio · Jul 19, 2024 · cabb542 · cabb542
1 parent b35ce72
commit cabb542
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 30 deletions.
diff --git a/.kuzzlerc.sample.jsonc b/.kuzzlerc.sample.jsonc
@@ -142,7 +142,6 @@
       "maxConcurrentPipes": 50,
       "pipesBufferSize": 50000,
       "include": [
-        "kuzzle-plugin-logger",
         "kuzzle-plugin-auth-passport-local"
       ]
     },

diff --git a/lib/config/default.config.ts b/lib/config/default.config.ts
@@ -75,7 +75,7 @@ const defaultConfig: KuzzleConfiguration = {
       initTimeout: 10000,
       maxConcurrentPipes: 50,
       pipesBufferSize: 50000,
-      include: ["kuzzle-plugin-logger", "kuzzle-plugin-auth-passport-local"],
+      include: ["kuzzle-plugin-auth-passport-local"],
     },
     "kuzzle-plugin-logger": {
       services: {

diff --git a/lib/core/plugin/pluginsManager.js b/lib/core/plugin/pluginsManager.js
@@ -43,10 +43,7 @@ const strategyError = kerror.wrap("plugin", "strategy");
 const controllerError = kerror.wrap("plugin", "controller");
 
 // Without those plugins, Kuzzle won't start at all.
-const CORE_PLUGINS = [
-  "kuzzle-plugin-logger",
-  "kuzzle-plugin-auth-passport-local",
-];
+const CORE_PLUGINS = ["kuzzle-plugin-auth-passport-local"];
 
 /**
  * @class PluginsManager

diff --git a/lib/types/config/PluginsConfiguration.ts b/lib/types/config/PluginsConfiguration.ts
@@ -31,7 +31,7 @@ export type PluginsConfiguration = {
      * Edit this list to deactivate one or more of those plugins.
      * NOTE: this list does not control plugins installed manually.
      *
-     * @default ["kuzzle-plugin-logger","kuzzle-plugin-auth-passport-local"]
+     * @default ["kuzzle-plugin-auth-passport-local"]
      */
     include: string[];
 
@@ -76,23 +76,16 @@ export type PluginsConfiguration = {
   };
 
   /**
-   * Default logger plugin configuration.
-   *
-   * This plugin use Winston to transport the logs.
-   *
-   * @see https://github.com/kuzzleio/kuzzle-plugin-logger
+   * Logger plugin configuration.
+   * @deprecated use server.logs
    */
   "kuzzle-plugin-logger": {
     /**
-     * Winston transport services declaration
+     * Services declaration
      */
     services: {
       /**
        * Print logs to STDOUT
-       *
-       * @default
-       *
-       * @see https://github.com/winstonjs/winston/blob/master/docs/transports.md#console-transport
        */
       stdout: {
         /**

diff --git a/test/core/backend/Backend.test.js b/test/core/backend/Backend.test.js
@@ -110,10 +110,7 @@ describe("Backend", () => {
 
       should(options.secretsFile).be.eql(application._secretsFile);
       should(options.vaultKey).be.eql(application._vaultKey);
-      should(options.plugins).have.keys(
-        "kuzzle-plugin-logger",
-        "kuzzle-plugin-auth-passport-local",
-      );
+      should(options.plugins).have.keys("kuzzle-plugin-auth-passport-local");
       should(options.installations).be.eql(
         application._installationsWaitingList,
       );
@@ -129,7 +126,7 @@ describe("Backend", () => {
       );
 
       application.config.content.plugins.common.include = [
-        "kuzzle-plugin-logger",
+        "kuzzle-plugin-auth-passport-local",
       ];
 
       await application.start();
@@ -138,8 +135,7 @@ describe("Backend", () => {
 
       const [, options] = global.kuzzle.start.getCall(0).args;
 
-      should(options.plugins).have.keys("kuzzle-plugin-logger");
-      should(options.plugins).not.have.keys(
+      should(options.plugins).have.only.keys(
         "kuzzle-plugin-auth-passport-local",
       );
     });

diff --git a/test/core/plugin/pluginsManager.test.js b/test/core/plugin/pluginsManager.test.js
@@ -112,21 +112,16 @@ describe("Plugin", () => {
     });
 
     it("should only load core plugins in failsafe mode", async () => {
-      const loggerPlugin = createPlugin("kuzzle-plugin-logger");
       const localPlugin = createPlugin("kuzzle-plugin-auth-passport-local");
       pluginsManager.loadPlugins.returns(
-        new Map([
-          [loggerPlugin.name, loggerPlugin],
-          [localPlugin.name, localPlugin],
-        ]),
+        new Map([[localPlugin.name, localPlugin]]),
       );
       pluginsManager._plugins.set(plugin.name, plugin);
       pluginsManager.config.common.failsafeMode = true;
 
       await pluginsManager.init();
 
       should(pluginsManager.loadedPlugins).be.eql([
-        "kuzzle-plugin-logger",
         "kuzzle-plugin-auth-passport-local",
       ]);
     });