Setup Wizard: More helpful error state when trying to import from unprovisioned device #12397

nucleogenesis · 2024-07-02T23:15:40Z

Summary

2024-07-02.16-07-59.mp4

Takes string from here "No learning facilities found"
Uses that by making the "Select facility" show an error when there are no facilities
Adds hideContinue prop to OnboardingStepBase to hide the Continue button there when we have this error state
Fixes issue where user's selection was lost when clicking "Go back" from the error state

References

Fixes #12066

Reviewer guidance

See the issue comment here for replication path -- note that I kinda had to go back and forth a few times through the flow - never actually importing anything - before I got the device to show up.

Overall, does the workflow feel okay?

github-actions · 2024-07-02T23:46:31Z

Build Artifacts

Asset type	Download link
PEX file	kolibri-0.17.0b3.dev0_git.49.g2d9e3192.pex
Windows Installer (EXE)	kolibri-0.17.0b3.dev0+git.49.g2d9e3192-windows-setup-unsigned.exe
Debian Package	kolibri_0.17.0b3.dev0+git.49.g2d9e3192-0ubuntu1_all.deb
Mac Installer (DMG)	kolibri-0.17.0b3.dev0+git.49.g2d9e3192.dmg
Android Package (APK)	kolibri-0.17.0b3.dev0+git.49.g2d9e3192-0.1.3-debug.apk
TAR file	kolibri-0.17.0b3.dev0+git.49.g2d9e3192.tar.gz
WHL file	kolibri-0.17.0b3.dev0+git.49.g2d9e3192-py2.py3-none-any.whl

pcenov · 2024-07-03T14:04:26Z

Thanks @nucleogenesis - I confirm that now there's an error message if I attempt to import a learner from unprovisioned device.
Just have one question - in #12066 I have mentioned that the expected behavior would be for the device to not be shown in the 'Select device' modal which is the case for example when I attempt to import a full facility from that same unprovisioned device. Is that not an option in this case?

bjester · 2024-07-03T14:42:35Z

To @pcenov's note, we should probably add a prop to SelectDeviceForm for filtering locations that have a facility, i.e. filterHasFacility. Then have the useDeviceFacilityFilter apply the filter. That should prevent it from ever getting as far as where these error messages would show.

That would take care of filtering devices that would not be joinable or importable because they have no facility, which is a solid improvement. Although it doesn't go quite as far as the original issue's proposal of filtering those devices that actually have learners for import. I think the consensus was that we don't need to go that far. See my comment in regards to that

nucleogenesis · 2024-07-22T22:21:39Z

kolibri/core/discovery/utils/network/client.py

- if "timeout" not in kwargs:
-  kwargs.update(timeout=self.timeout)
+
+ timeout = kwargs.pop("timeout", self.timeout)


@bjester I saw the comment in the filters about wanting to pass the params to the API directly and started investigating. I was running into an error when I tried to pass the filter values as kwargs and discovered that the parent request method expects the params kwarg.

Looking at changing the front-end code to pass these values in to the API seemed like maybe out of scope for this PR, but does this look right and like it might help simplify the facility filters a bit. I was thinking I might just put that into the apiParams object created in SelectDeviceForm but paused to get your thoughts here.

Yeah so I think the changes that are needed are external to this client class. This class is a generic client utility. This means we rather need to update the APIs that are using it to pass the params.

nucleogenesis · 2024-07-22T22:23:31Z

@radinamatic @bjester I've updated this with changes that I think are in line with Blaine's suggestion which hides no-facility devices altogether when a particular prop is passed.

I'm feeling a little unsure of my approach so I look forward to your thoughts on the code Blaine!

bjester

More comments. The primary blocking change is the updates to the network client. I'm quite sure those changes are likely breaking.

kolibri/core/discovery/utils/network/client.py

kolibri/core/assets/src/views/sync/SelectDeviceModalGroup/SelectDeviceForm.vue

bjester · 2024-07-25T15:56:03Z

kolibri/core/discovery/utils/network/client.py

- if "timeout" not in kwargs:
-  kwargs.update(timeout=self.timeout)
+
+ timeout = kwargs.pop("timeout", self.timeout)


Yeah so I think the changes that are needed are external to this client class. This class is a generic client utility. This means we rather need to update the APIs that are using it to pass the params.

kolibri/plugins/setup_wizard/assets/src/views/SelectFacilityForm.vue

kolibri/core/assets/src/views/sync/SelectDeviceModalGroup/SelectDeviceForm.vue

…ility

… user's selection between navigations)

… have no facilities by prop

{} => "are there any facilities at all?" { id: <val> } => "are there any facilities that match this id?" this ensures that we properly handle the case where there are no facilities

bjester

Code LGTM

bjester · 2024-07-29T18:28:46Z

kolibri/core/assets/src/views/sync/SelectDeviceModalGroup/SelectDeviceForm.vue

