Adds callFunc as member method to Custom Components (#929)

* Added Callfunc as ComponentType member

* Tightened up TypedFUnctionType compatibility code and added tests for .callFunc invocations

* fixed build issue

* Added callfunc as an override directly in scrape-roku-docs script

* fixed build errors

* Rescraped Roku docs

scripts/scrape-roku-docs.ts

@@ -757,6 +757,26 @@ class Runner {
     private mergeOverrides() {
         this.result = deepmerge(this.result, {
             nodes: {
+                node: {
+                    // Taken from: https://developer.roku.com/en-ca/docs/developer-program/core-concepts/handling-application-events.md#functional-fields
+                    methods: [
+                        {
+                            description: `callFunc() is a synchronized interface on roSGNode. It will always execute in the component's owning ScriptEngine and thread (by rendezvous if necessary), and it will always use the m and m.top of the owning component. Any context from the caller can be passed via one or more method parameters, which may be of any type (previously, callFunc() only supported a single associative array parameter).\n\nTo call the function, use the \`callFunc\` field with the required method signature. A return value, if any, can be an object that is similarly arbitrary. The method being called must determine how to interpret the parameters included in the \`callFunc\` field.`,
+                            name: 'callFunc',
+                            params: [
+                                {
+                                    default: null,
+                                    description: 'The function name to call.',
+                                    isRequired: true,
+                                    name: 'functionName',
+                                    type: 'String'
+                                }
+                            ],
+                            isVariadic: true,
+                            returnType: 'Dynamic'
+                        }
+                    ]
+                }
             },
             components: {},
             events: {},
@@ -1205,6 +1225,7 @@ interface SceneGraphNode {
     interfaces: Reference[];
     events: Reference[];
     fields: SceneGraphNodeField[];
+    methods: Func[];
 }
 
 interface SceneGraphNodeField {
@@ -1239,6 +1260,7 @@ interface Signature {
     params: Param[];
     returnType: string;
     returnDescription: string;
+    isVariadic?: boolean;
 }
 interface ElementFilter {
     id?: string;

src/Program.spec.ts

@@ -2278,7 +2278,7 @@ describe('Program', () => {
             expectTypeToBe(table.getSymbolType('ifDeviceInfo', opts).getMemberType('GetRandomUUID', rtOpts), TypedFunctionType);
 
             expectTypeToBe(table.getSymbolType('ifSGNodeField', opts), InterfaceType);
-            expectTypeToBe(table.getSymbolType('ifSGNodeField', opts).getMemberType('observeField', rtOpts), TypedFunctionType);
+            expectTypeToBe(table.getSymbolType('ifSGNodeField', opts).getMemberType('addFields', rtOpts), TypedFunctionType);
         });
 
         it('adds brightscript events', () => {

src/Program.ts

@@ -128,7 +128,7 @@ export class Program {
             nodeType.addBuiltInInterfaces();
             this.globalScope.symbolTable.addSymbol(nodeName, { description: nodeData.description }, nodeType, SymbolTypeFlag.typetime);
         } else {
-            nodeType = this.globalScope.symbolTable.getSymbolType(nodeData.name, { flags: SymbolTypeFlag.typetime }) as ComponentType;
+            nodeType = this.globalScope.symbolTable.getSymbolType(nodeName, { flags: SymbolTypeFlag.typetime }) as ComponentType;
         }
 
         return nodeType;

src/XmlScope.spec.ts

@@ -3,7 +3,7 @@ import { Position, Range } from 'vscode-languageserver';
 import { DiagnosticMessages } from './DiagnosticMessages';
 import type { XmlFile } from './files/XmlFile';
 import { Program } from './Program';
-import { expectDiagnostics, expectTypeToBe, trim } from './testHelpers.spec';
+import { expectDiagnostics, expectTypeToBe, expectZeroDiagnostics, trim } from './testHelpers.spec';
 import { standardizePath as s, util } from './util';
 let rootDir = s`${process.cwd()}/rootDir`;
 import { createSandbox } from 'sinon';
@@ -219,7 +219,7 @@ describe('XmlScope', () => {
             program.setFile('components/Widget.xml', trim`
                 <?xml version="1.0" encoding="utf-8" ?>
                 <component name="Widget" extends="Group">
-                     <script uri="Widget.brs"/>
+                    <script uri="Widget.brs"/>
                     <interface>
                         <function name="someFunc" />
                     </interface>
@@ -239,5 +239,29 @@ describe('XmlScope', () => {
             expectTypeToBe(widgetType.getCallFuncType('someFunc', { flags: SymbolTypeFlag.runtime }), TypedFunctionType);
         });
 
+        it('allows .callFunc() on components', () => {
+            program.setFile('components/Widget.xml', trim`
+                <?xml version="1.0" encoding="utf-8" ?>
+                <component name="Widget" extends="Group">
+                    <script uri="Widget.brs"/>
+                    <interface>
+                        <function name="someFunc" />
+                    </interface>
+                </component>
+            `);
+            program.setFile('components/Widget.brs', `
+                sub someFunc(input as object)
+                    print input
+                end sub
+            `);
+            program.setFile('source/util.brs', `
+                sub useCallFunc(input as roSGNodeWidget)
+                    input.callFunc("someFunc", {hello: "world"})
+                end sub
+            `);
+            program.validate();
+            expectZeroDiagnostics(program);
+        });
+
     });
 });

src/XmlScope.ts

@@ -9,9 +9,9 @@ import { isXmlFile } from './astUtils/reflection';
 import { SGFieldTypes } from './parser/SGTypes';
 import type { SGElement } from './parser/SGTypes';
 import { SymbolTypeFlag } from './SymbolTable';
-import { DynamicType } from './types';
 import type { BaseFunctionType } from './types/BaseFunctionType';
 import { ComponentType } from './types/ComponentType';
+import { DynamicType } from './types/DynamicType';
 
 export class XmlScope extends Scope {
     constructor(
@@ -53,6 +53,7 @@ export class XmlScope extends Scope {
             ? this.symbolTable.getSymbolType(util.getSgNodeTypeName(componentElement?.extends), { flags: SymbolTypeFlag.typetime, fullName: componentElement?.extends, tableProvider: () => this.symbolTable })
             : undefined;
         const result = new ComponentType(componentElement.name, parentComponentType as ComponentType);
+        result.addBuiltInInterfaces();
         const iface = componentElement.interfaceElement;
         if (!iface) {
             return result;

src/bscPlugin/validation/ScopeValidator.spec.ts

@@ -1,7 +1,7 @@
 import * as sinonImport from 'sinon';
 import { DiagnosticMessages } from '../../DiagnosticMessages';
 import { Program } from '../../Program';
-import { expectDiagnostics, expectTypeToBe, expectZeroDiagnostics } from '../../testHelpers.spec';
+import { expectDiagnostics, expectTypeToBe, expectZeroDiagnostics, trim } from '../../testHelpers.spec';
 import { expect } from 'chai';
 import type { TypeCompatibilityData } from '../../interfaces';
 import { IntegerType } from '../../types/IntegerType';
@@ -140,6 +140,59 @@ describe('ScopeValidator', () => {
             //should have no errors
             expectZeroDiagnostics(program);
         });
+
+        it('checks for at least the number of non-optional args on variadic (callFunc) functions', () => {
+            program.setFile('components/Widget.xml', trim`
+                <?xml version="1.0" encoding="utf-8" ?>
+                <component name="Widget" extends="Group">
+                    <script uri="Widget.brs"/>
+                    <interface>
+                        <function name="someFunc" />
+                    </interface>
+                </component>
+            `);
+            program.setFile('components/Widget.brs', `
+                sub someFunc(input as object)
+                    print input
+                end sub
+            `);
+            program.setFile('source/util.brs', `
+                sub useCallFunc(input as roSGNodeWidget)
+                    input.callFunc()
+                end sub
+            `);
+            program.validate();
+            //should have an error
+            expectDiagnostics(program, [
+                DiagnosticMessages.mismatchArgumentCount('1-32', 0)
+            ]);
+        });
+
+        it('any number number of args on variadic (callFunc) functions', () => {
+            program.setFile('components/Widget.xml', trim`
+                <?xml version="1.0" encoding="utf-8" ?>
+                <component name="Widget" extends="Group">
+                    <script uri="Widget.brs"/>
+                    <interface>
+                        <function name="someFunc" />
+                    </interface>
+                </component>
+            `);
+            program.setFile('components/Widget.brs', `
+                sub someFunc(input as object)
+                    print input
+                end sub
+            `);
+            program.setFile('source/util.brs', `
+                sub useCallFunc(input as roSGNodeWidget)
+                    input.callFunc("someFunc", 1, 2, 3, {})
+                end sub
+            `);
+            program.validate();
+            //TODO: do a better job of handling callFunc() invocations!
+            //should have an error
+            expectZeroDiagnostics(program);
+        });
     });
 
     describe('argumentTypeMismatch', () => {

src/bscPlugin/validation/ScopeValidator.ts

@@ -12,7 +12,8 @@ import type { BRSComponentData } from '../../roku-types';
 import type { Token } from '../../lexer/Token';
 import type { Scope } from '../../Scope';
 import { type AstNode, type Expression } from '../../parser/AstNode';
-import type { VariableExpression, DottedGetExpression, CallExpression, BinaryExpression, UnaryExpression } from '../../parser/Expression';
+import type { VariableExpression, DottedGetExpression, BinaryExpression, UnaryExpression } from '../../parser/Expression';
+import { CallExpression } from '../../parser/Expression';
 import { ParseMode } from '../../parser/Parser';
 import { TokenKind } from '../../lexer/TokenKind';
 import { WalkMode, createVisitor } from '../../astUtils/visitors';
@@ -438,6 +439,10 @@ export class ScopeValidator {
                     minParams++;
                 }
             }
+            if (funcType.isVariadic) {
+                // function accepts variable number of arguments
+                maxParams = CallExpression.MaximumArguments;
+            }
             let expCallArgCount = expression.args.length;
             if (expCallArgCount > maxParams || expCallArgCount < minParams) {
                 let minMaxParamsText = minParams === maxParams ? maxParams : `${minParams}-${maxParams}`;