Skip to content

Add @supportSync parsing logic for Custom Function Sync #947

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

Closed
wants to merge 3 commits into from
Closed

Add @supportSync parsing logic for Custom Function Sync #947

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a55da9a
Add syncSupport function option
hermanwenhe Jul 29, 2025
aee086a
change name to @sync; fix test bug
hermanwenhe Aug 5, 2025
2eafafb
update tag from @sync to @supportSync
hermanwenhe Aug 21, 2025
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
18 changes: 17 additions & 1 deletion packages/custom-functions-metadata/src/parseTree.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ export interface IFunctionOptions {
excludeFromAutoComplete?: boolean;
linkedEntityLoadService?: boolean;
capturesCallingObject?: boolean;
supportSync?: boolean;
}

export interface IFunctionParameter {
Expand Down Expand Up @@ -132,6 +133,7 @@ const REQUIRESADDRESS = "requiresaddress";
const REQUIRESPARAMETERADDRESSES = "requiresparameteraddresses";
const STREAMING = "streaming";
const VOLATILE = "volatile";
const SUPPORT_SYNC = "supportsync";

const TYPE_MAPPINGS = {
[ts.SyntaxKind.NumberKeyword]: "number",
Expand Down Expand Up @@ -462,7 +464,8 @@ export function parseTree(sourceCode: string, sourceFileName: string): IParseTre
!options.requiresStreamParameterAddresses &&
!options.excludeFromAutoComplete &&
!options.linkedEntityLoadService &&
!options.capturesCallingObject
!options.capturesCallingObject &&
!options.supportSync
) {
delete functionMetadata.options;
} else {
Expand Down Expand Up @@ -505,6 +508,10 @@ export function parseTree(sourceCode: string, sourceFileName: string): IParseTre
if (!options.capturesCallingObject) {
delete options.capturesCallingObject;
}

if (!options.supportSync) {
delete options.supportSync;
}
}

if (!functionMetadata.helpUrl) {
Expand Down Expand Up @@ -667,6 +674,7 @@ function getOptions(
excludeFromAutoComplete: isExcludedFromAutoComplete(func),
linkedEntityLoadService: isLinkedEntityLoadService(func),
capturesCallingObject: capturesCallingObject(func),
supportSync: supportSync(func),
};

if (isAddressRequired(func) || isRequiresParameterAddresses(func)) {
Expand Down Expand Up @@ -1062,6 +1070,14 @@ function capturesCallingObject(node: ts.Node): boolean {
return hasTag(node, CAPTURESCALLINGOBJECT);
}

/**
* Returns true if sync tag found in comments
* @param node jsDocs node
*/
function supportSync(node: ts.Node): boolean {
return hasTag(node, SUPPORT_SYNC);
}

function containsTag(tag: ts.JSDocTag, tagName: string): boolean {
return (tag.tagName.escapedText as string).toLowerCase() === tagName;
}
Expand Down
Loading