Skip to content

async xhr requests #6

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

async xhr requests #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6854ed0
async xhr refactor
skrukwa May 27, 2025
55270d4
update rest.ts
skrukwa Jun 10, 2025
b1b398b
revert GetFileSiteUrl bug fix - fix in other pr
skrukwa Jun 17, 2025
b4bb11f
revert getFormDigest exported signature using ts overloads
skrukwa Jun 18, 2025
27dcc96
Merge branch 'SnapOn-Software:main' into async-xhr-requests
skrukwa Jun 23, 2025
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
111 changes: 66 additions & 45 deletions src/utils/rest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,63 @@ function fillHeaders(xhr: XMLHttpRequest, headers: { [key: string]: string; }) {
}
}

function getXhr(url: string, body?: IRequestBody, options?: IRestOptions, async = true): IRequestObjects {
/**
* Depending on async:
* - Returns an XMLHttpRequest that was opened asynchronously (needs to have event listeners set up before .send()) or
* - Returns an XMLHttpRequest that was opened synchronously (will block on .send())
*/
function getXhr(url: string, body?: IRequestBody, options?: IRestOptions, async?: true): Promise<IRequestObjects>
function getXhr(url: string, body?: IRequestBody, options?: IRestOptions, async?: false): IRequestObjects
function getXhr(url: string, body?: IRequestBody, options?: IRestOptions, async: boolean = false): IRequestObjects | Promise<IRequestObjects> {

let [myOptions, myCacheOptions] = configureXhrHeaders(url, body, options);

const xhr: XMLHttpRequest = new XMLHttpRequest();
xhr.open(myOptions.method, url, async);

fillHeaders(xhr, myOptions.headers);

if (myOptions.cors) {
xhr.withCredentials = true;
}

if (!isNullOrEmptyString(myOptions.responseType) && myOptions.responseType !== "text") {
if (myCacheOptions.allowCache === true &&
(myOptions.responseType === "blob" || myOptions.responseType === "arraybuffer" || myOptions.responseType === "document")) {
logger.warn("When allowCache is true, Blob, ArrayBuffer and Document response types will only be stored in runtime memory and not committed to local storage.");
}
xhr.responseType = myOptions.responseType;
}

const needsDigest =
(myOptions.method === "GET" && myOptions.includeDigestInGet) ||
(myOptions.method === "POST" && myOptions.includeDigestInPost);

const applyDigest = (digest: string | null) => {
if (digest) {
xhr.setRequestHeader("X-RequestDigest", digest);
} else {
console.warn("X-RequestDigest header not set due to getFormDigest returning null");
}
}

const result: IRequestObjects = { xhr, options: myOptions, cacheOptions: myCacheOptions };

if (needsDigest && async) {
return getFormDigest(myOptions.spWebUrl, true).then(digest => {
applyDigest(digest);
return result;
})
} else if (needsDigest && !async) {
const digest = getFormDigest(myOptions.spWebUrl, false);
applyDigest(digest);
return result;
}

return result;
}

function configureXhrHeaders(url: string, body?: IRequestBody, options?: IRestOptions): [IRestRequestOptions, IRestCacheOptions & { cacheKey?: string; }] {
var optionsWithDefaults = assign<IRestOptions>({}, getDefaultOptions(), options);
let myCacheOptions: IRestCacheOptions & { cacheKey?: string; } = {};
Object.keys(AllRestCacheOptionsKeys).forEach(key => {
Expand All @@ -80,39 +136,19 @@ function getXhr(url: string, body?: IRequestBody, options?: IRestOptions, async
});
let myOptions: IRestRequestOptions = { ...optionsWithDefaults };

var xhr: XMLHttpRequest = new XMLHttpRequest();

let jsonType = myOptions.jsonMetadata || jsonTypes.verbose;

if (myOptions.cors) {
xhr.withCredentials = true;
}

if (isNullOrUndefined(myOptions.headers)) myOptions.headers = {};//issue 660 in case the sender sent headers as null
if (isNullOrUndefined(myOptions.headers["Accept"])) {
myOptions.headers["Accept"] = jsonType;
}

let method = myOptions.method;
if (isNullOrEmptyString(method)) {
method = isNullOrUndefined(body) ? "GET" : "POST";
if (isNullOrEmptyString(myOptions.method)) {
myOptions.method = isNullOrUndefined(body) ? "GET" : "POST";
}

myOptions.method = method;
xhr.open(method, url, async !== false);
if (method === "GET") {
if (myOptions.includeDigestInGet === true) {//by default don't add it, unless explicitly asked in options
xhr.setRequestHeader("X-RequestDigest", getFormDigest(myOptions.spWebUrl));
}
}
else if (method === "POST") {
if (isNullOrUndefined(myOptions.headers["content-type"])) {
myOptions.headers["content-type"] = jsonType;
}

if (myOptions.includeDigestInPost !== false) {//if explicitly set to false - don't include it
xhr.setRequestHeader("X-RequestDigest", getFormDigest(myOptions.spWebUrl));
}
if (myOptions.method === "POST" && isNullOrUndefined(myOptions.headers["content-type"])) {
myOptions.headers["content-type"] = jsonType;
}

if (!isNullOrEmptyString(myOptions.xHttpMethod)) {
Expand All @@ -123,27 +159,13 @@ function getXhr(url: string, body?: IRequestBody, options?: IRestOptions, async
}
}

fillHeaders(xhr, myOptions.headers);

if (!isNullOrEmptyString(myOptions.responseType) && myOptions.responseType !== "text") {
if (myCacheOptions.allowCache === true &&
(myOptions.responseType === "blob" || myOptions.responseType === "arraybuffer" || myOptions.responseType === "document")) {
logger.warn("When allowCache is true, Blob, ArrayBuffer and Document response types will only be stored in runtime memory and not committed to local storage.");
}
xhr.responseType = myOptions.responseType;
}

//we do not support cache if there is a request body
//postCacheKey - allow cache on post request for stuff like get item by CamlQuery
if (isNullOrUndefined(body) || !isNullOrEmptyString(myOptions.postCacheKey)) {
myCacheOptions.cacheKey = (url + '|' + JSON.stringify(myOptions)).trim().toLowerCase();
}

return {
xhr: xhr,
options: myOptions,
cacheOptions: myCacheOptions
};
return [myOptions, myCacheOptions];
}

function getCachedResult<T>(objects: IRequestObjects): IJsonSyncResult<T> {
Expand Down Expand Up @@ -373,10 +395,9 @@ export function GetJsonSync<T>(url: string, body?: IRequestBody, options?: IRest
return syncResult;
}

export function GetJson<T>(url: string, body?: IRequestBody, options?: IRestOptions): Promise<T> {
export async function GetJson<T>(url: string, body?: IRequestBody, options?: IRestOptions): Promise<T> {
try {
let objects = getXhr(url, body, options);

let objects = await getXhr(url, body, options, true);
var cachedResult = getCachedResult<T>(objects);
if (!isNullOrUndefined(cachedResult)) {
if (!supressDebugMessages) {
Expand Down Expand Up @@ -489,7 +510,7 @@ export function GetJson<T>(url: string, body?: IRequestBody, options?: IRestOpti

return xhrPromise;
} catch (e) {
return Promise.reject({ message: "an error occured" });
return Promise.reject({ error: e, message: e.message, stack: e.stack });
}
}

Expand All @@ -499,4 +520,4 @@ export function GetJsonClearCache() {
Object.keys(_cachedResults).forEach(key => {
delete _cachedResults[key];
});
}
}
44 changes: 41 additions & 3 deletions src/utils/sharepoint.rest/web.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1057,6 +1057,36 @@ export function GetContextWebInformationSync(siteUrl: string): IContextWebInform
}
}

export async function GetContextWebInformation(siteUrl: string): Promise<IContextWebInformation> {
var siteId: string = null;
if (hasGlobalContext() && _spPageContextInfo && _spPageContextInfo.isAppWeb) {
//inside an app web you can't get the contextinfo for any other site
siteUrl = _spPageContextInfo.webServerRelativeUrl;
siteId = _spPageContextInfo.siteId;
} else {
siteId = await GetSiteId(siteUrl);

if (isNullOrEmptyString(siteId)) {
return null;
}
}

try {
let result = await GetJson<{
d: { GetContextWebInformation: IContextWebInformation; };
}>(`${GetRestBaseUrl(siteUrl)}/contextinfo`, null, {
method: "POST",
maxAge: 5 * 60,
includeDigestInPost: false,
allowCache: true,
postCacheKey: `GetContextWebInformation_${normalizeGuid(siteId)}`
});
return result.d.GetContextWebInformation;
} catch {
return null;
}
}

function _getCustomActionsBaseRestUrl(siteUrl?: string, options: { listId?: string, actionId?: string } = {}) {
const { listId, actionId } = { ...options };

Expand Down Expand Up @@ -1274,9 +1304,17 @@ export async function GetWebPropertyByName(name: string, siteUrl?: string) {
return null;
}

export function getFormDigest(serverRelativeWebUrl?: string) {
var contextWebInformation = GetContextWebInformationSync(serverRelativeWebUrl);
return contextWebInformation && contextWebInformation.FormDigestValue || null;
export function getFormDigest(serverRelativeWebUrl?: string, async?: true): Promise<string | null>
export function getFormDigest(serverRelativeWebUrl?: string, async?: false): string | null
export function getFormDigest(serverRelativeWebUrl?: string, async: boolean = false): string | null | Promise<string | null> {
if (async) {
return GetContextWebInformation(serverRelativeWebUrl).then(contextWebInformation => {
return contextWebInformation && contextWebInformation.FormDigestValue || null;
});
} else {
let contextWebInformation = GetContextWebInformationSync(serverRelativeWebUrl);
return contextWebInformation && contextWebInformation.FormDigestValue || null;
}
}

export interface spfxContext { legacyPageContext: typeof _spPageContextInfo }
Expand Down