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.

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

feat(#580): a basic implementation of js function calling from askcript #590

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
25 changes: 25 additions & 0 deletions src/askvm/lib/factory.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import { resource, Resource } from './resource';
import { any } from './type';

/**
* Resource factory generates the resource wrappers around all the methods which are on `whitelist` of the `module` passed. Implementation of https://github.com/CatchTheTornado/askql/issues/580 for limited JS function calls inside AskScript
* @param module JS object which methods will be wrapped as resource handlers
* @param whitelist list of strings including function/method names of the module to be wrapped out
*/
export function factory(
jsModule: any,
whitelist: string[]
): Record<string, Resource<any, any>> {
const res: Record<string, Resource<any, any>> = {};
whitelist.forEach((k) => {
if (k in jsModule) {
res[k] = resource({
type: any,
async resolver(...args: any) {
return jsModule[k](...args);
},
});
}
});
return res;
}
1 change: 1 addition & 0 deletions src/askvm/lib/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ export * from './resource';
export * from './run';
export * from './type';
export * from './typed';
export * from './factory';
48 changes: 48 additions & 0 deletions src/askvm/resources/core/__tests__/factory.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
import { runUntyped } from '../../../index';
import { parse } from '../../../../askcode/lib';
import { factory } from '../../../lib/factory';
import * as core from '..';

const values = {};
const moduleToBeWrapped = {
wrapMe1: () => {
return 100;
},
wrapMe2: (arg: string) => {
return arg;
},
dontWrapMe: () => {
return 0;
},
};
const wrappedResources = factory(moduleToBeWrapped, ['wrapMe1', 'wrapMe2']);

function ask(code: string) {
return runUntyped(
{
resources: { ...core, ...wrappedResources },
values,
},
parse(code)
);
}

describe(`factory`, function () {
it(`factory should wrap only whitelisted resources`, async function () {
await expect(
Promise.resolve(Object.keys(wrappedResources))
).resolves.toStrictEqual(['wrapMe1', 'wrapMe2']);
});
it(`should wrap wrapMe1 js method and return 100`, async function () {
const expectedResult = 100;
await expect(ask(`ask(call(get('wrapMe1')))`)).resolves.toStrictEqual(
expectedResult
);
});
it(`should wrap wrapMe2 js method and return arg`, async function () {
const expectedResult = 'arg';
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe using a different string than 'arg' would be better, so that it's not the same as the variable name.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed

await expect(
pkarw marked this conversation as resolved.
Show resolved Hide resolved
ask(`ask(call(get('wrapMe2'), 'arg'))`)
pkarw marked this conversation as resolved.
Show resolved Hide resolved
).resolves.toStrictEqual(expectedResult);
});
});