Store Show uploads in folder named after Show ID instead of Show Slug

Parent: [STORY] As a programme coordinator/administrato... (aura#102 - closed)

While it's handy to have a named folder for music uploads, it's generally preferred to have references in form of IDs instead of user-defined values. The current approach has implications when renaming slugs in certain scenarios.

Therefore the uploads should be stored in a folder named after the Show ID.

Additionally Tank is using the slug in API endpoints provided to Dashboard. Here the showId should be used too.

This ticket is a requirement to implement: Display and edit show slug (dashboard#100 - closed)

changed milestone to %1.0-alpha2 — Precise Pheasant

added P2 discuss labels

marked this issue as related to dashboard#100 (closed)

marked this issue as related to steering#115 (closed)

changed milestone to %1.0-alpha5 — Capable Capybara

mentioned in issue aura#102 (closed)

mentioned in issue #57 (closed)

mentioned in issue aura#192 (closed)

marked this issue as related to aura#192 (closed)

changed the description

marked this issue as related to #57 (closed)

Using the show id instead of the slug would also be preferred from the API perspective.

Oh, I wasn't aware, that Tank is also using the slug only during API conversations.

Then we definitely should change that too.

changed the description

changed the description

assigned to @eigenwijsje

changed milestone to %1.0-alpha3 — Playful Platypus

Increasing priority, since it affects the API & migration.

added P1 label and removed P2 label

added To Do label

removed To Do label

changed the description

added To Do label

added 1 deleted label

removed discuss label

mentioned in issue #65 (closed)

marked this issue as related to #65 (closed)

added Doing label and removed To Do label

marked this issue as related to steering#179 (closed)

It sounds easy but this is going to require major changes:

• the authorization scope provided by steering,
• how the authorization scope is used by tank,
• how the models for File and Playlist use the slug/show name as reference,
• how the store handles the files and the playlists,
• the routes that use the slug/show name as URL or query parameter.

An additional problem is going to be the migration of the already stored files: There is no link between the slug/show name used to store the files and the id of a show in steering.

I'm moving this to the next milestone.

Thanks for the analysis, Ernesto. Most points sound actually not too hard to change imo. Only the auth scope topic, can you please explain what's the hard part here, when using the showId instead of the showSlug?

Migrations can be happily ignored, since there are no production instances yet.

The scope ticket in steering is actually the easy part.

The remaining parts are more complicated than you think.

The requests are checked for authorization for a show in at least 21 places, this needs to be done carefully.

As you can see here, the shows table has name as primary key, that is referenced by both playlists and files, the change from name to id touches not only the models but also all the functions that do the create/update/delete the shows, files and playlists.

I can count at least 48 places where the show is referenced as a string (slug) in the importer and store modules.

And I'm sure I missed some of the uses.

Sure, but the logic stays the same. So it's more like a "find & replace all" task.

removed 1 deleted label

changed milestone to %1.0-alpha5 — Capable Capybara

removed Doing label

added 1 deleted label

added To Do label

changed milestone to %1.0-alpha3 — Playful Platypus

added Doing label and removed To Do label

as of a01bf622, it's basically done and it includes breaking changes.

• The AuthorizationInfo now includes:
  • privileged (boolean), true if the user is member of the PRIVILEGED_GROUP in steering.
  • entitled (boolean), true if the user is member of one of the ENTITLED_GROUPS in steering.
  • allShows (boolean), true if the user is allowed to see all the shows.
  • ownedShowIds (list of int), the ids of the show owned by the user,
  • publicShowIds (list of int), the ids of the public shows,
• All the API endpoints that used to have showName (string) as a query or path parameter, now have showId (int).

closed

removed Doing label