Updating Service-Bus dependency long from 4 to 5.2

[mpodwysocki]

Packages impacted by this PR

• service-bus

Issues associated with this PR

• Dependency package long has a new version available #19225

Describe the problem that is addressed by this PR

This updates the long npm package from 4.0 to 5.2.

What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen?

This PR is to update the long dependency and fix any compilation errors which were found. In this case, two spec files needed an explicit import of the long module.

import Long from "long";

Are there test cases added in this PR? (If not, why?)

Not applicable as this is an update to existing spec files for a dependency.

Provide a list of related PRs (if any)

Command used to generate this PR:**(Applicable only to SDK release request PRs)

Checklists

• Added impacted package name to the issue description
• Does this PR needs any fixes in the SDK Generator?** (If so, create an Issue in the Autorest/typescript repository and link it here)
• Added a changelog (if necessary)

[witemple-msft]

LGTM.

[azure-sdk]

API change check for @azure/service-bus

API changes are not detected in this pull request for @azure/service-bus

[jeremymeng]

Looks good. Thanks for the upgrade!

[HarshaNalluru]

Can you please resolve the conflicts and merge this, Matt?

[abouroubi]

There is an issue with the latest version of long, and it made the service-bus SDK unusable...

dcodeIO/long.js#109

[jeremymeng]

@abouroubi have you tried with allowSyntheticDefaultImports: true in tsconfig.json? I just tried in a simple project out of

npm init -y
tsc --init
npm i long @azure/service-bus

and found that import Long from "long"; works as expected.

[abouroubi]

Hello @jeremymeng,
I do have the allowSyntheticDefaultImports: true.
The issue is when I try to use Long.fromString(messageId)to send it to the function cancelScheduledMessages, I'm faced with the error:

TypeError: Cannot read properties of undefined (reading 'fromString')

Here is my code:

import {
  ProcessErrorArgs,
  ServiceBusClient,
  ServiceBusMessage,
  ServiceBusReceivedMessage,
  ServiceBusReceiver,
  ServiceBusSender,
} from '@azure/service-bus';
import Long from 'long';
import { ConfigurationService } from '~shared/configuration/configuration.service';


export class QueueService {

  private sbClient: ServiceBusClient;
  private sender: ServiceBusSender;
  private receiver: ServiceBusReceiver;

  constructor(appConfig: ConfigurationService) {
    this.sbClient = new ServiceBusClient(appConfig.ServiceBus.ConnectionString);
    this.sender = this.sbClient.createSender(appConfig.ServiceBus.QueueName);
    this.receiver = this.sbClient.createReceiver(appConfig.ServiceBus.QueueName);
  }

  async sendMessage(body: any, scheduledEnqueueTimeUtc: Date): Promise<string> {
    const message: ServiceBusMessage = {
      body: body,
    };
    const results = await this.sender.scheduleMessages(message, scheduledEnqueueTimeUtc);

    return results[0].toString();
  }

  async cancelMessage(messageId: string) {
    this.sender.cancelScheduledMessages(Long.fromString(messageId));
  }

  async receiveMessages(
    processMessage: (message: { id: string; content: string }) => Promise<void>,
    processError: () => Promise<void>,
  ) {
    const process = async (brokeredMessage: ServiceBusReceivedMessage) => {
      await processMessage(brokeredMessage.body);
      await this.receiver.completeMessage(brokeredMessage);
    };
    const error = async (args: ProcessErrorArgs) => {
      await processError();
    };

    this.receiver.subscribe(
      {
        processMessage: process,
        processError: error,
      },
      {
        autoCompleteMessages: false,
      },
    );
  }
}

[jeremymeng]

@abouroubi Thanks for sharing the code! Please help me understand more since I don't see where the messageId is coming from. Were you converting the results of scheduleMessages() to string and later trying to convert it back using Long.fromString()?

[abouroubi]

Yes the messageId is saved into the database, and retrieved as a string that's why I need to convert it back.
It was working well when long package was on version 4.0.0.

[jeremymeng]

@abouroubi I tried your code with slight modification to get secret from environment variables. I get an id from sendMessage and then cancel it. It still worked for me.

  const service = new QueueService();
  const d = new Date();
  const id = await service.sendMessage("hello-" + d.toUTCString(), new Date(d.getTime() + 60 * 1000));
  console.log("Immediately canceling the message ", id);
  await service.cancelMessage(id);

also this merged PR is probably not the best place to continue discussion. Could you please open a new issue and share your minimum repro project? Thank you very much!