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.

Sign up for GitHub

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

[Search] - Update search-documents to the latest core packages #17393

Merged
merged 8 commits into from
Sep 3, 2021
+90 −88
Merged

[Search] - Update search-documents to the latest core packages #17393

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ca92e7f
update version and add changelog
maorleger Aug 31, 2021
80658bd
Update search-document versions
maorleger Sep 1, 2021
55b4749
target ES2017
maorleger Sep 1, 2021
3998d78
update engines section and README
maorleger Sep 1, 2021
527a6c2
use 11.2.1, and make engines rule warn
maorleger Sep 2, 2021
ea6fcdc
revert engines change and eslintrc
maorleger Sep 2, 2021
5265fc3
Remove identity from rush.json
maorleger Sep 2, 2021
c551c80
rush update
maorleger Sep 2, 2021
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
6 changes: 4 additions & 2 deletions common/config/rush/common-versions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@
"@types/node": ["^10.0.0", "^10.12.0"],
// @azure/test-utils-perfstress should depend on lowest version of @azure/core-http for maximum compatibility, allowing test
// projects to choose a higher version if desired.
"@azure/core-http": ["^1.0.0"],
// @azure/container-registry is using the beta version for CAE support
"@azure/core-rest-pipeline": ["1.1.0-beta.3"],
// @azure/event-processor-host is on a much lower major version
Expand All @@ -74,6 +73,9 @@
"@azure/keyvault-secrets": ["^4.1.0", "^4.2.0-beta.4"],
// Issue #14771 tracks updating to these versions
"@microsoft/api-extractor": ["7.13.2"],
"prettier": ["2.2.1"]
"prettier": ["2.2.1"],
// For this hotfix branch we will only update search-documents to latest core-http and core-tracing
"@azure/core-tracing": ["1.0.0-preview.13"],
"@azure/core-http": ["^1.0.0", "^2.1.0"]
}
}
133 changes: 60 additions & 73 deletions common/config/rush/pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 0 additions & 5 deletions rush.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -536,11 +536,6 @@
"projectFolder": "sdk/eventhub/mock-hub",
"versionPolicyName": "utility"
},
{
Copy link
Member Author

Choose a reason for hiding this comment

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

This hotfix has nothing to do with identity, but this codebase does not contain the necessary changes to support node 16 tests and identity will continue to fail here. I don't think backporting it to support tests for a package I am not releasing (and that search-documents doesn't depend on) is the better approach so I will remove it from the rush.json as we've done in other hotfix branches

"packageName": "@azure/identity",
"projectFolder": "sdk/identity/identity",
"versionPolicyName": "client"
},
{
"packageName": "@azure/keyvault-common",
"projectFolder": "sdk/keyvault/keyvault-common",
Expand Down
8 changes: 8 additions & 0 deletions sdk/search/search-documents/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Release History

## 11.2.1 (2021-09-07)

### New Features

- Support for Node.js 8 and IE 11 has been dropped. Please see our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details.
maorleger marked this conversation as resolved.
Show resolved Hide resolved
- Changed TS compilation target to ES2017 to produce smaller bundles and use more native platform features.
- Updated our internal core package dependencies to their latest versions to add support for Opentelemetry 1.0.0, which is compatible with the latest versions of our other client libraries.
Copy link
Contributor

Choose a reason for hiding this comment

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

Wow! Am surprised there are no code changes accompanying this. Is that because search does not have tests for tracing?

Copy link
Member Author

Choose a reason for hiding this comment

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

Most packages do not need code changes at the package level. This is really only an issue because we call Span#context in tracingPolicy which unfortunately is the method they decided to rename...

Copy link
Member Author

Choose a reason for hiding this comment

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

With that said, there is one build that is failing - so maybe code changes will be coming 😄 ...

I still think no code changes will be needed, as the rest of the builds are passing for this hotfix


## 11.2.0 (2021-06-08)

The list of changes in 11.2.0 since 11.1.0 & 11.2.0-beta.2 are provided below:
Expand Down
11 changes: 10 additions & 1 deletion sdk/search/search-documents/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,17 @@ Use the @azure/search-documents client library to:
npm install @azure/search-documents
```

### Currently supported environments

- [LTS versions of Node.js](https://nodejs.org/about/releases/)
- Latest versions of Safari, Chrome, Edge, and Firefox.

See our [support policy](https://github.com/Azure/azure-sdk-for-js/blob/main/SUPPORT.md) for more details.

### Prerequisites
This package supports [Node.js](https://nodejs.org/) version 8.x.x or higher. You need an [Azure subscription][azure_sub] and a [search service][create_search_service_docs] to use this package.

- An [Azure subscription](https://azure.microsoft.com/free/)
- A [Search service][create_search_service_docs]

To create a new search service, you can use the [Azure portal][create_search_service_docs], [Azure PowerShell][create_search_service_ps], or the [Azure CLI][create_search_service_cli]. Here's an example using the Azure CLI to create a free instance for getting started:

Expand Down
6 changes: 3 additions & 3 deletions sdk/search/search-documents/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@azure/search-documents",
"version": "11.2.0",
"version": "11.2.1",
"description": "Azure client library to use Cognitive Search for node.js and browser.",
"sdk-type": "client",
"main": "dist/index.js",
Expand Down Expand Up @@ -76,9 +76,9 @@
"sideEffects": false,
"dependencies": {
"@azure/core-auth": "^1.3.0",
"@azure/core-http": "^1.2.0",
"@azure/core-http": "^2.1.0",
"@azure/core-paging": "^1.1.1",
"@azure/core-tracing": "1.0.0-preview.11",
"@azure/core-tracing": "1.0.0-preview.13",
"@azure/logger": "^1.0.0",
"tslib": "^2.0.0",
"events": "^3.0.0"
Expand Down
2 changes: 1 addition & 1 deletion sdk/search/search-documents/src/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.

export const SDK_VERSION: string = "11.2.0";
export const SDK_VERSION: string = "11.2.1";
2 changes: 1 addition & 1 deletion sdk/search/search-documents/src/generated/data/searchClientContext.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import * as coreHttp from "@azure/core-http";
import { ApiVersion20200630, SearchClientOptionalParams } from "./models";

const packageName = "@azure/search-documents";
const packageVersion = "11.2.0";
const packageVersion = "11.2.1";

/** @internal */
export class SearchClientContext extends coreHttp.ServiceClient {
Expand Down
2 changes: 1 addition & 1 deletion sdk/search/search-documents/src/generated/service/searchServiceClientContext.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import {
} from "./models";

const packageName = "@azure/search-documents";
const packageVersion = "11.2.0";
const packageVersion = "11.2.1";

/** @internal */
export class SearchServiceClientContext extends coreHttp.ServiceClient {
Expand Down
3 changes: 2 additions & 1 deletion sdk/search/search-documents/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
"extends": "../../../tsconfig.package",
"compilerOptions": {
"outDir": "./dist-esm",
"declarationDir": "./types"
"declarationDir": "./types",
"target": "ES2017"
},
"exclude": ["node_modules", "types", "temp", "browser", "dist", "dist-esm", "./samples/**/*.ts"]
}