Skip to content
Open
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
186 changes: 186 additions & 0 deletions packages/client-hooks/jest.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,186 @@
// For a detailed explanation regarding each configuration property, visit:
// https://jestjs.io/docs/en/configuration.html

export default {
displayName: "client-hooks",
// All imported modules in your tests should be mocked automatically
// automock: false,

// Stop running tests after `n` failures
// bail: 0,

// The directory where Jest should store its cached dependency information
// cacheDirectory: process.env.LAYERCI ? "/tmp/jest-cache" : undefined,

// Automatically clear mock calls and instances between every test
clearMocks: true,

// Indicates whether the coverage information should be collected while executing the test
// collectCoverage: false,

// An array of glob patterns indicating a set of files for which coverage information should be collected
// collectCoverageFrom: undefined,

// The directory where Jest should output its coverage files
// coverageDirectory: undefined,

// An array of regexp pattern strings used to skip coverage collection
// coveragePathIgnorePatterns: [
// "/node_modules/"
// ],

// A list of reporter names that Jest uses when writing coverage reports
// coverageReporters: [
// "json",
// "text",
// "lcov",
// "clover"
// ],

// An object that configures minimum threshold enforcement for coverage results
// coverageThreshold: undefined,

// A path to a custom dependency extractor
// dependencyExtractor: undefined,

// Make calling deprecated APIs throw helpful error messages
// errorOnDeprecated: false,

extensionsToTreatAsEsm: [".ts", ".tsx"],

// Force coverage collection from ignored files using an array of glob patterns
// forceCoverageMatch: [],

// A path to a module which exports an async function that is triggered once before all test suites
// globalSetup: "<rootDir>/../api/spec/jest.globalsetup.ts",

// A path to a module which exports an async function that is triggered once after all test suites
// globalTeardown: undefined,

// A set of global variables that need to be available in all test environments
// globals: {},

// The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
// maxWorkers: "50%",

// An array of directory names to be searched recursively up from the requiring module's location
// moduleDirectories: [
// "node_modules"
// ],

// An array of file extensions your modules use
// moduleFileExtensions: [
// "js",
// "json",
// "jsx",
// "ts",
// "tsx",
// "node"
// ],

// A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
moduleNameMapper: {
"^(\\.{1,2}/.*)\\.js$": "$1",
},

// An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
// modulePathIgnorePatterns: [],

// Activates notifications for test results
// notify: false,

// An enum that specifies notification mode. Requires { notify: true }
// notifyMode: "failure-change",

// A preset that is used as a base for Jest's configuration
// preset: "ts-jest",

// Run tests from one or more projects
// projects: undefined,

// Use this configuration option to add custom reporters to Jest
// reporters: undefined,

// Automatically reset mock state between every test
// resetMocks: false,

// Reset the module registry before running each individual test
// resetModules: false,

// A path to a custom resolver
// resolver: undefined,

// Automatically restore mock state between every test
restoreMocks: true,

// The root directory that Jest should scan for tests and modules within
// rootDir: undefined,

// A list of paths to directories that Jest should use to search for files in
roots: ["<rootDir>"],

// Allows you to use a custom runner instead of Jest's default test runner
// runner: "jest-runner",

// The paths to modules that run some code to configure or set up the testing environment before each test
// setupFiles: ["./spec/setup.ts"],

// A list of paths to modules that run some code to configure or set up the testing framework before each test
// setupFilesAfterEnv: ["<rootDir>/spec/jest.setup.ts"],

// A list of paths to snapshot serializer modules Jest should use for snapshot testing
// snapshotSerializers: [],

// The test environment that will be used for testing
testEnvironment: "setup-polly-jest/jest-environment-jsdom",

// Options that will be passed to the testEnvironment
// testEnvironmentOptions: {},

// Adds a location field to test results
// testLocationInResults: false,

// The glob patterns Jest uses to detect test files
// testMatch: [path.join(__dirname, "spec/(*.)+(spec|test).[tj]s?(x)")],

// An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
testPathIgnorePatterns: ["/node_modules/"],

// The regexp pattern or array of patterns that Jest uses to detect test files
// testRegex: [],

// This option allows the use of a custom results processor
// testResultsProcessor: undefined,

// This option allows use of a custom test runner
// testRunner: "jasmine2",
testRunner: "jest-circus/runner",

// This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
// testURL: "http://localhost",

// Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
// timers: "real",

// A map from regular expressions to paths to transformers
// transform: undefined,
transform: { "^.+\\.(t|j)sx?$": ["@swc/jest"] },

// An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
// transformIgnorePatterns: [
// "/node_modules/"
// ],
// transformIgnorePatterns: ["/node_modules/(?!lodash)"],

// An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
// unmockedModulePathPatterns: undefined,

// Indicates whether each individual test should be reported during the run
// verbose: undefined,

// An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
// watchPathIgnorePatterns: [],

// Whether to use watchman for file crawling
// watchman: true,
};
45 changes: 45 additions & 0 deletions packages/client-hooks/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
{
"name": "@gadgetinc/client-hooks",
"version": "0.1.0",
"files": [
"README.md",
"dist/**/*"
],
"license": "MIT",
"repository": "github:gadget-inc/js-clients",
"homepage": "https://github.com/gadget-inc/js-clients/tree/main/packages/client-hooks",
"type": "module",
"exports": {
"./package.json": "./package.json",
".": {
"import": "./dist/esm/index.js",
"require": "./dist/cjs/index.js",
"default": "./dist/esm/index.js"
}
},
"source": "src/index.ts",
"main": "dist/cjs/index.js",
"sideEffects": false,
"scripts": {
"test": "NODE_OPTIONS=--experimental-vm-modules jest",
"test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch",
"typecheck:main": "tsc --noEmit",
"typecheck": "tsc --noEmit",
"clean": "rimraf dist/ *.tsbuildinfo **/*.tsbuildinfo",
"prebuild": "mkdir -p dist/cjs dist/esm && echo '{\"type\": \"commonjs\"}' > dist/cjs/package.json && echo '{\"type\": \"module\"}' > dist/esm/package.json",
"build": "pnpm clean && pnpm prebuild && tsc -b tsconfig.cjs.json tsconfig.esm.json",
"prepublishOnly": "pnpm build",
"prerelease": "gitpkg publish"
},
"peerDependencies": {
"@gadgetinc/core": ">=0.2.0"
},
"devDependencies": {
"@gadgetinc/core": "workspace:*",
"@urql/core": "*",
"@jest/globals": "*",
"@swc/jest": "*",
"@types/jest": "*",
"jest": "*"
}
}
61 changes: 61 additions & 0 deletions packages/client-hooks/spec/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# Client Hooks Test Suite

