Refactor/google drive module #392

gcharest · 2024-02-02T01:36:22Z

Summary | Résumé

Fixed:

.devcontainer.json configuration and vscode settings for codespaces setup
make the new dev test commands available in dev only
update google_meet module docstring

Refactor the Google Drive integration:
Note: none of the changes below affect the app in production for the moment

split the functions using the different endpoints into each their distinct module (google_drive, google_docs, google
streamline the functions and make them reusable in different contexts
- e.g.: single function to create a new file, taking the file type as an argument instead of two separate functions
add a google api error handler wrapper function

TODO: Add the remaining functions to their respective modules and update the imports in the various commands:

get_timeline_section: Uses the Docs endpoint. This function should get a section with a start/end heading instead of using const. The implementation function needs to be adjusted.
merge_data: Uses Docs and is specific to an incident. This function should be moved to the incident helper.
replace_text_between_headings: Uses Docs and seems specific to the incident command. This function should be moved to the incident helper.
create_incident: This function should be moved to the incident helper.
close_incident_document: This function should be moved to the incident helper.
update_incident_list: This function should be moved to the incident helper.
update_spreadsheet_close_incident: This function should be moved to the incident helper.

sylviamclaughlin · 2024-02-02T01:47:39Z

app/commands/sre.py

+            if PREFIX == "dev-":
+                google_service.google_service_command(client, body, respond)
+            else:
+                respond("This command is only available in the dev environment.")


I like that you added this here!

Yeah, I figured I should setup a toggle instead of just leaving it hanging in there in prod 😅

sylviamclaughlin · 2024-02-02T01:48:55Z

app/commands/google_service.py

-        .execute()
-    )
-    return results.get("files", [])
+def google_service_command(client, body, respond):


Super nitpicky, but I would put some spacing between the end of the first function and the def googe_service_command

I think this is showing without space due to the way GitHub displays the changes inline 🤔

It shows like this in VSCode:

app/commands/google_service.py

app/integrations/google_workspace/google_drive.py

app/integrations/google_workspace/google_service.py

app/tests/integrations/google_workspace/test_google_drive_module.py

app/integrations/google_workspace/google_service.py

app/integrations/google_workspace/google_drive.py

Co-authored-by: Pat Heard <[email protected]>

github-actions · 2024-02-02T14:44:39Z

GitHub Action status on 24c101e generated by comment-failure-action

Lint, format and test code

job	url
null	https://github.com/cds-snc/sre-bot/actions/runs/7757520891/job/21157165271

Build containers CI

No jobs failed 👍

github-actions · 2024-02-02T15:38:43Z

GitHub Action status on dab733e generated by comment-failure-action

Lint, format and test code

job	url
null	https://github.com/cds-snc/sre-bot/actions/runs/7758167782/job/21159298892

Build containers CI

No jobs failed 👍

github-actions · 2024-02-02T16:41:29Z

GitHub Action status on 3b73968 generated by comment-failure-action

Lint, format and test code

job	url
null	https://github.com/cds-snc/sre-bot/actions/runs/7758929359/job/21161819765

Build containers CI

No jobs failed 👍

gcharest added 25 commits February 1, 2024 13:44

fix: render commands available in dev only

126832f

fix: move google-service command to bottom

3f0aa59

feat: make test command available in dev only

4355ba8

fix: fix mypy path for current project structure

3cc40c7

fix: update pylint cwd

a1ad43f

fix: ignore google.oauth2 missing stub warning

060b0bd

fix: config flake8 instead of pylint

4774214

feat: add a decorator to handle api calls errors

f2ec771

feat: refactor basic drive functions

2555afb

feat: add get_file_by_name function

6070afe

feat: add list metadata function

97fa78e

feat: use new drive module functions

f875a9b

fix: shorten test command

c087c41

fix: handle invalid folder

cf65333

feat: modify wrapper to provide context

b1b5de1

fix: add missing parameter to list_metadata

463464d

