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

APP-6785: Remove local control page (RC) #4520

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ethanlookpotts
Copy link
Contributor

@ethanlookpotts ethanlookpotts commented Nov 4, 2024

We are removing RC from the RDK - users are now expected to use app.viam.com to control their machine.

Note

We don't expect workflows to pass until the base PR has been merged.

  1. APP-6785: Remove local control page - remove web workflows #4523
  2. 👉🏼 APP-6785: Remove local control page (RC) #4520

Change log

  • Remove web/frontend
  • Remove unused code in web/
  • Remove unused e2e script
  • Remove web-related targets from Makefile
  • Remove web-related docs from README

Review requests

  • Please review robot/web/web.go thoroughly - I aimed to remove anything related to serving the web app, but I might've trimmed too much or missed some code. Let me know!
  • Anyone missing from the reviewer list?

@viambot viambot added safe to test This pull request is marked safe to test from a trusted zone and removed safe to test This pull request is marked safe to test from a trusted zone labels Nov 4, 2024
@ethanlookpotts ethanlookpotts force-pushed the APP-6785/ethanlookpotts/remove-rc branch from 1d271d1 to 60f837f Compare November 4, 2024 20:17
@viambot viambot added safe to test This pull request is marked safe to test from a trusted zone and removed safe to test This pull request is marked safe to test from a trusted zone labels Nov 4, 2024
@ethanlookpotts ethanlookpotts changed the base branch from main to APP-6785/ethanlookpotts/remove-web-workflows November 4, 2024 20:17
Comment on lines +20 to 22
build: build-go

build-go:
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I could collapse build-go into build

Suggested change
build: build-go
build-go:
build:

Copy link
Member

Choose a reason for hiding this comment

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

I think it's fine this way. I just double checked the proposed makefile with the current github action workflows (to the degree grepping for "make" and "build"/"test" gets what I need).

Github actions are directly using build-go and test-go. So if you go ahead with this change:

  • You'll need to update the github action files invoking make build-go.
  • make build will be "go-less". But make {lint,test,generate} will have "go-ful" versions that github actions use.

@@ -55,7 +47,7 @@ tool-install:
github.com/rhysd/actionlint/cmd/actionlint \
golang.org/x/tools/cmd/stringer

lint: lint-go lint-web
lint: lint-go
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I could collapse lint-go into lint

robot/web/web.go Outdated
if err := svc.installWeb(mux, svc.r, options); err != nil {
return nil, err
}
mux.Handle(pat.New("/"), http.NotFoundHandler())
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@Otterverse see here - not found for /. How do health checks work for the agent?

Copy link
Member

Choose a reason for hiding this comment

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

It looks for a 2XX status code on whatever URL viam-server gives as it's "serving" line during startup. Ex:

11/5/2024, 12:35:22 PM info rdk web/web.go:599 serving url https://artoo-main.p55vcc4g4x.local.viam.cloud:8080 alt_url https://0.0.0.0:8080

11/5/2024, 12:35:22 PM info viam-agent viamserver/viamserver.go:172 healthcheck URLs: https://artoo-main.p55vcc4g4x.local.viam.cloud:8080 https://localhost:8080

11/5/2024, 12:35:22 PM info viam-agent viamserver/viamserver.go:173 viam-server started

