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

feat: replace buildStream w/ buildObjectStreamResponse + use generator #3

Merged
merged 1 commit into from
Jul 17, 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
17 changes: 17 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
module.exports = {
extends: ['@adamhamlin/eslint-config'],
overrides: [
{
files: ['**/__tests__/**'],
plugins: ['jest'],
extends: ['plugin:jest/all'],
rules: {
'jest/prefer-expect-assertions': 'off',
'jest/prefer-lowercase-title': 'off',
'jest/max-expects': ['error', { max: 8 }],
'jest/no-hooks': 'off',
'jest/unbound-method': ['error', { ignoreStatic: true }],
'@typescript-eslint/unbound-method': 'off', // disable in favor of jest/unbound-method
'@typescript-eslint/explicit-function-return-type': 'off',
'@typescript-eslint/no-empty-function': 'off',
},
},
],
};
7 changes: 4 additions & 3 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,12 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout/install
# NOTE: compilation is done as part of the "prepare" script, which is run during npm ci
- name: Checkout/install/compile
uses: adamhamlin/checkout-node-project@v1

- name: Lint
run: npm run check

- name: Compile
run: npm run compile
- name: Tests
run: npm test
51 changes: 38 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![npm version](https://badge.fury.io/js/super-simple-fastify-server.svg)](https://badge.fury.io/js/super-simple-fastify-server)
[![CI Status Badge](https://github.com/adamhamlin/super-simple-fastify-server/actions/workflows/ci.yaml/badge.svg)](https://github.com/adamhamlin/super-simple-fastify-server/actions/workflows/ci.yaml)

Super-simple Fastify web server! Quickly spin up a server for dev/test without all the bloat and boilerplate:
Super-simple Fastify web server! Quickly spin up a server for dev/test without all the bloat and boilerplate.

## Install

Expand Down Expand Up @@ -64,24 +64,49 @@ See the [Docker README](./readme/DOCKER.md) for more info.

### Returning response streams

You may want to test a client that consumes a large quantity of data from a response stream. Here is an example using the built-in `buildStream` utility:
You may want to test a client that consumes a large quantity of data from a JSON response stream. Here is a very simple example using the built-in `buildObjectStreamResponse` utility:

<!-- prettier-ignore -->
```ts
import { FastifyInstance, SimpleFastifyServer, buildStream, sleep } from 'super-simple-fastify-server';
import { FastifyInstance, SimpleFastifyServer, buildObjectStreamResponse, sleep } from 'super-simple-fastify-server';

const server = new SimpleFastifyServer(async (app: FastifyInstance) => {
app.get('/hello-world/stream', async function (_request, reply) {
const myStream = buildStream(async (stream) => {
await sleep(1000);
stream.write(JSON.stringify({ first: 'Hello' }));
await sleep(500);
stream.write(JSON.stringify({ second: ', ' }));
await sleep(500);
stream.write(JSON.stringify({ third: 'World!' }));
});

async function* myGeneratorFn() {
await sleep(2000);
yield *[
{ message: 'Hello' },
{ message: ', ' },
{ message: 'World!' }
];
}
const stream = buildObjectStreamResponse(myGeneratorFn());
reply.header('Content-Type', 'application/octet-stream');
return myStream;
return stream;
});
});
```

And, an example client (using [Axios](https://github.com/axios/axios)) to process the response:

<!-- prettier-ignore -->
```ts
import stream from 'stream';
import { chain } from 'stream-chain';
import { withParser } from 'stream-json/streamers/StreamValues';

const response = await myAxiosClient.get('/hello-world/stream', { responseType: 'stream' });
const rawStream: stream.Readable = response.data;

const streamChain = chain([
rawStream,
withParser(),
(parsed) => parsed.value
]);

let fullMessage = '';
for await (const obj of streamChain) {
fullMessage += obj.message;
}
console.log(fullMessage); // Hello, World!
```
2 changes: 1 addition & 1 deletion index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
export { SimpleFastifyServer } from './src/server/server';
export { FastifyInstance } from 'fastify';
export { buildStream, sleep } from './src/utils/utils';
export { buildObjectStreamResponse, sleep } from './src/utils/utils';
192 changes: 192 additions & 0 deletions jest.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,192 @@
import type { Config } from '@jest/types';

/**
* For a detailed explanation regarding each configuration property and type check, visit:
* https://jestjs.io/docs/configuration
*/
export default async (): Promise<Config.InitialOptions> => ({
// All imported modules in your tests should be mocked automatically
// automock: false,

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

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

// An array of glob patterns indicating a set of files for which coverage information should be collected
collectCoverageFrom: ['<rootDir>/src/**'],

// The directory where Jest should output its coverage files (relative to rootDir)
coverageDirectory: '<rootDir>/coverage',

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

// Indicates which provider should be used to instrument code for coverage
// coverageProvider: 'v8',

// 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: {
global: {
lines: 100,
functions: 100,
branches: 100,
statements: 100,
},
},

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

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

// 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: undefined,

// 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",
// "jsx",
// "ts",
// "tsx",
// "json",
// "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: {},

// 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 before 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 and implementation before every test
// restoreMocks: false,

// The root directory that Jest should scan for tests and modules within (relative to current directory)
rootDir: './',

// A list of paths to directories that Jest should use to search for files in (relative to rootDir)
roots: ['<rootDir>/src'],

// 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: [],

// A list of paths to modules that run some code to configure or set up the testing framework before each test
// setupFilesAfterEnv: [],

// The number of seconds after which a test is considered as slow and reported as such in the results.
slowTestThreshold: 3,

// 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: 'node',

// 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: ['**/__tests__/**/*.(spec|test).ts'],

// 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: "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",

// Default timeout of a test in milliseconds
testTimeout: 5_000,

// A map from regular expressions to paths to transformers
// transform: undefined,

// An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
// transformIgnorePatterns: [
// "/node_modules/",
// "\\.pnp\\.[^\\/]+$"
// ],

// 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,
});
Loading