@salesforce/core 3.10.0 → 3.10.1

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [3.10.1](https://github.com/forcedotcom/sfdx-core/compare/v3.10.0...v3.10.1) (2022-03-24)
+
+### Bug Fixes
+
+- rotating file logs ([ef5df25](https://github.com/forcedotcom/sfdx-core/commit/ef5df25c17a67541d12d5c228c18b75775251d98))
+
 ## [3.10.0](https://github.com/forcedotcom/sfdx-core/compare/v3.9.0...v3.10.0) (2022-03-23)
 
 ### Features

package/lib/config/envVars.d.ts

@@ -26,6 +26,8 @@ export declare enum EnvironmentVariable {
     'SFDX_INSTANCE_URL' = "SFDX_INSTANCE_URL",
     'SFDX_JSON_TO_STDOUT' = "SFDX_JSON_TO_STDOUT",
     'SFDX_LOG_LEVEL' = "SFDX_LOG_LEVEL",
+    'SFDX_LOG_ROTATION_COUNT' = "SFDX_LOG_ROTATION_COUNT",
+    'SFDX_LOG_ROTATION_PERIOD' = "SFDX_LOG_ROTATION_PERIOD",
     'SFDX_MAX_QUERY_LIMIT' = "SFDX_MAX_QUERY_LIMIT",
     'SFDX_MDAPI_TEMP_DIR' = "SFDX_MDAPI_TEMP_DIR",
     'SFDX_NPM_REGISTRY' = "SFDX_NPM_REGISTRY",
@@ -58,6 +60,8 @@ export declare enum EnvironmentVariable {
     'SF_INSTANCE_URL' = "SF_INSTANCE_URL",
     'SF_JSON_TO_STDOUT' = "SF_JSON_TO_STDOUT",
     'SF_LOG_LEVEL' = "SF_LOG_LEVEL",
+    'SF_LOG_ROTATION_COUNT' = "SF_LOG_ROTATION_COUNT",
+    'SF_LOG_ROTATION_PERIOD' = "SF_LOG_ROTATION_PERIOD",
     'SF_MAX_QUERY_LIMIT' = "SF_MAX_QUERY_LIMIT",
     'SF_MDAPI_TEMP_DIR' = "SF_MDAPI_TEMP_DIR",
     'SF_NPM_REGISTRY' = "SF_NPM_REGISTRY",

package/lib/config/envVars.js

@@ -40,6 +40,8 @@ var EnvironmentVariable;
     EnvironmentVariable["SFDX_INSTANCE_URL"] = "SFDX_INSTANCE_URL";
     EnvironmentVariable["SFDX_JSON_TO_STDOUT"] = "SFDX_JSON_TO_STDOUT";
     EnvironmentVariable["SFDX_LOG_LEVEL"] = "SFDX_LOG_LEVEL";
+    EnvironmentVariable["SFDX_LOG_ROTATION_COUNT"] = "SFDX_LOG_ROTATION_COUNT";
+    EnvironmentVariable["SFDX_LOG_ROTATION_PERIOD"] = "SFDX_LOG_ROTATION_PERIOD";
     EnvironmentVariable["SFDX_MAX_QUERY_LIMIT"] = "SFDX_MAX_QUERY_LIMIT";
     EnvironmentVariable["SFDX_MDAPI_TEMP_DIR"] = "SFDX_MDAPI_TEMP_DIR";
     EnvironmentVariable["SFDX_NPM_REGISTRY"] = "SFDX_NPM_REGISTRY";
@@ -72,6 +74,8 @@ var EnvironmentVariable;
     EnvironmentVariable["SF_INSTANCE_URL"] = "SF_INSTANCE_URL";
     EnvironmentVariable["SF_JSON_TO_STDOUT"] = "SF_JSON_TO_STDOUT";
     EnvironmentVariable["SF_LOG_LEVEL"] = "SF_LOG_LEVEL";
+    EnvironmentVariable["SF_LOG_ROTATION_COUNT"] = "SF_LOG_ROTATION_COUNT";
+    EnvironmentVariable["SF_LOG_ROTATION_PERIOD"] = "SF_LOG_ROTATION_PERIOD";
     EnvironmentVariable["SF_MAX_QUERY_LIMIT"] = "SF_MAX_QUERY_LIMIT";
     EnvironmentVariable["SF_MDAPI_TEMP_DIR"] = "SF_MDAPI_TEMP_DIR";
     EnvironmentVariable["SF_NPM_REGISTRY"] = "SF_NPM_REGISTRY";
@@ -186,6 +190,14 @@ exports.SUPPORTED_ENV_VARS = {
         description: getMessage(EnvironmentVariable.SFDX_LOG_LEVEL),
         synonymOf: EnvironmentVariable.SF_LOG_LEVEL,
     },
+    [EnvironmentVariable.SFDX_LOG_ROTATION_COUNT]: {
+        description: getMessage(EnvironmentVariable.SFDX_LOG_ROTATION_COUNT),
+        synonymOf: EnvironmentVariable.SF_LOG_ROTATION_COUNT,
+    },
+    [EnvironmentVariable.SFDX_LOG_ROTATION_PERIOD]: {
+        description: getMessage(EnvironmentVariable.SFDX_LOG_ROTATION_PERIOD),
+        synonymOf: EnvironmentVariable.SF_LOG_ROTATION_PERIOD,
+    },
     [EnvironmentVariable.SFDX_MAX_QUERY_LIMIT]: {
         description: getMessage(EnvironmentVariable.SFDX_MAX_QUERY_LIMIT),
         synonymOf: EnvironmentVariable.SF_MAX_QUERY_LIMIT,
@@ -315,6 +327,14 @@ exports.SUPPORTED_ENV_VARS = {
         description: getMessage(EnvironmentVariable.SF_LOG_LEVEL),
         synonymOf: null,
     },
+    [EnvironmentVariable.SF_LOG_ROTATION_COUNT]: {
+        description: getMessage(EnvironmentVariable.SF_LOG_ROTATION_COUNT),
+        synonymOf: null,
+    },
+    [EnvironmentVariable.SF_LOG_ROTATION_PERIOD]: {
+        description: getMessage(EnvironmentVariable.SF_LOG_ROTATION_PERIOD),
+        synonymOf: null,
+    },
     [EnvironmentVariable.SF_MAX_QUERY_LIMIT]: {
         description: getMessage(EnvironmentVariable.SF_MAX_QUERY_LIMIT),
         synonymOf: null,

package/lib/logger.d.ts

@@ -163,6 +163,17 @@ export declare class Logger {
     static readonly LEVEL_NAMES: string[];
     private static readonly lifecycle;
     private static rootLogger?;
+    /**
+     * The default rotation period for logs. Example '1d' will rotate logs daily (at midnight).
+     * See 'period' docs here: https://github.com/forcedotcom/node-bunyan#stream-type-rotating-file
+     */
+    readonly logRotationPeriod: string;
+    /**
+     * The number of backup rotated log files to keep.
+     * Example: '3' will have the base sf.log file, and the past 3 (period) log files.
+     * See 'count' docs here: https://github.com/forcedotcom/node-bunyan#stream-type-rotating-file
+     */
+    readonly logRotationCount: number;
     /**
      * Whether debug is enabled for this Logger.
      */

package/lib/logger.js

@@ -74,6 +74,17 @@ class Logger {
      * `Logger`.
      */
     constructor(optionsOrName) {
+        /**
+         * The default rotation period for logs. Example '1d' will rotate logs daily (at midnight).
+         * See 'period' docs here: https://github.com/forcedotcom/node-bunyan#stream-type-rotating-file
+         */
+        this.logRotationPeriod = new kit_1.Env().getString('SF_LOG_ROTATION_PERIOD') || '1d';
+        /**
+         * The number of backup rotated log files to keep.
+         * Example: '3' will have the base sf.log file, and the past 3 (period) log files.
+         * See 'count' docs here: https://github.com/forcedotcom/node-bunyan#stream-type-rotating-file
+         */
+        this.logRotationCount = new kit_1.Env().getNumber('SF_LOG_ROTATION_COUNT') || 2;
         /**
          * Whether debug is enabled for this Logger.
          */
@@ -252,12 +263,12 @@ class Logger {
         if (!this.bunyan.streams.find(
         // No bunyan typings
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        (stream) => stream.type === 'file' && stream.path === logFile)) {
-            // TODO: rotating-file
-            // https://github.com/trentm/node-bunyan#stream-type-rotating-file
+        (stream) => stream.type === 'rotating-file' && stream.path === logFile)) {
             this.addStream({
-                type: 'file',
+                type: 'rotating-file',
                 path: logFile,
+                period: this.logRotationPeriod,
+                count: this.logRotationCount,
                 level: this.bunyan.level(),
             });
         }
@@ -292,12 +303,12 @@ class Logger {
         if (!this.bunyan.streams.find(
         // No bunyan typings
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        (stream) => stream.type === 'file' && stream.path === logFile)) {
-            // TODO: rotating-file
-            // https://github.com/trentm/node-bunyan#stream-type-rotating-file
+        (stream) => stream.type === 'rotating-file' && stream.path === logFile)) {
             this.addStream({
-                type: 'file',
+                type: 'rotating-file',
                 path: logFile,
+                period: this.logRotationPeriod,
+                count: this.logRotationCount,
                 level: this.bunyan.level(),
             });
         }

package/messages/envVars.md

@@ -94,6 +94,14 @@ Set to true to send messages resulting from failed Salesforce CLI commands to st
 
 Level of messages that the CLI writes to the log file. Valid values are trace, debug, info, warn, error, fatal. Default value is warn.
 
+# sfdxLogRotationCount
+
+The default rotation period for logs. Example '1d' will rotate logs daily (at midnight).
+
+# sfdxLogRotationPeriod
+
+The number of backup rotated log files to keep. Example: '3' will have the base sf.log file, and the past 3 (period) log files.
+
 # sfdxMaxQueryLimit
 
 Maximum number of Salesforce records returned by a CLI command. Default value is 10,000. Overrides the maxQueryLimit configuration value.
@@ -222,6 +230,14 @@ Set to true to send messages resulting from failed Salesforce CLI commands to st
 
 Level of messages that the CLI writes to the log file. Valid values are trace, debug, info, warn, error, fatal. Default value is warn.
 
+# sfLogRotationCount
+
+The default rotation period for logs. Example '1d' will rotate logs daily (at midnight).
+
+# sfLogRotationPeriod
+
+The number of backup rotated log files to keep. Example: '3' will have the base sf.log file, and the past 3 (period) log files.
+
 # sfMaxQueryLimit
 
 Maximum number of Salesforce records returned by a CLI command. Default value is 10,000. Overrides the maxQueryLimit configuration variable.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "3.10.0",
+  "version": "3.10.1",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",