├── .gitignore
├── .npmignore
├── CODE_OF_CONDUCT.md
├── CaptureChunks.tsx
├── LICENSE.md
├── NOTICE
├── README.md
├── getComponentAsync.tsx
├── global.d.ts
├── index.ts
├── package.json
├── tsconfig.json
├── webpack.ts
└── yarn.lock


/.gitignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | *.js
3 | *.log
4 | *.d.ts
5 | !global.d.ts
6 | 


--------------------------------------------------------------------------------
/.npmignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | *.log
3 | 


--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 | This project is governed by [Lyft's code of conduct](https://github.com/lyft/code-of-conduct). All contributors and participants agree to abide by its terms.
2 | 


--------------------------------------------------------------------------------
/CaptureChunks.tsx:
--------------------------------------------------------------------------------
 1 | /// <reference path="./global.d.ts" />
 2 | 
 3 | import * as React from 'react';
 4 | 
 5 | export interface CaptureChunksProps {
 6 |     /** Output of webpack stats when "chunks" filed is enabled */
 7 |     statsChunks: Array<{
 8 |         id: string;
 9 |         modules: Array<{
10 |             name: string;
11 |             id: string;
12 |         }>;
13 |     }>;
14 |     /** Pass an empty array to get required chunks pushed to it */
15 |     additionalChunks: Array<string>;
16 | }
17 | 
18 | /**
19 |  * Capture additional chunks required to render the children.
20 |  * This works with the SyncImportServer TypeScript transformer and UniversalLazyComponent components
21 |  */
22 | export const CaptureChunks: React.StatelessComponent<CaptureChunksProps> =
23 | ({ statsChunks, additionalChunks, children }) => {
24 |     if (typeof global !== 'undefined') {
25 |         global.__webpack_report_dynamic_module__ = (moduleId) => {
26 |             statsChunks.forEach(chunk => {
27 |                 chunk.modules.forEach(module => {
28 |                     if (module.id === moduleId) {
29 |                         additionalChunks.push(chunk.id);
30 |                     }
31 |                 });
32 |             });
33 |         }
34 |     }
35 |     return React.Children.only(children);
36 | }
37 | 


--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
  1 | 
  2 |                                  Apache License
  3 |                            Version 2.0, January 2004
  4 |                         http://www.apache.org/licenses/
  5 | 
  6 |    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
  7 | 
  8 |    1. Definitions.
  9 | 
 10 |       "License" shall mean the terms and conditions for use, reproduction,
 11 |       and distribution as defined by Sections 1 through 9 of this document.
 12 | 
 13 |       "Licensor" shall mean the copyright owner or entity authorized by
 14 |       the copyright owner that is granting the License.
 15 | 
 16 |       "Legal Entity" shall mean the union of the acting entity and all
 17 |       other entities that control, are controlled by, or are under common
 18 |       control with that entity. For the purposes of this definition,
 19 |       "control" means (i) the power, direct or indirect, to cause the
 20 |       direction or management of such entity, whether by contract or
 21 |       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 22 |       outstanding shares, or (iii) beneficial ownership of such entity.
 23 | 
 24 |       "You" (or "Your") shall mean an individual or Legal Entity
 25 |       exercising permissions granted by this License.
 26 | 
 27 |       "Source" form shall mean the preferred form for making modifications,
 28 |       including but not limited to software source code, documentation
 29 |       source, and configuration files.
 30 | 
 31 |       "Object" form shall mean any form resulting from mechanical
 32 |       transformation or translation of a Source form, including but
 33 |       not limited to compiled object code, generated documentation,
 34 |       and conversions to other media types.
 35 | 
 36 |       "Work" shall mean the work of authorship, whether in Source or
 37 |       Object form, made available under the License, as indicated by a
 38 |       copyright notice that is included in or attached to the work
 39 |       (an example is provided in the Appendix below).
 40 | 
 41 |       "Derivative Works" shall mean any work, whether in Source or Object
 42 |       form, that is based on (or derived from) the Work and for which the
 43 |       editorial revisions, annotations, elaborations, or other modifications
 44 |       represent, as a whole, an original work of authorship. For the purposes
 45 |       of this License, Derivative Works shall not include works that remain
 46 |       separable from, or merely link (or bind by name) to the interfaces of,
 47 |       the Work and Derivative Works thereof.
 48 | 
 49 |       "Contribution" shall mean any work of authorship, including
 50 |       the original version of the Work and any modifications or additions
 51 |       to that Work or Derivative Works thereof, that is intentionally
 52 |       submitted to Licensor for inclusion in the Work by the copyright owner
 53 |       or by an individual or Legal Entity authorized to submit on behalf of
 54 |       the copyright owner. For the purposes of this definition, "submitted"
 55 |       means any form of electronic, verbal, or written communication sent
 56 |       to the Licensor or its representatives, including but not limited to
 57 |       communication on electronic mailing lists, source code control systems,
 58 |       and issue tracking systems that are managed by, or on behalf of, the
 59 |       Licensor for the purpose of discussing and improving the Work, but
 60 |       excluding communication that is conspicuously marked or otherwise
 61 |       designated in writing by the copyright owner as "Not a Contribution."
 62 | 
 63 |       "Contributor" shall mean Licensor and any individual or Legal Entity
 64 |       on behalf of whom a Contribution has been received by Licensor and
 65 |       subsequently incorporated within the Work.
 66 | 
 67 |    2. Grant of Copyright License. Subject to the terms and conditions of
 68 |       this License, each Contributor hereby grants to You a perpetual,
 69 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 70 |       copyright license to reproduce, prepare Derivative Works of,
 71 |       publicly display, publicly perform, sublicense, and distribute the
 72 |       Work and such Derivative Works in Source or Object form.
 73 | 
 74 |    3. Grant of Patent License. Subject to the terms and conditions of
 75 |       this License, each Contributor hereby grants to You a perpetual,
 76 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 77 |       (except as stated in this section) patent license to make, have made,
 78 |       use, offer to sell, sell, import, and otherwise transfer the Work,
 79 |       where such license applies only to those patent claims licensable
 80 |       by such Contributor that are necessarily infringed by their
 81 |       Contribution(s) alone or by combination of their Contribution(s)
 82 |       with the Work to which such Contribution(s) was submitted. If You
 83 |       institute patent litigation against any entity (including a
 84 |       cross-claim or counterclaim in a lawsuit) alleging that the Work
 85 |       or a Contribution incorporated within the Work constitutes direct
 86 |       or contributory patent infringement, then any patent licenses
 87 |       granted to You under this License for that Work shall terminate
 88 |       as of the date such litigation is filed.
 89 | 
 90 |    4. Redistribution. You may reproduce and distribute copies of the
 91 |       Work or Derivative Works thereof in any medium, with or without
 92 |       modifications, and in Source or Object form, provided that You
 93 |       meet the following conditions:
 94 | 
 95 |       (a) You must give any other recipients of the Work or
 96 |           Derivative Works a copy of this License; and
 97 | 
 98 |       (b) You must cause any modified files to carry prominent notices
 99 |           stating that You changed the files; and
100 | 
101 |       (c) You must retain, in the Source form of any Derivative Works
102 |           that You distribute, all copyright, patent, trademark, and
103 |           attribution notices from the Source form of the Work,
104 |           excluding those notices that do not pertain to any part of
105 |           the Derivative Works; and
106 | 
107 |       (d) If the Work includes a "NOTICE" text file as part of its
108 |           distribution, then any Derivative Works that You distribute must
109 |           include a readable copy of the attribution notices contained
110 |           within such NOTICE file, excluding those notices that do not
111 |           pertain to any part of the Derivative Works, in at least one
112 |           of the following places: within a NOTICE text file distributed
113 |           as part of the Derivative Works; within the Source form or
114 |           documentation, if provided along with the Derivative Works; or,
115 |           within a display generated by the Derivative Works, if and
116 |           wherever such third-party notices normally appear. The contents
117 |           of the NOTICE file are for informational purposes only and
118 |           do not modify the License. You may add Your own attribution
119 |           notices within Derivative Works that You distribute, alongside
120 |           or as an addendum to the NOTICE text from the Work, provided
121 |           that such additional attribution notices cannot be construed
122 |           as modifying the License.
123 | 
124 |       You may add Your own copyright statement to Your modifications and
125 |       may provide additional or different license terms and conditions
126 |       for use, reproduction, or distribution of Your modifications, or
127 |       for any such Derivative Works as a whole, provided Your use,
128 |       reproduction, and distribution of the Work otherwise complies with
129 |       the conditions stated in this License.
130 | 
131 |    5. Submission of Contributions. Unless You explicitly state otherwise,
132 |       any Contribution intentionally submitted for inclusion in the Work
133 |       by You to the Licensor shall be under the terms and conditions of
134 |       this License, without any additional terms or conditions.
135 |       Notwithstanding the above, nothing herein shall supersede or modify
136 |       the terms of any separate license agreement you may have executed
137 |       with Licensor regarding such Contributions.
138 | 
139 |    6. Trademarks. This License does not grant permission to use the trade
140 |       names, trademarks, service marks, or product names of the Licensor,
141 |       except as required for reasonable and customary use in describing the
142 |       origin of the Work and reproducing the content of the NOTICE file.
143 | 
144 |    7. Disclaimer of Warranty. Unless required by applicable law or
145 |       agreed to in writing, Licensor provides the Work (and each
146 |       Contributor provides its Contributions) on an "AS IS" BASIS,
147 |       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148 |       implied, including, without limitation, any warranties or conditions
149 |       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150 |       PARTICULAR PURPOSE. You are solely responsible for determining the
151 |       appropriateness of using or redistributing the Work and assume any
152 |       risks associated with Your exercise of permissions under this License.
153 | 
154 |    8. Limitation of Liability. In no event and under no legal theory,
155 |       whether in tort (including negligence), contract, or otherwise,
156 |       unless required by applicable law (such as deliberate and grossly
157 |       negligent acts) or agreed to in writing, shall any Contributor be
158 |       liable to You for damages, including any direct, indirect, special,
159 |       incidental, or consequential damages of any character arising as a
160 |       result of this License or out of the use or inability to use the
161 |       Work (including but not limited to damages for loss of goodwill,
162 |       work stoppage, computer failure or malfunction, or any and all
163 |       other commercial damages or losses), even if such Contributor
164 |       has been advised of the possibility of such damages.
165 | 
166 |    9. Accepting Warranty or Additional Liability. While redistributing
167 |       the Work or Derivative Works thereof, You may choose to offer,
168 |       and charge a fee for, acceptance of support, warranty, indemnity,
169 |       or other liability obligations and/or rights consistent with this
170 |       License. However, in accepting such obligations, You may act only
171 |       on Your own behalf and on Your sole responsibility, not on behalf
172 |       of any other Contributor, and only if You agree to indemnify,
173 |       defend, and hold each Contributor harmless for any liability
174 |       incurred by, or claims asserted against, such Contributor by reason
175 |       of your accepting any such warranty or additional liability.
176 | 
177 |    END OF TERMS AND CONDITIONS
178 | 
179 |    APPENDIX: How to apply the Apache License to your work.
180 | 
181 |       To apply the Apache License to your work, attach the following
182 |       boilerplate notice, with the fields enclosed by brackets "{}"
183 |       replaced with your own identifying information. (Don't include
184 |       the brackets!)  The text should be enclosed in the appropriate
185 |       comment syntax for the file format. We also recommend that a
186 |       file or class name and description of purpose be included on the
187 |       same "printed page" as the copyright notice for easier
188 |       identification within third-party archives.
189 | 
190 |    Copyright 2017 Lyft, Inc.
191 | 
192 |    Licensed under the Apache License, Version 2.0 (the "License");
193 |    you may not use this file except in compliance with the License.
194 |    You may obtain a copy of the License at
195 | 
196 |        http://www.apache.org/licenses/LICENSE-2.0
197 | 
198 |    Unless required by applicable law or agreed to in writing, software
199 |    distributed under the License is distributed on an "AS IS" BASIS,
200 |    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201 |    See the License for the specific language governing permissions and
202 |    limitations under the License.
203 | 


--------------------------------------------------------------------------------
/NOTICE:
--------------------------------------------------------------------------------
1 | universal-async-component
2 | Copyright 2016-2017 Lyft Inc.
3 | 
4 | This product includes software developed at Lyft Inc.
5 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Universal Async Component
 2 | 
 3 | Async component that works in server and client. It will allows code splitting that works for universal apps.
 4 | 
 5 | ## What is this?
 6 | This is solving the [hard problem](https://github.com/ReactTraining/react-router/blob/d64ed0150b41df02b083f090b6682261c819a91e/packages/react-router-dom/docs/guides/code-splitting.md#code-splitting--server-rendering) of mixing code splitting and server side rendering. To avoid "flash of contents" in the initial page load server must include dynamic chunks required to render that screen in the HTML response. Using this library and adding corresponding components to your build system you can achieve that.
 7 | 
 8 | 
 9 | ## Example project
10 | See the [**example repo**](https://github.com/mohsen1/universal-async-component-example)
11 | 
12 | ## Usage
13 | 
14 | ```js
15 | import { getComponentAsync } from 'universal-async-component';
16 | 
17 | const AsyncHelloWorld = getComponentAsync({ loader: () => import('./hello') });
18 | 
19 | const App = () => <AsyncHelloWorld />
20 | ```
21 | 
22 | ## Server side rendering
23 | 
24 | To make server-side rendering work you should update your server code to collect additional required chunks and also update your Webpack config to replace `import()` calls with something special that makes all of this work.
25 | 
26 | ### 1. Add `CaptureChunks`
27 | Wrap you app with `CaptureChunks` in your server renderer. You need to provide Webpack client side stats to it. Also, pass an empty array
28 | 
29 | ```jsx
30 | const additionalChunks = [];
31 | var htmlString = ReactDOM.renderToString(
32 |     <CaptureChunks statsChunks={clientStats.chunks} additionalChunks={additionalChunks}>
33 |         <App />
34 |     </CaptureChunks>
35 | );
36 | ```
37 | After above code is run, `additionalChunks` is populated with all chunkIds that is required to render current `App`.
38 | 
39 | Use Webpack [`StatsPlugin`](https://www.npmjs.com/package/webpack-stats-plugin) you can write the stats to disk:
40 | 
41 | ```js
42 | new StatsPlugin({
43 |     filename: 'client-stats.json',
44 |     fields: ['chunks', 'publicPath', 'assets'],
45 | })
46 | ```
47 | 
48 | ### 2. Use `additionalChunks`
49 | Use `additionalChunks` retrieved from `CaptureChunks` to append required chunks
50 | 
51 | ```js
52 | res.send(`
53 | <html>
54 |     <body>
55 |         <div id="root">${htmlString}</div>
56 |         <script src="webpack-bootstrap.js"></script>
57 |         ${additionalChunks.map(chunkId => `<script src="${chunksId}.client.js"></script>`)}
58 |         <script src="client.js"></script>
59 |     </body>
60 | </html>
61 | `)
62 | ```
63 | Note that additional chunks must come before the main bundle and after Webpack bootstrap script. It's easy to extract out Webpack bootstrap by using `CommonsChunkPlugin` plugin:
64 | 
65 | ```js
66 | new webpack.optimize.CommonsChunkPlugin({
67 |     names: ['bootstrap'],
68 |     filename: 'webpack-bootstrap.js',
69 |     minChunks: Infinity
70 | }),
71 | ```
72 | 
73 | ### 3. Add `"string-replace-loader"`
74 | Add `"string-replace-loader"` before any of other loaders in your **client and server** Webpack config and require options from `"universal-async-component"`:
75 | 
76 | ```js
77 | const { stringReplaceLoaderOptions } = require('universal-async-component');
78 | const config = {
79 |     rules: [
80 |         test: /\.jsx?/,
81 |         use: {
82 |             loader: "string-replace-loader",
83 |             options: stringReplaceLoaderOptions,
84 |         },
85 |     ],
86 | }
87 | ```
88 | Note: this will go away once React can render async components
89 | 
90 | 
91 | 
92 | 
93 | 


--------------------------------------------------------------------------------
/getComponentAsync.tsx:
--------------------------------------------------------------------------------
 1 | import * as  React from 'react';
 2 | 
 3 | export type ModuleNamespace = any; // TODO
 4 | 
 5 | /** Props passed to the loading component */
 6 | export interface LoadingProps {
 7 |     isLoading: boolean;
 8 |     error: any;
 9 |     timedOut: boolean;
10 | }
11 | 
12 | export interface GetComponentAsyncConfiguration<T> {
13 |     /** A function that returns promise of a module namespace or a module namespace */
14 |     loader: () => Promise<ModuleNamespace> & { resolvedValue?: ModuleNamespace };
15 |     /** Props to pass to loaded component */
16 |     props?: T;
17 |     /** Loading component */
18 |     loading?: React.ComponentType<LoadingProps>;
19 |     /** Exported member of module returned by the loader function */
20 |     exportKey?: string;
21 |     /** Timeout to give up loading (in milliseconds) */
22 |     timeout?: number;
23 | }
24 | 
25 | /**
26 |  * Get a component asynchronously by providing a loader function that resolves to the module that contains
27 |  * the component.
28 |  */
29 | export function getComponentAsync<T>(getComponentAsyncProps: GetComponentAsyncConfiguration<T>) {
30 | 
31 |     return class AsyncComponent extends React.Component<{}, { ResultComponent: React.ComponentType<T> }> {
32 |         state = { ResultComponent: null as any };
33 | 
34 |         componentWillMount() {
35 |             const exportKey = getComponentAsyncProps.exportKey || 'default';
36 |             const loaderResult = getComponentAsyncProps.loader();
37 |             if (loaderResult.resolvedValue) {
38 |                 this.setState({ ResultComponent: loaderResult.resolvedValue[exportKey] });
39 |             } else {
40 |                 loaderResult.then(result => {
41 |                     this.setState({ ResultComponent: result[exportKey] });
42 |                 });
43 |             }
44 |         }
45 | 
46 |         render() {
47 |             // TODO: Timeout
48 |             if (this.state.ResultComponent) {
49 |                 return <this.state.ResultComponent />
50 |             }
51 |             if (getComponentAsyncProps.loading) {
52 |                 return <getComponentAsyncProps.loading isLoading={true} error={null} timedOut={false} />
53 |             }
54 |             return null;
55 |         }
56 |     }
57 | }
58 | 
59 | 


--------------------------------------------------------------------------------
/global.d.ts:
--------------------------------------------------------------------------------
1 | declare module NodeJS {
2 |     export interface Global {
3 |         /** Report a dynamic module is being required and sent in sync instead */
4 |         __webpack_report_dynamic_module__?: (moduleId: string | number) => void;
5 |     }
6 | }
7 | 


--------------------------------------------------------------------------------
/index.ts:
--------------------------------------------------------------------------------
1 | export * from './CaptureChunks';
2 | export * from './getComponentAsync';
3 | export * from './webpack';
4 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "name": "universal-async-component",
 3 |   "version": "1.0.1",
 4 |   "description": "Universal Async Component",
 5 |   "main": "index.js",
 6 |   "repository": {
 7 |     "type": "git",
 8 |     "url": "git@github.com:lyft/universal-async-component.git"
 9 |   },
10 |   "author": "Mohsen Azimi <me@azimi.me>",
11 |   "license": {
12 |     "type": "Apache-2.0",
13 |     "url": "https://github.com/lyft/universal-async-component/LICENSE"
14 |   },
15 |   "typeings": "./index.d.ts",
16 |   "peerDependencies": {
17 |     "react": "^15.6.1"
18 |   },
19 |   "devDependencies": {
20 |     "@types/node": "^8.0.15",
21 |     "@types/react": "^15.0.38",
22 |     "@types/webpack": "^3.0.5",
23 |     "typescript": "^2.4.2"
24 |   },
25 |   "scripts": {
26 |     "prepublish": "tsc"
27 |   }
28 | }
29 | 


--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
1 | {
2 |     "compilerOptions": {
3 |         "jsx": "react",
4 |         "declaration": true
5 |     }
6 | }
7 | 


--------------------------------------------------------------------------------
/webpack.ts:
--------------------------------------------------------------------------------
 1 | const replace =
 2 | `/* import($1) */(function() {
 3 |     var __module_id__ = require.resolveWeak($1)
 4 |     var __module_sync__
 5 |     if (__webpack_modules__ && __webpack_modules__[__module_id__]) {
 6 |         if (typeof global !== "undefined" && typeof global.__webpack_report_dynamic_module__ === "function") {
 7 |             global.__webpack_report_dynamic_module__(__module_id__)
 8 |         }
 9 |         __module_sync__ = __webpack_require__(__module_id__);
10 |     }
11 |     var __promise__ = import($1)
12 |     if (__module_sync__) { __promise__.resolvedValue = __module_sync__; }
13 |     return __promise__;
14 | 
15 | })()`;
16 | 
17 | /** Provide this option object to "string-replace-loader" */
18 | export const stringReplaceLoaderOptions =  {
19 |     // This is a big hack until this issue is resolved:
20 |     // https://github.com/webpack/webpack/issues/5344
21 |     search: /import\((.*)\)/,
22 |     replace,
23 | };
24 | 


--------------------------------------------------------------------------------
/yarn.lock:
--------------------------------------------------------------------------------
 1 | # THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
 2 | # yarn lockfile v1
 3 | 
 4 | 
 5 | "@types/node@*", "@types/node@^8.0.15":
 6 |   version "8.0.15"
 7 |   resolved "https://registry.yarnpkg.com/@types/node/-/node-8.0.15.tgz#8f23f8a4642ced357704d048010876fc0c7f179a"
 8 | 
 9 | "@types/react@^15.0.38":
10 |   version "15.0.38"
11 |   resolved "https://registry.yarnpkg.com/@types/react/-/react-15.0.38.tgz#6afea31a9fe66304af474106ba372ddaba449995"
12 | 
13 | "@types/source-map@*":
14 |   version "0.5.0"
15 |   resolved "https://registry.yarnpkg.com/@types/source-map/-/source-map-0.5.0.tgz#dd34bbd8e32fe4e74f2e3d8ac07f8aa5b45a47ac"
16 | 
17 | "@types/tapable@*":
18 |   version "0.2.3"
19 |   resolved "https://registry.yarnpkg.com/@types/tapable/-/tapable-0.2.3.tgz#0888b0f20cc7e58e1c22a1888b4e963eefaa810a"
20 | 
21 | "@types/uglify-js@*":
22 |   version "2.6.29"
23 |   resolved "https://registry.yarnpkg.com/@types/uglify-js/-/uglify-js-2.6.29.tgz#521347f69e20201d218f5991ae66e10878afcf1a"
24 |   dependencies:
25 |     "@types/source-map" "*"
26 | 
27 | "@types/webpack@^3.0.5":
28 |   version "3.0.5"
29 |   resolved "https://registry.yarnpkg.com/@types/webpack/-/webpack-3.0.5.tgz#da3bca3665071ccbaba9ff929e361db85d3cc48a"
30 |   dependencies:
31 |     "@types/node" "*"
32 |     "@types/tapable" "*"
33 |     "@types/uglify-js" "*"
34 | 
35 | typescript@^2.4.2:
36 |   version "2.4.2"
37 |   resolved "https://registry.yarnpkg.com/typescript/-/typescript-2.4.2.tgz#f8395f85d459276067c988aa41837a8f82870844"
38 | 


--------------------------------------------------------------------------------