This directory contains tests for the `@gadgetinc/client-hooks` package. These tests are designed to be framework-agnostic and test the core logic of each hook without depending on specific framework implementations or concrete API clients.

## Test Architecture

### Mock Adapter (`mockAdapter.ts`)

The tests use a **mock adapter** that implements the `RuntimeAdapter` interface. This adapter simulates the behavior of framework-specific adapters (like React or Preact) without actually depending on those frameworks.

Key components:

- **Framework bindings**: Mock implementations of `useState`, `useEffect`, `useMemo`, etc.
- **URQL bindings**: Mock implementations of `useQuery` and `useMutation`
- **Context**: Mock Gadget API context for providing the client and connection

### Test Approach

Each hook test file follows a similar pattern:

1. **Setup**: Create a mock adapter, API client, and connection
2. **Initialize hooks**: Call `createHooks(adapter)` to initialize the hook system
3. **Test hook behavior**: Call the hook and verify it:
- Returns the expected state shape
- Calls the appropriate connection methods with correct parameters
- Uses adapter hooks correctly (useMemo, useCallback, etc.)
- Handles options and edge cases properly

### What These Tests DO Cover

- ✅ Hook initialization and state shape
- ✅ Correct parameters passed to connection operations
- ✅ Proper use of adapter framework hooks
- ✅ Options handling (pause, suspense, select, etc.)
- ✅ Namespace support
- ✅ Edge cases (stubbed actions, null data, etc.)

### What These Tests DON'T Cover

- ❌ Actual network requests and responses
- ❌ Framework-specific behavior (React rendering, Preact lifecycle, etc.)
- ❌ Real URQL client behavior
- ❌ Integration with concrete Gadget API clients

These integration tests will live in the framework-specific packages:

- `@gadgetinc/react` - Full integration tests with React, real URQL, and mocked network responses
- `@gadgetinc/preact` - Full integration tests with Preact

## Running Tests

```bash
# From the package root
pnpm test

# Watch mode
pnpm test --watch

# With coverage
pnpm test --coverage
```
Loading
Loading