Update frontend to Mithril 2

- Update libraries - Add Typescript typings for Mithril - Rename "props" to "attrs" - New lifecycle hooks - Other mechanical changes, following the upgrade guide - Remove some of the custom stuff in our Component base class - Introduce "fragments" for non-components that control their own DOM - Remove Mithril patches, introduce a few new ones Challenges: - Behavior of links to current page changed in Mithril - Native Promise rejections are shown on console when not handled - ... Refs #1821. Co-authored-by: Alexander Skvortsov <sasha.skvortsov109@gmail.com> Co-authored-by: Matthew Kilgore <tankerkiller125@gmail.com> Co-authored-by: Franz Liedke <franz@develophp.org>
flarum · Sep 18, 2020 · 6f4de6c · 6f4de6c
1 parent fa0ff20
commit 6f4de6c
Show file tree

Hide file tree

Showing 128 changed files with 2,398 additions and 2,065 deletions.
diff --git a/js/package-lock.json b/js/package-lock.json
diff --git a/js/package.json b/js/package.json
@@ -3,6 +3,7 @@
   "name": "@flarum/core",
   "dependencies": {
     "@babel/preset-typescript": "^7.10.1",
+    "@types/mithril": "^2.0.3",
     "bootstrap": "^3.4.1",
     "classnames": "^2.2.5",
     "color-thief-browser": "^2.0.2",
@@ -13,7 +14,7 @@
     "jquery.hotkeys": "^0.1.0",
     "lodash-es": "^4.17.14",
     "m.attrs.bidi": "github:tobscure/m.attrs.bidi",
-    "mithril": "^0.2.8",
+    "mithril": "^2.0.4",
     "punycode": "^2.1.1",
     "spin.js": "^3.1.0",
     "webpack": "^4.43.0",

diff --git a/js/shims.d.ts b/js/shims.d.ts
@@ -0,0 +1,48 @@
+// Mithril
+import * as Mithril from 'mithril';
+import Stream from 'mithril/stream';
+
+// Other third-party libs
+import * as _dayjs from 'dayjs';
+import * as _$ from 'jquery';
+
+// Globals from flarum/core
+import Application from './src/common/Application';
+
+/**
+ * Helpers that flarum/core patches into Mithril
+ */
+interface m extends Mithril.Static {
+  prop: typeof Stream;
+}
+
+/**
+ * Export Mithril typings globally.
+ *
+ * This lets us use these typings without an extra import everywhere we use
+ * Mithril in a TypeScript file.
+ */
+export as namespace Mithril;
+
+/**
+ * flarum/core exposes several extensions globally:
+ *
+ * - jQuery for convenient DOM manipulation
+ * - Mithril for VDOM and components
+ * - dayjs for date/time operations
+ *
+ * Since these are already part of the global namespace, extensions won't need
+ * to (and should not) bundle these themselves.
+ */
+declare global {
+  const $: typeof _$;
+  const m: m;
+  const dayjs: typeof _dayjs;
+}
+
+/**
+ * All global variables owned by flarum/core.
+ */
+declare global {
+  const app: Application;
+}
diff --git a/js/src/admin/AdminApplication.js b/js/src/admin/AdminApplication.js
@@ -27,13 +27,18 @@ export default class AdminApplication extends Application {
    * @inheritdoc
    */
   mount() {
-    m.mount(document.getElementById('app-navigation'), Navigation.component({ className: 'App-backControl', drawer: true }));
-    m.mount(document.getElementById('header-navigation'), Navigation.component());
-    m.mount(document.getElementById('header-primary'), HeaderPrimary.component());
-    m.mount(document.getElementById('header-secondary'), HeaderSecondary.component());
-    m.mount(document.getElementById('admin-navigation'), AdminNav.component());
+    m.mount(document.getElementById('app-navigation'), { view: () => Navigation.component({ className: 'App-backControl', drawer: true }) });
+    m.mount(document.getElementById('header-navigation'), Navigation);
+    m.mount(document.getElementById('header-primary'), HeaderPrimary);
+    m.mount(document.getElementById('header-secondary'), HeaderSecondary);
+    m.mount(document.getElementById('admin-navigation'), AdminNav);
+
+    // Mithril does not render the home route on https://example.com/admin, so
+    // we need to go to https://example.com/admin#/ explicitly.
+    if (!document.location.hash) document.location.hash = '#/';
+
+    m.route.prefix = '#';
 
-    m.route.mode = 'hash';
     super.mount();
 
     // If an extension has just been enabled, then we will run its settings

diff --git a/js/src/admin/components/AdminLinkButton.js b/js/src/admin/components/AdminLinkButton.js
@@ -10,11 +10,7 @@
 import LinkButton from '../../common/components/LinkButton';
 
 export default class AdminLinkButton extends LinkButton {
-  getButtonContent() {
-    const content = super.getButtonContent();
-
-    content.push(<div className="AdminLinkButton-description">{this.props.description}</div>);
-
-    return content;
+  getButtonContent(children) {
+    return [...super.getButtonContent(children), <div className="AdminLinkButton-description">{this.attrs.description}</div>];
   }
 }
diff --git a/js/src/admin/components/AdminNav.js b/js/src/admin/components/AdminNav.js
@@ -31,62 +31,74 @@ export default class AdminNav extends Component {
 
     items.add(
       'dashboard',
-      AdminLinkButton.component({
-        href: app.route('dashboard'),
-        icon: 'far fa-chart-bar',
-        children: app.translator.trans('core.admin.nav.dashboard_button'),
-        description: app.translator.trans('core.admin.nav.dashboard_text'),
-      })
+      AdminLinkButton.component(
+        {
+          href: app.route('dashboard'),
+          icon: 'far fa-chart-bar',
+          description: app.translator.trans('core.admin.nav.dashboard_text'),
+        },
+        app.translator.trans('core.admin.nav.dashboard_button')
+      )
     );
 
     items.add(
       'basics',
-      AdminLinkButton.component({
-        href: app.route('basics'),
-        icon: 'fas fa-pencil-alt',
-        children: app.translator.trans('core.admin.nav.basics_button'),
-        description: app.translator.trans('core.admin.nav.basics_text'),
-      })
+      AdminLinkButton.component(
+        {
+          href: app.route('basics'),
+          icon: 'fas fa-pencil-alt',
+          description: app.translator.trans('core.admin.nav.basics_text'),
+        },
+        app.translator.trans('core.admin.nav.basics_button')
+      )
     );
 
     items.add(
       'mail',
-      AdminLinkButton.component({
-        href: app.route('mail'),
-        icon: 'fas fa-envelope',
-        children: app.translator.trans('core.admin.nav.email_button'),
-        description: app.translator.trans('core.admin.nav.email_text'),
-      })
+      AdminLinkButton.component(
+        {
+          href: app.route('mail'),
+          icon: 'fas fa-envelope',
+          description: app.translator.trans('core.admin.nav.email_text'),
+        },
+        app.translator.trans('core.admin.nav.email_button')
+      )
     );
 
     items.add(
       'permissions',
-      AdminLinkButton.component({
-        href: app.route('permissions'),
-        icon: 'fas fa-key',
-        children: app.translator.trans('core.admin.nav.permissions_button'),
-        description: app.translator.trans('core.admin.nav.permissions_text'),
-      })
+      AdminLinkButton.component(
+        {
+          href: app.route('permissions'),
+          icon: 'fas fa-key',
+          description: app.translator.trans('core.admin.nav.permissions_text'),
+        },
+        app.translator.trans('core.admin.nav.permissions_button')
+      )
     );
 
     items.add(
       'appearance',
-      AdminLinkButton.component({
-        href: app.route('appearance'),
-        icon: 'fas fa-paint-brush',
-        children: app.translator.trans('core.admin.nav.appearance_button'),
-        description: app.translator.trans('core.admin.nav.appearance_text'),
-      })
+      AdminLinkButton.component(
+        {
+          href: app.route('appearance'),
+          icon: 'fas fa-paint-brush',
+          description: app.translator.trans('core.admin.nav.appearance_text'),
+        },
+        app.translator.trans('core.admin.nav.appearance_button')
+      )
     );
 
     items.add(
       'extensions',
-      AdminLinkButton.component({
-        href: app.route('extensions'),
-        icon: 'fas fa-puzzle-piece',
-        children: app.translator.trans('core.admin.nav.extensions_button'),
-        description: app.translator.trans('core.admin.nav.extensions_text'),
-      })
+      AdminLinkButton.component(
+        {
+          href: app.route('extensions'),
+          icon: 'fas fa-puzzle-piece',
+          description: app.translator.trans('core.admin.nav.extensions_text'),
+        },
+        app.translator.trans('core.admin.nav.extensions_button')
+      )
     );
 
     return items;

diff --git a/js/src/admin/components/AppearancePage.js b/js/src/admin/components/AppearancePage.js
@@ -6,15 +6,16 @@ import EditCustomHeaderModal from './EditCustomHeaderModal';
 import EditCustomFooterModal from './EditCustomFooterModal';
 import UploadImageButton from './UploadImageButton';
 import saveSettings from '../utils/saveSettings';
+import withAttr from '../../common/utils/withAttr';
 
 export default class AppearancePage extends Page {
-  init() {
-    super.init();
+  oninit(vnode) {
+    super.oninit(vnode);
 
-    this.primaryColor = m.prop(app.data.settings.theme_primary_color);
-    this.secondaryColor = m.prop(app.data.settings.theme_secondary_color);
-    this.darkMode = m.prop(app.data.settings.theme_dark_mode);
-    this.coloredHeader = m.prop(app.data.settings.theme_colored_header);
+    this.primaryColor = m.stream(app.data.settings.theme_primary_color);
+    this.secondaryColor = m.stream(app.data.settings.theme_secondary_color);
+    this.darkMode = m.stream(app.data.settings.theme_dark_mode);
+    this.coloredHeader = m.stream(app.data.settings.theme_colored_header);
   }
 
   view() {
@@ -27,40 +28,34 @@ export default class AppearancePage extends Page {
               <div className="helpText">{app.translator.trans('core.admin.appearance.colors_text')}</div>
 
               <div className="AppearancePage-colors-input">
-                <input
-                  className="FormControl"
-                  type="text"
-                  placeholder="#aaaaaa"
-                  value={this.primaryColor()}
-                  onchange={m.withAttr('value', this.primaryColor)}
-                />
-                <input
-                  className="FormControl"
-                  type="text"
-                  placeholder="#aaaaaa"
-                  value={this.secondaryColor()}
-                  onchange={m.withAttr('value', this.secondaryColor)}
-                />
+                <input className="FormControl" type="text" placeholder="#aaaaaa" bidi={this.primaryColor} />
+                <input className="FormControl" type="text" placeholder="#aaaaaa" bidi={this.secondaryColor} />
               </div>
 
-              {Switch.component({
-                state: this.darkMode(),
-                children: app.translator.trans('core.admin.appearance.dark_mode_label'),
-                onchange: this.darkMode,
-              })}
-
-              {Switch.component({
-                state: this.coloredHeader(),
-                children: app.translator.trans('core.admin.appearance.colored_header_label'),
-                onchange: this.coloredHeader,
-              })}
-
-              {Button.component({
-                className: 'Button Button--primary',
-                type: 'submit',
-                children: app.translator.trans('core.admin.appearance.submit_button'),
-                loading: this.loading,
-              })}
+              {Switch.component(
+                {
+                  state: this.darkMode(),
+                  onchange: this.darkMode,
+                },
+                app.translator.trans('core.admin.appearance.dark_mode_label')
+              )}
+
+              {Switch.component(
+                {
+                  state: this.coloredHeader(),
+                  onchange: this.coloredHeader,
+                },
+                app.translator.trans('core.admin.appearance.colored_header_label')
+              )}
+
+              {Button.component(
+                {
+                  className: 'Button Button--primary',
+                  type: 'submit',
+                  loading: this.loading,
+                },
+                app.translator.trans('core.admin.appearance.submit_button')
+              )}
             </fieldset>
           </form>
 
@@ -79,31 +74,37 @@ export default class AppearancePage extends Page {
           <fieldset>
             <legend>{app.translator.trans('core.admin.appearance.custom_header_heading')}</legend>
             <div className="helpText">{app.translator.trans('core.admin.appearance.custom_header_text')}</div>
-            {Button.component({
-              className: 'Button',
-              children: app.translator.trans('core.admin.appearance.edit_header_button'),
-              onclick: () => app.modal.show(EditCustomHeaderModal),
-            })}
+            {Button.component(
+              {
+                className: 'Button',
+                onclick: () => app.modal.show(EditCustomHeaderModal),
+              },
+              app.translator.trans('core.admin.appearance.edit_header_button')
+            )}
           </fieldset>
 
           <fieldset>
             <legend>{app.translator.trans('core.admin.appearance.custom_footer_heading')}</legend>
             <div className="helpText">{app.translator.trans('core.admin.appearance.custom_footer_text')}</div>
-            {Button.component({
-              className: 'Button',
-              children: app.translator.trans('core.admin.appearance.edit_footer_button'),
-              onclick: () => app.modal.show(EditCustomFooterModal),
-            })}
+            {Button.component(
+              {
+                className: 'Button',
+                onclick: () => app.modal.show(EditCustomFooterModal),
+              },
+              app.translator.trans('core.admin.appearance.edit_footer_button')
+            )}
           </fieldset>
 
           <fieldset>
             <legend>{app.translator.trans('core.admin.appearance.custom_styles_heading')}</legend>
             <div className="helpText">{app.translator.trans('core.admin.appearance.custom_styles_text')}</div>
-            {Button.component({
-              className: 'Button',
-              children: app.translator.trans('core.admin.appearance.edit_css_button'),
-              onclick: () => app.modal.show(EditCustomCssModal),
-            })}
+            {Button.component(
+              {
+                className: 'Button',
+                onclick: () => app.modal.show(EditCustomCssModal),
+              },
+              app.translator.trans('core.admin.appearance.edit_css_button')
+            )}
           </fieldset>
         </div>
       </div>