infra: add support for decoding configuration hostnames from SDK keys… #252
Conversation
| @@ -1,27 +1,70 @@ | |||
| import { Base64 } from 'js-base64'; | |||
|
|
|||
| const PATH = 'v0/i'; | |||
| const EVENT_INGESTION_HOSTNAME_KEY = 'eh'; | |||
| const CONFIGURATION_HOSTNAME_KEY = 'ch'; | |||
There was a problem hiding this comment.
@typotter Since I got here first 😉 , I selected ch (for configuration host). Please reflect this with the server changes.
| /** | ||
| * Decodes and returns the configuration hostname from the provided Eppo SDK key string. | ||
| * If the SDK key doesn't contain the configuration hostname, or it's invalid, it returns null. | ||
| */ | ||
| decodeAssignmentConfigurationUrl(sdkKey: string): string | null { | ||
| return this.decodeHostnames(sdkKey, ASSIGNMENT_CONFIG_PATH).configurationHostname; | ||
| } | ||
|
|
||
| /** | ||
| * Decodes and returns the edge configuration hostname from the provided Eppo SDK key string. | ||
| * If the SDK key doesn't contain the edge configuration hostname, or it's invalid, it returns null. | ||
| */ | ||
| decodeEdgeConfigurationUrl(sdkKey: string): string | null { | ||
| return this.decodeHostnames(sdkKey, EDGE_CONFIG_PATH).configurationHostname; | ||
| } |
There was a problem hiding this comment.
Looking into the future a bit: the clients allow for a baseUrl to be passed in; however we will no longer allow this to be fscdn.eppo.cloud if a hostname is decoded here as non-null and it will thrown an exception otherwise people will be able to bypass our DNS blocks. Down the line once all SDK keys have rotated or some future date, we can enforce a subdomain to be present and block bare requests to fscdn.eppo.cloud in VCL.
|
|
||
| const EVENT_INGESTION_PATH = 'v0/i'; | ||
| const ASSIGNMENT_CONFIG_PATH = 'assignment'; | ||
| const EDGE_CONFIG_PATH = 'edge'; |
There was a problem hiding this comment.
It seems this is intended to follow the same pattern used for event ingestion. The EVENT_INGESTION_PATH is used to return the full path/URL to be used. This doesn't seem to be doing that. I'd recommend we put the full path here in this file to be consistent.
… (FF-4143)
Motivation and Context
🎫 https://linear.app/eppo/issue/FF-4143/add-support-for-js-commons-to-decode-per-sdk-key-host
To add support for off-boarding customers from both the assignment and edge configuration APIs, we will be encoding a company specific hostname into key. Please see associated design doc for further details.
There will be 3 generations of SDKs "in the wild":
We need to augment the existing decoder class to handle the new cases and support existing ones.
Description
SdkDecoder:decodeAssignmentConfigurationUrlanddecodeEdgeConfigurationUrl. These will be used by the rules-based client and precomputed client, respectively. Those changes are not in scope for this PR.decodeHostnamesHow has this been tested?
New unit tests handling the 3 generations of SDK encodings.