Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

BCDA-7581: Utilize context logger for FHIR response writers in bcda-app #907

Merged
merged 4 commits into from
Jan 25, 2024
Merged

BCDA-7581: Utilize context logger for FHIR response writers in bcda-app #907

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d5dd6ce
adding ctxlogger to writer.go file logs
laurenkrugen-navapbc Jan 25, 2024
ed22960
missed file
laurenkrugen-navapbc Jan 25, 2024
ce81d1c
adding deployment target to dockerfile for CI
laurenkrugen-navapbc Jan 25, 2024
0a3ed38
updating dockerfile.ssas for ci
laurenkrugen-navapbc Jan 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Dockerfiles/Dockerfile.ssas
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ RUN openssl rsa -in /var/local/private.pem -outform PEM -pubout -out /var/local/

# Make sure we are in the directory to ensure the config files are resolved as expected
COPY --from=base /go/bcda-ssas-app/ /go/bcda-ssas-app/
COPY --from=base /go/bcda-ssas-app/ssas/cfg/configs /go/src/github.com/CMSgov/bcda-ssas-app/ssas/cfg/configs
COPY --from=base /go/bin/ /go/bin/
WORKDIR /go/bcda-ssas-app/ssas/

Expand Down
6 changes: 3 additions & 3 deletions bcda/api/alr.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ func (h *Handler) alrRequest(w http.ResponseWriter, r *http.Request) {
log.API.Error(err.Error())
oo := responseutils.CreateOpOutcome(fhircodes.IssueSeverityCode_ERROR, fhircodes.IssueTypeCode_EXCEPTION,
responseutils.InternalErr, err.Error())
responseutils.WriteError(oo, w, http.StatusInternalServerError)
responseutils.WriteError(ctx, oo, w, http.StatusInternalServerError)
return
}

Expand All @@ -74,14 +74,14 @@ func (h *Handler) alrRequest(w http.ResponseWriter, r *http.Request) {
}
log.API.Errorf("Could not handle ALR request %s", err.Error())
oo := responseutils.CreateOpOutcome(fhircodes.IssueSeverityCode_ERROR, fhircodes.IssueTypeCode_EXCEPTION, responseutils.DbErr, "")
responseutils.WriteError(oo, w, http.StatusInternalServerError)
responseutils.WriteError(ctx, oo, w, http.StatusInternalServerError)
return
}

if err = tx.Commit(); err != nil {
log.API.Errorf("Failed to commit transaction %s", err.Error())
oo := responseutils.CreateOpOutcome(fhircodes.IssueSeverityCode_ERROR, fhircodes.IssueTypeCode_EXCEPTION, responseutils.DbErr, "")
responseutils.WriteError(oo, w, http.StatusInternalServerError)
responseutils.WriteError(ctx, oo, w, http.StatusInternalServerError)
return
}

Expand Down
65 changes: 33 additions & 32 deletions bcda/api/requests.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,9 @@ type Handler struct {
}

type fhirResponseWriter interface {
Exception(http.ResponseWriter, int, string, string)
NotFound(http.ResponseWriter, int, string, string)
JobsBundle(http.ResponseWriter, []*models.Job, string)
Exception(context.Context, http.ResponseWriter, int, string, string)
NotFound(context.Context, http.ResponseWriter, int, string, string)
JobsBundle(context.Context, http.ResponseWriter, []*models.Job, string)
}

func NewHandler(dataTypes map[string]service.DataType, basePath string, apiVersion string) *Handler {
Expand Down Expand Up @@ -147,7 +147,7 @@ func (h *Handler) BulkGroupRequest(w http.ResponseWriter, r *http.Request) {
}
fallthrough
default:
h.RespWriter.Exception(w, http.StatusBadRequest, responseutils.RequestErr, "Invalid group ID")
h.RespWriter.Exception(r.Context(), w, http.StatusBadRequest, responseutils.RequestErr, "Invalid group ID")
return
}
h.bulkRequest(w, r, reqType)
Expand All @@ -174,22 +174,22 @@ func (h *Handler) JobsStatus(w http.ResponseWriter, r *http.Request) {
statusTypes = append(statusTypes, models.JobStatus(status))
} else {
errMsg := fmt.Sprintf("Repeated status type %s", status)
h.RespWriter.Exception(w, http.StatusBadRequest, responseutils.RequestErr, errMsg)
h.RespWriter.Exception(r.Context(), w, http.StatusBadRequest, responseutils.RequestErr, errMsg)
return
}
}

