[backend] enforce agent update with user-id #246

scott-cohere · 2024-06-19T18:54:48Z

Only allow creator of agent to update the agent.

in this PR:

Update some HTTP codes to be more accurate to the actual error
Update minor string formatting for errors to be more consistent
Update the validator for update agent request to cross check the user ID is the creator of the agent
Update unit tests

AI Description

This pull request makes changes to the backend code, specifically related to agent management and validation.

Summary:

Updates the status_code from 404 to 400 for more accurate error handling when an agent is not found.
Enhances the validate_update_agent_request function to include additional checks for the agent ID and user ID, ensuring requests are properly validated.
Adjusts test cases to reflect the updated status codes and error messages.

Code Changes:

src/backend/routers/agent.py:
- Modified the status_code in the HTTPException raised when an agent is not found to 400 for more accurate error handling.
src/backend/services/request_validators.py:
- Added session: DBSessionDep as a parameter to the validate_update_agent_request function for improved validation.
- Introduced additional checks to ensure the presence of an agent ID and that the agent belongs to the user making the request.
- Updated the status_code in the HTTPException raised when the agent is not found to 400.
src/backend/tests/routers/test_agent.py:
- Adjusted the expected status codes and error messages in test cases to reflect the updates made in the code.
- Added a new test case, test_update_agent_wrong_user, to verify that an unauthorized user cannot update an agent.

src/backend/services/request_validators.py

tianjing-li

Small change required

tianjing-li

lgtm one small change

* updates * remove client changes * remove logs * use better header user id check * fix validators * typo

