mirror of
https://github.com/SigNoz/signoz.git
synced 2026-08-08 22:20:40 +01:00
e08ef01170
## Summary
- Saved views now persist a versioned, typed spec (`schemaVersion` +
`spec{compositeQuery, selectedFields, display}`) instead of a bare
composite-query blob plus an opaque, frontend-owned `extraData` string
-- mirroring the pattern dashboards already use for their v2/perses
schema.
- `/api/v1/explorer/views` keeps working exactly as before: a thin
conversion layer translates to/from the legacy wire format, including
folding `extraData`'s ad hoc JSON into the typed spec and back for
backward compatibility.
- A one-time migration rewrites existing rows into the new shape and
drops the now-unused `extra_data`/`category`/`tags` columns.
### Scaffolding decisions
- Using v2 for new handlers instead of renaming old handlers to
something else for these reasons - keep the diff minimum for easier
reviews, avoiding any git history or last updated at change in old route
registration.
- Keeping the conversion to old saved view type in handler itself rather
than `savedviewtypes` package to keep it un-exported and not let them be
available anywhere else to be used. It also enables `savedviewtypes` to
be independent on query-service models.
- Modified the existing handler and it's interface to include the v2
methods instead of adding another handlerV2 since apiserver already had
handler wired in, so don't want to pass on 2 version simultaneously.
### Breaking change
- Any unknown key in the `ExtraData` will be rejected and dropped
silently in the old APIs and give error in new version.
- If there was any way to add tag or category in saved view earlier,
that data will be lost.
- Old APIs will not support the old QB request payload, only v5 format
is supported.
---
Closes SigNoz/engineering-pod#4651
Alternative discarded https://github.com/SigNoz/signoz/pull/12208
---------
Co-authored-by: Claude Sonnet 5 <noreply@anthropic.com>
64 lines
2.0 KiB
Go
64 lines
2.0 KiB
Go
package implsavedview
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/SigNoz/signoz/pkg/errors"
|
|
"github.com/SigNoz/signoz/pkg/modules/savedview"
|
|
"github.com/SigNoz/signoz/pkg/types/authtypes"
|
|
"github.com/SigNoz/signoz/pkg/types/savedviewtypes"
|
|
"github.com/SigNoz/signoz/pkg/valuer"
|
|
)
|
|
|
|
type module struct {
|
|
store savedviewtypes.Store
|
|
}
|
|
|
|
func NewModule(store savedviewtypes.Store) savedview.Module {
|
|
return &module{store: store}
|
|
}
|
|
|
|
func (module *module) GetViewsForFilters(ctx context.Context, orgID string, source savedviewtypes.Source, name string) ([]*savedviewtypes.SavedView, error) {
|
|
return module.store.List(ctx, orgID, source, name)
|
|
}
|
|
|
|
func (module *module) CreateView(ctx context.Context, orgID string, view savedviewtypes.PostableSavedView) (valuer.UUID, error) {
|
|
claims, err := authtypes.ClaimsFromContext(ctx)
|
|
if err != nil {
|
|
return valuer.UUID{}, errors.NewInternalf(errors.CodeInternal, "error in getting email from context")
|
|
}
|
|
|
|
dbView := view.ToSavedView(orgID, claims.Email)
|
|
|
|
if err := module.store.Create(ctx, dbView); err != nil {
|
|
return valuer.UUID{}, err
|
|
}
|
|
return dbView.ID, nil
|
|
}
|
|
|
|
func (module *module) GetView(ctx context.Context, orgID string, uuid valuer.UUID) (*savedviewtypes.SavedView, error) {
|
|
return module.store.Get(ctx, orgID, uuid)
|
|
}
|
|
|
|
func (module *module) UpdateView(ctx context.Context, orgID string, uuid valuer.UUID, view savedviewtypes.UpdatableSavedView) error {
|
|
claims, err := authtypes.ClaimsFromContext(ctx)
|
|
if err != nil {
|
|
return errors.NewInternalf(errors.CodeInternal, "error in getting email from context")
|
|
}
|
|
|
|
return module.store.Update(ctx, view.ToSavedView(uuid, orgID, claims.Email))
|
|
}
|
|
|
|
func (module *module) DeleteView(ctx context.Context, orgID string, uuid valuer.UUID) error {
|
|
return module.store.Delete(ctx, orgID, uuid)
|
|
}
|
|
|
|
func (module *module) Collect(ctx context.Context, orgID valuer.UUID) (map[string]any, error) {
|
|
savedViews, err := module.store.List(ctx, orgID.StringValue(), savedviewtypes.Source{}, "")
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return savedviewtypes.NewStatsFromSavedViews(savedViews), nil
|
|
}
|