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

February release highlights for JavaScript & TypeScript #2333

Merged
20 commits merged into from
Feb 13, 2021
Merged
Show file tree
Hide file tree
Changes from 14 commits
Commits
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
7 changes: 4 additions & 3 deletions releases/2021-02/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,10 @@ You can find links to packages, code, and docs on our [Azure SDK Releases page](

## Release Highlights

*
*
*
* Azure Search Documents is releasing a new GA.
sadasant marked this conversation as resolved.
Show resolved Hide resolved
* Adds support for indexing search documents with intelligent batching, automatic flushing, and retries for failed indexing actions.
* Azure Event Hubs is releasing a new GA.
* You can now specify custom endpoint address as a client constructor option to use when communicating with the Event Hubs service, which is useful when your network does not allow communicating to the standard Event Hubs endpoint.

## Release Notes

Expand Down
190 changes: 181 additions & 9 deletions releases/2021-02/js.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,30 +6,53 @@ sidebar: releases_sidebar
repository: azure/azure-sdk-for-js
---

<!--
[pattern]: # (${PackageName}:${PackageVersion})
-->

The Azure SDK team is pleased to make available the February 2021 client library release.

#### GA

[pattern.ga]: # (- ${PackageFriendlyName})
- Azure Search Documents
- Azure Event Hubs

#### Updates

[pattern.patch]: # (- ${PackageFriendlyName})
- Azure Storage Blob
ramya-rao-a marked this conversation as resolved.
Show resolved Hide resolved
- Azure Storage Queue
- Azure File Datalake
- Azure File Share
sadasant marked this conversation as resolved.
Show resolved Hide resolved
- Azure Identity

#### Beta

[pattern.beta]: # (- ${PackageFriendlyName})
- Azure Text Analytics
- Azure Metrics Advisor
- Azure Form Recognizer
- Azure Identity
- Azure Key Vault Keys
- Azure Key Vault Admin
- Azure Storage Blob
sadasant marked this conversation as resolved.
Show resolved Hide resolved
- Azure File Datalake
- Azure Event Grid
sadasant marked this conversation as resolved.
Show resolved Hide resolved

## Installation Instructions

To install the packages, copy and paste the below into a terminal.

```bash

$> npm install @azure/search-documents
$> npm install @azure/event-hubs
$> npm install @azure/storage-blob
$> npm install @azure/storage-file-datalake
$> npm install @azure/storage-file-share
$> npm install @azure/storage-queue
$> npm install @azure/ai-text-analytics@next
$> npm install @azure/ai-metrics-advisor@next
$> npm install @azure/ai-form-recognizer@next
$> npm install @azure/identity@next
$> npm install @azure/keyvault-keys@next
$> npm install @azure/keyvault-admin@next
$> npm install @azure/storage-blob@next
sadasant marked this conversation as resolved.
Show resolved Hide resolved
$> npm install @azure/storage-file-datalake@next
$> npm install @azure/eventgrid@next
sadasant marked this conversation as resolved.
Show resolved Hide resolved
```

[pattern]: # ($> npm install ${PackageName}@${PackageVersion})
Expand All @@ -40,7 +63,156 @@ If you have a bug or feature request for one of the libraries, please post an is

## Release highlights

sadasant marked this conversation as resolved.
Show resolved Hide resolved
[pattern]: # (### ${PackageFriendlyName} ${PackageVersion} [Changelog]${ChangelogUrl}`n${HighlightsBody}`n)
### Azure Event Hubs

We're releasing a new GA for the Azure Event Hubs client with new features and a major fix.

#### @azure/event-hubs [Changelog](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/eventhub/event-hubs/CHANGELOG.md#540-2021-02-09)

##### New Features in @azure/[email protected]

- You can now specify custom endpoint address as a client constructor option to use when communicating with the Event Hubs service, which is useful when your network does not allow communicating to the standard Event Hubs endpoint.
- Added a helper method `parseEventHubConnectionString` that can be used to validate and parse a given connection string for Azure Event Hubs.

##### Major Fixes in @azure/[email protected]

- Fixes an issue where the `RetryMode` enum for use when setting the RetryOptions.mode field in `EventHubConsumerClientOptions` or `EventHubClientOptions` wasn't exported by the package.
sadasant marked this conversation as resolved.
Show resolved Hide resolved

### Azure Identity

Identity is releasing a patch with a dependency fix and a bug fix, and a beta that includes MSAL 2.0 with PKCE support.

#### @azure/identity [Changelog](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/CHANGELOG.md)

##### Major Fixes in @azure/[email protected] ([Changelog](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/identity/identity/CHANGELOG.md#123-2021-02-09))

- Fixed Azure Stack support for the NodeJS version of the `InteractiveBrowserCredential`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we talk about what the problem before was? If I am an Azure Stack user, I wouldnt know whether this line would apply to me or not

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thoughts on this?

Fixed a bug that appeared while using InteractiveBrowserCredential to authenticate against Azure Stack from NodeJS (for local apps that would ask for authentication using a browser window). Azure Stack has specific authentication requirements that were missed on our previous InteractiveBrowserCredential release.

- The 'keytar' dependency has been updated to the latest version.
Copy link
Contributor

Choose a reason for hiding this comment

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

A dependency update is not a release highlight unless it solved a major problem for the customer. I recall the user did have some trouble which required us to do this update. Mentioning that here would help

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is the original issue: Azure/azure-sdk-for-js#13531

That issue is still open and the real solution is not trivial. This update helps but it's very minor. I'll remove the highlight entry.


##### Changes in @azure/[email protected]

- In this beta we've updated `InteractiveBrowserCredential` to use the Auth Code Flow with PKCE rather than Implicit Grant Flow by default in the browser, to better support browsers with enhanced security restrictions.
sadasant marked this conversation as resolved.
Show resolved Hide resolved

sadasant marked this conversation as resolved.
Show resolved Hide resolved
### Azure Key Vault

sadasant marked this conversation as resolved.
Show resolved Hide resolved
We're releasing some beta updates for the clients of the Key Vault service with small updates and breaking changes only from the last beta updates released.

#### @azure/keyvault-admin [Changelog](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-admin/CHANGELOG.md#400-beta2-2021-02-09)

##### Changes on @azure/[email protected]

- Backup and restore operations will now return a `BackupResult` and `RestoreResult` as appropriate.
Copy link
Contributor

Choose a reason for hiding this comment

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

What was it returning before? Does the user have to change their code? If this is not a breaking change or highly impacting, perhaps we can skip mentioning it?

The points under Major Fixes on @azure/[email protected] do not seem to be developer impacting changes either. They do not need to react to these changes. I would recommend removing both the Major Fixes and this current section here and have say just this line

The beta releases has bug fixes to improve quality and support for custom role definitions.

See What is a developer impacting change?

cc @maorleger

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's a breaking change, but from one beta to another, since this client hasn't been GAd.

BackupResult and RestoreResult from backup/restore long running operations now contain additional information about the operation, we can say that 🤔


##### New Features on @azure/[email protected]

- In this beta release we added support for custom role definitions which includes creating, updating, and deleting custom role definitions.

##### Major Fixes on @azure/[email protected]

- The logging of HTTP requests wasn't properly working - now it has been fixed and tests have been written that verify the fix.
- Backup / Restore polling will now correctly propagate any errors to the awaited call.

#### @azure/keyvault-keys [Changelog](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/keyvault/keyvault-keys/CHANGELOG.md#420-beta3-2021-02-09)

##### New Features on @azure/[email protected]

- A new `createOctKey` method to support easily creating oct / oct-HSM keys.
- `CryptographyClient` can now support "local only" mode by instantiating it with only a `JsonWebKey`, a new constructor overload was added to support this.
- Users can now get the `keyId` property from a `CryptographyClient`.

### Azure Text Analytics

We're releasing a new beta for the Text Analytics service including new features and some renamed properties and methods.

#### @azure/ai-text-analytics [Changelog](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/textanalytics/ai-text-analytics/CHANGELOG.md#510-beta4-2021-02-10)

##### New Features in @azure/[email protected]

- A new option to control how the offset is calculated by the service. For more information, see [the Text Analytics documentation](https://docs.microsoft.com/azure/cognitive-services/text-analytics/concepts/text-offsets#offsets-in-api-version-31-preview).

##### Breaking Changes on @azure/[email protected]

- The healthcare entities returned by `beginAnalyzeHealthcareEntities` are now organized as a directed graph where the edges represent a certain type of healthcare relationship between the source and target entities. Edges are stored in the `relatedEntities` property.

### Azure Metrics Advisor

- We are releasing a new preview version for metrics advisor with AAD support feature
sadasant marked this conversation as resolved.
Show resolved Hide resolved

#### @azure/ai-metrics-advisor [Changelog](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/metricsadvisor/ai-metrics-advisor/CHANGELOG.md#100-beta3-2021-02-09)

##### New Features in @azure/[email protected]@beta.3

- Metrics Advisor is releasing support for Azure Active Directory Authentication and support to rotate the API and Subscription Keys.
sadasant marked this conversation as resolved.
Show resolved Hide resolved
sadasant marked this conversation as resolved.
Show resolved Hide resolved

##### Breaking Changes in @azure/[email protected]@beta.3

- Renamed a method `listDimensionValuesForDetectionConfig()` to `listAnomalyDimensionValues()`.
- Changed the response types for update methods.
- Added mapping of metric id to metric name in Datafeed object.

### Azure Form Recognizer

We're releasing a new beta client for the Azure Form Recognizer service with an upgrade for one TypeScript type.

#### @azure/ai-form-recognizer [Changelog](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/formrecognizer/ai-form-recognizer/CHANGELOG.md#310-beta2-2021-02-09)

##### Breaking Changes in @azure/[email protected]

- Reworked the type of the `appearance` field and its children of the `FormLine` type to have more specific names.

### Azure Storage

We released hot fix versions and also beta versions for new service features in Azure Storage Service API version 2020-06-10.

#### @azure/storage-blob [Changelog](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-blob/CHANGELOG.md)

##### Major Fixes in @azure/[email protected] ([Changelog](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-blob/CHANGELOG.md#1241-2021-02-03))
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need the changelog link at this level? Wouldnt the changelog link a few lines above suffice?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We generally point to the exact version in the changelog above. In this case we have two, so I thought on separating them.


- Fixed a compile failure due to "Can't resolve 'crypto'" in Angular. [Issue #13267](https://github.com/Azure/azure-sdk-for-js/issues/13267).
- Fixed an issue that the download stream returned by `BlobClient.download` won't release underlying resources unless it's fully consumed. [Issue #11850](https://github.com/Azure/azure-sdk-for-js/issues/11850).
sadasant marked this conversation as resolved.
Show resolved Hide resolved

##### New Features in @azure/[email protected] ([Changelog](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-blob/CHANGELOG.md#1250-beta1-2021-02-09))

- Now support Batch operations scoped to the Container level. You can use `ContainerClient.getBlobBatchClient()` to get such a `BlobBatchClient`.

#### @azure/storage-file-datalake [Changelog](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-file-datalake/CHANGELOG.md)

##### Major Fixes in @azure/[email protected] ([Changelog](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-file-datalake/CHANGELOG.md#1231-2021-02-03))

- Fixed a compile failure due to "Can't resolve 'crypto'" in Angular. [Issue #13267](https://github.com/Azure/azure-sdk-for-js/issues/13267).
sadasant marked this conversation as resolved.
Show resolved Hide resolved

##### New Features in @azure/[email protected] ([Changelog](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-file-datalake/CHANGELOG.md#1240-beta1-2021-02-09))

- Added support for Container Soft Delete. You can restore a deleted filesystem via `DataLakeServiceClient.undeleteFileSystem()`. And the `DataLakeServiceClient.listFileSystems()` now support an `includeDeleted` option to include soft deleted filesystems in the response.

#### storage-file-share [Changelog](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-file-share/CHANGELOG.md#1241-2021-02-03)

##### @azure/[email protected]

This release contains bug fixes to improve quality.

#### storage-queue [Changelog](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/storage/storage-queue/CHANGELOG.md#1231-2021-02-03)

##### @azure/[email protected]

This release contains bug fixes to improve quality.
sadasant marked this conversation as resolved.
Show resolved Hide resolved

### Azure Event Grid

We released a new beta package for the Event Grid service.

#### @azure/eventgrid [Changelog](https://github.com/Azure/azure-sdk-for-js/blob/master/sdk/eventgrid/eventgrid/CHANGELOG.md#300-beta3-2020-10-06)

##### Breaking changes in @azure/[email protected]

- The type definitions for SMS events sent by Azure Communication Services have been renamed, to use the prefix "AcsSms" instead of "Acssms". If you are using TypeScript and explicitly referencing these interfaces, you will need to update your code to use the new names. The payload of the events is unchanged.
- `EventGridSharedAccessCredential` has been removed, in favor of `AzureSASCredential`. Code which is using `EventGridSharedAccessCredential` should now use `AzureSASCredential` instead.
- When constructing the client, you must now include the schema type your topic is configured to expect (one of "EventGrid", "CloudEvent" or "Custom").
- The `sendEvents` methods have been collapsed into a single method on the client called `send` which uses the input schema that was configured on the client.

##### New Features in @azure/[email protected]

- Added distributed tracing support. EventGridProducerClient will now create spans when sending events to Event Grid.
sadasant marked this conversation as resolved.
Show resolved Hide resolved
sadasant marked this conversation as resolved.
Show resolved Hide resolved

sadasant marked this conversation as resolved.
Show resolved Hide resolved
sadasant marked this conversation as resolved.
Show resolved Hide resolved
## Latest Releases
sadasant marked this conversation as resolved.
Show resolved Hide resolved

Expand Down