Add CGI middleware for requests to People API #346
Conversation
ttpcodes
force-pushed
the
people-middleware
branch
from
f9ee659 to
e5facf6
Compare
|
note: we should make sure there aren't CORS errors on either side, those are starting to show up again |
|
The request from the |
There was a problem hiding this comment.
I like this setup a lot! Very simple and elegant, and importantly, the same between prod and local. A few comments:
There's no indication of a problem if credentials.ini is missing/wrong, it just doesn't get the year (and doesn't print that it didn't). Could you please add some indicator so we (and new devs) don't get tripped up by this? Not sure where the best place is. Even an error would be good I think, so we can tell it's happening.
Also, I deployed to dev and it didn't seem to work (no year printout, no cookie). Might be related to the ambiguous Error: Request failed with status code 404.
Can you also add the additional setup instructions to the README please? (like python packages, how to get credentials, etc)
ttpcodes
force-pushed
the
people-middleware
branch
from
e5facf6 to
4535083
Compare
cgi-bin/people.py
Outdated
| print(error + content) | ||
| print(dumps(output)) |
There was a problem hiding this comment.
these two lines appear in every case, I think. can't we just put them once at the end?
* Add CGI wrapper for People API requests * Add CGI handler to dev server * Point Auth to new People API endpoint * Deploy cgi-bin * Condense print statements in CGI script Co-authored-by: Nate Foss <[email protected]>
This PR adds a new
CGIhandler calledpeople.pythat is responsible for making requests to thePeople APIon behalf of anyCourseRoadclients. Requests can be made to this endpoint with a user'skerband the API will return either an error or the year of the user zero-indexed. This resolves an issue in which the credentials for interacting with the API was stored directly in the client-side code.This PR also modifies the logic of the
webpack-dev-serverto allow for it to run its ownCGIhandler so that this logic can be tested during development as well. For this to work properly, each person will need to obtain a copy ofcredentials.inito set up this script (which I currently have) since these credentials will not be committed toGitHub.A few changes will need to be made once this is merged into
masterto make sure this works properly, including setting up any dependencies that thisCGImiddleware requires onScripts. Once this is approved by someone, I'll start testing ondevbefore deploying to production.