feat: factor out common.ts and errors.ts into a utils package (#1587)

* There's a bunch of TypeScript utilities that we can use across the monorepo here
opensource-observer · Jun 4, 2024 · 73cf528 · 73cf528
1 parent 57d88f3
commit 73cf528
Show file tree

Hide file tree

Showing 20 changed files with 277 additions and 93 deletions.
diff --git a/apps/frontend/components/dataprovider/auth-router.tsx b/apps/frontend/components/dataprovider/auth-router.tsx
@@ -5,9 +5,9 @@ import {
   CommonDataProviderRegistration,
   DataProviderView,
 } from "./provider-view";
+import { spawn } from "@opensource-observer/utils";
 import { RegistrationProps } from "../../lib/types/plasmic";
 import { logger } from "../../lib/logger";
-import { spawn } from "../../lib/common";
 import { analytics } from "../../lib/clients/segment";
 import { supabaseClient } from "../../lib/clients/supabase";
 

diff --git a/apps/frontend/components/dataprovider/event-data-provider.tsx b/apps/frontend/components/dataprovider/event-data-provider.tsx
@@ -2,7 +2,7 @@ import { useQuery } from "@apollo/experimental-nextjs-app-support/ssr";
 import dayjs from "dayjs";
 import _ from "lodash";
 import React from "react";
-import { assertNever, ensure, uncheckedCast } from "../../lib/common";
+import { assertNever, ensure, uncheckedCast } from "@opensource-observer/utils";
 import {
   GET_ARTIFACTS_BY_IDS,
   GET_PROJECTS_BY_IDS,

diff --git a/apps/frontend/components/widgets/analytics.tsx b/apps/frontend/components/widgets/analytics.tsx
@@ -2,8 +2,8 @@
 
 import { useEffect } from "react";
 import { usePathname, useSearchParams } from "next/navigation";
+import { spawn } from "@opensource-observer/utils";
 import { analytics } from "../../lib/clients/segment";
-import { spawn } from "../../lib/common";
 
 function Analytics() {
   const pathname = usePathname();

diff --git a/apps/frontend/components/widgets/auth-actions.tsx b/apps/frontend/components/widgets/auth-actions.tsx
@@ -1,9 +1,9 @@
 import React, { ReactNode } from "react";
 import { Provider } from "@supabase/supabase-js";
 import { useRouter, usePathname } from "next/navigation";
+import { assertNever, spawn } from "@opensource-observer/utils";
 import { supabaseClient } from "../../lib/clients/supabase";
 import { RegistrationProps } from "../../lib/types/plasmic";
-import { assertNever, spawn } from "../../lib/common";
 import { NODE_ENV, DOMAIN } from "../../lib/config";
 
 type AuthActionType = "signInWithOAuth" | "signOut";

diff --git a/apps/frontend/components/widgets/supabase-write.tsx b/apps/frontend/components/widgets/supabase-write.tsx
@@ -3,9 +3,8 @@ import { useRouter } from "next/navigation";
 import Snackbar from "@mui/material/Snackbar";
 import Alert from "@mui/material/Alert";
 import { ADT } from "ts-adt";
+import { HttpError, assertNever, spawn } from "@opensource-observer/utils";
 import { RegistrationProps } from "../../lib/types/plasmic";
-import { HttpError } from "../../lib/types/errors";
-import { assertNever, spawn } from "../../lib/common";
 import { supabaseClient } from "../../lib/clients/supabase";
 
 type SnackbarState = ADT<{

diff --git a/apps/frontend/lib/clients/supabase.ts b/apps/frontend/lib/clients/supabase.ts
@@ -1,5 +1,5 @@
 import { createClient } from "@supabase/supabase-js";
-import { HttpError } from "../types/errors";
+import { HttpError } from "@opensource-observer/utils";
 import {
   SUPABASE_URL,
   SUPABASE_ANON_KEY,

diff --git a/apps/frontend/lib/projects.ts b/apps/frontend/lib/projects.ts
@@ -1,7 +1,7 @@
 import * as _ from "lodash";
 import { generate } from "random-words";
 import { v4 as uuid4 } from "uuid";
-import { safeCast } from "./common";
+import { safeCast } from "@opensource-observer/utils";
 import {
   Collection,
   NullSortingState,

diff --git a/apps/frontend/package.json b/apps/frontend/package.json
@@ -27,6 +27,7 @@
     "@mui/icons-material": "^5.15.6",
     "@mui/material": "^5.15.6",
     "@mui/x-date-pickers": "^6.19.0",
+    "@opensource-observer/utils": "workspace:*",
     "@plasmicapp/loader-nextjs": "^1.0.360",
     "@segment/analytics-next": "^1.66.0",
     "@supabase/auth-helpers-nextjs": "^0.8.7",

diff --git a/lib/oss-artifact-validators/src/onchain/evm.ts b/lib/oss-artifact-validators/src/onchain/evm.ts
@@ -9,7 +9,7 @@ export interface EVMNetworkValidator {
   isDeployer(addr: string): Promise<boolean>;
 }
 
-export interface GenericEVMNetworkValidtorOptions {
+interface GenericEVMNetworkValidatorOptions {
   rpcUrl: string;
   deployerTable: string;
   bqOptions?: BigQueryOptions;
@@ -24,7 +24,7 @@ export class GenericEVMNetworkValidator implements EVMNetworkValidator {
   private deployerTable: string;
 
   static create(
-    options: GenericEVMNetworkValidtorOptions,
+    options: GenericEVMNetworkValidatorOptions,
   ): EVMNetworkValidator {
     const web3 = new Web3(options.rpcUrl);
     const bq = new BigQuery(options.bqOptions);
@@ -71,7 +71,7 @@ export class GenericEVMNetworkValidator implements EVMNetworkValidator {
 }
 
 export type EthereumOptions = Omit<
-  GenericEVMNetworkValidtorOptions,
+  GenericEVMNetworkValidatorOptions,
   "deployerTable"
 >;
 
@@ -84,7 +84,7 @@ export function EthereumValidator(options: EthereumOptions) {
 }
 
 export type ArbitrumOptions = Omit<
-  GenericEVMNetworkValidtorOptions,
+  GenericEVMNetworkValidatorOptions,
   "deployerTable"
 >;
 
@@ -97,7 +97,7 @@ export function ArbitrumValidator(options: ArbitrumOptions) {
 }
 
 export type BaseOptions = Omit<
-  GenericEVMNetworkValidtorOptions,
+  GenericEVMNetworkValidatorOptions,
   "deployerTable"
 >;
 
@@ -110,7 +110,7 @@ export function BaseValidator(options: BaseOptions) {
 }
 
 export type OptimismOptions = Omit<
-  GenericEVMNetworkValidtorOptions,
+  GenericEVMNetworkValidatorOptions,
   "deployerTable"
 >;
 

diff --git a/lib/utils/.eslintrc.json b/lib/utils/.eslintrc.json
@@ -0,0 +1,7 @@
+{
+  "extends": ["../../.eslintrc.js"],
+  "root": false,
+  "parserOptions": {
+    "project": ["./lib/utils/tsconfig.json"]
+  }
+}
diff --git a/lib/utils/README.md b/lib/utils/README.md
@@ -0,0 +1,3 @@
+# OSO Utils
+
+Utility functions used in the OSO monorepo
diff --git a/lib/utils/package.json b/lib/utils/package.json
@@ -0,0 +1,39 @@
+{
+  "name": "@opensource-observer/utils",
+  "version": "0.0.1",
+  "description": "Utility functions used in OSO",
+  "author": "Kariba Labs",
+  "license": "Apache-2.0",
+  "private": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "files": [
+    "dist",
+    "README.md",
+    "package.json"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/opensource-observer/oso.git"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "build": "tsc",
+    "lint": "tsc --noEmit && pnpm lint:eslint && pnpm lint:prettier",
+    "lint:eslint": "eslint --ignore-path ../../.gitignore --max-warnings 0 .",
+    "lint:prettier": "prettier --ignore-path ../../.gitignore --log-level warn --check **/*.{js,jsx,ts,tsx,sol,md,json}"
+  },
+  "keywords": [],
+  "devDependencies": {
+    "@types/node": "^20.14.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.5"
+  },
+  "dependencies": {
+    "@types/lodash": "^4.17.4",
+    "lodash": "^4.17.21"
+  }
+}
diff --git a/apps/frontend/lib/common.ts → lib/utils/src/common.ts b/apps/frontend/lib/common.ts → lib/utils/src/common.ts
@@ -1,4 +1,4 @@
-import { NullOrUndefinedValueError, AssertionError } from "./types/errors";
+import { NullOrUndefinedValueError, AssertionError } from "./errors.js";
 /**
  * Explicitly marks a promise as something we won't await
  * @param _promise

diff --git a/apps/frontend/lib/types/errors.ts → lib/utils/src/errors.ts b/apps/frontend/lib/types/errors.ts → lib/utils/src/errors.ts
diff --git a/lib/utils/src/index.ts b/lib/utils/src/index.ts
@@ -0,0 +1,2 @@
+export * from "./errors.js";
+export * from "./common.js";
diff --git a/lib/utils/tsconfig.json b/lib/utils/tsconfig.json
@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "target": "ES6",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "declaration": true,
+    "declarationMap": true,
+    "esModuleInterop": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "noImplicitAny": true,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "strictNullChecks": true,
+    "strictPropertyInitialization": false,
+  },
+  "exclude": ["node_modules"],
+  "include": ["./src/*.ts", "./src/**/*.ts", "./test"],
+}
diff --git a/ops/external-prs/package.json b/ops/external-prs/package.json
@@ -36,6 +36,7 @@
   "dependencies": {
     "@google-cloud/bigquery": "^7.5.1",
     "@opensource-observer/oss-artifact-validators": "workspace:*",
+    "@opensource-observer/utils": "workspace:*",
     "@types/columnify": "^1.5.4",
     "@types/libsodium-wrappers": "^0.7.13",
     "@types/mustache": "^4.2.5",

diff --git a/ops/external-prs/src/ossd/index.ts b/ops/external-prs/src/ossd/index.ts
@@ -27,6 +27,7 @@ import {
   BaseValidator,
   OptimismValidator,
 } from "@opensource-observer/oss-artifact-validators";
+import { uncheckedCast } from "@opensource-observer/utils";
 import { GithubOutput } from "../github.js";
 import { CheckConclusion, CheckStatus } from "../checks.js";
 
@@ -642,7 +643,8 @@ class OSSDirectoryPullRequest {
     for (const item of this.changes.artifacts.toValidate.blockchain) {
       const address = item.address;
       for (const network of item.networks) {
-        const validator = this.validators[network as BlockchainNetwork];
+        const validator =
+          this.validators[uncheckedCast<BlockchainNetwork>(network)];
         if (!validator) {
           logger.error({
             message: "no validator found for network",