chore(types): add type check #374

LiteSun · 2025-10-30T06:14:00Z

Description

Fix type errors across all projects
sdk differ converter-openapi backend-api7 backend-apisix-standalone backend-apisix cli
Add a CI check for type checking

Checklist

I have explained the need for this PR and the problem it solves
I have explained the changes or the new features added to this PR
I have added tests corresponding to this change
I have updated the documentation to reflect this change
I have verified that this change is backward compatible

.github/workflows/lint.yaml

Copilot

Pull Request Overview

This PR performs a major dependency downgrade, changing Vitest from version 3.2.4 to 3.0.0, alongside TypeScript type safety improvements and code quality enhancements across multiple backend implementations (APISIX, API7) and the SDK. The changes include adding explicit type assertions, fixing type compatibility issues, and improving null safety handling throughout the codebase.

Downgraded vitest from 3.2.4 to 3.0.0 with corresponding dependency adjustments
Added type assertions and explicit casting to resolve TypeScript strict mode violations
Refactored schema definitions to better support plugin configuration types

Reviewed Changes

Copilot reviewed 32 out of 34 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
pnpm-lock.yaml	Downgraded vitest and related dependencies from 3.2.4 to 3.0.0, added package dependencies to apps/cli and libs/sdk
libs/sdk/src/core/schema.ts	Changed pluginsSchema from record type to single plugin schema, added UpstreamHealthCheck type export, extended ConfigurationSchema with new optional fields
libs/sdk/src/backend/index.ts	Made httpAgent and httpsAgent optional in BackendOptions
libs/backend-apisix/src/transformer.ts	Added extensive type assertions and null-safety checks throughout transformation methods
libs/backend-apisix/src/typing.ts	Changed GlobalRule and PluginMetadata from record types to direct types
libs/backend-api7/src/transformer.ts	Improved type safety with explicit return types and type assertions
libs/backend-api7/src/index.ts	Added non-null assertions and improved type guards in defaultValue method
apps/cli/src/utils/listr.ts	Replaced logical AND shortcuts with explicit if statements for better readability
apps/cli/package.json	Moved dependencies from devDependencies to dependencies
.github/workflows/lint.yaml	Added new GitHub Actions workflow for lint checking

Files not reviewed (1)

pnpm-lock.yaml: Language not supported

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

libs/sdk/src/core/schema.ts

pnpm-lock.yaml

libs/backend-apisix/src/transformer.ts

libs/backend-apisix/src/fetcher.ts

apps/cli/src/command/helper.ts

libs/backend-api7/src/index.ts

libs/backend-apisix/src/transformer.ts

apps/cli/package.json

LiteSun · 2025-11-06T01:48:51Z

.github/workflows/typecheck.yaml

+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 'lts/*'
+      - uses: pnpm/action-setup@v4
+      - name: Install dependencies
+        run: pnpm install
+
+      - name: Run TypeScript Type Check
+        run: npx nx run-many --target=typecheck --all --skip-nx-cache


To fix the problem, explicitly set the minimum required permissions by adding a permissions: block at the workflow or job level. Since no step appears to require token-based write access, the least privilege is contents: read. Place permissions: at the top level, just after the workflow name: and before on:, so it applies to all jobs unless overridden. No other code changes, imports, or definitions are needed.

@LiteSun Please flow this guide.

…in permissions Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>

bzp2010 · 2025-11-05T09:17:35Z

tsconfig.json

+  "compilerOptions": {
+    "lib": ["esnext"],
+  },


Please revert this change: https://nx.dev/docs/concepts/typescript-project-linking#set-up-typescript-project-references

bzp2010 · 2025-11-05T09:39:06Z

package.json

    "url-loader": "^4.1.1",
    "vite": "7.1.9",
-    "vitest": "^3.0.0",
+    "vitest": "3.0.0",


Always use the latest version of 3.x. Keep ^3.0.0.

bzp2010 · 2025-11-05T09:51:21Z

libs/sdk/src/core/schema.ts

+  routes: z.array(routeSchema).optional(),
+  stream_routes: z.array(streamRouteSchema).optional(),
+  consumer_credentials: z.array(consumerCredentialSchema).optional(),
+  upstreams: z.array(upstreamSchema({ id: idSchema.optional() })).optional(),


These elements do not exist in the ADC schema and users are not permitted to configure these fields here. Do not modify the core schema.
If your type system requires these fields, create another type alias.

const AnotherConfiguration = z.infer<typeof ConfigurationSchema> & {xx: xx, yy: yy};

bzp2010 · 2025-11-05T09:53:00Z

