jspurefix 5.11.1 → 5.11.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -1
- package/dist/buffer/fixml/fixml-parser.js +1 -1
- package/dist/buffer/fixml/fixml-parser.js.map +1 -1
- package/dist/config/empty-log-factory.d.ts +2 -2
- package/dist/config/empty-log-factory.js +1 -1
- package/dist/config/empty-log-factory.js.map +1 -1
- package/dist/config/get-js-fx-logger.d.ts +2 -2
- package/dist/config/get-js-fx-logger.js.map +1 -1
- package/dist/config/js-fix-logger-factory.d.ts +2 -2
- package/dist/config/js-fix-logger-factory.js.map +1 -1
- package/dist/config/js-fix-logger.d.ts +9 -8
- package/dist/config/js-fix-logger.js +4 -4
- package/dist/config/js-fix-logger.js.map +1 -1
- package/dist/config/js-fix-winston-log-factory.d.ts +2 -2
- package/dist/config/js-fix-winston-log-factory.js +2 -2
- package/dist/config/js-fix-winston-log-factory.js.map +1 -1
- package/dist/config/winston-logger.d.ts +5 -2
- package/dist/config/winston-logger.js +55 -9
- package/dist/config/winston-logger.js.map +1 -1
- package/dist/dictionary/fragment-safety.d.ts +26 -0
- package/dist/dictionary/fragment-safety.js +154 -0
- package/dist/dictionary/fragment-safety.js.map +1 -0
- package/dist/dictionary/index.d.ts +1 -0
- package/dist/dictionary/index.js +1 -0
- package/dist/dictionary/index.js.map +1 -1
- package/dist/runtime/make-config.js +1 -1
- package/dist/runtime/make-config.js.map +1 -1
- package/dist/runtime/session-launcher.js +1 -1
- package/dist/runtime/session-launcher.js.map +1 -1
- package/dist/sample/http/oms/http-client.js +1 -1
- package/dist/sample/http/oms/http-client.js.map +1 -1
- package/dist/sample/http/oms/http-server.js +1 -1
- package/dist/sample/http/oms/http-server.js.map +1 -1
- package/dist/sample/tcp/qf-md/md-client.js +1 -1
- package/dist/sample/tcp/qf-md/md-client.js.map +1 -1
- package/dist/sample/tcp/qf-md/md-server.js +1 -1
- package/dist/sample/tcp/qf-md/md-server.js.map +1 -1
- package/dist/sample/tcp/recovering-skeleton/respawn-acceptor.js +1 -1
- package/dist/sample/tcp/recovering-skeleton/respawn-acceptor.js.map +1 -1
- package/dist/sample/tcp/recovering-skeleton/skeleton-client.js +1 -1
- package/dist/sample/tcp/recovering-skeleton/skeleton-client.js.map +1 -1
- package/dist/sample/tcp/recovering-skeleton/skeleton-server.js +1 -1
- package/dist/sample/tcp/recovering-skeleton/skeleton-server.js.map +1 -1
- package/dist/sample/tcp/skeleton/skeleton-session.js +1 -1
- package/dist/sample/tcp/skeleton/skeleton-session.js.map +1 -1
- package/dist/sample/tcp/trade-capture/trade-capture-client.js +1 -1
- package/dist/sample/tcp/trade-capture/trade-capture-client.js.map +1 -1
- package/dist/sample/tcp/trade-capture/trade-capture-server.js +1 -1
- package/dist/sample/tcp/trade-capture/trade-capture-server.js.map +1 -1
- package/dist/store/fix-msg-memory-store.js +1 -1
- package/dist/store/fix-msg-memory-store.js.map +1 -1
- package/dist/transport/ascii/ascii-msg-transmitter.js +1 -1
- package/dist/transport/ascii/ascii-msg-transmitter.js.map +1 -1
- package/dist/transport/ascii/ascii-session.js +1 -1
- package/dist/transport/ascii/ascii-session.js.map +1 -1
- package/dist/transport/http/http-acceptor-listener.js +1 -1
- package/dist/transport/http/http-acceptor-listener.js.map +1 -1
- package/dist/transport/http/http-acceptor.js +2 -2
- package/dist/transport/http/http-acceptor.js.map +1 -1
- package/dist/transport/http/http-initiator.js +1 -1
- package/dist/transport/http/http-initiator.js.map +1 -1
- package/dist/transport/http/http-json-sample-adapter.js +1 -1
- package/dist/transport/http/http-json-sample-adapter.js.map +1 -1
- package/dist/transport/session/fix-session.js +3 -3
- package/dist/transport/session/fix-session.js.map +1 -1
- package/dist/transport/session/session-registry.js +1 -1
- package/dist/transport/session/session-registry.js.map +1 -1
- package/dist/transport/tcp/recovering-tcp-initiator.js +1 -1
- package/dist/transport/tcp/recovering-tcp-initiator.js.map +1 -1
- package/dist/transport/tcp/tcp-acceptor-listener.js +2 -2
- package/dist/transport/tcp/tcp-acceptor-listener.js.map +1 -1
- package/dist/transport/tcp/tcp-acceptor.js +2 -2
- package/dist/transport/tcp/tcp-acceptor.js.map +1 -1
- package/dist/transport/tcp/tcp-initiator-connector.js +2 -2
- package/dist/transport/tcp/tcp-initiator-connector.js.map +1 -1
- package/dist/transport/tcp/tcp-initiator.js +1 -1
- package/dist/transport/tcp/tcp-initiator.js.map +1 -1
- package/docs/instrumentation.md +346 -0
- package/docs/scattered-components.md +280 -0
- package/jsfix.test_client.txt +62 -62
- package/jsfix.test_server.txt +72 -72
- package/package.json +1 -1
- package/src/buffer/fixml/fixml-parser.ts +1 -1
- package/src/config/empty-log-factory.ts +2 -2
- package/src/config/get-js-fx-logger.ts +2 -2
- package/src/config/js-fix-logger-factory.ts +8 -2
- package/src/config/js-fix-logger.ts +23 -8
- package/src/config/js-fix-winston-log-factory.ts +3 -3
- package/src/config/winston-logger.ts +85 -10
- package/src/dictionary/fragment-safety.ts +225 -0
- package/src/dictionary/index.ts +1 -0
- package/src/runtime/make-config.ts +1 -1
- package/src/runtime/session-launcher.ts +1 -1
- package/src/sample/http/oms/http-client.ts +1 -1
- package/src/sample/http/oms/http-server.ts +1 -1
- package/src/sample/tcp/qf-md/md-client.ts +1 -1
- package/src/sample/tcp/qf-md/md-server.ts +1 -1
- package/src/sample/tcp/recovering-skeleton/respawn-acceptor.ts +2 -1
- package/src/sample/tcp/recovering-skeleton/skeleton-client.ts +1 -1
- package/src/sample/tcp/recovering-skeleton/skeleton-server.ts +1 -1
- package/src/sample/tcp/skeleton/skeleton-session.ts +1 -1
- package/src/sample/tcp/trade-capture/trade-capture-client.ts +2 -1
- package/src/sample/tcp/trade-capture/trade-capture-server.ts +2 -1
- package/src/store/fix-msg-memory-store.ts +2 -1
- package/src/transport/ascii/ascii-msg-transmitter.ts +2 -1
- package/src/transport/ascii/ascii-session.ts +2 -1
- package/src/transport/http/http-acceptor-listener.ts +2 -1
- package/src/transport/http/http-acceptor.ts +2 -1
- package/src/transport/http/http-initiator.ts +2 -1
- package/src/transport/http/http-json-sample-adapter.ts +1 -1
- package/src/transport/session/fix-session.ts +2 -1
- package/src/transport/session/session-registry.ts +1 -1
- package/src/transport/tcp/recovering-tcp-initiator.ts +2 -1
- package/src/transport/tcp/tcp-acceptor-listener.ts +4 -2
- package/src/transport/tcp/tcp-acceptor.ts +2 -1
- package/src/transport/tcp/tcp-initiator-connector.ts +4 -2
- package/src/transport/tcp/tcp-initiator.ts +2 -1
package/package.json
CHANGED
|
@@ -37,7 +37,7 @@ export class FiXmlParser extends MsgParser {
|
|
|
37
37
|
this.definitions = this.config.definitions
|
|
38
38
|
const description = config.description
|
|
39
39
|
const me = description?.application?.name
|
|
40
|
-
this.logger = config.logFactory.logger(`${me}:FiXmlParser
|
|
40
|
+
this.logger = config.logFactory.logger(`${me}:FiXmlParser`, { component: 'FixmlParser', app: me })
|
|
41
41
|
this.saxStream = require('sax').createStream(true, {})
|
|
42
42
|
this.locations = new Tags(maxMessageLocations)
|
|
43
43
|
this.logger.info('subscribe to stream')
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { EmptyLogger, IJsFixLogger } from './js-fix-logger'
|
|
1
|
+
import { EmptyLogger, IJsFixLogger, JsFixLogFields } from './js-fix-logger'
|
|
2
2
|
import { JsFixLoggerFactory } from './js-fix-logger-factory'
|
|
3
3
|
|
|
4
4
|
export class EmptyLogFactory extends JsFixLoggerFactory {
|
|
5
|
-
public logger (type: string): IJsFixLogger {
|
|
5
|
+
public logger (type: string, _?: JsFixLogFields): IJsFixLogger {
|
|
6
6
|
return new EmptyLogger(type)
|
|
7
7
|
}
|
|
8
8
|
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
import { IJsFixLogger } from './js-fix-logger'
|
|
1
|
+
import { IJsFixLogger, JsFixLogFields } from './js-fix-logger'
|
|
2
2
|
|
|
3
|
-
export type GetJsFixLogger = (type: string) => IJsFixLogger
|
|
3
|
+
export type GetJsFixLogger = (type: string, context?: JsFixLogFields) => IJsFixLogger
|
|
@@ -1,6 +1,12 @@
|
|
|
1
|
-
import { IJsFixLogger } from './js-fix-logger'
|
|
1
|
+
import { IJsFixLogger, JsFixLogFields } from './js-fix-logger'
|
|
2
2
|
|
|
3
3
|
export abstract class JsFixLoggerFactory {
|
|
4
|
-
|
|
4
|
+
/**
|
|
5
|
+
* @param type the legacy display name, e.g. 'me:peer:FixSession'. it is what the
|
|
6
|
+
* console format renders between brackets, so it is passed verbatim and unchanged
|
|
7
|
+
* @param context fields bound to every line this logger writes. an implementation
|
|
8
|
+
* written before this argument existed keeps compiling and simply ignores it
|
|
9
|
+
*/
|
|
10
|
+
public abstract logger (type: string, context?: JsFixLogFields): IJsFixLogger
|
|
5
11
|
public abstract plain (fileName: string, maxSize?: number): IJsFixLogger
|
|
6
12
|
}
|
|
@@ -1,27 +1,42 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* structured fields carried alongside a log message.
|
|
3
|
+
*
|
|
4
|
+
* two kinds travel through the same shape. *context* is bound once when a logger is made
|
|
5
|
+
* and repeats on every line it writes - the component, the application, the counterparty.
|
|
6
|
+
* *fields* are supplied per call and carry a value worth aggregating on - a msgType, a
|
|
7
|
+
* sequence number, a byte count.
|
|
8
|
+
*
|
|
9
|
+
* they are deliberately kept as a bag rather than spread into the log record, so a caller
|
|
10
|
+
* passing { message: ... } cannot clobber the real message, and so the choice of how to
|
|
11
|
+
* render them belongs to the formatter rather than the engine. see
|
|
12
|
+
* docs/instrumentation.md.
|
|
13
|
+
*/
|
|
14
|
+
export type JsFixLogFields = Record<string, unknown>
|
|
15
|
+
|
|
1
16
|
export interface IJsFixLogger {
|
|
2
|
-
info: (message: string) => void
|
|
3
|
-
warning: (message: string) => void
|
|
4
|
-
debug: (message: string) => void
|
|
5
|
-
error: (e: Error) => void
|
|
17
|
+
info: (message: string, fields?: JsFixLogFields) => void
|
|
18
|
+
warning: (message: string, fields?: JsFixLogFields) => void
|
|
19
|
+
debug: (message: string, fields?: JsFixLogFields) => void
|
|
20
|
+
error: (e: Error, fields?: JsFixLogFields) => void
|
|
6
21
|
}
|
|
7
22
|
|
|
8
23
|
export class EmptyLogger implements IJsFixLogger {
|
|
9
24
|
constructor (public readonly type: string = '') {
|
|
10
25
|
}
|
|
11
26
|
|
|
12
|
-
public info (_: string): void {
|
|
27
|
+
public info (_: string, __?: JsFixLogFields): void {
|
|
13
28
|
// nothing
|
|
14
29
|
}
|
|
15
30
|
|
|
16
|
-
public warning (_: string): void {
|
|
31
|
+
public warning (_: string, __?: JsFixLogFields): void {
|
|
17
32
|
// nothing
|
|
18
33
|
}
|
|
19
34
|
|
|
20
|
-
public debug (_: string): void {
|
|
35
|
+
public debug (_: string, __?: JsFixLogFields): void {
|
|
21
36
|
// nothing
|
|
22
37
|
}
|
|
23
38
|
|
|
24
|
-
public error (_: Error): void {
|
|
39
|
+
public error (_: Error, __?: JsFixLogFields): void {
|
|
25
40
|
// nothing
|
|
26
41
|
}
|
|
27
42
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { IJsFixLogger } from './js-fix-logger'
|
|
1
|
+
import { IJsFixLogger, JsFixLogFields } from './js-fix-logger'
|
|
2
2
|
import { WinstonLogger } from './winston-logger'
|
|
3
3
|
import { JsFixLoggerFactory } from './js-fix-logger-factory'
|
|
4
4
|
|
|
@@ -10,8 +10,8 @@ export class JsFixWinstonLogFactory extends JsFixLoggerFactory {
|
|
|
10
10
|
this.wl = new WinstonLogger(options)
|
|
11
11
|
}
|
|
12
12
|
|
|
13
|
-
public logger (type: string): IJsFixLogger {
|
|
14
|
-
return this.wl.make(type)
|
|
13
|
+
public logger (type: string, context?: JsFixLogFields): IJsFixLogger {
|
|
14
|
+
return this.wl.make(type, context)
|
|
15
15
|
}
|
|
16
16
|
|
|
17
17
|
public plain (fileName: string, maxSize?: number): IJsFixLogger {
|
|
@@ -1,9 +1,15 @@
|
|
|
1
|
-
import { IJsFixLogger } from './js-fix-logger'
|
|
1
|
+
import { IJsFixLogger, JsFixLogFields } from './js-fix-logger'
|
|
2
2
|
import { Logger } from 'winston'
|
|
3
3
|
const { createLogger, format, transports } = require('winston')
|
|
4
4
|
const { combine, timestamp, printf } = format
|
|
5
5
|
|
|
6
6
|
export class WinstonLogger {
|
|
7
|
+
/**
|
|
8
|
+
* the format this engine has emitted since it shipped. it names exactly four fields, so
|
|
9
|
+
* the context and fields bags added later are invisible to it and the rendered line is
|
|
10
|
+
* unchanged - which is the whole reason they travel as separate keys. covered by a
|
|
11
|
+
* golden output test; do not widen it.
|
|
12
|
+
*/
|
|
7
13
|
public static readonly appFormat = printf((info: any) => {
|
|
8
14
|
return `${info.timestamp} [${info.type}] ${info.level}: ${info.message}`
|
|
9
15
|
})
|
|
@@ -12,6 +18,38 @@ export class WinstonLogger {
|
|
|
12
18
|
return `${info.message}`
|
|
13
19
|
})
|
|
14
20
|
|
|
21
|
+
/**
|
|
22
|
+
* flattens the context and fields bags to ECS style names for Filebeat and friends.
|
|
23
|
+
*
|
|
24
|
+
* this MUST mutate info rather than return a fresh object - a new object loses
|
|
25
|
+
* Symbol.for('level') and winston then discards the record with no output and no error.
|
|
26
|
+
*/
|
|
27
|
+
public static readonly ecsFormat = format((info: any) => {
|
|
28
|
+
const context = info.context ?? {}
|
|
29
|
+
const fields = info.fields ?? {}
|
|
30
|
+
const err = info.err
|
|
31
|
+
delete info.context
|
|
32
|
+
delete info.fields
|
|
33
|
+
delete info.err
|
|
34
|
+
// the legacy display name is redundant once component and app are real fields
|
|
35
|
+
delete info.type
|
|
36
|
+
info['@timestamp'] = info.timestamp
|
|
37
|
+
info['log.level'] = info.level
|
|
38
|
+
info['service.name'] = 'jspurefix'
|
|
39
|
+
delete info.timestamp
|
|
40
|
+
if (err) {
|
|
41
|
+
info['error.message'] = err.message
|
|
42
|
+
info['error.stack_trace'] = err.stack
|
|
43
|
+
}
|
|
44
|
+
for (const key of Object.keys(context)) {
|
|
45
|
+
info[`fix.${key}`] = context[key]
|
|
46
|
+
}
|
|
47
|
+
for (const key of Object.keys(fields)) {
|
|
48
|
+
info[`fix.${key}`] = fields[key]
|
|
49
|
+
}
|
|
50
|
+
return info
|
|
51
|
+
})
|
|
52
|
+
|
|
15
53
|
private readonly appLogger: Logger
|
|
16
54
|
|
|
17
55
|
constructor (public readonly options: any = WinstonLogger.consoleOptions()) {
|
|
@@ -31,6 +69,32 @@ export class WinstonLogger {
|
|
|
31
69
|
}
|
|
32
70
|
}
|
|
33
71
|
|
|
72
|
+
/**
|
|
73
|
+
* one JSON object per line, ECS style names, ready to be harvested. opt in - the
|
|
74
|
+
* console default is deliberately left alone so an upgrade does not move anyone's logs.
|
|
75
|
+
*/
|
|
76
|
+
public static ecsOptions (level: string = 'debug'): any {
|
|
77
|
+
return {
|
|
78
|
+
format: combine(
|
|
79
|
+
timestamp(),
|
|
80
|
+
WinstonLogger.ecsFormat(),
|
|
81
|
+
format.json()
|
|
82
|
+
),
|
|
83
|
+
level,
|
|
84
|
+
transports: [
|
|
85
|
+
new transports.Console()
|
|
86
|
+
]
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
public static ecsFileOptions (fileName: string, level: string = 'debug', maxSize: number = 50 * 1024 * 1024): any {
|
|
91
|
+
return WinstonLogger.fileOptions(fileName, level, maxSize, combine(
|
|
92
|
+
timestamp(),
|
|
93
|
+
WinstonLogger.ecsFormat(),
|
|
94
|
+
format.json()
|
|
95
|
+
))
|
|
96
|
+
}
|
|
97
|
+
|
|
34
98
|
public static fileOptions (fileName: string, level: string = 'debug', maxSize: number = 50 * 1024 * 1024, format: any = combine(
|
|
35
99
|
timestamp(),
|
|
36
100
|
WinstonLogger.appFormat
|
|
@@ -82,31 +146,42 @@ export class WinstonLogger {
|
|
|
82
146
|
} as IJsFixLogger
|
|
83
147
|
}
|
|
84
148
|
|
|
85
|
-
public make (type: string): IJsFixLogger {
|
|
149
|
+
public make (type: string, context?: JsFixLogFields): IJsFixLogger {
|
|
86
150
|
const logger = this.appLogger
|
|
87
151
|
return {
|
|
88
|
-
info: function (msg: string): void {
|
|
152
|
+
info: function (msg: string, fields?: JsFixLogFields): void {
|
|
89
153
|
logger.info({
|
|
90
154
|
type,
|
|
91
|
-
message: msg
|
|
155
|
+
message: msg,
|
|
156
|
+
context,
|
|
157
|
+
fields
|
|
92
158
|
})
|
|
93
159
|
},
|
|
94
|
-
debug: function (msg: string): void {
|
|
160
|
+
debug: function (msg: string, fields?: JsFixLogFields): void {
|
|
95
161
|
logger.debug({
|
|
96
162
|
type,
|
|
97
|
-
message: msg
|
|
163
|
+
message: msg,
|
|
164
|
+
context,
|
|
165
|
+
fields
|
|
98
166
|
})
|
|
99
167
|
},
|
|
100
|
-
warning: function (msg: string): void {
|
|
168
|
+
warning: function (msg: string, fields?: JsFixLogFields): void {
|
|
101
169
|
logger.warn({
|
|
102
170
|
type,
|
|
103
|
-
message: msg
|
|
171
|
+
message: msg,
|
|
172
|
+
context,
|
|
173
|
+
fields
|
|
104
174
|
})
|
|
105
175
|
},
|
|
106
|
-
error: function (e: Error): void {
|
|
176
|
+
error: function (e: Error, fields?: JsFixLogFields): void {
|
|
107
177
|
logger.error({
|
|
108
178
|
type,
|
|
109
|
-
|
|
179
|
+
// composed exactly as it always has been, so the console line does not move.
|
|
180
|
+
// the ecs format lifts error.message and error.stack_trace off err instead
|
|
181
|
+
message: `${e.message} : ${e.stack}`,
|
|
182
|
+
err: e,
|
|
183
|
+
context,
|
|
184
|
+
fields
|
|
110
185
|
})
|
|
111
186
|
}
|
|
112
187
|
}
|
|
@@ -0,0 +1,225 @@
|
|
|
1
|
+
import {
|
|
2
|
+
ContainedComponentField,
|
|
3
|
+
ContainedField,
|
|
4
|
+
ContainedFieldType,
|
|
5
|
+
ContainedGroupField,
|
|
6
|
+
ContainedSimpleField,
|
|
7
|
+
IContainedSet
|
|
8
|
+
} from './contained'
|
|
9
|
+
import { FixDefinitions } from './definition'
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* Static analysis of a dictionary, asking one question: if a component's tags arrived
|
|
13
|
+
* scattered through a message rather than adjacently, could this dictionary still say
|
|
14
|
+
* unambiguously which component each tag belongs to?
|
|
15
|
+
*
|
|
16
|
+
* The segment parser normally answers that from *position* - a tag between the first and
|
|
17
|
+
* last tag of a component belongs to it. A counterparty that emits a component's tags
|
|
18
|
+
* non-adjacently breaks the inference, and the tags themselves become the only evidence
|
|
19
|
+
* left. That works whenever the children of one set own disjoint tags, which FIX's tag
|
|
20
|
+
* numbering conventions (Underlying*, Leg*, NestedParties2/3) exist to guarantee, but a
|
|
21
|
+
* house dictionary is under no obligation to honour them.
|
|
22
|
+
*
|
|
23
|
+
* See docs/scattered-components.md. Nothing in the engine consumes this yet - it is a
|
|
24
|
+
* diagnostic run against a dictionary to find out whether the assumption holds before any
|
|
25
|
+
* code is written that depends on it.
|
|
26
|
+
*/
|
|
27
|
+
|
|
28
|
+
export enum FragmentSafetyCode {
|
|
29
|
+
/**
|
|
30
|
+
* two children of one set both claim the same tag, so a scattered instance of either
|
|
31
|
+
* could not be attributed to one of them by tag alone
|
|
32
|
+
*/
|
|
33
|
+
SiblingTagCollision = 'sibling-tag-collision',
|
|
34
|
+
/**
|
|
35
|
+
* a component owns no tag at its own level, so a scattered instance leaves no evidence
|
|
36
|
+
* it was ever present
|
|
37
|
+
*/
|
|
38
|
+
UnclaimableComponent = 'unclaimable-component'
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
export interface IFragmentSafetyFinding {
|
|
42
|
+
readonly code: FragmentSafetyCode
|
|
43
|
+
/**
|
|
44
|
+
* dotted path to the set the finding is about, from the message it was first reached
|
|
45
|
+
* through e.g. 'NewOrderSingle.Instrument'
|
|
46
|
+
*/
|
|
47
|
+
readonly path: string
|
|
48
|
+
/**
|
|
49
|
+
* name of the set whose children collide, or of the unclaimable component
|
|
50
|
+
*/
|
|
51
|
+
readonly set: string
|
|
52
|
+
/**
|
|
53
|
+
* the contended tag, or 0 for an unclaimable component
|
|
54
|
+
*/
|
|
55
|
+
readonly tag: number
|
|
56
|
+
/**
|
|
57
|
+
* names of the children of `set` that each claim `tag`
|
|
58
|
+
*/
|
|
59
|
+
readonly owners: string[]
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
export function describeFinding (f: IFragmentSafetyFinding): string {
|
|
63
|
+
switch (f.code) {
|
|
64
|
+
case FragmentSafetyCode.SiblingTagCollision:
|
|
65
|
+
return `${f.path}: tag ${f.tag} is claimed by ${f.owners.join(' and ')}`
|
|
66
|
+
case FragmentSafetyCode.UnclaimableComponent:
|
|
67
|
+
return `${f.path}: owns no tag of its own`
|
|
68
|
+
default:
|
|
69
|
+
return f.path
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
export class FragmentSafety {
|
|
74
|
+
private readonly findings: IFragmentSafetyFinding[] = []
|
|
75
|
+
private readonly analysed = new Set<IContainedSet>()
|
|
76
|
+
private readonly owned = new Map<IContainedSet, number[]>()
|
|
77
|
+
|
|
78
|
+
/**
|
|
79
|
+
* tags a set can claim at its own level - its simple fields, the same from any
|
|
80
|
+
* component nested below it, and the NumInGroup tag of any group it contains.
|
|
81
|
+
*
|
|
82
|
+
* a group's *interior* is deliberately excluded. a repeating group is the one
|
|
83
|
+
* self describing construct in tag value FIX, so its instances are always delimiter
|
|
84
|
+
* framed and contiguous, and its member tags are never evidence about the level above.
|
|
85
|
+
* this is the same distinction `flattenedTag` does not draw.
|
|
86
|
+
*/
|
|
87
|
+
public ownTags (set: IContainedSet): number[] {
|
|
88
|
+
const memo = this.owned.get(set)
|
|
89
|
+
if (memo) return memo
|
|
90
|
+
// seed before recursing so a self referencing dictionary terminates
|
|
91
|
+
this.owned.set(set, [])
|
|
92
|
+
const tags: number[] = []
|
|
93
|
+
for (const field of set.fields) {
|
|
94
|
+
switch (field.type) {
|
|
95
|
+
case ContainedFieldType.Simple: {
|
|
96
|
+
tags.push((field as ContainedSimpleField).definition.tag)
|
|
97
|
+
break
|
|
98
|
+
}
|
|
99
|
+
case ContainedFieldType.Component: {
|
|
100
|
+
const cf = field as ContainedComponentField
|
|
101
|
+
for (const t of this.ownTags(cf.definition)) {
|
|
102
|
+
tags.push(t)
|
|
103
|
+
}
|
|
104
|
+
break
|
|
105
|
+
}
|
|
106
|
+
case ContainedFieldType.Group: {
|
|
107
|
+
const gf = field as ContainedGroupField
|
|
108
|
+
const nof = gf.definition.noOfField
|
|
109
|
+
if (nof) {
|
|
110
|
+
tags.push(nof.tag)
|
|
111
|
+
}
|
|
112
|
+
break
|
|
113
|
+
}
|
|
114
|
+
default:
|
|
115
|
+
break
|
|
116
|
+
}
|
|
117
|
+
}
|
|
118
|
+
this.owned.set(set, tags)
|
|
119
|
+
return tags
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
/**
|
|
123
|
+
* every message in the dictionary, and every component and group reachable from one,
|
|
124
|
+
* each analysed once however many messages reach it
|
|
125
|
+
*/
|
|
126
|
+
public static analyse (definitions: FixDefinitions): IFragmentSafetyFinding[] {
|
|
127
|
+
const instance = new FragmentSafety()
|
|
128
|
+
// the message map is keyed by name, msgType and abbreviation, so walk distinct sets
|
|
129
|
+
const seen = new Set<IContainedSet>()
|
|
130
|
+
for (const message of definitions.message.values()) {
|
|
131
|
+
if (seen.has(message)) continue
|
|
132
|
+
seen.add(message)
|
|
133
|
+
instance.walk(message, message.name)
|
|
134
|
+
}
|
|
135
|
+
return instance.findings
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
/**
|
|
139
|
+
* a single set and everything below it, for a dictionary fragment under test
|
|
140
|
+
*/
|
|
141
|
+
public static analyseSet (set: IContainedSet, path?: string): IFragmentSafetyFinding[] {
|
|
142
|
+
const instance = new FragmentSafety()
|
|
143
|
+
instance.walk(set, path ?? set.name)
|
|
144
|
+
return instance.findings
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
private walk (set: IContainedSet, path: string): void {
|
|
148
|
+
if (this.analysed.has(set)) return
|
|
149
|
+
this.analysed.add(set)
|
|
150
|
+
this.checkSiblings(set, path)
|
|
151
|
+
for (const field of set.fields) {
|
|
152
|
+
switch (field.type) {
|
|
153
|
+
case ContainedFieldType.Component: {
|
|
154
|
+
const cf = field as ContainedComponentField
|
|
155
|
+
this.checkClaimable(cf, `${path}.${cf.name}`)
|
|
156
|
+
this.walk(cf.definition, `${path}.${cf.name}`)
|
|
157
|
+
break
|
|
158
|
+
}
|
|
159
|
+
case ContainedFieldType.Group: {
|
|
160
|
+
// the instance body of a group is a level in its own right, and everything
|
|
161
|
+
// said about scattering above applies again inside it
|
|
162
|
+
const gf = field as ContainedGroupField
|
|
163
|
+
this.walk(gf.definition, `${path}.${gf.name}`)
|
|
164
|
+
break
|
|
165
|
+
}
|
|
166
|
+
default:
|
|
167
|
+
break
|
|
168
|
+
}
|
|
169
|
+
}
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
private checkClaimable (cf: ContainedComponentField, path: string): void {
|
|
173
|
+
if (this.ownTags(cf.definition).length > 0) return
|
|
174
|
+
this.findings.push({
|
|
175
|
+
code: FragmentSafetyCode.UnclaimableComponent,
|
|
176
|
+
path,
|
|
177
|
+
set: cf.name,
|
|
178
|
+
tag: 0,
|
|
179
|
+
owners: []
|
|
180
|
+
})
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
private checkSiblings (set: IContainedSet, path: string): void {
|
|
184
|
+
// tag -> the children of this set claiming it. a tag reaching two children is what
|
|
185
|
+
// makes a scattered instance unattributable
|
|
186
|
+
const claims = new Map<number, string[]>()
|
|
187
|
+
for (const field of set.fields) {
|
|
188
|
+
for (const tag of this.claimsOf(field)) {
|
|
189
|
+
const owners = claims.get(tag)
|
|
190
|
+
if (owners) {
|
|
191
|
+
if (!owners.includes(field.name)) {
|
|
192
|
+
owners.push(field.name)
|
|
193
|
+
}
|
|
194
|
+
} else {
|
|
195
|
+
claims.set(tag, [field.name])
|
|
196
|
+
}
|
|
197
|
+
}
|
|
198
|
+
}
|
|
199
|
+
for (const [tag, owners] of claims) {
|
|
200
|
+
if (owners.length < 2) continue
|
|
201
|
+
this.findings.push({
|
|
202
|
+
code: FragmentSafetyCode.SiblingTagCollision,
|
|
203
|
+
path,
|
|
204
|
+
set: set.name,
|
|
205
|
+
tag,
|
|
206
|
+
owners
|
|
207
|
+
})
|
|
208
|
+
}
|
|
209
|
+
}
|
|
210
|
+
|
|
211
|
+
private claimsOf (field: ContainedField): number[] {
|
|
212
|
+
switch (field.type) {
|
|
213
|
+
case ContainedFieldType.Simple:
|
|
214
|
+
return [(field as ContainedSimpleField).definition.tag]
|
|
215
|
+
case ContainedFieldType.Component:
|
|
216
|
+
return this.ownTags((field as ContainedComponentField).definition)
|
|
217
|
+
case ContainedFieldType.Group: {
|
|
218
|
+
const nof = (field as ContainedGroupField).definition.noOfField
|
|
219
|
+
return nof ? [nof.tag] : []
|
|
220
|
+
}
|
|
221
|
+
default:
|
|
222
|
+
return []
|
|
223
|
+
}
|
|
224
|
+
}
|
|
225
|
+
}
|
package/src/dictionary/index.ts
CHANGED
|
@@ -25,7 +25,7 @@ export class RuntimeFactory {
|
|
|
25
25
|
if (!type) reject(new Error('no application type in application object'))
|
|
26
26
|
this.definitionFactory.getDefinitions(path,
|
|
27
27
|
(t: string) => {
|
|
28
|
-
return this.logFactory.logger(`${type}.${t}
|
|
28
|
+
return this.logFactory.logger(`${type}.${t}`, { component: t, role: type })
|
|
29
29
|
}).then((definitions: FixDefinitions) => {
|
|
30
30
|
const config = new JsFixConfig(this.msgFactory, definitions, description, AsciiChars.Soh, this.logFactory)
|
|
31
31
|
resolve(config)
|
|
@@ -19,7 +19,7 @@ export abstract class SessionLauncher {
|
|
|
19
19
|
acceptorConfig: string | ISessionDescription | null = null,
|
|
20
20
|
private readonly loggerFactory: JsFixLoggerFactory = defaultLoggerFactory
|
|
21
21
|
) {
|
|
22
|
-
this.logger = this.loggerFactory.logger('launcher')
|
|
22
|
+
this.logger = this.loggerFactory.logger('launcher', { component: 'SessionLauncher' })
|
|
23
23
|
this.initiatorConfig = initiatorConfig ? this.loadConfig(initiatorConfig) : null
|
|
24
24
|
this.acceptorConfig = acceptorConfig ? this.loadConfig(acceptorConfig) : null
|
|
25
25
|
}
|
|
@@ -16,7 +16,7 @@ export class HttpClient extends FixmlSession {
|
|
|
16
16
|
super(config)
|
|
17
17
|
this.logReceivedMsgs = true
|
|
18
18
|
this.fixLog = config.logFactory.plain(`jsfix.${config?.description?.application?.name}.txt`)
|
|
19
|
-
this.logger = config.logFactory.logger(`${this.me}
|
|
19
|
+
this.logger = config.logFactory.logger(`${this.me}`, { component: 'HttpClient', app: this.me })
|
|
20
20
|
}
|
|
21
21
|
|
|
22
22
|
protected onApplicationMsg (msgType: string, view: MsgView): void {
|
|
@@ -16,7 +16,7 @@ export class HttpServer extends FixmlSession {
|
|
|
16
16
|
super(config)
|
|
17
17
|
this.logReceivedMsgs = true
|
|
18
18
|
this.fixLog = config.logFactory.plain(`jsfix.${config?.description?.application?.name}.txt`)
|
|
19
|
-
this.logger = config.logFactory.logger(`${this.me}
|
|
19
|
+
this.logger = config.logFactory.logger(`${this.me}`, { component: 'HttpServer', app: this.me })
|
|
20
20
|
}
|
|
21
21
|
|
|
22
22
|
protected onApplicationMsg (msgType: string, view: MsgView): void {
|
|
@@ -16,7 +16,7 @@ export class MDClient extends AsciiSession {
|
|
|
16
16
|
super(config)
|
|
17
17
|
this.logReceivedMsgs = true
|
|
18
18
|
this.fixLog = config.logFactory.plain(`jsfix.${config?.description?.application?.name}.txt`)
|
|
19
|
-
this.logger = config.logFactory.logger(`${this.me}:MDClient
|
|
19
|
+
this.logger = config.logFactory.logger(`${this.me}:MDClient`, { component: 'MDClient', app: this.me })
|
|
20
20
|
}
|
|
21
21
|
|
|
22
22
|
protected onApplicationMsg (_: string, view: MsgView): void {
|
|
@@ -16,7 +16,7 @@ export class MDServer extends AsciiSession {
|
|
|
16
16
|
constructor (@inject('IJsFixConfig') public readonly config: IJsFixConfig) {
|
|
17
17
|
super(config)
|
|
18
18
|
this.logReceivedMsgs = true
|
|
19
|
-
this.logger = config.logFactory.logger(`${this.me}:MDServer
|
|
19
|
+
this.logger = config.logFactory.logger(`${this.me}:MDServer`, { component: 'MDServer', app: this.me })
|
|
20
20
|
this.fixLog = config.logFactory.plain(`jsfix.${config?.description?.application?.name}.txt`)
|
|
21
21
|
}
|
|
22
22
|
|
|
@@ -13,7 +13,8 @@ export class RespawnAcceptor extends FixEntity {
|
|
|
13
13
|
|
|
14
14
|
constructor (@inject('IJsFixConfig') public readonly config: IJsFixConfig) {
|
|
15
15
|
super(config)
|
|
16
|
-
this.logger = config.logFactory.logger('RespawnAcceptor'
|
|
16
|
+
this.logger = config.logFactory.logger('RespawnAcceptor',
|
|
17
|
+
{ component: 'RespawnAcceptor', role: 'acceptor' })
|
|
17
18
|
}
|
|
18
19
|
|
|
19
20
|
// if acceptor errors e.g. via a forced connection drop, then respawn
|
|
@@ -13,7 +13,7 @@ export class SkeletonClient extends AsciiSession {
|
|
|
13
13
|
super(config)
|
|
14
14
|
this.logReceivedMsgs = true
|
|
15
15
|
this.fixLog = config.logFactory.plain(`jsfix.${config?.description?.application?.name}.txt`)
|
|
16
|
-
this.logger = config.logFactory.logger(`${this.me}
|
|
16
|
+
this.logger = config.logFactory.logger(`${this.me}`, { component: 'SkeletonClient', app: this.me })
|
|
17
17
|
}
|
|
18
18
|
|
|
19
19
|
protected onApplicationMsg (msgType: string, view: MsgView): void {
|
|
@@ -13,7 +13,7 @@ export class SkeletonServer extends AsciiSession {
|
|
|
13
13
|
super(config)
|
|
14
14
|
this.logReceivedMsgs = true
|
|
15
15
|
this.fixLog = config.logFactory.plain(`jsfix.${config?.description?.application?.name}.txt`)
|
|
16
|
-
this.logger = config.logFactory.logger(`${this.me}
|
|
16
|
+
this.logger = config.logFactory.logger(`${this.me}`, { component: 'SkeletonServer', app: this.me })
|
|
17
17
|
}
|
|
18
18
|
|
|
19
19
|
protected onApplicationMsg (msgType: string, _: MsgView): void {
|
|
@@ -17,7 +17,7 @@ export class SkeletonSession extends AsciiSession {
|
|
|
17
17
|
super(config)
|
|
18
18
|
this.logReceivedMsgs = true
|
|
19
19
|
this.fixLog = config.logFactory.plain(`jsfix.${config?.description?.application?.name}.txt`)
|
|
20
|
-
this.logger = config.logFactory.logger(`${this.me}
|
|
20
|
+
this.logger = config.logFactory.logger(`${this.me}`, { component: 'SkeletonSession', app: this.me })
|
|
21
21
|
}
|
|
22
22
|
|
|
23
23
|
protected onApplicationMsg (msgType: string, view: MsgView): void {
|
|
@@ -18,7 +18,8 @@ export class TradeCaptureClient extends AsciiSession {
|
|
|
18
18
|
this.logReceivedMsgs = true
|
|
19
19
|
this.reports = new Map<string, ITradeCaptureReport>()
|
|
20
20
|
this.fixLog = config.logFactory.plain(`jsfix.${config?.description?.application?.name}.txt`)
|
|
21
|
-
this.logger = config.logFactory.logger(`${this.me}:TradeCaptureClient
|
|
21
|
+
this.logger = config.logFactory.logger(`${this.me}:TradeCaptureClient`,
|
|
22
|
+
{ component: 'TradeCaptureClient', app: this.me })
|
|
22
23
|
}
|
|
23
24
|
|
|
24
25
|
protected onApplicationMsg (msgType: string, view: MsgView): void {
|
|
@@ -18,7 +18,8 @@ export class TradeCaptureServer extends AsciiSession {
|
|
|
18
18
|
constructor (public readonly config: IJsFixConfig) {
|
|
19
19
|
super(config)
|
|
20
20
|
this.logReceivedMsgs = true
|
|
21
|
-
this.logger = config.logFactory.logger(`${this.me}:TradeCaptureServer
|
|
21
|
+
this.logger = config.logFactory.logger(`${this.me}:TradeCaptureServer`,
|
|
22
|
+
{ component: 'TradeCaptureServer', app: this.me })
|
|
22
23
|
this.fixLog = config.logFactory.plain(`jsfix.${config?.description?.application?.name}.txt`)
|
|
23
24
|
}
|
|
24
25
|
|
|
@@ -20,7 +20,8 @@ export class FixMsgMemoryStore implements IFixMsgStore {
|
|
|
20
20
|
]
|
|
21
21
|
|
|
22
22
|
public constructor (public readonly id: string, public readonly config: IJsFixConfig) {
|
|
23
|
-
this.logger = config.logFactory.logger(`${this.id}:FixMsgMemoryStore
|
|
23
|
+
this.logger = config.logFactory.logger(`${this.id}:FixMsgMemoryStore`,
|
|
24
|
+
{ component: 'FixMsgMemoryStore', store: this.id })
|
|
24
25
|
this.setExcMsgType([])
|
|
25
26
|
}
|
|
26
27
|
|
|
@@ -39,7 +39,8 @@ export class AsciiMsgTransmitter extends MsgTransmitter {
|
|
|
39
39
|
*/
|
|
40
40
|
private reportUnknownFields (config: IJsFixConfig): void {
|
|
41
41
|
const name = config.description.application?.name ?? 'na'
|
|
42
|
-
const logger = config.logFactory.logger(`${name}:encoder
|
|
42
|
+
const logger = config.logFactory.logger(`${name}:encoder`,
|
|
43
|
+
{ component: 'AsciiMsgTransmitter', app: name })
|
|
43
44
|
const reported = new Set<string>()
|
|
44
45
|
this.encoder.onUnknownField = (fieldName: string, setName: string) => {
|
|
45
46
|
const key = `${setName}.${fieldName}`
|
|
@@ -662,7 +662,8 @@ export abstract class AsciiSession extends FixSession {
|
|
|
662
662
|
|
|
663
663
|
// every session on a wildcard listener shared one logger name until now, which
|
|
664
664
|
// makes a multi-client server log impossible to follow
|
|
665
|
-
this.sessionLogger = this.config.logFactory.logger(`${this.me}:${peerCompId}:FixSession
|
|
665
|
+
this.sessionLogger = this.config.logFactory.logger(`${this.me}:${peerCompId}:FixSession`,
|
|
666
|
+
{ component: 'FixSession', app: this.me, peer: peerCompId })
|
|
666
667
|
|
|
667
668
|
this.sessionId = new SessionId(
|
|
668
669
|
this.config.description.BeginString,
|
|
@@ -15,7 +15,8 @@ export class HttpAcceptorListener extends FixEntity {
|
|
|
15
15
|
|
|
16
16
|
async start (): Promise<any> {
|
|
17
17
|
return new Promise<any>(async (resolve, reject) => {
|
|
18
|
-
const logger = this.config.logFactory.logger('acceptor'
|
|
18
|
+
const logger = this.config.logFactory.logger('acceptor',
|
|
19
|
+
{ component: 'HttpAcceptorListener', role: 'acceptor' })
|
|
19
20
|
const sessionContainer = this.config.sessionContainer
|
|
20
21
|
if (!sessionContainer.isRegistered(DITokens.FixSession)) {
|
|
21
22
|
reject(new Error(`application must register a DI token '${DITokens.FixSession}' - see src/sample`))
|