Enforce dependency direction by tests

Author: r59q

src/StaticConfiguration.ts

@@ -8,7 +8,7 @@
  * Static configuration values. These values are not expected to change, while the application is running.
  */
 import { MBSpecs } from 'microbyte';
-import { PinTurnOnState } from './components/features/model/PinSelectorUtil';
+import { PinTurnOnState } from './lib/PinTurnOnState';
 import { type LayersModelTrainingSettings as NeuralNetworkModelTrainerSettings } from './lib/mlmodels/LayersModelTrainer';
 import { HexOrigin } from './lib/microbit-interfacing/HexOrigin';
 

src/__tests__/archtest/fileloader.ts

@@ -7,8 +7,6 @@
 import fs from 'fs';
 import * as path from 'path';
 
-const directoriesToScan = ['./src/'];
-
 export interface DirectoryContents {
   files: string[];
   folders: string[];
@@ -37,7 +35,7 @@ export const readDirectory = (
 
 export const getFilesInDirectory = (
   directory: string,
-  ignoredFiles: string[],
+  ignoredFiles: string[] = [],
 ): string[] => {
   const files: string[] = [];
   const content = readDirectory(directory, ignoredFiles);

src/__tests__/archtest/lib-dependency.test.ts

@@ -7,6 +7,48 @@
  * SPDX-License-Identifier: MIT
  */
 
+import { readFileSync } from 'fs';
+import { getFilesInDirectory } from './fileloader';
+
+const readSvelteFileScript = (fileLocation: string) => {
+  const fullContent = readFileSync(fileLocation).toString();
+  const scriptMatches = fullContent.match(/<script[^>]*>([\s\S]*?)<\/script>/g);
+  return scriptMatches?.join('');
+};
+
 describe('Dependency direction test', () => {
-  test('Files in lib should not depend on files in components', () => {});
+  // A crude way to enforce direction of dependencies, inspired by ArchUnit for java
+  test('Files in lib should not depend on files in components', () => {
+    const libFiles = getFilesInDirectory('./src/lib');
+    const libContent = libFiles.map(e => {
+      return {
+        file: e,
+        content: readFileSync(e),
+      };
+    });
+    const componentFiles = getFilesInDirectory('./src/components');
+    const componentContent = componentFiles.map(e => {
+      if (e.endsWith('.svelte')) {
+        return {
+          file: e,
+          content: readSvelteFileScript(e),
+        };
+      } else {
+        return {
+          file: e,
+          content: readFileSync(e),
+        };
+      }
+    });
+
+    const violatingFiles = libContent.filter(e => e.content.includes('components/'));
+
+    const violationMessage = violatingFiles.reduce((pre, file) => {
+      return (
+        pre +
+        `\n \u001b[35m${file.file}\t \u001b[0mis dependent on components, but is located in lib folder`
+      );
+    }, '');
+    expect(violatingFiles.length, violationMessage).toBe(0);
+  });
 });

src/__tests__/ml/classifier.test.ts

@@ -22,7 +22,7 @@ import TestTrainingDataRepository from '../mocks/TestTrainingDataRepository';
 import TestGestureRepository from '../mocks/TestGestureRepository';
 import Confidences from '../../lib/domain/stores/Confidences';
 import BaseVector from '../../lib/domain/BaseVector';
-import Snackbar from '../../components/features/snackbar/Snackbar';
+import Snackbar from '../../lib/stores/Snackbar';
 
 describe('Classifier tests', () => {
   test('Changing matrix does not mark model as untrained', async () => {

src/components/features/graphs/knngraph/AxesFilterVectorView.svelte

@@ -9,7 +9,7 @@
   import arrowCreate from 'arrows-svg';
   import { onMount } from 'svelte';
   import { vectorArrows } from './AxesFilterVector';
-  import { knnCurrentPoint } from './KnnModelGraph';
+  import { knnCurrentPoint } from '../../../../lib/stores/KnnModelGraph';
   import StaticConfiguration from '../../../../StaticConfiguration';
   import type { Axis } from '../../../../lib/domain/Axis';
   import { stores } from '../../../../lib/stores/Stores';

src/components/features/graphs/knngraph/KNNModelGraphController.ts

@@ -5,7 +5,10 @@
  */
 import { type Writable, derived, get, writable } from 'svelte/store';
 import KNNModelGraphDrawer, { type GraphDrawConfig } from './KNNModelGraphDrawer';
-import { knnCurrentPoint, knnTrainingDataPoints } from './KnnModelGraph';
+import {
+  knnCurrentPoint,
+  knnTrainingDataPoints,
+} from '../../../../lib/stores/KnnModelGraph';
 import type Filters from '../../../../lib/domain/Filters';
 import { stores } from '../../../../lib/stores/Stores';
 import type { Point3D } from '../../../../lib/utils/graphUtils';

src/components/features/graphs/knngraph/KNNModelGraphDrawer.ts

@@ -7,7 +7,7 @@ import { gridPlanes3D, points3D, lines3D } from 'd3-3d';
 import { knnHighlightedPoint } from './KnnPointToolTip';
 import { get } from 'svelte/store';
 import * as d3 from 'd3';
-import { knnNeighbours } from './KnnModelGraph';
+import { knnNeighbours } from '../../../../lib/stores/KnnModelGraph';
 import type { Point3D, Point3DTransformed } from '../../../../lib/utils/graphUtils';
 import { state, stores } from '../../../../lib/stores/Stores';
 import StaticConfiguration from '../../../../StaticConfiguration';

src/components/features/model/ModelGestureStack.svelte

@@ -30,7 +30,7 @@
   import OutputMatrix from './ModelMatrix.svelte';
   import OutputSoundSelector from './ModelSoundSelector.svelte';
   import PinSelector from './ModelPinSelector.svelte';
-  import { PinTurnOnState } from './PinSelectorUtil';
+  import { PinTurnOnState } from '../../../lib/PinTurnOnState';
   import { MBSpecs } from 'microbyte';
 
   const gestures = stores.getGestures();

src/components/features/model/ModelPinSelector.svelte

@@ -5,7 +5,7 @@
  -->
 
 <script lang="ts">
-  import { PinTurnOnState } from './PinSelectorUtil';
+  import { PinTurnOnState } from '../../../lib/PinTurnOnState';
   import { t } from '../../../i18n';
   import { MBSpecs } from 'microbyte';
   import Card from '../../ui/Card.svelte';

src/components/layout/SideBarMenuView.svelte

@@ -7,12 +7,12 @@
 <!-- Left-hand side menu -->
 <script lang="ts">
   import { get } from 'svelte/store';
-  import type { MenuProperties } from '../../lib/navigation/Menus';
+  import type { MenuProperties } from '../sidemenu/Menus';
   import { currentPath, navigate, Paths } from '../../router/Router';
   import { state } from '../../lib/stores/Stores';
   import MediaQuery from './MediaQuery.svelte';
   import { Feature, getFeature } from '../../lib/FeatureToggles';
-  import Menus from '../../lib/navigation/Menus';
+  import Menus from '../sidemenu/Menus';
   import MenuButton from '../sidemenu/MenuButton.svelte';
 
   $: shouldBeExpanded = (menuProps: MenuProperties) => {