Full dependency inversion of <Dock> and all current tab kinds (#4757)

Co-authored-by: Mikko Aspiala <mikko.aspiala@gmail.com>
Co-authored-by: Sebastian Malton <sebastian@malton.name>
Co-authored-by: Janne Savolainen <janne.savolainen@live.fi>

src/common/fs/read-dir.injectable.ts

@@ -3,12 +3,11 @@
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
 import { getInjectable, lifecycleEnum } from "@ogre-tools/injectable";
-import { writeJsonFile } from "./write-json-file";
-import fsInjectable from "../fs.injectable";
+import fsInjectable from "./fs.injectable";
 
-const writeJsonFileInjectable = getInjectable({
-  instantiate: (di) => writeJsonFile({ fs: di.inject(fsInjectable) }),
+const readDirInjectable = getInjectable({
+  instantiate: (di) => di.inject(fsInjectable).readdir,
   lifecycle: lifecycleEnum.singleton,
 });
 
-export default writeJsonFileInjectable;
+export default readDirInjectable;

src/common/fs/read-file.injectable.ts

@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import { getInjectable, lifecycleEnum } from "@ogre-tools/injectable";
+import fsInjectable from "./fs.injectable";
+
+const readFileInjectable = getInjectable({
+  instantiate: (di) => di.inject(fsInjectable).readFile,
+  lifecycle: lifecycleEnum.singleton,
+});
+
+export default readFileInjectable;

src/common/fs/read-json-file.injectable.ts

@@ -2,15 +2,11 @@
  * Copyright (c) OpenLens Authors. All rights reserved.
  * Licensed under MIT License. See LICENSE in root directory for more information.
  */
-import { readJsonFile } from "./read-json-file";
 import { getInjectable, lifecycleEnum } from "@ogre-tools/injectable";
-import fsInjectable from "../fs.injectable";
+import fsInjectable from "./fs.injectable";
 
 const readJsonFileInjectable = getInjectable({
-  instantiate: (di) => readJsonFile({
-    fs: di.inject(fsInjectable),
-  }),
-
+  instantiate: (di) => di.inject(fsInjectable).readJson,
   lifecycle: lifecycleEnum.singleton,
 });
 

src/common/fs/read-json-file/read-json-file.ts

@@ -1,16 +0,0 @@
-/**
- * Copyright (c) OpenLens Authors. All rights reserved.
- * Licensed under MIT License. See LICENSE in root directory for more information.
- */
-import type { JsonObject } from "type-fest";
-
-interface Dependencies {
-  fs: {
-    readJson: (filePath: string) => Promise<JsonObject>;
-  };
-}
-
-export const readJsonFile =
-  ({ fs }: Dependencies) =>
-    (filePath: string) =>
-      fs.readJson(filePath);

src/common/fs/write-json-file.injectable.ts

@@ -0,0 +1,38 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import { getInjectable, lifecycleEnum } from "@ogre-tools/injectable";
+import type { EnsureOptions, WriteOptions } from "fs-extra";
+import path from "path";
+import type { JsonValue } from "type-fest";
+import fsInjectable from "./fs.injectable";
+
+interface Dependencies {
+  writeJson: (file: string, object: any, options?: WriteOptions | BufferEncoding | string) => Promise<void>;
+  ensureDir: (dir: string, options?: EnsureOptions | number) => Promise<void>;
+}
+
+const writeJsonFile = ({ writeJson, ensureDir }: Dependencies) => async (filePath: string, content: JsonValue) => {
+  await ensureDir(path.dirname(filePath), { mode: 0o755 });
+
+  await writeJson(filePath, content, {
+    encoding: "utf-8",
+    spaces: 2,
+  });
+};
+
+const writeJsonFileInjectable = getInjectable({
+  instantiate: (di) => {
+    const { writeJson, ensureDir } = di.inject(fsInjectable);
+
+    return writeJsonFile({
+      writeJson,
+      ensureDir,
+    });
+  },
+
+  lifecycle: lifecycleEnum.singleton,
+});
+
+export default writeJsonFileInjectable;

src/common/fs/write-json-file/write-json-file.ts

@@ -1,31 +0,0 @@
-/**
- * Copyright (c) OpenLens Authors. All rights reserved.
- * Licensed under MIT License. See LICENSE in root directory for more information.
- */
-import path from "path";
-import type { JsonObject } from "type-fest";
-
-interface Dependencies {
-  fs: {
-    ensureDir: (
-      directoryName: string,
-      options: { mode: number }
-    ) => Promise<void>;
-
-    writeJson: (
-      filePath: string,
-      contentObject: JsonObject,
-      options: { spaces: number }
-    ) => Promise<void>;
-  };
-}
-
-export const writeJsonFile =
-  ({ fs }: Dependencies) =>
-    async (filePath: string, contentObject: JsonObject) => {
-      const directoryName = path.dirname(filePath);
-
-      await fs.ensureDir(directoryName, { mode: 0o755 });
-
-      await fs.writeJson(filePath, contentObject, { spaces: 2 });
-    };

src/common/utils/__tests__/bind.test.ts

@@ -1,19 +0,0 @@
-/**
- * Copyright (c) OpenLens Authors. All rights reserved.
- * Licensed under MIT License. See LICENSE in root directory for more information.
- */
-import { bind } from "../index";
-
-describe("bind", () => {
-  it("should work correctly", () => {
-    function foobar(bound: number, nonBound: number): number {
-      expect(typeof bound).toBe("number");
-      expect(typeof nonBound).toBe("number");
-
-      return bound + nonBound;
-    }
-    const foobarBound = bind(foobar, null, 5);
-
-    expect(foobarBound(10)).toBe(15);
-  });
-});

src/common/utils/index.ts

@@ -10,13 +10,6 @@ export function noop<T extends any[]>(...args: T): void {
   return void args;
 }
 
-/**
- * A typecorrect version of <function>.bind()
- */
-export function bind<BoundArgs extends any[], NonBoundArgs extends any[], ReturnType>(fn: (...args: [...BoundArgs, ...NonBoundArgs]) => ReturnType, thisArg: any, ...boundArgs: BoundArgs): (...args: NonBoundArgs) => ReturnType {
-  return fn.bind(thisArg, ...boundArgs);
-}
-
 export * from "./app-version";
 export * from "./autobind";
 export * from "./camelCase";
@@ -49,6 +42,7 @@ export * from "./toggle-set";
 export * from "./toJS";
 export * from "./type-narrowing";
 export * from "./types";
+export * from "./wait-for-path";
 
 import * as iter from "./iter";
 import * as array from "./array";

src/common/utils/wait-for-path.ts

@@ -0,0 +1,55 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+import { FSWatcher } from "chokidar";
+import path from "path";
+
+/**
+ * Wait for `filePath` and all parent directories to exist.
+ * @param pathname The file path to wait until it exists
+ *
+ * NOTE: There is technically a race condition in this function of the form
+ * "time-of-check to time-of-use" because we have to wait for each parent
+ * directory to exist first.
+ */
+export async function waitForPath(pathname: string): Promise<void> {
+  const dirOfPath = path.dirname(pathname);
+
+  if (dirOfPath === pathname) {
+    // The root of this filesystem, assume it exists
+    return;
+  } else {
+    await waitForPath(dirOfPath);
+  }
+
+  return new Promise((resolve, reject) => {
+    const watcher = new FSWatcher({
+      depth: 0,
+      disableGlobbing: true,
+    });
+    const onAddOrAddDir = (filePath: string) => {
+      if (filePath === pathname) {
+        watcher.unwatch(dirOfPath);
+        watcher
+          .close()
+          .then(() => resolve())
+          .catch(reject);
+      }
+    };
+    const onError = (error: any) => {
+      watcher.unwatch(dirOfPath);
+      watcher
+        .close()
+        .then(() => reject(error))
+        .catch(() => reject(error));
+    };
+
+    watcher
+      .on("add", onAddOrAddDir)
+      .on("addDir", onAddOrAddDir)
+      .on("error", onError)
+      .add(dirOfPath);
+  });
+}

src/common/vars/is-linux.injectable.ts

@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import { getInjectable, lifecycleEnum } from "@ogre-tools/injectable";
+import { isLinux } from "../vars";
+
+const isLinuxInjectable = getInjectable({
+  instantiate: () => isLinux,
+  lifecycle: lifecycleEnum.singleton,
+});
+
+export default isLinuxInjectable;

src/common/vars/is-windows.injectable.ts

@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+import { getInjectable, lifecycleEnum } from "@ogre-tools/injectable";
+import { isWindows } from "../vars";
+
+const isWindowsInjectable = getInjectable({
+  instantiate: () => isWindows,
+  lifecycle: lifecycleEnum.singleton,
+});
+
+export default isWindowsInjectable;