// validate status types provided match our valid list of statuses
if err = h.validateStatuses(statusTypes); err != nil {
logger.Error(err)
h.RespWriter.Exception(w, http.StatusBadRequest, responseutils.RequestErr, err.Error())
h.RespWriter.Exception(r.Context(), w, http.StatusBadRequest, responseutils.RequestErr, err.Error())
return
}
}

if ad, err = readAuthData(r); err != nil {
logger.Error(err)
h.RespWriter.Exception(w, http.StatusUnauthorized, responseutils.TokenErr, "")
h.RespWriter.Exception(r.Context(), w, http.StatusUnauthorized, responseutils.TokenErr, "")
return
}

Expand All @@ -198,9 +198,9 @@ func (h *Handler) JobsStatus(w http.ResponseWriter, r *http.Request) {
logger.Error(err)

if ok := goerrors.As(err, &service.JobsNotFoundError{}); ok {
h.RespWriter.Exception(w, http.StatusNotFound, responseutils.DbErr, err.Error())
h.RespWriter.Exception(r.Context(), w, http.StatusNotFound, responseutils.DbErr, err.Error())
} else {
h.RespWriter.Exception(w, http.StatusInternalServerError, responseutils.InternalErr, "")
h.RespWriter.Exception(r.Context(), w, http.StatusInternalServerError, responseutils.InternalErr, "")
}
}

Expand All @@ -210,7 +210,8 @@ func (h *Handler) JobsStatus(w http.ResponseWriter, r *http.Request) {
}
host := fmt.Sprintf("%s://%s", scheme, r.Host)

h.RespWriter.JobsBundle(w, jobs, host)
// pass in the ctx here and log with the ctx logger
h.RespWriter.JobsBundle(r.Context(), w, jobs, host)
}