* add login page components * Add Register page and hooks for auth * Add the register page and connect all the frontend elements * Redirect to /login if the token expires and clean up some console errors * Add error messages for failed logins * frontend: Add Single Sign-on to Toolkit (#227) * Add Google SSO login plus OpenID components * Dynamically set SSO login buttons and show or hide username and password based on auth_strategies --------- Co-authored-by: Tianjing Li <tianjinglimail@gmail.com> * fix startup event * Fix build errors and update the API client * Fix tests by adding missing env vars Add test OIDC_WELL_KNOWN_ENDPOINT var to fixtures * Add a walkthrough guide of the toolkit (#251) * GUide * Chang * Change * Change * Update docs/walkthrough/walkthrough.md Co-authored-by: Luísa Moura <luisa@cohere.com> * Update walkthrough.md --------- Co-authored-by: Luísa Moura <luisa@cohere.com> * coral-web: fix agent info panel opening by default (#253) cast isEditAgentPanelOpen to boolean * [backend] enforce agent update with user-id (#246) * updates * remove client changes * remove logs * use better header user id check * fix validators * typo * Metrics: add middleware (#185) * Metrics: add middleware * add chat calls * merge * lint * make it async * add user id * add more fields * add retry and duration * add meta * comments * fix tests * improve error handling * rename fields * match spec * comments * clean code * only create loop when theres endpoint * add assistant id to chat * feat(toolkit): show assistant welcome message (#255) * feat(toolkit): show assistant welcome message * feat(toolkit): show assistant welcome message --------- Co-authored-by: misspia-cohere <pia@cohere.com> Co-authored-by: Tianjing Li <tianjinglimail@gmail.com> Co-authored-by: Beatrix De Wilde <128378696+BeatrixCohere@users.noreply.github.com> Co-authored-by: Luísa Moura <luisa@cohere.com> Co-authored-by: misspia-cohere <140425731+misspia-cohere@users.noreply.github.com> Co-authored-by: Scott <146760070+scott-cohere@users.noreply.github.com> Co-authored-by: Khalil Najjar <knajjars@gmail.com>

* updates * remove client changes * remove logs * use better header user id check * fix validators * typo

* add login page components * Add Register page and hooks for auth * Add the register page and connect all the frontend elements * Redirect to /login if the token expires and clean up some console errors * Add error messages for failed logins * frontend: Add Single Sign-on to Toolkit (#227) * Add Google SSO login plus OpenID components * Dynamically set SSO login buttons and show or hide username and password based on auth_strategies --------- Co-authored-by: Tianjing Li <tianjinglimail@gmail.com> * fix startup event * Fix build errors and update the API client * Fix tests by adding missing env vars Add test OIDC_WELL_KNOWN_ENDPOINT var to fixtures * Add a walkthrough guide of the toolkit (#251) * GUide * Chang * Change * Change * Update docs/walkthrough/walkthrough.md Co-authored-by: Luísa Moura <luisa@cohere.com> * Update walkthrough.md --------- Co-authored-by: Luísa Moura <luisa@cohere.com> * coral-web: fix agent info panel opening by default (#253) cast isEditAgentPanelOpen to boolean * [backend] enforce agent update with user-id (#246) * updates * remove client changes * remove logs * use better header user id check * fix validators * typo * Metrics: add middleware (#185) * Metrics: add middleware * add chat calls * merge * lint * make it async * add user id * add more fields * add retry and duration * add meta * comments * fix tests * improve error handling * rename fields * match spec * comments * clean code * only create loop when theres endpoint * add assistant id to chat * feat(toolkit): show assistant welcome message (#255) * feat(toolkit): show assistant welcome message * feat(toolkit): show assistant welcome message --------- Co-authored-by: misspia-cohere <pia@cohere.com> Co-authored-by: Tianjing Li <tianjinglimail@gmail.com> Co-authored-by: Beatrix De Wilde <128378696+BeatrixCohere@users.noreply.github.com> Co-authored-by: Luísa Moura <luisa@cohere.com> Co-authored-by: misspia-cohere <140425731+misspia-cohere@users.noreply.github.com> Co-authored-by: Scott <146760070+scott-cohere@users.noreply.github.com> Co-authored-by: Khalil Najjar <knajjars@gmail.com>

* Initial commit for Compass Tool * coral-web: update first turn suggestions (#225) * Addressed comments on the previous commit * Added custom_context to parse and filters to search * Formatting changes * feat(assistant): Update conversation header (#229) * feat(assistant): Update conversation header * feat(assistant): Update conversation header * update tooltip * fix IconButton import * Setup: fix dependencies (#243) * feat(toolkit): show conversation list on with agents list (#231) * Setup: remove redundant dependency (#244) * Improve Auth guide (#235) improve auth guide * coral-web: create agent + agent base form (#212) * create new agent form * render agents list * link back to base agent page * perform post submission actions * move input labels outside of input borders * move submit button * gen client * factor out agent base form * use default content type * list custom agents * check if agent name is unique * and deployment + env variables to agent form * add deployments * clean up * add submit modal * push to new agent page on create success * only show available deployments * remove deployments dropdown * feat: List Assistants returned from API (#242) * feat: list agents from BE * Update src/interfaces/coral_web/src/components/Conversation/MessagingContainer.tsx Co-authored-by: misspia-cohere <140425731+misspia-cohere@users.noreply.github.com> --------- Co-authored-by: misspia-cohere <140425731+misspia-cohere@users.noreply.github.com> * nits --------- Co-authored-by: Khalil Najjar <knajjars@gmail.com> * Propagate should_store logic to the File upload logic (#247) should_store logic to the attach_files_to_messages * [backend] passing in agent when calling streaming chat (#237) * initial chat changes * need to test * done * Remove old test * default model for agents right now * Organizations DB models, CRUD and tests (#238) * Organizations initial commit * Organizations initial commit * Organizations initial commit - sync main * Organizations initial commit - sync main - blacked * Organizations initial commit - sync main - lint * Organizations initial commit - sync main - tests * Organizations initial commit - sync main - tests * Organizations initial commit - review fixes * Organizations initial commit - review fixes * Split up display name and name for Tools (#241) * CHange * change * coral-web: update assistant (#248) * create new agent form * render agents list * link back to base agent page * perform post submission actions * move input labels outside of input borders * move submit button * gen client * factor out agent base form * check if agent name is unique * and deployment + env variables to agent form * add deployments * clean up * remove deployments dropdown * init agent page * create agent drawer * use agent form * add update agent request * add get agent request * fix rebase errors * remove model from agent form * add agent drawer to conversation * remove unused componenets * use new agent name for update success message * fix(toolkit): Address code feedback + improvements (#249) address code feedback improvements --------- Co-authored-by: Khalil Najjar <knajjars@gmail.com> * feat(toolkit): add/remove recently used agents (#250) * feat(toolkit): add/remove recently used agents * merge main * Add a walkthrough guide of the toolkit (#251) * GUide * Chang * Change * Change * Update docs/walkthrough/walkthrough.md Co-authored-by: Luísa Moura <luisa@cohere.com> * Update walkthrough.md --------- Co-authored-by: Luísa Moura <luisa@cohere.com> * coral-web: fix agent info panel opening by default (#253) cast isEditAgentPanelOpen to boolean * [backend] enforce agent update with user-id (#246) * updates * remove client changes * remove logs * use better header user id check * fix validators * typo * Metrics: add middleware (#185) * Metrics: add middleware * add chat calls * merge * lint * make it async * add user id * add more fields * add retry and duration * add meta * comments * fix tests * improve error handling * rename fields * match spec * comments * clean code * only create loop when theres endpoint * add assistant id to chat * feat(toolkit): show assistant welcome message (#255) * feat(toolkit): show assistant welcome message * feat(toolkit): show assistant welcome message * frontend: Login, logout, and account creation (#179) * add login page components * Add Register page and hooks for auth * Add the register page and connect all the frontend elements * Redirect to /login if the token expires and clean up some console errors * Add error messages for failed logins * frontend: Add Single Sign-on to Toolkit (#227) * Add Google SSO login plus OpenID components * Dynamically set SSO login buttons and show or hide username and password based on auth_strategies --------- Co-authored-by: Tianjing Li <tianjinglimail@gmail.com> * fix startup event * Fix build errors and update the API client * Fix tests by adding missing env vars Add test OIDC_WELL_KNOWN_ENDPOINT var to fixtures * Add a walkthrough guide of the toolkit (#251) * GUide * Chang * Change * Change * Update docs/walkthrough/walkthrough.md Co-authored-by: Luísa Moura <luisa@cohere.com> * Update walkthrough.md --------- Co-authored-by: Luísa Moura <luisa@cohere.com> * coral-web: fix agent info panel opening by default (#253) cast isEditAgentPanelOpen to boolean * [backend] enforce agent update with user-id (#246) * updates * remove client changes * remove logs * use better header user id check * fix validators * typo * Metrics: add middleware (#185) * Metrics: add middleware * add chat calls * merge * lint * make it async * add user id * add more fields * add retry and duration * add meta * comments * fix tests * improve error handling * rename fields * match spec * comments * clean code * only create loop when theres endpoint * add assistant id to chat * feat(toolkit): show assistant welcome message (#255) * feat(toolkit): show assistant welcome message * feat(toolkit): show assistant welcome message --------- Co-authored-by: misspia-cohere <pia@cohere.com> Co-authored-by: Tianjing Li <tianjinglimail@gmail.com> Co-authored-by: Beatrix De Wilde <128378696+BeatrixCohere@users.noreply.github.com> Co-authored-by: Luísa Moura <luisa@cohere.com> Co-authored-by: misspia-cohere <140425731+misspia-cohere@users.noreply.github.com> Co-authored-by: Scott <146760070+scott-cohere@users.noreply.github.com> Co-authored-by: Khalil Najjar <knajjars@gmail.com> * fix(toolkit): UX/UI improvements (#257) * Add error troubleshooting (#262) * Update chat.py --------- Co-authored-by: Jessica Wu <jessica@cohere.ai> Co-authored-by: Khalil Najjar <knajjars@gmail.com> Co-authored-by: Luísa Moura <luisa@cohere.com> Co-authored-by: Tomeu <tomeu@cohere.com> Co-authored-by: Tianjing Li <tianjinglimail@gmail.com> Co-authored-by: misspia-cohere <140425731+misspia-cohere@users.noreply.github.com> Co-authored-by: Eugene P <144219719+EugeneLightsOn@users.noreply.github.com> Co-authored-by: Scott <146760070+scott-cohere@users.noreply.github.com> Co-authored-by: Beatrix De Wilde <128378696+BeatrixCohere@users.noreply.github.com> Co-authored-by: Alex W <alex@blinkenlights.ca> Co-authored-by: misspia-cohere <pia@cohere.com>

scott-cohere added 2 commits June 19, 2024 14:43

updates

cd713c6

remove client changes

548bc7e

scott-cohere requested review from EugeneLightsOn, malexw, scottmx81, tianjing-li and a team as code owners June 19, 2024 18:54

scott-cohere had a problem deploying to development June 19, 2024 18:54 — with GitHub Actions Failure

remove logs

4b58e66

scott-cohere had a problem deploying to development June 19, 2024 19:50 — with GitHub Actions Failure

scott-cohere changed the title ~~[backend] enforce agent deletion with user-id~~ [backend] enforce agent update with user-id Jun 19, 2024

tianjing-li reviewed Jun 19, 2024

View reviewed changes

src/backend/services/request_validators.py Outdated Show resolved Hide resolved

tianjing-li requested changes Jun 19, 2024

View reviewed changes

use better header user id check

904785c

scott-cohere temporarily deployed to development June 20, 2024 14:02 — with GitHub Actions Inactive

scott-cohere requested a review from tianjing-li June 20, 2024 14:15

tianjing-li approved these changes Jun 20, 2024

View reviewed changes

fix validators

896a45c

scott-cohere had a problem deploying to development June 20, 2024 16:07 — with GitHub Actions Failure

typo

ec06cca

scott-cohere temporarily deployed to development June 20, 2024 17:43 — with GitHub Actions Inactive

scott-cohere merged commit c460c2a into main Jun 20, 2024
2 checks passed

scott-cohere deleted the scott/update-agent-restricted-to-creator branch June 20, 2024 21:36

malexw pushed a commit that referenced this pull request Jun 21, 2024

[backend] enforce agent update with user-id (#246)

27bb55c

* updates * remove client changes * remove logs * use better header user id check * fix validators * typo

sanal-cohere pushed a commit that referenced this pull request Jun 21, 2024

[backend] enforce agent update with user-id (#246)

0054efc

* updates * remove client changes * remove logs * use better header user id check * fix validators * typo

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[backend] enforce agent update with user-id #246

[backend] enforce agent update with user-id #246

scott-cohere commented Jun 19, 2024 •

edited by cohere-pr-pal bot

Loading

tianjing-li left a comment

tianjing-li left a comment

[backend] enforce agent update with user-id #246

[backend] enforce agent update with user-id #246

Conversation

scott-cohere commented Jun 19, 2024 • edited by cohere-pr-pal bot Loading

tianjing-li left a comment

Choose a reason for hiding this comment

tianjing-li left a comment

Choose a reason for hiding this comment

scott-cohere commented Jun 19, 2024 •

edited by cohere-pr-pal bot

Loading