rohit/probo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add i18n data structures for cookie banner

Browse Source 
Add cookie_banner_translations table to store per-language
translations as JSONB, and a default_language column on
cookie_banners. Extend the version snapshot types to carry
translated UI strings and category content per language.

Signed-off-by: Émile Ré <emile@getprobo.com>
This commit is contained in:
Émile Ré
2026-04-22 19:05:41 +04:00
parent 4678c58ab0
commit d189913ba3
5 changed files with 370 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
pkg/coredata/cookie_banner.go
View File

@@ -39,6 +39,7 @@ type (
ConsentExpiryDays int `db:"consent_expiry_days"`
ConsentMode CookieConsentMode `db:"consent_mode"`
ShowBranding bool `db:"show_branding"`
DefaultLanguage string `db:"default_language"`
CreatedAt time.Time `db:"created_at"`
UpdatedAt time.Time `db:"updated_at"`
}
@@ -87,6 +88,7 @@ SELECT
consent_expiry_days,
consent_mode,
show_branding,
default_language,
created_at,
updated_at
FROM
@@ -137,6 +139,7 @@ SELECT
consent_expiry_days,
consent_mode,
show_branding,
default_language,
created_at,
updated_at
FROM
@@ -188,6 +191,7 @@ SELECT
consent_expiry_days,
consent_mode,
show_branding,
default_language,
created_at,
updated_at
FROM
@@ -245,6 +249,7 @@ SELECT
consent_expiry_days,
consent_mode,
show_branding,
default_language,
created_at,
updated_at
FROM
@@ -329,6 +334,7 @@ INSERT INTO cookie_banners (
consent_expiry_days,
consent_mode,
show_branding,
default_language,
created_at,
updated_at
) VALUES (
@@ -342,6 +348,7 @@ INSERT INTO cookie_banners (
@consent_expiry_days,
@consent_mode,
@show_branding,
@default_language,
@created_at,
@updated_at
)
@@ -358,6 +365,7 @@ INSERT INTO cookie_banners (
"consent_expiry_days": b.ConsentExpiryDays,
"consent_mode": b.ConsentMode,
"show_branding": b.ShowBranding,
"default_language": b.DefaultLanguage,
"created_at": b.CreatedAt,
"updated_at": b.UpdatedAt,
}
@@ -390,6 +398,7 @@ SET
consent_expiry_days = @consent_expiry_days,
consent_mode = @consent_mode,
show_branding = @show_branding,
default_language = @default_language,
updated_at = @updated_at
WHERE
%s
@@ -407,6 +416,7 @@ WHERE
"consent_expiry_days": b.ConsentExpiryDays,
"consent_mode": b.ConsentMode,
"show_branding": b.ShowBranding,
"default_language": b.DefaultLanguage,
"updated_at": b.UpdatedAt,
}
maps.Copy(args, scope.SQLArguments())

311
pkg/coredata/cookie_banner_translation.go Normal file
View File

