File named `__Intake_NOTES_w_all_Variables.yml` results in invalid Docassemble package

SuffolkLITLab / docassemble-ALWeaver

A tool to help quickly generate draft interviews from an existing document (pdf or DOCX) for the docassemble platform.

https://apps-test.suffolklitlab.org/start/ALWeaver/assembly_line/#/1

MIT License

19 stars 6 forks source link

File named `__Intake_NOTES_w_all_Variables.yml` results in invalid Docassemble package #561

Closed nonprofittechy closed 2 years ago

nonprofittechy commented 2 years ago

When you run a file with the original DOCX file name 01 - Intake variables.docx and accept all defaults in the Weaver, the package that is created has a YAML file name, __Intake_NOTES_w_all_Variables.yml, that doesn't load correctly in the playground. The YAML file is presumably screened out by Docassemble's security measures.

We may want to just make sure that all filenames start with letters and not underscores.

BryceStevenWilley commented 2 years ago

Just so I'm understanding things right, 01 - Intake variables.docx file is included the downloaded zip, it just doesn't get uploaded to the playground properly? We can patch that, but IMO that doesn't sense make for DA web to filter files starting with a number, and should consider patching upstream.

Edit: read over the comment too quickly, and it looks like the problem is that the file starts with an underscore (which is missing from the title). Still feels like that shouldn't happen IMO.

nonprofittechy commented 2 years ago

Sorry, original issue was a bit confusing. The input filename causes us to make a question YAML that docassemble won't accept. __ABC is a weird interview prefix for us to use though, even though it's technically a valid variable name prefix, so I think it would be fine for us to just follow Docassemble's over zealous sanitizing here.