Restructure to monorepo (#6907)

* wip: restructure to monorepo Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * refactor create-release-pr to a package Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * build fixes Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * github workflow fixes Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * fix typo Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * add webpack-env types to core Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * fix github workflows Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * refactor/fix integration tests Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * lint fix Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * yarn run dev Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * eslint settings for vscode Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * move templates to right package Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * open-lens build fixes Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * integration test fix Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * fix nx task dependencies Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * use bash shell for unit tests in test workflow Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * fix test:unit for windows Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * fix win-ca webpack error in open-lens Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * fix win-ca webpack error in open-lens Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * fix build:app on windows Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * remove ELECTRON_BUILDER_EXTRA_ARGS Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * sync src/ from master Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> * remove Makefile from core Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>
2025-05-20 05:10:56 +00:00 · 2023-01-24 10:46:26 -08:00
1 parent 0066ca4ea2
commit 2657df2293
@@ -0,0 +1,258 @@
+/**
+ * Copyright (c) OpenLens Authors. All rights reserved.
+ * Licensed under MIT License. See LICENSE in root directory for more information.
+ */
+
+// Base http-service / json-api class
+
+import { Agent as HttpAgent } from "http";
+import { Agent as HttpsAgent } from "https";
+import { merge } from "lodash";
+import type { Response, RequestInit } from "node-fetch";
+import { stringify } from "querystring";
+import type { Patch } from "rfc6902";
+import type { PartialDeep, ValueOf } from "type-fest";
+import { EventEmitter } from "../../common/event-emitter";
+import type { Logger } from "../../common/logger";
+import type { Fetch } from "../fetch/fetch.injectable";
+import type { Defaulted } from "../utils";
+import { json } from "../utils";
+
+export interface JsonApiData {}
+
+export interface JsonApiError {
+  code?: number;
+  message?: string;
+  errors?: { id: string; title: string; status?: number }[];
+}
+
+export interface JsonApiParams<D> {
+  data?: PartialDeep<D>; // request body
+}
+
+export interface JsonApiLog {
+  method: string;
+  reqUrl: string;
+  reqInit: RequestInit;
+  data?: any;
+  error?: any;
+}
+
+export type GetRequestOptions = () => Promise<RequestInit>;
+
+export interface JsonApiConfig {
+  apiBase: string;
+  serverAddress: string;
+  debug?: boolean;
+  getRequestOptions?: GetRequestOptions;
+}
+
+const httpAgent = new HttpAgent({ keepAlive: true });
+const httpsAgent = new HttpsAgent({ keepAlive: true });
+
+export type QueryParam = string | number | boolean | null | undefined | readonly string[] | readonly  number[] | readonly boolean[];
+export type QueryParams = Partial<Record<string, QueryParam | undefined>>;
+
+export type ParamsAndQuery<Params, Query> = (
+  ValueOf<Query> extends QueryParam
+    ? Params & { query?: Query }
+    : Params & { query?: undefined }
+);
+
+export interface JsonApiDependencies {
+  fetch: Fetch;
+  readonly logger: Logger;
+}
+
+export class JsonApi<Data = JsonApiData, Params extends JsonApiParams<Data> = JsonApiParams<Data>> {
+  static readonly reqInitDefault = {
+    headers: {
+      "content-type": "application/json",
+    },
+  };
+  protected readonly reqInit: Defaulted<RequestInit, keyof typeof JsonApi["reqInitDefault"]>;
+
+  static readonly configDefault: Partial<JsonApiConfig> = {
+    debug: false,
+  };
+
+  constructor(protected readonly dependencies: JsonApiDependencies, public readonly config: JsonApiConfig, reqInit?: RequestInit) {
+    this.config = Object.assign({}, JsonApi.configDefault, config);
+    this.reqInit = merge({}, JsonApi.reqInitDefault, reqInit);
+    this.parseResponse = this.parseResponse.bind(this);
+    this.getRequestOptions = config.getRequestOptions ?? (() => Promise.resolve({}));
+  }
+
+  public readonly onData = new EventEmitter<[Data, Response]>();
+  public readonly onError = new EventEmitter<[JsonApiErrorParsed, Response]>();
+  private readonly getRequestOptions: GetRequestOptions;
+
+  async getResponse<Query>(
+    path: string,
+    params?: ParamsAndQuery<Params, Query>,
+    init: RequestInit = {},
+  ): Promise<Response> {
+    let reqUrl = `${this.config.serverAddress}${this.config.apiBase}${path}`;
+    const reqInit = merge(
+      {
+        method: "get",
+        agent: reqUrl.startsWith("https:") ? httpsAgent : httpAgent,
+      },
+      this.reqInit,
+      await this.getRequestOptions(),
+      init,
+    );
+    const { query } = params ?? {};
+
+    if (query && Object.keys(query).length > 0) {
+      const queryString = stringify(query as unknown as QueryParams);
+
+      reqUrl += (reqUrl.includes("?") ? "&" : "?") + queryString;
+    }
+
+    return this.dependencies.fetch(reqUrl, reqInit);
+  }
+
+  get<OutData = Data, Query = QueryParams>(
+    path: string,
+    params?: ParamsAndQuery<Params, Query>,
+    reqInit: RequestInit = {},
+  ) {
+    return this.request<OutData, Query>(path, params, { ...reqInit, method: "get" });
+  }
+
+  post<OutData = Data, Query = QueryParams>(
+    path: string,
+    params?: ParamsAndQuery<Params, Query>,
+    reqInit: RequestInit = {},
+  ) {
+    return this.request<OutData, Query>(path, params, { ...reqInit, method: "post" });
+  }
+
+  put<OutData = Data, Query = QueryParams>(
+    path: string,
+    params?: ParamsAndQuery<Params, Query>,
+    reqInit: RequestInit = {},
+  ) {
+    return this.request<OutData, Query>(path, params, { ...reqInit, method: "put" });
+  }
+
+  patch<OutData = Data, Query = QueryParams>(
+    path: string,
+    params?: (ParamsAndQuery<Omit<Params, "data">, Query> & { data?: Patch | PartialDeep<Data> }),
+    reqInit: RequestInit = {},
+  ) {
+    return this.request<OutData, Query>(path, params, { ...reqInit, method: "patch" });
+  }
+
+  del<OutData = Data, Query = QueryParams>(
+    path: string,
+    params?: ParamsAndQuery<Params, Query>,
+    reqInit: RequestInit = {},
+  ) {
+    return this.request<OutData, Query>(path, params, { ...reqInit, method: "delete" });
+  }
+
+  protected async request<OutData, Query = QueryParams>(
+    path: string,
+    params: (ParamsAndQuery<Omit<Params, "data">, Query> & { data?: unknown }) | undefined,
+    init: Defaulted<RequestInit, "method">,
+  ) {
+    let reqUrl = `${this.config.serverAddress}${this.config.apiBase}${path}`;
+    const reqInit = merge(
+      {},
+      this.reqInit,
+      await this.getRequestOptions(),
+      init,
+    );
+    const { data, query } = params || {};
+
+    if (data && !reqInit.body) {
+      reqInit.body = JSON.stringify(data);
+    }
+
+    if (query && Object.keys(query).length > 0) {
+      const queryString = stringify(query as unknown as QueryParams);
+
+      reqUrl += (reqUrl.includes("?") ? "&" : "?") + queryString;
+    }
+    const infoLog: JsonApiLog = {
+      method: reqInit.method.toUpperCase(),
+      reqUrl,
+      reqInit,
+    };
+
+    const res = await this.dependencies.fetch(reqUrl, reqInit);
+
+    return this.parseResponse<OutData>(res, infoLog);
+  }
+
+  protected async parseResponse<OutData>(res: Response, log: JsonApiLog): Promise<OutData> {
+    const { status } = res;
+
+    const text = await res.text();
+    let data: any;
+
+    try {
+      data = text ? json.parse(text) : ""; // DELETE-requests might not have response-body
+    } catch (e) {
+      data = text;
+    }
+
+    if (status >= 200 && status < 300) {
+      this.onData.emit(data, res);
+      this.writeLog({ ...log, data });
+
+      return data;
+    }
+
+    if (log.method === "GET" && res.status === 403) {
+      this.writeLog({ ...log, error: data });
+      throw data;
+    }
+
+    const error = new JsonApiErrorParsed(data, this.parseError(data, res));
+
+    this.onError.emit(error, res);
+    this.writeLog({ ...log, error });
+
+    throw error;
+  }
+
+  protected parseError(error: JsonApiError | string, res: Response): string[] {
+    if (typeof error === "string") {
+      return [error];
+    }
+
+    if (Array.isArray(error.errors)) {
+      return error.errors.map(error => error.title);
+    }
+
+    if (error.message) {
+      return [error.message];
+    }
+
+    return [res.statusText || "Error!"];
+  }
+
+  protected writeLog(log: JsonApiLog) {
+    const { method, reqUrl, ...params } = log;
+
+    this.dependencies.logger.debug(`[JSON-API] request ${method} ${reqUrl}`, params);
+  }
+}
+
+export class JsonApiErrorParsed {
+  isUsedForNotification = false;
+
+  constructor(private error: JsonApiError | DOMException, private messages: string[]) {
+  }
+
+  get isAborted() {
+    return this.error.code === DOMException.ABORT_ERR;
+  }
+
+  toString() {
+    return this.messages.join("\n");
+  }
+}