同期処理をサポートしてほしい

[koichimurakami]

CQRSで処理する際は非同期処理を基本としていますが、同期処理をしたい場面もあると思います。
また、当初同期処理で実装していたが、非同期処理に変更したい場面もあるかもしれないです。
同期処理と非同期処理ではレスポントも異なると思うので完全にフラグだけで変更出来ないと思いますが、関数の引数を同一にするなど工夫して開発者の負担を減らせるようにしたいため、このフレームワークで同期処理をサポートしてほしいです。

[koichimurakami]

本件ですが、
例えばTODOを登録する場合以下のようにFunction名にAsyncを付けるか付けないかで同期・非同期を分けるとか、Function名は同じだけどoptionsに async: true を付けた場合は非同期で、async: false を付けたら非同期にする等をイメージします。

非同期処理

todo = {}
service.publishAsync(todo, options) 処理内容: (Commandテーブルに書き込み→DynamoDB Strem→Lambda→StepFunction→Dataテーブルに書き込み→RDBに書き込み)

同期処理

todo = {}
service.publish(todo, options) 処理内容: (Dataテーブルに書き込み→RDBに書き込み)

[koichimurakami]

@baquan1708
Thank you.

I think it's better to use English words instead of abbreviations for parameter names. Therefore, could you please change to?

[baquan1708]

Yes, I can. I will change opts to options. Here is the revised interface:

export interface ICommandService {
  /**
   * Publishes a command and processes it synchronously.
   *
   * @param {CommandInputModel} input - The complete command data to be published.
   * @param {ICommandOptions} options - Options for command execution, including context and additional parameters.
   * @returns {Promise<CommandModel>} The published command model.
   * @throws {BadRequestException} If the item does not exist or the input version is invalid.
   */
  publishSync(
    input: CommandInputModel,
    options: ICommandOptions,
  ): Promise<CommandModel>

  /**
   * Publishes a command and processes it asynchronously.
   *
   * @param {CommandInputModel} input - The complete command data to be published.
   * @param {ICommandOptions} options - Options for command execution, including context and additional parameters.
   * @returns {Promise<CommandModel|null>} The published command model, or `null` if the command was not updated (not dirty).
   * @throws {BadRequestException} If the input version is invalid.
   */
  publishAsync(
    input: CommandInputModel,
    options: ICommandOptions,
  ): Promise<CommandModel | null>

  /**
   * Publishes a partial command and processes it synchronously.
   *
   * @param {CommandPartialInputModel} input - The partial data used to update the command item.
   * @param {ICommandOptions} options - Options for command execution, including context and additional parameters.
   * @returns {Promise<CommandModel>} The updated command model after the publish operation.
   * @throws {BadRequestException} If the item does not exist for the provided keys.
   */
  publishPartialUpdateSync(
    input: CommandPartialInputModel,
    options: ICommandOptions,
  ): Promise<CommandModel>

  /**
   * Publishes a partial command and processes it asynchronously.
   *
   * @param {CommandPartialInputModel} input - The partial data used to update the command item.
   * @param {ICommandOptions} options - Options for command execution, including context and additional parameters.
   * @returns {Promise<CommandModel>} The updated command model after the publish operation.
   * @throws {BadRequestException} If the item does not exist for the provided keys.
   */
  publishPartialUpdateAsync(
    input: CommandPartialInputModel,
    options: ICommandOptions,
  ): Promise<CommandModel>
}

[koichimurakami]

Thank you.
Could you proceed with the implementation of this function?

[baquan1708]

Certainly! I'll proceed with implementing this function right away.

[baquan1708]

@koichimurakami cc: @Tuan-Anh-Nguyen-pionero

I've just created PR: #74. When you have a moment, could you please review it?

[koichimurakami]

Release Info in Japanese: https://www.mbc-net.com/update-mbc-cqrs-%e3%82%b5%e3%83%bc%e3%83%90%e3%83%bc%e3%83%ac%e3%82%b9-%e3%83%95%e3%83%ac%e3%83%bc%e3%83%a0%e3%83%af%e3%83%bc%e3%82%af-ver-0-1-35-beta-core%e3%81%ab%e5%90%8c%e6%9c%9f%e5%87%a6%e7%90%86/