nanoflags 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/CHANGELOG.md +20 -0
- data/LICENSE +202 -0
- data/NOTICE +4 -0
- data/README.md +152 -0
- data/lib/nanoflags/client.rb +869 -0
- data/lib/nanoflags/engine/js.rb +531 -0
- data/lib/nanoflags/engine/json.rb +200 -0
- data/lib/nanoflags/engine.rb +407 -0
- data/lib/nanoflags/evaluation_detail.rb +87 -0
- data/lib/nanoflags/http.rb +119 -0
- data/lib/nanoflags/keys.rb +14 -0
- data/lib/nanoflags/store.rb +59 -0
- data/lib/nanoflags/verify.rb +180 -0
- data/lib/nanoflags/version.rb +6 -0
- data/lib/nanoflags.rb +10 -0
- metadata +69 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 20a5de550f54663193447c6a3dae237efeb11bf1c77fa6c9ea84afce95c67ef8
|
|
4
|
+
data.tar.gz: 0f56e030ceac3b6eee8f906ce3cfb0c6348ced4e025db3adb02c3db1c932fadc
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 3423f9bb63cac26aa70f0a2cfec35574d4bc141b40d34e0c908fe40431fbc6195a327a257fb0f8d31ec44e787fc93de36004d320e8fe4d12b67c91bcc4d56658
|
|
7
|
+
data.tar.gz: 6d3377fa5b9b7b000300a6c0e4e91e73ee781f76b2be455ea0190cb7ed4b9c50dd4ba03cbb08b0955007ff2be46538c976de55bd6361298bce76712e4da0a587
|
data/CHANGELOG.md
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## 0.1.0 (2026-11-18)
|
|
4
|
+
|
|
5
|
+
First release of the NanoFlags server SDK for Ruby (gem `nanoflags`).
|
|
6
|
+
|
|
7
|
+
- Native port of the NanoFlags evaluation engine (engine version 1): identical results to the TypeScript engine on
|
|
8
|
+
the shared parity fixtures (21 998 cases, MurmurHash3 and bucket vectors, `supportsEngine`, `clientBundle`) and on
|
|
9
|
+
the 3 491 JavaScript corner cases of `go/internal/testdata/extra.json`, error messages included.
|
|
10
|
+
- `NanoFlags::Client`: typed getters (`bool_variation`, `string_variation`, `number_variation`, `json_variation`),
|
|
11
|
+
detail variants with reason, rule, rollout bucket and trace, `evaluate`, `all_flags`. Accessors never raise.
|
|
12
|
+
- Background updates: `/v1/stream` server-sent events trigger conditional `/v1/bundle` requests (ETag), with polling
|
|
13
|
+
and backoff as the safety net; served-stale bundles never move the client backwards.
|
|
14
|
+
- Signature verification (Ed25519, embedded production keys, key rotation via `/v1/keys`, environment pinning) on by
|
|
15
|
+
default for the hosted edge. Bundles for a newer engine are refused.
|
|
16
|
+
- Persistence (`cache_path:` / `store:`, verified again on restore) and `bootstrap:`.
|
|
17
|
+
- Fork safety: forked children keep the inherited configuration and restart their threads on first use (or via
|
|
18
|
+
`NanoFlags::Client.after_fork`).
|
|
19
|
+
- Sampled telemetry (`/v1/events`) with the default redaction of the other SDKs (attribute names and value types
|
|
20
|
+
only) and the periodic service report.
|
data/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
data/NOTICE
ADDED
data/README.md
ADDED
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
# nanoflags (Ruby)
|
|
2
|
+
|
|
3
|
+
Server SDK for [NanoFlags](https://nanoflags.io) feature flags. Flags are evaluated **locally and synchronously**
|
|
4
|
+
against a signed, in-memory configuration bundle; a variation call never does I/O and never raises. Background
|
|
5
|
+
threads keep the bundle current: the edge's event stream (`/v1/stream`) announces each new revision, which is then
|
|
6
|
+
fetched with ETag revalidation, with polling as the safety net.
|
|
7
|
+
|
|
8
|
+
- Ruby 3.1+. No runtime dependencies (Net::HTTP, OpenSSL and JSON from the standard library).
|
|
9
|
+
- Native port of the NanoFlags engine, checked against the TypeScript engine with the shared parity fixtures
|
|
10
|
+
(~22 000 cases in `packages/engine/fixtures/parity.json`, plus ~3 500 JavaScript corner cases with V8's error
|
|
11
|
+
messages in `go/internal/testdata/extra.json`): same values, reasons, rollout buckets and traces as every other SDK.
|
|
12
|
+
- Signature verification **on by default** for the hosted edge's embedded key list; unsigned or tampered bundles
|
|
13
|
+
are refused and the last good configuration stays in use.
|
|
14
|
+
- Thread-safe and fork-safe (Puma, Unicorn, Passenger, Resque, Sidekiq Swarm); an OpenFeature provider ships as
|
|
15
|
+
[`nanoflags-openfeature`](../nanoflags-openfeature/README.md).
|
|
16
|
+
|
|
17
|
+
## Install
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
# Gemfile
|
|
21
|
+
gem "nanoflags"
|
|
22
|
+
gem "nanoflags-openfeature" # optional: OpenFeature
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Quickstart
|
|
26
|
+
|
|
27
|
+
```ruby
|
|
28
|
+
require "nanoflags"
|
|
29
|
+
|
|
30
|
+
FLAGS = NanoFlags::Client.new(
|
|
31
|
+
ENV.fetch("NANOFLAGS_SDK_KEY"), # nf_srv_… (server view) or nf_pub_… (client-exposed flags only)
|
|
32
|
+
service: "checkout-api" # shown in "which revision is each service running"
|
|
33
|
+
)
|
|
34
|
+
FLAGS.on_error { |e| Rails.logger.warn("nanoflags #{e.code}: #{e.message}") } # before the first load completes
|
|
35
|
+
FLAGS.wait_until_ready(5) # never raises; true once a configuration is in use
|
|
36
|
+
|
|
37
|
+
user = { key: current_user.id.to_s, plan: current_user.plan, country: "DE" }
|
|
38
|
+
if FLAGS.bool_variation("new-checkout", false, user)
|
|
39
|
+
# …
|
|
40
|
+
end
|
|
41
|
+
accent = FLAGS.string_variation("accent", "blue", user)
|
|
42
|
+
limit = FLAGS.number_variation("rate-limit", 100, user) # Integer for whole numbers, else Float
|
|
43
|
+
layout = FLAGS.json_variation("layout", { "cols" => 3 }, user) # Hash with String keys
|
|
44
|
+
|
|
45
|
+
d = FLAGS.bool_variation_detail("new-checkout", false, user)
|
|
46
|
+
puts d.value, d.reason, d.rule_id, d.revision # true rule_match beta 57
|
|
47
|
+
|
|
48
|
+
FLAGS.on_change { |e| puts "now on r#{e.revision} via #{e.transport}" }
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Create **one client per process** and share it between threads. Each variation takes the flag key, the value to
|
|
52
|
+
serve when the flag cannot be evaluated (no configuration yet, unknown flag, value of another type), and the
|
|
53
|
+
context: a Hash of JSON-like attributes (String or Symbol keys; Time and Date become ISO 8601 strings). `key` is the
|
|
54
|
+
stable identity used for percentage rollouts.
|
|
55
|
+
|
|
56
|
+
### Rails
|
|
57
|
+
|
|
58
|
+
```ruby
|
|
59
|
+
# config/initializers/nanoflags.rb
|
|
60
|
+
Rails.application.config.after_initialize do
|
|
61
|
+
NANOFLAGS = NanoFlags::Client.new(
|
|
62
|
+
Rails.application.credentials.nanoflags_sdk_key,
|
|
63
|
+
service: "web",
|
|
64
|
+
cache_path: Rails.root.join("tmp/nanoflags.json"), # optional: start from the last good bundle
|
|
65
|
+
logger: Rails.logger
|
|
66
|
+
)
|
|
67
|
+
end
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### Puma, Unicorn, Passenger and other forking servers
|
|
71
|
+
|
|
72
|
+
The client is fork-safe: a forked worker keeps the configuration it inherited (it can evaluate immediately) and
|
|
73
|
+
restarts its own background threads on its first call; events queued before the fork are sent by the parent only.
|
|
74
|
+
To start the threads as soon as a worker boots, call `NanoFlags::Client.after_fork` from the server's hook:
|
|
75
|
+
|
|
76
|
+
```ruby
|
|
77
|
+
# config/puma.rb
|
|
78
|
+
on_worker_boot { NanoFlags::Client.after_fork }
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
With `preload_app!`, creating the client in the master is fine; pass `start: false` there if the master should not
|
|
82
|
+
open any connection, and the workers start it on first use.
|
|
83
|
+
|
|
84
|
+
### Sidekiq and other threaded workers
|
|
85
|
+
|
|
86
|
+
Use the same process-wide client from every job; evaluations are lock-free reads of the current bundle. Call
|
|
87
|
+
`FLAGS.close` on shutdown only if you need the final telemetry flush synchronously (an `at_exit` hook does it too).
|
|
88
|
+
|
|
89
|
+
## API
|
|
90
|
+
|
|
91
|
+
| | |
|
|
92
|
+
| --- | --- |
|
|
93
|
+
| `NanoFlags::Client.new(sdk_key, base_url:, service:, poll_interval:, streaming:, bootstrap:, cache_path:, store:, events:, verify:, on_change:, on_error:, logger:, start:, http:, request_timeout:)` | the client |
|
|
94
|
+
| `bool_variation` / `string_variation` / `number_variation` / `json_variation(key, default, context = nil)` | typed value |
|
|
95
|
+
| `*_variation_detail(...)` → `NanoFlags::EvaluationDetail` | `value`, `reason` (`rule_match`, `default`, `off`, `flag_not_found`, `error`), `rule_index`, `rule_id`, `in_rollout`, `bucket`, `revision`, `trace`, `error`, `json`, `type_name` |
|
|
96
|
+
| `evaluate(key, default, context)` | engine result without a type check |
|
|
97
|
+
| `all_flags(context)` / `all_flags_detail(context)` | every flag of the loaded configuration (no telemetry) |
|
|
98
|
+
| `wait_until_ready(timeout)` → `true`/`false` | blocks until a configuration is in use or the first load failed |
|
|
99
|
+
| `status` (`"not-ready"` / `"ready"` / `"stale"`), `revision`, `transport` (`:stream` / `:poll`), `initialized?`, `last_error` | state |
|
|
100
|
+
| `on(:change \| :error \| :status) { … }`, `on_change { … }`, `on_error { … }` → unsubscribe lambda | listeners |
|
|
101
|
+
| `refresh`, `flush`, `close`, `start`, `NanoFlags::Client.after_fork` | revalidate now, send telemetry now, stop, start, restart after fork |
|
|
102
|
+
|
|
103
|
+
`base_url` defaults to the hosted edge `https://edge.nanoflags.io`. Errors are delivered to `on_error` as
|
|
104
|
+
`NanoFlags::Error` with a `code`: `:network`, `:unauthorized`, `:http`, `:invalid_bundle`, `:store`, `:config`,
|
|
105
|
+
`:signature`, `:engine`. Nothing is ever raised from a variation call.
|
|
106
|
+
|
|
107
|
+
## Behaviour
|
|
108
|
+
|
|
109
|
+
- **Fallbacks and staleness.** Until a configuration loads, variations return your default. Once loaded, the last
|
|
110
|
+
good configuration stays in use through network failures (`status` becomes `"stale"`).
|
|
111
|
+
- **Updates.** The client keeps `GET /v1/stream` open (key in the `Authorization` header, never in the URL); each
|
|
112
|
+
`revision` event makes it fetch `/v1/bundle` with `If-None-Match`, verify and swap the bundle atomically. A
|
|
113
|
+
`revoked` event stops the stream (the poll keeps reporting the key as rejected). Polling every `poll_interval`
|
|
114
|
+
(30 s; `0` disables it) catches anything the stream misses; after failures it retries after 1 s, 2 s, 4 s … up to
|
|
115
|
+
the poll interval. Stream reconnects back off up to 30 s. HTTP honours `HTTPS_PROXY` / `NO_PROXY` and
|
|
116
|
+
`SSL_CERT_FILE`. The live WebSocket (`/v1/live`) used by the JavaScript, Python and Go SDKs is not implemented yet;
|
|
117
|
+
with the event stream a new revision arrives after one extra conditional request.
|
|
118
|
+
- **Signature verification.** Every bundle is checked (Ed25519 over the canonical string, by `kid`) before it can
|
|
119
|
+
replace the current one. With the hosted edge this is on by default with the embedded production keys
|
|
120
|
+
(`NanoFlags::OFFICIAL_SIGNING_KEYS`) and unsigned bundles are refused; a bundle naming an unknown `kid` (key
|
|
121
|
+
rotation) loads `GET /v1/keys` once (at most once a minute). For a self-hosted edge pass
|
|
122
|
+
`verify: { public_keys: [jwk], require: true }` (or `verify: true` to use the edge's `/v1/keys`); `verify: false`
|
|
123
|
+
turns it off. Bundles signed for another environment than the first accepted one are refused. The raw signed bytes
|
|
124
|
+
are hashed exactly as served, never a re-serialisation.
|
|
125
|
+
- **Persistence and bootstrap.** `cache_path: "tmp/flags.json"` keeps the last good bundle (atomic write, mode 0600)
|
|
126
|
+
and restores it on start as `"stale"` until the edge confirms it; a restored copy is verified again and ignored if
|
|
127
|
+
it does not verify. `store:` takes any object with `get` / `set(text)` (`NanoFlags::Store::Cache.new(Rails.cache)`
|
|
128
|
+
shares it through an ActiveSupport cache). `bootstrap:` takes a bundle (Hash or JSON text) to serve immediately.
|
|
129
|
+
- **Engine version.** Bundles produced for a newer evaluation engine (`bundle.engine` > `NanoFlags::Engine::VERSION`)
|
|
130
|
+
are refused (`:engine`) and the current configuration stays in use: upgrade the gem.
|
|
131
|
+
- **Telemetry.** A sampled 10 % of evaluations are sent every 10 s, plus a service report every 60 s. Context
|
|
132
|
+
**values never leave the process** by default: only the names (and value types) of the attributes the flag's rules
|
|
133
|
+
use, e.g. `{"plan" => "string"}`. `events: { redact: ->(ctx) { … } }` customises this; `events: false` turns it off.
|
|
134
|
+
- **Threads.** The bundle is replaced as a single reference, so concurrent evaluations always see one consistent
|
|
135
|
+
revision. Listeners run on the client's background threads. `close` stops everything after a final flush.
|
|
136
|
+
- **Not included yet:** the live WebSocket and test sessions (`x-nanoflags-session`).
|
|
137
|
+
|
|
138
|
+
## Development
|
|
139
|
+
|
|
140
|
+
```sh
|
|
141
|
+
bundle install
|
|
142
|
+
bundle exec rake # unit, parity and local HTTP tests (no key, no network)
|
|
143
|
+
NANOFLAGS_LIVE=1 bundle exec rake # adds a read-only check against the hosted edge (public demo key)
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
`test/test_parity.rb` runs the shared engine fixtures (`../../packages/engine/fixtures/parity.json` and
|
|
147
|
+
`../../go/internal/testdata/extra.json`, or `NANOFLAGS_PARITY_FIXTURES` / `NANOFLAGS_EXTRA_FIXTURES`).
|
|
148
|
+
|
|
149
|
+
## License
|
|
150
|
+
|
|
151
|
+
Apache License 2.0 — see [LICENSE](LICENSE) and [NOTICE](NOTICE). The NanoFlags name and logo are not covered by
|
|
152
|
+
the license.
|