-
Notifications
You must be signed in to change notification settings - Fork 302
/
definitions.go
149 lines (127 loc) · 4.21 KB
/
definitions.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
// Copyright © 2019 The Things Network Foundation, The Things Industries B.V.
//
// 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 events
import (
"context"
"fmt"
"sort"
"go.thethings.network/lorawan-stack/v3/pkg/i18n"
"go.thethings.network/lorawan-stack/v3/pkg/ttnpb"
"google.golang.org/protobuf/proto"
)
const i18nPrefix = "event"
type definition struct {
name string
description string
dataType proto.Message
propagateToParent bool
}
// Definition describes an event definition.
type Definition interface {
Name() string
Description() string
DataType() proto.Message
PropagateToParent() bool
}
func (d *definition) Definition() Definition { return d }
func (d definition) Name() string { return d.name }
func (d definition) Description() string { return d.description }
func (d definition) DataType() proto.Message { return d.dataType }
func (d definition) PropagateToParent() bool { return d.propagateToParent }
func (d *definition) With(options ...Option) Builder {
extended := &builder{
definition: d,
}
extended.options = append(extended.options, options...)
return extended
}
var defaultOptions = []Option{
WithVisibility(ttnpb.Right_RIGHT_ALL),
}
func (d *definition) New(ctx context.Context, opts ...Option) Event {
return d.With(defaultOptions...).New(ctx, opts...)
}
// EntityIdentifiers interface is for everything from which we can get entity identifiers.
type EntityIdentifiers interface {
GetEntityIdentifiers() *ttnpb.EntityIdentifiers
}
func (d *definition) NewWithIdentifiersAndData(ctx context.Context, ids EntityIdentifiers, data any) Event {
return d.With(defaultOptions...).NewWithIdentifiersAndData(ctx, ids, data)
}
func (d *definition) BindData(data any) Builder {
return d.With(defaultOptions...).BindData(data)
}
// Definitions of registered events.
var definitions = make(map[string]*definition)
// All returns all defined events, sorted by name.
func All() Builders {
type definition struct {
name string
builder Builder
}
sorted := make([]*definition, 0, len(definitions))
for name, builder := range definitions {
sorted = append(sorted, &definition{name: name, builder: builder})
}
sort.Slice(sorted, func(i, j int) bool {
return sorted[i].name < sorted[j].name
})
out := make(Builders, len(sorted))
for i, s := range sorted {
out[i] = s.builder
}
return out
}
// defineSkip registers an event and returns its definition.
// The argument skip is the number of stack frames to ascend, with 0 identifying the caller of defineSkip.
func defineSkip(name, description string, skip uint, opts ...Option) Builder {
if definitions[name] != nil {
panic(fmt.Errorf("Event %q already defined", name))
}
def := &definition{
name: name,
description: description,
}
for _, opt := range opts {
if defOpt, ok := opt.(DefinitionOption); ok {
defOpt.applyToDefinition(def)
}
}
definitions[name] = def
i18n.Define(fmt.Sprintf("%s:%s", i18nPrefix, name), description).SetSource(1 + skip)
initMetrics(name)
var b Builder = def
if len(opts) > 0 {
b = b.With(opts...)
}
return b
}
// Define a registered event.
func Define(name, description string, opts ...Option) Builder {
return defineSkip(name, description, 1, opts...)
}
// DefineFunc generates a function, which returns a Definition with specified name and description.
// Most callers should be using Define - this function is only useful for helper functions.
func DefineFunc(name, description string, opts ...Option) func() Builder {
return func() Builder {
return defineSkip(name, description, 1, opts...)
}
}
// GetDefinition gets the definition for an event.
func GetDefinition(evt Event) Definition {
if def, ok := definitions[evt.Name()]; ok {
return def
}
return nil
}