Add number of magic modules to file stats (#1079)

https://microbit-global.monday.com/boards/1125389526/pulses/1136771284

Author: microbit-robert

.circleci/config.yml

@@ -43,7 +43,7 @@ _steps:
   install_dependencies: &install_dependencies
     run: npm ci --cache .npm-cache && sudo npm config set @microbit-foundation:registry https://npm.pkg.github.com/microbit-foundation && sudo npm i -g @microbit-foundation/[email protected] @microbit-foundation/[email protected] @microbit-foundation/circleci-npm-package-versioner@1
   install_theme: &install_theme
-    run: npm config set @microbit-foundation:registry https://npm.pkg.github.com/microbit-foundation && npm install --no-save @microbit-foundation/[email protected].195
+    run: npm config set @microbit-foundation:registry https://npm.pkg.github.com/microbit-foundation && npm install --no-save @microbit-foundation/[email protected].198
   update_version: &update_version
     run: npm run ci:update-version
   build: &build

src/fs/fs.test.ts

@@ -229,6 +229,7 @@ describe("Filesystem", () => {
       files: 1,
       lines: undefined, // signifies initial program
       storageUsed: 256,
+      magicModules: 0,
     });
 
     await ufs.write(
@@ -239,10 +240,13 @@ describe("Filesystem", () => {
     const data = new Uint8Array(512);
     data.fill(128);
     await ufs.write("other.dat", data, VersionAction.INCREMENT);
+    const moduleData = "# microbit-module: [email protected]";
+    await ufs.write("magic_module.py", moduleData, VersionAction.INCREMENT);
     expect(await ufs.statistics()).toEqual({
-      files: 2,
+      files: 3,
       lines: 3,
-      storageUsed: 768,
+      storageUsed: 896,
+      magicModules: 1,
     });
   });
 });

src/fs/fs.ts

@@ -15,7 +15,7 @@ import { BoardId } from "../device/board-id";
 import { FlashDataSource, HexGenerationError } from "../device/device";
 import { Logging } from "../logging/logging";
 import { MicroPythonSource } from "../micropython/micropython";
-import { asciiToBytes, generateId } from "./fs-util";
+import { asciiToBytes, extractModuleData, generateId } from "./fs-util";
 import { Host } from "./host";
 import { PythonProject } from "./initial-project";
 import { FSStorage } from "./storage";
@@ -58,6 +58,10 @@ export interface Statistics {
    * HEX storage used.
    */
   storageUsed: number;
+  /**
+   * Number of files tagged with "# microbit-module:".
+   */
+  magicModules: number;
 }
 
 /**
@@ -387,15 +391,24 @@ export class FileSystem extends EventEmitter implements FlashDataSource {
   async statistics(): Promise<Statistics> {
     const fs = await this.initialize();
     const currentMainFile = fs.readBytes(MAIN_FILE);
+    const files = fs.ls();
+    let numMagicModules = 0;
+    for (const file of files) {
+      const text = fs.read(file);
+      if (extractModuleData(text)) {
+        numMagicModules++;
+      }
+    }
     return {
-      files: fs.ls().length,
+      files: files.length,
       storageUsed: fs.getStorageUsed(),
       lines:
         this.cachedInitialProject &&
         this.cachedInitialProject.files[MAIN_FILE] ===
           fromByteArray(currentMainFile)
           ? undefined
           : lineNumFromUint8Array(currentMainFile),
+      magicModules: numMagicModules,
     };
   }