Skip to content

Avoid tracing messages in Transport when tracing is false #221

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Avoid tracing messages in Transport when tracing is false #221

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 21 additions & 9 deletions src/webserial.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,6 @@ class Transport {
if (this.device.writable) {
const writer = this.device.writable.getWriter();
if (this.tracing) {
console.log("Write bytes");
this.trace(`Write ${outData.length} bytes: ${this.hexConvert(outData)}`);
}
await writer.write(outData);
Expand Down Expand Up @@ -322,11 +321,15 @@ class Transport {
? "Serial data stream stopped: Possible serial noise or corruption."
: "No serial data received."
: `Packet content transfer stopped`;
this.trace(msg);
if (this.tracing) {
this.trace(msg);
}
throw new Error(msg);
}

this.trace(`Read ${readBytes.length} bytes: ${this.hexConvert(readBytes)}`);
if (this.tracing) {
this.trace(`Read ${readBytes.length} bytes: ${this.hexConvert(readBytes)}`);
}

let i = 0; // Track position in readBytes
while (i < readBytes.length) {
Expand All @@ -335,9 +338,13 @@ class Transport {
if (byte === this.SLIP_END) {
partialPacket = new Uint8Array(0); // Start of a new packet
} else {
this.trace(`Read invalid data: ${this.hexConvert(readBytes)}`);
if (this.tracing) {
this.trace(`Read invalid data: ${this.hexConvert(readBytes)}`);
}
const remainingData = await this.newRead(this.inWaiting(), timeout);
this.trace(`Remaining data in serial buffer: ${this.hexConvert(remainingData)}`);
if (this.tracing) {
this.trace(`Remaining data in serial buffer: ${this.hexConvert(remainingData)}`);
}
this.detectPanicHandler(new Uint8Array([...readBytes, ...(remainingData || [])]));
throw new Error(`Invalid head of packet (0x${byte.toString(16)}): Possible serial noise or corruption.`);
}
Expand All @@ -348,16 +355,22 @@ class Transport {
} else if (byte === this.SLIP_ESC_ESC) {
partialPacket = this.appendArray(partialPacket, new Uint8Array([this.SLIP_ESC]));
} else {
this.trace(`Read invalid data: ${this.hexConvert(readBytes)}`);
if (this.tracing) {
this.trace(`Read invalid data: ${this.hexConvert(readBytes)}`);
}
const remainingData = await this.newRead(this.inWaiting(), timeout);
this.trace(`Remaining data in serial buffer: ${this.hexConvert(remainingData)}`);
if (this.tracing) {
this.trace(`Remaining data in serial buffer: ${this.hexConvert(remainingData)}`);
}
this.detectPanicHandler(new Uint8Array([...readBytes, ...(remainingData || [])]));
throw new Error(`Invalid SLIP escape (0xdb, 0x${byte.toString(16)})`);
}
} else if (byte === this.SLIP_ESC) {
isEscaping = true;
} else if (byte === this.SLIP_END) {
this.trace(`Received full packet: ${this.hexConvert(partialPacket)}`);
if (this.tracing) {
this.trace(`Received full packet: ${this.hexConvert(partialPacket)}`);
}
this.buffer = this.appendArray(this.buffer, readBytes.slice(i));
yield partialPacket;
partialPacket = null;
Expand All @@ -381,7 +394,6 @@ class Transport {
const { value, done } = await this.reader.read();
if (done || !value) break;
if (this.tracing) {
console.log("Raw Read bytes");
this.trace(`Read ${value.length} bytes: ${this.hexConvert(value)}`);
}
yield value; // Yield each data chunk
Expand Down