Support hierarchy subpath #2080

qiaozha · 2023-10-24T09:16:33Z

fixes #2035 #2066

This PR is for hierarchy client support, document some agreements we have:

hierarchyClient will be enabled by default, unless it's specified as false.
If hierarchyClient is true, we will generate hierarchy client in the classic layer. every namespace and interface will be considered as a layer.
if hierarchyClient is true, generate hierarchy client subpath in the api layer. customer will no longer be able to access the deep layered apis from the top ./api subpath export.
we will generate models with full namespace as prefix if we detect there's model name conflict or enableModelNamespace is true.
we will generate hierarchy folder structure in the api layer, and generate classic folder to wrapper the classical client calls to the api layer. which has the same hierarchy folder structure as the api layer. which is also true if hierarchyClient is false and enableOperationGroup is true, we will just not export the api subpath in that case.
we will generate all the operation options in the models/options.ts and if there're any name conflicts, we will add full namespace as prefix to avoid them. Though I tried to put them in the api hierarchy subpath to avoid resolve the conflicts with namespace prefix, but the api extractor doesn't look happy and we have to export all the operation options to the top level index.ts.
If hierarchyClient is false, and enableOperationGroup is false, enableModelNamespace is also false, there should be no code change, which can be proved in those hierarchyClient false cases.

About testing,
I have enabled hierarchyClient true for three smoke test, hierarchy_generic, openai_generic and widget_dpg,
And disabled hierarchyClient for all the rest smoke tests and modular integration tests. The change for modularIntegration tests are code reorganize as point out in the above point 4. Their API doesn't change which can be proved from no integration tests change.

qiaozha

Initial review for some implementation details to be confirmed.

packages/typespec-test/test/anomalyDetector/generated/typespec-ts/src/models.ts

...ypespec-test/test/openai_generic/generated/typespec-ts/src/api/audio/transcriptions/index.ts

.../typespec-test/test/openai_generic/generated/typespec-ts/src/api/audio/translations/index.ts

packages/typespec-test/test/openai_generic/generated/typespec-ts/src/api/index.ts

packages/typespec-test/test/openai_generic/generated/typespec-ts/src/api/models/index.ts

packages/typespec-test/test/openai_generic/generated/typespec-ts/src/OpenAIClient.ts

...ypespec-test/test/openai_generic/generated/typespec-ts/src/api/audio/transcriptions/index.ts

packages/typespec-test/test/openai_generic/generated/typespec-ts/src/OpenAIClient.ts

…l conflicts if detect

qiaozha

Still missing the subpath export info in the package.json

packages/typespec-test/test/openai_generic/generated/typespec-ts/review/openai-generic.api.md

packages/typespec-test/test/hierarchy_generic/spec/main.tsp

packages/typespec-test/test/hierarchy_generic/generated/typespec-ts/src/api/b/b/index.ts

packages/typespec-test/test/hierarchy_generic/generated/typespec-ts/src/rest/models.ts

...ypespec-test/test/openai_generic/generated/typespec-ts/src/api/audio/transcriptions/index.ts

…nflict exists

packages/typespec-test/test/openai_generic/generated/typespec-ts/review/openai-generic.api.md

...ypespec-test/test/openai_generic/generated/typespec-ts/src/api/audio/transcriptions/index.ts

packages/typespec-test/test/openai_generic/generated/typespec-ts/package.json

packages/typespec-test/test/hierarchy_generic/generated/typespec-ts/src/FooClient.ts

* loadtesting-with-hierarchy-false * do not return namespace hierarchies * use interface name when enable operation group in rlc * fix package.json

* loadtesting-with-hierarchy-false * do not return namespace hierarchies * use interface name when enable operation group in rlc * fix package.json * update generic generated files just import order chaneg

* disable-hierarchy-client-and-not-introduce-extra-changes * fix model import issues * reserve work * reserve work * fix hierarchy layer overload * fix generation failure * fall back to enableOperationGroup logic if hierarchyClient is false * fix package.json and api layer export * fix smoke-test

