Skip to main content

JavaScript: Some Tips for Using MobX's Provider with Enzyme, etc.

Recently, we decided to move from using React's context functionality directly, to using MobX's Provider feature. Updating the code was a little painful, but not nearly as hard as trying to move from React Router v2 to v4! There were a few things that were hard in particular, such as updating all of the Enzyme-based tests. If you need to do the same thing, here are some tips:

First of all, start by reading all the documentation on Provider and inject. I'm not going to duplicate that here.

Let's suppose you have a component named MyComponent, and you have a MobX store named myStore.

If you're using a function-based component like:

const MyComponent = inject('myStore')(observer(cssModules(
    ({ myStore }) => <div>hi!</div>,
    styles,
)));
 
export default MyComponent;

Then to set the propTypes, you'll need to write:

MyComponent.wrappedComponent.propsTypes = { myStore: PropTypes.object.isRequired };

Thankfully, you'll get a warning if you get this one wrong.

In this case, the class-based syntax with decorators looks a bit nicer:

@inject('myStore')
@observer
@cssModules(styles)
export default class MyComponent extends Component {
    static propTypes = {
        myStore: PropTypes.object.isRequired,
    };
 
    render() {
        return <div>hi!</div>;
    }
}

If you're using shallow to test MyComponent, then you should use .wrappedComponent, and pass myStore as a prop directly (which is one of my favorite features of how Provider works):

wrapper = shallow(<MyComponent.wrappedComponent myStore={ myStore } />);

If you're using mount, don't use wrappedComponent. Instead use Provider:

wrapper = mount(
    <Provider myStore={ myStore }>
        <MyComponent />
    </Provider>,
);

If you're using mount, and you see some code like:

wrapper.find(MyComponent).node...;

You'll probably need to change it to:

wrapper.find(MyComponent.wrappedComponent).node...;

If you are in a weird situation where you have to use context and Provider, you're going to find out that Enzyme won't pass any context to Provider since Provider isn't expecting it. Hence, nested components won't get the context that they need. To work around that problem (which is really a problem with how Enzyme works), you can do something like:

    wrapper = mount(
        <Provider myStore={ myStore }>
            <MyComponent>
                <MyOtherComponentThatNeedsContext />
            </MyComponent>
        </Provider>,
        {
            context: { mySpecialContextData },
            childContextTypes: {
                mySpecialContextData: PropTypes.object.isRequired
            }
        },
    );

Anyway, that's all I have for now. I'll keep updating this blog post with more tips as I find them.


Comments

jjinux said…
Let's suppose you have a component that makes use of Provider:

export default class PracticeTestStartPage extends Component {
    render() {
        return (
            <Provider courseTakingStore={ this.props.courseTakingStore }>
                <div className="fullscreen db-sm fx-lc full-top-nav__scroll-wrapper">
                    ...
                </div>
            </Provider>
        );
    }
}

And you have a test like:

it('renders page', () => {
    wrapper = shallow(<PracticeTestStartPage courseTakingStore={ courseTakingStore }
                                             startQuiz={ startQuiz } quiz={ quiz } />);
    expect(wrapper.text().includes('Best Practice Test Ever')).toBeTruthy();
});

Since it uses shallow, it won't render the thing inside Provider. However, it's easy to work around that using:

it('renders page', () => {
    wrapper = shallow(<PracticeTestStartPage courseTakingStore={ courseTakingStore }
                                             startQuiz={ startQuiz } quiz={ quiz } />);
    wrapper = wrapper.children().shallow();
    expect(wrapper.text().includes('Best Practice Test Ever')).toBeTruthy();
});

Popular posts from this blog

Ubuntu 20.04 on a 2015 15" MacBook Pro

I decided to give Ubuntu 20.04 a try on my 2015 15" MacBook Pro. I didn't actually install it; I just live booted from a USB thumb drive which was enough to try out everything I wanted. In summary, it's not perfect, and issues with my camera would prevent me from switching, but given the right hardware, I think it's a really viable option. The first thing I wanted to try was what would happen if I plugged in a non-HiDPI screen given that my laptop has a HiDPI screen. Without sub-pixel scaling, whatever scale rate I picked for one screen would apply to the other. However, once I turned on sub-pixel scaling, I was able to pick different scale rates for the internal and external displays. That looked ok. I tried plugging in and unplugging multiple times, and it didn't crash. I doubt it'd work with my Thunderbolt display at work, but it worked fine for my HDMI displays at home. I even plugged it into my TV, and it stuck to the 100% scaling I picked for the othe

ERNOS: Erlang Networked Operating System

I've been reading Dreaming in Code lately, and I really like it. If you're not a dreamer, you may safely skip the rest of this post ;) In Chapter 10, "Engineers and Artists", Alan Kay, John Backus, and Jaron Lanier really got me thinking. I've also been thinking a lot about Minix 3 , Erlang , and the original Lisp machine . The ideas are beginning to synthesize into something cohesive--more than just the sum of their parts. Now, I'm sure that many of these ideas have already been envisioned within Tunes.org , LLVM , Microsoft's Singularity project, or in some other place that I haven't managed to discover or fully read, but I'm going to blog them anyway. Rather than wax philosophical, let me just dump out some ideas: Start with Minix 3. It's a new microkernel, and it's meant for real use, unlike the original Minix. "This new OS is extremely small, with the part that runs in kernel mode under 4000 lines of executable code.&quo

Haskell or Erlang?

I've coded in both Erlang and Haskell. Erlang is practical, efficient, and useful. It's got a wonderful niche in the distributed world, and it has some real success stories such as CouchDB and jabber.org. Haskell is elegant and beautiful. It's been successful in various programming language competitions. I have some experience in both, but I'm thinking it's time to really commit to learning one of them on a professional level. They both have good books out now, and it's probably time I read one of those books cover to cover. My question is which? Back in 2000, Perl had established a real niche for systems administration, CGI, and text processing. The syntax wasn't exactly beautiful (unless you're into that sort of thing), but it was popular and mature. Python hadn't really become popular, nor did it really have a strong niche (at least as far as I could see). I went with Python because of its elegance, but since then, I've coded both p