enroll non-UMich users (iss. #221, #169, #252, #291) #247

lsloan · 2021-11-18T12:12:36Z

Resolves #221.

As well as…

Resolves #169.
Resolves #252.
Resolves #291.

PR review etiquette requests

To my reviewer friends, I humbly request…

When making comments about the PR, especially ones requesting changes, please use the "code review" form of comments, not "single comment". The review style ones allow for direct replies which make threaded, easier to follow conversations. The single comments do not.
If you make a review comment requesting that I change something, when I've completed the change (or made a comment reply), I will reply with "🏁" or "✅" when I think the conversation has been resolved. As the reviewer, I will leave it up to you to decide whether the conversation needs to continue or it's time to click the "Resolve conversation" button.

To Do

Older to do items (click to expand)

- Remove User object from function arguments where it is unnecessary
- Work with @ssciolla to improve handling of user exists errors
- See conversation beginning at (enroll non-UMich users (iss. #221, #169, #252, #291) #247 (comment))

Very simplistic approach for now. Should be refactored to reduce duplication of code before merging upstream.

…rse-manager-next into 221-enroll-non-umich

Also, temporarily accept results as JSON string. Method based on one for enrolling existing users

Temporarily use JSON results as return value.

…rse-manager-next into 221-enroll-non-umich

ccm_web/server/src/canvas/canvas.service.ts

…rse-manager-next into 221-enroll-non-umich

`adminApiToken` may end up replacing `adminApiClientId` and `adminApiSecret` altogether.

ccm_web/server/src/invitation/cirrus-invitation.interfaces.ts

ssciolla · 2022-02-24T16:17:06Z

ccm_web/server/src/invitation/cirrus-invitation.service.ts

+ const invitationConfig = configService.get('invitation', { infer: true })
+ const apiURL = invitationConfig.apiURL
+ this.url = apiURL + cirrusAPIVersion + CirrusAPIEndPoint


Codacy says this is an issue, but I don't think it is. I believe Codacy doesn't have access to typing from NestJS, so it can't determine the type of apiURL. Anywho, you can ignore this issue in Codacy. Click on the settings icon dropdown on the issue in the Codacy UI, then click "Ignore Issue".

Thanks for the advice on ignoring. I didn't try that, but I had tried to change the code pattern config. That didn't work because Codacy said it was using the config file from our repo. I didn't think it'd be wise for me to change that config just to placate Codacy. At least, not without discussing it with you and the team first. That might mask real errors, I'd guess.

ssciolla · 2022-02-24T16:19:50Z

ccm_web/server/src/invitation/cirrus-invitation.service.ts

+
+ return response.data
+ } catch (error) {
+ if (axios.isAxiosError(error) && error.response !== undefined) {


Similar deal here. Codacy doesn't have access to the axios typing, so I think Codacy believes error and response are any. You can safely ignore the issue in Codacy.

ssciolla · 2022-02-24T16:23:25Z

config/.env.sample

+INVITATION_API_URL=https://apps.cirrusidentity.com/console
+INVITATION_API_KEY=
+INVITATION_API_SECRET=
+INVITATION_API_ENTITY_ID=


These may benefit from short comment descriptions.

@pushyami

correct case from @pushyami's code Co-authored-by: Sam Sciolla <35741256+ssciolla@users.noreply.github.com>

Checking for specific error indicators among the long error body returned by Canvas.

lsloan · 2022-02-24T16:59:47Z

As @pushyamig requested, I've done some testing.

I've run several, at least ten or more, requests containing 200 semi-randomly generated users. Each time…

all 200 are created as new users in Canvas
all 200 are accepted by Cirrus for invitation and appear in their console
random spot-checking shows each has received an email message

These batches of 200 take a range of 8–13 seconds to complete.

Batches with more than 200 users gets an HTTP 400 error with the message…

{"statusCode":400,"message":["users must contain not more than 200 elements"],"error":"Bad Request"}

ssciolla

Releasing comments now. There is a compilation error; @lsloan, you need to update references to cirrusPIEndpoint. Not seeing any (other) super serious issues. I'll finish the review with testing now.

ssciolla · 2022-02-24T17:23:35Z

README.md

+21. Copy the static API key created in Canvas. The ID is the long number shown
+ in the "Details" column of the "Developer Keys" page. It usually begins
+ with "1770~…".


Is this still accurate? I would think you'd do this in Settings, not anything related to Developer Keys.

ssciolla · 2022-02-24T17:24:39Z

README.md

+ 7. Add to the `CANVAS_ADMIN_API_TOKEN` key the API token copied earlier
+ (in step 20).
+ 8. Configure invitation API settings. The invitation API used by CCM is
+ currently based on Cirrus Identity services. Provide values for each


Maybe for now just link "Cirrus Identity service" to the Cirrus site.

ssciolla · 2022-02-24T17:26:31Z

ccm_web/server/src/api/api.admin.handler.ts

+ ): Promise<Array<{ result: CanvasUserLoginEmail | APIErrorData | false, email: string }>> {
+ const start = process.hrtime.bigint()
+
+ // Try creating all Canvas users; failure often means user already exists


This comment may no longer be exactly accurate, since we're handling the unique ID error internally and returning false.

ccm_web/server/src/api/api.admin.handler.ts

ssciolla · 2022-02-24T17:33:01Z

ccm_web/server/src/api/api.controller.ts

@@ -103,6 +134,16 @@ export class APIController {
 return enrollmentsResult
 }

+ // Do NOT use `InvalidTokenInterceptor` here!


Could just remove this, or if you want to have something, maybe say something like // Uses admin token, so InvalidTokenInterceptor omitted. If you do keep it, please add something to the other endpoint,admin/createExternalUsers.

ccm_web/server/src/api/api.utils.ts

ccm_web/server/src/canvas/canvas.interfaces.ts

ccm_web/server/src/invitation/cirrus-invitation.service.ts

ssciolla

@lsloan, okay, I've done some testing, and I think we're in good shape. I would give approval, but the compilation error hasn't been fixed. I also think it would be a good improvement to tighten and simplify the CanvasUser interface(s) as described in my latest comments. I will keep an eye on these and give an approval as soon as these two things are taken care of. Everything else is minor and can be resolved as you see fit. Let's finish this!

ccm_web/server/src/canvas/canvas.interfaces.ts

ccm_web/server/src/api/api.admin.handler.ts

ccm_web/server/src/canvas/canvas.interfaces.ts

…rse-manager-next into 221-enroll-non-umich

…into 221-enroll-non-umich * '221-enroll-non-umich' of https://github.com/lsloan/ccm: check for unique ID error during Canvas user creation (#7) Update ccm_web/server/src/invitation/cirrus-invitation.interfaces.ts

I didn't fix refs after accepting change suggestion in GH PR. I also hadn't pulled from GH, so I didn't see the compile errors this had caused.

@pushyami

I didn't fix refs after accepting change suggestion in GH PR. I also hadn't pulled from GH, so I didn't see the compile errors this had caused. (EDIT: Updated to use Pushyami's correct username, "pushyamig". Apologies to @pushyami. I wish I could easily go back to correct the other commit message, too.)

@pushyami

…into 221-enroll-non-umich * '221-enroll-non-umich' of https://github.com/lsloan/ccm: tl-its-umich-edu#221 - correct case from @pushyami's code

lsloan · 2022-02-24T20:53:58Z

@ssciolla wrote in #247 (comment):

Actually, login_id also seems to be present in both cases. Could we just add login_id to CanvasUser, then delete CanvasUserLoginEmail and replace all references to it with CanvasUser?

~~Yes, I think so. I'll give it a go.~~

I take that back. As I'm trying to change CanvasUserLoginEmail → CanvasUser everywhere, that turns out to be a problem because CanvasUser doesn't include email. I guess I could add email to it, as I've just done with login_id. I don't know whether that will still be compatible with results returned by the Canvas API.

~~Is that what you'd like?~~

Thanks for working that through with me in Zoom. As you went along, I think you ended up with an even better solution than you anticipated.

ssciolla

I'm approving. Thanks @lsloan for being flexible as we changed some of the architecture choices, and for considering my PR requests to your branch. There are some comments and suggestions still pending, but none of them seem serious enough to prevent merging or require additional review from me. Please resolve them as you see fit.

@pushyamig, you may want to take a look, for your general awareness, at some of the logic and error handling changes we made -- I'm thinking particularly of api.service.ts, canvas.interfaces.ts and api.utils.ts.

lsloan · 2022-02-24T21:28:09Z

Thanks for approving the PR, @ssciolla. I'm glad to see this PR near its end.

I feel my involvement in CCM has aged me significantly.

Apparently I'd forgotten to commit this doc change.

lsloan added 2 commits November 16, 2021 14:16

tl-its-umich-edu#221 - add methods for non-UMich users

91b8e24

Very simplistic approach for now. Should be refactored to reduce duplication of code before merging upstream.

tl-its-umich-edu#221 - wiring in admin API credentials

d53814f

lsloan self-assigned this Nov 18, 2021

lsloan changed the title ~~enroll non-UMich (iss. #221)~~ 🚧 DRAFT: enroll non-UMich users (iss. #221) Nov 18, 2021

lsloan added 22 commits November 18, 2021 09:52

tl-its-umich-edu#221 - wiring in invitation API credentials

a6b295e

Merge branch 'main' of https://github.com/tl-its-umich-edu/canvas-cou…

a90cca4

…rse-manager-next into 221-enroll-non-umich

tl-its-umich-edu#221 - add new configs; shorten others' names

c123226

tl-its-umich-edu#221 - add more config values; add them to config

4416ba2

tl-its-umich-edu#221 - return JSON string (for now)

7fb37e7

tl-its-umich-edu#221 - add config svc to enroll ext user method

9e5fd2c

Also, temporarily accept results as JSON string. Method based on one for enrolling existing users

tl-its-umich-edu#221 - method based on enroll existing users

15fc7e0

Temporarily use JSON results as return value.

tl-its-umich-edu#221 - class for invitation errors

ef1975e

tl-its-umich-edu#221 - invitation service based on Canvas one

b3e4540

tl-its-umich-edu#221 - create users; simplify enrollment method

5ca5ffa

tl-its-umich-edu#221 - new DTO for external users

a8410c8

tl-its-umich-edu#221 - attempt to use existing enrollment method

4e185db

tl-its-umich-edu#221 - new type for created users

df7d7be

tl-its-umich-edu#221 - create requestor using admin token

1980e2e

tl-its-umich-edu#221 - use new type for created users

d52cfa0

tl-its-umich-edu#221 - eslint appeasement

9ddcf53

tl-its-umich-edu#221 - update enroll methods; use both user types

2826718

tl-its-umich-edu#221 - use correct email field name for CanvasUser

32c6d37

tl-its-umich-edu#221 - use correct user type; handle errors

3ddd3a3

Merge branch 'main' of https://github.com/tl-its-umich-edu/canvas-cou…

14c32b4

…rse-manager-next into 221-enroll-non-umich

tl-its-umich-edu#221 - external users method not needed?

0a04f72

tl-its-umich-edu#221 - use new types for external user data

ffc189b

lsloan commented Dec 9, 2021

View reviewed changes

ccm_web/server/src/canvas/canvas.service.ts Outdated Show resolved Hide resolved

lsloan added 3 commits December 14, 2021 13:13

Merge branch 'main' of https://github.com/tl-its-umich-edu/canvas-cou…

d911752

…rse-manager-next into 221-enroll-non-umich

tl-its-umich-edu#221 - add admin API token config support

c75ba78

`adminApiToken` may end up replacing `adminApiClientId` and `adminApiSecret` altogether.

tl-its-umich-edu#221 - add support for user given- and surnames

83187fa

ssciolla reviewed Feb 24, 2022

View reviewed changes

ccm_web/server/src/invitation/cirrus-invitation.interfaces.ts Outdated Show resolved Hide resolved

ssciolla reviewed Feb 24, 2022

View reviewed changes

lsloan and others added 2 commits February 24, 2022 11:25

Update ccm_web/server/src/invitation/cirrus-invitation.interfaces.ts

31798cf

correct case from @pushyami's code Co-authored-by: Sam Sciolla <35741256+ssciolla@users.noreply.github.com>

check for unique ID error during Canvas user creation (#7)

999bafe

Checking for specific error indicators among the long error body returned by Canvas.

ssciolla reviewed Feb 24, 2022

View reviewed changes

ccm_web/server/src/canvas/canvas.interfaces.ts Outdated Show resolved Hide resolved

ccm_web/server/src/api/api.admin.handler.ts Outdated Show resolved Hide resolved

ccm_web/server/src/canvas/canvas.interfaces.ts Outdated Show resolved Hide resolved

lsloan added 5 commits February 24, 2022 14:06

Merge branch 'main' of https://github.com/tl-its-umich-edu/canvas-cou…

ade135e

…rse-manager-next into 221-enroll-non-umich

tl-its-umich-edu#221 - correct case from @pushyami's code

1001d59

I didn't fix refs after accepting change suggestion in GH PR. I also hadn't pulled from GH, so I didn't see the compile errors this had caused.

Merge branch '221-enroll-non-umich' of https://github.com/lsloan/ccm …

64230a0

…into 221-enroll-non-umich * '221-enroll-non-umich' of https://github.com/lsloan/ccm: tl-its-umich-edu#221 - correct case from @pushyami's code

This comment was marked as outdated.

Sign in to view

This comment was marked as resolved.

Sign in to view

tl-its-umich-edu#221 - simplified interfaces for Canvas API data

f06f8c5

ssciolla approved these changes Feb 24, 2022

View reviewed changes

lsloan added 2 commits February 24, 2022 16:06

tl-its-umich-edu#221 - remove debug logging

2d90018

tl-its-umich-edu#221 - update useful comments

36d1fbd

tl-its-umich-edu#221 - more general data type

19f3fc3

lsloan changed the title ~~enroll non-UMich users (iss. #221, #252, #291)~~ enroll non-UMich users (iss. #221, #169, #252, #291) Feb 24, 2022

lsloan merged commit 8d55aa8 into tl-its-umich-edu:main Feb 24, 2022

lsloan deleted the 221-enroll-non-umich branch February 24, 2022 21:41

lsloan added a commit to lsloan/ccm that referenced this pull request Mar 24, 2022

correction & clarification left over from tl-its-umich-edu#247

124cf14

Apparently I'd forgotten to commit this doc change.

lsloan mentioned this pull request Mar 24, 2022

documentation correction and clarification #367

Merged

pushyamig pushed a commit that referenced this pull request Apr 8, 2022

correction & clarification left over from #247 (#367)

4cd6613

Apparently I'd forgotten to commit this doc change.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

enroll non-UMich users (iss. #221, #169, #252, #291) #247

enroll non-UMich users (iss. #221, #169, #252, #291) #247

lsloan commented Nov 18, 2021 •

edited

Loading

ssciolla Feb 24, 2022

lsloan Feb 24, 2022

ssciolla Feb 24, 2022 •

edited

Loading

ssciolla Feb 24, 2022

lsloan commented Feb 24, 2022 •

edited

Loading

ssciolla left a comment

ssciolla Feb 24, 2022

ssciolla Feb 24, 2022

ssciolla Feb 24, 2022

ssciolla Feb 24, 2022

lsloan Feb 24, 2022

ssciolla left a comment

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as resolved.

lsloan commented Feb 24, 2022 •

edited

Loading

ssciolla left a comment •

edited

Loading

lsloan commented Feb 24, 2022

enroll non-UMich users (iss. #221, #169, #252, #291) #247

enroll non-UMich users (iss. #221, #169, #252, #291) #247

Conversation

lsloan commented Nov 18, 2021 • edited Loading

PR review etiquette requests

To Do

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ssciolla Feb 24, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lsloan commented Feb 24, 2022 • edited Loading

ssciolla left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ssciolla left a comment

Choose a reason for hiding this comment

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as resolved.

lsloan commented Feb 24, 2022 • edited Loading

ssciolla left a comment • edited Loading

Choose a reason for hiding this comment

lsloan commented Feb 24, 2022

lsloan commented Nov 18, 2021 •

edited

Loading

ssciolla Feb 24, 2022 •

edited

Loading

lsloan commented Feb 24, 2022 •

edited

Loading

lsloan commented Feb 24, 2022 •

edited

Loading

ssciolla left a comment •

edited

Loading