func (h *Handler) validateStatuses(statusTypes []models.JobStatus) error {
Expand All @@ -233,7 +234,7 @@ func (h *Handler) JobStatus(w http.ResponseWriter, r *http.Request) {
logger.Error(err)
//We don't need to return the full error to a consumer.
//We pass a bad request header (400) for this exception due to the inputs always being invalid for our purposes
h.RespWriter.Exception(w, http.StatusBadRequest, responseutils.RequestErr, "")
h.RespWriter.Exception(r.Context(), w, http.StatusBadRequest, responseutils.RequestErr, "")

return
}
Expand All @@ -244,7 +245,7 @@ func (h *Handler) JobStatus(w http.ResponseWriter, r *http.Request) {
// NOTE: This is a catch all and may not necessarily mean that the job was not found.
// So returning a StatusNotFound may be a misnomer
//In contrast to above, if the input COULD be valid, we return a not found header (404)
h.RespWriter.Exception(w, http.StatusNotFound, responseutils.DbErr, "")
h.RespWriter.Exception(r.Context(), w, http.StatusNotFound, responseutils.DbErr, "")

return
}
Expand All @@ -253,7 +254,7 @@ func (h *Handler) JobStatus(w http.ResponseWriter, r *http.Request) {

case models.JobStatusFailed, models.JobStatusFailedExpired:
logger.Error(job.Status)
h.RespWriter.Exception(w, http.StatusInternalServerError, responseutils.JobFailed, responseutils.DetailJobFailed)
h.RespWriter.Exception(r.Context(), w, http.StatusInternalServerError, responseutils.JobFailed, responseutils.DetailJobFailed)
case models.JobStatusPending, models.JobStatusInProgress:
w.Header().Set("X-Progress", job.StatusMessage())
w.WriteHeader(http.StatusAccepted)
Expand All @@ -262,7 +263,7 @@ func (h *Handler) JobStatus(w http.ResponseWriter, r *http.Request) {
// If the job should be expired, but the cleanup job hasn't run for some reason, still respond with 410
if job.UpdatedAt.Add(h.JobTimeout).Before(time.Now()) {
w.Header().Set("Expires", job.UpdatedAt.Add(h.JobTimeout).String())
h.RespWriter.Exception(w, http.StatusGone, responseutils.NotFoundErr, "")
h.RespWriter.Exception(r.Context(), w, http.StatusGone, responseutils.NotFoundErr, "")
return
}
w.Header().Set("Content-Type", constants.JsonContentType)
Expand Down Expand Up @@ -304,23 +305,23 @@ func (h *Handler) JobStatus(w http.ResponseWriter, r *http.Request) {
jsonData, err := json.Marshal(rb)
if err != nil {
logger.Error(err)
h.RespWriter.Exception(w, http.StatusInternalServerError, responseutils.InternalErr, "")
h.RespWriter.Exception(r.Context(), w, http.StatusInternalServerError, responseutils.InternalErr, "")
return
}

_, err = w.Write([]byte(jsonData))
if err != nil {
logger.Error(err)
h.RespWriter.Exception(w, http.StatusInternalServerError, responseutils.InternalErr, "")
h.RespWriter.Exception(r.Context(), w, http.StatusInternalServerError, responseutils.InternalErr, "")
return
}

w.WriteHeader(http.StatusOK)
case models.JobStatusArchived, models.JobStatusExpired:
w.Header().Set("Expires", job.UpdatedAt.Add(h.JobTimeout).String())
h.RespWriter.Exception(w, http.StatusGone, responseutils.NotFoundErr, "")
h.RespWriter.Exception(r.Context(), w, http.StatusGone, responseutils.NotFoundErr, "")
case models.JobStatusCancelled, models.JobStatusCancelledExpired:
h.RespWriter.NotFound(w, http.StatusNotFound, responseutils.NotFoundErr, "Job has been cancelled.")
h.RespWriter.NotFound(r.Context(), w, http.StatusNotFound, responseutils.NotFoundErr, "Job has been cancelled.")

}
}
Expand All @@ -333,7 +334,7 @@ func (h *Handler) DeleteJob(w http.ResponseWriter, r *http.Request) {
if err != nil {
err = errors.Wrap(err, "cannot convert jobID to uint")
logger.Error(err)
h.RespWriter.Exception(w, http.StatusBadRequest, responseutils.RequestErr, err.Error())
h.RespWriter.Exception(r.Context(), w, http.StatusBadRequest, responseutils.RequestErr, err.Error())
return
}

Expand All @@ -342,11 +343,11 @@ func (h *Handler) DeleteJob(w http.ResponseWriter, r *http.Request) {
switch err {
case service.ErrJobNotCancellable:
logger.Info(errors.Wrap(err, "Job is not cancellable"))
h.RespWriter.Exception(w, http.StatusGone, responseutils.DeletedErr, err.Error())
h.RespWriter.Exception(r.Context(), w, http.StatusGone, responseutils.DeletedErr, err.Error())
return
default:
logger.Error(err)
h.RespWriter.Exception(w, http.StatusInternalServerError, responseutils.DbErr, err.Error())
h.RespWriter.Exception(r.Context(), w, http.StatusInternalServerError, responseutils.DbErr, err.Error())
return
}
}
Expand Down Expand Up @@ -402,7 +403,7 @@ func (h *Handler) AttributionStatus(w http.ResponseWriter, r *http.Request) {

if resp.Data == nil {
logger.Error(errors.New("Could not find any CCLF8 files"))
h.RespWriter.Exception(w, http.StatusNotFound, responseutils.NotFoundErr, "")
h.RespWriter.Exception(r.Context(), w, http.StatusNotFound, responseutils.NotFoundErr, "")
return
}

Expand Down Expand Up @@ -456,7 +457,7 @@ func (h *Handler) bulkRequest(w http.ResponseWriter, r *http.Request, reqType se

if ad, err = readAuthData(r); err != nil {
logger.Error(err)
h.RespWriter.Exception(w, http.StatusUnauthorized, responseutils.TokenErr, "")
h.RespWriter.Exception(r.Context(), w, http.StatusUnauthorized, responseutils.TokenErr, "")
return
}

Expand All @@ -469,14 +470,14 @@ func (h *Handler) bulkRequest(w http.ResponseWriter, r *http.Request, reqType se

if err = h.validateResources(resourceTypes, ad.CMSID); err != nil {
logger.Error(err)
h.RespWriter.Exception(w, http.StatusBadRequest, responseutils.RequestErr, err.Error())
h.RespWriter.Exception(r.Context(), w, http.StatusBadRequest, responseutils.RequestErr, err.Error())
return
}

bb, err := client.NewBlueButtonClient(client.NewConfig(h.bbBasePath))
if err != nil {
logger.Error(err)
h.RespWriter.Exception(w, http.StatusInternalServerError, responseutils.InternalErr, "")
h.RespWriter.Exception(r.Context(), w, http.StatusInternalServerError, responseutils.InternalErr, "")
return
}

Expand All @@ -500,7 +501,7 @@ func (h *Handler) bulkRequest(w http.ResponseWriter, r *http.Request, reqType se
if err != nil {
err = fmt.Errorf("failed to start transaction: %w", err)
logger.Error(err)
h.RespWriter.Exception(w, http.StatusInternalServerError, responseutils.InternalErr, "")
h.RespWriter.Exception(r.Context(), w, http.StatusInternalServerError, responseutils.InternalErr, "")
return
}
// Use a transaction backed repository to ensure all of our upserts are encapsulated into a single transaction
Expand All @@ -527,7 +528,7 @@ func (h *Handler) bulkRequest(w http.ResponseWriter, r *http.Request, reqType se
// We've added logic into the worker to handle this situation.
if err = tx.Commit(); err != nil {
logger.Error(err.Error())
h.RespWriter.Exception(w, http.StatusInternalServerError, responseutils.DbErr, "")
h.RespWriter.Exception(r.Context(), w, http.StatusInternalServerError, responseutils.DbErr, "")
return
}

Expand All @@ -539,7 +540,7 @@ func (h *Handler) bulkRequest(w http.ResponseWriter, r *http.Request, reqType se
newJob.ID, err = rtx.CreateJob(ctx, newJob)
if err != nil {
logger.Error(err)
h.RespWriter.Exception(w, http.StatusInternalServerError, responseutils.DbErr, "")
h.RespWriter.Exception(r.Context(), w, http.StatusInternalServerError, responseutils.DbErr, "")
return
}

Expand All @@ -560,7 +561,7 @@ func (h *Handler) bulkRequest(w http.ResponseWriter, r *http.Request, reqType se
b, err := bb.GetPatient(jobData, "0")
if err != nil {
logger.Error(err)
h.RespWriter.Exception(w, http.StatusInternalServerError, responseutils.FormatErr, "Failure to retrieve transactionTime metadata from FHIR Data Server.")
h.RespWriter.Exception(r.Context(), w, http.StatusInternalServerError, responseutils.FormatErr, "Failure to retrieve transactionTime metadata from FHIR Data Server.")
return
}
newJob.TransactionTime = b.Meta.LastUpdated
Expand Down Expand Up @@ -593,15 +594,15 @@ func (h *Handler) bulkRequest(w http.ResponseWriter, r *http.Request, reqType se
respCode = http.StatusInternalServerError
errType = responseutils.InternalErr
}
h.RespWriter.Exception(w, respCode, errType, err.Error())
h.RespWriter.Exception(r.Context(), w, respCode, errType, err.Error())
return
}
newJob.JobCount = len(queJobs)

// We've now computed all of the fields necessary to populate a fully defined job
if err = rtx.UpdateJob(ctx, newJob); err != nil {
logger.Error(err.Error())
h.RespWriter.Exception(w, http.StatusInternalServerError, responseutils.DbErr, "")
h.RespWriter.Exception(r.Context(), w, http.StatusInternalServerError, responseutils.DbErr, "")
return
}

Expand All @@ -614,7 +615,7 @@ func (h *Handler) bulkRequest(w http.ResponseWriter, r *http.Request, reqType se

if err = h.Enq.AddJob(*j, int(jobPriority)); err != nil {
logger.Error(err)
h.RespWriter.Exception(w, http.StatusInternalServerError, responseutils.InternalErr, "")
h.RespWriter.Exception(r.Context(), w, http.StatusInternalServerError, responseutils.InternalErr, "")
return
}
}
Expand Down
Loading
Loading