Compare commits
2 Commits
792707cd70
...
a382f1da69
Author | SHA1 | Date | |
---|---|---|---|
a382f1da69 | |||
ef719f74da |
@ -42,7 +42,6 @@ func BuildRouter(c *services.Container) error {
|
|||||||
}),
|
}),
|
||||||
middleware.Session(sessions.NewCookieStore([]byte(c.Config.App.EncryptionKey))),
|
middleware.Session(sessions.NewCookieStore([]byte(c.Config.App.EncryptionKey))),
|
||||||
middleware.LoadAuthenticatedUser(c.Auth),
|
middleware.LoadAuthenticatedUser(c.Auth),
|
||||||
middleware.ServeCachedPage(c.TemplateRenderer),
|
|
||||||
echomw.CSRFWithConfig(echomw.CSRFConfig{
|
echomw.CSRFWithConfig(echomw.CSRFConfig{
|
||||||
TokenLookup: "form:csrf",
|
TokenLookup: "form:csrf",
|
||||||
}),
|
}),
|
||||||
|
@ -1,64 +1,12 @@
|
|||||||
package middleware
|
package middleware
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"errors"
|
|
||||||
"fmt"
|
"fmt"
|
||||||
"net/http"
|
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/labstack/echo/v4"
|
"github.com/labstack/echo/v4"
|
||||||
|
|
||||||
"git.grosinger.net/tgrosinger/saasitone/pkg/context"
|
|
||||||
"git.grosinger.net/tgrosinger/saasitone/pkg/log"
|
|
||||||
"git.grosinger.net/tgrosinger/saasitone/pkg/services"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// ServeCachedPage attempts to load a page from the cache by matching on the complete request URL
|
|
||||||
// If a page is cached for the requested URL, it will be served here and the request terminated.
|
|
||||||
// Any request made by an authenticated user or that is not a GET will be skipped.
|
|
||||||
func ServeCachedPage(t *services.TemplateRenderer) echo.MiddlewareFunc {
|
|
||||||
return func(next echo.HandlerFunc) echo.HandlerFunc {
|
|
||||||
return func(ctx echo.Context) error {
|
|
||||||
// Skip non GET requests
|
|
||||||
if ctx.Request().Method != http.MethodGet {
|
|
||||||
return next(ctx)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Skip if the user is authenticated
|
|
||||||
if ctx.Get(context.AuthenticatedUserKey) != nil {
|
|
||||||
return next(ctx)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Attempt to load from cache
|
|
||||||
page, err := t.GetCachedPage(ctx, ctx.Request().URL.String())
|
|
||||||
if err != nil {
|
|
||||||
switch {
|
|
||||||
case errors.Is(err, services.ErrCacheMiss):
|
|
||||||
case context.IsCanceledError(err):
|
|
||||||
return nil
|
|
||||||
default:
|
|
||||||
log.Ctx(ctx).Error("failed getting cached page",
|
|
||||||
"error", err,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
return next(ctx)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Set any headers
|
|
||||||
if page.Headers != nil {
|
|
||||||
for k, v := range page.Headers {
|
|
||||||
ctx.Response().Header().Set(k, v)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
log.Ctx(ctx).Debug("serving cached page")
|
|
||||||
|
|
||||||
return ctx.HTMLBlob(page.StatusCode, page.HTML)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// CacheControl sets a Cache-Control header with a given max age
|
// CacheControl sets a Cache-Control header with a given max age
|
||||||
func CacheControl(maxAge time.Duration) echo.MiddlewareFunc {
|
func CacheControl(maxAge time.Duration) echo.MiddlewareFunc {
|
||||||
return func(next echo.HandlerFunc) echo.HandlerFunc {
|
return func(next echo.HandlerFunc) echo.HandlerFunc {
|
||||||
|
@ -1,51 +1,14 @@
|
|||||||
package middleware
|
package middleware
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"net/http"
|
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/stretchr/testify/require"
|
|
||||||
|
|
||||||
"git.grosinger.net/tgrosinger/saasitone/pkg/page"
|
|
||||||
"git.grosinger.net/tgrosinger/saasitone/pkg/tests"
|
"git.grosinger.net/tgrosinger/saasitone/pkg/tests"
|
||||||
"git.grosinger.net/tgrosinger/saasitone/templates"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestServeCachedPage(t *testing.T) {
|
|
||||||
// Cache a page
|
|
||||||
ctx, rec := tests.NewContext(c.Web, "/cache")
|
|
||||||
p := page.New(ctx)
|
|
||||||
p.Layout = templates.LayoutHTMX
|
|
||||||
p.Name = templates.PageHome
|
|
||||||
p.Cache.Enabled = true
|
|
||||||
p.Cache.Expiration = time.Minute
|
|
||||||
p.StatusCode = http.StatusCreated
|
|
||||||
p.Headers["a"] = "b"
|
|
||||||
p.Headers["c"] = "d"
|
|
||||||
err := c.TemplateRenderer.RenderPage(ctx, p)
|
|
||||||
output := rec.Body.Bytes()
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
// Request the URL of the cached page
|
|
||||||
ctx, rec = tests.NewContext(c.Web, "/cache")
|
|
||||||
err = tests.ExecuteMiddleware(ctx, ServeCachedPage(c.TemplateRenderer))
|
|
||||||
assert.NoError(t, err)
|
|
||||||
assert.Equal(t, p.StatusCode, ctx.Response().Status)
|
|
||||||
assert.Equal(t, p.Headers["a"], ctx.Response().Header().Get("a"))
|
|
||||||
assert.Equal(t, p.Headers["c"], ctx.Response().Header().Get("c"))
|
|
||||||
assert.Equal(t, output, rec.Body.Bytes())
|
|
||||||
|
|
||||||
// Login and try again
|
|
||||||
tests.InitSession(ctx)
|
|
||||||
err = c.Auth.Login(ctx, usr.ID)
|
|
||||||
require.NoError(t, err)
|
|
||||||
_ = tests.ExecuteMiddleware(ctx, LoadAuthenticatedUser(c.Auth))
|
|
||||||
err = tests.ExecuteMiddleware(ctx, ServeCachedPage(c.TemplateRenderer))
|
|
||||||
assert.Nil(t, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestCacheControl(t *testing.T) {
|
func TestCacheControl(t *testing.T) {
|
||||||
ctx, _ := tests.NewContext(c.Web, "/")
|
ctx, _ := tests.NewContext(c.Web, "/")
|
||||||
_ = tests.ExecuteMiddleware(ctx, CacheControl(time.Second*5))
|
_ = tests.ExecuteMiddleware(ctx, CacheControl(time.Second*5))
|
||||||
|
@ -1,4 +1,4 @@
|
|||||||
package services
|
package models
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"database/sql"
|
"database/sql"
|
||||||
@ -13,7 +13,7 @@ type Post struct {
|
|||||||
}
|
}
|
||||||
|
|
||||||
type DBPostClient struct {
|
type DBPostClient struct {
|
||||||
db *sql.DB
|
DB *sql.DB
|
||||||
}
|
}
|
||||||
|
|
||||||
// FetchAll is an mock example of fetching posts to illustrate how paging works
|
// FetchAll is an mock example of fetching posts to illustrate how paging works
|
@ -1,9 +1,9 @@
|
|||||||
package services
|
package models
|
||||||
|
|
||||||
import "database/sql"
|
import "database/sql"
|
||||||
|
|
||||||
// UserClient is a struct that can be used to create custom methods for
|
// UserClient is a struct that can be used to create custom methods for
|
||||||
// interacting with users in the database.
|
// interacting with users in the database.
|
||||||
type DBUserClient struct {
|
type DBUserClient struct {
|
||||||
db *sql.DB
|
DB *sql.DB
|
||||||
}
|
}
|
@ -52,11 +52,6 @@ type Page struct {
|
|||||||
// messages and markup presented to the user
|
// messages and markup presented to the user
|
||||||
Form any
|
Form any
|
||||||
|
|
||||||
// Layout stores the name of the layout base template file which will be used when the page is rendered.
|
|
||||||
// This should match a template file located within the layouts directory inside the templates directory.
|
|
||||||
// The template extension should not be included in this value.
|
|
||||||
Layout templates.Layout
|
|
||||||
|
|
||||||
LayoutComponent func(content templ.Component) templ.Component
|
LayoutComponent func(content templ.Component) templ.Component
|
||||||
|
|
||||||
// Name stores the name of the page as well as the name of the template file which will be used to render
|
// Name stores the name of the page as well as the name of the template file which will be used to render
|
||||||
|
@ -10,6 +10,7 @@ import (
|
|||||||
"github.com/golang-migrate/migrate/v4/source/file"
|
"github.com/golang-migrate/migrate/v4/source/file"
|
||||||
|
|
||||||
"git.grosinger.net/tgrosinger/saasitone/config"
|
"git.grosinger.net/tgrosinger/saasitone/config"
|
||||||
|
"git.grosinger.net/tgrosinger/saasitone/pkg/models"
|
||||||
"git.grosinger.net/tgrosinger/saasitone/pkg/models/sqlc"
|
"git.grosinger.net/tgrosinger/saasitone/pkg/models/sqlc"
|
||||||
)
|
)
|
||||||
|
|
||||||
@ -17,8 +18,8 @@ type DBClient struct {
|
|||||||
db *sql.DB
|
db *sql.DB
|
||||||
C *sqlc.Queries
|
C *sqlc.Queries
|
||||||
|
|
||||||
User *DBUserClient
|
User *models.DBUserClient
|
||||||
Post *DBPostClient
|
Post *models.DBPostClient
|
||||||
}
|
}
|
||||||
|
|
||||||
func NewDBClient(cfg *config.Config) (*DBClient, error) {
|
func NewDBClient(cfg *config.Config) (*DBClient, error) {
|
||||||
@ -43,8 +44,8 @@ func NewDBClient(cfg *config.Config) (*DBClient, error) {
|
|||||||
db: db,
|
db: db,
|
||||||
C: sqlc.New(db),
|
C: sqlc.New(db),
|
||||||
}
|
}
|
||||||
client.User = &DBUserClient{db: db}
|
client.User = &models.DBUserClient{DB: db}
|
||||||
client.Post = &DBPostClient{db: db}
|
client.Post = &models.DBPostClient{DB: db}
|
||||||
|
|
||||||
migrationsDirPath := cfg.Storage.MigrationsDir
|
migrationsDirPath := cfg.Storage.MigrationsDir
|
||||||
logger.Info("Loading schema migrations",
|
logger.Info("Loading schema migrations",
|
||||||
|
@ -13,8 +13,6 @@ import (
|
|||||||
"github.com/labstack/echo/v4"
|
"github.com/labstack/echo/v4"
|
||||||
|
|
||||||
"git.grosinger.net/tgrosinger/saasitone/config"
|
"git.grosinger.net/tgrosinger/saasitone/config"
|
||||||
"git.grosinger.net/tgrosinger/saasitone/pkg/context"
|
|
||||||
"git.grosinger.net/tgrosinger/saasitone/pkg/log"
|
|
||||||
"git.grosinger.net/tgrosinger/saasitone/pkg/page"
|
"git.grosinger.net/tgrosinger/saasitone/pkg/page"
|
||||||
"git.grosinger.net/tgrosinger/saasitone/templates"
|
"git.grosinger.net/tgrosinger/saasitone/templates"
|
||||||
)
|
)
|
||||||
@ -137,141 +135,9 @@ func (t *TemplateRenderer) RenderPageTempl(ctx echo.Context, page page.Page, con
|
|||||||
page.HTMX.Response.Apply(ctx)
|
page.HTMX.Response.Apply(ctx)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Cache this page, if caching was enabled
|
|
||||||
t.cachePage(ctx, page, &buf)
|
|
||||||
|
|
||||||
return ctx.HTMLBlob(ctx.Response().Status, buf.Bytes())
|
return ctx.HTMLBlob(ctx.Response().Status, buf.Bytes())
|
||||||
}
|
}
|
||||||
|
|
||||||
// RenderPage renders a Page as an HTTP response
|
|
||||||
func (t *TemplateRenderer) RenderPage(ctx echo.Context, page page.Page) error {
|
|
||||||
var buf *bytes.Buffer
|
|
||||||
var err error
|
|
||||||
templateGroup := "page"
|
|
||||||
|
|
||||||
// Page name is required
|
|
||||||
if page.Name == "" {
|
|
||||||
return echo.NewHTTPError(http.StatusInternalServerError, "page render failed due to missing name")
|
|
||||||
}
|
|
||||||
|
|
||||||
// Use the app name in configuration if a value was not set
|
|
||||||
if page.AppName == "" {
|
|
||||||
page.AppName = t.config.App.Name
|
|
||||||
}
|
|
||||||
|
|
||||||
// Check if this is an HTMX non-boosted request which indicates that only partial
|
|
||||||
// content should be rendered
|
|
||||||
if page.HTMX.Request.Enabled && !page.HTMX.Request.Boosted {
|
|
||||||
// Switch the layout which will only render the page content
|
|
||||||
page.Layout = templates.LayoutHTMX
|
|
||||||
|
|
||||||
// Alter the template group so this is cached separately
|
|
||||||
templateGroup = "page:htmx"
|
|
||||||
}
|
|
||||||
|
|
||||||
// Parse and execute the templates for the Page
|
|
||||||
// As mentioned in the documentation for the Page struct, the templates used for the page will be:
|
|
||||||
// 1. The layout/base template specified in Page.Layout
|
|
||||||
// 2. The content template specified in Page.Name
|
|
||||||
// 3. All templates within the components directory
|
|
||||||
// Also included is the function map provided by the funcmap package
|
|
||||||
buf, err = t.
|
|
||||||
Parse().
|
|
||||||
Group(templateGroup).
|
|
||||||
Key(string(page.Name)).
|
|
||||||
Base(string(page.Layout)).
|
|
||||||
Files(
|
|
||||||
fmt.Sprintf("layouts/%s", page.Layout),
|
|
||||||
fmt.Sprintf("pages/%s", page.Name),
|
|
||||||
).
|
|
||||||
Directories("components").
|
|
||||||
Execute(page)
|
|
||||||
if err != nil {
|
|
||||||
return echo.NewHTTPError(
|
|
||||||
http.StatusInternalServerError,
|
|
||||||
fmt.Sprintf("failed to parse and execute templates: %s", err),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Set the status code
|
|
||||||
ctx.Response().Status = page.StatusCode
|
|
||||||
|
|
||||||
// Set any headers
|
|
||||||
for k, v := range page.Headers {
|
|
||||||
ctx.Response().Header().Set(k, v)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Apply the HTMX response, if one
|
|
||||||
if page.HTMX.Response != nil {
|
|
||||||
page.HTMX.Response.Apply(ctx)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Cache this page, if caching was enabled
|
|
||||||
t.cachePage(ctx, page, buf)
|
|
||||||
|
|
||||||
return ctx.HTMLBlob(ctx.Response().Status, buf.Bytes())
|
|
||||||
}
|
|
||||||
|
|
||||||
// cachePage caches the HTML for a given Page if the Page has caching enabled
|
|
||||||
func (t *TemplateRenderer) cachePage(ctx echo.Context, page page.Page, html *bytes.Buffer) {
|
|
||||||
if !page.Cache.Enabled || page.IsAuth {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// If no expiration time was provided, default to the configuration value
|
|
||||||
if page.Cache.Expiration == 0 {
|
|
||||||
page.Cache.Expiration = t.config.Cache.Expiration.Page
|
|
||||||
}
|
|
||||||
|
|
||||||
// Extract the headers
|
|
||||||
headers := make(map[string]string)
|
|
||||||
for k, v := range ctx.Response().Header() {
|
|
||||||
headers[k] = v[0]
|
|
||||||
}
|
|
||||||
|
|
||||||
// The request URL is used as the cache key so the middleware can serve the
|
|
||||||
// cached page on matching requests
|
|
||||||
key := ctx.Request().URL.String()
|
|
||||||
cp := &CachedPage{
|
|
||||||
URL: key,
|
|
||||||
HTML: html.Bytes(),
|
|
||||||
Headers: headers,
|
|
||||||
StatusCode: ctx.Response().Status,
|
|
||||||
}
|
|
||||||
|
|
||||||
err := t.cache.
|
|
||||||
Set().
|
|
||||||
Group(cachedPageGroup).
|
|
||||||
Key(key).
|
|
||||||
Tags(page.Cache.Tags...).
|
|
||||||
Expiration(page.Cache.Expiration).
|
|
||||||
Data(cp).
|
|
||||||
Save(ctx.Request().Context())
|
|
||||||
|
|
||||||
switch {
|
|
||||||
case err == nil:
|
|
||||||
log.Ctx(ctx).Debug("cached page")
|
|
||||||
case !context.IsCanceledError(err):
|
|
||||||
log.Ctx(ctx).Error("failed to cache page",
|
|
||||||
"error", err,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetCachedPage attempts to fetch a cached page for a given URL
|
|
||||||
func (t *TemplateRenderer) GetCachedPage(ctx echo.Context, url string) (*CachedPage, error) {
|
|
||||||
p, err := t.cache.
|
|
||||||
Get().
|
|
||||||
Group(cachedPageGroup).
|
|
||||||
Key(url).
|
|
||||||
Fetch(ctx.Request().Context())
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return p.(*CachedPage), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// getCacheKey gets a cache key for a given group and ID
|
// getCacheKey gets a cache key for a given group and ID
|
||||||
func (t *TemplateRenderer) getCacheKey(group, key string) string {
|
func (t *TemplateRenderer) getCacheKey(group, key string) string {
|
||||||
if group != "" {
|
if group != "" {
|
||||||
|
@ -1,21 +1,22 @@
|
|||||||
package services
|
package services
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/http/httptest"
|
"net/http/httptest"
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
|
"github.com/a-h/templ"
|
||||||
"github.com/labstack/echo/v4"
|
"github.com/labstack/echo/v4"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
"git.grosinger.net/tgrosinger/saasitone/config"
|
"git.grosinger.net/tgrosinger/saasitone/config"
|
||||||
"git.grosinger.net/tgrosinger/saasitone/pkg/htmx"
|
"git.grosinger.net/tgrosinger/saasitone/pkg/htmx"
|
||||||
|
"git.grosinger.net/tgrosinger/saasitone/pkg/models"
|
||||||
"git.grosinger.net/tgrosinger/saasitone/pkg/page"
|
"git.grosinger.net/tgrosinger/saasitone/pkg/page"
|
||||||
"git.grosinger.net/tgrosinger/saasitone/pkg/tests"
|
"git.grosinger.net/tgrosinger/saasitone/pkg/tests"
|
||||||
"git.grosinger.net/tgrosinger/saasitone/templates"
|
"git.grosinger.net/tgrosinger/saasitone/templ/layouts"
|
||||||
|
"git.grosinger.net/tgrosinger/saasitone/templ/pages"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestTemplateRenderer(t *testing.T) {
|
func TestTemplateRenderer(t *testing.T) {
|
||||||
@ -31,9 +32,8 @@ func TestTemplateRenderer(t *testing.T) {
|
|||||||
Parse().
|
Parse().
|
||||||
Group(group).
|
Group(group).
|
||||||
Key(id).
|
Key(id).
|
||||||
Base("htmx").
|
Base("test").
|
||||||
Files("layouts/htmx", "pages/error").
|
Files("emails/test").
|
||||||
Directories("components").
|
|
||||||
Store()
|
Store()
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
@ -43,13 +43,7 @@ func TestTemplateRenderer(t *testing.T) {
|
|||||||
|
|
||||||
// Check that all expected templates are included
|
// Check that all expected templates are included
|
||||||
expectedTemplates := make(map[string]bool)
|
expectedTemplates := make(map[string]bool)
|
||||||
expectedTemplates["htmx"+config.TemplateExt] = true
|
expectedTemplates["test"+config.TemplateExt] = true
|
||||||
expectedTemplates["error"+config.TemplateExt] = true
|
|
||||||
components, err := templates.Get().ReadDir("components")
|
|
||||||
require.NoError(t, err)
|
|
||||||
for _, f := range components {
|
|
||||||
expectedTemplates[f.Name()] = true
|
|
||||||
}
|
|
||||||
for _, v := range parsed.Template.Templates() {
|
for _, v := range parsed.Template.Templates() {
|
||||||
delete(expectedTemplates, v.Name())
|
delete(expectedTemplates, v.Name())
|
||||||
}
|
}
|
||||||
@ -63,20 +57,19 @@ func TestTemplateRenderer(t *testing.T) {
|
|||||||
buf, err := tpl.Execute(data)
|
buf, err := tpl.Execute(data)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
require.NotNil(t, buf)
|
require.NotNil(t, buf)
|
||||||
assert.Contains(t, buf.String(), "Please try again")
|
assert.Contains(t, buf.String(), "Test email template")
|
||||||
|
|
||||||
buf, err = c.TemplateRenderer.
|
buf, err = c.TemplateRenderer.
|
||||||
Parse().
|
Parse().
|
||||||
Group(group).
|
Group(group).
|
||||||
Key(id).
|
Key(id).
|
||||||
Base("htmx").
|
Base("test").
|
||||||
Files("htmx", "pages/error").
|
Files("email/test").
|
||||||
Directories("components").
|
|
||||||
Execute(data)
|
Execute(data)
|
||||||
|
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
require.NotNil(t, buf)
|
require.NotNil(t, buf)
|
||||||
assert.Contains(t, buf.String(), "Please try again")
|
assert.Contains(t, buf.String(), "Test email template")
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestTemplateRenderer_RenderPage(t *testing.T) {
|
func TestTemplateRenderer_RenderPage(t *testing.T) {
|
||||||
@ -85,8 +78,7 @@ func TestTemplateRenderer_RenderPage(t *testing.T) {
|
|||||||
tests.InitSession(ctx)
|
tests.InitSession(ctx)
|
||||||
|
|
||||||
p := page.New(ctx)
|
p := page.New(ctx)
|
||||||
p.Name = "home"
|
p.Name = "test"
|
||||||
p.Layout = "main"
|
|
||||||
p.Cache.Enabled = false
|
p.Cache.Enabled = false
|
||||||
p.Headers["A"] = "b"
|
p.Headers["A"] = "b"
|
||||||
p.Headers["C"] = "d"
|
p.Headers["C"] = "d"
|
||||||
@ -98,101 +90,27 @@ func TestTemplateRenderer_RenderPage(t *testing.T) {
|
|||||||
// Rendering should fail if the Page has no name
|
// Rendering should fail if the Page has no name
|
||||||
ctx, _, p := setup()
|
ctx, _, p := setup()
|
||||||
p.Name = ""
|
p.Name = ""
|
||||||
err := c.TemplateRenderer.RenderPage(ctx, p)
|
err := c.TemplateRenderer.RenderPageTempl(ctx, p, pages.Error(p))
|
||||||
assert.Error(t, err)
|
assert.Error(t, err)
|
||||||
})
|
})
|
||||||
|
|
||||||
t.Run("no page cache", func(t *testing.T) {
|
|
||||||
ctx, _, p := setup()
|
|
||||||
err := c.TemplateRenderer.RenderPage(ctx, p)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
// Check status code and headers
|
|
||||||
assert.Equal(t, http.StatusCreated, ctx.Response().Status)
|
|
||||||
for k, v := range p.Headers {
|
|
||||||
assert.Equal(t, v, ctx.Response().Header().Get(k))
|
|
||||||
}
|
|
||||||
|
|
||||||
// Check the template cache
|
|
||||||
parsed, err := c.TemplateRenderer.Load("page", string(p.Name))
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
// Check that all expected templates were parsed.
|
|
||||||
// This includes the name, layout and all components
|
|
||||||
expectedTemplates := make(map[string]bool)
|
|
||||||
expectedTemplates[fmt.Sprintf("%s%s", p.Name, config.TemplateExt)] = true
|
|
||||||
expectedTemplates[fmt.Sprintf("%s%s", p.Layout, config.TemplateExt)] = true
|
|
||||||
components, err := templates.Get().ReadDir("components")
|
|
||||||
require.NoError(t, err)
|
|
||||||
for _, f := range components {
|
|
||||||
expectedTemplates[f.Name()] = true
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, v := range parsed.Template.Templates() {
|
|
||||||
delete(expectedTemplates, v.Name())
|
|
||||||
}
|
|
||||||
assert.Empty(t, expectedTemplates)
|
|
||||||
})
|
|
||||||
|
|
||||||
t.Run("htmx rendering", func(t *testing.T) {
|
t.Run("htmx rendering", func(t *testing.T) {
|
||||||
ctx, _, p := setup()
|
ctx, _, p := setup()
|
||||||
p.HTMX.Request.Enabled = true
|
p.HTMX.Request.Enabled = true
|
||||||
p.HTMX.Response = &htmx.Response{
|
p.HTMX.Response = &htmx.Response{
|
||||||
Trigger: "trigger",
|
Trigger: "trigger",
|
||||||
}
|
}
|
||||||
err := c.TemplateRenderer.RenderPage(ctx, p)
|
|
||||||
|
component := pages.Home(p, []models.Post{})
|
||||||
|
p.LayoutComponent = func(content templ.Component) templ.Component {
|
||||||
|
return layouts.Main(p, content)
|
||||||
|
}
|
||||||
|
|
||||||
|
err := c.TemplateRenderer.RenderPageTempl(ctx, p, component)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
|
|
||||||
// Check HTMX header
|
// Check HTMX header
|
||||||
assert.Equal(t, "trigger", ctx.Response().Header().Get(htmx.HeaderTrigger))
|
assert.Equal(t, "trigger", ctx.Response().Header().Get(htmx.HeaderTrigger))
|
||||||
|
|
||||||
// Check the template cache
|
|
||||||
parsed, err := c.TemplateRenderer.Load("page:htmx", string(p.Name))
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
// Check that all expected templates were parsed.
|
|
||||||
// This includes the name, htmx and all components
|
|
||||||
expectedTemplates := make(map[string]bool)
|
|
||||||
expectedTemplates[fmt.Sprintf("%s%s", p.Name, config.TemplateExt)] = true
|
|
||||||
expectedTemplates["htmx"+config.TemplateExt] = true
|
|
||||||
components, err := templates.Get().ReadDir("components")
|
|
||||||
require.NoError(t, err)
|
|
||||||
for _, f := range components {
|
|
||||||
expectedTemplates[f.Name()] = true
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, v := range parsed.Template.Templates() {
|
|
||||||
delete(expectedTemplates, v.Name())
|
|
||||||
}
|
|
||||||
assert.Empty(t, expectedTemplates)
|
|
||||||
})
|
|
||||||
|
|
||||||
t.Run("page cache", func(t *testing.T) {
|
|
||||||
ctx, rec, p := setup()
|
|
||||||
p.Cache.Enabled = true
|
|
||||||
p.Cache.Tags = []string{"tag1"}
|
|
||||||
err := c.TemplateRenderer.RenderPage(ctx, p)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
// Fetch from the cache
|
|
||||||
cp, err := c.TemplateRenderer.GetCachedPage(ctx, p.URL)
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
// Compare the cached page
|
|
||||||
assert.Equal(t, p.URL, cp.URL)
|
|
||||||
assert.Equal(t, p.Headers, cp.Headers)
|
|
||||||
assert.Equal(t, p.StatusCode, cp.StatusCode)
|
|
||||||
assert.Equal(t, rec.Body.Bytes(), cp.HTML)
|
|
||||||
|
|
||||||
// Clear the tag
|
|
||||||
err = c.Cache.
|
|
||||||
Flush().
|
|
||||||
Tags(p.Cache.Tags[0]).
|
|
||||||
Execute(context.Background())
|
|
||||||
require.NoError(t, err)
|
|
||||||
|
|
||||||
// Refetch from the cache and expect no results
|
|
||||||
_, err = c.TemplateRenderer.GetCachedPage(ctx, p.URL)
|
|
||||||
assert.Error(t, err)
|
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
9
templ/layouts/htmx.templ
Normal file
9
templ/layouts/htmx.templ
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
package layouts
|
||||||
|
|
||||||
|
import (
|
||||||
|
"git.grosinger.net/tgrosinger/saasitone/pkg/page"
|
||||||
|
)
|
||||||
|
|
||||||
|
templ HTMX(p page.Page, content templ.Component) {
|
||||||
|
@content
|
||||||
|
}
|
39
templ/layouts/htmx_templ.go
Normal file
39
templ/layouts/htmx_templ.go
Normal file
@ -0,0 +1,39 @@
|
|||||||
|
// Code generated by templ - DO NOT EDIT.
|
||||||
|
|
||||||
|
// templ: version: v0.2.707
|
||||||
|
package layouts
|
||||||
|
|
||||||
|
//lint:file-ignore SA4006 This context is only used if a nested component is present.
|
||||||
|
|
||||||
|
import "github.com/a-h/templ"
|
||||||
|
import "context"
|
||||||
|
import "io"
|
||||||
|
import "bytes"
|
||||||
|
|
||||||
|
import (
|
||||||
|
"git.grosinger.net/tgrosinger/saasitone/pkg/page"
|
||||||
|
)
|
||||||
|
|
||||||
|
func HTMX(p page.Page, content templ.Component) templ.Component {
|
||||||
|
return templ.ComponentFunc(func(ctx context.Context, templ_7745c5c3_W io.Writer) (templ_7745c5c3_Err error) {
|
||||||
|
templ_7745c5c3_Buffer, templ_7745c5c3_IsBuffer := templ_7745c5c3_W.(*bytes.Buffer)
|
||||||
|
if !templ_7745c5c3_IsBuffer {
|
||||||
|
templ_7745c5c3_Buffer = templ.GetBuffer()
|
||||||
|
defer templ.ReleaseBuffer(templ_7745c5c3_Buffer)
|
||||||
|
}
|
||||||
|
ctx = templ.InitializeContext(ctx)
|
||||||
|
templ_7745c5c3_Var1 := templ.GetChildren(ctx)
|
||||||
|
if templ_7745c5c3_Var1 == nil {
|
||||||
|
templ_7745c5c3_Var1 = templ.NopComponent
|
||||||
|
}
|
||||||
|
ctx = templ.ClearChildren(ctx)
|
||||||
|
templ_7745c5c3_Err = content.Render(ctx, templ_7745c5c3_Buffer)
|
||||||
|
if templ_7745c5c3_Err != nil {
|
||||||
|
return templ_7745c5c3_Err
|
||||||
|
}
|
||||||
|
if !templ_7745c5c3_IsBuffer {
|
||||||
|
_, templ_7745c5c3_Err = templ_7745c5c3_Buffer.WriteTo(templ_7745c5c3_W)
|
||||||
|
}
|
||||||
|
return templ_7745c5c3_Err
|
||||||
|
})
|
||||||
|
}
|
@ -4,11 +4,11 @@ import (
|
|||||||
"strconv"
|
"strconv"
|
||||||
|
|
||||||
"git.grosinger.net/tgrosinger/saasitone/pkg/page"
|
"git.grosinger.net/tgrosinger/saasitone/pkg/page"
|
||||||
"git.grosinger.net/tgrosinger/saasitone/pkg/services"
|
"git.grosinger.net/tgrosinger/saasitone/pkg/models"
|
||||||
"git.grosinger.net/tgrosinger/saasitone/pkg/funcmap"
|
"git.grosinger.net/tgrosinger/saasitone/pkg/funcmap"
|
||||||
)
|
)
|
||||||
|
|
||||||
templ Home(p page.Page, posts []services.Post) {
|
templ Home(p page.Page, posts []models.Post) {
|
||||||
if (p.HTMX.Request.Target != "posts") {
|
if (p.HTMX.Request.Target != "posts") {
|
||||||
@topContent(p)
|
@topContent(p)
|
||||||
}
|
}
|
||||||
|
@ -14,11 +14,11 @@ import (
|
|||||||
"strconv"
|
"strconv"
|
||||||
|
|
||||||
"git.grosinger.net/tgrosinger/saasitone/pkg/funcmap"
|
"git.grosinger.net/tgrosinger/saasitone/pkg/funcmap"
|
||||||
|
"git.grosinger.net/tgrosinger/saasitone/pkg/models"
|
||||||
"git.grosinger.net/tgrosinger/saasitone/pkg/page"
|
"git.grosinger.net/tgrosinger/saasitone/pkg/page"
|
||||||
"git.grosinger.net/tgrosinger/saasitone/pkg/services"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
func Home(p page.Page, posts []services.Post) templ.Component {
|
func Home(p page.Page, posts []models.Post) templ.Component {
|
||||||
return templ.ComponentFunc(func(ctx context.Context, templ_7745c5c3_W io.Writer) (templ_7745c5c3_Err error) {
|
return templ.ComponentFunc(func(ctx context.Context, templ_7745c5c3_W io.Writer) (templ_7745c5c3_Err error) {
|
||||||
templ_7745c5c3_Buffer, templ_7745c5c3_IsBuffer := templ_7745c5c3_W.(*bytes.Buffer)
|
templ_7745c5c3_Buffer, templ_7745c5c3_IsBuffer := templ_7745c5c3_W.(*bytes.Buffer)
|
||||||
if !templ_7745c5c3_IsBuffer {
|
if !templ_7745c5c3_IsBuffer {
|
||||||
|
@ -1,42 +0,0 @@
|
|||||||
{{define "metatags"}}
|
|
||||||
<title>{{ .AppName }}{{ if .Title }} | {{ .Title }}{{ end }}</title>
|
|
||||||
<link rel="icon" href="{{file "favicon.png"}}">
|
|
||||||
<meta charset="utf-8">
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
||||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
||||||
{{- if .Metatags.Description}}
|
|
||||||
<meta name="description" content="{{.Metatags.Description}}">
|
|
||||||
{{- end}}
|
|
||||||
{{- if .Metatags.Keywords}}
|
|
||||||
<meta name="keywords" content="{{.Metatags.Keywords | join ", "}}">
|
|
||||||
{{- end}}
|
|
||||||
{{end}}
|
|
||||||
|
|
||||||
{{define "css"}}
|
|
||||||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bulma@0.9.4/css/bulma.min.css">
|
|
||||||
{{end}}
|
|
||||||
|
|
||||||
{{define "js"}}
|
|
||||||
<script src="https://unpkg.com/htmx.org@2.0.0/dist/htmx.min.js"></script>
|
|
||||||
<script defer src="https://unpkg.com/alpinejs@3.x.x/dist/cdn.min.js"></script>
|
|
||||||
{{end}}
|
|
||||||
|
|
||||||
{{define "footer"}}
|
|
||||||
{{- if .CSRF}}
|
|
||||||
<script>
|
|
||||||
document.body.addEventListener('htmx:configRequest', function(evt) {
|
|
||||||
if (evt.detail.verb !== "get") {
|
|
||||||
evt.detail.parameters['csrf'] = '{{.CSRF}}';
|
|
||||||
}
|
|
||||||
})
|
|
||||||
</script>
|
|
||||||
{{end}}
|
|
||||||
<script>
|
|
||||||
document.body.addEventListener('htmx:beforeSwap', function(evt) {
|
|
||||||
if (evt.detail.xhr.status >= 400){
|
|
||||||
evt.detail.shouldSwap = true;
|
|
||||||
evt.detail.target = htmx.find("body");
|
|
||||||
}
|
|
||||||
});
|
|
||||||
</script>
|
|
||||||
{{end}}
|
|
@ -1,9 +0,0 @@
|
|||||||
{{define "csrf"}}
|
|
||||||
<input type="hidden" name="csrf" value="{{.CSRF}}"/>
|
|
||||||
{{end}}
|
|
||||||
|
|
||||||
{{define "field-errors"}}
|
|
||||||
{{- range .}}
|
|
||||||
<p class="help is-danger">{{.}}</p>
|
|
||||||
{{- end}}
|
|
||||||
{{end}}
|
|
@ -1,21 +0,0 @@
|
|||||||
{{define "messages"}}
|
|
||||||
{{- range (.GetMessages "success")}}
|
|
||||||
{{template "message" dict "Type" "success" "Text" .}}
|
|
||||||
{{- end}}
|
|
||||||
{{- range (.GetMessages "info")}}
|
|
||||||
{{template "message" dict "Type" "info" "Text" .}}
|
|
||||||
{{- end}}
|
|
||||||
{{- range (.GetMessages "warning")}}
|
|
||||||
{{template "message" dict "Type" "warning" "Text" .}}
|
|
||||||
{{- end}}
|
|
||||||
{{- range (.GetMessages "danger")}}
|
|
||||||
{{template "message" dict "Type" "danger" "Text" .}}
|
|
||||||
{{- end}}
|
|
||||||
{{end}}
|
|
||||||
|
|
||||||
{{define "message"}}
|
|
||||||
<div class="notification is-light is-{{.Type}}" x-data="{show: true}" x-show="show">
|
|
||||||
<button class="delete" @click="show = false"></button>
|
|
||||||
{{.Text}}
|
|
||||||
</div>
|
|
||||||
{{end}}
|
|
@ -1,35 +0,0 @@
|
|||||||
<!DOCTYPE html>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
{{template "metatags" .}}
|
|
||||||
{{template "css" .}}
|
|
||||||
{{template "js" .}}
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<section class="hero is-info is-fullheight">
|
|
||||||
<div class="hero-body">
|
|
||||||
<div class="container">
|
|
||||||
<div class="columns is-centered">
|
|
||||||
<div class="column is-half">
|
|
||||||
{{- if .Title}}
|
|
||||||
<h1 class="title">{{.Title}}</h1>
|
|
||||||
{{- end}}
|
|
||||||
<div class="box">
|
|
||||||
{{template "messages" .}}
|
|
||||||
{{template "content" .}}
|
|
||||||
|
|
||||||
<div class="content is-small has-text-centered" hx-boost="true">
|
|
||||||
<a href="{{url "login"}}">Login</a> ◌
|
|
||||||
<a href="{{url "register"}}">Create an account</a> ◌
|
|
||||||
<a href="{{url "forgot_password"}}">Forgot password?</a>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
{{template "footer" .}}
|
|
||||||
</body>
|
|
||||||
</html>
|
|
@ -1 +0,0 @@
|
|||||||
{{template "content" .}}
|
|
@ -1,92 +0,0 @@
|
|||||||
<!DOCTYPE html>
|
|
||||||
<html lang="en" style="height:100%;">
|
|
||||||
<head>
|
|
||||||
{{template "metatags" .}}
|
|
||||||
{{template "css" .}}
|
|
||||||
{{template "js" .}}
|
|
||||||
</head>
|
|
||||||
<body class="has-background-light" style="min-height:100%;">
|
|
||||||
<nav class="navbar is-dark">
|
|
||||||
<div class="container">
|
|
||||||
<div class="navbar-brand" hx-boost="true">
|
|
||||||
<a href="{{url "home"}}" class="navbar-item">{{.AppName}}</a>
|
|
||||||
</div>
|
|
||||||
<div id="navbarMenu" class="navbar-menu">
|
|
||||||
<div class="navbar-end">
|
|
||||||
{{template "search" .}}
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
<div class="container mt-5">
|
|
||||||
<div class="columns">
|
|
||||||
<div class="column is-2">
|
|
||||||
<aside class="menu" hx-boost="true">
|
|
||||||
<p class="menu-label">General</p>
|
|
||||||
<ul class="menu-list">
|
|
||||||
<li>{{link (url "home") "Dashboard" .Path}}</li>
|
|
||||||
<li>{{link (url "about") "About" .Path}}</li>
|
|
||||||
<li>{{link (url "contact") "Contact" .Path}}</li>
|
|
||||||
<li>{{link (url "cache") "Cache" .Path}}</li>
|
|
||||||
<li>{{link (url "task") "Task" .Path}}</li>
|
|
||||||
</ul>
|
|
||||||
|
|
||||||
<p class="menu-label">Account</p>
|
|
||||||
<ul class="menu-list">
|
|
||||||
{{- if .IsAuth}}
|
|
||||||
<li>{{link (url "logout") "Logout" .Path}}</li>
|
|
||||||
{{- else}}
|
|
||||||
<li>{{link (url "login") "Login" .Path}}</li>
|
|
||||||
<li>{{link (url "register") "Register" .Path}}</li>
|
|
||||||
<li>{{link (url "forgot_password") "Forgot password" .Path}}</li>
|
|
||||||
{{- end}}
|
|
||||||
</ul>
|
|
||||||
</aside>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="column is-10">
|
|
||||||
<div class="box">
|
|
||||||
{{- if .Title}}
|
|
||||||
<h1 class="title">{{.Title}}</h1>
|
|
||||||
{{- end}}
|
|
||||||
|
|
||||||
{{template "messages" .}}
|
|
||||||
{{template "content" .}}
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
{{template "footer" .}}
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
|
|
||||||
{{define "search"}}
|
|
||||||
<div class="search mr-2 mt-1" x-data="{modal:false}">
|
|
||||||
<input class="input" type="search" placeholder="Search..." @click="modal = true; $nextTick(() => $refs.input.focus());"/>
|
|
||||||
<div class="modal" :class="modal ? 'is-active' : ''" x-show="modal == true">
|
|
||||||
<div class="modal-background"></div>
|
|
||||||
<div class="modal-content" @click.away="modal = false;">
|
|
||||||
<div class="box">
|
|
||||||
<h2 class="subtitle">Search</h2>
|
|
||||||
<p class="control">
|
|
||||||
<input
|
|
||||||
hx-get="{{url "search"}}"
|
|
||||||
hx-trigger="keyup changed delay:500ms"
|
|
||||||
hx-target="#results"
|
|
||||||
name="query"
|
|
||||||
class="input"
|
|
||||||
type="search"
|
|
||||||
placeholder="Search..."
|
|
||||||
x-ref="input"
|
|
||||||
/>
|
|
||||||
</p>
|
|
||||||
<div class="block"></div>
|
|
||||||
<div id="results"></div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
<button class="modal-close is-large" aria-label="close"></button>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
{{end}}
|
|
@ -1,18 +1,17 @@
|
|||||||
package templates
|
package templates
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestGet(t *testing.T) {
|
func TestGet(t *testing.T) {
|
||||||
_, err := Get().Open(fmt.Sprintf("pages/%s.gohtml", PageHome))
|
_, err := Get().Open("emails/test.gohtml")
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestGetOS(t *testing.T) {
|
func TestGetOS(t *testing.T) {
|
||||||
_, err := GetOS().Open(fmt.Sprintf("pages/%s.gohtml", PageHome))
|
_, err := GetOS().Open("emails/test.gohtml")
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
}
|
}
|
||||||
|
Loading…
x
Reference in New Issue
Block a user