[Event Hubs] remove createFromIotHubConnectionString method #5311

chradek · 2019-09-30T21:16:01Z

This change removes the EventHubClient.createFromIotHubConnectionString method. Instead, an event-hubs compatible connection string can be used directly when instantiating an EventHubClient.

richardpark-msft · 2019-10-01T19:56:46Z

sdk/eventhub/event-hubs/README.md


 ```javascript
-const client = await EventHubClient.createFromIotHubConnectionString("connectionString");
+const client = new EventHubClient("connectionStringWithEntityPath");


You have an example of the connection string format above - maybe just paste it in here? The eye gets drawn to the sample more than the description of the sample.

richardpark-msft · 2019-10-01T19:58:03Z

sdk/eventhub/event-hubs/changelog.md

+
+- Removed the `createFromIotHubConnectionString` method from `EventHubClient`. ([PR #5311](https://github.com/Azure/azure-sdk-for-js/pull/5311)).
+  Instead, pass an Event Hubs-compatible connection string when instantiating an `EventHubClient` to read properties or events
+  from an IoT Hub.


Might be useful here to show what the 'old' vs 'new' code difference is in a little snippet.

This one is pretty simple though.

richardpark-msft · 2019-10-01T20:04:35Z

sdk/eventhub/event-hubs/README.md

 await client.getProperties();
 await client.getPartitionProperties("partitionId");
 ```