qiaozha

left some reviews after disable hierarchy client in most of the other test cases.

packages/typespec-test/test/loadtesting_modular/generated/typespec-ts/src/index.ts

...ing_modular/generated/typespec-ts/src/loadTestAdministration/LoadTestAdministrationClient.ts

...odularIntegration/generated/client/structure/renamed-operation/src/RenamedOperationClient.ts

qiaozha · 2023-10-31T15:14:16Z

packages/typespec-ts/test/modularIntegration/generated/encode/bytes/src/BytesClient.ts

+    this.query = getQueryOperations(this._client);
+    this.property = getPropertyOperations(this._client);
+    this.header = getHeaderOperations(this._client);
+    this.requestBody = getRequestBodyOperations(this._client);
+    this.responseBody = getResponseBodyOperations(this._client);


In the case of hierarchyClient is false, and operationGroup is true, we will just organize the code in the hierarchy way for better documentation purpose, and we will not export the api layer as subpath. @joheredi how do you think ? it should have no api interface change in both classic layer and api layer expect for the change of exporting the operation group operations interface which we have discussed earlier that have to be exported as of the api extractor and the change of operation operations change as I memtioned earlier.

...pec-ts/test/modularIntegration/generated/parameters/collection-format/src/api/query/index.ts

…hyClient false

packages/typespec-test/test/chatApi_modular/generated/typespec-ts/package.json

…-ts/package.json

packages/typespec-test/test/loadtesting_modular/tspconfig.yaml

…st.typescript into support-hierarchy-subpath

* hierarchy-namespace-in-client-tsp * fix client structure with operations * update smoke-test

qiaozha added 8 commits October 19, 2023 09:52

inital-commit-of-hierarchy-support

208d50d

merge main

49c6bbd

add model namespace name

43bec0d

reserve work

f37db63

Merge branch 'main' into support-hierarchy-subpath

a79e9f9

revert change in openai modular as of openai generic

9cf6d3e

generate operations

106c346

merge main and resolve conflicts

e313ad9

qiaozha commented Oct 24, 2023

View reviewed changes

qiaozha added 2 commits October 25, 2023 18:26

add classical operation hierarchy layers and reserve work

a2b317d

organize classic operation as hierarchy layered

068e288

qiaozha commented Oct 26, 2023

View reviewed changes

qiaozha added 5 commits October 26, 2023 10:58

change typespec to have simpler names

9d3f7d0

resolve operation conflicts with full namespace path

3448b59

merge main and resolve conflicts

f8b2369

add namespace prefix for model only when conflicts

15a6cf2

add edge case for model and operation name conflicts and resolve mode…

db65278

…l conflicts if detect

qiaozha commented Oct 26, 2023

View reviewed changes

qiaozha mentioned this pull request Oct 26, 2023

use $ as the operation rename for reserved word. #2084

Closed

qiaozha added 2 commits October 26, 2023 15:59

enableModelNamespace as true for anomaly detector

8a25967

fix hierarchy layer info bug

eb9f817

qiaozha commented Oct 26, 2023

View reviewed changes

...ypespec-test/test/openai_generic/generated/typespec-ts/src/api/audio/transcriptions/index.ts Outdated Show resolved Hide resolved

qiaozha added 3 commits October 26, 2023 18:18

do not rename in Modular but rename in RLC if hierarchy client and co…

f2d28c1

…nflict exists

fix model conflicts detect condition

0b4f423

update edge case generation

318b9c6

qiaozha commented Oct 26, 2023

View reviewed changes

packages/typespec-test/test/openai_generic/generated/typespec-ts/review/openai-generic.api.md Outdated Show resolved Hide resolved

...ypespec-test/test/openai_generic/generated/typespec-ts/src/api/audio/transcriptions/index.ts Show resolved Hide resolved

update package.json with hierarchy subpath

9d3deb0

qiaozha commented Oct 26, 2023

View reviewed changes

packages/typespec-test/test/openai_generic/generated/typespec-ts/package.json Outdated Show resolved Hide resolved

