feat: Bundle UI into coderd; add ./develop.sh script #28

bryphe-coder · 2022-01-15T01:35:30Z

This change bundles the static assets like we have for v1 - using the embed go package. Fixes #22

In addition, it sets up a development script that runs coderd locally and serves the front-end, with hot-reloading. The script used is v2-dev, which is in a devbin folder:

NOTE: Like coder/m, recommend adding ~/coder/devbin to the PATH

NOTE: The UI is still placeholder, of course. Need to start testing out a simple, placeholder flow for the new v2 world as a next step

Summary of changes:

Add build steps for go in the Makefile
- Add a step for production build, in which we use the embed tag
- Add a step for development, which doesn't need the embed tag - so we don't need to build the front-end twice
Add next export build step to output front-end artifacts in out
Add a site package for go
- Add embed_static.go and embed.go. This is mostly brought in as-is from v1, except removing some intercom/sentry CSP entries that we aren't using.
Add a next development server
Add a v2-dev script, that runs coderd and the next dev server side-by-side
Use the site package as the fallback handler.
Add .gitignore entries for additional build collateral

bryphe-coder · 2022-01-15T01:36:35Z

site/embed_static.go

+// The `embed` package ignores recursively including directories
+// that prefix with `_`. Wildcarding nested is janky, but seems to
+// work quite well for edge-cases.
+//go:embed out/_next/*/*/*/*
+//go:embed out/_next/*/*/*
+//go:embed out
+var site embed.FS


@kylecarbs - are you OK with using this same strategy for v2?

This is brought in mostly as-is from v1's embed_static.go , except for removing unnecessary CSP entries for sentry/intercom which aren't integrated yet.

I think we create a single .gitkeep in out/_next/static/chunks/pages/app. Then we don't need to do the build flag!

Apart from that, this looks great!

codecov · 2022-01-15T01:36:59Z

Codecov Report

Merging #28 (5441d0c) into main (5c49f1f) will decrease coverage by 0.40%.
The diff coverage is 70.32%.

@@            Coverage Diff             @@
##             main      #28      +/-   ##
==========================================
- Coverage   72.00%   71.60%   -0.41%     
==========================================
  Files          37       38       +1     
  Lines        1304     1486     +182     
  Branches        7        7              
==========================================
+ Hits          939     1064     +125     
- Misses        293      340      +47     
- Partials       72       82      +10

Flag	Coverage Δ
unittest-go-macos-latest	`65.16% <70.32%> (+0.92%)`	⬆️
unittest-go-ubuntu-latest	`70.54% <70.32%> (-1.15%)`	⬇️
unittest-go-windows-latest	`65.16% <70.32%> (+1.61%)`	⬆️
unittest-js	`71.01% <ø> (ø)`

