Skip to content

Change minimum time between cronjobs to 15 seconds #3198

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 1 commit into
base: main
Choose a base branch
from
Open

Change minimum time between cronjobs to 15 seconds #3198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
60 changes: 60 additions & 0 deletions packages/snaps-controllers/src/cronjob/CronjobController.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,66 @@ describe('CronjobController', () => {
cronjobController.destroy();
});

it('schedules a cronjob to run in 15 seconds if the cronjob is set to run less than every 15 seconds', () => {
const expression = '*/1 * * * * *'; // Every second

const rootMessenger = getRootCronjobControllerMessenger();
const controllerMessenger =
getRestrictedCronjobControllerMessenger(rootMessenger);

rootMessenger.registerActionHandler(
'PermissionController:getPermissions',
() => {
return {
[SnapEndowments.Cronjob]: getCronjobPermission({ expression }),
};
},
);

const cronjobController = new CronjobController({
messenger: controllerMessenger,
});

cronjobController.register(MOCK_SNAP_ID);

expect(rootMessenger.call).toHaveBeenCalledWith(
'PermissionController:getPermissions',
MOCK_SNAP_ID,
);

jest.advanceTimersByTime(11_000);

expect(rootMessenger.call).not.toHaveBeenCalledWith(
'SnapController:handleRequest',
{
snapId: MOCK_SNAP_ID,
origin: '',
handler: HandlerType.OnCronjob,
request: {
method: 'exampleMethod',
params: ['p1'],
},
},
);

jest.advanceTimersByTime(4_000);

expect(rootMessenger.call).toHaveBeenCalledWith(
'SnapController:handleRequest',
{
snapId: MOCK_SNAP_ID,
origin: '',
handler: HandlerType.OnCronjob,
request: {
method: 'exampleMethod',
params: ['p1'],
},
},
);

cronjobController.destroy();
});

it('schedules a background event', () => {
const rootMessenger = getRootCronjobControllerMessenger();
const controllerMessenger =
Expand Down
5 changes: 4 additions & 1 deletion packages/snaps-controllers/src/cronjob/CronjobController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,10 @@ export class CronjobController extends BaseController<
const parsed = parseCronExpression(job.expression);
const next = parsed.next();
const now = new Date();
const ms = next.getTime() - now.getTime();

// If the time until the next run is less than 15 seconds, we increase it
// to 15 seconds to avoid running jobs too frequently.
const ms = Math.max(next.getTime() - now.getTime(), 15_000);
Copy link
Member

Choose a reason for hiding this comment

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

What if the job is a job that runs every day but meant to start in 1 second?

Copy link
Member Author

Choose a reason for hiding this comment

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

Good point, I need to rethink my approach 😅


// Don't schedule this job yet as it is too far in the future
if (ms > DAILY_TIMEOUT) {
Expand Down
Loading