Improve how we handle Static Helpers #2716
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MaryGao
reviewed
Jul 31, 2024
joheredi
commented
Jul 31, 2024
| @@ -52,64 +53,4 @@ export interface CoreDependencies extends Record<string, ReferenceableSymbol> { | |||
| }; | |||
| } | |||
|
|
|||
| const _CoreDependencies: CoreDependencies = { | |||
There was a problem hiding this comment.
Moving these to modular/external-dependencies.ts
joheredi
commented
Jul 31, 2024
| @@ -39,15 +45,18 @@ export interface Binder { | |||
|
|
|||
| class BinderImp implements Binder { | |||
| private declarations = new Map<unknown, DeclarationInfo>(); | |||
| private references = new Map<unknown, Set<SourceFile>>(); | |||
There was a problem hiding this comment.
Adding this map to track things that are used, this is helpful to cleanup unused static-helpers
joheredi
commented
Jul 31, 2024
| @@ -146,7 +155,7 @@ class BinderImp implements Binder { | |||
| * @returns The serialized placeholder string. | |||
| */ | |||
| private serializePlaceholder(refkey: unknown): string { | |||
| return `"<PLACEHOLDER:${String(refkey)}>"`; | |||
| return `_PLACEHOLDER_${String(refkey)}_`; | |||
There was a problem hiding this comment.
This format is safer with ts-morph. Sometimes the double quotes and < may cause unexpected ts-morph behavior. This makes the placeholder a valid identifier
joheredi
changed the title
dgetu
reviewed
Jul 31, 2024
MaryGao
reviewed
Aug 1, 2024
MaryGao
reviewed
Aug 1, 2024
MaryGao
reviewed
Aug 1, 2024
| @@ -394,6 +397,12 @@ function getLroOnlyOperationFunction(operation: Operation, clientType: string) { | |||
| getOperationSignatureParameters(operation, clientType); | |||
| const returnType = buildLroReturnType(operation); | |||
| const { name, fixme = [] } = getOperationName(operation); | |||
| const pollerLikeReference = resolveReference( | |||
There was a problem hiding this comment.
Glad to see this change! ：）And we don't need to care the importing path stuff.
timovv
reviewed
Aug 7, 2024
timovv
approved these changes
Aug 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Objective:
Enhance the handling of static-helpers by transitioning from string injection into a
ts-morphfile to utilizing actual TypeScript files, which are copied to the output directory. This change aims to streamline the process and improve maintainability.Key Changes:
resolveReference(PagingHelpers.buildPagedAsyncIterator), automatically adding the correct import.Future Work:
I created 2 additional PRs that will merge into this one to make review a bit easier. This PR contains the changes to the code-gen.
PR with changes to generated CADL ranch tests: joheredi#8
PR with changes to generated smoke tests: joheredi#10