Skip to content

Commit 7ca51c5

Browse files
author
Kagamihara Nadeshiko
committed
Major logger interface refactoring
1. Use namespace instead of class for Log 2. Remove duplicate code by adding a `logWithSeverity` 3. Rename `global` to `globalLogger` to avoid confusion 4. Change code/tests accordingly
1 parent aa29b00 commit 7ca51c5

File tree

16 files changed

+141
-175
lines changed

16 files changed

+141
-175
lines changed

‎__tests__/Logger.test.ts‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ import type {Reactor} from "../src/core/internal";
33
import {
44
App,
55
Log,
6-
LogLevel,
76
loggingCLAType,
87
booleanCLAType,
98
stringCLAType,
@@ -26,9 +25,9 @@ describe("Logger functions", function () {
2625

2726
describe("Test for Logger", () => {
2827
it("DEBUG Log", () => {
29-
Log.global.level = LogLevel.DEBUG;
28+
Log.setLevel(Log.LogLevel.DEBUG);
3029

31-
console.log("Log level is " + Log.global.level);
30+
console.log("Log level is " + Log.globalLogger.level);
3231
Log.getInstance("test module");
3332
Log.debug(null, () => "test");
3433
Log.debug(null, () => "test", "test module");
@@ -65,7 +64,7 @@ describe("Test for Logger", () => {
6564
expect(Log.log).toHaveBeenCalledTimes(2);
6665
expect(Log.warn).toHaveBeenCalledTimes(2);
6766

68-
console.log(Log.global.level);
67+
console.log(Log.globalLogger.level);
6968
});
7069
});
7170

@@ -75,7 +74,7 @@ describe("Command Line Arguments Helper Functions Tests", () => {
7574
expect(loggingCLAType("")).toBeNull;
7675
});
7776
test("log level check", () => {
78-
expect(loggingCLAType("ERROR")).toBe(1);
77+
expect(loggingCLAType("ERROR")).toBe(Log.LogLevel.ERROR.valueOf());
7978
});
8079
test("boolean test for command line argument parsing", () => {
8180
expect(booleanCLAType("true")).toBe(true);

‎__tests__/OutputGet.test.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ class OutputGetTest extends App {
1212
failure: () => void
1313
) {
1414
super(timeout, true, false, success, failure);
15-
Log.global.debug(">>>>>>>>----" + this.util);
15+
Log.globalLogger.debug(">>>>>>>>----" + this.util);
1616
this.addReaction([this.t], [this.writable(this.o)], function (this, o) {
17-
Log.global.debug(">>>>>>>>>>being triggered>>>>>>>>>>>");
17+
Log.globalLogger.debug(">>>>>>>>>>being triggered>>>>>>>>>>>");
1818
if (o.get() != null) {
1919
throw new Error(
2020
"Calling get on an output before it has been set does not return null"

‎__tests__/dependencies.ts‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ describe("Manually constructed precedence graphs", () => {
145145
graph.removeNode(nodes[1]);
146146
expect(graph.size()[0]).toEqual(5); // V
147147
expect(graph.size()[1]).toEqual(3); // E
148-
Log.global.debug(graph.toString());
148+
Log.globalLogger.debug(graph.toString());
149149
expect(graph.toString()).toBe(
150150
dontIndent`graph
151151
0["app.R[R3]"]
@@ -165,7 +165,7 @@ describe("Manually constructed precedence graphs", () => {
165165
graph.addEdge(nodes[3], nodes[2]);
166166
expect(graph.size()[0]).toEqual(6); // V
167167
expect(graph.size()[1]).toEqual(4); // E
168-
Log.global.debug(graph.toString());
168+
Log.globalLogger.debug(graph.toString());
169169
expect(graph.toString()).toBe(
170170
dontIndent`graph
171171
0["app.R[R3]"]
@@ -195,7 +195,7 @@ describe("Manually constructed precedence graphs", () => {
195195
it("introduce a cycle", () => {
196196
graph.addEdge(nodes[2], nodes[5]);
197197
expect(graph.updatePriorities(false)).toBeFalsy();
198-
Log.global.debug(graph.toString());
198+
Log.globalLogger.debug(graph.toString());
199199
});
200200
});
201201

@@ -217,18 +217,18 @@ describe("ReactionQ", () => {
217217
var reactionQ = new PrioritySet<Priority>();
218218

219219
for (let i = 0; i < 6; i++) {
220-
Log.global.debug(
220+
Log.globalLogger.debug(
221221
"Pushing node: " + i + " with prio: " + nodes[i].getPriority()
222222
);
223223
reactionQ.push(nodes[i]);
224224
}
225225

226226
// duplicate insertions
227-
Log.global.debug(
227+
Log.globalLogger.debug(
228228
"Pushing duplicate node with prio: " + nodes[5].getPriority()
229229
);
230230
reactionQ.push(nodes[5]);
231-
Log.global.debug(
231+
Log.globalLogger.debug(
232232
"Pushing duplicate node with prio: " + nodes[1].getPriority()
233233
);
234234
reactionQ.push(nodes[1]);
@@ -237,7 +237,7 @@ describe("ReactionQ", () => {
237237
const r = reactionQ.pop();
238238
for (let i = 0; i < 6; i++) {
239239
if (Object.is(r, nodes[i])) {
240-
Log.global.debug(
240+
Log.globalLogger.debug(
241241
"Found matching node: " + i + " with prio: " + nodes[i].getPriority()
242242
);
243243
}
@@ -251,7 +251,7 @@ describe("ReactionQ", () => {
251251

252252
for (let i = 0; i < 6; i++) {
253253
if (Object.is(r, nodes[i])) {
254-
Log.global.debug(
254+
Log.globalLogger.debug(
255255
"Found matching node: " + i + " with prio: " + nodes[i].getPriority()
256256
);
257257
}
@@ -264,7 +264,7 @@ describe("ReactionQ", () => {
264264
const r = reactionQ.pop();
265265
for (let i = 0; i < 6; i++) {
266266
if (Object.is(r, nodes[i])) {
267-
Log.global.debug(
267+
Log.globalLogger.debug(
268268
"Found matching node: " + i + " with prio: " + nodes[i].getPriority()
269269
);
270270
}
@@ -277,7 +277,7 @@ describe("ReactionQ", () => {
277277
const r = reactionQ.pop();
278278
for (let i = 0; i < 6; i++) {
279279
if (Object.is(r, nodes[i])) {
280-
Log.global.debug(
280+
Log.globalLogger.debug(
281281
"Found matching node: " + i + " with prio: " + nodes[i].getPriority()
282282
);
283283
}
@@ -290,7 +290,7 @@ describe("ReactionQ", () => {
290290
const r = reactionQ.pop();
291291
for (let i = 0; i < 6; i++) {
292292
if (Object.is(r, nodes[i])) {
293-
Log.global.debug(
293+
Log.globalLogger.debug(
294294
"Found matching node: " + i + " with prio: " + nodes[i].getPriority()
295295
);
296296
}
@@ -303,7 +303,7 @@ describe("ReactionQ", () => {
303303
const r = reactionQ.pop();
304304
for (let i = 0; i < 6; i++) {
305305
if (Object.is(r, nodes[i])) {
306-
Log.global.debug(
306+
Log.globalLogger.debug(
307307
"Found matching node: " + i + " with prio: " + nodes[i].getPriority()
308308
);
309309
}

‎__tests__/disconnect.test.ts‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ import {
1010
TimeValue,
1111
Origin,
1212
Log,
13-
LogLevel,
1413
Action
1514
} from "../src/core/internal";
1615

‎__tests__/mutations.test.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ describe("Creating reactors at runtime", function () {
168168
jest.setTimeout(5000);
169169

170170
it("Reactor with periodic timer", (done) => {
171-
// Log.global.level = LogLevel.DEBUG
171+
// Log.global.level = Log.LogLevel.DEBUG
172172

173173
const app = new Zeno(TimeValue.secs(4), done, () => {});
174174

@@ -181,7 +181,7 @@ describe("Creating reactors at runtime", function () {
181181
// jest.setTimeout(5000);
182182

183183
// it("Simple scatter gather", done => {
184-
// Log.global.level = LogLevel.DEBUG
184+
// Log.global.level = Log.LogLevel.DEBUG
185185

186186
// let app = new ScatterGather(TimeValue.secs(5), done, () => {})
187187

‎__tests__/reactors.errors.test.ts‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ import {
66
InPort,
77
TimeUnit,
88
TimeValue,
9-
Log,
10-
LogLevel
9+
Log
1110
} from "../src/core/internal";
1211

1312
class R extends Reactor {
@@ -49,7 +48,7 @@ class R extends Reactor {
4948
}
5049

5150
describe("Testing Error Cases", function () {
52-
Log.global.level = LogLevel.DEBUG;
51+
Log.setLevel(Log.LogLevel.DEBUG);
5352

5453
it("Multiple reactions for a callee port", () => {
5554
var parent = new App();

‎__tests__/reactors.test.ts‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ import {
88
TimeValue,
99
Origin,
1010
Log,
11-
LogLevel,
1211
Action
1312
} from "../src/core/internal";
1413

@@ -163,7 +162,7 @@ describe("Testing deadlines", function () {
163162
jest.setTimeout(5000);
164163

165164
it("Missed reaction deadline on InPort", (done) => {
166-
Log.global.level = LogLevel.WARN;
165+
Log.setLevel(Log.LogLevel.WARN);
167166

168167
function fail() {
169168
throw new Error("Test has failed.");
@@ -187,7 +186,7 @@ describe("Testing deadlines", function () {
187186
it("Missed reaction deadline on the second reaction in the chain", (done) => {
188187
// let consoleOutput: string[] = []
189188

190-
Log.global.level = LogLevel.WARN;
189+
Log.setLevel(Log.LogLevel.WARN);
191190

192191
function fail() {
193192
throw new Error("Test has failed.");
@@ -219,7 +218,7 @@ describe("Testing deadlines", function () {
219218
});
220219

221220
it("Missed deadline with custom message", (done) => {
222-
Log.global.level = LogLevel.WARN;
221+
Log.setLevel(Log.LogLevel.WARN);
223222

224223
// let deadlineMissed:string = ""
225224

@@ -233,7 +232,7 @@ describe("Testing deadlines", function () {
233232
done,
234233
fail,
235234
() => {
236-
Log.global.warn("Deadline missed!");
235+
Log.warn(null, () => "Deadline missed!");
237236
},
238237
TimeValue.withUnits(1, TimeUnit.nsec)
239238
);
@@ -274,7 +273,7 @@ describe("Testing Reactions", function () {
274273

275274
describe("Testing Actions", function () {
276275
it("Mismatched logical time", () => {
277-
Log.global.level = LogLevel.WARN;
276+
Log.setLevel(Log.LogLevel.WARN);
278277

279278
function fail() {
280279
throw new Error("Test has failed.");

‎src/benchmark/FacilityLocation.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import {
1818
App
1919
} from "../core/internal";
2020

21-
Log.global.level = Log.levels.INFO;
21+
Log.setLevel(Log.LogLevel.INFO);
2222

2323
class Point {
2424
x: number;

‎src/benchmark/PingPong.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import {
99
App
1010
} from "../core/internal";
1111

12-
Log.global.level = Log.levels.ERROR;
12+
Log.setLevel(Log.LogLevel.DEBUG);
1313

1414
export class Ping extends Reactor {
1515
count: Parameter<number>;

‎src/benchmark/Sieve.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import {
1212
Log
1313
} from "../core/internal";
1414

15-
Log.global.level = Log.levels.INFO;
15+
Log.setLevel(Log.LogLevel.INFO);
1616
class Ramp extends Reactor {
1717
next: Action<number>;
1818

0 commit comments

Comments
 (0)