-
Notifications
You must be signed in to change notification settings - Fork 90
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Synchronous catalog config from a global var + types (#3166)
- Loading branch information
Showing
18 changed files
with
175 additions
and
128 deletions.
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
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,3 @@ | ||
| import { getConfig } from 'utils/Config' | ||
|
|
||
| export default getConfig() |
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
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 was deleted.
Oops, something went wrong.
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,121 @@ | ||
| import Ajv from 'ajv' | ||
| import invariant from 'invariant' | ||
|
|
||
| import { BaseError } from 'utils/error' | ||
| import { printObject } from 'utils/string' | ||
|
|
||
| import configSchema from '../../config-schema.json' | ||
|
|
||
| type Mode = 'MARKETING' | 'OPEN' | 'PRODUCT' | 'LOCAL' | ||
| type AuthMethodConfig = 'ENABLED' | 'DISABLED' | 'SIGN_IN_ONLY' | ||
|
|
||
| // manually synced w/ config-schema.json | ||
| export interface ConfigJson { | ||
| alwaysRequiresAuth: boolean | ||
| analyticsBucket?: string | ||
| apiGatewayEndpoint: string | ||
| binaryApiGatewayEndpoint: string | ||
| calendlyLink?: string | ||
| googleClientId?: string | ||
| oktaClientId?: string | ||
| oktaBaseUrl?: string | ||
| intercomAppId?: string | ||
| mode: Mode | ||
| legacyPackagesRedirect?: string | ||
| linkedData?: { | ||
| name?: string | ||
| description?: string | ||
| } | ||
| mixpanelToken: string | ||
| noDownload?: boolean | ||
| noOverviewImages?: boolean | ||
| passwordAuth: AuthMethodConfig | ||
| registryUrl: string | ||
| s3Proxy: string | ||
| sentryDSN?: string | ||
| serviceBucket: string | ||
| ssoAuth: AuthMethodConfig | ||
| ssoProviders: string | ||
| desktop?: boolean | ||
| build_version?: string // not sure where this comes from | ||
| } | ||
|
|
||
| const ajv = new Ajv({ allErrors: true, removeAdditional: true }) | ||
|
|
||
| ajv.addSchema(configSchema, 'Config') | ||
|
|
||
| export class ConfigError extends BaseError { | ||
| static displayName = 'ConfigError' | ||
| } | ||
|
|
||
| function validateConfig(input: unknown): asserts input is ConfigJson { | ||
| if (ajv.validate('Config', input)) return | ||
| throw new ConfigError( | ||
| [ | ||
| 'invalid config format:', | ||
| ajv.errorsText(), | ||
| 'Errors array:', | ||
| printObject(ajv.errors), | ||
| 'Input:', | ||
| printObject(input), | ||
| ].join('\n'), | ||
| { errors: ajv.errors, input }, | ||
| ) | ||
| } | ||
|
|
||
| const AUTH_MAP = { | ||
| ENABLED: true, | ||
| DISABLED: false, | ||
| SIGN_IN_ONLY: 'SIGN_IN_ONLY', | ||
| } | ||
|
|
||
| const startWithOrigin = (s: string) => (s.startsWith('/') ? window.origin + s : s) | ||
|
|
||
| const transformConfig = (cfg: ConfigJson) => ({ | ||
| ...cfg, | ||
| passwordAuth: AUTH_MAP[cfg.passwordAuth], | ||
| ssoAuth: AUTH_MAP[cfg.ssoAuth], | ||
| ssoProviders: cfg.ssoProviders.length ? cfg.ssoProviders.split(' ') : [], | ||
| enableMarketingPages: cfg.mode === 'PRODUCT' || cfg.mode === 'MARKETING', | ||
| disableNavigator: cfg.mode === 'MARKETING', | ||
| s3Proxy: startWithOrigin(cfg.s3Proxy), | ||
| apiGatewayEndpoint: startWithOrigin(cfg.apiGatewayEndpoint), | ||
| binaryApiGatewayEndpoint: startWithOrigin(cfg.binaryApiGatewayEndpoint), | ||
| noDownload: !!cfg.noDownload, | ||
| noOverviewImages: !!cfg.noOverviewImages, | ||
| desktop: !!cfg.desktop, | ||
| }) | ||
|
|
||
| export function prepareConfig(input: unknown) { | ||
| try { | ||
| validateConfig(input) | ||
| return transformConfig(input) | ||
| } catch (e) { | ||
| if (e instanceof ConfigError) throw e | ||
| throw new ConfigError('unexpected error', { originalError: e }) | ||
| } | ||
| } | ||
|
|
||
| export type Config = ReturnType<typeof prepareConfig> | ||
|
|
||
| let cachedConfig: Config | null = null | ||
| const configKey = 'QUILT_CATALOG_CONFIG' | ||
| export function getConfig() { | ||
| if (!cachedConfig) { | ||
| const rawConfig = (window as any)[configKey] | ||
| invariant(rawConfig, `window.${configKey} must be defined`) | ||
| cachedConfig = prepareConfig(rawConfig) | ||
| } | ||
| return cachedConfig | ||
| } | ||
|
|
||
| export function useConfig(opts: { suspend: false }): { promise: Promise<Config> } | ||
| export function useConfig(): Config | ||
| /** @deprecated Config is now synchronous -- just import 'constants/config' module directly */ | ||
| export function useConfig(opts?: { suspend?: boolean }) { | ||
| const cfg = getConfig() | ||
| if (opts?.suspend === false) return { promise: Promise.resolve(cfg) } | ||
| return cfg | ||
| } | ||
|
|
||
| export { useConfig as use } |
Oops, something went wrong.