libs/sdk/src/backend/index.ts

+  cacheKey?: string;
+  httpAgent?: httpAgent;
+  httpsAgent?: httpsAgent;


They are mandatory. Every backend must provide them, and any E2E tests containing errors need to be fixed individually.

bzp2010 · 2025-11-05T10:01:42Z

libs/backend-apisix/tsconfig.lib.json

+    "e2e/**/*.ts"
  ]
-}
+}


PLEASE KEEP EOL

bzp2010 · 2025-11-06T04:27:13Z

libs/backend-apisix/src/fetcher.ts


  private listGlobalRules() {
-    return this._list<typing.ListResponse<typing.GlobalRule>>(
+    return this._list<typing.ListResponse<Record<string, typing.GlobalRule>>>(


bzp2010 · 2025-11-06T04:29:43Z

libs/backend-apisix/src/fetcher.ts

        Object.fromEntries<ADCSDK.Plugin>(
          list.map((item) => [
-            item.key.split('/').pop(),
+            item.key.split('/').pop() ?? item.key,


I'm concerned this might be incorrect, so it's best not to modify it.

The Admin API has some default rules, such as keys containing / being returned here.

bzp2010 · 2025-11-06T04:38:21Z

libs/backend-apisix/src/transformer.ts

          }
        : undefined,
-      ssl_protocols: ssl.ssl_protocols,
+      ssl_protocols: ssl.ssl_protocols as ('TLSv1.1' | 'TLSv1.2' | 'TLSv1.3')[],


I recommend modifying the original type definition.

bzp2010 · 2025-11-06T04:47:39Z

libs/backend-apisix/src/transformer.ts

          ADC_NAME: consumerGroup.name,
        },
-        name: undefined,
-        consumers: undefined,


This is to allow recursiveOmitUndefined to remove them; please leave it as is.

First, the id, name, consumers expanded from consumerGroup will be overwritten with undefined, then subsequently removed by recursiveOmitUndefined—that's how they function.
Additionally, this modification is useless, as ADC does not support Consumer Group; thus, they are now essentially placeholders.

bzp2010 · 2025-11-06T04:48:32Z

tsconfig.base.json

      "esnext"
-    ]
+    ],
+    "skipLibCheck": true


Is this necessary?

LiteSun added 12 commits October 30, 2025 10:28

fix(apps): lint

72229df

f

c3fa05e

fix api7 typing

9011884

fix apisix backend typing

7f2a4bb

Merge branch 'main' into sy/fix-lint

d580bf1

f

48d9e99

f

41c1806

f

c31dfb9

f

df7e18e

f

31550d9

f

a6ea794

f

93ab8b2

github-advanced-security bot found potential problems Nov 4, 2025

View reviewed changes

.github/workflows/lint.yaml Fixed Show fixed Hide fixed

f

f8d7361

LiteSun requested a review from Copilot November 4, 2025 07:16

Copilot AI reviewed Nov 4, 2025

View reviewed changes

LiteSun added 7 commits November 4, 2025 16:05

f

87e3d4d

update

e118d92

f

8157da4

f

c012364

f

9c7b359

f

6a58edd

f

eb6f7ca

github-advanced-security bot found potential problems Nov 4, 2025

View reviewed changes

LiteSun and others added 4 commits November 4, 2025 18:49

f

7456b98

Potential fix for code scanning alert no. 21: Workflow does not conta…

674d6b6

…in permissions Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>

f

5b32cdf

f

efc79ec

LiteSun changed the title ~~fix(apps): lint~~ chore(types): add type check Nov 4, 2025

LiteSun marked this pull request as ready for review November 5, 2025 00:29

LiteSun requested a review from bzp2010 as a code owner November 5, 2025 00:29

LiteSun added test/api7 Trigger the API7 test on the PR test/apisix-standalone Trigger the APISIX standalone test on the PR labels Nov 5, 2025

LiteSun marked this pull request as draft November 5, 2025 01:35

f

43770bd

LiteSun marked this pull request as ready for review November 5, 2025 03:35

bzp2010 reviewed Nov 6, 2025

View reviewed changes

LiteSun added 3 commits November 6, 2025 15:48

f

84708ed

f

14fd5a5

f

508c80e

@@ -1,4 +1,6 @@
             name: Typecheck
+            permissions:
+              contents: read
             on:
               push:
                 branches:

chore(types): add type check #374

Are you sure you want to change the base?

chore(types): add type check #374

Uh oh!

Conversation

LiteSun commented Oct 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Check warning

Copilot Autofix

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

LiteSun commented Oct 30, 2025 •

edited

Loading