Skip to content

Add rate limiting using Reddit RateLimit API response headers #71

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
jfl88 wants to merge 16 commits into
base: master
Choose a base branch
from
Open

Add rate limiting using Reddit RateLimit API response headers #71

Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
08f3fb3
Change 5sec delay to 7sec
jfl88 Sep 25, 2024
86936e7
Add rate limit recognition
jfl88 Sep 25, 2024
ef7c809
correct bracket issue
jfl88 Sep 25, 2024
1e43135
fix bracket issue
jfl88 Sep 25, 2024
25fd4d8
fixing brackets
jfl88 Sep 25, 2024
3930500
final bracket fix
jfl88 Sep 25, 2024
0ed1e1e
increase default timeout
jfl88 Sep 25, 2024
b1649c9
add debug
jfl88 Sep 25, 2024
6f7634d
add rate-limited to handle function
jfl88 Sep 25, 2024
2decea5
Update powerdeletesuite.js
jfl88 Jan 5, 2025
4af9021
Update powerdeletesuite.js
jfl88 Jan 5, 2025
78d5f98
Update powerdeletesuite.js
jfl88 Jan 5, 2025
b13a26f
Update powerdeletesuite.js
jfl88 Jan 5, 2025
4a29c18
Update powerdeletesuite.js
jfl88 Jan 5, 2025
333303c
Update powerdeletesuite.js
jfl88 Jan 5, 2025
194be0e
Merge branch 'j0be:master' into master
jfl88 Jan 5, 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
202 changes: 115 additions & 87 deletions powerdeletesuite.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -623,6 +623,21 @@ var pd = {
csvCell: function (str) {
return '"' + str + '",';
},
getRateLimitTimeout: function(xhr) {
// Read headers
const rateLimitRemaining = parseInt(xhr.getResponseHeader('x-ratelimit-remaining'), 10);
const rateLimitReset = parseInt(xhr.getResponseHeader('x-ratelimit-reset'), 10);
// Determine timeout
let timeout;
// if ratelimit low, set the timeout to wait based on the reset time
if (rateLimitRemaining <= 5) {
timeout = (rateLimitReset + 1) * 1000;
} else {
// Randomize timeout between 1.5 to 3 seconds
timeout = Math.floor(Math.random() * 1500) + 1500;
}
return timeout;
},
getSettings: function () {
return localStorage.getItem("pd_storage")
? JSON.parse(localStorage.getItem("pd_storage"))
Expand Down Expand Up @@ -714,21 +729,27 @@ var pd = {
sort: pd.task.paths.sorts[0],
t: pd.task.paths.timeframes[0],
},
}).then(
function (resp) {
}).complete(
function (xhr) {
resp = xhr.responseJSON;
if (resp.data) {
var children = resp.data.children;
pd.task.info.donePages++;
if (children.length > 0) {
pd.task.info.doneItems = 0;
pd.task.info.numItems = children.length;
pd.task.items = children;
pd.actions.children.handleGroup();
} else {
pd.task.after = "";
pd.actions.page.shift();
pd.actions.page.next();
}
const timeout = pd.helpers.getRateLimitTimeout(xhr);
console.log('timeout: ' + timeout);
Copy link
Copy Markdown

@fidelisrafael fidelisrafael Jan 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I want to suggest this to be changed to: console.debug so one can hide these log lines from the main console's output...

// Set the next action with the calculated timeout
setTimeout(() => {
var children = resp.data.children;
pd.task.info.donePages++;
if (children.length > 0) {
pd.task.info.doneItems = 0;
pd.task.info.numItems = children.length;
pd.task.items = children;
pd.actions.children.handleGroup();
} else {
pd.task.after = "";
pd.actions.page.shift();
pd.actions.page.next();
}
}, timeout);
} else {
pd.task.info.errors++;
if (
Expand All @@ -742,7 +763,7 @@ var pd = {
pd.ui.done();
}
}
},
}).fail(
function () {
pd.task.info.errors++;
if (
Expand Down Expand Up @@ -872,85 +893,92 @@ var pd = {
},
},
delete: function (item) {
setTimeout(() => {
if (pd.performActions) {
$.ajax({
url: "/api/del",
method: "post",
data: {
id: item.data.name,
executed: "deleted",
uh: pd.config.uh,
renderstyle: "html",
},
}).then(
function () {
if (pd.performActions) {
$.ajax({
url: "/api/del",
method: "post",
data: {
id: item.data.name,
executed: "deleted",
uh: pd.config.uh,
renderstyle: "html",
},
}).complete(
function (xhr) {
const timeout = pd.helpers.getRateLimitTimeout(xhr);
console.log('timeout: ' + timeout);
// Set the next action with the calculated timeout
setTimeout(() => {
pd.task.items[0].pdDeleted = true;
pd.actions.children.handleSingle();
},
function () {
pd.task.info.errors++;
if (
confirm(
"Error deleting " +
(item.kind == "t3" ? "post" : "comment") +
", would you like to retry?"
)
) {
pd.actions.children.handleSingle();
} else {
pd.actions.children.finishItem();
pd.actions.children.handleGroup();
}
}
);
} else {
pd.task.items[0].pdDeleted = true;
pd.task.after = pd.task.items[0].data.name;
pd.actions.children.handleSingle();
}
}, 5000);
}, timeout);
}
).fail(
function () {
pd.task.info.errors++;
if (
confirm(
"Error deleting " +
(item.kind == "t3" ? "post" : "comment") +
", would you like to retry?"
)
) {
pd.actions.children.handleSingle();
} else {
pd.actions.children.finishItem();
pd.actions.children.handleGroup();
}
});
} else {
pd.task.items[0].pdDeleted = true;
pd.task.after = pd.task.items[0].data.name;
pd.actions.children.handleSingle();
}
},
edit: function (item) {
setTimeout(() => {
if (pd.performActions) {
var editString = pd.task.config.editText ||
pd.editStrings[Math.floor(Math.random() * pd.editStrings.length)];
$.ajax({
url: "/api/editusertext",
method: "post",
data: {
thing_id: item.data.name,
text: editString,
id: "#form-" + item.data.name,
r: item.data.subreddit,
uh: pd.config.uh,
renderstyle: "html",
},
}).then(
function () {
if (pd.performActions) {
var editString = pd.task.config.editText ||
pd.editStrings[Math.floor(Math.random() * pd.editStrings.length)];
$.ajax({
url: "/api/editusertext",
method: "post",
data: {
thing_id: item.data.name,
text: editString,
id: "#form-" + item.data.name,
r: item.data.subreddit,
uh: pd.config.uh,
renderstyle: "html",
},
}).complete(
function (xhr) {
const timeout = pd.helpers.getRateLimitTimeout(xhr);
console.log('timeout: ' + timeout);
// Set the next action with the calculated timeout
setTimeout(() => {
pd.task.items[0].pdEdited = true;
pd.actions.children.handleSingle();
},
function () {
pd.task.info.errors++;
if (
!confirm(
"Error editing " +
(item.kind == "t3" ? "post" : "comment") +
", would you like to retry?"
)
) {
item.pdEdited = true;
}
pd.actions.children.handleSingle();
}, timeout);
}
).fail(
function () {
pd.task.info.errors++;
if (
!confirm(
"Error editing " +
(item.kind == "t3" ? "post" : "comment") +
", would you like to retry?"
)
) {
item.pdEdited = true;
}
);
} else {
pd.task.items[0].pdEdited = true;
pd.actions.children.handleSingle();
}
}, 5000);
pd.actions.children.handleSingle();
}
);
} else {
pd.task.items[0].pdEdited = true;
pd.actions.children.handleSingle();
}
},
},
ui: {
Expand Down