Notes about outstanding issues and how we might proceed

[RobinDaugherty]

Here are the issues that I'm hoping to solve. Dropping this here just to have a record, I haven't triaged this list yet.

• Singleton, can't be stubbed for testing
• No tests
• Parameter names mimic the naming convention without actually following them.
• Some configuration in a config object, some not.
• Requires a "file type".
  • Supposed to be an extension including dot. It's an optional, but force-unwrapped when upload starts.
• Moves the file you ask it to upload. And deletes it when done.
  • "id" of upload is used as file name when moving. No escaping in this, so if it contains a slash, will fail.
• Log levels are upside down and broken. Only "All" really works.
• chunkSize is in megabytes. Not documented.
• Force-unwrapping. Force-unwrapping everywhere.
• Stores a "status" in userdefaults, so if an upload was ever started and the app crashed/quit, TUSKit will never work again.
  • TUSClientStaus typo'd class name
  • Why is this stored in user defaults? If the app relaunches, there might be incomplete uploads, and those should be fetched from userdefaults. But the "current status" doesn't carry across executions.
  • Makes it seem like it will handle resumption when app comes back to foreground or launches after a crash, but there's no method to resume operation at app launch.
• README says to call cleanUpAll but that doesn't exist. It's cleanUp()
  • Calling this doesn't fix stuck status, it remains "uploading" even when there are no uploads.
• cancel does nothing. cancelAll does nothing in a loop.
• Content Length, offset, etc, are stored as an (optional) string.
• All data is loaded into memory, including ALL CHUNKS.
• Doesn't actually retry any failures. Swallows URL request failure without a log message.
• Delegate is poorly constructed and named.
  • failure method is notified of any failure, even if unrelated to an upload. for example, if cleanup() is called and the file can't be deleted.
• TUSResponse is an error from inside the library, which should be an Error object.
• Progress method crashes because the upload object has no offset or length. Is it possible this is only for files that fit in a single chunk?