8000 feat(cdk): add rxScheduleTask function by Karnaukhov-kh · Pull Request #1344 · rx-angular/rx-angular · GitHub
[go: up one dir, main page]

Skip to content

feat(cdk): add rxScheduleTask function #1344

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.

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

Closed
wants to merge 9 commits into from
110 changes: 110 additions & 0 deletions libs/cdk/render-strategies/docs/rx-schedule-task.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
# rxScheduleTask

`rxScheduleTask` provides a helper function to schedule function execution. It is a minimal building block for making performance optimizations in your code.

## Motivation

Chromium based browsers considers all tasks that taking more than 50ms as long tasks. If task runs more than 50ms, users will start noticing lags. Optimally all user interactions should happen at 30 fps framerate with 32ms budget per browser task. In ideal world it should be 60 fps and 16ms budget.

> 💡 In reality browser has a reserved overhead of 4ms, try to stick to 28ms of work for 30 fps and 12ms for 60 fps.

## Scheduling mechanisms in browser

Most common ways of delaying task execution are:

- `setTimeout`
- `requestAnimationFrame`
- `requestIdleCallback`

`rxScheduleTask` provides similar API but comes with huge benefits of notion of frame budget and priority configuration.

## Concurrent strategies

> 💡 Under the hood all our concurrent strategies are based on MessageChannel technology.

To address the problem of long tasks and help browser split the work @rx-angular/cdk provides concurrent strategies. This strategies will help browser to chunk the work into non-blocking tasks whenever it's possible.

You can read detailed information about concurrent strategies [here](https://github.com/rx-angular/rx-angular/blob/main/libs/cdk/render-strategies/docs/concurrent-strategies.md).

## Usage examples

### Input params

- Just as common delaying apis this method `accepts` a work function that should be scheduled.
- Second important parameter is `strategy` which will be used for scheduling (`normal` is default).
- Third argument is `options` that can hold `delay` for the task and `ngZone` where task should run.

### Return type

Function returns a callback that you can use to cancel already scheduled tasks.

### Default usage

```typescript
import { rxScheduleTask } from '@rx-angular/cdk/render-strategies';
...

function updateStateAndBackup<T>(data: T) {
this.stateService.set(data);

rxScheduleTask(() => localStorage.setItem('state', JSON.stringify(state)));
}
```

### Usage with non-default strategy

```typescript
import { rxScheduleTask } from '@rx-angular/cdk/render-strategies';
...

function updateStateAndBackup<T>(data: T) {
this.stateService.set(data);

rxScheduleTask(
() => localStorage.setItem('state', JSON.stringify(state)),
{strategy: 'idle'}
);
}
```

### Usage with options

```typescript
import { rxScheduleTask } from '@rx-angular/cdk/render-strategies';
...

function updateStateAndBackup<T>(data: T) {
this.stateService.set(data);

rxScheduleTask(
() => localStorage.setItem('state', JSON.stringify(state)),
{ delay: 200, zone: this.ngZone, strategy: 'idle' }
);
}
```

### Cancel scheduled task

```typescript
import { rxScheduleTask } from '@rx-angular/cdk/render-strategies';
...

let saveToLocalStorageCallback;

function updateStateAndBackup<T>(data: T) {
this.stateService.set(data);

if (saveToLocalStorageCallback) {
saveToLocalStorageCallback();
}

saveToLocalStorageCallback = rxScheduleTask(() =>
localStorage.setItem('state', JSON.stringify(state))
);
}
```

## Links

- [Detailed information about strategies](https://github.com/rx-angular/rx-angular/tree/master/libs/cdk/render-strategies)
- [MessageChannel documentation](https://developer.mozilla.org/en-US/docs/Web/API/MessageChannel)
1 change: 1 addition & 0 deletions libs/cdk/render-strategies/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@ export { RxStrategyCredentials } from './lib/model';
export { RxRenderBehavior } from './lib/model';
export { RxRenderWork } from './lib/model';
export { RX_RENDER_STRATEGIES_CONFIG, RxRenderStrategiesConfig } from './lib/config';
export { rxScheduleTask } from './lib/rx-schedule-task';
52 changes: 52 additions & 0 deletions libs/cdk/render-strategies/src/lib/rx-schedule-task.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
import { NgZone } from '@angular/core';
import {
cancelCallback,
scheduleCallback,
PriorityLevel,
} from '@rx-angular/cdk/internals/scheduler';
import { RxConcurrentStrategyNames } from './model';

type StrategiesPriorityRecord = Record<
RxConcurrentStrategyNames,
PriorityLevel
>;

const strategiesPrio: StrategiesPriorityRecord = {
immediate: PriorityLevel.ImmediatePriority,
userBlocking: PriorityLevel.UserBlockingPriority,
normal: PriorityLevel.NormalPriority,
low: PriorityLevel.LowPriority,
idle: PriorityLevel.IdlePriority,
};

const defaultStrategy: keyof StrategiesPriorityRecord = 'normal';

/**
* @description
* This function is used to schedule a task with a certain priority.
* It is useful for tasks that can be done asynchronously.
*
* ```ts
* const task = rxScheduleTask(() => localStorage.setItem(state, JSON.stringify(state));
* ```
*/
export const rxScheduleTask = (
work: (...args: any[]) => void,
options?: {
strategy?: keyof StrategiesPriorityRecord;
delay?: number;
ngZone?: NgZone;
}
) => {
const task = scheduleCallback(
strategiesPrio[options?.strategy || defaultStrategy],
() => work(),
{
delay: options?.delay,
ngZone: options?.ngZone,
}
);
return () => {
cancelCallback(task);
};
};
Comment on lines +33 to +52
Copy link
Member

Choose a reason for hiding this comment

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

What about the following syntax to initialize options?

Suggested change
export const rxScheduleTask = (
work: (...args: any[]) => void,
options?: {
strategy?: keyof StrategiesPriorityRecord;
delay?: number;
ngZone?: NgZone;
}
) => {
const task = scheduleCallback(
strategiesPrio[options?.strategy || defaultStrategy],
() => work(),
{
delay: options?.delay,
ngZone: options?.ngZone,
}
);
return () => {
cancelCallback(task);
};
};
export const rxScheduleTask = (
work: (...args: any[]) => void,
{
strategy = defaultStrategy,
delay,
ngZone,
}: {
strategy?: keyof StrategiesPriorityRecord;
delay?: number;
ngZone?: NgZone;
} = {}
) => {
const task = scheduleCallback(strategiesPrio[strategy], () => work(), {
delay,
ngZone,
});
return () => {
cancelCallback(task);
};
};

0