Experimental: Add support to create the Tanzu Hub client #175

anujc25 · 2024-04-12T22:28:10Z

What this PR does / why we need it

Adds support to create authenticated Tanzu Hub client for the specified tanzu context
The Tanzu Hub client exposes a graphQL client implemented using github.com/Khan/genqlient/graphql to query the hub resources with graphQL APIs.
Also provides a Makefile to help plugin authors initialize and generate the stub for the graphQL queries.

Which issue(s) this PR fixes

Fixes #

Describe testing done for PR

Release note

Experimental: Add support to create the Tanzu Hub client

Additional information

Special notes for your reviewer

config/tanzu_context.go

client/hub/client.go

vuil · 2024-04-15T21:20:52Z

Have you thought about where instructions/tooling pertaining to generation of query stubs from Hub schema should reside.
I am not sure if they fit in plugin-tooling.mk, but some convenient make targets might be worth considering

client/hub/README.md

vuil · 2024-04-26T22:17:10Z

client/hub/README.md

+To create a Tanzu Hub client, plugin authors can just use the `CreateHubClient(contextName string)` API
+by providing the `tanzu` context name. An authenticated Tanzu Hub client for the specified tanzu context will be returned.
+This client includes an authenticated GraphQLClient from the `github.com/Khan/genqlient`
+that can be used to do GraphQL queries. Internally it configures the client with a CSP access token for each request.


a CSP access token -> an access token

do we have plans to auto-refresh the token? Given the CLI single command invocation use case (assuming we are not dealing with very long-running operations), this might not be too relevant.
If we are open to the possibility, it might be worth mentioning here and add a TODO in client.go

Also worth mentioning (especially for folks jumping to this doc mostly to learn about hub client integration) that the client if authenticated is assured at least 10-15m access to the graphQL endpoint.

vuil

Nice!
If you are thinking of address the comments in this change.
I would also suggest updating README.md to mention the EXPERIMENTAL nature of the hub client introduction

vuil · 2024-05-01T18:24:11Z

hack/hub/tanzuhub.mk

+
+TANZU_HUB_PKG_BASE_DIR ?= $(ROOT_DIR)/pkg
+TANZU_HUB_PKG_DIR=$(TANZU_HUB_PKG_BASE_DIR)/hub
+TANZU_HUB_INIT_FILES := queries.graphql main.go genqlient.yaml


nit: I wonder if we should put (commented out) a very simple example query in queries.graphql.

hack/hub/tanzuhub.mk

marckhouzam

This is really cool! Nice way to help project use the client.
Some questions to help me confirm I understood things properly.

client/hub/README.md

marckhouzam · 2024-05-01T19:20:47Z

hack/hub/tanzuhub.mk

+	for filename in $(TANZU_HUB_INIT_FILES); do \
+		[ -f $(TANZU_HUB_PKG_DIR)/$$filename ] && echo "Skipping $(TANZU_HUB_PKG_DIR)/$$filename (already exists)" || wget -O "$(TANZU_HUB_PKG_DIR)/$(filename)" $(TANZU_HUB_INIT_PKG_URL)/$$filename ; \
+	done
+	wget -O "$(TANZU_HUB_PKG_DIR)/schema.graphql" $(TANZU_HUB_SCHEMA_FILE_URL)


This file is the schema. I assume it should not be modified by the local project?

should it be checked-in to git? mine is 98k lines

can this schema change?

should a new version be fetched each time the code is compiled? Or should the project dev run make tanzu-hub-stub-init once in a while to refresh? or do we not need to re-download at all?

It does not harm to check in that file in the plugin repository as plugins can manage how it should be consumed and when it needs to be updated. But as schema can change, I don't think we should check it into this repository.

Yes it can change.

The expectation at the moment is to run the make tanzu-hub-stub-init to refresh the schema file.

marckhouzam · 2024-05-01T19:38:32Z

hack/hub/tanzuhub.mk

+.PHONY: tanzu-hub-stub-init
+tanzu-hub-stub-init: # Initialize a Tanzu Hub package with stub, schema.graphql and queries.graphql to generate graphQL client APIs
+	mkdir -p $(TANZU_HUB_PKG_DIR)
+	for filename in $(TANZU_HUB_INIT_FILES); do \


So these three files are stubs but once created, the user may modify then so we don't want to overwrite them, correct? Or is it only queries.graphql that we need to "protect"? Could the user want to regenerate the other files to update them to a new TPR release? In such a case, how about putting the files that can be changed under a generated/ directory that the user can delete at any time and then run make tanzu-hub-stub-init again?

I will need time to think about this a bit more. Considering this is an experimental feature, we should be okay to do this change later as well.

marckhouzam

Ok, this is great!
I'll let you decide what you want to do about the comments as I just started playing with this.

LGTM whatever you decide.

config/tanzu_context.go

