Skip to content
This repository has been archived by the owner on Oct 1, 2024. It is now read-only.

Latest commit

 

History

History

quilt_rails

README.md

quilt_rails

Caution

quilt_rails is deprecated.

Shopifolk, see Shopify/quilt-internal for information on the latest packages available for use internally.

A turn-key solution for integrating Quilt client-side libraries into your Rails app, with support for server-side-rendering using @shopify/react-server, integration with @shopify/sewing-kit for building, testing and linting, and front-end performance tracking through @shopify/performance.

Table of Contents

Server-side-rendering

🗒 This guide is focused on internal Shopify developers with access @shopify/sewing-kit. A similar setup can be achieved using the manual installation , and following the react-server webpack plugin guide. Apps not running on Shopify infrastructure should disable server-side GraphQL queries to avoid scalability issue.

Quick start

Using the magic of generators, we can spin up a basic app with a few console commands.

Generate Rails boilerplate

Use rails new . --skip-javascript to scaffold out a Rails application.to do the same.

Add Ruby dependencies

bundle add sewing_kit quilt_rails

This will install our ruby dependencies and update the project's gemfile.

Generate app boilerplate

rails generate sewing_kit:install

This will generate a package.json file with common sewing-kit script tasks, default lint, format configuration; a sewing-kit configuration file, and other project default configurations.

rails generate quilt:install

This command will install Node dependencies, mount the Quilt engine in config/routes.rb, and provide a bare bone React app (in TypeScript) that.

Try it out

bin/rails server

Will run the application, starting up both servers and compiling assets.

Manual installation

Follow this guide on how to do manual setup without the generator.

Advanced use

Testing

For fast tests with consistent results, test front-end components using the tools provided by sewing-kit instead of Rails integration tests.

Use sewing-kit test to run all .test.{js|ts}x files in the app/ui directory. Jest is used as a test runner, with customization available via its sewing-kit plugin.

For testing React applications we provide and support @shopify/react-testing.

Example

Given a component MyComponent.tsx

// app/ui/components/MyComponent/MyComponent.tsx
export function MyComponent({name}: {name: string}) {
  return <div>Hello, {name}!</div>;
}

A test would be written using Jest and @shopify/react-testing's mount feature.

// app/ui/components/MyComponent/tests/MyComponent.test.tsx
import {MyComponent} from '../MyComponent';

describe('MyComponent', () => {
  it('greets the given named person', () => {
    const wrapper = mount(<MyComponent name="Kokusho" />);

    // toContainReactText is a custom matcher provided by @shopify/react-testing/matchers
    expect(wrapper).toContainReactText('Hello, Kokusho');
  });
});
Customizing the test environment

Often you will want to hook up custom polyfills, global mocks, or other logic that needs to run either before the initialization of the test environment, or once for each test suite.

By default, sewing-kit will look for such test setup files under /app/ui/tests. Check out the documentation for more details.

Interacting with the request and response in React code

React-server sets up @shopify/react-network automatically, so most interactions with the request or response can be done from inside the React app.

Example: getting headers
// app/ui/index.tsx

import React from 'react';
import {useRequestHeader} from '@shopify/react-network';

function App() {
  // get `some-header` from the request that was sent through Rails
  const someHeaderICareAbout = useRequestHeader('some-header');

  return (
    <>
      <h1>My application ❤️</h1>
      <div>{someHeaderICareAbout}</div>
    </>
  );
}

export default App;

Note: This solution works out of the box for initial server-side renders. If you wish to have consistent access to request headers on subsequent client-side renders, take a look at NetworkUniversalProvider.

Example: sending custom headers from Rails controller

In some cases you may want to send custom headers from Rails to your React server. Quilt facilitates this case by providing consumers with a headers argument on the render_react call.

class ReactController < ApplicationController
  include Quilt::ReactRenderable

  def index
    render_react(headers: {'x-custom-header': 'header-value-a'})
  end
end

🗒️ if you don't have a controller. Follow the instruction to setup quilt_rails in a controller instead of using the engine.

Headers can be accessed during server-side-rendering with the useRequestHeader hook from @shopify/react-network.

// app/ui/index.tsx

import React from 'react';
import {useRequestHeader} from '@shopify/react-network';

function App() {
  const header = useRequestHeader('x-custom-header');
  return <h1>Data: {header}</h1>;
}

export default App;
Example: sending custom data from Rails controller

In some cases you may want to send basic data from Rails to your React server. Quilt facilitates this case by providing consumers with a data argument on the render_react call.

