Extension support page #1112

ixrock · 2020-10-22T10:19:18Z

Add link to support page on bottom bar, close #742

PR's most noticeable changes:

Support page extension:
- adds top menu item (Help -> Support)
- adds status-bar support-ring icon (app's bottom-right corner)
- adds global page accessible from /support
switching to manual updates for material-icons-font from master repo (npm doesn't contain the latest icons pack, e.g. support icon)
Tooltip component fixes: previously didn't work in some case (e.g. small icon in the screen corner with bigger tooltip)
PageLayout new common component: used for Support, Preferences and ClusterSettings pages

Screenshots

* WIP: Adding support page Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com> * lint Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com>

Signed-off-by: Roman <ixrock@gmail.com>

…upport_page

Signed-off-by: Roman <ixrock@gmail.com>

…upport_page # Conflicts: # extensions/telemetry/package.json # extensions/telemetry/renderer.tsx # extensions/telemetry/src/tracker.ts # src/extensions/core-api/registries.ts # src/extensions/extension-api.ts # src/extensions/extension-renderer-api.ts # src/extensions/lens-renderer-runtime.ts # src/extensions/renderer-api/registries.ts

Signed-off-by: Roman <ixrock@gmail.com>

ixrock · 2020-10-22T12:22:11Z

src/extensions/extension-loader.ts

-      for(const [id, ext] of installedExtensions) {
-        let instance = this.instances.get(ext.manifestPath)
+      for (const [id, ext] of installedExtensions) {
+        let instance = this.instances.get(ext.name)


Without this change same extension might be enabled multiple times..
Possible reason: initial checking for ext.manifestPath, but actual saving as installed-extensions happened via ext.id key

Yeah, I noticed this bug also in #1125.

ixrock · 2020-10-22T13:30:57Z

src/extensions/lens-extension.ts

@@ -34,7 +33,6 @@ export class LensExtension implements ExtensionModel {
  @observable manifest: ExtensionManifest;
  @observable manifestPath: string;
  @observable isEnabled = false;
-  @observable.ref runtime: LensExtensionRuntimeEnv;


Removed initially planned "runtime". Now everything could be served via webpack's externals into global Lens runtime.

ixrock · 2020-10-22T13:39:32Z

extensions/telemetry/package.json

@@ -9,8 +9,8 @@
    "styles": []
  },
  "scripts": {
-    "build": "webpack --config webpack.config.js",
-    "dev": "npm run build --watch"


For some reasons reusing command didn't work for me from WebStorm (maybe because need of $@ at the end or different running context, dunno). Btw webpack.config.js is a default config name (even .ts is supported, when used in conjunction with ts-node).

ixrock · 2020-10-22T13:40:39Z

src/extensions/core-api/index.ts

+import * as Registry from "../registries"
+import * as CommonVars from "../../common/vars";
+
+export let windowManager: WindowManager;


Exported in runtime in src/main/index.ts

ixrock · 2020-10-22T13:57:10Z

src/renderer/i18n.ts

@@ -14,7 +14,7 @@ export interface ILanguage {

 export const _i18n = setupI18n({
  missing: (message, id) => {
-    console.warn('Missing localization:', message, id);
+    // console.warn('Missing localization:', message, id);


Turned off to avoid noise for now until we have officially i18n supported.

jim-docker · 2020-10-22T19:12:17Z

extensions/support-page/main.ts

+    this.disposers.push(
+      registry.add({
+        parentId: "help",
+        label: "Support",


this basically duplicates the "Community Slack" and "Report an Issue" Help submenu items that are already there...

So need to remove from that place? What is the question / propose?

Probably remove this "Support" menu item (although it's nice to demonstrate that this can be done). The existing menu items have the advantage of taking you directly to the link in one click, whereas with "Support" it's one click to get to the support page then another to get to the link.

jim-docker · 2020-10-22T19:38:10Z

src/extensions/extension-api.ts

-export * from "./renderer-extension-api"
+// Extension-api types generation bundle (used by rollup.js)
+
+export * from "./core-api"


should this be main-api for consistency?

It's not only about main. Currently this api also consumed in renderer process (whole file imported in bootstrap.tsx).
Anyway I would split both apis with strong separation what's and where included later for more future-proof concept.

jim-docker · 2020-10-22T20:01:28Z

extensions/example-extension/renderer.tsx

  registerPages(registry: Registry.PageRegistry) {
    this.disposers.push(
      registry.add({
-        type: Registry.DynamicPageType.CLUSTER,
+        type: Registry.PageRegistryType.CLUSTER,


I know it's out of scope for this PR but why can't LensRendererExtension have something like:

registerPages(registry: Registry.PageRegistry) { for (let page of this.pages()) { this.disposers.push(registry.add(page)) }

and then the subclasses just have to implement pages() which returns an array of the pages to add?

This API definitely will be improved to git rid of everything redundant for end user of the extensions.

jim-docker · 2020-10-22T20:06:07Z

src/extensions/extension-loader.ts

-    logger.info('[EXTENSIONS-LOADER]: load on main renderer')
-    this.autoloadExtensions(getLensRuntimeEnv, (instance: LensRendererExtension) => {
+  loadOnClusterManagerRenderer() {
+    logger.info('[EXTENSIONS-LOADER]: load on main renderer (cluster manager)')


what does main renderer mean?

Main renderer (term added not by me) means it's a top renderer for main BrowserWindow when app starts and "not-main" renderer it's a renderer process(es) (child renderer process in iframe) where dashboard for single cluster is running.

jim-docker · 2020-10-22T20:15:51Z

src/extensions/extension-loader.ts

-    this.autoloadExtensions(getLensRuntimeEnv, (instance: LensRendererExtension) => {
+  loadOnClusterManagerRenderer() {
+    logger.info('[EXTENSIONS-LOADER]: load on main renderer (cluster manager)')
+    this.autoloadExtensions((instance: LensRendererExtension) => {
      instance.registerPages(pageRegistry)


should this line be removed from here since it is added to loadOnClusterRenderer()?

Nope, it's registering pages in different contexts (cluster-manager and dashboard / single cluster)

jim-docker · 2020-10-22T20:53:59Z

src/renderer/components/layout/page-layout.tsx

+}
+
+@observer
+export class PageLayout extends React.Component<PageLayoutProps> {


…upport_page # Conflicts: # package.json # src/extensions/core-api/registries.ts # src/extensions/extension-loader.ts # src/extensions/lens-renderer-extension.ts # src/extensions/renderer-api/components.ts

Signed-off-by: Roman <ixrock@gmail.com>

ixrock · 2020-10-23T15:37:29Z

@jakolehm can this be merged already?

jakolehm · 2020-10-24T06:20:50Z

src/extensions/extension-loader.ts

-      for(const [id, ext] of installedExtensions) {
-        let instance = this.instances.get(ext.manifestPath)
+      for (const [id, ext] of installedExtensions) {
+        let instance = this.instances.get(ext.name)


Yeah, I noticed this bug also in #1125.

jakolehm · 2020-10-24T06:22:06Z

src/extensions/registries/page-registry.ts

+import { BaseRegistry } from "./base-registry";
+import { computed } from "mobx";
+
+export enum PageRegistryType {


It feels that we should have separate APIs for each type (just to be more futureproof). Ofc that should be done in a separate PR.

jim-docker and others added 9 commits October 19, 2020 14:28

WIP: Adding support page (#1030)

36cc10d

* WIP: Adding support page Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com> * lint Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com>

tooltip fixes, embed latest material-icons font, added page-layout

2e662e8

Signed-off-by: Roman <ixrock@gmail.com>

page-layout: fixes + reuse in cluster-setttings and preferences pages

22653bd

Signed-off-by: Roman <ixrock@gmail.com>

support-page extension -- part 1

25210b8

Signed-off-by: Roman <ixrock@gmail.com>

Merge remote-tracking branch 'origin/extensions-api' into extension_s…

822d9b4

…upport_page

support-page extension -- part 2

ef66f67

Signed-off-by: Roman <ixrock@gmail.com>

support-page extension -- menu-registry / part 1

b853d1d

Signed-off-by: Roman <ixrock@gmail.com>

base branch merge fixes / clean up

59ca12f

Signed-off-by: Roman <ixrock@gmail.com>

ixrock added the area/extension Something to related to the extension api label Oct 22, 2020

ixrock added this to the 3.7.0 milestone Oct 22, 2020

ixrock requested review from nevalla, jakolehm and a team October 22, 2020 10:19

ixrock changed the base branch from master to extensions-api October 22, 2020 10:25

ixrock added 2 commits October 22, 2020 14:24

register status-bar element, base class for extension's registry

6572fad

Signed-off-by: Roman <ixrock@gmail.com>

handle navigation from main-extension's menu (Help -> Support)

a868a98

Signed-off-by: Roman <ixrock@gmail.com>

ixrock changed the title ~~[WIP]: Extension support page~~ Extension support page Oct 22, 2020

ixrock commented Oct 22, 2020

View reviewed changes

ixrock requested a review from jim-docker October 22, 2020 14:01

jim-docker approved these changes Oct 22, 2020

View reviewed changes

ixrock added 2 commits October 23, 2020 12:20

Merge remote-tracking branch 'origin/extensions-api' into extension_s…

2f408ff

…upport_page # Conflicts: # package.json # src/extensions/core-api/registries.ts # src/extensions/extension-loader.ts # src/extensions/lens-renderer-extension.ts # src/extensions/renderer-api/components.ts

merge-fixes

6287279

Signed-off-by: Roman <ixrock@gmail.com>

ixrock removed request for nevalla and jakolehm October 23, 2020 15:37

ixrock requested a review from a team October 24, 2020 03:50

jakolehm approved these changes Oct 24, 2020

View reviewed changes

jakolehm merged commit f3a0059 into extensions-api Oct 24, 2020

jakolehm deleted the extension_support_page branch October 24, 2020 06:24

nevalla modified the milestones: 3.7.0, 4.0.0 Oct 26, 2020

jakolehm mentioned this pull request Oct 27, 2020

Release v4.0.0-alpha.1 #1159

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Extension support page #1112

Extension support page #1112

ixrock commented Oct 22, 2020 •

edited

ixrock Oct 22, 2020 •

edited

jakolehm Oct 24, 2020

ixrock Oct 22, 2020

ixrock Oct 22, 2020

ixrock Oct 22, 2020

ixrock Oct 22, 2020

jim-docker Oct 22, 2020

ixrock Oct 23, 2020

jim-docker Oct 23, 2020

jim-docker Oct 22, 2020

ixrock Oct 23, 2020

jim-docker Oct 22, 2020

ixrock Oct 23, 2020 •

edited

jim-docker Oct 22, 2020

ixrock Oct 23, 2020

jim-docker Oct 22, 2020

ixrock Oct 23, 2020

jim-docker Oct 22, 2020

ixrock commented Oct 23, 2020

jakolehm Oct 24, 2020

jakolehm Oct 24, 2020

Extension support page #1112

Extension support page #1112

Conversation

ixrock commented Oct 22, 2020 • edited

ixrock Oct 22, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ixrock Oct 23, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ixrock commented Oct 23, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ixrock commented Oct 22, 2020 •

edited

ixrock Oct 22, 2020 •

edited

ixrock Oct 23, 2020 •

edited