Re: [pgAdmin4]: Webpacking of static JS/CSS

Hi

On Fri, Jun 30, 2017 at 2:29 AM, George Gelashvili <ggelashvili(at)pivotal(dot)io>
wrote:

> Hey Surinder,
>
>
> ​1. ​
>> Tools
>> ​(tools.js)​ - It will contain all JS modules under tools directory
>>
>>
>> ​2. ​
>> Browser
>> ​(browser.js)​ - It will contain all JS modules under browser directory
>>
>
> By under, do you mean every javascript file recursively under the browser
> directory?
>
​No, I mean a single bundled javascript ​file of various nodes static JS
files.

>
>
>> ​4. Common.js and/or vendor.js - Common.js will contains all common js
>> files/libraries shared by modules like backform, backbone, underscore etc.
>>
>
> We're okay with bundling vendorized code for a first pass to webpack
> everything. The goal should be to pull code out of the shared javascript
> bundle as we unvendor dependencies.
>
Yes, bundled vendor.js will have all unvendor dependencies and files will
refer from node_modules.

> For naming: Common.js is an overloaded term (http://requirejs.org/docs/com
> monjs.html). We prefer vendor.js. Will there be non-vendor code put into
> this bundle?
> ​I think vendor.js should only contain vendor files. We can create another
> file(xyz) that will contains JS files shared across the modules.
>
> ​What do you think ?​
>
>
​
>
>> Entry points JS: main.js - It will load above modules ascynchronusly or
>> it will be minified version of all.
>> define('', ['common', 'tools', 'browser', 'grid'], function(...) {});
>>
> or these modules can also be loaded using dependency; For example, load
>> grid.js on database node expand.
>>
>
> Could you go into some more detail on this decision? How would main.js be
> used in the app? Is the idea to still use define from require.js in
> javascript being webpacked?
>
​In pgAdmin4 there is no main.js, but entry point is browser/index.html.​
This is how I think bundled JS will load:

Load vendor.js using <script></script> in base.html

*​browser/​index.html*

require(
​ ​
['pgadmin',
​'sources/generated/common', ​
'sources/generated/bundled'],
​ ​
function() {
}
​)​

*sources/generated/bundled​.js​*

​define
(
​ ​
['
​sources/generated/browser
', 'sources/generated/
​tools
'
​, 'sources/generated/grid'​
],
​ ​
function
​(​
pgBrowser) {
​ pgBrowser.init();​
}
)​
​

​or we can use 'import'​ instead of 'require' for files that will be
bundled like 'bundled.js'
I keep require/define call untouched in module JS, and webpack converts
'define' calls to __webpack_require__(module_id) to load dependent modules.

>
> ​Currently I am working on converting 'requirejs config shim dependency
>> into webpack' using imports-loader and exports-loader which is taking
>> time and will look for alternative if it doesn't works. Once dependency is
>> properly defined, the task to generate other module JS will become quite
>> easy.
>>
>
> We used imports-loader and exports-loader for tests (see
> web/webpack.test.config.js)
>
​Hmm. it is useful.​ but I am using shim-loader
<https://github.com/zinserjan/shim-loader> which is compatible with
requirejs shim format.

>
>
>> I also found, the CSS imported using import 'slickgrid/slick.grid.css';
>> statement is put into <style></style> tags
>> ​ in html​
>> , instead must be loaded separately as a file so overrides.css can work.
>>
>
> Those three css files from slickgrid need to be brought into the
> application somehow because they won't be available after building the app,
> since SlickGrid has been un-vendored. We opted to webpack the css together
> with the required slickgrid js files. Can the overrides.css files be
> modified to work with this bundle? Which overrides.css file is not
> working now?
>
​This affects the CSS font styles of edit grid header or might affect other
changes as well. we'll have to look how to override vendor slick grid css
which is now rendered in HTML markup.

> Cheers,
> Matt and George
>