Merge pull request #1034 from scramjetorg/fix/move-mgr-api-client

[FIX] Cyclic dependency in api-client and manager-client
scramjetorg · Feb 12, 2024 · dfbe9f4 · dfbe9f4
2 parents e140747 + 6e3a6fe
commit dfbe9f4
Show file tree

Hide file tree

Showing 22 changed files with 20 additions and 106 deletions.
diff --git a/packages/api-client/package.json b/packages/api-client/package.json
@@ -14,7 +14,6 @@
   "license": "MIT",
   "dependencies": {
     "@scramjet/client-utils": "^0.39.0",
-    "@scramjet/manager-api-client": "^0.39.0",
     "@scramjet/sth-config": "^0.39.0",
     "@scramjet/symbols": "^0.39.0",
     "n-readlines": "^1.0.1",

diff --git a/packages/api-client/src/definitions.d.ts b/packages/api-client/src/definitions.d.ts
@@ -0,0 +1,2 @@
+/// <reference path="host-client.ts"/>
+/// <reference path="manager-client.ts"/>
diff --git a/packages/api-client/src/host-client.ts b/packages/api-client/src/host-client.ts
@@ -1,9 +1,12 @@
+/// <reference path="./definitions.d.ts" />
+
 import { ClientProvider, ClientUtils, ClientUtilsCustomAgent, Headers, HttpClient } from "@scramjet/client-utils";
 import { STHRestAPI } from "@scramjet/types";
 import { InstanceClient } from "./instance-client";
 import { SequenceClient } from "./sequence-client";
 import { HostHeaders } from "@scramjet/symbols";
-import { ManagerClient } from "@scramjet/manager-api-client";
+// eslint-disable-next-line import/no-cycle
+import { ManagerClient } from "./manager-client";
 
 /**
  * Host client.

diff --git a/packages/api-client/src/index.ts b/packages/api-client/src/index.ts
@@ -1,3 +1,4 @@
 export { HostClient } from "./host-client";
 export { InstanceClient, InstanceInputStream, InstanceOutputStream } from "./instance-client";
 export { SequenceClient } from "./sequence-client";
+export * from "./manager-client";
diff --git a/.../manager-api-client/src/manager-client.ts → packages/api-client/src/manager-client.ts b/.../manager-api-client/src/manager-client.ts → packages/api-client/src/manager-client.ts
@@ -1,4 +1,7 @@
-import { HostClient, } from "@scramjet/api-client";
+/// <reference path="./definitions.d.ts" />
+
+// eslint-disable-next-line import/no-cycle
+import { HostClient } from "./host-client";
 import { ClientUtils, ClientProvider, HttpClient, ClientUtilsCustomAgent } from "@scramjet/client-utils";
 import { MRestAPI, LoadCheckStat } from "@scramjet/types";
 import { Readable } from "stream";

diff --git a/packages/manager-api-client/.eslintrc.js b/packages/manager-api-client/.eslintrc.js
diff --git a/packages/manager-api-client/package.json b/packages/manager-api-client/package.json
diff --git a/packages/manager-api-client/src/index.ts b/packages/manager-api-client/src/index.ts
diff --git a/packages/manager-api-client/test/pass.spec.ts b/packages/manager-api-client/test/pass.spec.ts
diff --git a/packages/manager-api-client/tsconfig.build.json b/packages/manager-api-client/tsconfig.build.json
diff --git a/packages/manager-api-client/tsconfig.json b/packages/manager-api-client/tsconfig.json
diff --git a/packages/middleware-api-client/package.json b/packages/middleware-api-client/package.json
@@ -16,7 +16,6 @@
   "dependencies": {
     "@scramjet/api-client": "^0.39.0",
     "@scramjet/client-utils": "^0.39.0",
-    "@scramjet/manager-api-client": "^0.39.0",
     "@scramjet/multi-manager-api-client": "^0.39.0"
   },
   "devDependencies": {

diff --git a/packages/middleware-api-client/src/middleware-client.ts b/packages/middleware-api-client/src/middleware-client.ts
@@ -1,6 +1,6 @@
 /* eslint-disable no-console */
 import { ClientProvider, ClientUtils } from "@scramjet/client-utils";
-import { ManagerClient } from "@scramjet/manager-api-client";
+import { ManagerClient } from "@scramjet/api-client";
 import { MWRestAPI, MMRestAPI } from "@scramjet/types";
 
 /**

diff --git a/packages/multi-manager-api-client/package.json b/packages/multi-manager-api-client/package.json
@@ -13,8 +13,7 @@
   },
   "dependencies": {
     "@scramjet/api-client": "^0.39.0",
-    "@scramjet/client-utils": "^0.39.0",
-    "@scramjet/manager-api-client": "^0.39.0"
+    "@scramjet/client-utils": "^0.39.0"
   },
   "devDependencies": {
     "@scramjet/types": "^0.39.0",

diff --git a/packages/multi-manager-api-client/src/multi-cpm-client.ts b/packages/multi-manager-api-client/src/multi-cpm-client.ts
@@ -1,6 +1,6 @@
 /* eslint-disable no-console */
 import { ClientProvider, ClientUtils, HttpClient } from "@scramjet/client-utils";
-import { ManagerClient } from "@scramjet/manager-api-client";
+import { ManagerClient } from "@scramjet/api-client";
 import { DeepPartial, LoadCheckStat, ManagerConfiguration, MMRestAPI } from "@scramjet/types";
 
 export class MultiManagerClient implements ClientProvider {

diff --git a/packages/runner/Dockerfile b/packages/runner/Dockerfile
@@ -20,7 +20,6 @@ WORKDIR /app/
 
 COPY ./dist/sth-config ./dist/sth-config
 COPY ./dist/api-client ./dist/api-client
-COPY ./dist/manager-api-client ./dist/manager-api-client
 COPY ./dist/client-utils ./dist/client-utils
 COPY ./dist/utility ./dist/utility
 COPY ./dist/symbols ./dist/symbols

diff --git a/packages/runner/package.json b/packages/runner/package.json
@@ -18,7 +18,6 @@
   "dependencies": {
     "@scramjet/api-client": "^0.39.0",
     "@scramjet/client-utils": "^0.39.0",
-    "@scramjet/manager-api-client": "^0.39.0",
     "@scramjet/model": "^0.39.0",
     "@scramjet/obj-logger": "^0.39.0",
     "@scramjet/symbols": "^0.39.0",

diff --git a/packages/sth/Dockerfile b/packages/sth/Dockerfile
@@ -9,7 +9,6 @@ COPY ./dist/api-server ./dist/api-server
 COPY ./dist/sth-config ./dist/sth-config
 COPY ./dist/host ./dist/host
 COPY ./dist/obj-logger ./dist/obj-logger
-COPY ./dist/manager-api-client ./dist/manager-api-client
 COPY ./dist/model ./dist/model
 COPY ./dist/module-loader ./dist/module-loader
 COPY ./dist/runner ./dist/runner

diff --git a/packages/types/src/api-client/host-client.ts b/packages/types/src/api-client/host-client.ts
@@ -75,5 +75,5 @@ export declare class HostClient {
     getTopics(): Promise<STHRestAPI.GetTopicsResponse>;
     getInstanceClient(id: string): InstanceClient;
     getSequenceClient(id: string): SequenceClient;
-    getManagerClient(apiBase: string, utils: ClientUtils | undefined): import("../manager-api-client/manager-client").ManagerClient;
+    getManagerClient(apiBase: string, utils: ClientUtils | undefined): import("./manager-client").ManagerClient;
 }
diff --git a/.../src/manager-api-client/manager-client.ts → ...es/types/src/api-client/manager-client.ts b/.../src/manager-api-client/manager-client.ts → ...es/types/src/api-client/manager-client.ts
@@ -12,7 +12,7 @@ export declare class ManagerClient {
 
     constructor(apiBase: string, utils: ClientUtils | undefined);
 
-    getHostClient(id: string, hostApiBase: string): import("../api-client/host-client").HostClient;
+    getHostClient(id: string, hostApiBase: string): import("./host-client").HostClient;
     getHosts(): Promise<MRestAPI.GetHostInfoResponse[]>;
     getVersion(): Promise<STHRestAPI.GetVersionResponse>;
     sendNamedData<T>(topic: string, stream: Parameters<HttpClient["sendStream"]>[1], requestInit?: RequestInit, contentType?: string, end?: boolean): Promise<T>;

diff --git a/packages/types/src/app-context.ts b/packages/types/src/app-context.ts
@@ -180,11 +180,11 @@ export interface AppContext<AppConfigType extends AppConfig, State extends any>
     /** Allows setting timeout in millis to exit the sequence after exit called (default 10000) */
     exitTimeout: number;
 
-    /** Allows to access Hub, for datails please refer to @scramjet/api-client */
+    /** Allows to access Hub, for details please refer to @scramjet/api-client */
     hub: import("./api-client/host-client").HostClient;
 
-    /** Allows to access Space, for datails please refer to @scramjet/manager-api-client */
-    space: import("./manager-api-client/manager-client").ManagerClient;
+    /** Allows to access Space, for details please refer to @scramjet/api-client */
+    space: import("./api-client/manager-client").ManagerClient;
 
     /** Instance Id */
     instanceId: string;

diff --git a/packages/types/src/index.ts b/packages/types/src/index.ts
@@ -44,7 +44,7 @@ export * from "./sd-stream-handler";
 export * from "./sd-topic-handler";
 export * from "./topic-router";
 
-export type ManagerClient = import("./manager-api-client/manager-client").ManagerClient;
+export type ManagerClient = import("./api-client/manager-client").ManagerClient;
 
 export { MRestAPI };
 export { MWRestAPI };