fix: surround function name w/ single quotes

83f2fa6

fix: google drive healthcheck

fead205

fix: matching error message

61d8c68

feat: add healtcheck message

0011722

fix: update module docstrings w/ more details

890ff08

fix: remove import from google_service

6c344f6

fix: update module docstring

02788a7

feat: add basic docstring for Docs module

332a5fe

fix: replicate current tests for conformity

aa88af7

gcharest requested a review from a team February 2, 2024 01:36

gcharest self-assigned this Feb 2, 2024

sylviamclaughlin reviewed Feb 2, 2024

View reviewed changes

app/commands/google_service.py Show resolved Hide resolved

sylviamclaughlin reviewed Feb 2, 2024

View reviewed changes

app/integrations/google_workspace/google_drive.py Show resolved Hide resolved

sylviamclaughlin reviewed Feb 2, 2024

View reviewed changes

app/integrations/google_workspace/google_service.py Show resolved Hide resolved

sylviamclaughlin reviewed Feb 2, 2024

View reviewed changes

app/tests/integrations/google_workspace/test_google_drive_module.py Outdated Show resolved Hide resolved

patheard reviewed Feb 2, 2024

View reviewed changes

app/integrations/google_workspace/google_service.py Outdated Show resolved Hide resolved

patheard reviewed Feb 2, 2024

View reviewed changes

app/integrations/google_workspace/google_drive.py Outdated Show resolved Hide resolved

fix: add loop to handle pagination

24c101e

Co-authored-by: Pat Heard <[email protected]>

gcharest added 4 commits February 2, 2024 15:06

fix: ensure all files are returned

2a0a993

fix: add test to handle pagination

68a262c

fix: log errors

129fcdd

fix: remove unused variables

dab733e

gcharest added 2 commits February 2, 2024 16:38

feat: include ValueError logging in the wrapper function

40d4413

fix: adjust tests to handle logging errors

3b73968

gcharest added 2 commits February 2, 2024 16:47

fix: test names

4ad41da

fix: lint

dda6090

gcharest enabled auto-merge (squash) February 2, 2024 16:49

patheard approved these changes Feb 2, 2024

View reviewed changes

gcharest merged commit 7504b42 into main Feb 2, 2024
7 checks passed

gcharest deleted the refactor/GoogleDriveModule branch February 2, 2024 16:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor/google drive module #392

Refactor/google drive module #392

gcharest commented Feb 2, 2024 •

edited

Loading

sylviamclaughlin Feb 2, 2024

gcharest Feb 2, 2024

sylviamclaughlin Feb 2, 2024

gcharest Feb 2, 2024

github-actions bot commented Feb 2, 2024 •

edited

Loading

github-actions bot commented Feb 2, 2024 •

edited

Loading

github-actions bot commented Feb 2, 2024 •

edited

Loading

Refactor/google drive module #392

Refactor/google drive module #392

Conversation

gcharest commented Feb 2, 2024 • edited Loading

Summary | Résumé

TODO: Add the remaining functions to their respective modules and update the imports in the various commands:

sylviamclaughlin Feb 2, 2024

Choose a reason for hiding this comment

gcharest Feb 2, 2024

Choose a reason for hiding this comment

sylviamclaughlin Feb 2, 2024

Choose a reason for hiding this comment

gcharest Feb 2, 2024

Choose a reason for hiding this comment

github-actions bot commented Feb 2, 2024 • edited Loading

Lint, format and test code

Build containers CI

github-actions bot commented Feb 2, 2024 • edited Loading

Lint, format and test code

Build containers CI

github-actions bot commented Feb 2, 2024 • edited Loading

Lint, format and test code

Build containers CI

gcharest commented Feb 2, 2024 •

edited

Loading

github-actions bot commented Feb 2, 2024 •

edited

Loading

github-actions bot commented Feb 2, 2024 •

edited

Loading

github-actions bot commented Feb 2, 2024 •

edited

Loading