DRAFT: "AutoRouter" to reduce router initialization boilerplate #195

kwhitley · 2023-11-25T18:40:20Z

Description

Adds flow(router: Router, options?: FlowOptions): Response to reduce boilerplate. This function makes the following assumptions (with override controls):

Default response formatter as json
Includes default 404 handler on missed route
Includes default 500 error handler on uncaught errors

// BEFORE/WITHOUT FLOW
import { Router, json, error } from 'itty-router'

const router = Router()

router
  .get('/my-items', () => [1, 2, 3])
  .get('*', () => error(404))

export default {
  fetch: (...args) => router
                        .handle(...args)
                        .then(json)
                        .catch(error)
}

// AFTER/WITH FLOW
import { Router, flow } from 'itty-router'

const router = Router()

router.get('/my-items', () => [1, 2, 3])

export default {
  fetch: flow(router)
}

// or even

export default flow(router)

// WITH FLOW, OVERRIDES (including CORS)
import { Router, flow, error } from 'itty-router'

const router = Router()

router.get('/my-items', () => [1, 2, 3])

export default {
  fetch: flow(router, {
    cors: true,
    notFound: (req) => error(404, `The path "${req.url}" was not found.`),
  })
}

API (options)

Option Name	Default	Valid Choices
cors	`false`	`false` (off/ignore), `true` (default `createCors()`), `CorsOptions`
format	`json`	`false` (off/ignore), `Function<Response>`
errors	`error`	`false` (off/ignore), `Function<Response>`
notFound	`() => error(404)`	`false` (off/ignore), `Function<Response>`

Type of Change (select one and follow subtasks)

…equest used, but Args changed

* Add the required `extends` calls to fix the ts-expect-error * Get rid of the other typescript ignores * Replace one last expect-error with an `as` In this case the 'as' is asserting "I know better than the compiler" and it is both true and more accurate than saying "I expect typescript to error out here." As an added benefit, `as` does more type checking than 'expect error', so you get just a small bit more type safety.

Crisfole

@kwhitley this is mostly an improvement, but you're missing more generics. That's what causes some 95% of your ts-ignore-error and any usages.

Pretty much every any you have can be replaced 1:1 with a generic type parameter for significantly better type signatures.

Crisfole · 2023-12-16T19:10:12Z

src/Router.ts

