Start location ignored for reset courses on language change

[danielghost]

If a course is reset with _restoreStateOnLanguageChange=true on language change, but the current location was no longer within the _startIds, that location will be restored unless _start._force: true. This is because isRouteSpecified is true so the start location is ignored.

This requires the author to understand that the _force value should be true whenever not restoring the state. Should this be something that is automatically applied to prevent the ability to return to a invalid location in these cases?

[oliverfoster]

Should this be something that is automatically applied to prevent the ability to return to a invalid location in these cases?

How would we know to apply it automatically? Because _restoreStateOnLanguageChange is true?

Would it make sense to reload in a way that isRouterSpecified==false on language change? So that the user must start from the menu or startid again? i.e. with no #/ hash path at the end of the url

Changing the language currently seems to reroute around here:

1. Choose language
   https://github.com/adaptlearning/adapt-contrib-languagePicker/blob/de6e72940c6c50eae74a4b9a2bf80917bdcc9f27/js/languagePickerModel.js#L40-L56
2. data, listen to language change
   

   adapt-contrib-core/js/data.js

   Line 55 in c7c74d4

   'change:_activeLanguage': this.onLanguageChange,

3. data, reload manifest etc
   

   adapt-contrib-core/js/data.js

   Lines 80 to 108 in c7c74d4

   	async onLanguageChange(model, language) {
   	await wait.queue();
   	const previousAttributes = model.previousAttributes();
   	const previousLanguage = previousAttributes._activeLanguage;
   	offlineStorage.set('lang', language);
   	// set `_isStarted` back to `false` when changing language so that the learner's answers
   	// to questions get restored in the new language when `_restoreStateOnLanguageChange: true`
   	// see https://github.com/adaptlearning/adapt_framework/issues/2977
   	if (Adapt.get('_isStarted')) {
   	Adapt.set('_isStarted', false);
   	}
   	this.loadCourseData(language, previousLanguage);
   	}
   	async loadCourseData(newLanguage, previousLanguage) {
   	// All code that needs to run before adapt starts should go here
   	const language = Adapt.config.get('_activeLanguage');
   	const courseFolder = Adapt.build.get('coursedir') + '/' + language + '/';
   	$('html').attr('lang', language);
   	await this.loadManifestFiles(courseFolder);
   	await this.triggerDataLoaded();
   	await this.triggerDataReady(newLanguage, previousLanguage);
   	this.triggerInit();
   	}

4. app, adapt, init, trigger adapt:start
   

   adapt-contrib-core/js/app.js

   Line 32 in c7c74d4

   Adapt.init();

   
   

   adapt-contrib-core/js/adapt.js

   Lines 26 to 41 in c7c74d4

   	async init() {
   	this.addDirection();
   	this.disableAnimation();
   	this.trigger('adapt:preInitialize');
   	await wait.queue();
   	// wait until no more completion checking
   	this.deferUntilCompletionChecked(async () => {
   	// start adapt in a full restored state
   	this.trigger('adapt:start');
   	await wait.queue();
   	if (!Backbone.History.started) {
   	Backbone.history.start();
   	}

5. Start controller onAdaptStart, setStartLocation
   

   adapt-contrib-core/js/startController.js

   Line 17 in c7c74d4

   'adapt:start': this.onAdaptStart,

   
   

   adapt-contrib-core/js/startController.js

   Lines 26 to 34 in c7c74d4

   	setStartLocation() {
   	if (!this._isSessionInProgress) {
   	this._isSessionInProgress = true;
   	if (!this.isEnabled()) return;
   	return window.history.replaceState('', '', this.getStartHash());
   	}
   	const hash = this.isEnabled() ? this.getStartHash(false) : '#/';
   	router.navigate(hash, { trigger: true, replace: true });
   	}