Skip to content

Commit 28d5dd9

Browse files
committed
Revert "Allow logging functions to accept string[] directly"
This reverts commit 909fda1.
1 parent 962aaad commit 28d5dd9

4 files changed

Lines changed: 19 additions & 75 deletions

File tree

‎lib/entry-points.js‎

Lines changed: 4 additions & 16 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/logging.test.ts‎

Lines changed: 0 additions & 17 deletions
This file was deleted.

‎src/logging.ts‎

Lines changed: 8 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,23 @@
11
import * as core from "@actions/core";
22

3-
/** Types that all of our logging functions accept. */
4-
export type Loggable = string | string[];
5-
6-
/** Some logging functions also accept errors directly. */
7-
export type LoggableError = Loggable | Error;
8-
93
export interface Logger {
10-
debug: (message: Loggable) => void;
11-
info: (message: Loggable) => void;
12-
warning: (message: LoggableError) => void;
13-
error: (message: LoggableError) => void;
4+
debug: (message: string) => void;
5+
info: (message: string) => void;
6+
warning: (message: string | Error) => void;
7+
error: (message: string | Error) => void;
148

159
isDebug: () => boolean;
1610

1711
startGroup: (name: string) => void;
1812
endGroup: () => void;
1913
}
2014

21-
/** If `message` is an array of strings, the array is `join`-ed into one string separated by spaces. */
22-
export const joinMessageStrings = <T>(
23-
message: string[] | string | T,
24-
): string | T => {
25-
if (Array.isArray(message)) {
26-
return message.join(" ");
27-
} else {
28-
return message;
29-
}
30-
};
31-
32-
/**
33-
* Wraps a logging function so that `joinMessageStrings` is applied to the input before
34-
* calling the wrapped logging function.
35-
*/
36-
const autoJoinMessageStrings = <T>(fn: (msg: string | T) => void) => {
37-
return (message: string[] | string | T) => {
38-
return fn(joinMessageStrings(message));
39-
};
40-
};
41-
4215
export function getActionsLogger(): Logger {
4316
return {
44-
debug: autoJoinMessageStrings(core.debug),
45-
info: autoJoinMessageStrings(core.info),
46-
warning: autoJoinMessageStrings(core.warning),
47-
error: autoJoinMessageStrings(core.error),
17+
debug: core.debug,
18+
info: core.info,
19+
warning: core.warning,
20+
error: core.error,
4821
isDebug: core.isDebug,
4922
startGroup: core.startGroup,
5023
endGroup: core.endGroup,

‎src/testing-utils.ts‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ import {
3030
featureConfig,
3131
FeatureEnablement,
3232
} from "./feature-flags";
33-
import { joinMessageStrings, Loggable, LoggableError, Logger } from "./logging";
33+
import { Logger } from "./logging";
3434
import { OverlayDatabaseMode } from "./overlay/overlay-database-mode";
3535
import { getBundlePlatform } from "./platform";
3636
import { ActionName } from "./status-report";
@@ -658,8 +658,8 @@ export class RecordingLogger implements Logger {
658658

659659
constructor(private readonly logToConsole: boolean = true) {}
660660

661-
private addMessage(level: LogLevel, message: LoggableError): void {
662-
this.messages.push({ type: level, message: joinMessageStrings(message) });
661+
private addMessage(level: LogLevel, message: string | Error): void {
662+
this.messages.push({ type: level, message });
663663

664664
if (this.logToConsole) {
665665
// eslint-disable-next-line no-console
@@ -684,19 +684,19 @@ export class RecordingLogger implements Logger {
684684
return true;
685685
}
686686

687-
debug(message: Loggable) {
687+
debug(message: string) {
688688
this.addMessage("debug", message);
689689
}
690690

691-
info(message: Loggable) {
691+
info(message: string) {
692692
this.addMessage("info", message);
693693
}
694694

695-
warning(message: LoggableError) {
695+
warning(message: string | Error) {
696696
this.addMessage("warning", message);
697697
}
698698

699-
error(message: LoggableError) {
699+
error(message: string | Error) {
700700
this.addMessage("error", message);
701701
}
702702

0 commit comments

Comments
 (0)