[Maps] Onboarding `maps-common` & `maps-search` package #23039

andykao1213 · 2022-08-30T05:28:56Z

Packages impacted by this PR

maps-search

Issues associated with this PR

NA

Describe the problem that is addressed by this PR

Introduce the maps-search SDK for the Azure Map Search Service

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?

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

Yes

Provide a list of related PRs (if any)

[Maps] Search, Route, Render test #22566 : The previous PR contains search, route, and render. We decided to separate to three for easier review.

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)

andykao1213 · 2022-08-30T05:31:00Z

Here is the API view created previously: https://apiview.dev/Assemblies/Review/737c63ff29ea4eb8ad335ddabb4c382f

check-enforcer · 2022-08-30T05:47:30Z

This pull request is protected by Check Enforcer.

What is Check Enforcer?

Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass.

Why am I getting this message?

You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged.

What should I do now?

If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows:
/check-enforcer evaluate
Typically evaulation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

What if I am onboarding a new service?

Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment:
/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run js - [service] - ci

sdk/maps/ci.yml

sdk/maps/maps-common/CHANGELOG.md

sdk/maps/maps-search/CHANGELOG.md

sdk/maps/maps-search/README.md

sdk/maps/maps-search/samples/v1-beta/typescript/src/search.ts

azure-sdk · 2022-09-05T08:57:44Z

API change check

APIView has identified API level changes in this PR and created following API reviews.

azure-maps-search
azure-maps-common

jeremymeng

API surface looks good. @joheredi please take another look.

joheredi · 2022-09-26T19:56:29Z

sdk/maps/maps-search/src/mapsSearchClient.ts

+  BatchPollerProxy,
+  createAzureMapsKeyCredentialPolicy,
+  createMapsClientIdPolicy,
+} from "../../maps-common/src";


Shouldn't this be imported from @azure/maps-common?

We recommend publishing @azure/maps-common. Using a local reference has brought us more problems than it is worth. If we publish the common package any major changes to it can be versioned which is a big advantage.

@timovv - fyi as he's familiar with the problems we've faced with sharing code this way.

I see. I agree that the versioned package should bring benefits to us. Let me change this.

@timovv If you don't mind, could you share your experience of the problem you've encountered? 🤔

@joheredi Now the @azure/maps-common has been changed to a published package, please take a look. Thank you.

The main issue with a local reference is that making a breaking change to the local code means you must immediately change all the packages that depended on it. We had to do this with the Key Vault SDK a few months back, and it resulted in a giant PR which was very difficult to review. We ran into a couple of issues that we had to hotfix as a result of that which would have most likely been caught otherwise. Publishing means you can roll out those changes incrementally across your packages, which is a lot safer!

@timovv Understood. Thanks for the detailed explanation 👍🏼

joheredi · 2022-09-27T18:06:02Z

sdk/maps/maps-common/review/maps-common.api.md

