upy-fs-builder: Add function to send several files at once to write to fs.

This will be much faster than the correct method to send individual
files. This is because individual files convert the Intel Hex string
to a memory map and then back to a string for each file.

Author: microbit-carlos

src/__tests__/micropython-fs-builder.spec.ts

@@ -2,9 +2,10 @@ import * as fs from 'fs';
 
 import MemoryMap from 'nrf-intel-hex';
 
-import { bytesToStr, strToBytes } from '../common';
+import { strToBytes } from '../common';
 import {
   addIntelHexFile,
+  addIntelHexFiles,
   getIntelHexFiles,
   testResetFileSystem,
 } from '../micropython-fs-builder';
@@ -146,16 +147,11 @@ describe('Writing files to the filesystem.', () => {
     const shortData = shortMap.get(0x3c900);
 
     testResetFileSystem();
-    let fwWithFsOther = addIntelHexFile(
-      uPyHexFile,
-      files[0].fileName,
-      strToBytes(files[0].fileStr)
-    );
-    fwWithFsOther = addIntelHexFile(
-      fwWithFsOther,
-      files[1].fileName,
-      strToBytes(files[1].fileStr)
-    );
+    const filesObj: { [filename: string]: Uint8Array } = {};
+    filesObj[files[0].fileName] = strToBytes(files[0].fileStr);
+    filesObj[files[1].fileName] = strToBytes(files[1].fileStr);
+
+    const fwWithFsOther = addIntelHexFiles(uPyHexFile, filesObj);
     // fs.writeFileSync('./ignore/output2.hex', fwWithFsOther);
 
     const opMap = MemoryMap.fromHex(fwWithFsOther);

src/__tests__/micropython-fs-hex.spec.ts

@@ -6,7 +6,7 @@ import * as fsBuilder from '../micropython-fs-builder';
 import { MicropythonFsHex } from '../micropython-fs-hex';
 
 // Mock Spy
-const addIntelHexFileSpy = jest.spyOn(fsBuilder, 'addIntelHexFile');
+const addIntelHexFilesSpy = jest.spyOn(fsBuilder, 'addIntelHexFiles');
 
 // MicroPython hex file for testing
 const uPyHexFile = fs.readFileSync('./src/__tests__/upy-v1.0.1.hex', 'utf8');
@@ -327,7 +327,7 @@ describe('Test other.', () => {
 
 describe('Test hex generation.', () => {
   beforeEach(() => {
-    addIntelHexFileSpy.mockReset();
+    addIntelHexFilesSpy.mockReset();
   });
 
   it('getIntelHex called with constructor hex string.', () => {
@@ -336,8 +336,8 @@ describe('Test hex generation.', () => {
 
     const returnedIntelHex = microbitFs.getIntelHex();
 
-    expect(addIntelHexFileSpy.mock.calls.length).toEqual(1);
-    expect(addIntelHexFileSpy.mock.calls[0][0]).toBe(uPyHexFile);
+    expect(addIntelHexFilesSpy.mock.calls.length).toEqual(1);
+    expect(addIntelHexFilesSpy.mock.calls[0][0]).toBe(uPyHexFile);
   });
 
   it('getIntelHex called with argument hex string.', () => {
@@ -347,8 +347,8 @@ describe('Test hex generation.', () => {
 
     const returnedIntelHex = microbitFs.getIntelHex(falseHex);
 
-    expect(addIntelHexFileSpy.mock.calls.length).toEqual(1);
-    expect(addIntelHexFileSpy.mock.calls[0][0]).toBe(falseHex);
+    expect(addIntelHexFilesSpy.mock.calls.length).toEqual(1);
+    expect(addIntelHexFilesSpy.mock.calls[0][0]).toBe(falseHex);
   });
 });
 
@@ -384,7 +384,7 @@ describe('Test importing files from hex.', () => {
   };
 
   beforeEach(() => {
-    addIntelHexFileSpy.mockReset();
+    addIntelHexFilesSpy.mockReset();
   });
 
   const createHexStrWithFiles = (): string => {
@@ -449,8 +449,8 @@ describe('Test importing files from hex.', () => {
     micropythonFs.importFilesFromIntelHex(hexStrWithFiles);
     const returnedIntelHex = micropythonFs.getIntelHex();
 
-    expect(addIntelHexFileSpy.mock.calls.length).toEqual(3);
-    expect(addIntelHexFileSpy.mock.calls[0][0]).toBe(uPyHexFile);
+    expect(addIntelHexFilesSpy.mock.calls.length).toEqual(1);
+    expect(addIntelHexFilesSpy.mock.calls[0][0]).toBe(uPyHexFile);
   });
 
   it('Constructor hex file with files to import thorws an error.', () => {

src/micropython-fs-builder.ts

@@ -273,28 +273,26 @@ class FsFile {
 }
 
 /**
- * Adds a byte array as a file in the MicroPython filesystem.
+ * Adds a byte array as a file to a MicroPython Memory Map.
  *
  * @throws {Error} When the invalid file name is given.
  * @throws {Error} When the the file doesn't have any data.
  * @throws {Error} When there are issues calculating the file system boundaries.
  * @throws {Error} When there is no space left for the file.
  *
- * @param intelHex - MicroPython Intel Hex string.
+ * @param intelHexMap - Memory map for the MicroPython Intel Hex.
  * @param filename - Name for the file.
  * @param data - Byte array for the file data.
- * @returns MicroPython Intel Hex string with the file in the filesystem.
+ * @returns MicroPython Memory map with the file in the filesystem.
  */
-function addIntelHexFile(
-  intelHex: string,
+function addMemMapFile(
+  intelHexMap: MemoryMap,
   filename: string,
   data: Uint8Array
-): string {
+): MemoryMap {
   if (!filename) throw new Error('File has to have a file name.');
   if (!data.length) throw new Error(`File ${filename} has to contain data.`);
 
-  const intelHexClean = cleanseOldHexFormat(intelHex);
-  const intelHexMap: MemoryMap = MemoryMap.fromHex(intelHexClean);
   const freeChunks = getFreeChunks(intelHexMap);
   if (freeChunks.length === 0) {
     throw new Error('There is no storage space left.');
@@ -305,6 +303,57 @@ function addIntelHexFile(
   const fileFsBytes = fsFile.getFsBytes(freeChunks);
   intelHexMap.set(chunksStartAddress, fileFsBytes);
   setPersistentPage(intelHexMap);
+  return intelHexMap;
+}
+
+/**
+ * Adds a byte array as a file in the MicroPython filesystem.
+ *
+ * @throws {Error} When the invalid file name is given.
+ * @throws {Error} When the the file doesn't have any data.
+ * @throws {Error} When there are issues calculating the file system boundaries.
+ * @throws {Error} When there is no space left for the file.
+ *
+ * @param intelHex - MicroPython Intel Hex string.
+ * @param filename - Name for the file.
+ * @param data - Byte array for the file data.
+ * @returns MicroPython Intel Hex string with the file in the filesystem.
+ */
+function addIntelHexFile(
+  intelHex: string,
+  filename: string,
+  data: Uint8Array
+): string {
+  // filename and data checked in addMemMapFile
+  const intelHexClean = cleanseOldHexFormat(intelHex);
+  let intelHexMap: MemoryMap = MemoryMap.fromHex(intelHexClean);
+  intelHexMap = addMemMapFile(intelHexMap, filename, data);
+  return intelHexMap.asHexString() + '\n';
+}
+
+/**
+ * Adds a hash table of filenames and byte arrays as files to the MicroPython
+ * filesystem.
+ *
+ * @throws {Error} When the an invalid file name is given.
+ * @throws {Error} When the a file doesn't have any data.
+ * @throws {Error} When there are issues calculating the file system boundaries.
+ * @throws {Error} When there is no space left for a file.
+ *
+ * @param intelHex - MicroPython Intel Hex string.
+ * @param files - Hash table with filenames as the key and byte arrays as the
+ *     value.
+ * @returns MicroPython Intel Hex string with the file in the filesystem.
+ */
+function addIntelHexFiles(
+  intelHex: string,
+  files: { [filename: string]: Uint8Array }
+): string {
+  const intelHexClean = cleanseOldHexFormat(intelHex);
+  let intelHexMap: MemoryMap = MemoryMap.fromHex(intelHexClean);
+  Object.keys(files).forEach((filename) => {
+    intelHexMap = addMemMapFile(intelHexMap, filename, files[filename]);
+  });
   return intelHexMap.asHexString() + '\n';
 }
 
@@ -408,4 +457,4 @@ function getIntelHexFiles(
   return files;
 }
 
-export { addIntelHexFile, getIntelHexFiles };
+export { addIntelHexFile, addIntelHexFiles, getIntelHexFiles };

src/micropython-fs-hex.ts

@@ -1,6 +1,6 @@
 /** Manage files in a MicroPython hex file. */
 import { FsInterface } from './fs-interface';
-import { addIntelHexFile, getIntelHexFiles } from './micropython-fs-builder';
+import { addIntelHexFiles, getIntelHexFiles } from './micropython-fs-builder';
 import { SimpleFile } from './simple-file';
 
 export class MicropythonFsHex implements FsInterface {
@@ -204,19 +204,20 @@ export class MicropythonFsHex implements FsInterface {
    * Generate a new copy of the MicroPython Intel Hex with the filesystem
    * included.
    *
-   * @throws {Error} When the file doesn't have any data.
+   * @throws {Error} When a file doesn't have any data.
    * @throws {Error} When there are issues calculating file system boundaries.
-   * @throws {Error} When there is no space left for the file.
+   * @throws {Error} When there is no space left for a file.
    *
    * @param intelHex - Optionally provide a different Intel Hex to include the
    *    filesystem into.
-   * @returns A new Intel Hex string with the filesystem included.
+   * @returns A new string with MicroPython and the filesystem included.
    */
   getIntelHex(intelHex?: string): string {
-    let finalHex = intelHex || this._intelHex;
+    const finalHex = intelHex || this._intelHex;
+    const files: { [filename: string]: Uint8Array } = {};
     Object.values(this._files).forEach((file) => {
-      finalHex = addIntelHexFile(finalHex, file.filename, file.getBytes());
+      files[file.filename] = file.getBytes();
     });
-    return finalHex;
+    return addIntelHexFiles(finalHex, files);
   }
 }