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

disable call caching for various workflows #251

Merged
merged 12 commits into from
Dec 5, 2023

Conversation

kapsakcj
Copy link
Contributor

@kapsakcj kapsakcj commented Nov 17, 2023

Need to test in Terra, but wanted to at least get the draft PR in place.

Testing is done in Terra, ready for review and further testing. I would recommend that the reviewer re-launches workflows on the dev branch cjk-disable-call-cache for workflows that have been run previously. If you don't have previous workflows, launch the workflow twice. Ensure the call cache box IS CHECKED (default behavior) and inspect job manager to ensure cache was not used for the updated WDL tasks

Closes #250 #235

🛠️ Changes Being Made

Added this code to a few different task files:

  meta {
    # added so that call caching is always turned off
    volatile: true
  }

So that call caching is disabled when running these workflows in Terra. In my opinion these are workflows where the expected behavior is to always run from the beginning, regardless of previous attempts.

The benefit of knowing the output files are fresh & not having to troubleshoot after a user accidentally forgets to disable the call caching feature in Terra (which is on by default) far outweigh the benefit of saving on compute time.

Impacted Workflows/Tasks

  • basespace_fetch task and workflow
  • transfer_column_content task and workflow
  • and ncbi_datasets task which impacts assembly_fetch workflow and Snippy_streamline workflow
    • enabled multi-threading for transfer_column_content task: added this flag gsutil -m
  • theiavalidate workflow tasks, export_two_tsvs and compare_two_tsvs,

🧠 Context and Rationale

See above for rationale

📋 Workflow/Task Steps

N/A

Inputs

N/A

Outputs

N/A

Impacted Outputs

🧪 Testing

Locally

Did not test locally, change is most relevant to Terra environment. Although these files pass miniwdl check syntax check.

Terra

Will add test workflows later

Scenarios for Reviewer to Test

Would be good to re-launch workflows that have been run in the past. Then inspect the Job Manager in Terra and ensure call caching is off for the specified task.

🔬 Quality checks

Pull Request (PR) checklist:

  • Include a description of what is in this pull request in this message.
  • The workflow/task has been tested locally and on Terra
  • The CI/CD has been adjusted and tests are passing
  • Everything follows the style guide

…nt task, and ncbi_datasets task. enabled multi-threading for transfer_column_content task also
@kapsakcj
Copy link
Contributor Author

Perhaps also add to export_taxon_tables task? specifically to tasks/utilities/task_broad_terra_tools.wdl

Is this another task that should always run fresh every time? I think yes to prevent from previous workflow outputs from being kept, despite the workflow being re-run.

@kapsakcj
Copy link
Contributor Author

kapsakcj commented Nov 29, 2023

⚠️ Need to ensure that the call-caching box IS CHECKED at all times during these tests

workflow tests:

@kapsakcj kapsakcj marked this pull request as ready for review December 1, 2023 16:47
Copy link
Member

@sage-wright sage-wright left a comment

Choose a reason for hiding this comment

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

@sage-wright sage-wright linked an issue Dec 5, 2023 that may be closed by this pull request
@sage-wright sage-wright merged commit 53f3f0a into main Dec 5, 2023
16 checks passed
@kapsakcj kapsakcj deleted the cjk-disable-call-caching branch December 29, 2023 17:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

disable call caching for transfer_column_content workflow disable call caching for theiavalidate workflow
2 participants