This repository was archived by the owner on Aug 4, 2025. It is now read-only.
[PF-308] Add GCS bucket and bigquery data references #212
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| package bio.terra.workspace.app.controller; | ||
|
|
||
| import bio.terra.workspace.app.controller.common.ReferenceController; | ||
| import bio.terra.workspace.common.utils.ControllerTranslationUtils; | ||
| import bio.terra.workspace.generated.controller.DataRepoReferenceApi; | ||
| import bio.terra.workspace.generated.model.CreateDataRepoSnapshotReferenceRequestBody; | ||
| import bio.terra.workspace.generated.model.DataRepoSnapshotReference; | ||
| import bio.terra.workspace.generated.model.UpdateDataReferenceRequestBody; | ||
| import bio.terra.workspace.service.datareference.DataReferenceService; | ||
| import bio.terra.workspace.service.datareference.model.DataReference; | ||
| import bio.terra.workspace.service.datareference.model.DataReferenceType; | ||
| import bio.terra.workspace.service.datareference.model.SnapshotReference; | ||
| import bio.terra.workspace.service.datareference.utils.DataReferenceValidationUtils; | ||
| import bio.terra.workspace.service.iam.AuthenticatedUserRequest; | ||
| import bio.terra.workspace.service.iam.AuthenticatedUserRequestFactory; | ||
| import java.util.UUID; | ||
| import javax.servlet.http.HttpServletRequest; | ||
| import javax.validation.Valid; | ||
| import org.springframework.beans.factory.annotation.Autowired; | ||
| import org.springframework.http.HttpStatus; | ||
| import org.springframework.http.ResponseEntity; | ||
| import org.springframework.stereotype.Controller; | ||
| import org.springframework.web.bind.annotation.PathVariable; | ||
| import org.springframework.web.bind.annotation.RequestBody; | ||
|
|
||
| @Controller | ||
| public class DataRepoReferenceController extends ReferenceController | ||
| implements DataRepoReferenceApi { | ||
|
|
||
| private final DataReferenceValidationUtils dataReferenceValidation; | ||
| private final DataReferenceService dataReferenceService; | ||
| private final AuthenticatedUserRequestFactory authenticatedUserRequestFactory; | ||
| private final HttpServletRequest request; | ||
|
|
||
| @Autowired | ||
| public DataRepoReferenceController( | ||
| DataReferenceValidationUtils dataReferenceValidation, | ||
| DataReferenceService dataReferenceService, | ||
| AuthenticatedUserRequestFactory authenticatedUserRequestFactory, | ||
| HttpServletRequest request) { | ||
| this.dataReferenceValidation = dataReferenceValidation; | ||
| this.dataReferenceService = dataReferenceService; | ||
| this.authenticatedUserRequestFactory = authenticatedUserRequestFactory; | ||
| this.request = request; | ||
| } | ||
|
|
||
| private AuthenticatedUserRequest getAuthenticatedInfo() { | ||
| return authenticatedUserRequestFactory.from(request); | ||
| } | ||
|
|
||
| @Override | ||
| public ResponseEntity<DataRepoSnapshotReference> createDataRepoSnapshotReference( | ||
| UUID id, @Valid CreateDataRepoSnapshotReferenceRequestBody body) { | ||
| SnapshotReference referenceObject = | ||
| SnapshotReference.create( | ||
| body.getSnapshot().getInstanceName(), body.getSnapshot().getSnapshot()); | ||
| DataReference reference = | ||
| createDataReference( | ||
| id, | ||
| body.getMetadata(), | ||
| DataReferenceType.DATA_REPO_SNAPSHOT, | ||
| referenceObject, | ||
| getAuthenticatedInfo(), | ||
| dataReferenceValidation, | ||
| dataReferenceService); | ||
|
|
||
| DataRepoSnapshotReference response = | ||
| new DataRepoSnapshotReference() | ||
| .metadata(ControllerTranslationUtils.metadataFromDataReference(reference)) | ||
| .snapshot(((SnapshotReference) reference.referenceObject()).toApiModel()); | ||
| return new ResponseEntity<>(response, HttpStatus.OK); | ||
| } | ||
|
|
||
| @Override | ||
| public ResponseEntity<DataRepoSnapshotReference> getDataRepoSnapshotReference( | ||
| UUID id, UUID referenceId) { | ||
| DataReference ref = getReference(id, referenceId, getAuthenticatedInfo(), dataReferenceService); | ||
|
|
||
| DataRepoSnapshotReference response = | ||
| new DataRepoSnapshotReference() | ||
| .snapshot(((SnapshotReference) ref.referenceObject()).toApiModel()) | ||
| .metadata(ControllerTranslationUtils.metadataFromDataReference(ref)); | ||
| return new ResponseEntity<>(response, HttpStatus.OK); | ||
| } | ||
|
|
||
| @Override | ||
| public ResponseEntity<DataRepoSnapshotReference> getDataRepoSnapshotReferenceByName( | ||
| UUID id, String name) { | ||
| DataReference ref = | ||
| getReferenceByName( | ||
| id, | ||
| DataReferenceType.DATA_REPO_SNAPSHOT, | ||
| name, | ||
| getAuthenticatedInfo(), | ||
| dataReferenceService); | ||
| DataRepoSnapshotReference response = | ||
| new DataRepoSnapshotReference() | ||
| .snapshot(((SnapshotReference) ref.referenceObject()).toApiModel()) | ||
| .metadata(ControllerTranslationUtils.metadataFromDataReference(ref)); | ||
| return new ResponseEntity<>(response, HttpStatus.OK); | ||
| } | ||
|
|
||
| @Override | ||
| public ResponseEntity<Void> updateDataRepoSnapshotReference( | ||
| @PathVariable("id") UUID id, | ||
| @PathVariable("referenceId") UUID referenceId, | ||
| @RequestBody UpdateDataReferenceRequestBody body) { | ||
| updateReference(id, referenceId, body, getAuthenticatedInfo(), dataReferenceService); | ||
| return new ResponseEntity<>(HttpStatus.NO_CONTENT); | ||
| } | ||
| } | ||
|
Contributor
There was a problem hiding this comment. also from #221 this needs to include |
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why do we need to unpack this into the source tree?
Is an alternative to copy our resources into the build tree?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be nice to deploy our yaml file into a build dir so we could use relative (non-upward) paths.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I unpacked it into the source tree so that our swagger-ui (also in the source dir) can parse references to it. otherwise, those schemas won't show up in swagger-ui, which breaks example values.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can leave it for now. I'll make a ticket.
Another approach might be to move all of the parts into a build subdirectory and do the codegen from there.
I'll make a ticket.