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

Drawing Sierpinski's Triangle in Minecraft Using Python

In his keynote at PyCon, Eben Upton, the Executive Director of the Rasberry Pi Foundation, mentioned that not only has Minecraft been ported to the Rasberry Pi, but you can even control it with Python . Since four of my kids are avid Minecraft fans, I figured this might be a good time to teach them to program using Python. So I started yesterday with the goal of programming something cool for Minecraft and then showing it off at the San Francisco Python Meetup in the evening. The first problem that I faced was that I didn't have a Rasberry Pi. You can't hack Minecraft by just installing the Minecraft client. Speaking of which, I didn't have the Minecraft client installed either ;) My kids always play it on their Nexus 7s. I found an open source Minecraft server called Bukkit that "provides the means to extend the popular Minecraft multiplayer server." Then I found a plugin called RaspberryJuice that implements a subset of the Minecraft Pi modding API for B

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

Creating Windows 10 Boot Media for a Lenovo Thinkpad T410 Using Only a Mac and a Linux Machine

TL;DR: Giovanni and I struggled trying to get Windows 10 installed on the Lenovo Thinkpad T410. We struggled a lot trying to create the installation media because we only had a Mac and a Linux machine to work with. Everytime we tried to boot the USB thumb drive, it just showed us a blinking cursor. At the end, we finally realized that Windows 10 wasn't supported on this laptop :-/ I've heard that it took Thomas Edison 100 tries to figure out the right material to use as a lightbulb filament. Well, I'm no Thomas Edison, but I thought it might be noteworthy to document our attempts at getting it to boot off a USB thumb drive: Download the ISO. Attempt 1: Use Etcher. Etcher says it doesn't work for Windows. Attempt 2: Use Boot Camp Assistant. It doesn't have that feature anymore. Attempt 3: Use Disk Utility on a Mac. Erase a USB thumb drive: Format: ExFAT Scheme: GUID Partition Map Mount the ISO. Copy everything from