...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Background:
Currently, Sunbird has one portal instance that has all the modules and has multiple tenant support. If a tenant request any changes to an existing feature or a new feature, all tenants will get these changes as well.
Problem statement:
Sunbird should support experimenting with the portal, which allows customers to load the different portal app/module with new features. This should follow the below principle
- Experiment feature should be isolated from the main app.
- Deployment of the experiment should not affect the main app.
- Loading of the experiment app should be configurable and loading logic should reside in the server.
- Determine experiment Id and fetch experiment details before the app loads .
- It should not have any impact on the load times for the users who are not part of an experiment.
- All telemetry generated from the portal thereafter should contain the experiment id (in tags section)
Prerequisites :-
- APP_INITIALIZER :- The
"APP_INITIALIZER"is an instance ofInjectionTokenin angular that will be executed when an application is initialized. We will make use of it and perform our device register call and get the experiment details at this step. - Currently device register call is done after the app is initialized.
Loading Experiment specific app:
Solution :-
.jpg?version=1&modificationDate=1567494538081&cacheVersion=1&api=v2)
Workflow for Anonymous users : -
...
- Logged in User opens the sunbird portal .
- App_initializer factory method is called before the app loads.
- Check whether any experiment is set for this user instance (inside locals).
- If no experiment is set then , check whether he/she is a logged in user.
- By this time we will have the url , uid and did info.
- we will make a device register call passing "url ,did and userId "as extra parameters to fetch the experiment details .
- If no experiment is present then we will continue with the normal portal flow and load the default app . This will have no impact on the page load time.
- If any experiment is present then
- Reload the app passing experiment details in encoded form .
- There will be a middleware for the logged in routes that will look for experiment details .
- Fetch the experiment build.
- Set the experiment Id and render the experiment app
- If no experiment dist found reload the app with normal app.
- App is reloaded with experiment Id set
- Again App_initializer factory method is called before the app loads.
- this time experiment id is set so all steps are skipped and it loads the experiment app.
- initialise the telemetry with experiment id set in tags .
- Again App_initializer factory method is called before the app loads.
Deployment:
Solution 1: Store experiment app build in common blob folder with experiment Id as a folder name.
...
- .