Note: The data passed should be data that is unlikely or will never change over the course of the session before they render any React components.

Note: Please note the minimal dependencies require to use this feature is listed in CHANGELOG

class ReactController < ApplicationController
  include Quilt::ReactRenderable

  def index
    render_react(data: {'some_id': 123})
  end
end

🗒️ if you don't have a controller. Follow the instruction to setup quilt_rails in a controller instead of using the engine.

If using react-server without a customized server & client file, this will be automatically passed into your application as the data prop. If react-server is not being used or a customized server / client file was provided, check out react-server/webpack-plugin on how to pass the data to React.

// app/ui/index.tsx

import React from 'react';

function App({data}: {data: Record<string, any>}) {
  // Logs {"some_id":123}
  console.log(data);

  return <h1>Data: {data}</h1>;
}

export default App;
Example: redirecting
// app/ui/index.tsx

import React from 'react';
import {useRedirect} from '@shopify/react-network';

function App() {
  // redirect to google as soon as we render
  useRedirect('www.google.com');

  return <h1>My application ❤️</h1>;
}

export default App;

Isomorphic state

With SSR enabled React apps, state must be serialized on the server and deserialized on the client to keep it consistent. When using @shopify/react-server, the best tool for this job is @shopify/react-html's useSerialized hook.

useSerialized can be used to implement universal-providers, allowing application code to manage what is persisted between the server and client without adding any custom code to client or server entrypoints. We offer some for common use cases such as GraphQL, and I18n.

Customizing the Node server

By default, sewing-kit bundles in @shopify/react-server/webpack-plugin for quilt_rails applications to get apps up and running fast without needing to manually write any Node server code.

If what it provides is not sufficient, a completely custom server can be defined by adding a server.js or server.ts file to the app/ui folder. The simplest way to customize the server is to export the object created by @shopify/react-server's createServer call in server.ts file.

└── appeon
   └── ui
      └─- app.{js|ts}x
      └─- index.{js|ts}
      └─- server.{js|ts}x

Fixing rejected CSRF tokens for new user sessions

When a React component sends HTTP requests back to a Rails endpoint (e.g., /graphql), Rails may throw a Can't verify CSRF token authenticity exception. This stems from the Rails CSRF tokens not persisting until after the first UiController call ends.

If your API does not require session data, the easiest way to deal with this is to use protect_from_forgery with: :null_session. This will work for APIs that either have no authentication requirements, or use header based authentication.

While Can't verify CSRF token authenticity error will persist, protect_from_forgery with: :null_session will keep CSRF protection while ensuring the session is nullified when a token is not sent in to be more secure.

You can also add self.log_warning_on_csrf_failure = false to the controller to suppress this error all together.

Example
class GraphqlController < ApplicationController
  protect_from_forgery with: :null_session

  def execute
    # Get GraphQL query, etc

    result = MySchema.execute(query, operation_name: operation_name, variables: variables, context: context)

    render(json: result)
  end
end

If your API does require session data, you can follow these steps:

  • Add an x-shopify-react-xhr header to all GraphQL requests with a value of 1 (this is done automatically if you are using @shopify/react-graphql-universal-provider)
  • Add a protect_from_forgery with: Quilt::HeaderCsrfStrategy override to your API controllers
Example
class GraphqlController < ApplicationController
  protect_from_forgery with: Quilt::HeaderCsrfStrategy

  def execute
    # Get GraphQL query, etc

    result = MySchema.execute(query, operation_name: operation_name, variables: variables, context: context)

    render(json: result)
  end
end

Exception monitoring with Bugsnag

For an opinionated universal Bugsnag+React setup we provide and support @shopify/react-bugsnag.

Example
// app/ui/index.tsx
import React from 'react';
import {Bugsnag, createBugsnagClient} from 'utilities/bugsnag';
import {bugsnagClientApiKey} from 'config/bugsnag';

const bugsnagClient = createBugsnagClient({apiKey: bugsnagClientApiKey});

export function App() {
  return <Bugsnag client={bugsnagClient}>{/* actual app content here */}</Bugsnag>;
}

Performance tracking a React app

To setup performance tracking with your React app with quilt_rails. Follow details guide here.

API

Find all features this gem offer in this API doc.

Shopify embedded app

See here for Dev Docs for Apps. Make sure to add the line: include ShopifyApp::EmbeddedApp if you are using Quilt for server-side rendering of React for an embedded application:

class ReactController < ApplicationController
  include ShopifyApp::EmbeddedApp
  include Quilt::ReactRenderable
  def index
    render_react
  end
end

FAQ

Find your here.