…u#175) - Adds support to create authenticated Tanzu Hub client for the specified tanzu context - The Tanzu Hub client exposes a graphQL client implemented using github.com/Khan/genqlient/graphql to query the hub resources with graphQL APIs. - Also provides a Makefile to help plugin authors initialize and generate the stub for the graphQL queries.

- Adds support to create authenticated Tanzu Hub client for the specified tanzu context - The Tanzu Hub client exposes a graphQL client implemented using github.com/Khan/genqlient/graphql to query the hub resources with graphQL APIs. - Also provides a Makefile to help plugin authors initialize and generate the stub for the graphQL queries.

vmwclabot added the cla-not-required label Apr 12, 2024

vuil reviewed Apr 15, 2024

View reviewed changes

config/tanzu_context.go Outdated Show resolved Hide resolved

vuil reviewed Apr 15, 2024

View reviewed changes

client/hub/client.go Outdated Show resolved Hide resolved

vuil reviewed Apr 15, 2024

View reviewed changes

client/hub/client.go Outdated Show resolved Hide resolved

anujc25 force-pushed the hub-client-support branch 4 times, most recently from fd49571 to ef08f99 Compare April 23, 2024 06:06

anujc25 changed the title ~~Add support to create Tanzu Hub client~~ Experimental: Add support to create the Tanzu Hub client Apr 23, 2024

anujc25 force-pushed the hub-client-support branch from ef08f99 to ede63d2 Compare April 23, 2024 06:28

anujc25 marked this pull request as ready for review April 23, 2024 06:29

anujc25 requested a review from a team as a code owner April 23, 2024 06:29

anujc25 mentioned this pull request Apr 23, 2024

Experimental: Set the Tanzu Hub endpoint when creating tanzu context vmware-tanzu/tanzu-cli#734

Merged

anujc25 force-pushed the hub-client-support branch from ede63d2 to 316d2ff Compare April 23, 2024 06:31

vuil reviewed Apr 26, 2024

View reviewed changes

vuil approved these changes May 1, 2024

View reviewed changes

anujc25 commented May 1, 2024

View reviewed changes

hack/hub/tanzuhub.mk Outdated Show resolved Hide resolved

anujc25 added 3 commits May 1, 2024 12:38

Add support to create authenticated Tanzu Hub client

9e1aa06

Address comments

e09bc44

Fix tanzuhub.mk file

0344e49

anujc25 force-pushed the hub-client-support branch from 8808def to 0344e49 Compare May 1, 2024 19:38

marckhouzam reviewed May 1, 2024

View reviewed changes

marckhouzam approved these changes May 1, 2024

View reviewed changes

config/tanzu_context.go Show resolved Hide resolved

config/tanzu_context.go Show resolved Hide resolved

marckhouzam added this to the v1.3.0 milestone May 1, 2024

anujc25 added 4 commits May 1, 2024 13:51

Address comments

f40196a

Add Experimental note in the README

31216fe

go tidy dependencies

703c327

Add comment to the queries.graphql file

764fec1

anujc25 force-pushed the hub-client-support branch from 6cd3581 to 764fec1 Compare May 1, 2024 22:05

anujc25 merged commit ad724a2 into vmware-tanzu:main May 1, 2024
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Experimental: Add support to create the Tanzu Hub client #175

Experimental: Add support to create the Tanzu Hub client #175

anujc25 commented Apr 12, 2024 •

edited

Loading

vuil commented Apr 15, 2024

vuil Apr 26, 2024

anujc25 Apr 29, 2024

vuil left a comment

vuil May 1, 2024

marckhouzam left a comment

marckhouzam May 1, 2024

anujc25 May 1, 2024 •

edited

Loading

marckhouzam May 1, 2024

anujc25 May 1, 2024

marckhouzam left a comment

Experimental: Add support to create the Tanzu Hub client #175

Experimental: Add support to create the Tanzu Hub client #175

Conversation

anujc25 commented Apr 12, 2024 • edited Loading

What this PR does / why we need it

Which issue(s) this PR fixes

Describe testing done for PR

Release note

Additional information

Special notes for your reviewer

vuil commented Apr 15, 2024

vuil Apr 26, 2024

Choose a reason for hiding this comment

anujc25 Apr 29, 2024

Choose a reason for hiding this comment

vuil left a comment

Choose a reason for hiding this comment

vuil May 1, 2024

Choose a reason for hiding this comment

marckhouzam left a comment

Choose a reason for hiding this comment

marckhouzam May 1, 2024

Choose a reason for hiding this comment

anujc25 May 1, 2024 • edited Loading

Choose a reason for hiding this comment

marckhouzam May 1, 2024

Choose a reason for hiding this comment

anujc25 May 1, 2024

Choose a reason for hiding this comment

marckhouzam left a comment

Choose a reason for hiding this comment

anujc25 commented Apr 12, 2024 •

edited

Loading

anujc25 May 1, 2024 •

edited

Loading