bcgov / bcgov/entity

Rename output attachment filenames to follow standard pattern

Open
#15,874 0 comments 0 reactions 0 assignees View on GitHub
ENTITY - DO NOT USE techdebt
Dominant language
JavaScript
Stars
23
Forks
62
Avg merge
24m
Merged PRs (30d)
1

Description

## What is the problem?
Output attachment file names currently contain mixed case, spaces and don't include a unique identifier.

## What is the impact and proposed solution
As pointed out in recent PR comments, it would be better if our all our output attachment filenames:
- didn't contain spaces (spaces in filenames make for more difficult scripting)
- didn't contain mixed case (different operating systems handle the upper- and lower-case letters differently)
- included a unique_id (since users download the same type of file for multiple clients and using the same filename can cause confusion. Which "incorporation application.pdf" was for ABC Corp?)

Thanks @thorwolpert https://github.com/bcgov/lear/pull/1980#discussion_r1157909599

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the linked PR discussion at github.com/bcgov/lear/pull/1980#discussion_r1157909599, then trace where output attachment filenames are produced. Confirm the exact standard pattern and update all affected outputs so names have no spaces or mixed case and include a unique_id; done means every output attachment follows that pattern.

Written by the indexing model from the issue text.

Assessment

Domain
backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.