+
+// @public
+export interface GeoJsonFeature extends GeoJsonObject {
+    // (undocumented)


make sure to document all these undocumented properties

I've added the reference and summary from the GeoJSON spec to the related interface, and I believe the information should be enough. The rest of the undocumented properties is considered unnecessary from our side.

For the BatchPollerProxy, since it's for internal so I leave it undocumented. Please refer to the commit: fd7722f

joheredi · 2022-09-27T18:06:49Z

sdk/maps/maps-common/review/maps-common.api.md

+    // (undocumented)
+    properties?: Record<string, any>;
+    // (undocumented)
+    type: "Feature";


would it be possible to name these properties kind instead of type? It is more commonly used as a discriminator in our libraries

This is the GeoJSON spec, so I think it would be better to keep the convention

joheredi · 2022-09-27T18:10:12Z

sdk/maps/maps-search/review/maps-search.api.md

+export class MapsSearchClient {
+    constructor(credential: AzureKeyCredential, options?: MapsSearchClientOptions);
+    constructor(credential: TokenCredential, mapsAccountClientId: string, options?: MapsSearchClientOptions);
+    beginFuzzySearchBatch(requests: FuzzySearchRequest[], options?: FuzzySearchBatchOptions): Promise<BatchPoller<BatchResult<SearchAddressResult>>>;


I wonder if we should call these queries instead of requests. @jeremymeng what do you think?

That seems to be consistent with the non-batch functions

But the requests is in the array-type of FuzzySearchRequest, which contains not only SearchQuery but also another property options. Would it be better to keep it requests to avoid confusion?

joheredi

Thanks for addressing the suggestions @andykao1213! I think this is looking pretty good, I'd like @deyaaeldeen to take a look a the LRO implementation as there is a new API that we may be able to leverage here. Other than that I left a few small comments but the API is looking really good.

deyaaeldeen · 2022-09-28T00:04:01Z

sdk/maps/maps-common/src/models/pollers.ts

+  implements BatchPoller<TBatchResult>
+{
+  constructor(
+    private internalPoller: PollerLike<


Does your LROs support cancellation?

The internalPoller only accepts the generated poller (e.g. beginFuzzySearchBatch), which is a wrapper of LroEngine. But I see that the LroEngine.cancelOperation is deprecated. So should I remove this?

@deyaaeldeen per the previous discussion, since map-search's lro doesn't support cancelation, I've hidden it in the commit 1de07d2.
I will open another PR before GA to replace the generated lro with createHttpPoller as you suggest.

- Remove the unnecessary rule setting of eslint - Update the legacy type path

Remove this because maps-search's lro doesn't support cancelation. For future lro that support cancelation, we should use the `createHttpPoller` like the one in the [ai-language-text](https://github.com/Azure/azure-sdk-for-js/blob/cb198d21c4f377e9d2d57744523b8eb3f45a2fb6/sdk/cognitivelanguage/ai-language-text/src/textAnalysisClient.ts#L686)

joheredi

Great job! Thanks for addressing the comments!

* Update maps dependency in pnpm-lock.yaml * Fix sample metadata errors * Fix linting errors * Fix linting errors * Fix run time error * Update package.json in samples folder * Fix linting errors * Fix linting errors * Add changelog for maps-common * Update recording files for maps-search * Add test.yml for maps-search * Add tests.yml for render and route * Update tests.yml * Update test-resources.json for maps * Fix tests.yml format error * Update env vars and remove unused export var * Remove unused code * Fix lock file * Remove route & render * Replace `beginGet*Batch` with `resume*Batch` We provide a `beginGet*Batch` method to resume the previous request previously. This is not ideal because it need to get a `batchId` which is store in the internal state of the LRO. Once the LRO brings changes, our code will be broken. We can achieve the same thing by using serialized state. This change aims to leverage this approach and create convenience methods `resume*Batch` for users * Update recording * Make the endpoint of `MapsSearchClient` configurable * Change LatLon from an interface to a tuple Also remove the `toLatLon` function since creating a tuple is quite easy. * Make the props `coordinates` and `countryCodeFilter` optional Specifying `coordinates` and `countryCodeFilter` can narrow the results of the fuzzy search. But considring the case like searching "Australia", theese fields may have no use. We decided to make them optional so user can decides if they want to narrow down the results or not. * fixup! Remove route & render * Adjust CHANGELOGs of maps-search & common Following the keyvault-common, removing CHANGELOGs from maps-common since it's not published. * Update samples * Add batchRequest sample * Add a new sample searchAddressResult * Update search.ts and its examples * enhance code example in README.md * comment unused import * Update recording for maps-search * remove redundant recording files * Add maps-search * Rename LatLong to LatLon * Fix constructor Readme doc * Update readme to new signature * Add tests partially * Change LatLon/BoundingBox to interfaces * Reduce the number of constructor overloading * Rename SearchClient as MapsSearchClient * Add options mapper tests * Add result type mapper tests (in progress) * rename clientId to mapsAccountClientId * listPolygons -> getPolygons * getPointOfInterestCategoryTree -> getPointOfInterestCategories * Expose missing model * Add alternative input file for quick experiment * Regenerate code and make changes accordingly * Reduce number of overloads of fuzzy searches * Add geojson types * Adopting new geojson definitions * Change test specs to align with new method names * clean up models and tsconfig * Expose Known* models * Remove batch sync methods * Add public tests (non-batch) * move model * Add docstrings * Start polling in begin* method * Refactor BatchPoller for retrieving batchId * Finalize batch pollers * Readd batch methods * Update generated code * Finalize batch signature * Rebuild samples & clean up * Add AAD tests * Clean up Swagger readme * Fix spelling * Add initial files for @azure/maps-route module * maps-search: change comments and perform formatting * Methods options and testing skeleton for maps-route * maps-search: refactor options * Improve convenience layer for non-LRO methods * Change variable names * Complete batch methods * update maps-search Readme * Update maps-route Readme * Add generated samples for maps-route * Update samples for maps-search * Delete backup file * Add maps-common module * Update maps-route/maps-search to use maps-common * maps-render: first draft * Use LatLon/BoundingBox from maps-common * Complete maps-render with tests * Expose required types from maps-route * Expose required types from maps-search * Complete unit tests for maps-render * Update maps-render README * Update samples * Fix comment/strings * Fix comment/strings * Update Route comment/interface * Regenerate code * Update files * Define required fields and fix code * Remove non-poller batch methods * Fix playback test failure * Rename parts of model names * Rename remaining parts of models according to review feedback * Remove TODO comments * Update Reamdme transform to reflect latest swagger * Change key policy name * Simplify batch item error model * Add brower tests * Turn maps-common into internal module * Rearrange Readme * Rewrite Readme for common * Remove batch-sync methods * Route required fields: part 1 * Route required fields: part 2 * Add AAD back * Route model fixes #1 * Route model fixes #2 + geojson named tuples * Refine geojson types * Aliased a few method options * maps-render required fields part 1 * Do not validate budget parameters * Revert "Do not validate budget parameters" This reverts commit 4ec3f5f. * Rename MapTileset to TileJson * Render: model rename & type improvement * Explicitly transform image range * Fix route record tests * Update map account creation commands in Readme * Update Readme/docstrings/samples for Search/Route/Render * Remove rollup and use dev-tool instead * Remove some empty tests * Add AAD test case and make file name shorter * Update test cases * Update cspell rules * Update recording files * Simplify test cases * Sync cspell.json from upstream * Use test-recorder 2.0 and update unit test cases * Push wrong browsers recording files * Update settings to support recording * Fix dependency errors * Upgrade api-recorder and fix errors * Code refinement * Update maps search recording files * Update karma.conf.js format * Update recording files and settings * Fix broken links * Update maps dependency in pnpm-lock.yaml * Fix sample metadata errors * Fix linting errors * Fix linting errors * Fix run time error * Update package.json in samples folder * Fix linting errors * Fix linting errors * Add changelog for maps-common * Update recording files for maps-search * Add test.yml for maps-search * Add tests.yml for render and route * Update tests.yml * Update test-resources.json for maps * Fix tests.yml format error * Update env vars and remove unused export var * Remove unused code * Fix lock file * Remove maps-render * fixup! Change LatLon from an interface to a tuple * Comment the future doc link * Update doc & fix type issue * fix lint issues * Regenerate API View * Comment the whole [apiref] since the original syntax cannot pass the Analyze/Link verification * Fix issue related to the change of maps-common - Replace beginGet*Result with resume* methods - Turn LatLon to a tuple - Add mapper to transform the string to Date because resume* method will return a serialized Date * Update test recording * Remove maps-common from the Artifacts * remove unused dependencies * Add impression in README so we can track the page views * Remove `AZURE_LOG_LEVEL` in test.yml * Update samples - Move the option parameter to the right place - Add comments & "break" for handling the type of the search result to make it clear for the user * Patch {} to properties for GeoJsonPolygon * rename maxDetourTime to maxDetourTimeInSeconds * Update recordings * Remove any * Rename to detourTimeInSeconds to align the convention * Change the test.yml EnvVar See more explanation here: - #23039 (comment) - #23039 (comment) * Rename numResults to numberResults * Add document comment * Add endpoint options to MapsRouteClient * Remove unused dependencies in maps-route * fixup! Change the test.yml EnvVar * Update interfaces & documents * Update changelog * Merge getRouteDirection with the additional parameter one * Update samples * Make the `maps-common to a published package * Update the import of `maps-common` in `maps-search` * Fix CI Issue * Add documents for geojson * Update the samples & readme * Leverage maps-common package in mpas-route * chore update - Remove the unnecessary rule setting of eslint - Update the legacy type path * Remove unnecessary eslint config * WIP: Remove LRO generation * WIP: refactor mapsRouteClient * WIP: first generation * Format the generated code * Support AAD * Transform the model name * Add helper functions * Add a sample - route.ts * Add samples for lro * Add test * Generate samples * Add api view * Update the generation * WIP: ReadMe * Rename "computeBestOrder" to "computeBestWaypointOrder" * Refine README * Rename model * Add test createRouteDirectionsBatchRequest * Fix lint issue * Add missing metadata * Remove maps-route/ * Update CI issue * Fix merged issue * Update version rule for maps-common * Update CI name * Remove extra lint config * Use `require` in the README for consistency * Regenerate the samples * Remove redundant recording files * Remove unused parameters in test-resources.json * Refine readme snippet * Log something specific for the result * Update samples * Split the route.ts into 3 * Remove model rename * Use default export for RLC factory function Co-authored-by: Charlie Chen <charlie.chen@microsoft.com> Co-authored-by: Charlie Chen <yuchungchen@microsoft.com> Co-authored-by: --global <alankashiwa@gmail.com>

Release machinelearningservices microsoft.machine learning services 2023 04 01 (Azure#23450) * Adds base for updating Microsoft.MachineLearningServices from version stable/2022-10-01 to version 2023-04-01 * Updates readme * Updates API version in new specs and examples * [Stable] Bring Back schedule shutdown MLC models (Azure#23039) * bring back schedule shutdown MLC models * add description --------- Co-authored-by: Naman Agarwal <naagarw@microsoft.com> * add minLength:1 prop to required strings (Azure#23109) * [Stable] Add IdleShutdown properties and api (Azure#23042) * [Stable] Add IdleShutdown properties and api * update version * remove api to update IdleShutdownSetting * Delete example --------- Co-authored-by: Naman Agarwal <naagarw@microsoft.com> * Pushing new features in stable swagger (Azure#23071) * Pushing new features in stable swagger * Added example file * Triggering retest * Fixed version issue * Triggering retest * Removing OS Patching * Changes as per feedback, and add os patching back * Fix formatting * Removed Custom Service Update API * Fixed Example Files * Added as per review comments * Added as per review comments * Retrigger test --------- Co-authored-by: Srivatsa Sinha <srsinha@microsoft.com> * Add Registries 2023-04-01 Swagger (Azure#23085) * add swagger + examples * fix readme * fix readme * switching to autogenerated registries swagger * fix spellcheck * update ga examples * previous API version for comparison = 2023-02-01-preview * new API version for comparison = 2023-04-01 * update examples * update swagger, examples to fix pr gates * fix lint diff errors * delete should have a 202 response, update createorupdate examples, fix removeRegions operation * removeRegions -> LRO POST operation * fix LRO options on removeRegions * add registryNameParamert * update swagger * update * PATCH property should have sku, identity properties * fix example --------- Co-authored-by: Komal Yadav <komalyadav@microsoft.com> * MFE April 2023 staging (Azure#23164) * add latest mfe.json * updated examples * add wasbs to known words * swap pendingupload to proper naming * align RPs on Azure Machine Learning Services * rename pendingUpload to verb: startPendingUpload * remove trailing slash startpendingupload * improve descriptions * add pattern to all resource name types + examples * update original-uri -> azure-async-operation * remove wasbs and mark credential usage as secret * test is changing all to azure-async-operation causes breaking change * the code is implemented where the original-uri is where you will find the final object post-polling * update examples to remove wasbsUri * reference registries instead for RegistryName * remove wasbs * original-uri -> azure-async-operation * update examples to empty secrets * CreateOrUpdatePendingUpload -> CreateOrUpdateStartPendingUpload * add pattern for workspaceName * x-ms-secret on the SASUri * switch back to original-uri given update from auto-rest folks --------- Co-authored-by: Kayla Ames <kaseager@microsoft.com> * update compute examples to ReadOnly * v5->v3 * PartialManagedServiceIdentity -> RegistryPartialManagedServiceIdentity * update ID for delete/cancel job/schedule location header * PrivateEndpointConnection -> RegistryPrivateEndpointConnection * more renames for Registry * align mlc with arm * update registry examples * update registryPrivateLinkServiceConnectionState in examples * update description arm id for registryPrivateEndpointConnections * update to preview --------- Co-authored-by: Naman Agarwal <namanag16@gmail.com> Co-authored-by: Naman Agarwal <naagarw@microsoft.com> Co-authored-by: Teddy Todorov <thtodoro@microsoft.com> Co-authored-by: srivatsasinha <102133347+srivatsasinha@users.noreply.github.com> Co-authored-by: Srivatsa Sinha <srsinha@microsoft.com> Co-authored-by: Komal Yadav <23komal.yadav23@gmail.com> Co-authored-by: Komal Yadav <komalyadav@microsoft.com> Co-authored-by: Kayla Ames <kaseager@microsoft.com>

dubiety self-requested a review August 31, 2022 02:38

dubiety reviewed Aug 31, 2022

View reviewed changes

andykao1213 requested a review from dubiety September 5, 2022 07:27

andykao1213 force-pushed the andrewkao/maps-search branch from eb39dbb to 6bbbbf5 Compare September 5, 2022 08:48

alankashiwa added 23 commits September 6, 2022 02:51

Add maps-search

d4f8309

Rename LatLong to LatLon

8e401b7

Fix constructor Readme doc

433ef7b

Update readme to new signature

f1e42e9

Add tests partially

22d94af

Change LatLon/BoundingBox to interfaces

131542c

Reduce the number of constructor overloading

87be993

Rename SearchClient as MapsSearchClient

9ccce79

Add options mapper tests

cbd365b

Add result type mapper tests (in progress)

0bf9cf0

rename clientId to mapsAccountClientId

4e6eda4

listPolygons -> getPolygons

bbfcccd

getPointOfInterestCategoryTree -> getPointOfInterestCategories

c26cbe1

Expose missing model

78da7b5

Add alternative input file for quick experiment

3a90436

Regenerate code and make changes accordingly

01fb651

Reduce number of overloads of fuzzy searches

570351f

Add geojson types

cb7814b

Adopting new geojson definitions

7a59eb9

Change test specs to align with new method names

d42a7d6

clean up models and tsconfig

be6e5a7

Expose Known* models

9b50784

Remove batch sync methods

d436d1f

Add document comment

979cae7

andykao1213 requested review from HarshaNalluru, benbp and jeremymeng September 21, 2022 10:31

Merge remote-tracking branch 'upstream/main' into andrewkao/maps-search

502d7dc

jeremymeng approved these changes Sep 23, 2022

View reviewed changes

andykao1213 requested a review from joheredi September 26, 2022 01:51

joheredi reviewed Sep 26, 2022

View reviewed changes

andykao1213 added 4 commits September 27, 2022 09:31

Make the `maps-common to a published package

9100bda

Update the import of maps-common in maps-search

76d9057

Merge remote-tracking branch 'upstream/main' into andrewkao/maps-search

a7e33ec

Fix CI Issue

02a0517

andykao1213 requested a review from joheredi September 27, 2022 13:39

joheredi reviewed Sep 27, 2022

View reviewed changes

deyaaeldeen reviewed Sep 28, 2022

View reviewed changes

andykao1213 added 2 commits September 28, 2022 06:21

Add documents for geojson

fd7722f

chore update

384217c

- Remove the unnecessary rule setting of eslint - Update the legacy type path

andykao1213 changed the title ~~[Maps] Add maps-search package~~ [Maps] Onboarding maps-common & maps-search package Sep 28, 2022

Merge remote-tracking branch 'upstream/main' into andrewkao/maps-search

01f4e60

andykao1213 self-assigned this Sep 28, 2022

andykao1213 added 2 commits September 30, 2022 02:06

Merge remote-tracking branch 'upstream/main' into andrewkao/maps-search

f48c878

joheredi approved these changes Sep 30, 2022

View reviewed changes

deyaaeldeen merged commit 6038d9f into Azure:main Sep 30, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Maps] Onboarding `maps-common` & `maps-search` package #23039

[Maps] Onboarding `maps-common` & `maps-search` package #23039

andykao1213 commented Aug 30, 2022 •

edited

Loading

andykao1213 commented Aug 30, 2022

check-enforcer bot commented Aug 30, 2022

azure-sdk commented Sep 5, 2022 •

edited

Loading

jeremymeng left a comment

joheredi Sep 26, 2022

joheredi Sep 26, 2022

andykao1213 Sep 27, 2022

andykao1213 Sep 27, 2022

timovv Sep 27, 2022

andykao1213 Sep 28, 2022

joheredi Sep 27, 2022

andykao1213 Sep 28, 2022

joheredi Sep 27, 2022

andykao1213 Sep 28, 2022

joheredi Sep 27, 2022

joheredi Sep 27, 2022

andykao1213 Sep 29, 2022

joheredi left a comment

deyaaeldeen Sep 28, 2022

andykao1213 Sep 28, 2022 •

edited

Loading

andykao1213 Sep 30, 2022

joheredi left a comment

[Maps] Onboarding maps-common & maps-search package #23039

[Maps] Onboarding maps-common & maps-search package #23039

Conversation

andykao1213 commented Aug 30, 2022 • edited Loading

Packages impacted by this PR

Issues associated with this PR

Describe the problem that is addressed by this PR

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?

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

Provide a list of related PRs (if any)

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

Checklists

andykao1213 commented Aug 30, 2022

check-enforcer bot commented Aug 30, 2022

What is Check Enforcer?

Why am I getting this message?

What should I do now?

What if I am onboarding a new service?

azure-sdk commented Sep 5, 2022 • edited Loading

jeremymeng left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joheredi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andykao1213 Sep 28, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joheredi left a comment

Choose a reason for hiding this comment

[Maps] Onboarding `maps-common` & `maps-search` package #23039

[Maps] Onboarding `maps-common` & `maps-search` package #23039

andykao1213 commented Aug 30, 2022 •

edited

Loading

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

azure-sdk commented Sep 5, 2022 •

edited

Loading

andykao1213 Sep 28, 2022 •

edited

Loading