download-base-url in fpm

[amitu]

Status: Done

Owner: @AbrarNitk
Started On: 29th Aug 2022
Discord Thread

TODO

• deploy one fpm package on heroku with documentation
• It should work with Django(ftd-py)

7th Sep 2022

• One Endpoint which will clear the cache(downloaded files and packages)
  • PR
  • Discussion

30th Aug 2022

• document it
• implement it: download-base-url in Package and CLI Parameter #459

---

FPM will start with a download-base-url as cli argument, and it will not have any content on the disc with it starts. When a document is needed it will be downloaded and cached on file system.

How would we redeploy?

We will give an end point that will clear all the cached files on file system. The end point can also accept a list of files to clear specifically, in case someone wants to do a better integration based on files changed in this commit.

This will have to have some security, some shared secret maybe. Technically attacker is not really getting any advantage. So we may not even need this.

Run FPM On Heroku

With this feature we can easily run fpm on a heroku instance.

Django

Once this is implemented Django will not have to store ftd files along with Django files.

[amitu]

@AbrarNitk, @Arpita-Jaiswal We renamed this feature from base url to package url because we had a conflict, --base is already used for another purpose. But then we also use a field named base in FPM.ftd.

-- fpm.package: fpm.dev
zip: github.com/fifthtry/fpm.dev/archive/refs/heads/main.zip
base: https://raw.githubusercontent.com/fifthtry/fpm.dev/main

I think both this feature and the base field should use similar terminology. Calling it package url is not enough because:

-- fpm.package: fpm.dev
zip: github.com/fifthtry/fpm.dev/archive/refs/heads/main.zip
package-url: https://raw.githubusercontent.com/fifthtry/fpm.dev/main

Does not look good. The "package url" for the package fpm.dev is https://fpm.dev. Maybe we call it partial-download-url? Or download-base-url?

[Arpita-Jaiswal]

download-base-url looks good to me and abrar.
FYI: @amitu

[amitu]

@AbrarNitk update the titles etc everywhere.