Basically agent sees that first line and parses it, and reports WHAT it parsed in that second line. Then it queries that every minute, looking for a 2XX http response (it doesn't care about the response body.)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Awesome! I added a 200 status and "healthy" message here: 596b486

@Otterverse are you able to verify that this works if I generate an AppImage?

Copy link
Member

Choose a reason for hiding this comment

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

Agent doesn't use appimages. Those are the "old" method. Just do a static binary make server-static and then you can test it yourself. You can copy the built file to your device (running agent) and set the pin_url for viam-server to file:///path/to/local/viam-server to let it run the new version. (You can also use a remote/public URL if you find that easier.)

Copy link
Member

Choose a reason for hiding this comment

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

I can try the same now too... will clone your branch and give it a whirl.

Copy link
Member

Choose a reason for hiding this comment

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

Okay, running a build from this branch, looks good!

2024-11-05T20:19:31.030Z	INFO	rdk	web/web.go:449	serving	{"url":"https://artoo-main.p55vcc4g4x.local.viam.cloud:8080","alt_url":"https://0.0.0.0:8080"}
2024-11-05T20:19:31.031Z	INFO	viam-agent	viamserver/viamserver.go:172	healthcheck URLs: https://artoo-main.p55vcc4g4x.local.viam.cloud:8080 https://localhost:8080

...

2024-11-05T20:20:34.390Z	DEBUG	viam-agent	viamserver/viamserver.go:290	healthcheck for viam-server is good
2024-11-05T20:20:34.391Z	DEBUG	viam-agent	agent/manager.go:233	Subsystem healthcheck succeeded for viam-server

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry for the delay here - thank you for taking a look! I am also going to try going through these steps for my understanding. Once I've confirmed that things are working as expected I'll move forward with the base PR and put this one up for explicit review.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sweet! I was able to verify this as well and everything is behaving as expected.

@ethanlookpotts ethanlookpotts added the appimage-ignore-tests Build AppImage of PR and ignore tests label Nov 5, 2024
Base automatically changed from APP-6785/ethanlookpotts/remove-web-workflows to main November 7, 2024 22:31
@ethanlookpotts ethanlookpotts force-pushed the APP-6785/ethanlookpotts/remove-rc branch from 596b486 to fefba9d Compare November 7, 2024 22:43
@viambot viambot added safe to test This pull request is marked safe to test from a trusted zone and removed safe to test This pull request is marked safe to test from a trusted zone labels Nov 7, 2024
@ethanlookpotts ethanlookpotts marked this pull request as ready for review November 7, 2024 22:44
@dgottlieb
Copy link
Member

We are removing RC from the RDK - users are now expected to use app.viam.com to control their machine.

So this breaks using localhost:8080 ? Is there some alternative workflow for robots using a "local FS" config?

@benjirewis
Copy link
Member

Was also looking @dgottlieb ; assume this is relevant https://viam.atlassian.net/wiki/spaces/ENG/pages/829587457/Local+control+page

@ethanlookpotts
Copy link
Contributor Author

Correct @dgottlieb, this breaks using localhost:8080. The confluence page that @benjirewis linked is how you can connect with cloud signaling, but not sure if it works in the "local FS" case. Trying now.

@dgottlieb
Copy link
Member

Thanks for that document link! But I'm not sure if that helps me? If I wanted to avoid using app, I don't think running a local app instance is the direction I was hoping for.

@ethanlookpotts
Copy link
Contributor Author

If I wanted to avoid using app, I don't think running a local app instance is the direction I was hoping for.

It doesn't run the whole local app instance - just the control tab, just like the page on localhost:8080 used to be. The code does live in the app repo, but you don't run the whole app. Acknowledged that it doesn't help OSS users, only our employees at the moment.

web/app_fs.go Show resolved Hide resolved
Comment on lines -96 to -105
type AppTemplateData struct {
WebRTCEnabled bool `json:"webrtc_enabled"`
WebRTCSignalingAddress string `json:"webrtc_signaling_address"`
Env string `json:"env"`
Host string `json:"host"`
StaticHost string `json:"static_host"`
SupportedAuthTypes []string `json:"supported_auth_types"`
AuthEntity string `json:"auth_entity"`
BakedAuth map[string]interface{} `json:"baked_auth"`
}
Copy link
Member

@randhid randhid Nov 8, 2024

Choose a reason for hiding this comment

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

can new local app handle no credentials passed, insecure, like the one you're deleting did?

I can not run rdk without credentials and use the sdks to connect to it with an insecure option, is this possible in the new world where we build "local" rc?

Copy link
Member

@zaporter-work zaporter-work Nov 8, 2024

Choose a reason for hiding this comment

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

Insecure connections haven't been built into the svelte-sdk. I can add them if it would be useful to you

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is what @dgottlieb is looking for as well - we need a small TS SDK change in order to provide this from the svelte-sdk (aka the new local control page). Opened here, and will also open the corresponding change against the svelte-sdk.

@ethanlookpotts
Copy link
Contributor Author

ethanlookpotts commented Nov 8, 2024

This is still ready for review but I will wait to merge it until we have the solution for the new local control page connecting insecurely to a local machine running a local config. (This PR will not make the next viam-server release.)

Copy link
Member

@dgottlieb dgottlieb left a comment

Choose a reason for hiding this comment

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

I saw the TS changes were merged. Would it be helpful for me to test run a local config with the new proposed flow?

@ethanlookpotts
Copy link
Contributor Author

ethanlookpotts commented Nov 12, 2024

I saw the TS changes were merged. Would it be helpful for me to test run a local config with the new proposed flow?

@dgottlieb Not quite yet, but soon! We need the TS SDK to be bumped in App (happening this afternoon) and then we can move forward with https://github.com/viamrobotics/app/pull/6824. Then I will update the instructions and ask you to test the new workflow for me! Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
appimage-ignore-tests Build AppImage of PR and ignore tests safe to test This pull request is marked safe to test from a trusted zone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants