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.

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

fix: communication-sms: remove mocha arrow functions #26659

Conversation

StevanFreeborn
Copy link
Contributor

@StevanFreeborn StevanFreeborn commented Jul 28, 2023

Packages impacted by this PR

sdk\communication\communication-sms

Issues associated with this PR

#13005

Describe the problem that is addressed by this PR

The existing mocha tests for the sdk\communication\communication-sms made use of the arrow syntax for callback functions. Mocha recommends not to do this because you lose access to the mocha context (https://mochajs.org/#arrow-functions).

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?

The reason for utilizing the function keyword instead of an arrow syntax to write the callback functions in these mocha tests is to maintain access to the mocha context.

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

No additional test cases were added in this PR as the change only required modifying existing test cases.

Provide a list of related PRs (if any)

#23761 - Same fix, but for the sdk\search\search-documents package
#23789 - Same fix but for the sdk\attestation\attestation package
#23835 - Same fix but for the sdk\batch\batch package
#23850 - Same fix but for the sdk\cognitivelanguage\ai-language-conversations package
#23881 - Same fix but for the sdk\cognitiveservices\cognitiveservices-luis-authoring package
#24126 - Same fix but for the sdk\cognitiveservices\cognitiveservices-luis-runtime package
#21470 - Same fix but for the sdk\communication\communication-chat package
#24746 - Same fix but for the sdk\communication\communication-common package
#24747 - Same fix but for the sdk\communication\communication-email package
#24797 - Same fix but for the sdk\communication\communication-identity package
#24800 - Same fix but for the sdk\communication\communication-rooms package
#24865 - Same fix but for the sdk\communication\communication-job-router package
#25148 - Same fix but for the sdk\confidentialledger\confidential-ledger-rest package

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

Not applicable

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)

@github-actions github-actions bot added Communication - SMS Community Contribution Community members are working on the issue customer-reported Issues that are reported by GitHub users external to the Azure organization. labels Jul 28, 2023
@github-actions
Copy link

Thank you for your contribution @StevanFreeborn! We will review the pull request and get back to you soon.

Copy link
Member

@jeremymeng jeremymeng left a comment

Choose a reason for hiding this comment

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

@StevanFreeborn thanks a lot for your fix!

@jeremymeng jeremymeng merged commit a32bf42 into Azure:main Jul 28, 2023
@StevanFreeborn StevanFreeborn deleted the stevanfreeborn/fix/comm-sms-remove-mocha-arrow-functions branch July 28, 2023 18:46
dgetu pushed a commit that referenced this pull request Sep 6, 2023
### Packages impacted by this PR

`sdk\communication\communication-sms`

### Issues associated with this PR

#13005 

### Describe the problem that is addressed by this PR

The existing mocha tests for the `sdk\communication\communication-sms`
made use of the arrow syntax for callback functions. Mocha recommends
not to do this because you lose access to the mocha context
(https://mochajs.org/#arrow-functions).

### 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?

The reason for utilizing the function keyword instead of an arrow syntax
to write the callback functions in these mocha tests is to maintain
access to the mocha context.

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

No additional test cases were added in this PR as the change only
required modifying existing test cases.

### Provide a list of related PRs _(if any)_

#23761 - Same fix, but for the `sdk\search\search-documents` package
#23789 - Same fix but for the `sdk\attestation\attestation` package
#23835 - Same fix but for the `sdk\batch\batch` package
#23850 - Same fix but for the
`sdk\cognitivelanguage\ai-language-conversations` package
#23881 - Same fix but for the
`sdk\cognitiveservices\cognitiveservices-luis-authoring` package
#24126 - Same fix but for the
`sdk\cognitiveservices\cognitiveservices-luis-runtime` package
#21470 - Same fix but for the `sdk\communication\communication-chat`
package
#24746 - Same fix but for the `sdk\communication\communication-common`
package
#24747 - Same fix but for the `sdk\communication\communication-email`
package
#24797 - Same fix but for the `sdk\communication\communication-identity`
package
#24800 - Same fix but for the `sdk\communication\communication-rooms`
package
#24865 - Same fix but for the
`sdk\communication\communication-job-router` package
#25148 - Same fix but for the
`sdk\confidentialledger\confidential-ledger-rest` package

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

**_Not applicable_**

### Checklists
- [x] 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](https://github.com/Azure/autorest.typescript)
repository and link it here)_
- [ ] Added a changelog (if necessary)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Communication - SMS Community Contribution Community members are working on the issue customer-reported Issues that are reported by GitHub users external to the Azure organization.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants