Real end-to-end type-safety with Expressjs

Eliav2 — Sun, 28 Apr 2024 22:10:51 +0000

TLDR: Check out my new end-to-end type adapter for Express.js: express-typed

I’ve always appreciated the simplicity of Express, but it was created back in 2009, long before TypeScript emerged in 2014. Consequently, type safety wasn’t built into the framework from the start.

While alternatives like trpc exist, they often come bundled with peculiar adapters specific to trpc, not always seamlessly fitting into other setups.

Another option ts-rest and zodios, but they require upfront type definitions imported into both backend and frontend. This approach can be tedious, especially when dealing with dynamic backend types, such as those in Prisma ORM.

When confronted with these challenges in my recent project, I decided to build a custom type adapter for Express.js Router. This solution relies heavily on type declarations, wrapped in a tiny runtime wrapper around Express.Router, that enables type inference (as TypeScript inference primarily operates declaratively: during assignment and return, while Express.Router routes are declared imperatively)

This library was successfully deployed in production with my latest project, and the results were so impressive that I couldn’t resist extracting the type adapter into a separate library to share with you all.

Check out the GitHub repo for more details, and please share any suggestions or issues you encounter!

How React hooks work - in depth

Eliav2 — Mon, 03 May 2021 12:24:32 +0000

How React hooks work - in depth

(for better readability and markdown support, you can read this article from the github repo)

In simple cases, React Hooks will magically do exactly what you meant for, but in other cases, their behavior can feel
inconsistent and unpredictable. the next article will try to deeply explain and demonstrate React hooks behavior.

The article is consisted of three main sections:

Definitions - this section summarizes important terms in React and web development which necessary for the rest of the article.
React Hooks - explains what type of hooks exists, what the difference between them, and how they behave.
Examples - examples that demonstrate everything explained in this article with an increasing difficulty rate.

Which of you that will finish reading the article to the end, and will really understand the latest example, will no
longer be surprised by unexpected problems when using hooks in components with a complicated lifecycle.

The article is not for starters, and I will assume that you have some experience with React and React hooks.

code sandbox of all examples: https://codesandbox.io/s/github/Eliav2/how-react-hooks-work

webpage of sandbox(examples on full screen): https://d47vv.csb.app/

GitHub repo: https://github.com/Eliav2/how-react-hooks-work

article mirrors

read in your preferred platform:

For best readability and for most updated version I would strongly recommend read from Home page.
Comments and questions can be left on your preferred platform.

Definitions

If you are not a React expert, It is strongly recommended to read the definitions section. You can start from the example
section and then return to this section later if something is not clear.

the more important definitions here are: render, update, react hook and phase.

browser DOM - a tree of HTML elements. These elements make up everything the user sees in the browser, including this very page.
React - A library for manipulating React components.
React component - function(or class) that holds stateful logic managed by React lib, that component usually returns UI elements based on the stateful logic of the same component. React have class components, and functional components(FC).
React tree - a tree of React components(like the tree you can see in React devtools). this is not the same as the browser's DOM tree.
react renderer - ReactDOM in web(or react-native in mobile) - a library that knows how to manipulate React tree and 'render' it into the browser's DOM in the desired location(in react apps usually to root element). The renderer managing a Virtual DOM (VDOM) which is created and updated based on the given React tree.
render - this is the moment when React tree is created based on the current state. then the tree is passed to the renderer that will update the VDOM, and then will flush the changes into the browser's DOM.
update - when we say that a component 'updates', we are saying that the function component body re-executed (with possibly different props). it is possible that more the one update cycle will occur before a render. examples of the difference between update and render later.
react hook - A primitive that shares stateful logic with the parent Component. this is the reason hooks allowed only inside a body of a function component - hook is hooked to the parent component stateful logic. The hook and the parent component updates are triggers in the same phase, and the effects of the hook and the FC also fire in the same phase.
a component's phase - this is not an official term, I'm using this term in this tutorial to describe a different point of time in a React component. update: also React calls this phase.

Note - These definitions were summarized by me and may not be accurate, but they are sufficient to understand the rest of
the article.

React Hooks

There 2 types of React hooks:

State hooks - like useState or useReducer. these hooks use and possibly manipulates the parent component stateful logic.
Effect hooks - one of useEffect or useLayoutEffect. these hooks receive a callback function and usually a dependency array. the callback function will be scheduled by React to fire on a later phase(see definition above). the exact phase is dependent on the effect that was chosen. Effects from the same type will be executed in the order of declaration.

Super Important Notes

Calling state hook from effect(like useEffect) will schedule another render.
Calling state hook from FC body will schedule another update call.

Render cycle

these are the phases of a render:

effects

update call - the moment FC body is executed. this is always the first phase of a render.
useLayoutEffect - it is triggered immediately after all the scheduled update calls executed, just before flushing changes to the browser's DOM and before useEffect.

the docs say:

Updates scheduled inside useLayoutEffect will be flushed synchronously before the browser has a chance to paint.
useEffect - it is triggered after all scheduled updates calls has been executed. this is always the last phase of a
render.

after these phases, the 'render' step is completed and then ReactDOM will do the 'commit' step which basically just
saying updating the browser's DOM based on the virtual DOM created by the render step. the 'commit' phase is not
relevant for the purpose of this article.

cleanup effects

before each effect is fired a cleanup function is fired(if scheduled). the cleanup effects are:

useLayoutEffect cleanup
useEffect cleanup

Note - cleanup effect will never fire on the first render(because there is no prior effect to cleanup from).

Render cycle summary:

per render cycle: Each effect fires the most 1 times, excluding update call which fires at least once.

The effects are fired in this order(excluding the first render), and only if was scheduled:

updateCall - may be called several times for a single render, and will occur one after another before any effect!
useLayoutEffect cleanup
useLayoutEffect
useEffect cleanup
useEffect

the AllPhases example demonstrates this very well.

Examples

important Note - each line of the code that will come next are part of the tutorial, even the comments. read them all to
follow along. these examples are self-explanatory.

Make sure looking at each example code sandbox(there is a link at the end of each example)!

Basic

OK enough words. see the next example.

const Basic = () => {
    // log function helper
    // this will help up follow the component phase cycle
    const render = useRef(0);
    const call = useRef(0);
    const consoleState = () => `{call:${call.current},render:${render.current}}`;
    const log = (...args) => console.log(...args, consoleState());
    // update phase counts
    call.current += 1;
    useEffect(() => {
        render.current += 1;
    });

    //logic
    useEffect(() => {
        log('mount has finished');
    }, []);
    useEffect(() => {
        log('render has finished');
    });
    log('update call');
    return <div/>;
};

what order of logs would you expect when the component mounts? think for a second and replace the '?':

/**
 * expected logs:
 *    update call           {call:?,render:?}
 *    mount has finished    {call:?,render:?}
 *    render has finished   {call:?,render:?}
 */

well, the order is:

/**
 * expected logs:
 *    update call {call:1,render:0}
 *    mount has finished {call:1,render:1}
 *    render has finished {call:1,render:1}
 */

as we explained earlier, the function body fire first and then the effects.

code sandbox

BasicReverse

what will happen if we will replace the effects, does the order will change?

const BasicReverse = () => {
    // log function helper 
    // ...
    // logic
    useEffect(() => {
      log("render has finished");
    });
    useEffect(() => {
      log("mount has finished");
    }, []);
    log("update call");
    return <div/>;
};

well, the order does change, and will be:

/**
 * expected logs:
 *    update call {call:1,render:0}
 *    render has finished {call:1,render:1}
 *    mount has finished {call:1,render:1}
 */

this is because effect hooks from the same type(here useEffect) are scheduled by React for the same phase and will be
executed in the order of declaration, this is a common mistake to think that useEffect with an empty dependency array will
fire on the mount and on a different phase from useEffect with no dependency array.

code sandbox

useLog

now let's create a log helper hook useLog that will let us keep track of the component phase for later examples:

const useLog = (componentName = '', effect = useEffect) => {
    // keep track of phase
    const render = useRef(0);
    const call = useRef(0);

    const consoleState = () =>
        `{call:${call.current},render:${render.current}}(${componentName})`;
    const log = (...args) => console.log(...args, consoleState());

    effect(() => {
        render.current += 1;
        callToEffectTime.current = Math.round((performance.now() - startTime) * 100) / 100;
    });
    call.current += 1;

    return log;
};

render.current and call.current will 'tick' at the same rate of the parent component because of hooks natures.\
This is simplified useLog, you will see different useLog hook in the UseLog.js file which includes some logic for
time execution logic.

and usage:

const Basic = () => {
    const log = useLog();
    useEffect(() => {
        log('finished render');
    });
    return <div/>;
};

/**
 * expected logs:
 *    finished render {call:1,render:1}()
 */

code sandbox

unmount

if we will trigger unmount after mount the logs order will be:

const BasicUnmount = () => {
    const log = useLog();
    useEffect(() => {
        log('mount');
        return () => log('unmount');
    }, []);
    useEffect(() => {
        log('render');
        return () => log('un-render');
    });
    log('update call');
    return <div>asd</div>;
    /**
     * expected logs:
     *    update call {call:1,render:0}
     *    mount {call:1,render:1}
     *    render {call:1,render:1}
     *    unmount {call:1,render:1}
     *    un-render {call:1,render:1}
     */
};

when a component goes through unmounting step - the update phase does not happen, only the effect fire, in the order of
declaration.

code sandbox

Effect vs LayoutEffect

useLayoutEffect is executed before useEffect:

const EffectVsLayoutEffect = () => {
  const logUseLayoutEffect = useLog("useLayoutEffect", useLayoutEffect);
  const logUseEffect = useLog("useEffect", useEffect);
  useEffect(() => {
    logUseEffect("boom!");
  });
  useLayoutEffect(() => {
    logUseLayoutEffect("boom!");
  });
  return <div />;
  /**
   * expected logs:
   *    boom! {call:1,render:1}(useLayoutEffect) in 4.21ms
   *    boom! {call:1,render:1}(useEffect) in 13.37ms
   */
};

code sandbox

AllPhases

This demonstrates all the different phases combined. after mount another dumy re-render is scheduled, we will use
absolute timing for this example to see when each phase is executed:

const AllPhases = () => {
    const logUseLayoutEffect = useLog("useLayoutEffect", useLayoutEffect, "abs");
    const logUseEffect = useLog("useEffect", useEffect, "abs");

    const [, setState] = useState({});
    const forceRender = () => setState({});

    useEffect(() => {
        logUseEffect("useEffect");
        return () => logUseEffect("useEffect cleanup");
    });
    useLayoutEffect(() => {
        logUseLayoutEffect("useLayoutEffect");
        return () => logUseLayoutEffect("useLayoutEffect cleanup");
    });
    logUseEffect("update");

    // fire only on mount
    useEffect(() => {
        logUseEffect(
            "component fully mounted and render cycle ended. now scheduling another render..."
        );
        forceRender();
        return () => logUseEffect("unmount cleanup");
    }, []);

    return <div/>;
    /**
     * expected logs:
     *  update {call:1,render:0}(useEffect) 513.565ms
     *  useLayoutEffect {call:1,render:1}(useLayoutEffect) 517.345ms
     *  useEffect {call:1,render:1}(useEffect) 527.335ms
     *  component fully mounted and render cycle ended. now scheduling another render... {call:1,render:1}(useEffect) 527.6ms
     *  update {call:2,render:1}(useEffect) 529.675ms
     *  useLayoutEffect cleanup {call:2,render:1}(useLayoutEffect) 530.935ms
     *  useLayoutEffect {call:2,render:2}(useLayoutEffect) 531.32ms
     *  useEffect cleanup {call:2,render:1}(useEffect) 531.75ms
     *  useEffect {call:2,render:2}(useEffect) 532.01ms
     */
};

this example deeply demonstrates all the different possible phases while a component renders. make sure you understand
that before proceeding to the next examples.

code sandbox

UpdateCycle

when you set a state while in the update phase another update phase will be scheduled by React. let's try to force React to
trigger 10 update calls before rendering.

const UpdateCycle = () => {
    const log = useLog("UpdateCycle");
    const [, setState] = useState({});
    const forceUpdate = () => setState({});
    const updateCalls = useRef(0);

    const HandleClick = () => {
        updateCalls.current = 0;
        forceUpdate();
    };
    updateCalls.current += 1;
    if (updateCalls.current < 10) forceUpdate();

    useEffect(() => {
        log("render");
    });
    log("update");

    return (
        <div style={boxStyle} onClick={HandleClick}>
            click
        </div>
    );
    /**
     * update {call:1,render:0}(UpdateCycle) 0.33ms
     * update {call:2,render:0}(UpdateCycle) 0.17ms
     * update {call:3,render:0}(UpdateCycle) 0.03ms
     * update {call:4,render:0}(UpdateCycle) 0.025ms
     * update {call:5,render:0}(UpdateCycle) 0.045ms
     * update {call:6,render:0}(UpdateCycle) 0.04ms
     * update {call:7,render:0}(UpdateCycle) 0.03ms
     * update {call:8,render:0}(UpdateCycle) 0.02ms
     * update {call:9,render:0}(UpdateCycle) 0.03ms
     * update {call:10,render:0}(UpdateCycle) 0.015ms
     * render {call:10,render:1}(UpdateCycle) 0.245ms
     */
};

