Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate to Node16 resolution #186

Merged
merged 21 commits into from
Mar 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions cspell.config.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
"corepack",
"printables",
"arethetypeswrong",
"oneof",
"typesafe"
],
"ignorePaths": ["**/*.svg", "**/*.ai", "**/pnpm-lock.yaml", "*.excalidraw"]
Expand Down
2 changes: 1 addition & 1 deletion jest-preset.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ module.exports = {
},
workerThreads: true, // Enabled so jest would stop complaining about serializing BigInt. See https://github.com/jestjs/jest/issues/11617#issuecomment-1458155552 for details
transform: {
"^.+\\.(ts|tsx)$": [
"^.+\\.(ts|tsx|js)$": [
"ts-jest",
{
isolatedModules: false,
Expand Down
4 changes: 2 additions & 2 deletions packages/connect-query/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
"scripts": {
"clean": "rm -rf ./dist/*",
"build": "npm run build:cjs && npm run build:esm",
"build:cjs": "tsc --project tsconfig.build.json --module commonjs --outDir ./dist/cjs --declaration --declarationDir ./dist/cjs && echo >./dist/cjs/package.json '{\"type\":\"commonjs\"}'",
"build:esm": "tsc --project tsconfig.build.json --module ES2015 --verbatimModuleSyntax --outDir ./dist/esm --declaration --declarationDir ./dist/esm",
"build:cjs": "tsc --project tsconfig.build.json --module commonjs --moduleResolution node10 --verbatimModuleSyntax false --outDir ./dist/cjs --declarationDir ./dist/cjs && echo >./dist/cjs/package.json '{\"type\":\"commonjs\"}'",
"build:esm": "tsc --project tsconfig.build.json",
"generate": "buf generate --path eliza.proto",
"test": "jest",
"format": "prettier . --write --ignore-path ./.eslintignore && eslint . --fix && license-header",
Expand Down
14 changes: 7 additions & 7 deletions packages/connect-query/src/call-unary-method.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ import type { QueryFunctionContext } from "@tanstack/react-query";
import { useQueries } from "@tanstack/react-query";
import { renderHook, waitFor } from "@testing-library/react";

import { callUnaryMethod } from "./call-unary-method";
import type { ConnectQueryKey } from "./connect-query-key";
import { createConnectQueryKey } from "./connect-query-key";
import { defaultOptions } from "./default-options";
import { ElizaService } from "./gen/eliza_connect";
import type { SayRequest } from "./gen/eliza_pb";
import { mockEliza, wrapper } from "./jest/test-utils";
import { callUnaryMethod } from "./call-unary-method.js";
import type { ConnectQueryKey } from "./connect-query-key.js";
import { createConnectQueryKey } from "./connect-query-key.js";
import { defaultOptions } from "./default-options.js";
import { ElizaService } from "./gen/eliza_connect.js";
import type { SayRequest } from "./gen/eliza_pb.js";
import { mockEliza, wrapper } from "./jest/test-utils.js";

const sayMethodDescriptor = {
...ElizaService.methods.say,
Expand Down
6 changes: 3 additions & 3 deletions packages/connect-query/src/connect-query-key.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@

import { describe, expect, it } from "@jest/globals";

import { createConnectQueryKey } from "./connect-query-key";
import { SayRequest } from "./gen/eliza_pb";
import { disableQuery } from "./utils";
import { createConnectQueryKey } from "./connect-query-key.js";
import { SayRequest } from "./gen/eliza_pb.js";
import { disableQuery } from "./utils.js";

describe("makeQueryKey", () => {
const methodDescriptor = {
Expand Down
2 changes: 1 addition & 1 deletion packages/connect-query/src/default-options.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

import { describe, expect, it } from "@jest/globals";

import { defaultOptions } from "./default-options";
import { defaultOptions } from "./default-options.js";

describe("defaultOptions", () => {
const {
Expand Down
3 changes: 2 additions & 1 deletion packages/connect-query/src/default-options.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import stableHash from "stable-hash";
*/
export const defaultOptions = {
queries: {
queryKeyHashFn: stableHash,
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- stableHash is a function but doesn't seem to satisfy the type. Likely a node16 compat problem.
queryKeyHashFn: stableHash as any as (object: any) => string,
},
} satisfies DefaultOptions;
12 changes: 8 additions & 4 deletions packages/connect-query/src/jest/test-utils.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,14 @@ import {
BigIntService,
ElizaService,
PaginatedService,
} from "../gen/eliza_connect";
import type { CountRequest, ListResponse, SayRequest } from "../gen/eliza_pb";
import { CountResponse, SayResponse } from "../gen/eliza_pb";
import { TransportProvider } from "../use-transport";
} from "../gen/eliza_connect.js";
import type {
CountRequest,
ListResponse,
SayRequest,
} from "../gen/eliza_pb.js";
import { CountResponse, SayResponse } from "../gen/eliza_pb.js";
import { TransportProvider } from "../use-transport.js";

/**
* A utils wrapper that supplies Tanstack Query's `QueryClientProvider` as well as Connect-Query's `TransportProvider`.
Expand Down
14 changes: 7 additions & 7 deletions packages/connect-query/src/use-infinite-query.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,16 @@ import { renderHook, waitFor } from "@testing-library/react";
import {
createConnectInfiniteQueryKey,
createConnectQueryKey,
} from "./connect-query-key";
import { defaultOptions } from "./default-options";
import { PaginatedService } from "./gen/eliza_connect";
import { mockPaginatedTransport, wrapper } from "./jest/test-utils";
} from "./connect-query-key.js";
import { defaultOptions } from "./default-options.js";
import { PaginatedService } from "./gen/eliza_connect.js";
import { mockPaginatedTransport, wrapper } from "./jest/test-utils.js";
import {
useInfiniteQuery,
useSuspenseInfiniteQuery,
} from "./use-infinite-query";
import { useQuery } from "./use-query";
import { disableQuery } from "./utils";
} from "./use-infinite-query.js";
import { useQuery } from "./use-query.js";
import { disableQuery } from "./utils.js";

// TODO: maybe create a helper to take a service and method and generate this.
const methodDescriptor = {
Expand Down
8 changes: 4 additions & 4 deletions packages/connect-query/src/use-mutation.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@
import { describe, expect, it, jest } from "@jest/globals";
import { renderHook, waitFor } from "@testing-library/react";

import { defaultOptions } from "./default-options";
import { BigIntService, PaginatedService } from "./gen/eliza_connect";
import { defaultOptions } from "./default-options.js";
import { BigIntService, PaginatedService } from "./gen/eliza_connect.js";
import {
mockPaginatedTransport,
mockStatefulBigIntTransport,
wrapper,
} from "./jest/test-utils";
import { useMutation } from "./use-mutation";
} from "./jest/test-utils.js";
import { useMutation } from "./use-mutation.js";

// TODO: maybe create a helper to take a service and method and generate this.
const methodDescriptor = {
Expand Down
8 changes: 4 additions & 4 deletions packages/connect-query/src/use-query.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@
import { describe, expect, it } from "@jest/globals";
import { renderHook, waitFor } from "@testing-library/react";

import { ElizaService } from "./gen/eliza_connect";
import { mockEliza, wrapper } from "./jest/test-utils";
import { useQuery, useSuspenseQuery } from "./use-query";
import { disableQuery } from "./utils";
import { ElizaService } from "./gen/eliza_connect.js";
import { mockEliza, wrapper } from "./jest/test-utils.js";
import { useQuery, useSuspenseQuery } from "./use-query.js";
import { disableQuery } from "./utils.js";

// TODO: maybe create a helper to take a service and method and generate this.
const sayMethodDescriptor = {
Expand Down
8 changes: 4 additions & 4 deletions packages/connect-query/src/use-transport.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ import { ConnectError } from "@connectrpc/connect";
import { describe, expect, it } from "@jest/globals";
import { renderHook, waitFor } from "@testing-library/react";

import { ElizaService } from "./gen/eliza_connect";
import { mockBigInt, wrapper } from "./jest/test-utils";
import { useQuery } from "./use-query";
import { TransportProvider, useTransport } from "./use-transport";
import { ElizaService } from "./gen/eliza_connect.js";
import { mockBigInt, wrapper } from "./jest/test-utils.js";
import { useQuery } from "./use-query.js";
import { TransportProvider, useTransport } from "./use-transport.js";

const sayMethodDescriptor = {
...ElizaService.methods.say,
Expand Down
12 changes: 8 additions & 4 deletions packages/connect-query/src/utils.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,14 @@
import type { PartialMessage } from "@bufbuild/protobuf";
import { describe, expect, it, jest } from "@jest/globals";

import { BigIntService } from "./gen/eliza_connect";
import type { CountResponse } from "./gen/eliza_pb";
import type { Equal, Expect } from "./jest/test-utils";
import { assert, createProtobufSafeUpdater, isAbortController } from "./utils";
import { BigIntService } from "./gen/eliza_connect.js";
import type { CountResponse } from "./gen/eliza_pb.js";
import type { Equal, Expect } from "./jest/test-utils.js";
import {
assert,
createProtobufSafeUpdater,
isAbortController,
} from "./utils.js";

describe("assert", () => {
const message = "assertion message";
Expand Down
5 changes: 4 additions & 1 deletion packages/connect-query/tsconfig.build.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
{
"extends": "../../tsconfig.base.json",
"compilerOptions": {
"skipLibCheck": true
"skipLibCheck": true,
"declaration": true,
"declarationDir": "./dist/esm",
"outDir": "./dist/esm"
},
"include": ["src/**/*.ts", "src/**/*.tsx"],
"exclude": ["**/*.test.ts", "**/*.test.tsx", "src/jest/**"]
Expand Down
4 changes: 3 additions & 1 deletion packages/connect-query/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@
"compilerOptions": {
"rootDir": ".",
"noUnusedLocals": false, // necessary for TypeScript type tests, but since this is not enabled for build, unused variables have no risk of leaking into the build output
"lib": ["DOM", "ESNext"]
"lib": ["DOM", "ESNext"],
"noEmit": true,
"verbatimModuleSyntax": false
},
"exclude": ["coverage", "dist"],
"include": ["src", "./*.config.ts"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@
import { createEcmaScriptPlugin } from "@bufbuild/protoplugin";

import { version } from "../package.json";
import { generateDts } from "./generateDts";
import { generateTs } from "./generateTs";
import { generateDts } from "./generateDts.js";
import { generateTs } from "./generateTs.js";

export const protocGenConnectQuery = createEcmaScriptPlugin({
name: "protoc-gen-connect-query",
Expand Down
6 changes: 4 additions & 2 deletions packages/protoc-gen-connect-query/tsconfig.build.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@
"files": ["src/protoc-gen-connect-query-plugin.ts"],
"extends": "../../tsconfig.base.json",
"compilerOptions": {
"moduleResolution": "Node16",
"module": "Node16",
"outDir": "dist/cjs",
"module": "CommonJS",
"resolveJsonModule": true
"resolveJsonModule": true,
"verbatimModuleSyntax": false
}
}
7 changes: 5 additions & 2 deletions tsconfig.base.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"compilerOptions": {
"allowJs": true,
"target": "ESNext",
"esModuleInterop": true,
"forceConsistentCasingInFileNames": true,
Expand All @@ -13,8 +14,10 @@
"noFallthroughCasesInSwitch": true,
"noImplicitOverride": true,

// We need node's module resolution, so we do not have to skip lib checks
"moduleResolution": "Node",
"verbatimModuleSyntax": true,
"moduleResolution": "Node16",
paul-sachs marked this conversation as resolved.
Show resolved Hide resolved
"module": "Node16",

"skipLibCheck": false,
"declaration": true,
"declarationMap": true,
Expand Down
Loading