+ );
+
+ // If we're filtering a particular facility
+ if (Object.keys(facilityFilter).length > 0 || props.filterByHasFacilities) {
 apiParams.subset_of_users_device = false;


It maybe unexpected that we filter out SoUDs when applying props.filterByHasFacilities, but since it's a new prop, we don't have any use cases, so it's def fine until we do.

pcenov · 2024-08-13T10:53:47Z

Hi @radinamatic - I confirm that the issue described in #12066 is fixed now and there are no new issues observed while regression testing.

radinamatic

Manual QA passes, good to go! 💯 👏🏽

rtibbles · 2024-08-22T15:11:18Z

Readthedocs build appears to have stalled, and has nothing to do with this PR. Merging!

nucleogenesis added this to the Kolibri 0.17: Enhanced Quiz Management milestone Jul 2, 2024

nucleogenesis requested review from bjester and marcellamaki July 2, 2024 23:15

github-actions bot added APP: Setup Wizard Re: Setup Wizard (facility import, superuser creation, settings, etc.) DEV: frontend labels Jul 2, 2024

marcellamaki requested a review from radinamatic July 2, 2024 23:25

pcenov mentioned this pull request Jul 3, 2024

Squash migrations to prevent issues with older SQLite versions. learningequality/morango#225

Merged

marcellamaki modified the milestones: Kolibri 0.17: Enhanced Quiz Management, Kolibri 0.17: General maintenance, bugs, misc. important fixes Jul 3, 2024

rtibbles changed the base branch from develop to release-v0.17.x July 12, 2024 16:15

github-actions bot added the DEV: backend Python, databases, networking, filesystem... label Jul 22, 2024

nucleogenesis commented Jul 22, 2024

View reviewed changes

bjester requested changes Jul 25, 2024

View reviewed changes

rtibbles modified the milestones: Kolibri 0.17: General maintenance, bugs, misc. important fixes, Kolibri 0.17: Planned Patch 1 Jul 26, 2024

nucleogenesis force-pushed the fix--noisy-unprovisioned-devices branch from 50dca78 to c75c06f Compare July 26, 2024 22:44

bjester reviewed Jul 29, 2024

View reviewed changes

kolibri/core/assets/src/views/sync/SelectDeviceModalGroup/SelectDeviceForm.vue Outdated Show resolved Hide resolved

nucleogenesis added 7 commits July 29, 2024 09:15

use borrowed string in recoverable error state when device has no fac…

585694e

…ility

initialize JoinOrNewLOD component w/ value from machine context (save…

5578fe3

… user's selection between navigations)

update typedef

6beef53

use device filtering to preemptively remove devices from list if they…

8058b00

… have no facilities by prop

use i18n string for error message

ce91f4a

deviceHasMatchingFacility treats empty filter as wildcard

66d9a9d

{} => "are there any facilities at all?" { id: <val> } => "are there any facilities that match this id?" this ensures that we properly handle the case where there are no facilities

use filterByHasFacilities prop

1b7a759

nucleogenesis force-pushed the fix--noisy-unprovisioned-devices branch from c75c06f to 1b7a759 Compare July 29, 2024 18:23

bjester approved these changes Jul 29, 2024

View reviewed changes

nucleogenesis added the TODO: needs review Waiting for review label Jul 29, 2024

rtibbles assigned radinamatic Jul 30, 2024

radinamatic approved these changes Aug 13, 2024

View reviewed changes

rtibbles merged commit 1353e99 into learningequality:release-v0.17.x Aug 22, 2024
32 of 33 checks passed

rtibbles mentioned this pull request Aug 22, 2024

Setup Wizard - Devices that are not fully setup are showing up in the 'Select device' modal #12066

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Setup Wizard: More helpful error state when trying to import from unprovisioned device #12397

Setup Wizard: More helpful error state when trying to import from unprovisioned device #12397

nucleogenesis commented Jul 2, 2024

github-actions bot commented Jul 2, 2024 •

edited

Loading

pcenov commented Jul 3, 2024

bjester commented Jul 3, 2024

nucleogenesis Jul 22, 2024

bjester Jul 25, 2024

nucleogenesis commented Jul 22, 2024

bjester left a comment

bjester Jul 25, 2024

bjester left a comment

bjester Jul 29, 2024

pcenov commented Aug 13, 2024

radinamatic left a comment

rtibbles commented Aug 22, 2024

Setup Wizard: More helpful error state when trying to import from unprovisioned device #12397

Setup Wizard: More helpful error state when trying to import from unprovisioned device #12397

Conversation

nucleogenesis commented Jul 2, 2024

Summary

References

Reviewer guidance

github-actions bot commented Jul 2, 2024 • edited Loading

Build Artifacts

pcenov commented Jul 3, 2024

bjester commented Jul 3, 2024

nucleogenesis Jul 22, 2024

Choose a reason for hiding this comment

bjester Jul 25, 2024

Choose a reason for hiding this comment

nucleogenesis commented Jul 22, 2024

bjester left a comment

Choose a reason for hiding this comment

bjester Jul 25, 2024

Choose a reason for hiding this comment

bjester left a comment

Choose a reason for hiding this comment

bjester Jul 29, 2024

Choose a reason for hiding this comment

pcenov commented Aug 13, 2024

radinamatic left a comment

Choose a reason for hiding this comment

rtibbles commented Aug 22, 2024

github-actions bot commented Jul 2, 2024 •

edited

Loading