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.

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

remove api call ID prefix for db CRUD #105

Merged
merged 1 commit into from
Jan 22, 2025

Conversation

raylrui
Copy link
Contributor

@raylrui raylrui commented Jan 21, 2025

Fix #104 and umccr/orcabus#818

Reason: api call update according umccr/orcabus#784 and remove prefix for overall consistency in api call with db

@raylrui raylrui self-assigned this Jan 21, 2025
@@ -17,7 +17,7 @@ const SequenceRunDetailsDrawer: FC<SequenceRunDetailsDrawerProps> = ({

const { data: sequenceRunDetail, isFetching: isFetchingSequenceRunDetail } =
useSequenceRunDetailModel({
params: { path: { id: selectedSequenceRunId } },
params: { path: { id: selectedSequenceRunId?.split('.')[1] as string } },
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So this stripped the prefix out (leaving just the ULID)? umccr/orcabus#784 should basically do that so the FE don't need to this anymore.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unless there is a bug from that PR? But from testing in https://sequence.dev.umccr.org/schema/swagger-ui/# it does seems work with or without the prefixes

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, FE will need the prefix+ULID in its url for page pathway, not for api call. when make api call, ULID will be enough to find the instance. Not sure for all, but for sequence and workflow manager, so far is okay

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unless there is a bug from that PR? But from testing in https://sequence.dev.umccr.org/schema/swagger-ui/# it does seems work with or without the prefixes

And also I remove the prefix because there will a conflict like this when make api call with prefix when saving the association_id. If we keep consistency when make api call with out prefix, no conflict and no need to touch BE code
image

Copy link
Member

@williamputraintan williamputraintan Jan 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The fix here is for the API call not for FE page pathway? So the strip here makes no difference in the results?

FE will need the prefix+ULID in its url for page pathway,

Why the FE would need the prefix? Should it just pass the ID through the API?

Copy link
Contributor Author

@raylrui raylrui Jan 22, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, actually FE don't need the prefix as well, just take it directly from db read. I will have a think to remove it all...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And also I remove the prefix because there will a conflict like this when make api call with prefix when saving the association_id. If we keep consistency when make api call with out prefix, no conflict and no need to touch BE code

I think the logic should then be in BE so that any client using the API should not care about this? Perhaps if think we could just change this association_id to become OrcaBusIdField instead of CharField then the stripping will be handled automatically.

@raylrui
Copy link
Contributor Author

raylrui commented Jan 22, 2025

As discussed, couple with db field change to "OrcaBusIdField" umccr/orcabus#820

@raylrui
Copy link
Contributor Author

raylrui commented Jan 23, 2025

wait to be revert as fix PR in bacnkend here

@raylrui raylrui deleted the fix/sequence-run-comment-api-remove-prefix branch February 5, 2025 04:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working fix
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Sequence run view Timeline not showing comments
2 participants