ActivityRecording::Session - rapid short recordings corrupt files, crash app

var session; // the ActivityRecorder.Session object

function initializeSession()
{
if (Toybox has :ActivityRecording) {
if (session == null) {
session = ActivityRecording.createSession(
{
:name=>"Stopwatch"//,
//:sport=>ActivityRecording.SPORT_GENERIC, // set sport type
//:subSport=>ActivityRecording.SUB_SPORT_GENERIC // set sub sport type
}
);
}
}
}

// called when timer is stopped/reset, and user presses START
function start()
{
initializeSession();

if (session)
{
if (!session.isRecording())
{
var r = session.start();

//System.println("Session.start() returned " + r );
if (!r)
{
// never happens, due to hardcoded 500ms delay between save and start
return false;
}
}
}
// do some stopwatch-related stuff here
// ...
return true;
}

// called when timer is running, and user presses START
function stop()
{
// ...
if (session != null && session.isRecording())
{
var s = session.stop();
//System.println("Session.stop() returned " + s);
}
// I don't return anything here because
// I don't want to do anything different in the UI
// if the recording fails to stop
// (A stopwatch that won't stop is problematic)
}

// called when timer is stopped, and user presses BACK/LAP
function save()
{
var success = true;
if (session)
{
if (session.isRecording())
{
success = session.stop();
//System.println("Session.stop() (2) returned " + success);
}
if (success)
{
success = session.save();
//System.println("Session.save() returned " + success);
if (success)
{
session = null;
// used to call initializeSession() here,
// but it seems to make little difference
}
}
}
// Have never seen this be anything but true
return success;
}


When I uncomment the debug printlns and run in the simulator, start(), stop() and save() always return true. (Because of my hardcoded 500ms delay between save() and start()).

Unfortunately I can't use them in the test case, because they make the problem go away.

- But I am sure that start() returns true because if it didn't, I would display a "Wait..." progressbar for 2 seconds

- And I am sure that save() return true because I have never seen it return false. (I have code which repeatedly tries to call save() if save() returns false. A previous version of the app had no hardcoded wait, and it would've displayed a "Save" progressbar only if save() failed, but I had never seen that progressbar under any circumstances. even when saving long recordings and/or when the subsequent start() would fail.)

Either way, if save() returns false, the app will try for up to ten seconds to keep calling save() until it returns true, but I have never seen save() return false, so I assume it never does (in the kinds of situations I test). When I've crashed the device (without 500ms wait), save() still didn't return false.

- And I'm sure that at least the second of two possible calls to stop() is succeeding because it's part of the save() check above.
To clarify, I call stop() at most twice. The first time when the user stops the timer with START, at which point I ignore the return value, because there's no sensible action to take in the UI if stopping the timer fails.

The second possible time is when the user press BACK to save the recording -- in this case if sessionIsRecording() returns true, I'll call stop() again, before calling save().

Note, I used to call initializeSession() immediately after session.save(), but I don't anymore. I thought this might be part of the problem, but when I put the call back, I could still recreate the problem. It might've been a little harder to do.

I'll also reiterate that I wish Session.save() would return false, while the activity is saving, as opposed to the next Session.start() returning false if you call it too soon. It would really be nice to be able to properly block the UI while the session is saving, but I don't see how it's possible.