joheredi reviewed Oct 26, 2023

View reviewed changes

packages/typespec-test/test/hierarchy_generic/generated/typespec-ts/src/FooClient.ts Show resolved Hide resolved

manual change for export the operation interface

6bad7e1

qiaozha added 3 commits October 29, 2023 21:18

loadtesting-with-hierarchy-false (#9)

dd3bcde

* loadtesting-with-hierarchy-false * do not return namespace hierarchies * use interface name when enable operation group in rlc * fix package.json

update generic generated files with just pure import order change (#10)

cc8aeda

* loadtesting-with-hierarchy-false * do not return namespace hierarchies * use interface name when enable operation group in rlc * fix package.json * update generic generated files just import order chaneg

qiaozha commented Oct 31, 2023

View reviewed changes

qiaozha added 5 commits October 31, 2023 23:17

merge main

6b1f859

fix lint error

b1744eb

tryfix ci

31e8e98

add operation group name back if hierarchy client is false

5cfd365

use operation group name if hierarchy client is false

a8b8e7a

qiaozha commented Nov 1, 2023

View reviewed changes

...pec-ts/test/modularIntegration/generated/parameters/collection-format/src/api/query/index.ts Outdated Show resolved Hide resolved

...pec-ts/test/modularIntegration/generated/parameters/collection-format/src/api/query/index.ts Outdated Show resolved Hide resolved

qiaozha added 5 commits November 1, 2023 14:55

rename operation if enableOperationGroup true and hierarchyClient false

6634eb6

merge main and resolve conflicts

2852795

do not include operation group name duplicated

54dc4bc

only return interface name when enableOperationGroup true and hierarc…

1c35775

…hyClient false

disable hierarchyClient for chatApi

543fced

qiaozha commented Nov 2, 2023

View reviewed changes

packages/typespec-test/test/chatApi_modular/generated/typespec-ts/package.json Outdated Show resolved Hide resolved

Update packages/typespec-test/test/chatApi_modular/generated/typespec…

57a5c8b

…-ts/package.json

qiaozha commented Nov 2, 2023

View reviewed changes

packages/typespec-test/test/loadtesting_modular/tspconfig.yaml Show resolved Hide resolved

qiaozha and others added 3 commits November 2, 2023 15:50

Update packages/typespec-test/test/loadtesting_modular/tspconfig.yaml

34853e7

enableOperationGroup for service with operationGroup decorator

774a359

Merge branch 'support-hierarchy-subpath' of github.com:qiaozha/autore…

67b52b8

…st.typescript into support-hierarchy-subpath

qiaozha marked this pull request as ready for review November 2, 2023 10:27

qiaozha requested review from sarangan12 and MaryGao as code owners November 2, 2023 10:27

qiaozha and others added 2 commits November 2, 2023 20:07

to not get namespace hierarchy if hierarchyClient is false (#12)

df6a786

* hierarchy-namespace-in-client-tsp * fix client structure with operations * update smoke-test

undo enable operation group for clients

d543829

qiaozha requested a review from joheredi November 2, 2023 13:03

joheredi approved these changes Nov 2, 2023

View reviewed changes

qiaozha merged commit 7b641fe into Azure:main Nov 4, 2023
28 checks passed

qiaozha deleted the support-hierarchy-subpath branch November 4, 2023 01:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support hierarchy subpath #2080

Support hierarchy subpath #2080

qiaozha commented Oct 24, 2023 •

edited

Loading

qiaozha left a comment

qiaozha left a comment

qiaozha left a comment

qiaozha Oct 31, 2023

Support hierarchy subpath #2080

Support hierarchy subpath #2080

Conversation

qiaozha commented Oct 24, 2023 • edited Loading

qiaozha left a comment

Choose a reason for hiding this comment

qiaozha left a comment

Choose a reason for hiding this comment

qiaozha left a comment

Choose a reason for hiding this comment

qiaozha Oct 31, 2023

Choose a reason for hiding this comment

qiaozha commented Oct 24, 2023 •

edited

Loading