as we can see, we forced React to re-call the function body 10 times before performing the render. we can also notice
that the render phase occurred 0.245ms after the last update call.

code sandbox

RenderCycle

Ok, so we saw what happens when we update the state while in the update phase, but what happens if we try to update the
state when we are no longer in the update state? well, React will schedule an entire re-render cycle for the component.
each render cycle will also include at least one update call.

let's force 5 render cycles:

const RenderCycle = () => {
    const log = useLog("RenderCycle");
    const [, setState] = useState({});
    const forceRender = () => setState({});
    const renderCalls = useRef(0);

    const HandleClick = () => {
        renderCalls.current = 0;
        forceRender();
    };

    useEffect(() => {
        renderCalls.current += 1;
        if (renderCalls.current < 5) forceRender();
        log("render");
    });
    log("update");

    return (
        <div style={boxStyle} onClick={HandleClick}>
            click
        </div>
    );
    /**
     * update {call:1,render:0}(RenderCycle) 0.365ms
     * render {call:1,render:1}(RenderCycle) 0.33ms
     * update {call:2,render:1}(RenderCycle) 0.26ms
     * render {call:2,render:2}(RenderCycle) 0.315ms
     * update {call:3,render:2}(RenderCycle) 0.12ms
     * render {call:3,render:3}(RenderCycle) 0.25ms
     * update {call:4,render:3}(RenderCycle) 0.07ms
     * render {call:4,render:4}(RenderCycle) 0.495ms
     * update {call:5,render:4}(RenderCycle) 0.055ms
     * render {call:5,render:5}(RenderCycle) 0.135ms
     */
};

we can see that each render cycle comes with an update call.

code sandbox

CombinedCycle

now lets say we want 5 update calls for each render. let's force 3 renders:

const CombinedCycle = () => {
    const log = useLog("CombinedCycle");
    const [, setState] = useState({});
    const forceUpdate = () => setState({});
    const updateCalls = useRef(0);
    const renderCalls = useRef(0);

    const HandleClick = () => {
        updateCalls.current = 0;
        renderCalls.current = 0;
        forceUpdate();
    };
    updateCalls.current += 1;
    if (updateCalls.current < 5) forceUpdate();

    useEffect(() => {
        renderCalls.current += 1;
        if (renderCalls.current < 3) forceUpdate();
        updateCalls.current = 0;
        log("render");
    });
    log("update");

    return (
        <div style={boxStyle} onClick={HandleClick}>
            click
        </div>
    );
};
/**
 * update {call:1,render:0}(CombinedCycle) 0.085ms
 * update {call:2,render:0}(CombinedCycle) 0.17ms
 * update {call:3,render:0}(CombinedCycle) 0.03ms
 * update {call:4,render:0}(CombinedCycle) 0.025ms
 * update {call:5,render:0}(CombinedCycle) 0.03ms
 * render {call:5,render:1}(CombinedCycle) 0.29ms
 * update {call:6,render:1}(CombinedCycle) 0.03ms
 * update {call:7,render:1}(CombinedCycle) 0.095ms
 * update {call:8,render:1}(CombinedCycle) 0.02ms
 * update {call:9,render:1}(CombinedCycle) 0.04ms
 * update {call:10,render:1}(CombinedCycle) 0.025ms
 * render {call:10,render:2}(CombinedCycle) 0.08ms
 * update {call:11,render:2}(CombinedCycle) 0.055ms
 * update {call:12,render:2}(CombinedCycle) 0.085ms
 * update {call:13,render:2}(CombinedCycle) 0.025ms
 * update {call:14,render:2}(CombinedCycle) 0.03ms
 * update {call:15,render:2}(CombinedCycle) 0.03ms
 * render {call:15,render:3}(CombinedCycle) 0.085ms
 */

code sandbox

MultipleComponents

Let's combine the last 3 examples into the common parent.

import UpdateCycle from "./UpdateCycle";
import RenderCycle from "./RenderCycle";
import CombinedCycle from "./CombinedCycle";

const Example = () => (
    <>
        <UpdateCycle/>
        <RenderCycle/>
        <CombinedCycle/>
    </>
);

now stop. think. what would you expect? does each component will go through her own update-render phases or maybe the
update calls will occur one after another and then the effects one after another?

