Skip to content
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

Jump to bottom

refactor: reduce conginitive complexity of the function #1891

Merged
merged 4 commits into from
Oct 17, 2024
Merged

refactor: reduce conginitive complexity of the function #1891

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
226320a
refactor: reduce conginitive complexity of the function
saikumarrs Oct 17, 2024
2798c4f
refactor: reduce cognitive complexity of the whole function
saikumarrs Oct 17, 2024
8bc43f4
refactor: reduce cognitive complexity of the whole function
saikumarrs Oct 17, 2024
d340774
chore: bump size limit
saikumarrs Oct 17, 2024
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
121 changes: 63 additions & 58 deletions packages/analytics-js/src/components/configManager/util/commonUtil.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,72 +129,77 @@ const updateStorageStateFromLoadOptions = (logger?: ILogger): void => {
);
}

batch(() => {
state.storage.type.value = storageType;
let cookieOptions = storageOptsFromLoad?.cookie ?? {};
let cookieOptions = storageOptsFromLoad?.cookie ?? {};
let sscEnabled = false;
let finalDataServiceUrl: string | undefined;
if (useServerSideCookies) {
sscEnabled = useServerSideCookies;
const providedCookieDomain = cookieOptions.domain ?? setCookieDomain;
/**
* Based on the following conditions, we decide whether to use the exact domain or not to determine the data service URL:
* 1. If the cookie domain is provided and it is not a top-level domain, then use the exact domain
* 2. If the sameDomainCookiesOnly flag is set to true, then use the exact domain
*/
const useExactDomain =
(isDefined(providedCookieDomain) &&
!isWebpageTopLevelDomain(removeLeadingPeriod(providedCookieDomain as string))) ||
sameDomainCookiesOnly;

const dataServiceUrl = getDataServiceUrl(
dataServiceEndpoint ?? DEFAULT_DATA_SERVICE_ENDPOINT,
useExactDomain ?? false,
);

if (useServerSideCookies) {
state.serverCookies.isEnabledServerSideCookies.value = useServerSideCookies;
const providedCookieDomain = cookieOptions.domain ?? setCookieDomain;
if (isValidURL(dataServiceUrl)) {
finalDataServiceUrl = removeTrailingSlashes(dataServiceUrl) as string;

const curHost = getDomain(window.location.href);
const dataServiceHost = getDomain(dataServiceUrl);

// If the current host is different from the data service host, then it is a cross-site request
// For server-side cookies to work, we need to set the SameSite=None and Secure attributes
// One round of cookie options manipulation is taking place here
// Based on these(setCookieDomain/storage.cookie or sameDomainCookiesOnly) two load-options, final cookie options are set in the storage module
// TODO: Refactor the cookie options manipulation logic in one place
if (curHost !== dataServiceHost) {
cookieOptions = {
...cookieOptions,
samesite: 'None',
secure: true,
};
}
/**
* Based on the following conditions, we decide whether to use the exact domain or not to determine the data service URL:
* 1. If the cookie domain is provided and it is not a top-level domain, then use the exact domain
* 2. If the sameDomainCookiesOnly flag is set to true, then use the exact domain
* If the sameDomainCookiesOnly flag is not set and the cookie domain is provided(not top level domain),
* and the data service host is different from the provided cookie domain, then we disable server-side cookies
* ex: provided cookie domain: 'random.com', data service host: 'sub.example.com'
*/
const useExactDomain =
(isDefined(providedCookieDomain) &&
!isWebpageTopLevelDomain(removeLeadingPeriod(providedCookieDomain as string))) ||
sameDomainCookiesOnly;

const dataServiceUrl = getDataServiceUrl(
dataServiceEndpoint ?? DEFAULT_DATA_SERVICE_ENDPOINT,
useExactDomain ?? false,
);

if (isValidURL(dataServiceUrl)) {
state.serverCookies.dataServiceUrl.value = removeTrailingSlashes(dataServiceUrl) as string;

const curHost = getDomain(window.location.href);
const dataServiceHost = getDomain(dataServiceUrl);

// If the current host is different from the data service host, then it is a cross-site request
// For server-side cookies to work, we need to set the SameSite=None and Secure attributes
// One round of cookie options manipulation is taking place here
// Based on these(setCookieDomain/storage.cookie or sameDomainCookiesOnly) two load-options, final cookie options are set in the storage module
// TODO: Refactor the cookie options manipulation logic in one place
if (curHost !== dataServiceHost) {
cookieOptions = {
...cookieOptions,
samesite: 'None',
secure: true,
};
}
/**
* If the sameDomainCookiesOnly flag is not set and the cookie domain is provided(not top level domain),
* and the data service host is different from the provided cookie domain, then we disable server-side cookies
* ex: provided cookie domain: 'random.com', data service host: 'sub.example.com'
*/
if (
!sameDomainCookiesOnly &&
useExactDomain &&
dataServiceHost !== removeLeadingPeriod(providedCookieDomain as string)
) {
state.serverCookies.isEnabledServerSideCookies.value = false;
logger?.warn(
SERVER_SIDE_COOKIE_FEATURE_OVERRIDE_WARNING(
CONFIG_MANAGER,
providedCookieDomain,
dataServiceHost as string,
),
);
}
} else {
state.serverCookies.isEnabledServerSideCookies.value = false;
if (
!sameDomainCookiesOnly &&
useExactDomain &&
dataServiceHost !== removeLeadingPeriod(providedCookieDomain as string)
) {
sscEnabled = false;
logger?.warn(
SERVER_SIDE_COOKIE_FEATURE_OVERRIDE_WARNING(
CONFIG_MANAGER,
providedCookieDomain,
dataServiceHost as string,
),
);
}
} else {
sscEnabled = false;
}
}

batch(() => {
state.storage.type.value = storageType;

state.storage.cookie.value = cookieOptions;

state.serverCookies.isEnabledServerSideCookies.value = sscEnabled;
state.serverCookies.dataServiceUrl.value = finalDataServiceUrl;

state.storage.encryptionPluginName.value =
StorageEncryptionVersionsToPluginNameMap[storageEncryptionVersion as string];

Expand Down