Fix CI and Build outputs (#364)

* build and CI refinements --------- Co-authored-by: kwrobel.eth <[email protected]>
namehash · Aug 26, 2024 · 1e677da · 1e677da
1 parent d6aff4f
commit 1e677da
Show file tree

Hide file tree

Showing 27 changed files with 249 additions and 272 deletions.
diff --git a/.changeset/selfish-toys-move.md b/.changeset/selfish-toys-move.md
@@ -0,0 +1,9 @@
+---
+"@namehash/nameguard-react": minor
+"@namehash/nameguard": minor
+"@namehash/namekit-react": minor
+"@namehash/nameguard-js": minor
+"@namehash/ens-utils": minor
+---
+
+build changes
diff --git a/.github/workflows/nameguard-end-to-end-tests.yml b/.github/workflows/nameguard-end-to-end-tests.yml
@@ -88,9 +88,19 @@ jobs:
         if: needs.check_changes.outputs.api_changed > 0
         run: curl http://0.0.0.0:8000/inspect-name/mainnet/test.eth
 
+      - name: Set NAMEGUARD_API_URI
+        id: set_api_uri
+        env:
+          PRODUCTION_NAMEGUARD_API_URI: ${{ vars.PRODUCTION_NAMEGUARD_API_URI }}
+        run: |
+          if [ "${{ needs.check_changes.outputs.api_changed }}" -gt 0 ]; then
+            echo "NAMEGUARD_API_URI=http://0.0.0.0:8000" >> $GITHUB_ENV
+          else
+            echo "NAMEGUARD_API_URI=$PRODUCTION_NAMEGUARD_API_URI" >> $GITHUB_ENV
+          fi
+         
       - name: Run tests
         env:
           PROVIDER_URI_MAINNET: ${{ secrets.PROVIDER_URI_MAINNET }}
           PROVIDER_URI_SEPOLIA: ${{ secrets.PROVIDER_URI_SEPOLIA }}
-          NAMEGUARD_API_URI: ${{ needs.check_changes.outputs.api_changed > 0 && 'http://0.0.0.0:8000' || '' }}
         run: pnpm test --filter ./packages/nameguard-sdk
diff --git a/.github/workflows/typescript-packages-unit-tests.yml b/.github/workflows/typescript-packages-unit-tests.yml
@@ -1,4 +1,4 @@
-name: TypeScript Packages - Unit Tests
+name: TypeScript Packages - Unit
 
 on:
   push:
@@ -13,47 +13,50 @@ on:
       - "packages/**"
 
 jobs:
-  check_changes:
-    runs-on: ubuntu-latest
-    outputs:
-      sdk_only_changed: ${{ steps.check.outputs.sdk_only_changed }}
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Check for SDK-only changes
-        id: check
-        run: |
-          git fetch origin ${{ github.base_ref }}
-          API_CHANGED=$(git diff --name-only origin/${{ github.base_ref }} HEAD | grep "^api/nameguard/" | wc -l)
-          SDK_CHANGED=$(git diff --name-only origin/${{ github.base_ref }} HEAD | grep "^packages/nameguard-sdk/" | wc -l)
-          if [ $API_CHANGED -eq 0 ] && [ $SDK_CHANGED -gt 0 ]; then
-            echo "sdk_only_changed=true" >> $GITHUB_OUTPUT
-          else
-            echo "sdk_only_changed=false" >> $GITHUB_OUTPUT
-          fi
-
-  build:
-    runs-on: ubuntu-latest
+  test:
     strategy:
+      fail-fast: false
       matrix:
         package:
           - "ens-utils"
+          - "nameguard-sdk"
           - "nameguard-js"
           - "nameguard-react"
-          - "nameguard-sdk"
           - "namekit-react"
+
+    name: Test ${{ matrix.package }}
+    runs-on: ubuntu-latest
+
     steps:
       - uses: actions/checkout@v4
 
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "lts/*"
+
       - name: Setup pnpm
         uses: pnpm/action-setup@v4
 
-      - name: Install Dependencies
+      - name: Get pnpm store directory
+        id: pnpm-cache
+        shell: bash
+        run: |
+          echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
+
+      - uses: actions/cache@v3
+        name: Setup pnpm cache
+        with:
+          path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-pnpm-store-
+
+      - name: Install dependencies
         run: pnpm install
 
-      - name: Build ${{ matrix.package }}
-        run: pnpm --filter ./packages/${{ matrix.package }} build
+      - name: Build
+        run: pnpm build
 
       - name: Test ${{ matrix.package }}
-        if: matrix.package != 'nameguard-sdk' || needs.check_changes.outputs.sdk_only_changed == 'true'
         run: pnpm --filter ./packages/${{ matrix.package }} test
diff --git a/apps/namehashlabs.org/package.json b/apps/namehashlabs.org/package.json
@@ -39,8 +39,5 @@
     "tailwindcss": "3.4.3",
     "typescript": "5.4.5",
     "vitest": "^1.6.0"
-  },
-  "engines": {
-    "node": "18.x"
   }
 }