-**Notes:** For scalable and efficient receiving, please take a look at [azure-event-processor-host](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/eventhub/event-processor-host). The Event Processor host, internally uses the streaming receiver to receive events.
+**Notes:** For scalable and efficient receiving, please take a look at [EventProcessor](https://azure.github.io/azure-sdk-for-js/event-hubs/classes/eventprocessor.html). The EventProcessor, internally uses the batched receiver to receive events.


Just curious - what makes this more scalable/efficient? I looked at the linked doc and it doesn't mention it.

A better link would be https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-event-processor-host once the content there has been updated to be language agnostic

Are you recommending that I wait to change the link until after the docs there have been updated? Right now those docs are specific to EPH, which we've updated significantly as EventProcessor.

I recommend we wait until the docs there have been updated. Maybe log an issue so that we dont forget?

Logged #5355 to track this work.

ramya-rao-a · 2019-10-01T23:23:56Z

sdk/eventhub/event-hubs/README.md

@@ -276,15 +276,21 @@ To control the number of events passed to processEvents, use the options argumen
 You can use `EventHubClient` to work with IotHub as well. This is useful for receiving telemetry data of IotHub from the linked EventHub.
 Most likely the associated connection string will not have send claims. Hence getting HubRuntimeInfo or PartitionRuntimeInfo and receiving events would be the possible operations.


Hence getting HubRuntimeInfo or PartitionRuntimeInfo and receiving events would be the possible operations.

Should we flip this and say that "send operations are not possible"?

ramya-rao-a · 2019-10-01T23:25:27Z

sdk/eventhub/event-hubs/README.md

@@ -276,15 +276,21 @@ To control the number of events passed to processEvents, use the options argumen
 You can use `EventHubClient` to work with IotHub as well. This is useful for receiving telemetry data of IotHub from the linked EventHub.
 Most likely the associated connection string will not have send claims. Hence getting HubRuntimeInfo or PartitionRuntimeInfo and receiving events would be the possible operations.

- Please notice that we are awaiting on the [createFromIotHubConnectionString](https://azure.github.io/azure-sdk-for-js/event-hubs/classes/eventhubclient.html#createfromiothubconnectionstring) method to get an instance of the EventHubClient. This is different from other static methods on the client. The method talks to the IotHub endpoint to get a redirect error which contains the EventHub endpoint to talk to. It then constructs the right EventHub connection string based on the information in the redirect error and returns an instance of the EventHubClient that you can play with.
+- Please notice that the connection string needs to contain the `Endpoint` key-value pair
+  in addition to the `SharedAccessKeyName` and `SharedAccessKey` key-value pairs.


Should we instead talk directly about the "Built in endpoints" or "event hub compatible endpoints" instead?
If they have the iot hub specific endpoint, and they read this line, we are telling them that it wont work, but we are not telling them how to fix the issue and move ahead

ramya-rao-a · 2019-10-01T23:28:59Z

sdk/eventhub/event-hubs/README.md

- Please notice that we are awaiting on the [createFromIotHubConnectionString](https://azure.github.io/azure-sdk-for-js/event-hubs/classes/eventhubclient.html#createfromiothubconnectionstring) method to get an instance of the EventHubClient. This is different from other static methods on the client. The method talks to the IotHub endpoint to get a redirect error which contains the EventHub endpoint to talk to. It then constructs the right EventHub connection string based on the information in the redirect error and returns an instance of the EventHubClient that you can play with.
+- Please notice that the connection string needs to contain the `Endpoint` key-value pair
+  in addition to the `SharedAccessKeyName` and `SharedAccessKey` key-value pairs.
+  It can optionally include the name of the IoT Hub as the `EntityPath` value, or the name can be passed separately to the


The value used from the portal has the EntityPath set in it.
There is no other way that the user can get the event hub compatible connection string.
Is there any value talking about EntityPath being optional?

Now I know how to get the event-hubs compatibile connection string through the portal! When I was getting it through an ARM template, I had to add EntityPath manually and through testing found it wasn't required if you specify it in the constructor instead.

ramya-rao-a · 2019-10-01T23:31:28Z

sdk/eventhub/event-hubs/README.md

 await client.getProperties();
 await client.getPartitionProperties("partitionId");
 ```

-**Notes:** For scalable and efficient receiving, please take a look at [azure-event-processor-host](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/eventhub/event-processor-host). The Event Processor host, internally uses the streaming receiver to receive events.
+**Notes:** For scalable and efficient receiving, please take a look at [EventProcessor](https://azure.github.io/azure-sdk-for-js/event-hubs/classes/eventprocessor.html). The EventProcessor, internally uses the batched receiver to receive events.


A better link would be https://docs.microsoft.com/en-us/azure/event-hubs/event-hubs-event-processor-host once the content there has been updated to be language agnostic

sdk/eventhub/event-hubs/samples/useWithIotHub.ts

ramya-rao-a · 2019-10-01T23:35:04Z

sdk/eventhub/event-hubs/test/iothub.spec.ts

@@ -12,7 +12,9 @@ import { EnvVarKeys, getEnvVars } from "./utils/testUtils";
 const env = getEnvVars();

 describe("EventHub Client with iothub connection string ", function(): void {
-  const service = { connectionString: env[EnvVarKeys.IOTHUB_CONNECTION_STRING] };
+  const service = {
+    connectionString: (env[EnvVarKeys.IOTHUB_CONNECTION_STRING] as string) || ""


Have we run the tests in CI?
I wonder if this env value is using the event hub compatible connection string or not

No, only locally. I need to find out how to actually change it for the CI system :)

ramya-rao-a · 2019-10-02T20:50:45Z

sdk/eventhub/event-hubs/README.md

-const client = await EventHubClient.createFromIotHubConnectionString("connectionString");
+const client = new EventHubClient(
+  "Endpoint=sb://my-iothub-namespace-[uid].servicebus.windows.net/;SharedAccessKeyName=my-SA-name;SharedAccessKey=my-SA-key;EntityPath=my-iot-hub-name"
+);
 await client.getProperties();
 await client.getPartitionProperties("partitionId");


"partitionId" as a string wont work here. This sample needs updating...

Co-Authored-By: Ramya Rao <[email protected]>

chradek · 2019-10-02T21:24:40Z

/azp run js - eventhubs-client - tests

azure-pipelines · 2019-10-02T21:24:50Z

Azure Pipelines successfully started running 1 pipeline(s).

chradek · 2019-10-02T21:38:36Z

/azp run js - eventhubs-client - tests

azure-pipelines · 2019-10-02T21:38:46Z

Azure Pipelines successfully started running 1 pipeline(s).

chradek added Client This issue points to a problem in the data-plane of the library. Event Hubs labels Sep 30, 2019

chradek requested review from ramya-rao-a and ShivangiReja as code owners September 30, 2019 21:16

richardpark-msft reviewed Oct 1, 2019

View reviewed changes

ramya-rao-a suggested changes Oct 1, 2019

View reviewed changes

ramya-rao-a reviewed Oct 2, 2019

View reviewed changes

chradek and others added 4 commits October 2, 2019 14:19

[Event Hubs] remove createFromIotHubConnectionString

95feea7

Update changelog

ba0d4bc

Update sdk/eventhub/event-hubs/samples/useWithIotHub.ts

9ac85bf

Co-Authored-By: Ramya Rao <[email protected]>

update iot-hub docs

db3cb41

chradek force-pushed the event-hubs-iot branch from 27a6989 to db3cb41 Compare October 2, 2019 21:20

ramya-rao-a approved these changes Oct 2, 2019

View reviewed changes

update readme

d1368b9

adds iothub tests as runnable in browser

ac46879

chradek merged commit 3888736 into Azure:master Oct 2, 2019

chradek deleted the event-hubs-iot branch October 2, 2019 22:12

tkoster mentioned this pull request Mar 5, 2020

Discuss Azure Event Hub SDK 5.0 noopkat/electric-io#196

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Event Hubs] remove createFromIotHubConnectionString method #5311

[Event Hubs] remove createFromIotHubConnectionString method #5311

chradek commented Sep 30, 2019 •

edited

Loading

richardpark-msft Oct 1, 2019

richardpark-msft Oct 1, 2019

richardpark-msft Oct 1, 2019

ramya-rao-a Oct 1, 2019

chradek Oct 2, 2019

ramya-rao-a Oct 2, 2019

chradek Oct 2, 2019

ramya-rao-a Oct 1, 2019

ramya-rao-a Oct 1, 2019

ramya-rao-a Oct 1, 2019

chradek Oct 2, 2019

ramya-rao-a Oct 1, 2019

ramya-rao-a Oct 1, 2019

chradek Oct 2, 2019

ramya-rao-a Oct 2, 2019

chradek Oct 2, 2019

chradek commented Oct 2, 2019

azure-pipelines bot commented Oct 2, 2019

chradek commented Oct 2, 2019

azure-pipelines bot commented Oct 2, 2019

		@@ -276,15 +276,21 @@ To control the number of events passed to processEvents, use the options argumen
		You can use `EventHubClient` to work with IotHub as well. This is useful for receiving telemetry data of IotHub from the linked EventHub.
		Most likely the associated connection string will not have send claims. Hence getting HubRuntimeInfo or PartitionRuntimeInfo and receiving events would be the possible operations.

[Event Hubs] remove createFromIotHubConnectionString method #5311

[Event Hubs] remove createFromIotHubConnectionString method #5311

Conversation

chradek commented Sep 30, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chradek commented Oct 2, 2019

azure-pipelines bot commented Oct 2, 2019

chradek commented Oct 2, 2019

azure-pipelines bot commented Oct 2, 2019

chradek commented Sep 30, 2019 •

edited

Loading