Security News
Introducing the Socket Python SDK
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
simple-async-tasks
Advanced tools
A simple in-memory queue, for nodejs and the browser, with consumers for common usecases.
easily create and use async-tasks within a pit-of-success
npm install simple-async-tasks
define the domain object of the async task you want to be able to run
import { DomainEntity } from 'domain-objects';
import { AsyncTask, AsyncTaskStatus } from 'simple-async-tasks';
/**
* for example: an async task for emitting some data to remote persistance
*/
export interface AsyncTaskEmitToRemote extends AsyncTask {
uuid?: string;
updatedAt?: string;
status: AsyncTaskStatus;
/**
* the endpoint to emit the data to
*/
endpoint: string;
/**
* the payload to emit
*
* note
* - supports string and binary buffer
*/
payload: string | Buffer;
}
export class AsyncTaskEmitToRemote
extends DomainEntity<AsyncTaskEmitToRemote>
implements AsyncTaskEmitToRemote
{
public static unique = ['endpoint', 'payload'];
}
define the database-access-object we can use to persist this async-task
usually, you should be using a library to code-generate or instantiate the dao for you
for example
import { createCacheDao } from 'simple-cache-dao';
import { createCache } from 'simple-in-memory-cache';
const daoTaskEmitToRemote = createCacheDao({ cache: createCache() })
define how to queue your task for execution
import { createQueue, QueueOrder } from 'simple-in-memory-queue';
// TODO: load all queued tasks from db on page load
export const asyncTaskEmitToRemoteQueue = createQueue<AsyncTaskEmitToRemote>({
order: QueueOrder.FIRST_IN_FIRST_OUT,
});
export const queueTaskEmitToRemote = withAsyncTaskExecutionLifecycleQueue({
dao: daoTaskEmitToRemote,
queue: asyncTaskEmitToRemoteQueue,
getNew: ({ endpoint, payload }) =>
new AsyncTaskEmitToRemote({
status: AsyncTaskStatus.QUEUED,
endpoint,
payload,
}),
});
define how to execute your async task
export const executeTaskEmitToRemote = withAsyncTaskExecutionLifecycleExecute(
async ({ task }: { task: HasMetadata<AsyncTaskEmitToRemote> }) => {
// execute your logic
// mark it as fulfilled
await daoTaskEmitToRemote.upsert({ task: { ...task, status: AsyncTaskStatus.FULFILLED }})
},
{
dao: daoTaskEmitToRemote,
},
);
⚠️ note: you must change the status of the task away from attempted by the time the execute function resolves to some non-attempted , otherwise it will be considered a failure
define the trigger that will consume from your queue and invoke the execute function
note
1.8.0 (2024-08-19)
FAQs
A simple in-memory queue, for nodejs and the browser, with consumers for common usecases.
The npm package simple-async-tasks receives a total of 87 weekly downloads. As such, simple-async-tasks popularity was classified as not popular.
We found that simple-async-tasks demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.
Security News
A new Rust RFC proposes "Trusted Publishing" for Crates.io, introducing short-lived access tokens via OIDC to improve security and reduce risks associated with long-lived API tokens.