the entire tree goes through the phase of the update, and only then the effects are fired.

    /**
 * update {call:1,render:0}(UpdateCycle) 0.505ms
 * update {call:2,render:0}(UpdateCycle) 0.22ms
 * update {call:3,render:0}(UpdateCycle) 0.03ms
 * update {call:4,render:0}(UpdateCycle) 0.035ms
 * update {call:5,render:0}(UpdateCycle) 0.075ms
 * update {call:6,render:0}(UpdateCycle) 0.05ms
 * update {call:7,render:0}(UpdateCycle) 0.04ms
 * update {call:8,render:0}(UpdateCycle) 0.04ms
 * update {call:9,render:0}(UpdateCycle) 0.045ms
 * update {call:10,render:0}(UpdateCycle) 0.025ms
 * update {call:1,render:0}(RenderCycle) 0.035ms
 * update {call:1,render:0}(CombinedCycle) 0.065ms
 * update {call:2,render:0}(CombinedCycle) 0.06ms
 * update {call:3,render:0}(CombinedCycle) 0.065ms
 * update {call:4,render:0}(CombinedCycle) 0.045ms
 * update {call:5,render:0}(CombinedCycle) 0.04ms
 * render {call:10,render:1}(UpdateCycle) 0.15ms
 * render {call:1,render:1}(RenderCycle) 0.33ms
 * render {call:5,render:1}(CombinedCycle) 0.17ms
 * update {call:2,render:1}(RenderCycle) 0.295ms
 * update {call:6,render:1}(CombinedCycle) 0.045ms
 * update {call:7,render:1}(CombinedCycle) 0.045ms
 * update {call:8,render:1}(CombinedCycle) 0.04ms
 * update {call:9,render:1}(CombinedCycle) 0.06ms
 * update {call:10,render:1}(CombinedCycle) 0.04ms
 * render {call:2,render:2}(RenderCycle) 0.145ms
 * render {call:10,render:2}(CombinedCycle) 0.145ms
 * update {call:3,render:2}(RenderCycle) 0.055ms
 * update {call:11,render:2}(CombinedCycle) 0.05ms
 * update {call:12,render:2}(CombinedCycle) 0.085ms
 * update {call:13,render:2}(CombinedCycle) 0.03ms
 * update {call:14,render:2}(CombinedCycle) 0.015ms
 * update {call:15,render:2}(CombinedCycle) 0.02ms
 * render {call:3,render:3}(RenderCycle) 0.125ms
 * render {call:15,render:3}(CombinedCycle) 0.075ms
 * update {call:4,render:3}(RenderCycle) 0.06ms
 * render {call:4,render:4}(RenderCycle) 0.135ms
 * update {call:5,render:4}(RenderCycle) 0.025ms
 * render {call:5,render:5}(RenderCycle) 0.06ms
 */

code sandbox

phew! that was tough. if you read and understand everything to this point you can confidently say that you understand
React hook's nature.

Component with complicated lifecycle

so why do we need to understand all of this? well, in simple cases you don't, but when dealing with a component with a
complicated lifecycle you can sometimes get confused by the component's behavior. an example of such component will
be react-xarrow which needs to trigger callback on different phases to get
the right dimensions and activate animations callbacks on different phases, for that react-xarrows
using react-use-call-onnext-render to schedule callback for
later phases.

Recap

on each phase: An entire React Tree goes through each phase in a render cycle one after another, which means that if one component in the tree is in the useEffect phase for example, all the different components in the tree are currently also in the useEffect phase.
for a React Tree: on the same phase, each Component on React tree will fire each phase in the same order of the declaration of the react component in the React tree. for example:

  <>
    <Comp1/>
    <Comp2/>
  </>

the useEffect if Comp1 will fire and only then the useEffect Comp2 will fire.

On the same React component: on the same phase, each effect from the same type will fire in the order of declaration.

That's it! you now understand what really going on when you asks React to update some state in some component.

If you liked this tutorial make sure to like it and share it! thank you for reading until the end!

DEV Community: Eliav2

Real end-to-end type-safety with Expressjs

How React hooks work - in depth

How React hooks work - in depth

article mirrors

Definitions

React Hooks

Super Important Notes

Render cycle

effects

cleanup effects

Render cycle summary:

Examples

Basic

BasicReverse

useLog

unmount

Effect vs LayoutEffect

AllPhases

UpdateCycle

RenderCycle

CombinedCycle

MultipleComponents

Component with complicated lifecycle

Recap