[INTERNAL] AbstractReader: Add getName() function to prepare for better reader tracing

Author: RandomByte

lib/AbstractReader.js

@@ -2,7 +2,7 @@ import randomInt from "random-int";
 import Trace from "./tracing/Trace.js";
 
 /**
- * Abstract resource locator
+ * Abstract resource locator implementing the general API for <b>reading</b> resources
  *
  * @abstract
  * @public
@@ -14,11 +14,22 @@ class AbstractReader {
 	 * The constructor.
 	 *
 	 * @public
+	 * @param {string} name Name of the reader. Typically used for tracing purposes
 	 */
-	constructor() {
+	constructor(name) {
 		if (new.target === AbstractReader) {
 			throw new TypeError("Class 'AbstractReader' is abstract");
 		}
+		this._name = name;
+	}
+
+	/*
+	 * Returns the name of the reader instance. This can be used for logging/tracing purposes.
+	 *
+	 * @returns {string} Name of the reader
+	 */
+	getName() {
+		return this._name || `<unnamed ${this.constructor.name} Reader>`;
 	}
 
 	/**

lib/AbstractReaderWriter.js

@@ -1,7 +1,7 @@
 import AbstractReader from "./AbstractReader.js";
 
 /**
- * Abstract resource locator
+ * Abstract resource locator implementing the general API for <b>reading and writing</b> resources
  *
  * @abstract
  * @public
@@ -14,12 +14,22 @@ class AbstractReaderWriter extends AbstractReader {
 	 * The constructor.
 	 *
 	 * @public
+	 * @param {string} name Name of the reader/writer. Typically used for tracing purposes
 	 */
-	constructor() {
+	constructor(name) {
 		if (new.target === AbstractReaderWriter) {
 			throw new TypeError("Class 'AbstractReaderWriter' is abstract");
 		}
-		super();
+		super(name);
+	}
+
+	/*
+	 * Returns the name of the reader/writer instance. This can be used for logging/tracing purposes.
+	 *
+	 * @returns {string} Name of the reader/writer
+	 */
+	getName() {
+		return this._name || `<unnamed ${this.constructor.name} Reader/Writer>`;
 	}
 
 	/**

lib/DuplexCollection.js

@@ -20,12 +20,12 @@ class DuplexCollection extends AbstractReaderWriter {
 	 * @param {string} [parameters.name=""] The collection name
 	 */
 	constructor({reader, writer, name = ""}) {
-		super();
+		super(name);
 		this._reader = reader;
 		this._writer = writer;
 
 		this._combo = new ReaderCollectionPrioritized({
-			name: name,
+			name: `${name} - ReaderCollectionPrioritized`,
 			readers: [
 				writer,
 				reader

lib/ReaderCollection.js

@@ -17,8 +17,7 @@ class ReaderCollection extends AbstractReader {
 	 * @param {@ui5/fs/AbstractReader[]} parameters.readers List of resource readers (all tried in parallel)
 	 */
 	constructor({name, readers}) {
-		super();
-		this._name = name;
+		super(name);
 		this._readers = readers;
 	}
 

lib/ReaderCollectionPrioritized.js

@@ -18,8 +18,7 @@ class ReaderCollectionPrioritized extends AbstractReader {
 	 * 																(first is tried first)
 	 */
 	constructor({readers, name}) {
-		super();
-		this._name = name;
+		super(name);
 		this._readers = readers;
 	}
 

lib/WriterCollection.js

@@ -29,8 +29,7 @@ class WriterCollection extends AbstractReaderWriter {
 	 * });
 	 */
 	constructor({name, writerMapping}) {
-		super();
-		this._name = name;
+		super(name);
 
 		if (!writerMapping) {
 			throw new Error("Missing parameter 'writerMapping'");

test/lib/DuplexCollection.js

@@ -14,7 +14,7 @@ test("DuplexCollection: constructor", (t) => {
 	t.deepEqual(duplexCollection._reader, {}, "reader assigned");
 	t.deepEqual(duplexCollection._writer, {}, "writer assigned");
 	t.true(duplexCollection._combo instanceof ReaderCollectionPrioritized, "prioritized reader collection created");
-	t.is(duplexCollection._combo._name, "myCollection", "name assigned");
+	t.is(duplexCollection._combo.getName(), "myCollection - ReaderCollectionPrioritized", "name assigned");
 	t.deepEqual(duplexCollection._combo._readers, [{}, {}], "reader and writer assigned to readers");
 });
 
@@ -27,7 +27,7 @@ test("DuplexCollection: constructor with setting default name of an empty string
 	t.deepEqual(duplexCollection._reader, {}, "reader assigned");
 	t.deepEqual(duplexCollection._writer, {}, "writer assigned");
 	t.true(duplexCollection._combo instanceof ReaderCollectionPrioritized, "prioritized reader collection created");
-	t.is(duplexCollection._combo._name, "", "name assigned");
+	t.is(duplexCollection._combo.getName(), " - ReaderCollectionPrioritized", "name assigned");
 	t.deepEqual(duplexCollection._combo._readers, [{}, {}], "reader and writer assigned to readers");
 });
 

test/lib/ReaderCollection.js

@@ -9,7 +9,7 @@ test("ReaderCollection: constructor", (t) => {
 		readers: [{}, {}, {}]
 	});
 
-	t.is(readerCollection._name, "myReader", "correct name assigned");
+	t.is(readerCollection.getName(), "myReader", "correct name assigned");
 	t.deepEqual(readerCollection._readers, [{}, {}, {}], "correct readers assigned");
 });