Skip to content

fix: url configuration should respect / for host and error more meaningfully when invalid #9164

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
runspired merged 2 commits into from
Dec 10, 2023
Merged

fix: url configuration should respect / for host and error more meaningfully when invalid #9164

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1727326
fix: url configuration should respect / for host and error more meani…
runspired Dec 10, 2023
0537196
fix prettier
runspired Dec 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 43 additions & 5 deletions packages/request-utils/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ export interface BuildURLConfig {
namespace: string | null;
}

let CONFIG: BuildURLConfig = {
const CONFIG: BuildURLConfig = {
host: '',
namespace: '',
};
Expand All @@ -69,7 +69,13 @@ let CONFIG: BuildURLConfig = {
* These values may still be overridden by passing
* them to buildBaseURL directly.
*
* This method may be called as many times as needed
* This method may be called as many times as needed.
* host values of `''` or `'/'` are equivalent.
*
* Except for the value of `/` as host, host should not
* end with `/`.
*
* namespace should not start or end with a `/`.
*
* ```ts
* type BuildURLConfig = {
Expand All @@ -78,6 +84,17 @@ let CONFIG: BuildURLConfig = {
* }
* ```
*
* Example:
*
* ```ts
* import { setBuildURLConfig } from '@ember-data/request-utils';
*
* setBuildURLConfig({
* host: 'https://api.example.com',
* namespace: 'api/v1'
* });
* ```
*
* @method setBuildURLConfig
* @static
* @public
Expand All @@ -86,7 +103,27 @@ let CONFIG: BuildURLConfig = {
* @return void
*/
export function setBuildURLConfig(config: BuildURLConfig) {
CONFIG = config;
assert(`setBuildURLConfig: You must pass a config object`, config);
assert(
`setBuildURLConfig: You must pass a config object with a 'host' or 'namespace' property`,
'host' in config || 'namespace' in config
);

CONFIG.host = config.host || '';
CONFIG.namespace = config.namespace || '';

assert(
`buildBaseURL: host must NOT end with '/', received '${CONFIG.host}'`,
CONFIG.host === '/' || !CONFIG.host.endsWith('/')
);
assert(
`buildBaseURL: namespace must NOT start with '/', received '${CONFIG.namespace}'`,
!CONFIG.namespace.startsWith('/')
);
assert(
`buildBaseURL: namespace must NOT end with '/', received '${CONFIG.namespace}'`,
!CONFIG.namespace.endsWith('/')
);
}

export interface FindRecordUrlOptions {
Expand Down Expand Up @@ -317,8 +354,9 @@ export function buildBaseURL(urlOptions: UrlOptions): string {
assert(`buildBaseURL: idPath must NOT start with '/', received '${idPath}'`, !idPath.startsWith('/'));
assert(`buildBaseURL: idPath must NOT end with '/', received '${idPath}'`, !idPath.endsWith('/'));

const url = [host === '/' ? '' : host, namespace, resourcePath, idPath, fieldPath].filter(Boolean).join('/');
return host ? url : `/${url}`;
const hasHost = host !== '' && host !== '/';
const url = [hasHost ? host : '', namespace, resourcePath, idPath, fieldPath].filter(Boolean).join('/');
return hasHost ? url : `/${url}`;
}

const DEFAULT_QUERY_PARAMS_SERIALIZATION_OPTIONS: QueryParamsSerializationOptions = {
Expand Down