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

Jump to bottom

Namespace refactoring Implementation #2968

Closed
Tracked by #4537
lmazuel opened this issue Oct 23, 2024 · 5 comments
Closed
Tracked by #4537

Namespace refactoring Implementation #2968

lmazuel opened this issue Oct 23, 2024 · 5 comments
Assignees
@weidongxu-microsoft
Labels
DPG

Comments

@lmazuel
Copy link
Member

lmazuel commented Oct 23, 2024

No description provided.

This was referenced Oct 23, 2024
Closed
Open
@weidongxu-microsoft
Copy link
Member

weidongxu-microsoft commented Oct 24, 2024 •
edited
Loading

epic

design

depends

@weidongxu-microsoft weidongxu-microsoft self-assigned this Oct 25, 2024
@weidongxu-microsoft
Copy link
Member

weidongxu-microsoft commented Nov 4, 2024 •
edited
Loading

Java design (base on TCGC .namespace)

Azure

  • Client classes would be under <tcgc_namespace>
  • Model/enum classes would be under <tcgc_namespace>.models
  • Internal model/enum classes would be under <tcgc_namespace>.implementation.models

This is following best practice on Azure Java Guideline e.g. model types, without service had to define a separate TypeSpec namespace for TypeSpec models.

Unbranded

  • Client/model/enum classes would be under <tcgc_namespace>
  • Internal model/enum classes would be under <tcgc_namespace>.implementation (?)

@weidongxu-microsoft
Copy link
Member

Migration plan for Azure

  • namespace option would override the client namespace from TCGC
  • new onboard should not have namespace option
  • migrate existing lib, update client.tsp to add @clientNamespace, and remove namespace option

This was referenced Nov 11, 2024
Merged
Merged
github-merge-queue bot pushed a commit to microsoft/typespec that referenced this issue Nov 13, 2024
@weidongxu-microsoft
http-client-java, do not prefix com. in namespace (#5084)
56349a5 
Also remove the `Cadl.` in local test. Replaced it with `TspTest` (we
don't want to call it `TypeSpec.` as it could conflict with TypeSpec
libs).

It would not affect Azure SDK which always has `namespace` in emitter
option.
It only affect SDK that does not have this option (basically, test case,
and unbranded).

It prepares for the Namespace refactor, as we should not modify the
TypeSpec Namespace. Azure/autorest.java#2968
github-merge-queue bot pushed a commit to microsoft/typespec that referenced this issue Nov 22, 2024
@weidongxu-microsoft
http-client-java, namespace from client.tsp (#5051)
2e1c857 
link Azure/autorest.java#2968

current limitation:
- operation group be in same package of client
- subclient be in same package of client

mostly this due to the fact that ctor of the client is package private,
so it won't work if client and its builder or client of accessor method
are in different packages

---

At this PR, unbranded would still have `.models` in package for models.
We can tweak this later (by setting `modelsSubPackage` in JavaSetting to
empty, when unbranded).

---

tested and it be backward compatible, if `namespace` is provided in
emitter option
https://github.com/Azure/azure-sdk-for-java/pull/43055/files
@weidongxu-microsoft
Copy link
Member

Current limitation

  • operation group be in same package of client
  • subclient be in same package of client

@weidongxu-microsoft
Copy link
Member

typespec-java 0.26.0
http-client-java 0.1.1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@weidongxu-microsoft weidongxu-microsoft

Labels
DPG
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@lmazuel @weidongxu-microsoft