opensensemap/blockly-app
1
0
Fork 0
mirror of https://github.com/sensebox/blockly-app synced 2025-04-25 22:00:32 +02:00
Code Issues Releases Wiki Activity

add some more comments

Browse source
This commit is contained in:
Norwin 2019-03-29 18:02:17 +01:00
parent c37be90325
commit 2ab13932d3
2 changed files with 14 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
src/pages/blockly/blockly_protocol.ts
View file

@ -10,7 +10,16 @@ import { LoggingProvider } from '../../providers/logging/logging';
export class BlocklyMessageProtocol { export class BlocklyMessageProtocol {
ready: Promise<void> ready: Promise<void>
// defines the expected response type for each request type
private reqResPatterns: BlocklyReqPatterns = {
'getSketch': 'sketch',
'getXml': 'xml',
'setXml': null,
'toggleView': null,
}
constructor (private blocklyFrame: ElementRef, private log: LoggingProvider) { constructor (private blocklyFrame: ElementRef, private log: LoggingProvider) {
// set up event listeners for non-request log messages
window.addEventListener('message', (ev: IframePostMessageEvent) => { window.addEventListener('message', (ev: IframePostMessageEvent) => {
if (ev.data.type === 'log') if (ev.data.type === 'log')
this.log.warn('log entry from blockly:', ev.data) this.log.warn('log entry from blockly:', ev.data)
@ -18,6 +27,7 @@ export class BlocklyMessageProtocol {
this.log.debug(`received ${ev.data.type} message from blockly`, { message: ev.data }) this.log.debug(`received ${ev.data.type} message from blockly`, { message: ev.data })
}) })
// resolve ready promise once the blocklyFrame is ready
this.ready = new Promise(resolve => { this.ready = new Promise(resolve => {
window.addEventListener('message', (ev: IframePostMessageEvent) => { window.addEventListener('message', (ev: IframePostMessageEvent) => {
// @HACK @FIXME: timeout is required, as blockly resolves some async functions // @HACK @FIXME: timeout is required, as blockly resolves some async functions
@ -27,13 +37,6 @@ export class BlocklyMessageProtocol {
}) })
} }
private reqResPatterns: BlocklyReqPatterns = {
'getSketch': 'sketch',
'getXml': 'xml',
'setXml': null,
'toggleView': null,
}
toggleView() { this.sendRequest({ type: 'toggleView' }) } toggleView() { this.sendRequest({ type: 'toggleView' }) }
setXml(data: string) { this.sendRequest({ type: 'setXml', data }) } setXml(data: string) { this.sendRequest({ type: 'setXml', data }) }

4
src/providers/logging/logging.ts
View file

@ -38,6 +38,8 @@ export class LoggingProvider {
} }
} }
// construct a new logger with a new component name and default fields,
// inheriting existing default fields
createChild (component: string, defaultFields: object = {}) { createChild (component: string, defaultFields: object = {}) {
const child = new LoggingProvider(this.http, this.plt, this.storage, this.translate) const child = new LoggingProvider(this.http, this.plt, this.storage, this.translate)
Object.assign(child.defaultFields, defaultFields, { component }) Object.assign(child.defaultFields, defaultFields, { component })
@ -72,6 +74,7 @@ export class LoggingProvider {
const logentry = { } as LogMessage const logentry = { } as LogMessage
let msg = '' let msg = ''
// fields can be strings, which are appended to the message; or objects, which are merged.
for (const param of fields) { for (const param of fields) {
if (typeof param === 'object') if (typeof param === 'object')
Object.assign(logentry, param) Object.assign(logentry, param)
@ -82,6 +85,7 @@ export class LoggingProvider {
if (msg) if (msg)
logentry.msg = msg logentry.msg = msg
// add the static and dynamic default fields
Object.assign(logentry, this.defaultFields, { Object.assign(logentry, this.defaultFields, {
time: new Date().toISOString(), time: new Date().toISOString(),
levelText: LogLevel[level], levelText: LogLevel[level],