feat: Playground #1575

nasdf · 2023-06-13T21:07:49Z

Relevant issue(s)

Resolves #884

Description

This PR adds a web based playground to DefraDB.

To use the embedded playground run the following.

# build playground
make deps:playground

# enable embedded playground
export BUILD_TAGS=playground

make start
# or 
make build

The playground is served from the same port as the API: http://localhost:9181

View & query DefraDB types
Create & patch schemas
Relational field support
Embed playground in binary

Tasks

I made sure the code is well commented, particularly hard-to-understand areas.
I made sure the repository-held documentation is changed accordingly.
I made sure the pull request title adheres to the conventional commit style (the subset used in the project can be found in tools/configs/chglog/config.yml).
I made sure to discuss its limitations such as threats to validity, vulnerability to mistake and misuse, robustness to invalidation of assumptions, resource requirements, ...

How has this been tested?

Testing was done manually.

Specify the platform(s) on which this was tested:

MacOS

…ma list api response

codecov · 2023-07-14T18:33:24Z

Codecov Report

Patch coverage: 93.62% and project coverage change: -0.02 ⚠️

Comparison is base (49bced3) 74.92% compared to head (fccf857) 74.90%.

@@             Coverage Diff             @@
##           develop    #1575      +/-   ##
===========================================
- Coverage    74.92%   74.90%   -0.02%     
===========================================
  Files          203      203              
  Lines        21072    21072              
===========================================
- Hits         15787    15782       -5     
- Misses        4207     4210       +3     
- Partials      1078     1080       +2

Flag	Coverage Δ
all-tests	`74.90% <93.62%> (-0.02%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
cli/schema_list.go	`14.29% <0.00%> (-0.42%)`	⬇️
api/http/handler.go	`100.00% <100.00%> (ø)`
api/http/handlerfuncs.go	`70.77% <100.00%> (-0.08%)`	⬇️
api/http/router.go	`100.00% <100.00%> (ø)`
client/descriptions.go	`73.68% <100.00%> (+0.71%)`	⬆️

... and 4 files with indirect coverage changes

Continue to review full report in Codecov by Sentry.

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

fredcarle · 2023-07-17T18:57:03Z

api/http/router.go

-	h.Mux = chi.NewRouter()
+var router = chi.NewRouter()

-	// setup CORS
-	if len(h.options.allowedOrigins) != 0 {
-		h.Use(cors.Handler(cors.Options{
-			AllowedOrigins: h.options.allowedOrigins,
-			AllowedMethods: []string{"GET", "POST", "OPTIONS"},
-			AllowedHeaders: []string{"Content-Type"},
-			MaxAge:         300,
-		}))
-	}
-
-	// setup logger middleware
-	h.Use(loggerMiddleware)
-
-	// define routes
-	h.Get(RootPath, h.handle(rootHandler))
-	h.Get(PingPath, h.handle(pingHandler))
-	h.Get(DumpPath, h.handle(dumpHandler))
-	h.Get(BlocksPath+"/{cid}", h.handle(getBlockHandler))
-	h.Get(GraphQLPath, h.handle(execGQLHandler))
-	h.Post(GraphQLPath, h.handle(execGQLHandler))
-	h.Get(SchemaPath, h.handle(listSchemaHandler))
-	h.Post(SchemaPath, h.handle(loadSchemaHandler))
-	h.Patch(SchemaPath, h.handle(patchSchemaHandler))
-	h.Post(IndexPath, h.handle(createIndexHandler))
-	h.Delete(IndexPath, h.handle(dropIndexHandler))
-	h.Get(IndexPath, h.handle(listIndexHandler))
-	h.Get(PeerIDPath, h.handle(peerIDHandler))
-
-	return h
+func init() {
+	router.Get(RootPath, rootHandler)
+	router.Get(PingPath, pingHandler)
+	router.Get(DumpPath, dumpHandler)
+	router.Get(BlocksPath+"/{cid}", getBlockHandler)
+	router.Get(GraphQLPath, execGQLHandler)
+	router.Post(GraphQLPath, execGQLHandler)
+	router.Get(SchemaPath, listSchemaHandler)
+	router.Post(SchemaPath, loadSchemaHandler)
+	router.Patch(SchemaPath, patchSchemaHandler)
+	router.Post(IndexPath, createIndexHandler)
+	router.Delete(IndexPath, dropIndexHandler)
+	router.Get(IndexPath, listIndexHandler)
+	router.Get(PeerIDPath, peerIDHandler)


thought: I'm not a big fan of a global var router and setting the routes on package init. I think it would be better for future maintenance (and other beneficial reasons) to keep this under the setRoutes function. Although you can simply return the router.

That being said, I like how you moved the handle method to a middleware and that it avoids wrapping the handlers in the handle method.

playground.go:init can also be moved inside the setRoutes function.

I wanted to keep the setRoutes method but I couldn't think of another way to do build time route registration. I'm using the playground.go:init function because the playground can be enabled/disabled using the build tag. I'm happy to move everything back if we can think of an alternative that works with build tags.

You could create a global withPlayground variable in router.go and set in to true in the init inside playground.go. You can then have a if block in the setRoutes function to act accordingly.

Thanks! My brain was stuck on that for a while. I think I came up with a good solution. The route registration is moved back to setRoutes and the playground handler is set at build time via init. I made sure it works when not including the playground as well.

shahzadlone · 2023-07-17T19:19:52Z

api/http/playground.go

@@ -0,0 +1,18 @@
+//go:build playground


todo: Should add a copyright header (I am also wondering why the linter didn't complain about the copyright header)

Maybe due to the build tag here? I'm not exactly sure either.

playground/playground.go

playground/src/App.tsx

playground/src/components/Plugin.tsx

playground/src/components/SchemaLoadForm.tsx

playground/src/components/SchemaPatchForm.tsx

playground/src/index.css

fredcarle

Good job with this Keenan! I actually played around with the playground this morning and it's working quite well. Specially for a first iteration of it.

## Relevant issue(s) Resolves sourcenetwork#884 ## Description This PR adds a web based playground to DefraDB. To use the embedded playground run the following. ``` # build playground make deps:playground # enable embedded playground export BUILD_TAGS=playground make start # or make build ``` The playground is served from the same port as the API: `http://localhost:9181` - [x] View & query DefraDB types - [x] Create & patch schemas - [x] Relational field support - [x] Embed playground in binary ![localhost_5173_](https://github.com/sourcenetwork/defradb/assets/1862560/8ad8bd53-eadf-40bc-9204-6c821b0b13d2) ## Tasks - [x] I made sure the code is well commented, particularly hard-to-understand areas. - [x] I made sure the repository-held documentation is changed accordingly. - [x] I made sure the pull request title adheres to the conventional commit style (the subset used in the project can be found in [tools/configs/chglog/config.yml](tools/configs/chglog/config.yml)). - [x] I made sure to discuss its limitations such as threats to validity, vulnerability to mistake and misuse, robustness to invalidation of assumptions, resource requirements, ... ## How has this been tested? Testing was done manually. Specify the platform(s) on which this was tested: - MacOS