@@ -0,0 +1,311 @@
// Copyright (c) 2026 Probo Inc <hello@getprobo.com>.
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
package coredata
import (
"context"
"encoding/json"
"errors"
"fmt"
"maps"
"time"
"github.com/jackc/pgx/v5"
"github.com/jackc/pgx/v5/pgconn"
"go.gearno.de/kit/pg"
"go.probo.inc/probo/pkg/gid"
)
type (
CookieBannerTranslation struct {
ID gid.GID `db:"id"`
OrganizationID gid.GID `db:"organization_id"`
CookieBannerID gid.GID `db:"cookie_banner_id"`
Language string `db:"language"`
Translations json.RawMessage `db:"translations"`
CreatedAt time.Time `db:"created_at"`
UpdatedAt time.Time `db:"updated_at"`
}
CookieBannerTranslations []*CookieBannerTranslation
)
func (t *CookieBannerTranslation) AuthorizationAttributes(ctx context.Context, conn pg.Querier) (map[string]string, error) {
q := `SELECT organization_id FROM cookie_banner_translations WHERE id = $1 LIMIT 1;`
var organizationID gid.GID
if err := conn.QueryRow(ctx, q, t.ID).Scan(&organizationID); err != nil {
if errors.Is(err, pgx.ErrNoRows) {
return nil, ErrResourceNotFound
}
return nil, fmt.Errorf("cannot query cookie banner translation authorization attributes: %w", err)
}
return map[string]string{"organization_id": organizationID.String()}, nil
}
func (t *CookieBannerTranslation) LoadByID(
ctx context.Context,
conn pg.Querier,
scope Scoper,
translationID gid.GID,
) error {
q := `
SELECT
id,
organization_id,
cookie_banner_id,
language,
translations,
created_at,
updated_at
FROM
cookie_banner_translations
WHERE
%s
AND id = @translation_id
LIMIT 1;
`
q = fmt.Sprintf(q, scope.SQLFragment())
args := pgx.StrictNamedArgs{"translation_id": translationID}
maps.Copy(args, scope.SQLArguments())
rows, err := conn.Query(ctx, q, args)
if err != nil {
return fmt.Errorf("cannot query cookie banner translations: %w", err)
}
translation, err := pgx.CollectExactlyOneRow(rows, pgx.RowToStructByName[CookieBannerTranslation])
if err != nil {
if errors.Is(err, pgx.ErrNoRows) {
return ErrResourceNotFound
}
return fmt.Errorf("cannot collect cookie banner translation: %w", err)
}
*t = translation
return nil
}
func (t *CookieBannerTranslation) LoadByCookieBannerIDAndLanguage(
ctx context.Context,
conn pg.Querier,
scope Scoper,
cookieBannerID gid.GID,
language string,
) error {
q := `
SELECT
id,
organization_id,
cookie_banner_id,
language,
translations,
created_at,
updated_at
FROM
cookie_banner_translations
WHERE
%s
AND cookie_banner_id = @cookie_banner_id
AND language = @language
LIMIT 1;
`
q = fmt.Sprintf(q, scope.SQLFragment())
args := pgx.StrictNamedArgs{
"cookie_banner_id": cookieBannerID,
"language": language,
}
maps.Copy(args, scope.SQLArguments())
rows, err := conn.Query(ctx, q, args)
if err != nil {
return fmt.Errorf("cannot query cookie banner translations: %w", err)
}
translation, err := pgx.CollectExactlyOneRow(rows, pgx.RowToStructByName[CookieBannerTranslation])
if err != nil {
if errors.Is(err, pgx.ErrNoRows) {
return ErrResourceNotFound
}
return fmt.Errorf("cannot collect cookie banner translation: %w", err)
}
*t = translation
return nil
}
func (t *CookieBannerTranslations) LoadAllByCookieBannerID(
ctx context.Context,
conn pg.Querier,
scope Scoper,
cookieBannerID gid.GID,
) error {
q := `
SELECT
id,
organization_id,
cookie_banner_id,
language,
translations,
created_at,
updated_at
FROM
cookie_banner_translations
WHERE
%s
AND cookie_banner_id = @cookie_banner_id
ORDER BY
language ASC;
`
q = fmt.Sprintf(q, scope.SQLFragment())
args := pgx.StrictNamedArgs{"cookie_banner_id": cookieBannerID}
maps.Copy(args, scope.SQLArguments())
rows, err := conn.Query(ctx, q, args)
if err != nil {
return fmt.Errorf("cannot query cookie banner translations: %w", err)
}
translations, err := pgx.CollectRows(rows, pgx.RowToAddrOfStructByName[CookieBannerTranslation])
if err != nil {
return fmt.Errorf("cannot collect cookie banner translations: %w", err)
}
*t = translations
return nil
}
func (t *CookieBannerTranslation) Insert(
ctx context.Context,
tx pg.Tx,
scope Scoper,
) error {
q := `
INSERT INTO cookie_banner_translations (
id,
tenant_id,
organization_id,
cookie_banner_id,
language,
translations,
created_at,
updated_at
) VALUES (
@id,
@tenant_id,
@organization_id,
@cookie_banner_id,
@language,
@translations,
@created_at,
@updated_at
)
`
args := pgx.StrictNamedArgs{
"id": t.ID,
"tenant_id": scope.GetTenantID(),
"organization_id": t.OrganizationID,
"cookie_banner_id": t.CookieBannerID,
"language": t.Language,
"translations": t.Translations,
"created_at": t.CreatedAt,
"updated_at": t.UpdatedAt,
}
_, err := tx.Exec(ctx, q, args)
if err != nil {
if pgErr, ok := errors.AsType[*pgconn.PgError](err); ok {
if pgErr.Code == "23505" && pgErr.ConstraintName == "idx_cookie_banner_translations_unique_language_per_banner" {
return ErrResourceAlreadyExists
}
}
return fmt.Errorf("cannot insert cookie banner translation: %w", err)
}
return nil
}
func (t *CookieBannerTranslation) Update(
ctx context.Context,
tx pg.Tx,
scope Scoper,
) error {
q := `
UPDATE cookie_banner_translations
SET
translations = @translations,
updated_at = @updated_at
WHERE
%s
AND id = @id
`
q = fmt.Sprintf(q, scope.SQLFragment())
args := pgx.StrictNamedArgs{
"id": t.ID,
"translations": t.Translations,
"updated_at": t.UpdatedAt,
}
maps.Copy(args, scope.SQLArguments())
result, err := tx.Exec(ctx, q, args)
if err != nil {
return fmt.Errorf("cannot update cookie banner translation: %w", err)
}
if result.RowsAffected() == 0 {
return ErrResourceNotFound
}
return nil
}
func (t *CookieBannerTranslation) Delete(
ctx context.Context,
tx pg.Tx,
scope Scoper,
) error {
q := `
DELETE FROM cookie_banner_translations
WHERE
%s
AND id = @id
`
q = fmt.Sprintf(q, scope.SQLFragment())
args := pgx.StrictNamedArgs{"id": t.ID}
maps.Copy(args, scope.SQLArguments())
_, err := tx.Exec(ctx, q, args)
if err != nil {
return fmt.Errorf("cannot delete cookie banner translation: %w", err)
}
return nil
}

20
pkg/coredata/cookie_banner_version.go
View File

@@ -30,10 +30,22 @@ import (
type (
CookieBannerVersionSnapshot struct {
PrivacyPolicyURL string `json:"privacy_policy_url"`
ConsentExpiryDays int `json:"consent_expiry_days"`
ConsentMode string `json:"consent_mode"`
Categories []CookieBannerVersionSnapshotCategory `json:"categories"`
PrivacyPolicyURL string `json:"privacy_policy_url"`
ConsentExpiryDays int `json:"consent_expiry_days"`
ConsentMode string `json:"consent_mode"`
DefaultLanguage string `json:"default_language"`
Categories []CookieBannerVersionSnapshotCategory `json:"categories"`
Translations map[string]CookieBannerVersionSnapshotTranslation `json:"translations,omitempty"`
}
CookieBannerVersionSnapshotTranslation struct {
UI map[string]string `json:"ui"`
Categories []CookieBannerVersionSnapshotCategoryTranslation `json:"categories"`
}
CookieBannerVersionSnapshotCategoryTranslation struct {
Name string `json:"name"`
Description string `json:"description"`
}
CookieBannerVersionSnapshotCategory struct {

3
pkg/coredata/entity_type_reg.go
View File

@@ -109,6 +109,7 @@ const (
OAuth2AuthorizationCodeEntityType uint16 = 83
OAuth2DeviceCodeEntityType uint16 = 84
CookieEntityType uint16 = 85
CookieBannerTranslationEntityType uint16 = 86
)
func NewEntityFromID(id gid.GID) (any, bool) {
@@ -275,6 +276,8 @@ func NewEntityFromID(id gid.GID) (any, bool) {
return &OAuth2DeviceCode{ID: id}, true
case CookieEntityType:
return &Cookie{ID: id}, true
case CookieBannerTranslationEntityType:
return &CookieBannerTranslation{ID: id}, true
default:
return nil, false
}

30
pkg/coredata/migrations/20260422T145821Z.sql Normal file
View File

@@ -0,0 +1,30 @@
-- Copyright (c) 2026 Probo Inc <hello@getprobo.com>.
--
-- Permission to use, copy, modify, and/or distribute this software for any
-- purpose with or without fee is hereby granted, provided that the above
-- copyright notice and this permission notice appear in all copies.
--
-- THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-- REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-- AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-- INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-- LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-- OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-- PERFORMANCE OF THIS SOFTWARE.
ALTER TABLE cookie_banners ADD COLUMN default_language TEXT NOT NULL DEFAULT 'en';
ALTER TABLE cookie_banners ALTER COLUMN default_language DROP DEFAULT;
CREATE TABLE cookie_banner_translations (
id TEXT PRIMARY KEY,
tenant_id TEXT NOT NULL,
organization_id TEXT NOT NULL,
cookie_banner_id TEXT NOT NULL REFERENCES cookie_banners(id) ON DELETE CASCADE,
language TEXT NOT NULL,
translations JSONB NOT NULL,
created_at TIMESTAMP WITH TIME ZONE NOT NULL,
updated_at TIMESTAMP WITH TIME ZONE NOT NULL
);
CREATE UNIQUE INDEX idx_cookie_banner_translations_unique_language_per_banner
ON cookie_banner_translations (cookie_banner_id, language);