IQSS / IQSS/dataverse-client-javascript

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

Offen Anfängerfreundlich
#476 4 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
TypeScript
Sterne
20
Forks
11
Ø Merge
2 T. 5 Std.
Gemergte PRs (30 T.)
1

Beschreibung

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)

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der referenzierten DatasetVersionInfo-Definition in src/datasets/domain/models/Dataset.ts und der Transformation in src/datasets/infra/repositories/transformers/datasetTransformers.ts. Vergleiche, wie releaseTime, createTime und lastUpdateTime im Vergleich zur Dataverse API-Antwort dargestellt werden. Als abgeschlossen gilt die Aufgabe, wenn das Modell und der Transformer für alle drei Felder eine bewusste, konsistente Zeitstempeldarstellung verwenden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
api, backend-api-design
Issue-Typ
Bug
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Aktiv
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
68/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.