-
Notifications
You must be signed in to change notification settings - Fork 29
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
pkarw
wants to merge
2
commits into
master
Choose a base branch
from
issue_580_limited_js_calls_from_askcript
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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; | ||
} |
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
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
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'; | ||
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); | ||
}); | ||
}); |
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed