Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Navigation refactoring, handling extension page params #1651

Merged
merged 22 commits into from Dec 22, 2020
Merged

Conversation

ixrock
Copy link
Member

@ixrock ixrock commented Dec 3, 2020

  • Custom page params
  • Detached bunch of unrelated url-params from renderer/navigation.ts with new helper Navigation.createPageParam({name: string, defaultValue?: any, parse?(), stringify?(), ...})
  • Simplified page-registry, so it doesn't need to care about dynamic params part of final page URL
  • [BREAKING]: pageInit.id stops supporting dynamic param placeholders, e.g. /users/:user
  • [BREAKING]: pageInit.exact option removed

close #1399

image

Example from extensions/example-extension/renderer.tsx:

export default class ExampleExtension extends LensRendererExtension {
  clusterPages: Interface.PageRegistration[] = [
    {
      components: {
        Page: (props: Interface.PageComponentProps<ExamplePageParams>) => {
          return <ExamplePage {...props} extension={this}/>;
        },
      },
      params: {
        // setup basic param "exampleId" with default value "demo"
        exampleId: "demo",

        // setup advanced multi-values param "selectedNamespaces" with custom parsing/stringification
        selectedNamespaces: {
          defaultValueStringified: ["default", "kube-system"],
          multiValues: true,
          parse(values: string[]) { // from URL
            return values.map(name => namespaceStore.getByName(name)).filter(Boolean);
          },
          stringify(values: K8sApi.Namespace[]) { // to URL
            return values.map(namespace => namespace.getName());
          },
        }
      }
    }
  ];

  clusterPageMenus: Interface.PageMenuRegistration[] = [
    {
      title: "Example extension",
      components: {
        Icon: ExampleIcon,
      },
    },
  ];
}

Signed-off-by: Roman <ixrock@gmail.com>
@ixrock ixrock added enhancement New feature or request area/extension Something to related to the extension api labels Dec 3, 2020
@ixrock ixrock requested review from jakolehm, jim-docker and a team December 3, 2020 18:34
Signed-off-by: Roman <ixrock@gmail.com>
Copy link
Collaborator

@Nokel81 Nokel81 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have reviews some of these changes. I will continue the review tomorrow. But there are some things already that need to be changed.

src/extensions/registries/page-registry.ts Outdated Show resolved Hide resolved
src/extensions/registries/page-menu-registry.ts Outdated Show resolved Hide resolved
src/extensions/registries/page-menu-registry.ts Outdated Show resolved Hide resolved
src/extensions/registries/page-registry.ts Outdated Show resolved Hide resolved
src/extensions/registries/__tests__/page-registry.test.ts Outdated Show resolved Hide resolved
src/renderer/navigation/url-param.ts Outdated Show resolved Hide resolved
src/renderer/navigation/url-param.ts Outdated Show resolved Hide resolved
src/renderer/components/table/table.tsx Outdated Show resolved Hide resolved
src/renderer/components/select/select.tsx Outdated Show resolved Hide resolved
src/renderer/components/+namespaces/namespace.store.ts Outdated Show resolved Hide resolved
extensions/example-extension/page.tsx Outdated Show resolved Hide resolved
extensions/example-extension/renderer.tsx Outdated Show resolved Hide resolved
extensions/example-extension/renderer.tsx Outdated Show resolved Hide resolved
src/extensions/cluster-feature.ts Outdated Show resolved Hide resolved
src/extensions/cluster-feature.ts Show resolved Hide resolved
src/extensions/cluster-feature.ts Outdated Show resolved Hide resolved
src/extensions/cluster-feature.ts Outdated Show resolved Hide resolved
src/extensions/registries/base-registry.ts Show resolved Hide resolved
src/extensions/registries/page-registry.ts Show resolved Hide resolved
@ixrock
Copy link
Member Author

ixrock commented Dec 4, 2020

Besides all technical details and breaking changes.. what do you think about the concept?

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

Signed-off-by: Roman <ixrock@gmail.com>
…page-params registration

Signed-off-by: Roman <ixrock@gmail.com>
Signed-off-by: Roman <ixrock@gmail.com>
Signed-off-by: Roman <ixrock@gmail.com>
…am => createPageParam (helper)

Signed-off-by: Roman <ixrock@gmail.com>
# Conflicts:
#	src/renderer/components/app.tsx
Signed-off-by: Roman <ixrock@gmail.com>
Signed-off-by: Roman <ixrock@gmail.com>
@Nokel81 Nokel81 self-requested a review December 8, 2020 14:09
Nokel81
Nokel81 previously approved these changes Dec 8, 2020
Copy link
Contributor

@stefcameron stefcameron left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good change, but I think the interface could be improved a bit.

extensions/example-extension/page.tsx Outdated Show resolved Hide resolved
extensions/example-extension/renderer.tsx Outdated Show resolved Hide resolved
extensions/example-extension/renderer.tsx Outdated Show resolved Hide resolved
# Conflicts:
#	src/renderer/components/+workloads-replicasets/replicasets.tsx
#	src/renderer/components/+workloads/workloads.tsx
Signed-off-by: Roman <ixrock@gmail.com>
Signed-off-by: Roman <ixrock@gmail.com>
Signed-off-by: Roman <ixrock@gmail.com>
package.json Show resolved Hide resolved
Signed-off-by: Roman <ixrock@gmail.com>
Copy link
Contributor

@jim-docker jim-docker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this PR breaks the foldout menu feature (using id/parentId fields of the ClusterPageMenuRegistration interface). I have examples that work in master but not in this branch.

src/renderer/navigation/page-param.ts Outdated Show resolved Hide resolved
# Conflicts:
#	src/renderer/components/layout/sidebar.tsx
Signed-off-by: Roman <ixrock@gmail.com>
@ixrock
Copy link
Member Author

ixrock commented Dec 18, 2020

I think this PR breaks the foldout menu feature (using id/parentId fields of the ClusterPageMenuRegistration interface). I have examples that work in master but not in this branch.

@jim-docker could you please check this one more time? I've merged master and reverted most of the part for sidebar menu logic, so would possibly work now.

@jim-docker
Copy link
Contributor

I think this PR breaks the foldout menu feature (using id/parentId fields of the ClusterPageMenuRegistration interface). I have examples that work in master but not in this branch.

@jim-docker could you please check this one more time? I've merged master and reverted most of the part for sidebar menu logic, so would possibly work now.

Yes, works again 👍

jim-docker
jim-docker previously approved these changes Dec 18, 2020
@Nokel81 Nokel81 self-requested a review December 18, 2020 17:41
@jakolehm jakolehm added this to the 4.1.0 milestone Dec 22, 2020
jakolehm
jakolehm previously approved these changes Dec 22, 2020
src/renderer/navigation/index.ts Show resolved Hide resolved
# Conflicts:
#	src/renderer/components/+namespaces/namespace.store.ts
@ixrock ixrock dismissed stale reviews from jakolehm and jim-docker via 77d2184 December 22, 2020 12:37
# Conflicts:
#	src/renderer/components/+workloads-pods/pods.tsx
@ixrock ixrock merged commit be4e1aa into master Dec 22, 2020
@ixrock ixrock deleted the pages-url-params branch December 22, 2020 13:29
@jakolehm jakolehm mentioned this pull request Jan 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/extension Something to related to the extension api enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add params field to page registration (extension api)
8 participants