Skip to content
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

[Service Bus] Throw when partitionKey is not same as sessionId #12490

Merged
merged 2 commits into from
Nov 11, 2020
Merged

[Service Bus] Throw when partitionKey is not same as sessionId #12490

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2e1e61a
[Service Bus] Throw when partitionKey is not same as sessionId
ramya-rao-a Nov 11, 2020
e71dc1a
Update sdk/servicebus/service-bus/src/util/errors.ts
ramya-rao-a Nov 11, 2020
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
33 changes: 15 additions & 18 deletions sdk/servicebus/service-bus/src/sender.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@

import Long from "long";
import { MessageSender } from "./core/messageSender";
import { ServiceBusMessage, isServiceBusMessage } from "./serviceBusMessage";
import { ServiceBusMessage } from "./serviceBusMessage";
import { ConnectionContext } from "./connectionContext";
import {
getSenderClosedErrorMsg,
throwErrorIfConnectionClosed,
throwIfNotValidServiceBusMessage,
throwTypeErrorIfParameterMissing,
throwTypeErrorIfParameterNotLong
} from "./util/errors";
Expand Down Expand Up @@ -190,16 +191,18 @@ export class ServiceBusSenderImpl implements ServiceBusSender {

// link message span contexts
let spanContextsToLink: SpanContext[] = [];
if (isServiceBusMessage(messages)) {
messages = [messages];
}

let batch: ServiceBusMessageBatch;
if (Array.isArray(messages)) {
if (isServiceBusMessageBatch(messages)) {
spanContextsToLink = messages._messageSpanContexts;
batch = messages;
} else {
if (!Array.isArray(messages)) {
ramya-rao-a marked this conversation as resolved.
Show resolved Hide resolved
messages = [messages];
}
batch = await this.createMessageBatch(options);
for (const message of messages) {
if (!isServiceBusMessage(message)) {
throw new TypeError(invalidTypeErrMsg);
}
throwIfNotValidServiceBusMessage(message, invalidTypeErrMsg);
if (!batch.tryAddMessage(message, { parentSpan: getParentSpan(options?.tracingOptions) })) {
// this is too big - throw an error
const error = new MessagingError(
Expand All @@ -209,11 +212,6 @@ export class ServiceBusSenderImpl implements ServiceBusSender {
throw error;
}
}
} else if (isServiceBusMessageBatch(messages)) {
spanContextsToLink = messages._messageSpanContexts;
batch = messages;
} else {
throw new TypeError(invalidTypeErrMsg);
}

const sendSpan = createSendSpan(
Expand Down Expand Up @@ -258,11 +256,10 @@ export class ServiceBusSenderImpl implements ServiceBusSender {
const messagesToSchedule = Array.isArray(messages) ? messages : [messages];

for (const message of messagesToSchedule) {
if (!isServiceBusMessage(message)) {
throw new TypeError(
"Provided value for 'messages' must be of type ServiceBusMessage or an array of type ServiceBusMessage."
);
}
throwIfNotValidServiceBusMessage(
message,
"Provided value for 'messages' must be of type ServiceBusMessage or an array of type ServiceBusMessage."
);
}

const scheduleMessageOperationPromise = async () => {
Expand Down
10 changes: 5 additions & 5 deletions sdk/servicebus/service-bus/src/serviceBusMessageBatch.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,9 @@
import {
ServiceBusMessage,
toRheaMessage,
isServiceBusMessage,
getMessagePropertyTypeMismatchError
} from "./serviceBusMessage";
import { throwTypeErrorIfParameterMissing } from "./util/errors";
import { throwIfNotValidServiceBusMessage, throwTypeErrorIfParameterMissing } from "./util/errors";
import { ConnectionContext } from "./connectionContext";
import {
MessageAnnotations,
Expand Down Expand Up @@ -246,9 +245,10 @@ export class ServiceBusMessageBatchImpl implements ServiceBusMessageBatch {
*/
public tryAddMessage(message: ServiceBusMessage, options: TryAddOptions = {}): boolean {
throwTypeErrorIfParameterMissing(this._context.connectionId, "message", message);
if (!isServiceBusMessage(message)) {
throw new TypeError("Provided value for 'message' must be of type ServiceBusMessage.");
}
throwIfNotValidServiceBusMessage(
message,
"Provided value for 'message' must be of type ServiceBusMessage."
);

// check if the event has already been instrumented
const previouslyInstrumented = Boolean(
Expand Down
26 changes: 25 additions & 1 deletion sdk/servicebus/service-bus/src/util/errors.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
import { logger, receiverLogger } from "../log";
import Long from "long";
import { ConnectionContext } from "../connectionContext";
import { ServiceBusReceivedMessage } from "../serviceBusMessage";
import { isServiceBusMessage, ServiceBusReceivedMessage } from "../serviceBusMessage";
import { ReceiveMode } from "../models";

/**
Expand Down Expand Up @@ -249,3 +249,27 @@ export function throwErrorIfInvalidOperationOnMessage(
throw error;
}
}

/**
* Error message for when the ServiceBusMessage provided by the user has different values
* for partitionKey and sessionId.
* @internal
* @throw
*/
export const PartitionKeySessionIdMismatchError =
"The fields 'partitionKey' and 'sessionId' cannot have different values.";
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changelog

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll add one in a separate PR with the other validation checks I added in previous PRs

/**
* Throws error if given object is not a valid ServiceBusMessage
ramya-rao-a marked this conversation as resolved.
Show resolved Hide resolved
* @internal
* @ignore
* @param msg The object that needs to be validated as a ServiceBusMessage
* @param errorMessageForWrongType The error message to use when given object is not a ServiceBusMessage
*/
export function throwIfNotValidServiceBusMessage(msg: any, errorMessageForWrongType: string): void {
if (!isServiceBusMessage(msg)) {
throw new TypeError(errorMessageForWrongType);
}
if (msg.partitionKey && msg.sessionId && msg.partitionKey !== msg.sessionId) {
throw new TypeError(PartitionKeySessionIdMismatchError);
}
}
36 changes: 33 additions & 3 deletions sdk/servicebus/service-bus/test/internal/sender.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import { ConnectionContext } from "../../src/connectionContext";
import { ServiceBusMessage } from "../../src";
import { isServiceBusMessageBatch, ServiceBusSenderImpl } from "../../src/sender";
import { createConnectionContextForTests } from "./unittestUtils";
import { PartitionKeySessionIdMismatchError } from "../../src/util/errors";

const assert = chai.assert;

Expand All @@ -29,58 +30,87 @@ describe("sender unit tests", () => {
return new ServiceBusMessageBatchImpl(fakeContext, 100);
};

["hello", {}, 123, null, undefined, ["hello"]].forEach((invalidValue) => {
const partitionKeySessionIdMismatchMsg = {
body: "boooo",
sessionId: "my-sessionId",
partitionKey: "my-partitionKey"
};
const badMessages = [
"hello",
{},
123,
null,
undefined,
["hello"],
partitionKeySessionIdMismatchMsg
];

badMessages.forEach((invalidValue) => {
it(`don't allow Sender.sendMessages(${invalidValue})`, async () => {
let expectedErrorMsg =
"Provided value for 'messages' must be of type ServiceBusMessage, ServiceBusMessageBatch or an array of type ServiceBusMessage.";
if (invalidValue === null || invalidValue === undefined) {
expectedErrorMsg = `Missing parameter "messages"`;
}
if (invalidValue === partitionKeySessionIdMismatchMsg) {
expectedErrorMsg = PartitionKeySessionIdMismatchError;
}

try {
await sender.sendMessages(
// @ts-expect-error
invalidValue
);
assert.fail("You should not be seeing this.");
} catch (err) {
assert.equal(err.name, "TypeError");
assert.equal(err.message, expectedErrorMsg);
}
});
});

["hello", {}, null, undefined].forEach((invalidValue) => {
badMessages.forEach((invalidValue) => {
it(`don't allow tryAdd(${invalidValue})`, async () => {
const batch = await sender.createMessageBatch();
let expectedErrorMsg = "Provided value for 'message' must be of type ServiceBusMessage.";
if (invalidValue === null || invalidValue === undefined) {
expectedErrorMsg = `Missing parameter "message"`;
}
if (invalidValue === partitionKeySessionIdMismatchMsg) {
expectedErrorMsg = PartitionKeySessionIdMismatchError;
}

try {
batch.tryAddMessage(
// @ts-expect-error
invalidValue
);
assert.fail("You should not be seeing this.");
} catch (err) {
assert.equal(err.name, "TypeError");
assert.equal(err.message, expectedErrorMsg);
}
});
});

["hello", {}, null, undefined, ["hello"]].forEach((invalidValue) => {
badMessages.forEach((invalidValue) => {
it(`don't allow Sender.scheduleMessages(${invalidValue})`, async () => {
let expectedErrorMsg =
"Provided value for 'messages' must be of type ServiceBusMessage or an array of type ServiceBusMessage.";
if (invalidValue === null || invalidValue === undefined) {
expectedErrorMsg = `Missing parameter "messages"`;
}
if (invalidValue === partitionKeySessionIdMismatchMsg) {
expectedErrorMsg = PartitionKeySessionIdMismatchError;
}

try {
await sender.scheduleMessages(
// @ts-expect-error
invalidValue,
new Date()
);
assert.fail("You should not be seeing this.");
} catch (err) {
assert.equal(err.name, "TypeError");
assert.equal(err.message, expectedErrorMsg);
Expand Down