-export type RouteHandler<I = IRequest, A extends any[] = any[]> = {
-  (request: I, ...args: A): any
+export type RouteHandler<R = IRequest, Args = any[]> = {
+  // @ts-expect-error - TS never likes this syntax


Doesn’t like the syntax because you need [] array type for spread args.

You’d need an extends Array in your type handler here, I think

Crisfole · 2023-12-18T14:49:42Z

src/createCors.ts

-export interface CorsFns {
-  corsify(req: Request): Response;
-  preflight(r: IRequest): Response;
+export interface CorsHandlers {


MUCH better name. Thanks for the fix.

Crisfole · 2023-12-18T14:50:48Z

src/createCors.ts

-  preflight(r: IRequest): Response;
+export interface CorsHandlers {
+  corsify(response: Response): any
+  preflight(Request: IRequest): any


Never use a direct IRequest anywhere but as a default for a generic type. It'd be best if you setup a linter for this, tbh. It's the source of 99% of your type bugs.

Crisfole · 2023-12-18T14:51:20Z

src/createCors.ts

@@ -38,20 +38,20 @@ export const createCors = (options: CorsOptions = {}): CorsFns => {
  if (maxAge) rHeaders['Access-Control-Max-Age'] = maxAge

  // Pre-flight function.
-  const preflight = (r: IRequest) => {
+  const preflight = (request: IRequest): any => {


createCors needs to be generic to get the types to behave.

Crisfole · 2023-12-18T14:52:12Z

src/flow.ts

@@ -20,7 +20,7 @@ export type FlowOptions = {
  after?: afterFunction
 }

-export type Flowed = (request: RequestLike, ...extra: any[]) => Promise<any>
+export type Flowed = (request: IRequest, ...extra: any[]) => Promise<any>


This has to be generic to get the handler types working nicely.

Crisfole · 2023-12-18T14:52:45Z

src/flow.ts

@@ -20,7 +20,7 @@ export type FlowOptions = {
  after?: afterFunction
 }

-export type Flowed = (request: RequestLike, ...extra: any[]) => Promise<any>
+export type Flowed = (request: IRequest, ...extra: any[]) => Promise<any>
 export type FlowedAndFetch = Flowed & { fetch: Flowed }


This is a real weird type. It's a fetch function that owns a ... fetch function?

kwhitley · 2023-12-21T15:50:20Z

Adding to the discussion here... flow has been shelved for an arguably better router approach. Notes to follow.

kwhitley · 2024-03-15T06:33:34Z

Killed in favor of #222

kwhitley added 12 commits August 15, 2023 14:26

testing flow

5f495a9

released v4.1.0-next.0 - initial flow release

70f5901

released v4.1.0-next.1 - flow should be exported from index

69d1e19

added flow examples

496679f

released v4.1.0-next.2 - updated package.json

a5e9789

released v4.1.0-next.3 - changing API of flow

d6727b6

released v4.1.0-next.4 - code golf optimization in flow

902e668

flow work

668f402

flow working with tests - TODO: finalize API

87e708d

fixed merge conflicts

aead16c

ts-error should have description

ab1364f

fixing lint errors

acd93ae

kwhitley added new feature New feature or request in progress I'm working on it... allegedly... PENDING RELEASE Final stages before release! :D Feedback Requested API Changes, interface questions, etc... labels Nov 25, 2023

kwhitley added 14 commits November 25, 2023 13:28

Merge remote-tracking branch 'origin/v4.x' into flow

16e31e4

update to CHANGELOG

b210c31

Merge remote-tracking branch 'origin/v4.x' into flow

497da62

deps update

b3fab6f

update actions to use Node v20

8195b92

mock Response for websocket test

d0866d1

fix node version

fd13151

flow signatures added and tests fixed

5169efa

remove support for router.fetch

7e8bf0c

resolved merge conflicts

575460b

deps update

811c166

testing after and before handlers in flow

873f794

tweak bun flow advanced example

5c25e1a

default CORS option is now to allow all methods

762c489

kwhitley and others added 12 commits December 13, 2023 14:22

CHANGELOG added for createCors fix

3ae06c3

fixed #202 - typescript generics not being used at router level if IR…

5858f48

…equest used, but Args changed

fixed request/args TS flow?!

2559423

modified changelog and Router types

9539603

checking in

52915f7

updating flow spec

5c3d570

after honors return if given

143892c

shorter way to write the after bit

de4a44d

merge conflicts

d96a320

AutoRouter

4af4b54

passing all tests

d1772b9

Crisfole suggested changes Dec 18, 2023

View reviewed changes

conflicts

cf7efa7

kwhitley changed the title ~~New Feature: "flow" to reduce router initialization boilerplate~~ New Feature: "AutoRouter" to reduce router initialization boilerplate Jan 8, 2024

kwhitley changed the title ~~New Feature: "AutoRouter" to reduce router initialization boilerplate~~ DRAFT: "AutoRouter" to reduce router initialization boilerplate Jan 8, 2024

kwhitley closed this Mar 15, 2024

kwhitley added ON HOLD and removed in progress I'm working on it... allegedly... PENDING RELEASE Final stages before release! :D new feature New feature or request Feedback Requested API Changes, interface questions, etc... labels Mar 20, 2024

kwhitley deleted the flow branch March 24, 2024 20:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DRAFT: "AutoRouter" to reduce router initialization boilerplate #195

DRAFT: "AutoRouter" to reduce router initialization boilerplate #195

kwhitley commented Nov 25, 2023 •

edited

Loading

Crisfole left a comment

Crisfole Dec 16, 2023

Crisfole Dec 16, 2023

Crisfole Dec 18, 2023

Crisfole Dec 18, 2023

Crisfole Dec 18, 2023

Crisfole Dec 18, 2023

Crisfole Dec 18, 2023

kwhitley commented Dec 21, 2023

kwhitley commented Mar 15, 2024

DRAFT: "AutoRouter" to reduce router initialization boilerplate #195

DRAFT: "AutoRouter" to reduce router initialization boilerplate #195

Conversation

kwhitley commented Nov 25, 2023 • edited Loading

Description

API (options)

Type of Change (select one and follow subtasks)

Crisfole left a comment

Choose a reason for hiding this comment

Crisfole Dec 16, 2023

Choose a reason for hiding this comment

Crisfole Dec 16, 2023

Choose a reason for hiding this comment

Crisfole Dec 18, 2023

Choose a reason for hiding this comment

Crisfole Dec 18, 2023

Choose a reason for hiding this comment

Crisfole Dec 18, 2023

Choose a reason for hiding this comment

Crisfole Dec 18, 2023

Choose a reason for hiding this comment

Crisfole Dec 18, 2023

Choose a reason for hiding this comment

kwhitley commented Dec 21, 2023

kwhitley commented Mar 15, 2024

kwhitley commented Nov 25, 2023 •

edited

Loading