JS/TS에서 비동기 프로세스의 동기 실행을 위한 라이브러리 출시

JavaScript/TypeScript에서 비동기 프로세스를 동기적으로 실행할 수 있는 sync-actions라는 라이브러리를 출시했습니다. 특히 TypeScript에서는 유형이 안전한 방식으로 정의된 함수를 호출할 수 있습니다. 비동기로 표시하고 싶지 않거나 할 수 없는 기능 내에서 비동기 프로세스를 실행하려는 경우에 사용하기 위한 것입니다.

특징

• Node.js 작업자_스레드 활용
  • 비동기 프로세스는 하위 스레드에서 실행되며, 메인 스레드는 완료될 때까지 동기적으로 기다립니다.
• 유형이 안전한 함수 호출
  • TypeScript에서는 정의된 함수의 타입 정보를 활용할 수 있습니다.
• 네이티브 ESM으로 출판
  • CommonJS를 지원하지 않아 간편해졌습니다.

저장소

https://github.com/koyopro/sync-actions

용법

설치

npm 패키지로 공개되어 있으니 npm install 등을 이용해 설치해주세요.

npm install sync-actions

기본 사용법

Promise 객체를 반환하는 비동기 함수를 DefineSyncWorker()에 전달하면 인터페이스를 정의하고 launch()를 사용하여 작업자 스레드를 시작할 수 있습니다. 작업자를 정의하는 파일은 다른 처리 파일과 별도로 생성된다고 가정합니다.

// worker.js
import { defineSyncWorker } from "sync-actions";

export const { actions, worker } = defineSyncWorker(import.meta.filename, {
  ping: async () => {
    // Execute asynchronous process,
    await new Promise((resolve) => setTimeout(resolve, 1000));
    // Return the result as a return value
    return "pong";
  }
}).launch();

// main.js
import { actions, worker } from "./worker.js";

// You can execute asynchronous functions synchronously
console.log(actions.ping()); // => "pong" is output after 1 second

worker.terminate();

유형이 안전한 함수 호출

TypeScript에서는 유형이 안전한 방식으로 DefineSyncWorker로 정의된 함수를 호출할 수 있습니다.

// worker.ts
import { defineSyncWorker } from "sync-actions";

export const { actions, worker } = defineSyncWorker(import.meta.filename, {
  // By specifying the types of arguments and return values, type-safe calls are possible
  add: async (a: number, b: number): Promise<number> => {
    return a + b;
  }
}).launch();

// main.ts
import { actions, worker } from "./worker.js";

// Type-safe call
actions.add(1, 2); // => 3 (number)

// @ts-expect-error
actions.add("1", 2);
// => Argument of type 'string' is not assignable to parameter of type 'number'

worker.terminate();

배경

지금까지의 내용은 README와 동일하므로, 제작 배경을 설명하겠습니다.

Accel Record라는 ORM을 개발 중입니다.¹ 일반적인 ORM과 달리 Accel Record는 동기식 인터페이스로 DB 접근을 수행하도록 설계되어 있습니다.² DB 접근을 동기적으로 수행하는 부분 child_process 모듈로 시작된 하위 프로세스에서 비동기 프로세스를 실행하여 구현되었습니다.³ 대신에 Worker_threads를 사용하면 된다고 생각했습니다. child_process를 사용하면 런타임 시 오버헤드를 줄일 수 있습니다.

Accel Record도 사용성 측면에서 Ruby on Rails의 Active Record와 유사하게 설계되었으며, 앞으로 이루고 싶은 것 중 하나가 CarrierWave와 같은 라이브러리를 만드는 것입니다. CarrierWave를 사용하면 레코드 저장 시 외부 스토리지 서비스(예: AWS S3)에 이미지를 저장할 수 있으며, Accel Record를 사용하여 이를 달성하려면 이미지 업로드와 같은 비동기 프로세스를 동기식으로 실행해야 합니다. 서브 프로세스 대신에 Worker_thread를 사용하면 이 프로세스를 더 빠르게 실행할 수 있을 것으로 기대합니다.

그래서 저는 Worker_threads를 사용하여 비동기 프로세스를 동기적으로 실행하는 라이브러리를 찾아본 적이 있습니다. synckit 및 deasync와 같은 여러 라이브러리를 찾았지만 그 중 어느 것도 내 쪽에서는 예상대로 작동하지 않았기 때문에 직접 만들기로 결정했습니다. 그러다 보니 TypeScript로 안전하게 사용할 수 있는 인터페이스를 만들어야겠다는 생각이 들었습니다.

더 많은 내부 세부정보

• worker_threads로 시작된 하위 스레드의 비동기 프로세스가 완료될 때까지 메인 스레드는 Atomic.wait()를 사용하여 차단됩니다.
• MessageChannel은 스레드 간 통신에 사용됩니다. 이 부분의 구현에는 싱크킷의 소스코드가 큰 도움이 되었습니다.
• worker_threads로 워커를 시작할 때 .ts 파일을 .js로 트랜스파일해야 합니다. 그 부분에 대해서는 esbuild를 사용하고 있습니다.
• Worker를 시작할 때 트랜스파일된 소스 코드를 Worker에 문자열로 전달하여 실행하려고 했는데 제 환경에서는 제대로 작동하지 않았습니다. 제가 가장 고민했던 부분이 바로 이 부분입니다. 결국 node_modules 아래에 파일을 작성하고 해당 경로를 Worker에 전달했습니다. 이 방법이 가장 안정적인 것으로 나타났습니다.

---

1. "Accel Record" 소개: 액티브 레코드 패턴을 사용하는 TypeScript ORM ↩

2. 새로운 TypeScript ORM을 위해 동기식 API를 채택한 이유 ↩

3. TypeScript의 동기식 DB 액세스 기술 ↩

위 내용은 JS/TS에서 비동기 프로세스의 동기 실행을 위한 라이브러리 출시의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!