diff --git a/internal/seo/tsconfig.json b/internal/seo/tsconfig.json
@@ -1,4 +1,6 @@
 {
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "@namekit/tsconfig/base.json",
   "compilerOptions": {
     "target": "ES2020",
     "module": "commonjs",

diff --git a/internal/tsconfig/base.json b/internal/tsconfig/base.json
@@ -0,0 +1,26 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Base",
+  "compilerOptions": {
+    "target": "es2022",
+    "module": "es2022",
+    "allowJs": true,
+    "moduleDetection": "force",
+    "sourceMap": true,
+    "composite": false,
+    "declaration": true,
+    "declarationMap": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "inlineSources": false,
+    "isolatedModules": true,
+    "moduleResolution": "node",
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "preserveWatchOutput": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "downlevelIteration": true
+  },
+  "exclude": ["node_modules"]
+}
diff --git a/internal/tsconfig/nextjs.json b/internal/tsconfig/nextjs.json
@@ -0,0 +1,22 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "display": "Next.js",
+  "extends": "./base.json",
+  "compilerOptions": {
+    "target": "es5",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "noEmit": true,
+    "incremental": true,
+    "esModuleInterop": true,
+    "module": "esnext",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "preserve"
+  },
+  "include": ["src", "next-env.d.ts"],
+  "exclude": ["node_modules"]
+}
diff --git a/internal/tsconfig/package.json b/internal/tsconfig/package.json
@@ -0,0 +1,10 @@
+{
+  "name": "@namekit/tsconfig",
+  "version": "0.0.0",
+  "private": true,
+  "files": [
+    "base.json",
+    "nextjs.json",
+    "react.json"
+  ]
+}
diff --git a/packages/ens-utils/package.json b/packages/ens-utils/package.json
@@ -42,6 +42,7 @@
     "viem": "2.9.3"
   },
   "devDependencies": {
+    "@namekit/tsconfig": "workspace:*",
     "tsup": "8.0.2",
     "typescript": "5.3.3",
     "vite": "5.1.7",

diff --git a/packages/ens-utils/tsconfig.json b/packages/ens-utils/tsconfig.json
@@ -1,17 +1,8 @@
 {
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "@namekit/tsconfig/base.json",
   "compilerOptions": {
     "target": "ES2020",
-    "lib": ["ES2020", "dom"],
-    "module": "ES2020",
-    "moduleResolution": "node",
-    "strict": true,
-    "sourceMap": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    "resolveJsonModule": true,
-    "outDir": "./dist",
-    "rootDir": "./src",
-  },
-  "exclude": ["node_modules"]
+    "module": "ES2020"
+  }
 }
