Remove unused API endpoints and unused stubbing of Profile API #567
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The `ProfileApiMock#stub_profile_api_list_school_students` helper method stubs the `ProfileApiClient.list_school_students` method. However, none of the examples in these specs result in a call to that method, so we can remove the calls. Removing these redundant calls should make the specs easier to reason about.
The `ProfileApiMock#stub_profile_api_list_school_owners` helper method stubs the `ProfileApiClient.list_school_owners` method. However, none of the examples in these specs result in a call to that method, so we can remove the calls. Removing these redundant calls should make the specs easier to reason about.
This method isn't called from anywhere in the code and, in any case, it's a no-op, because it doesn't call `ProfileApiClient.connection`, so it's safe to remove it.
I noticed that `ProfileApiClient.invite_school_owner` was a no-op, because it didn't call `ProfileApiClient.connection`, so I've removed it as well as the operation and the controller action that called it.
I noticed that `ProfileApiClient.remove_school_owner` was a no-op, because it didn't call `ProfileApiClient.connection`, so I've removed it as well as the operation and the controller action that called it.
I noticed that `ProfileApiClient.remove_school_teacher` was a no-op, because it didn't call `ProfileApiClient.connection`, so I've removed it as well as the operation and the controller action that called it.
raspberrypiherokubot
temporarily deployed
to
editor-api-p-remove-unu-ev33tz
|
@adrian-rpf This addresses one of the issues I mentioned when we chatted the other day. I'd welcome your feedback. |
chrisroos
approved these changes
Jul 9, 2025
There was a problem hiding this comment.
This all looks good to me, @floehopper!
I've also double checked CEfE in staging and can't see any way in the UI to do any of the 3 operations you've removed:
- Add an owner
- Remove an owner
- Remove a teacher
Which provides further evidence that this code isn't being exercised.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I started making these changes when I noticed that a bunch of stubbing of
ProfileApiClientmethods was not needed.However, I then noticed that a bunch of
ProfileApiClientmethods are no-ops, because they don't make any use ofProfileApiClient.connectionwhich is the only code that actually makes any HTTP requests to the Profile API. This in turn led me to remove the API endpoints whose sole purpose was to call these no-op methods along with all the associated code and specs.I can't see any reason to keep unused code in the app - it just makes the codebase harder to navigate for no good reason. If we envisage implementing these endpoints in the future and we're worried about having to write the same code again, we can easily recover it from the git history.
The API endpoints that have been removed are:
POST /api/schools/:school_id/ownersDELETE /api/schools/:school_id/owners/:idDELETE /api/schools/:school_id/teachers/:idAs far as I can see,
editor-standalonedoesn't make requests to any URLs relating to school owners and the only requests it makes relating to school teachers is ininviteTeacherToSchool()- see the following references:So it should be safe to merge this.