Skip to content

Commit

Permalink
[BREAKING] Deprecate advanced APIs in preparation of refactoring
Browse files Browse the repository at this point in the history
BREAKING CHANGE:
In preparation for a major refactoring of @ui5/logger, and as part of
making its API public, this breaking change removes capabilities that
are likely to change and should not be part of a public API.

This will ensure that later changes to the module can be donen in a
compatible manner.

Relevant changes:
* Restrict log-methods to two argument only. The use of placeholders
  like '%s' is no longer supported. A warning will be logged if more
  than two argument is supplied. Placeholders will be replaced with a
  deprecation message. We suggest the use of template literals.
* Deprecate #getGroupLogger method. Calling it throws an error.
  It will be removed in one of the next patch releases
* Deprecate #setShowProgress method. Calling it throws an error.
  It will be removed in one of the next patch releases
* Remove GroupLogger and TaskLogger classes. Similar functionality might
  be re-added in a later release.
  • Loading branch information
RandomByte committed Dec 22, 2022
1 parent b9e7461 commit 3aea5e7
Show file tree
Hide file tree
Showing 2 changed files with 115 additions and 188 deletions.
100 changes: 33 additions & 67 deletions lib/logger.js
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,20 @@ function isLevelEnabled(levelName) {
}
}

const substitutionPlaceholders = /%[oOdisfc]/g;
function handleLogArguments(mode, messages) {
if (messages.length > 1) {
messages[0] = messages[0].replaceAll(substitutionPlaceholders, "<deprecated string substitution char>");
}
if (messages.length > 2) {
console.log(`⚠️ @ui5/logger: Deprecated log.${mode}() call with multiple arguments. ` +
`@ui5/logger version 3 does not accept more than two argument. Call stack of this invocation:`);
console.trace();
return [messages[0], messages[1]];
}
return messages;
}

class Logger {
constructor(moduleName) {
this._moduleName = moduleName;
Expand All @@ -50,95 +64,48 @@ class Logger {
}

silly(...messages) {
return this._logger.silly(this._moduleName, ...messages);
return this._logger.silly(this._moduleName, ...handleLogArguments("silly", messages));
}

verbose(...messages) {
return this._logger.verbose(this._moduleName, ...messages);
return this._logger.verbose(this._moduleName, ...handleLogArguments("verbose", messages));
}

perf(...messages) {
return this._logger.perf(this._moduleName, ...messages);
return this._logger.perf(this._moduleName, ...handleLogArguments("perf", messages));
}

info(...messages) {
return this._logger.info(this._moduleName, ...messages);
return this._logger.info(this._moduleName, ...handleLogArguments("info", messages));
}

warn(...messages) {
return this._logger.warn(this._moduleName, ...messages);
return this._logger.warn(this._moduleName, ...handleLogArguments("warn", messages));
}

error(...messages) {
return this._logger.error(this._moduleName, ...messages);
return this._logger.error(this._moduleName, ...handleLogArguments("error", messages));
}

_getLogger() {
// TODO 3.0: Remove this function
console.log("⚠️ Deprecated call to Logger#_getLogger. " +
"Internal method Logger#_getLogger has been deprecated and will be removed.");
console.trace();
return this._logger;
}
}

class GroupLogger extends Logger {
constructor(moduleName, weight = 0, parentLogger) {
super(moduleName);

if (parentLogger) {
this._logger = parentLogger._getLogger().newGroup("", weight);
} else {
this._logger = npmlog.newGroup("", weight);
}
}

createSubLogger(name, weight) {
return new GroupLogger(this._moduleName + " " + name, weight, this);
}

createTaskLogger(name, todo, weight) {
return new TaskLogger(this._moduleName + " " + name, todo, weight, this);
}
}


class TaskLogger extends Logger {
constructor(moduleName, todo, weight, parentLogger) {
super(moduleName);
this._todo = todo || 0;
this._completed = 0;

if (parentLogger) {
this._logger = parentLogger._getLogger().newItem("", todo, weight);
} else {
this._logger = npmlog.newItem(this._moduleName, todo, weight);
}
}

addWork(todo) {
this._logger.addWork(todo);
this._todo += todo;
}

startWork(...messages) {
// Current job number is completed + 1
this.info(`(${this._completed + 1}/${this._todo})`, ...messages);
}

completeWork(completed) {
this._completed += completed;
this._logger.completeWork(completed);
}

finish() {
return this._logger.finish();
}
}

const logger = {
getLogger: function(moduleName) {
return new Logger(moduleName);
},

getGroupLogger: function(moduleName) {
return new GroupLogger(moduleName);
// TODO 3.0: Remove this function
throw new Error("Deprecated call to @ui5/logger#getGroupLogger. " +
"This function has been deprecated in @ui5/logger version 3 and will be " +
"removed in the final release");
},

setLevel(level) {
Expand All @@ -151,19 +118,18 @@ const logger = {
isLevelEnabled,

setShowProgress(showProgress) {
if (showProgress) {
npmlog.enableProgress();
} else {
npmlog.disableProgress();
}
// TODO 3.0: Remove this function
throw new Error("Deprecated call to @ui5/logger#setShowProgress. " +
"This function has been deprecated in @ui5/logger version 3 and will be " +
"removed in the final release");
},
};

// Export internal classes for testing only
/* istanbul ignore else */
if (process.env.NODE_ENV === "test") {
logger.__test__ = {
Logger, GroupLogger, TaskLogger
Logger
};
}

Expand Down
Loading

0 comments on commit 3aea5e7

Please sign in to comment.