Merge pull request #452 from NordicSemiconductor/fix/disk-full-trigger

Fix/disk full trigger

Changelog.md

@@ -9,6 +9,8 @@
 
 -   Chart frame trotting for slower machines.
 -   Clearing session files on close in some special cases.
+-   Behavior of **Disk full trigger** when recording for an indefinite period of
+    time. It now correctly stops sampling when the disk is full.
 
 ## 4.0.0 - 2024-03-13
 

src/actions/deviceActions.ts

@@ -79,6 +79,7 @@ import { setSpikeFilter as persistSpikeFilter } from '../utils/persistentStore';
 
 let device: null | SerialDevice = null;
 let updateRequestInterval: NodeJS.Timeout | undefined;
+let releaseFileWriteListener: (() => void) | undefined;
 
 export const setupOptions =
     (recordingMode: RecordingMode): AppThunk<RootState, Promise<void>> =>
@@ -99,6 +100,21 @@ export const setupOptions =
                     DataManager().initializeTriggerSession(60);
                     break;
             }
+
+            releaseFileWriteListener?.();
+            releaseFileWriteListener = DataManager().onFileWrite?.(() => {
+                isDiskFull(
+                    getDiskFullTrigger(getState()),
+                    getSessionRootFolder(getState())
+                ).then(isFull => {
+                    if (isFull) {
+                        logger.warn(
+                            'Session stopped. Disk full trigger value reached.'
+                        );
+                        dispatch(samplingStop());
+                    }
+                });
+            });
         } catch (err) {
             logger.error(err);
         }
@@ -145,6 +161,7 @@ export const samplingStop =
         dispatch(samplingStoppedAction());
         await device.ppkAverageStop();
         stopPreventSleep();
+        releaseFileWriteListener?.();
     };
 
 export const updateSpikeFilter = (): AppThunk<RootState> => (_, getState) => {
@@ -207,7 +224,6 @@ export const open =
         let prevBits = 0;
         let nbSamples = 0;
         let nbSamplesTotal = 0;
-        let lastDiskFullCheck = 0;
 
         const onSample = ({ value, bits }: SampleValues) => {
             const {
@@ -311,24 +327,6 @@ export const open =
                 if (samplingRunning) {
                     dispatch(samplingStop());
                 }
-
-                const shouldCheckDiskFull =
-                    performance.now() - lastDiskFullCheck > 10_000;
-
-                if (shouldCheckDiskFull) {
-                    lastDiskFullCheck = performance.now();
-                    isDiskFull(
-                        getDiskFullTrigger(getState()),
-                        getSessionRootFolder(getState())
-                    ).then(isFull => {
-                        if (isFull) {
-                            logger.warn(
-                                'Session stopped. Disk full trigger detected'
-                            );
-                            dispatch(samplingStop());
-                        }
-                    });
-                }
             }
         };
 

src/components/SidePanel/SessionSettings.tsx

@@ -76,7 +76,7 @@ export default () => {
                 unit="MB"
                 value={diskFullTrigger}
                 range={{
-                    min: 1,
+                    min: 10, // 4 * 100_000 * 10 bytes ~= 5.7 MB per page
                     max: 10240,
                     decimals: undefined,
                     step: undefined,

src/components/SidePanel/StartStop.tsx

@@ -4,11 +4,12 @@
  * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
  */
 
-import React, { useEffect, useState } from 'react';
+import React, { useEffect, useRef, useState } from 'react';
 import { useDispatch, useSelector } from 'react-redux';
 import {
     ConfirmationDialog,
     Group,
+    logger,
     StartStopButton,
     telemetry,
 } from '@nordicsemiconductor/pc-nrfconnect-shared';
@@ -56,6 +57,8 @@ const calcFileSizeString = (sampleFreq: number, durationSeconds: number) => {
 
 export default () => {
     const dispatch = useDispatch();
+
+    const onWriteListener = useRef<() => void>();
     const scopePane = useSelector(isScopePane);
     const dataLoggerPane = useSelector(isDataLoggerPane);
     const recordingMode = useSelector(getRecordingMode);
@@ -88,8 +91,30 @@ export default () => {
             mode,
             samplesPerSecond: DataManager().getSamplesPerSecond(),
         });
-        dispatch(samplingStart());
+
+        const space = Math.max(
+            0,
+            await getFreeSpace(diskFullTrigger, sessionFolder)
+        );
+
+        setFreeSpace(space);
+
+        if (space === 0) {
+            logger.warn(
+                'Disk is full. Unable to start sampling. Change the disk full trigger threshold or free up disk memory.'
+            );
+            setShowDialog(false);
+            return;
+        }
+
         setShowDialog(false);
+        await dispatch(samplingStart());
+        onWriteListener.current?.();
+        onWriteListener.current = DataManager().onFileWrite(() => {
+            getFreeSpace(diskFullTrigger, sessionFolder).then(s => {
+                setFreeSpace(Math.max(0, s));
+            });
+        });
     };
 
     const [freeSpace, setFreeSpace] = useState<number>(0);
@@ -99,7 +124,7 @@ export default () => {
 
         const action = () => {
             getFreeSpace(diskFullTrigger, sessionFolder).then(space => {
-                setFreeSpace(space);
+                setFreeSpace(Math.max(0, space));
             });
         };
         action();
@@ -128,6 +153,7 @@ export default () => {
                     stopText="Stop"
                     onClick={async () => {
                         if (samplingRunning) {
+                            onWriteListener.current?.();
                             dispatch(samplingStop());
                             telemetry.sendEvent('StopSampling', {
                                 mode: recordingMode,

src/globals.ts

@@ -392,6 +392,8 @@ export const DataManager = () => ({
             });
         }),
     hasPendingTriggers: () => options.timeReachedTriggers.length > 0,
+    onFileWrite: (listener: () => void) =>
+        options.fileBuffer?.onFileWrite(listener),
 });
 
 /**

src/utils/FileBuffer.ts

@@ -29,6 +29,7 @@ export class FileBuffer {
     #fileBusy = false;
     #beforeUnload: (event: BeforeUnloadEvent) => Promise<void>;
     #bufferingListeners: ((event: Promise<void>) => void)[] = [];
+    #fileWriteListeners: (() => void)[] = [];
     #freePageBuffers: Uint8Array[] = [];
     #bufferingRequests: Promise<void>[] = [];
     #cancelBufferOperations: WeakMap<Promise<void>, AbortController> =
@@ -125,7 +126,10 @@ export class FileBuffer {
                         throw new Error('Invalid File handle');
                     return fs
                         .appendFile(this.#fileHandle, activePage.page)
-                        .finally(resolve);
+                        .finally(() => {
+                            this.#fileWriteListeners.forEach(l => l());
+                            resolve();
+                        });
                 });
             } else {
                 this.fileOperationTasks.push(() => {
@@ -137,7 +141,10 @@ export class FileBuffer {
                             this.#fileHandle,
                             activePage.page.subarray(0, activePage.bytesWritten)
                         )
-                        .finally(resolve);
+                        .finally(() => {
+                            this.#fileWriteListeners.forEach(l => l());
+                            resolve();
+                        });
                 });
 
                 writeBuffer.switchPage();
@@ -577,4 +584,18 @@ export class FileBuffer {
             }
         };
     }
+
+    onFileWrite(listener: () => void) {
+        this.#fileWriteListeners.push(listener);
+
+        return () => {
+            const index = this.#fileWriteListeners.findIndex(
+                l => l === listener
+            );
+
+            if (index !== -1) {
+                this.#fileWriteListeners.splice(index, 1);
+            }
+        };
+    }
 }