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-job-router: remove mocha arrow functions from tests in test directory #24865

Conversation

StevanFreeborn
Copy link
Contributor

Packages impacted by this PR

sdk\communication\communication-job-router

Issues associated with this PR

#13005

Describe the problem that is addressed by this PR

The existing mocha tests for the sdk\communication\communication-job-router 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

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)
    • I don't believe this is relevant.
  • Added a changelog (if necessary)
    • I don't believe this is necessary

@ghost ghost added Communication customer-reported Issues that are reported by GitHub users external to the Azure organization. labels Feb 14, 2023
@ghost
Copy link

ghost commented Feb 14, 2023

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

@jeremymeng
Copy link
Member

@StevanFreeborn it seems that an older version of prettier was used. I assume your changes are on top of main branch. Could you please try rush update before running the format npm script again?

@StevanFreeborn
Copy link
Contributor Author

Correct the changes were made in a branch that was made off of the main branch. And most definitely I can try that.

@StevanFreeborn
Copy link
Contributor Author

StevanFreeborn commented Feb 15, 2023

@jeremymeng it looks like that did it! I really appreciate you helping me through this stickiness. Will make me a better contributor going forward when checks fail.

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.

Thanks for the improvement!

@jeremymeng jeremymeng merged commit 5e30602 into Azure:main Feb 21, 2023
@StevanFreeborn StevanFreeborn deleted the fix/comm-job-router-change-mocha-arrow-functions branch February 21, 2023 19:27
jeremymeng pushed a commit that referenced this pull request Mar 13, 2023
### Packages impacted by this PR

`sdk\confidentialledger\confidential-ledger-rest`

### Issues associated with this PR

#13005 

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

The existing mocha tests for the
`sdk\confidentialledger\confidential-ledger-rest` 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
#24865 - Same fix but for the
`sdk\communication\communication-job-router` 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)_
   - **_I don't believe this is relevant._**
- [ ] Added a changelog (if necessary)
  - **_I don't believe this is necessary_**
jeremymeng pushed a commit that referenced this pull request 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
- [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)
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 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