AllTheDucks / jshack-v1

JSHack Version One
8 stars 3 forks source link

Deprecate injection end points #9

Open Sephster opened 3 years ago

Sephster commented 3 years ago

We are looking to move to Ultra based navigation (UBN) and had to review JSHack's functionality. The top frameset option does not work in UBN but edit and system page appear to work fine.

While working on this, I noticed that the renderingHook doesn't support the global nav and breadcrumb hooks any more so thought I'd submit a PR to remove these.

Happy to update the wiki too with my findings on UBN if this is wanted? Please do shout if I've missed anything with this PR and apologies if I've made a mistake with my understanding of renderingHook's current capabilities.

Cheers, Andrew

shaneargo commented 3 years ago

It would be interesting to know at what point they were deprecated.

If it was a long time ago, everything should be okay. My primary concern is related to how the system will react if someone has a hack already installed (or tries to install one - which is less of a concern) that is configured to use of these hooks.

If these hooks are no longer functional, then it is probably safe to presume that no one is actively using one, but it is possible that someone has one installed but disabled. I have seen a number of institutions with many hacks installed, but disabled.

The solution is probably to review the code that parses the hack package to make sure we appropriately handle an unknown hook key.

Sephster commented 3 years ago

Hi Shane. Yeah I was wondering that myself. I looked back at the API docs as far as I could go and none of them listed the deprecated hooks so I think they haven't been supported in Blackboard for a while now.

I could do two things as per your suggestions:

I think the second point will need to be done regardless of what the outcome of the first is but the investigation will probably dictate the wording here. If you are happy for me to take a look at this, I will update this PR accordingly. Cheers