-
Notifications
You must be signed in to change notification settings - Fork 195
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
Add event handler #366
Open
davidlehn
wants to merge
5
commits into
main
Choose a base branch
from
events
base: main
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
Add event handler #366
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
3cf7dfb
Remove experimental protectedMode option.
davidlehn 32f481a
Add event handler.
davidlehn e84e691
Use events for language value warnings.
davidlehn 0478801
Change handleEvent option to eventHandler.
davidlehn 1ebcc1f
Use object spread.
davidlehn 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
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,92 @@ | ||
| /* | ||
| * Copyright (c) 2020 Digital Bazaar, Inc. All rights reserved. | ||
| */ | ||
| 'use strict'; | ||
|
|
||
| const JsonLdError = require('./JsonLdError'); | ||
|
|
||
| const { | ||
| isArray: _isArray | ||
| } = require('./types'); | ||
|
|
||
| const { | ||
| asArray: _asArray | ||
| } = require('./util'); | ||
|
|
||
| const api = {}; | ||
| module.exports = api; | ||
|
|
||
| /** | ||
| * Handle an event. | ||
| * | ||
| * Top level APIs have a common 'eventHandler' option. This option can be a | ||
| * function, array of functions, object mapping event.code to functions (with a | ||
| * default to call next()), or any combination of such handlers. Handlers will | ||
| * be called with an object with an 'event' entry and a 'next' function. Custom | ||
| * handlers should process the event as appropriate. The 'next()' function | ||
| * should be called to let the next handler process the event. | ||
| * | ||
| * The final default handler will use 'console.warn' for events of level | ||
| * 'warning'. | ||
| * | ||
| * @param {object} event - event structure: | ||
| * {string} code - event code | ||
| * {string} level - severity level, one of: ['warning'] | ||
| * {string} message - human readable message | ||
| * {object} details - event specific details | ||
| * @param {object} options - processing options | ||
| */ | ||
| api.handleEvent = ({ | ||
| event, | ||
| options | ||
| }) => { | ||
| const handlers = [].concat( | ||
| options.eventHandler ? _asArray(options.eventHandler) : [], | ||
| _defaultHandler | ||
| ); | ||
| _handle({event, handlers}); | ||
| }; | ||
|
|
||
| function _handle({event, handlers}) { | ||
| let doNext = true; | ||
| for(let i = 0; doNext && i < handlers.length; ++i) { | ||
| doNext = false; | ||
| const handler = handlers[i]; | ||
| if(_isArray(handler)) { | ||
| doNext = _handle({event, handlers: handler}); | ||
| } else if(typeof handler === 'function') { | ||
| handler({event, next: () => { | ||
| doNext = true; | ||
| }}); | ||
| } else if(typeof handler === 'object') { | ||
| if(event.code in handler) { | ||
| handler[event.code]({event, next: () => { | ||
| doNext = true; | ||
| }}); | ||
| } else { | ||
| doNext = true; | ||
| } | ||
| } else { | ||
| throw new JsonLdError( | ||
| 'Invalid event handler.', | ||
| 'jsonld.InvalidEventHandler', | ||
| {event}); | ||
| } | ||
| } | ||
| return doNext; | ||
| } | ||
|
|
||
| function _defaultHandler({event}) { | ||
| if(event.level === 'warning') { | ||
| console.warn(`WARNING: ${event.message}`, { | ||
| code: event.code, | ||
| details: event.details | ||
| }); | ||
| return; | ||
| } | ||
| // fallback to ensure events are handled somehow | ||
| throw new JsonLdError( | ||
| 'No handler for event.', | ||
| 'jsonld.UnhandledEvent', | ||
| {event}); | ||
| } |
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
Oops, something went wrong.
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.
What's an example where this would match? Looks like the above checks wouldn't allow
{"@reverse": "@foo"}or similar to get this far.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.
Previous checks don't specifically look at
@reverse, except to verify that it's a string.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.
It checks it's a string,
_expandIrisit, then_isAbsoluteIrichecks that. Seems like a keyword like string wouldn't get beyond those steps. Is there an example where it would?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.
Just created w3c/json-ld-api#389, as the order of checks was inverted.