IQSS / IQSS/dataverse-client-javascript

Inconsistency in `DatasetVersionInfo` model? (Date vs string)

オープン 初心者向け
#476 コメント 4 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
TypeScript
スター
20
フォーク
11
平均マージ
2日 5時間
マージ済み PR(30日)
1

説明

I noticed that in the DatasetVersionInfo model, the timestamps use inconsistent types:

https://github.com/IQSS/dataverse-client-javascript/blob/0043dddf5e7d9358d0dcac176cb8c0f325aab78b/src/datasets/domain/models/Dataset.ts#L25-L32

releaseTime and createTime are represented as Date objects, while lastUpdateTime is represented as an ISO 8601 string and not transformed into a Date object:

https://github.com/IQSS/dataverse-client-javascript/blob/0043dddf5e7d9358d0dcac176cb8c0f325aab78b/src/datasets/infra/repositories/transformers/datasetTransformers.ts#L237-L239

The return values from the Dataverse API for retrieving a dataset version are all consistently ISO 8601 strings:

Image

I was wondering what the reason for this is, or whether this inconsistency should be cleaned up? (If so, I'd be open to opening a PR for that)

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

src/datasets/domain/models/Dataset.ts にある参照先の DatasetVersionInfo 定義と、src/datasets/infra/repositories/transformers/datasetTransformers.ts にある変換処理から始めます。releaseTime、createTime、lastUpdateTime が Dataverse API のレスポンスと比較してどのように表現されているかを確認します。完了の条件は、モデルと transformer が3つすべてのフィールドに対して、意図的で一貫したタイムスタンプ表現を使用していることです。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
typescript
領域
api, backend-api-design
issue の種類
バグ
難易度
2/5
見積もり時間
1〜3時間
活発さ
活発
明瞭さ
おおむね明確
初心者へのやさしさ
68/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。