feat(client): introduce extensible YAML config #2329
Conversation
fortuna
force-pushed
the
fortuna-go-config
branch
from
2de4bea to
1093e52
Compare
|
|
||
| import * as errors from '../../model/errors'; | ||
|
|
||
| export const TEST_ONLY = { | ||
| parseAccessKey: parseAccessKey, | ||
| getAddressFromTransportConfig: getAddressFromTransportConfig, |
There was a problem hiding this comment.
I'm not a big fan of exporting private functions just for testing if there are alternatives; it should be a last resort. Can you not test the same functionality through the "public API" with the exported parseTunnelConfig()?
Also it seems parseAccessKey and serviceNameFromAccessKey can be removed from this object.
There was a problem hiding this comment.
JS/TS are terrible languages that don't provide a way to expose private methods to tests.
This is a workaround I found in go/typescript-testing#export-visibility
I use parseAccessKey in the tests, but I removed the other two.
There was a problem hiding this comment.
I know the workaround, I'm asking why you need it. Why can't you test the public APIs only for this scenario?
There was a problem hiding this comment.
You are right. The method I'm testing is exported, so I don't need TEST_ONLY. Removed.
I wrote and rewrote this code so many times that I lost track of things!
|
@sbruens @jyyi1 here is an attempt to document the config format. Please let me know how I can improve it: https://github.com/Jigsaw-Code/outline-apps/blob/fortuna-go-config/client/config.md |
client/config.md
Outdated
| ### <a id=TunnelConfig></a>TunnelConfig | ||
| This is the format of the configuration returned by [Dynamic Access Keys](https://www.reddit.com/r/outlinevpn/wiki/index/dynamic_access_keys/). | ||
|
|
||
| Format: [TunnelConfig](#TunnelConfig) | [LegacyShadowsocksConfig](#LegacyShadowsocksConfig) | [LegacyShadowsocksURL](#LegacyShadowsocksURL) |
There was a problem hiding this comment.
Maybe call it URI to align with the SIP standard?
| Format: [TunnelConfig](#TunnelConfig) | [LegacyShadowsocksConfig](#LegacyShadowsocksConfig) | [LegacyShadowsocksURL](#LegacyShadowsocksURL) | |
| Format: [TunnelConfig](#TunnelConfig) | [LegacyShadowsocksConfig](#LegacyShadowsocksConfig) | [LegacyShadowsocksURI](#LegacyShadowsocksURI) |
| firstHop = streamFirstHop | ||
| } | ||
| return &InvokeMethodResult{ | ||
| Value: firstHop, |
There was a problem hiding this comment.
Shall we return an error here or just the empty result?
There was a problem hiding this comment.
Not having a shared first hop is not really an error. We just won't have something to show. Perhaps firsthHop should be a struct instead, and we could show both.
Without the struct, people won't be able to use separate endpoints for tcp and udp on Windows, even if they are on the same IP, because we don't have the IP returned
| provider := newTestProvider() | ||
|
|
||
| node, err := ParseConfigYAML(` | ||
| $type: ss |
client/go/outline/config/parse.go
Outdated
| ) | ||
|
|
||
| // ConfigParserKey is the config key used to specify the parser to use to parse an object. | ||
| const ConfigParserKey = "$parser" |
There was a problem hiding this comment.
Should this be $parser or $type? The document says $type.
|
|
||
| import * as errors from '../../model/errors'; | ||
|
|
||
| export const TEST_ONLY = { | ||
| parseAccessKey: parseAccessKey, | ||
| getAddressFromTransportConfig: getAddressFromTransportConfig, |
There was a problem hiding this comment.
You are right. The method I'm testing is exported, so I don't need TEST_ONLY. Removed.
I wrote and rewrote this code so many times that I lost track of things!
client/config.md
Outdated
| ### <a id=TunnelConfig></a>TunnelConfig | ||
| This is the format of the configuration returned by [Dynamic Access Keys](https://www.reddit.com/r/outlinevpn/wiki/index/dynamic_access_keys/). | ||
|
|
||
| Format: [TunnelConfig](#TunnelConfig) | [LegacyShadowsocksConfig](#LegacyShadowsocksConfig) | [LegacyShadowsocksURL](#LegacyShadowsocksURL) |
This is part 2 of #2306.
TODO:
$parserand$type