Added support for non root (home) deployment of bit-server #4923 #4958

pgangwani · 2021-10-13T14:37:31Z

Fixes Issue

How to test

Clone, checkout https://github.com/pgangwani/bit-server-static-public-path-issue
Above repo represent setup where bit-server is not deploeyed on root / of the domain
Make sure we setup bit locally with link name bit-local

# clone
git clone https://github.com/teambit/bit.git
cd bit

# install
rm -rf node_modules public/bit
bit install # this might take a long time
bit compile

# probably not needed:
# npm run build
# npm run build:types 
## OR
# npm run build:windows 

# one time registration
npm run dev-link bit-local
# OR
npm run dev-link:windows bd

# you will then be able to run:
bd -v
# output will be "last-tag 0.0.516"
# (unlike bit -v, which outputs "0.0.516"

# etc 
> ~/project/example-project$
bd start --rebuild

Run npm run reproduce:issue
Goto /bit-dev/ route and test the server with & without pushing components.

Proposed Changes

Need help on how to remove hardcoded values to be coming from configs
Test all use case
Review comments for sure

KutnerUri · 2021-10-13T14:53:52Z

very nice! need to

replace hard coded values with configuration (worst case I'll do it)
remove unrelated files (yarn.lock, prettiers)

pgangwani · 2021-10-13T19:47:09Z

very nice! need to

replace hard coded values with configuration (worst case I'll do it)

remove unrelated files (yarn.lock, prettiers)

Removed unrelated file.
As discussed over slack, I really need to connect stuff. I could connect only static/ folder till now and was able to make changes in respective to files to make it work in /bit-dev/ route

scopes/preview/ui/component-preview/urls.ts

KutnerUri · 2021-10-14T17:19:36Z

scopes/harmony/graphql/render-lifecycle.tsx

-    const wsUrl = `${isInsecure ? 'ws:' : 'wss:'}//${location.host}/subscriptions`;
+    const wsUrl = `${isInsecure ? 'ws:' : 'wss:'}//${location.host}/bit-dev/subscriptions`;

-    const client = this.graphqlUI.createClient('/graphql', { state, subscriptionUri: wsUrl });
+    const client = this.graphqlUI.createClient('/bit-dev/graphql', { state, subscriptionUri: wsUrl });


need to pass basename from graphql/ui aspect

KutnerUri · 2021-10-14T17:21:54Z

scopes/preview/ui/component-preview/urls.ts

-  const defaultServerUrl = `/api/${component.id.toString()}/~aspect/preview/`;
+  const defaultServerUrl = `/bit-dev/api/${component.id.toString()}/~aspect/preview/`;


need to pass basename (from where..?) as prop.

Where to get the basename prop though?
maybe we can it from react-router context?

worse case we can set a global react-context from the UI aspect, something like:

const { basename, apiPath } = useContext(???); const defaultServerUrl = `${apiPath}/${component.id.toString()}/~aspect/preview/`;

I'm thinking of adding basename to our internal routing system, as part of the changes I'm going to do to @teambit/base-ui.routing.routing-provider anyways.

It would be more elegant.

Then again, I'm not sure it will work here, because explicitUrl could have it's own url.

KutnerUri · 2021-10-14T17:25:27Z

scopes/ui-foundation/react-router/react-router/route-context.tsx

+  routing = Routing.url,
+  children,
+  location,
+  basename = '/bit-dev/',


default should be undefined (if possible), or / otherwise.

the "bit-dev" should come from the UI aspect

KutnerUri · 2021-10-14T17:27:53Z

scopes/ui-foundation/ui/ui.main.runtime.ts

+    // Changing to relative path which should work in all cases
+    publicPath: process.env.ASSET_PATH || './',


ooh this looks interesting, how does it work

workspace.jsonc

KutnerUri · 2021-10-17T18:36:52Z

forwarded publicPath to graphql aspect and react-router aspect.
Only left to deduce the basename for preview iframe, I need to think how to do that.

pgangwani · 2021-10-18T09:35:13Z

forwarded publicPath to graphql aspect and react-router aspect. Only left to deduce the basename for preview iframe, I need to think how to do that.

Thanks @KutnerUri for interim update. Will checkout latest and test. Can you share the steps how can I test when I have just scope.json ?

KutnerUri · 2021-10-28T15:48:10Z

scopes/harmony/graphql/graphql.preview.runtime.tsx

+GraphqlPreview.provider = ([previewPreview]: [PreviewPreview]) => {
+  const graphqlPreview = new GraphqlPreview();
+
+  previewPreview.registerRenderContext(() => graphqlPreview.getConfig());


forward gql config to preview

KutnerUri · 2021-10-28T15:48:43Z

scopes/harmony/graphql/graphql.ui.runtime.tsx

@@ -57,6 +60,19 @@ export class GraphqlUI {
    return client;
  }

+  getConfig = (): GqlConfig => {


dynamic gql endpoints, based on configuration

pgangaw and others added 3 commits October 13, 2021 19:01

feat: Adding support for the non root bit-server deployment

ad57a3e

Merge branch 'master' of https://github.com/teambit/bit

c86e4a9

feat: would like to see here

0a739a4

pgangwani changed the title # Added support for non root (home) deployment of bit-server #4923 Oct 13, 2021

KutnerUri marked this pull request as draft October 13, 2021 14:54

Pawan Gangwani added 2 commits October 14, 2021 01:06

refactor: reverting unrelated changes though it came from linter

66e7e7d

refactor: reverting unrelated changes again

9eef500

KutnerUri self-requested a review October 14, 2021 08:19

GiladShoham requested changes Oct 14, 2021

View reviewed changes

scopes/preview/ui/component-preview/urls.ts Outdated Show resolved Hide resolved

fix: encorporate review comments

48fcec4

KutnerUri reviewed Oct 14, 2021

View reviewed changes

Pawan Gangwani and others added 4 commits October 15, 2021 00:02

fix: encorporate review comments

51a664d

Merge branch 'master' into master

d7148bd

react-router basename

b671407

gql basename

f566e08

pgangwani mentioned this pull request Oct 18, 2021

bit server start issue in self hosted docker in kubernetes cluster (any load balancer setup) #4923

Closed

KutnerUri added 4 commits October 21, 2021 19:05

use createHref in preview routes

8bd9264

refactor gql endpoints

2fb569c

forward gql endpoints to preview

d860f0a

Merge branch 'master' into master

9a534c5

KutnerUri marked this pull request as ready for review October 28, 2021 15:47

forward ui config during preview

11a8fb5

KutnerUri previously approved these changes Oct 28, 2021

View reviewed changes

KutnerUri added 2 commits November 2, 2021 12:22

rename publicPath to be urlBasename

e055759

add basename to graphql endpoint

25dd1a9

GiladShoham dismissed KutnerUri’s stale review via 25dd1a9 October 26, 2022 16:36

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added support for non root (home) deployment of bit-server #4923 #4958

Added support for non root (home) deployment of bit-server #4923 #4958

pgangwani commented Oct 13, 2021 •

edited

Loading

KutnerUri commented Oct 13, 2021

pgangwani commented Oct 13, 2021 •

edited

Loading

KutnerUri Oct 14, 2021

KutnerUri Oct 14, 2021 •

edited

Loading

KutnerUri Oct 17, 2021

KutnerUri Oct 14, 2021

KutnerUri Oct 14, 2021

KutnerUri commented Oct 17, 2021

pgangwani commented Oct 18, 2021 •

edited

Loading

KutnerUri Oct 28, 2021

KutnerUri Oct 28, 2021

		const defaultServerUrl = `/api/${component.id.toString()}/~aspect/preview/`;
		const defaultServerUrl = `/bit-dev/api/${component.id.toString()}/~aspect/preview/`;

		// Changing to relative path which should work in all cases
		publicPath: process.env.ASSET_PATH \|\| './',

Added support for non root (home) deployment of bit-server #4923 #4958

Are you sure you want to change the base?

Added support for non root (home) deployment of bit-server #4923 #4958

Conversation

pgangwani commented Oct 13, 2021 • edited Loading

Fixes Issue

How to test

Proposed Changes

KutnerUri commented Oct 13, 2021

pgangwani commented Oct 13, 2021 • edited Loading

KutnerUri Oct 14, 2021

Choose a reason for hiding this comment

KutnerUri Oct 14, 2021 • edited Loading

Choose a reason for hiding this comment

KutnerUri Oct 17, 2021

Choose a reason for hiding this comment

KutnerUri Oct 14, 2021

Choose a reason for hiding this comment

KutnerUri Oct 14, 2021

Choose a reason for hiding this comment

KutnerUri commented Oct 17, 2021

pgangwani commented Oct 18, 2021 • edited Loading

KutnerUri Oct 28, 2021

Choose a reason for hiding this comment

KutnerUri Oct 28, 2021

Choose a reason for hiding this comment

pgangwani commented Oct 13, 2021 •

edited

Loading

pgangwani commented Oct 13, 2021 •

edited

Loading

KutnerUri Oct 14, 2021 •

edited

Loading

pgangwani commented Oct 18, 2021 •

edited

Loading