diff --git a/packages/ens-utils/tsup.config.ts b/packages/ens-utils/tsup.config.ts
@@ -2,11 +2,10 @@ import { defineConfig } from "tsup";
 
 export default defineConfig({
   entry: ["src/index.ts"],
-  splitting: true,
-  sourcemap: false,
+  format: ["esm"],
   clean: true,
   dts: true,
-  treeshake: true,
+  skipNodeModulesBundle: true,
   target: [
     "chrome123",
     "edge122",
@@ -15,7 +14,4 @@ export default defineConfig({
     "safari17",
     "node20",
   ],
-  format: ["esm"],
-  skipNodeModulesBundle: true,
-  external: ["node_modules"],
 });
diff --git a/packages/nameguard-js/package.json b/packages/nameguard-js/package.json
@@ -37,15 +37,16 @@
     "test": "vitest"
   },
   "devDependencies": {
+    "@namekit/tsconfig": "workspace:*",
     "@types/node": "^20.6.2",
     "tsup": "^7.2.0",
     "typescript": "^5.2.2",
     "vitest": "1.4.0"
   },
   "dependencies": {
-    "@namehash/nameguard": "workspace:*",
-    "@namehash/ens-utils": "workspace:*",
     "@adraffy/ens-normalize": "1.10.1",
+    "@namehash/ens-utils": "workspace:*",
+    "@namehash/nameguard": "workspace:*",
     "text-segmentation": "1.0.3",
     "viem": "2.9.3",
     "whatwg-fetch": "3.6.19"

diff --git a/packages/nameguard-js/src/index.js b/packages/nameguard-js/src/index.js
@@ -0,0 +1 @@
+export { createClient } from "./nameguard-js";
diff --git a/packages/nameguard-js/src/index.ts b/packages/nameguard-js/src/index.ts
@@ -1 +1 @@
-export { createClient, NameGuardJSOptions } from "./nameguard-js";
+export { createClient, type NameGuardJSOptions } from "./nameguard-js";
diff --git a/packages/nameguard-js/src/nameguard-js.ts b/packages/nameguard-js/src/nameguard-js.ts
@@ -5,6 +5,7 @@ import {
   SecurePrimaryNameResult,
   NameGuardOptions,
   DEFAULT_COMPUTE_NAMEGUARD_REPORT,
+  Network,
 } from "@namehash/nameguard";
 import { securePrimaryName as securePrimaryNameImpl } from "./securePrimaryName";
 
@@ -24,11 +25,11 @@ class NameGuardJS extends NameGuard {
     const chainId = this.publicClient.chain?.id;
     if (this.network === "mainnet" && chainId !== 1) {
       throw new Error(
-        `Network mismatch: expected mainnet (chain id 1), but got chain id ${chainId}.`
+        `Network mismatch: expected mainnet (chain id 1), but got chain id ${chainId}.`,
       );
     } else if (this.network === "sepolia" && chainId !== 11155111) {
       throw new Error(
-        `Network mismatch: expected sepolia (chain id 11155111), but got chain id ${chainId}.`
+        `Network mismatch: expected sepolia (chain id 11155111), but got chain id ${chainId}.`,
       );
     } else if (this.network !== "mainnet" && this.network !== "sepolia") {
       throw new Error(`Unsupported network: ${this.network}.`);
@@ -37,9 +38,10 @@ class NameGuardJS extends NameGuard {
 
   public override getSecurePrimaryName(
     address: string,
-    options?: SecurePrimaryNameOptions
+    options?: SecurePrimaryNameOptions,
   ): Promise<SecurePrimaryNameResult> {
-    const computeNameGuardReport = options?.computeNameGuardReport || DEFAULT_COMPUTE_NAMEGUARD_REPORT;
+    const computeNameGuardReport =
+      options?.computeNameGuardReport || DEFAULT_COMPUTE_NAMEGUARD_REPORT;
     if (computeNameGuardReport) {
       return super.getSecurePrimaryName(address, options);
     }
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		export { createClient, NameGuardJSOptions } from "./nameguard-js";
		export { createClient, type NameGuardJSOptions } from "./nameguard-js";