Skip to content

Add turbostream decoding for data/actions #124

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 4 commits into
base: master
Choose a base branch
from
Open

Add turbostream decoding for data/actions #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a20cbb4
Add turbostream decoding for data
ricardo-devis-agullo Feb 18, 2025
ef0c02e
update pkg
ricardo-devis-agullo Feb 18, 2025
41b596f
add turbo compiled
ricardo-devis-agullo Feb 27, 2025
fa983a8
put turbo build
ricardo-devis-agullo Feb 27, 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
16 changes: 14 additions & 2 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "oc-client-browser",
"version": "1.9.5",
"version": "1.10.0",
"description": "OC browser client",
"main": "index.js",
"types": "index.d.ts",
Expand Down Expand Up @@ -75,7 +75,8 @@
"typescript": "4.4.4"
},
"dependencies": {
"turbo-stream": "^2.4.1",
"uglify-js": "3.14.2",
"universalify": "2.0.0"
}
}
}
264 changes: 180 additions & 84 deletions src/oc-client.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,58 @@ var oc = oc || {};
};

// constants
var RETRY_INTERVAL = ocConf.retryInterval || __DEFAULT_RETRY_INTERVAL__,
var IS_FETCH_AVAILABLE = typeof fetch === 'function',
handleResponseCallback = function (apiResponse, callback) {
var response = apiResponse[0].response;
var err = response.error ? response.details || response.error : null;
callback(err, response.data, apiResponse[0]);
},
handleTemplateCallback = function (
apiResponse,
ocId,
id,
element,
callback
) {
var template = apiResponse.template;
apiResponse.data.id = ocId;
apiResponse.data.element = element;
oc.render(template, apiResponse.data, function (err, html) {
if (err) {
callback(
interpolate(MESSAGES_ERRORS_RENDERING, apiResponse.href) + err
);
} else {
logInfo(interpolate(MESSAGES_RENDERED, template.src));
callback(null, {
id: id,
ocId: ocId,
html: html,
baseUrl: apiResponse.baseUrl,
key: template.key,
version: apiResponse.version,
name: apiResponse.name
});
}
});
},
handleFetchError = function (err, href, retryFn, failedFn) {
if (err && err.status == 429) {
retries[href] = 0;
}
logError(MESSAGES_ERRORS_RETRIEVING);
retry(href, retryFn, failedFn);
},
handleFetchResponse = function (response) {
if (!response.ok) throw response;
if (response.headers.get('Content-Type') !== 'x-text/stream')
return response.json();

return oc._decode(response.body).then(function (decoded) {
return decoded.value;
});
},
RETRY_INTERVAL = ocConf.retryInterval || __DEFAULT_RETRY_INTERVAL__,
RETRY_LIMIT = ocConf.retryLimit || __DEFAULT_RETRY_LIMIT__,
DISABLE_LOADER = isBool(ocConf.disableLoader)
? ocConf.disableLoader
Expand Down Expand Up @@ -242,42 +293,71 @@ var oc = oc || {};
function getData(options, cb) {
cb = cb || noop;
var version = options.version,
baseUrl = options.baseUrl,
name = options.name,
json = options.json;
json = options.json,
baseUrl = options.baseUrl;
if (options.action) {
baseUrl =
baseUrl +
'~actions/' +
options.action +
'/' +
options.name +
'/' +
options.version || '';
}
isRequired('version', version);
isRequired('baseUrl', baseUrl);
isRequired('name', name);
var parameters = $.extend({}, ocConf.globalParameters, options.parameters);
var jsonRequest = isBool(json) ? json : JSON_REQUESTS;
var data = {
components: [
{
action: options.action,
name: name,
version: version,
parameters: $.extend({}, ocConf.globalParameters, options.parameters)
}
]
};
var data = options.action
? parameters
: {
components: [
{
action: options.action,
name: name,
version: version,
parameters: parameters
}
]
};
var headers = getHeaders();
var ajaxOptions = {
method: 'POST',
url: baseUrl,
data: jsonRequest ? JSON.stringify(data) : data,
headers: headers,
crossDomain: true,
success: function (apiResponse) {
var response = apiResponse[0].response;
var err = response.error ? response.details || response.error : null;
cb(err, response.data, apiResponse[0]);
},
error: cb
};
if (jsonRequest) {
headers['Content-Type'] = 'application/json';
}

$.ajax(ajaxOptions);
if (IS_FETCH_AVAILABLE) {
fetch(baseUrl, {
method: 'POST',
headers: headers,
body: jsonRequest ? JSON.stringify(data) : $.param(data)
// credentials: 'include'
})
.then(handleFetchResponse)
.then(function (apiResponse) {
if (!options.action) {
handleResponseCallback(apiResponse, cb);
} else {
cb(null, apiResponse.data);
}
})
.catch(cb);
} else {
var ajaxOptions = {
method: 'POST',
url: baseUrl,
data: jsonRequest ? JSON.stringify(data) : data,
headers: headers,
crossDomain: true,
success: function (apiResponse) {
handleResponseCallback(apiResponse, cb);
},
error: cb
};
$.ajax(ajaxOptions);
}
}
oc.getData = getData;
oc.getAction = function (options) {
Expand Down Expand Up @@ -508,65 +588,81 @@ var oc = oc || {};
if (!href) {
callback(MESSAGES_ERRORS_RENDERING + MESSAGES_ERRORS_HREF_MISSING);
} else {
$.ajax({
url: addParametersToHref(
href,
$.extend(
{},
ocConf.globalParameters,
RETRY_SEND_NUMBER && { __oc_Retry: retryNumber }
)
),
headers: getHeaders(),
contentType: 'text/plain',
crossDomain: true,
success: function (apiResponse) {
var template = apiResponse.template;
apiResponse.data.id = ocId;
apiResponse.data.element = element;
oc.render(template, apiResponse.data, function (err, html) {
if (err) {
callback(
interpolate(MESSAGES_ERRORS_RENDERING, apiResponse.href) + err
);
} else {
logInfo(interpolate(MESSAGES_RENDERED, template.src));
callback(null, {
id: id,
ocId: ocId,
html: html,
baseUrl: apiResponse.baseUrl,
key: template.key,
version: apiResponse.version,
name: apiResponse.name
});
}
var url = addParametersToHref(
href,
$.extend(
{},
ocConf.globalParameters,
RETRY_SEND_NUMBER && { __oc_Retry: retryNumber }
)
);
var headers = getHeaders();
var contentType = 'text/plain';
headers['Content-Type'] = contentType;

if (IS_FETCH_AVAILABLE) {
fetch(url, {
headers: headers
// credentials: 'include'
})
.then(handleFetchResponse)
.then(function (apiResponse) {
handleTemplateCallback(apiResponse, ocId, id, element, callback);
})
.catch(function (err) {
handleFetchError(
err,
href,
function (requestNumber) {
oc.renderByHref(
{
href: href,
retryNumber: requestNumber,
id: id,
element: element
},
callback
);
},
function () {
callback(interpolate(MESSAGES_ERRORS_RETRY_FAILED, href));
}
);
});
},
error: function (err) {
if (err && err.status == 429) {
retries[href] = 0;
}
logError(MESSAGES_ERRORS_RETRIEVING);
retry(
href,
function (requestNumber) {
oc.renderByHref(
{
href: href,
retryNumber: requestNumber,
id: id,
element: element
},
callback
);
},
function () {
callback(interpolate(MESSAGES_ERRORS_RETRY_FAILED, href));
} else {
$.ajax({
url: url,
headers: headers,
contentType: contentType,
crossDomain: true,
success: function (apiResponse) {
handleTemplateCallback(apiResponse, ocId, id, element, callback);
},
error: function (err) {
if (err && err.status == 429) {
retries[href] = 0;
}
);
}
});
logError(MESSAGES_ERRORS_RETRIEVING);
retry(
href,
function (requestNumber) {
oc.renderByHref(
{
href: href,
retryNumber: requestNumber,
id: id,
element: element
},
callback
);
},
function () {
callback(interpolate(MESSAGES_ERRORS_RETRY_FAILED, href));
}
);
}
});
}
}
});
};
Expand Down
Loading
Loading