orca-nrw / crossplatform-moodle-lti-plugin

GNU General Public License v3.0
3 stars 5 forks source link

PLUGIN1-MOODLE Please integrate submodule "clientapp" via https or remove entirely from release. #85

Open tsbartel opened 1 year ago

tsbartel commented 1 year ago

Describe the bug The submodule clientapp is currently integrated via SSH, which raises issues when adding the plugin crossplatform-moodle-lti-plugin as a submodule behind a firewall. Specifically, trying to recursively update all submodules in a given Moodle codebase, the clientapp one fails if outgoing SSH connections are blocked (which they should be!). In combination with the error message, the accompanying timeout is a considerable nuisance when managing the Moodle codebase.

To Reproduce Steps to reproduce the behaviour:

  1. Behind a firewall blocking all outgoing traffic except a working HTTP & HTTPS-Proxy.
  2. Create a clone of this repository or add it as a submodule to an existing moodle repository:
    git clone https://github.com/orca-nrw/crossplatform-moodle-lti-plugin.git moodle-mod_orcalti
    git submodule add https://github.com/orca-nrw/crossplatform-moodle-lti-plugin.git mod/orcalti
  3. Within the cloned plugin repository / main moodle repository, update all submodules:
    git submodule sync
    git submodule update --recursive --force --init
  4. See error:
    
    Submodule 'clientapp' (git@github.com:orca-nrw/crossplatform-lti-plugin.git) registered for path 'clientapp'
    Cloning into 'moodle-mod_orcalti/clientapp'...
    ssh: connect to host github.com port 22: Connection timed out
    fatal: Could not read from remote repository.

Please make sure you have the correct access rights and the repository exists. fatal: clone of 'git@github.com:orca-nrw/crossplatform-lti-plugin.git' into submodule path 'moodle-mod_orcalti/clientapp' failed Failed to clone 'clientapp'. Retry scheduled



**Expected behaviour**
Initialization / Update of submodules should work with minimal adjustments to security rules (firewall).

**Possible solutions / proposals**
As far as we can tell, the submodule is used in development, not in production - as such it should ideally be removed entirely from future releases. (Or at the very least be integrated via HTTPS.)

**Software versions (please complete the following information):**
 - git 2.25.1
 - Ubuntu 20.04 LTS
KaiOrca commented 1 year ago

Thank you for submitting. This Ticket will be adressed in ORCA-1638