Skip to content

Remove handled fragmented messages from the map #571

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.

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

Merged
merged 2 commits into from
Aug 17, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
29 changes: 18 additions & 11 deletions src/network/ClientConnection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -242,25 +242,32 @@ export class ClientMessageReader {
/** @internal */
export class FragmentedClientMessageHandler {
private readonly fragmentedMessages = new Map<number, ClientMessage>();
private readonly logger: ILogger;

constructor(logger: ILogger) {
this.logger = logger;
}

handleFragmentedMessage(clientMessage: ClientMessage, callback: Function): void {
const fragmentationFrame = clientMessage.startFrame;
const fragmentationId = clientMessage.getFragmentationId();
clientMessage.dropFragmentationFrame();
if (fragmentationFrame.hasBeginFragmentFlag()) {
this.fragmentedMessages.set(fragmentationId, clientMessage);
} else if (fragmentationFrame.hasEndFragmentFlag()) {
const mergedMessage = this.mergeIntoExistingClientMessage(fragmentationId, clientMessage);
callback(mergedMessage);
} else {
this.mergeIntoExistingClientMessage(fragmentationId, clientMessage);
}
}
const existingMessage = this.fragmentedMessages.get(fragmentationId);
if (existingMessage == null) {
this.logger.debug('FragmentedClientMessageHandler',
'A fragmented message without the begin part is received. Fragmentation id: ' + fragmentationId);
return;
}

private mergeIntoExistingClientMessage(fragmentationId: number, clientMessage: ClientMessage): ClientMessage {
const existingMessage = this.fragmentedMessages.get(fragmentationId);
existingMessage.merge(clientMessage);
return existingMessage;
existingMessage.merge(clientMessage);
if (fragmentationFrame.hasEndFragmentFlag()) {
this.fragmentedMessages.delete(fragmentationId);
callback(existingMessage);
}
}
}
}

Expand Down Expand Up @@ -304,7 +311,7 @@ export class ClientConnection {
this.reader = new ClientMessageReader();
this.connectionId = connectionId;
this.logger = this.client.getLoggingService().getLogger();
this.fragmentedMessageHandler = new FragmentedClientMessageHandler();
this.fragmentedMessageHandler = new FragmentedClientMessageHandler(this.logger);
}

/**
Expand Down
18 changes: 15 additions & 3 deletions test/connection/FragmentedClientMessageHandlerTest.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,16 @@ const ClientMessageReader = require('../../lib/network/ClientConnection').Client
const cm = require('../../lib/ClientMessage');
const FixSizedTypesCodec = require('../../lib/codec/builtin/FixSizedTypesCodec').FixSizedTypesCodec;

describe('FragmentedClientMessageHandler', function () {
describe('FragmentedClientMessageHandlerTest', function () {

let reader;
let handler;

beforeEach(() => {
reader = new ClientMessageReader();
handler = new FragmentedClientMessageHandler();
handler = new FragmentedClientMessageHandler({
debug: () => {}
});
});

it('handles fragmented message', function (done) {
Expand Down Expand Up @@ -62,15 +64,25 @@ describe('FragmentedClientMessageHandler', function () {

// Should merge with the above message
handler.handleFragmentedMessage(fragment1, () => done(new Error("It should just merge.")));
expect(handler.fragmentedMessages.size).to.equal(1);
compareMessages(fragments[1].startFrame.next, endFrame.next);
endFrame = fragmentedMessage.endFrame;

// Should merge with the above message and run the callback
let isCalled = false;
handler.handleFragmentedMessage(fragment2, () => {
compareMessages(fragments[2].startFrame.next, endFrame.next);
done();
isCalled = true;
});
expect(isCalled).to.be.true;
expect(handler.fragmentedMessages.size).to.equal(0);

// If a message with a missing begin part is received, we should do nothing
handler.handleFragmentedMessage(fragment1, () => done(new Error("It should ignore invalid messages.")))
handler.handleFragmentedMessage(fragment2, () => done(new Error("It should ignore invalid messages.")))
expect(handler.fragmentedMessages.size).to.equal(0);

done();
});

const compareMessages = (frame1, frame2) => {
Expand Down