-
Notifications
You must be signed in to change notification settings - Fork 513
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add auto-reloading for html render (#207)
Co-authored-by: byene0923 <[email protected]>
- Loading branch information
1 parent
510696f
commit 9c4d0da
Showing
12 changed files
with
365 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| <html> | ||
| <h1> | ||
| {[{ .title }]} | ||
| </h1> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| /* | ||
| * Copyright 2022 CloudWeGo Authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "html/template" | ||
| "time" | ||
|
|
||
| "github.com/cloudwego/hertz/pkg/app" | ||
| "github.com/cloudwego/hertz/pkg/app/server" | ||
| "github.com/cloudwego/hertz/pkg/common/utils" | ||
| "github.com/cloudwego/hertz/pkg/protocol/consts" | ||
| ) | ||
|
|
||
| func formatAsDate(t time.Time) string { | ||
| year, month, day := t.Date() | ||
| return fmt.Sprintf("%d/%02d/%02d", year, month, day) | ||
| } | ||
|
|
||
| func main() { | ||
| // set interval to 0 means using fs-watching mechanism. | ||
| h := server.Default(server.WithAutoReloadRender(true, 0)) | ||
|
|
||
| h.Delims("{[{", "}]}") | ||
|
|
||
| h.SetFuncMap(template.FuncMap{ | ||
| "formatAsDate": formatAsDate, | ||
| }) | ||
| h.LoadHTMLGlob("./examples/html_rendering/*") | ||
|
|
||
| h.GET("/index", func(c context.Context, ctx *app.RequestContext) { | ||
| ctx.HTML(consts.StatusOK, "index.tmpl", utils.H{ | ||
| "title": "Main website", | ||
| }) | ||
| }) | ||
|
|
||
| h.GET("/raw", func(c context.Context, ctx *app.RequestContext) { | ||
| ctx.HTML(consts.StatusOK, "template.html", utils.H{ | ||
| "now": time.Date(2017, 0o7, 0o1, 0, 0, 0, 0, time.UTC), | ||
| }) | ||
| }) | ||
|
|
||
| h.Spin() | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| <h1>Date: {[{.now | formatAsDate}]}</h1> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| /* | ||
| * Copyright 2022 CloudWeGo Authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package render | ||
|
|
||
| import ( | ||
| "os" | ||
| "testing" | ||
| "time" | ||
| ) | ||
|
|
||
| func TestHTMLDebug_StartChecker_timer(t *testing.T) { | ||
| render := &HTMLDebug{RefreshInterval: 2 * time.Second} | ||
| select { | ||
| case <-render.reloadCh: | ||
| t.Fatalf("should not be triggered") | ||
| default: | ||
| } | ||
| render.startChecker() | ||
| select { | ||
| case <-time.After(50 * time.Millisecond): | ||
| t.Fatalf("should be triggered immediately") | ||
| case <-render.reloadCh: | ||
|
|
||
| } | ||
| select { | ||
| // some ci servers have poor computing power, so we add some extra time here. | ||
| case <-time.After(2*time.Second + 50*time.Millisecond): | ||
| t.Fatalf("should be triggered before 2 seconds") | ||
| case <-render.reloadCh: | ||
| t.Logf("paas") | ||
| } | ||
| } | ||
|
|
||
| func TestHTMLDebug_StartChecker_fs_watcher(t *testing.T) { | ||
| f, _ := os.CreateTemp("./", "test.tmpl") | ||
| defer func() { | ||
| f.Close() | ||
| os.Remove(f.Name()) | ||
| }() | ||
| render := &HTMLDebug{Files: []string{f.Name()}} | ||
| select { | ||
| case <-render.reloadCh: | ||
| t.Fatalf("should not be triggered") | ||
| default: | ||
| } | ||
| render.startChecker() | ||
| f.Write([]byte("hello")) | ||
|
|
||
| select { | ||
| case <-time.After(50 * time.Millisecond): | ||
| t.Fatalf("should be triggered immediately") | ||
| case <-render.reloadCh: | ||
| } | ||
| select { | ||
| case <-render.reloadCh: | ||
| t.Fatalf("should not be triggered") | ||
| default: | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.