nasdf added 10 commits June 12, 2023 14:38

initial playground project setup

7b7997e

basic load schema working

5eb9af2

add list schema route

3665c3f

schema patch working

3121911

fix bug with Integer types on load

f8d2fd2

add readme

c447e2b

Merge branch 'develop' into feature/playground

665e51e

update playground for new schema list api. add internal field to sche…

2e51ffa

…ma list api response

Merge branch 'develop' into feature/playground

5062964

simplify schema create form

e8dc3d9

nasdf added 3 commits July 14, 2023 13:14

move http route registration to init. add embed logic for playground

ff4ef91

move build commands to Makefile

6975345

fix Makefile

a4e066b

nasdf marked this pull request as ready for review July 17, 2023 17:31

nasdf requested a review from a team July 17, 2023 17:32

fredcarle reviewed Jul 17, 2023

View reviewed changes

shahzadlone reviewed Jul 17, 2023

View reviewed changes

shahzadlone assigned nasdf Jul 17, 2023

fredcarle added feature New feature or request area/api Related to the external API component labels Jul 18, 2023

fredcarle added this to the DefraDB v0.6 milestone Jul 18, 2023

nasdf and others added 4 commits July 18, 2023 14:01

add missing source license headers

2da7a84

move api routes back to setRoutes function.

62555a1

Merge branch 'develop' into feature/playground

1eb92ab

add missing import in api handlerfuncs

fccf857

nasdf requested a review from a team July 19, 2023 15:50

fredcarle approved these changes Jul 19, 2023

View reviewed changes

nasdf merged commit b95c931 into sourcenetwork:develop Jul 19, 2023
10 checks passed

nasdf deleted the feature/playground branch July 19, 2023 16:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Playground #1575

feat: Playground #1575

nasdf commented Jun 13, 2023 •

edited

codecov bot commented Jul 14, 2023 •

edited

fredcarle Jul 17, 2023

fredcarle Jul 17, 2023

nasdf Jul 18, 2023

fredcarle Jul 18, 2023

nasdf Jul 18, 2023

shahzadlone Jul 17, 2023

nasdf Jul 18, 2023

fredcarle left a comment

feat: Playground #1575

feat: Playground #1575

Conversation

nasdf commented Jun 13, 2023 • edited

Relevant issue(s)

Description

Tasks

How has this been tested?

codecov bot commented Jul 14, 2023 • edited

Codecov Report

fredcarle Jul 17, 2023

Choose a reason for hiding this comment

fredcarle Jul 17, 2023

Choose a reason for hiding this comment

nasdf Jul 18, 2023

Choose a reason for hiding this comment

fredcarle Jul 18, 2023

Choose a reason for hiding this comment

nasdf Jul 18, 2023

Choose a reason for hiding this comment

shahzadlone Jul 17, 2023

Choose a reason for hiding this comment

nasdf Jul 18, 2023

Choose a reason for hiding this comment

fredcarle left a comment

Choose a reason for hiding this comment

nasdf commented Jun 13, 2023 •

edited

codecov bot commented Jul 14, 2023 •

edited