Impacted Files	Coverage Δ
site/embed.go	`70.32% <70.32%> (ø)`
peer/conn.go	`76.14% <0.00%> (-0.92%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5c49f1f...5441d0c. Read the comment docs.

site/embed_static.go

site/scripts/dev.ts

Makefile

site/embed_static.go

kylecarbs · 2022-01-17T20:13:38Z

site/embed_static.go

+// The `embed` package ignores recursively including directories
+// that prefix with `_`. Wildcarding nested is janky, but seems to
+// work quite well for edge-cases.
+//go:embed out/_next/*/*/*/*
+//go:embed out/_next/*/*/*
+//go:embed out
+var site embed.FS


I think we create a single .gitkeep in out/_next/static/chunks/pages/app. Then we don't need to do the build flag!

Apart from that, this looks great!

site/embed_static.go

site/scripts/dev.ts

…mbed_static.go

Makefile

site/embed.go

.github/workflows/coder.yaml

site/embed.go

kylecarbs · 2022-01-18T15:29:29Z

devbin/v2-dev

+# Do initial build - a dev build for coderd.
+# It's OK that we don't build the front-end before - because the front-end
+# assets are handled by the `yarn dev` devserver.
+make bin/coderd


I'm hesitant to promote the devbin workflow in v2 until we need it. It became really unmaintainable in v1 due to poor scoping, so I'd prefer to punt this as long as possible.

Let's just have CODERV2_HOST default to :3000

This is pretty useful for developing the front-end - because you get a hot-reload on top of a live instance. I can just keep it local for now, though.

The main thing I want is to have a simple workflow for front-end developers jumping in - would your expectation be that they just run make bin/coderd; bin/coderd; and then open up yarn dev in a separate terminal?

I pushed up the change to default the port to 3000 here: d9c6aeb

I thought I commented on this, but I guess not!

Thoughts on having develop.sh at the root instead? It's required to contribute anyways, and then is very obvious to users.

Sounds great to me! Moved devbin/v2-dev -> develop.sh in 237f83e

kylecarbs

A few minor nits!

kylecarbs · 2022-01-18T18:00:36Z

.gitignore

+# Build
+bin/
+out/


Should this be site/out/?

Nice catch - indeed it should: 65d0145

kylecarbs · 2022-01-18T18:01:01Z

Makefile

+build: site/out bin/coderd
+.PHONY: build


We should keep these sorted in alphabetical order. I'll see if there's a Makefile linter we can use!

I've made the change locally for now in 8902599

kylecarbs · 2022-01-18T18:01:46Z

devbin/v2-dev

+# Do initial build - a dev build for coderd.
+# It's OK that we don't build the front-end before - because the front-end
+# assets are handled by the `yarn dev` devserver.
+make bin/coderd


I thought I commented on this, but I guess not!

Thoughts on having develop.sh at the root instead? It's required to contribute anyways, and then is very obvious to users.

site/scripts/dev.ts

bryphe-coder added 9 commits January 14, 2022 23:53

Add embedded static site route

e931b05

Remove unnecessary sentry/intercom integrations for now

e240cd7

Remove unused import

67feff7

Update dependencies

1dcdee7

Update v2-dev script

b516310

Add dev targets for v2

974df4e

Add dev scripts to proxy api

3aa80d6

Add descriptive comment for confusing bash incantation

c2f912a

Use v2-dev instead of v2-dev.sh for ease of use

b1fdb32

bryphe-coder self-assigned this Jan 15, 2022

bryphe-coder commented Jan 15, 2022

View reviewed changes

site/embed_static.go Outdated Show resolved Hide resolved

bryphe-coder commented Jan 15, 2022

View reviewed changes

site/scripts/dev.ts Outdated Show resolved Hide resolved

bryphe-coder added 2 commits January 15, 2022 01:48

Exclude dev scripts from coverage

dfc7cac

Add test case for embed static

6ade6a6

bryphe-coder commented Jan 15, 2022

View reviewed changes

Makefile Outdated Show resolved Hide resolved

bryphe-coder requested a review from kylecarbs January 17, 2022 18:18

Fix formatting of jest file

6aa66ac

kylecarbs requested changes Jan 17, 2022

View reviewed changes

bryphe-coder added 10 commits January 18, 2022 03:49

Use .gitkeep to preserve directory structure; replace embed.go with e…

ccce23a

…mbed_static.go

Update Makefile and .gitignore

9b770a6

Simplify proxy APIs for dev server

e8d6f76

Un-export several CSP types/constants that do not need to be exported

6fe167e

Add -tag=embed to the gotestsum command

7f79897

Formatting

735091e

Fix path of .gitkeep file

2b87738

Fix GITKEEP naming, so go embed doesn't ignore it

9fdefa5

Update v2-dev script for new Makefile targets / built binary path

0f3fe77

Actually add nested GITKEEP file

e3586aa

bryphe-coder added 3 commits January 18, 2022 04:39

Add build tags argument to golangci-lint

82397c0

Pin ts-node in package.json

8046586

Update lockfile

5ae703a

bryphe-coder requested a review from kylecarbs January 18, 2022 05:16

Remove introduced whitespace

93f8057

kylecarbs reviewed Jan 18, 2022

View reviewed changes

Makefile Outdated Show resolved Hide resolved

Makefile Outdated Show resolved Hide resolved

kylecarbs reviewed Jan 18, 2022

View reviewed changes

bryphe-coder added 3 commits January 18, 2022 15:36

Remove build/go; rename build/ui -> site/out

03a2945

Remove embed tag completely

974c654

Default CODERV2_HOST to local server on :3000

d9c6aeb

kylecarbs approved these changes Jan 18, 2022

View reviewed changes

bryphe-coder added 4 commits January 18, 2022 18:47

Move devbin/v2-dev -> develop.sh

237f83e

Move dev.ts from site/scripts -> site

3d42ef3

Properly .gitignore front-end site/out

65d0145

Sort Makefile targets

8902599

bryphe-coder changed the title ~~feat: Bundle UI into coderd; add v2-dev script~~ feat: Bundle UI into coderd; add ./develop.sh script Jan 18, 2022

bryphe-coder added 3 commits January 18, 2022 19:10

Fix dev.ts ignore path for code coverage

211be9f

Add missed prettierignore path

be9e302

Alphabetize jest.config.js ignore paths

5441d0c

bryphe-coder merged commit 4dc6e35 into main Jan 18, 2022

bryphe-coder deleted the bryphe/feat/bundle-ui branch January 18, 2022 21:13

ketang unassigned bryphe-coder Mar 22, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Bundle UI into coderd; add ./develop.sh script #28

feat: Bundle UI into coderd; add ./develop.sh script #28

bryphe-coder commented Jan 15, 2022 •

edited

bryphe-coder Jan 15, 2022

kylecarbs Jan 17, 2022

codecov bot commented Jan 15, 2022 •

edited

kylecarbs Jan 17, 2022

kylecarbs Jan 18, 2022

kylecarbs Jan 18, 2022

bryphe-coder Jan 18, 2022

bryphe-coder Jan 18, 2022

kylecarbs Jan 18, 2022

bryphe-coder Jan 18, 2022

kylecarbs left a comment

kylecarbs Jan 18, 2022

bryphe-coder Jan 18, 2022

kylecarbs Jan 18, 2022

bryphe-coder Jan 18, 2022

kylecarbs Jan 18, 2022

feat: Bundle UI into coderd; add ./develop.sh script #28

feat: Bundle UI into coderd; add ./develop.sh script #28

Conversation

bryphe-coder commented Jan 15, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Jan 15, 2022 • edited

Codecov Report

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

kylecarbs left a 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

bryphe-coder commented Jan 15, 2022 •

edited

codecov bot commented Jan 15, 2022 •

edited