Greenstand/treetracker-query-api

Extend the BaseRepository to support: add

Open

#23 opened on Dec 30, 2021

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)TypeScript (65 forks)auto 404
Node.jsgood first issuepostgresql

Repository metrics

Stars
 (17 stars)
PR merge metrics
 (PR metrics pending)

Description

The function is for creating a new entity in the database.

The function signature should like:

add<T>(object: T>: T

So the subclass can do:

TokenRepository.add(token)

Possible edge cases:

  • Unexpected property: id. (422 HTTP code with error message)
  • Maybe there are some cases that database will throw error like, foreign key violation, we should translate this type of exception to : (500, database exception)

Some hints:

  • Please read our readme for more information/guide/tutorial.
  • Here is an engineering book in Greenstand.
  • To know more about our organization, visit our website.
  • If you want to join the slack community (some resources need the community member's permission), please leave your email address.

Contributor guide

Research direction
Implement the add method in BaseRepository with the specified signature, handle the id property (return 422 if provided), and catch database exceptions (e.g., foreign key violation) and translate to 500 with error message. Refer to the repository's readme and engineering book for patterns.
Tech stack
typescript
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75