cr-connect-workflow/crc/scripts/is_file_uploaded.py

from SpiffWorkflow.util.metrics import timeit

from crc.scripts.script import Script
from crc.services.user_file_service import UserFileService


class IsFileUploaded(Script):

    def get_description(self):
        return """Test whether a file is uploaded for a study. 
                  Pass in the IRB Doc Code for the file."""

    def do_task_validate_only(self, task, study_id, workflow_id, *args, **kwargs):
        return self.do_task(task, study_id, workflow_id, *args, **kwargs)

    def do_task(self, task, study_id, workflow_id, *args, **kwargs):

        doc_code = args[0]
        files = UserFileService.get_files_for_study(study_id, irb_doc_code=doc_code)
        for file in files:
            if file.archived is False:
                return True
        return False
Performance Improvements: 1. Avoid ever re-generating the list of scripts that can be used in a script task. Terribly expensive as we call eval constantly, and it never ever changes once the app starts. (see script.py changes, and comments) 2. Cache the DocumentStatus list in the flask session, so we calculate it at most once per API Call. It's at least .25 seconds per call. (see study_sevice) 3. We called UserFileService.get_files_for_study (which runs a db query EVERY time) for every possible document type. Now we run the query once (study service line 321) 4. When returning a workflow, we looped through every single task in that workflow's navigation, and called the expensive spiff_task_to_api_task just to figure out it's proper display name. We run a much faster and more efficient method to calculate the display name naow (see workflow_service on lie 680, and 799) 5. A hellton of @timeit and sincetime() calls, that I want to leave in, to help debug any slowness on production. 2022-02-24 14:25:42 -05:00			`from SpiffWorkflow.util.metrics import timeit`

Ticket 143. Test whether file is uploaded. 2021-01-04 10:53:21 -05:00			`from crc.scripts.script import Script`
1. Created a UserFileService, so it's clear what we use when for File Services, UserFiles, SpecFiles, and ReferenceFiles each function differently. 2. Reference Files and Spec Files are written to disk, they do not exist in the database at all. 2022-02-02 12:59:56 -05:00			`from crc.services.user_file_service import UserFileService`
Ticket 143. Test whether file is uploaded. 2021-01-04 10:53:21 -05:00

			`class IsFileUploaded(Script):`

			`def get_description(self):`
			`return """Test whether a file is uploaded for a study.`
			`Pass in the IRB Doc Code for the file."""`

			`def do_task_validate_only(self, task, study_id, workflow_id, args, *kwargs):`
return something for the validation 2022-04-19 08:01:18 -04:00			`return self.do_task(task, study_id, workflow_id, args, *kwargs)`
Ticket 143. Test whether file is uploaded. 2021-01-04 10:53:21 -05:00
			`def do_task(self, task, study_id, workflow_id, args, *kwargs):`

Performance Improvements: 1. Avoid ever re-generating the list of scripts that can be used in a script task. Terribly expensive as we call eval constantly, and it never ever changes once the app starts. (see script.py changes, and comments) 2. Cache the DocumentStatus list in the flask session, so we calculate it at most once per API Call. It's at least .25 seconds per call. (see study_sevice) 3. We called UserFileService.get_files_for_study (which runs a db query EVERY time) for every possible document type. Now we run the query once (study service line 321) 4. When returning a workflow, we looped through every single task in that workflow's navigation, and called the expensive spiff_task_to_api_task just to figure out it's proper display name. We run a much faster and more efficient method to calculate the display name naow (see workflow_service on lie 680, and 799) 5. A hellton of @timeit and sincetime() calls, that I want to leave in, to help debug any slowness on production. 2022-02-24 14:25:42 -05:00			`doc_code = args[0]`
			`files = UserFileService.get_files_for_study(study_id, irb_doc_code=doc_code)`
We archive files now, we don't delete them 2022-04-15 11:44:38 -04:00			`for file in files:`
			`if file.archived is False:`
			`return True`
			`return False`