jsm.go 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665
  1. // Copyright 2021-2022 The NATS Authors
  2. // Licensed under the Apache License, Version 2.0 (the "License");
  3. // you may not use this file except in compliance with the License.
  4. // You may obtain a copy of the License at
  5. //
  6. // http://www.apache.org/licenses/LICENSE-2.0
  7. //
  8. // Unless required by applicable law or agreed to in writing, software
  9. // distributed under the License is distributed on an "AS IS" BASIS,
  10. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11. // See the License for the specific language governing permissions and
  12. // limitations under the License.
  13. package nats
  14. import (
  15. "context"
  16. "encoding/json"
  17. "errors"
  18. "fmt"
  19. "strconv"
  20. "strings"
  21. "time"
  22. )
  23. // JetStreamManager manages JetStream Streams and Consumers.
  24. type JetStreamManager interface {
  25. // AddStream creates a stream.
  26. AddStream(cfg *StreamConfig, opts ...JSOpt) (*StreamInfo, error)
  27. // UpdateStream updates a stream.
  28. UpdateStream(cfg *StreamConfig, opts ...JSOpt) (*StreamInfo, error)
  29. // DeleteStream deletes a stream.
  30. DeleteStream(name string, opts ...JSOpt) error
  31. // StreamInfo retrieves information from a stream.
  32. StreamInfo(stream string, opts ...JSOpt) (*StreamInfo, error)
  33. // PurgeStream purges a stream messages.
  34. PurgeStream(name string, opts ...JSOpt) error
  35. // StreamsInfo can be used to retrieve a list of StreamInfo objects.
  36. // DEPRECATED: Use Streams() instead.
  37. StreamsInfo(opts ...JSOpt) <-chan *StreamInfo
  38. // Streams can be used to retrieve a list of StreamInfo objects.
  39. Streams(opts ...JSOpt) <-chan *StreamInfo
  40. // StreamNames is used to retrieve a list of Stream names.
  41. StreamNames(opts ...JSOpt) <-chan string
  42. // GetMsg retrieves a raw stream message stored in JetStream by sequence number.
  43. // Use options nats.DirectGet() or nats.DirectGetNext() to trigger retrieval
  44. // directly from a distributed group of servers (leader and replicas).
  45. // The stream must have been created/updated with the AllowDirect boolean.
  46. GetMsg(name string, seq uint64, opts ...JSOpt) (*RawStreamMsg, error)
  47. // GetLastMsg retrieves the last raw stream message stored in JetStream by subject.
  48. // Use option nats.DirectGet() to trigger retrieval
  49. // directly from a distributed group of servers (leader and replicas).
  50. // The stream must have been created/updated with the AllowDirect boolean.
  51. GetLastMsg(name, subject string, opts ...JSOpt) (*RawStreamMsg, error)
  52. // DeleteMsg deletes a message from a stream. The message is marked as erased, but its value is not overwritten.
  53. DeleteMsg(name string, seq uint64, opts ...JSOpt) error
  54. // SecureDeleteMsg deletes a message from a stream. The deleted message is overwritten with random data
  55. // As a result, this operation is slower than DeleteMsg()
  56. SecureDeleteMsg(name string, seq uint64, opts ...JSOpt) error
  57. // AddConsumer adds a consumer to a stream.
  58. AddConsumer(stream string, cfg *ConsumerConfig, opts ...JSOpt) (*ConsumerInfo, error)
  59. // UpdateConsumer updates an existing consumer.
  60. UpdateConsumer(stream string, cfg *ConsumerConfig, opts ...JSOpt) (*ConsumerInfo, error)
  61. // DeleteConsumer deletes a consumer.
  62. DeleteConsumer(stream, consumer string, opts ...JSOpt) error
  63. // ConsumerInfo retrieves information of a consumer from a stream.
  64. ConsumerInfo(stream, name string, opts ...JSOpt) (*ConsumerInfo, error)
  65. // ConsumersInfo is used to retrieve a list of ConsumerInfo objects.
  66. // DEPRECATED: Use Consumers() instead.
  67. ConsumersInfo(stream string, opts ...JSOpt) <-chan *ConsumerInfo
  68. // Consumers is used to retrieve a list of ConsumerInfo objects.
  69. Consumers(stream string, opts ...JSOpt) <-chan *ConsumerInfo
  70. // ConsumerNames is used to retrieve a list of Consumer names.
  71. ConsumerNames(stream string, opts ...JSOpt) <-chan string
  72. // AccountInfo retrieves info about the JetStream usage from an account.
  73. AccountInfo(opts ...JSOpt) (*AccountInfo, error)
  74. // StreamNameBySubject returns a stream matching given subject.
  75. StreamNameBySubject(string, ...JSOpt) (string, error)
  76. }
  77. // StreamConfig will determine the properties for a stream.
  78. // There are sensible defaults for most. If no subjects are
  79. // given the name will be used as the only subject.
  80. type StreamConfig struct {
  81. Name string `json:"name"`
  82. Description string `json:"description,omitempty"`
  83. Subjects []string `json:"subjects,omitempty"`
  84. Retention RetentionPolicy `json:"retention"`
  85. MaxConsumers int `json:"max_consumers"`
  86. MaxMsgs int64 `json:"max_msgs"`
  87. MaxBytes int64 `json:"max_bytes"`
  88. Discard DiscardPolicy `json:"discard"`
  89. DiscardNewPerSubject bool `json:"discard_new_per_subject,omitempty"`
  90. MaxAge time.Duration `json:"max_age"`
  91. MaxMsgsPerSubject int64 `json:"max_msgs_per_subject"`
  92. MaxMsgSize int32 `json:"max_msg_size,omitempty"`
  93. Storage StorageType `json:"storage"`
  94. Replicas int `json:"num_replicas"`
  95. NoAck bool `json:"no_ack,omitempty"`
  96. Template string `json:"template_owner,omitempty"`
  97. Duplicates time.Duration `json:"duplicate_window,omitempty"`
  98. Placement *Placement `json:"placement,omitempty"`
  99. Mirror *StreamSource `json:"mirror,omitempty"`
  100. Sources []*StreamSource `json:"sources,omitempty"`
  101. Sealed bool `json:"sealed,omitempty"`
  102. DenyDelete bool `json:"deny_delete,omitempty"`
  103. DenyPurge bool `json:"deny_purge,omitempty"`
  104. AllowRollup bool `json:"allow_rollup_hdrs,omitempty"`
  105. Compression StoreCompression `json:"compression"`
  106. FirstSeq uint64 `json:"first_seq,omitempty"`
  107. // Allow applying a subject transform to incoming messages before doing anything else.
  108. SubjectTransform *SubjectTransformConfig `json:"subject_transform,omitempty"`
  109. // Allow republish of the message after being sequenced and stored.
  110. RePublish *RePublish `json:"republish,omitempty"`
  111. // Allow higher performance, direct access to get individual messages. E.g. KeyValue
  112. AllowDirect bool `json:"allow_direct"`
  113. // Allow higher performance and unified direct access for mirrors as well.
  114. MirrorDirect bool `json:"mirror_direct"`
  115. // Limits for consumers on this stream.
  116. ConsumerLimits StreamConsumerLimits `json:"consumer_limits,omitempty"`
  117. // Metadata is additional metadata for the Stream.
  118. // Keys starting with `_nats` are reserved.
  119. // NOTE: Metadata requires nats-server v2.10.0+
  120. Metadata map[string]string `json:"metadata,omitempty"`
  121. }
  122. // SubjectTransformConfig is for applying a subject transform (to matching messages) before doing anything else when a new message is received.
  123. type SubjectTransformConfig struct {
  124. Source string `json:"src,omitempty"`
  125. Destination string `json:"dest"`
  126. }
  127. // RePublish is for republishing messages once committed to a stream. The original
  128. // subject cis remapped from the subject pattern to the destination pattern.
  129. type RePublish struct {
  130. Source string `json:"src,omitempty"`
  131. Destination string `json:"dest"`
  132. HeadersOnly bool `json:"headers_only,omitempty"`
  133. }
  134. // Placement is used to guide placement of streams in clustered JetStream.
  135. type Placement struct {
  136. Cluster string `json:"cluster"`
  137. Tags []string `json:"tags,omitempty"`
  138. }
  139. // StreamSource dictates how streams can source from other streams.
  140. type StreamSource struct {
  141. Name string `json:"name"`
  142. OptStartSeq uint64 `json:"opt_start_seq,omitempty"`
  143. OptStartTime *time.Time `json:"opt_start_time,omitempty"`
  144. FilterSubject string `json:"filter_subject,omitempty"`
  145. SubjectTransforms []SubjectTransformConfig `json:"subject_transforms,omitempty"`
  146. External *ExternalStream `json:"external,omitempty"`
  147. Domain string `json:"-"`
  148. }
  149. // ExternalStream allows you to qualify access to a stream source in another
  150. // account.
  151. type ExternalStream struct {
  152. APIPrefix string `json:"api"`
  153. DeliverPrefix string `json:"deliver,omitempty"`
  154. }
  155. // StreamConsumerLimits are the limits for a consumer on a stream.
  156. // These can be overridden on a per consumer basis.
  157. type StreamConsumerLimits struct {
  158. InactiveThreshold time.Duration `json:"inactive_threshold,omitempty"`
  159. MaxAckPending int `json:"max_ack_pending,omitempty"`
  160. }
  161. // Helper for copying when we do not want to change user's version.
  162. func (ss *StreamSource) copy() *StreamSource {
  163. nss := *ss
  164. // Check pointers
  165. if ss.OptStartTime != nil {
  166. t := *ss.OptStartTime
  167. nss.OptStartTime = &t
  168. }
  169. if ss.External != nil {
  170. ext := *ss.External
  171. nss.External = &ext
  172. }
  173. return &nss
  174. }
  175. // If we have a Domain, convert to the appropriate ext.APIPrefix.
  176. // This will change the stream source, so should be a copy passed in.
  177. func (ss *StreamSource) convertDomain() error {
  178. if ss.Domain == _EMPTY_ {
  179. return nil
  180. }
  181. if ss.External != nil {
  182. // These should be mutually exclusive.
  183. // TODO(dlc) - Make generic?
  184. return errors.New("nats: domain and external are both set")
  185. }
  186. ss.External = &ExternalStream{APIPrefix: fmt.Sprintf(jsExtDomainT, ss.Domain)}
  187. return nil
  188. }
  189. // apiResponse is a standard response from the JetStream JSON API
  190. type apiResponse struct {
  191. Type string `json:"type"`
  192. Error *APIError `json:"error,omitempty"`
  193. }
  194. // apiPaged includes variables used to create paged responses from the JSON API
  195. type apiPaged struct {
  196. Total int `json:"total"`
  197. Offset int `json:"offset"`
  198. Limit int `json:"limit"`
  199. }
  200. // apiPagedRequest includes parameters allowing specific pages to be requested
  201. // from APIs responding with apiPaged.
  202. type apiPagedRequest struct {
  203. Offset int `json:"offset,omitempty"`
  204. }
  205. // AccountInfo contains info about the JetStream usage from the current account.
  206. type AccountInfo struct {
  207. Tier
  208. Domain string `json:"domain"`
  209. API APIStats `json:"api"`
  210. Tiers map[string]Tier `json:"tiers"`
  211. }
  212. type Tier struct {
  213. Memory uint64 `json:"memory"`
  214. Store uint64 `json:"storage"`
  215. Streams int `json:"streams"`
  216. Consumers int `json:"consumers"`
  217. Limits AccountLimits `json:"limits"`
  218. }
  219. // APIStats reports on API calls to JetStream for this account.
  220. type APIStats struct {
  221. Total uint64 `json:"total"`
  222. Errors uint64 `json:"errors"`
  223. }
  224. // AccountLimits includes the JetStream limits of the current account.
  225. type AccountLimits struct {
  226. MaxMemory int64 `json:"max_memory"`
  227. MaxStore int64 `json:"max_storage"`
  228. MaxStreams int `json:"max_streams"`
  229. MaxConsumers int `json:"max_consumers"`
  230. MaxAckPending int `json:"max_ack_pending"`
  231. MemoryMaxStreamBytes int64 `json:"memory_max_stream_bytes"`
  232. StoreMaxStreamBytes int64 `json:"storage_max_stream_bytes"`
  233. MaxBytesRequired bool `json:"max_bytes_required"`
  234. }
  235. type accountInfoResponse struct {
  236. apiResponse
  237. AccountInfo
  238. }
  239. // AccountInfo retrieves info about the JetStream usage from the current account.
  240. // If JetStream is not enabled, this will return ErrJetStreamNotEnabled
  241. // Other errors can happen but are generally considered retryable
  242. func (js *js) AccountInfo(opts ...JSOpt) (*AccountInfo, error) {
  243. o, cancel, err := getJSContextOpts(js.opts, opts...)
  244. if err != nil {
  245. return nil, err
  246. }
  247. if cancel != nil {
  248. defer cancel()
  249. }
  250. resp, err := js.apiRequestWithContext(o.ctx, js.apiSubj(apiAccountInfo), nil)
  251. if err != nil {
  252. // todo maybe nats server should never have no responder on this subject and always respond if they know there is no js to be had
  253. if err == ErrNoResponders {
  254. err = ErrJetStreamNotEnabled
  255. }
  256. return nil, err
  257. }
  258. var info accountInfoResponse
  259. if err := json.Unmarshal(resp.Data, &info); err != nil {
  260. return nil, err
  261. }
  262. if info.Error != nil {
  263. // Internally checks based on error code instead of description match.
  264. if errors.Is(info.Error, ErrJetStreamNotEnabledForAccount) {
  265. return nil, ErrJetStreamNotEnabledForAccount
  266. }
  267. return nil, info.Error
  268. }
  269. return &info.AccountInfo, nil
  270. }
  271. type createConsumerRequest struct {
  272. Stream string `json:"stream_name"`
  273. Config *ConsumerConfig `json:"config"`
  274. }
  275. type consumerResponse struct {
  276. apiResponse
  277. *ConsumerInfo
  278. }
  279. // AddConsumer will add a JetStream consumer.
  280. func (js *js) AddConsumer(stream string, cfg *ConsumerConfig, opts ...JSOpt) (*ConsumerInfo, error) {
  281. if cfg == nil {
  282. cfg = &ConsumerConfig{}
  283. }
  284. consumerName := cfg.Name
  285. if consumerName == _EMPTY_ {
  286. consumerName = cfg.Durable
  287. }
  288. if consumerName != _EMPTY_ {
  289. consInfo, err := js.ConsumerInfo(stream, consumerName, opts...)
  290. if err != nil && !errors.Is(err, ErrConsumerNotFound) && !errors.Is(err, ErrStreamNotFound) {
  291. return nil, err
  292. }
  293. if consInfo != nil {
  294. sameConfig := checkConfig(&consInfo.Config, cfg)
  295. if sameConfig != nil {
  296. return nil, fmt.Errorf("%w: creating consumer %q on stream %q", ErrConsumerNameAlreadyInUse, consumerName, stream)
  297. } else {
  298. return consInfo, nil
  299. }
  300. }
  301. }
  302. return js.upsertConsumer(stream, consumerName, cfg, opts...)
  303. }
  304. func (js *js) UpdateConsumer(stream string, cfg *ConsumerConfig, opts ...JSOpt) (*ConsumerInfo, error) {
  305. if cfg == nil {
  306. return nil, ErrConsumerConfigRequired
  307. }
  308. consumerName := cfg.Name
  309. if consumerName == _EMPTY_ {
  310. consumerName = cfg.Durable
  311. }
  312. if consumerName == _EMPTY_ {
  313. return nil, ErrConsumerNameRequired
  314. }
  315. return js.upsertConsumer(stream, consumerName, cfg, opts...)
  316. }
  317. func (js *js) upsertConsumer(stream, consumerName string, cfg *ConsumerConfig, opts ...JSOpt) (*ConsumerInfo, error) {
  318. if err := checkStreamName(stream); err != nil {
  319. return nil, err
  320. }
  321. o, cancel, err := getJSContextOpts(js.opts, opts...)
  322. if err != nil {
  323. return nil, err
  324. }
  325. if cancel != nil {
  326. defer cancel()
  327. }
  328. req, err := json.Marshal(&createConsumerRequest{Stream: stream, Config: cfg})
  329. if err != nil {
  330. return nil, err
  331. }
  332. var ccSubj string
  333. if consumerName == _EMPTY_ {
  334. // if consumer name is empty (neither Durable nor Name is set), use the legacy ephemeral endpoint
  335. ccSubj = fmt.Sprintf(apiLegacyConsumerCreateT, stream)
  336. } else if err := checkConsumerName(consumerName); err != nil {
  337. return nil, err
  338. } else if js.nc.serverMinVersion(2, 9, 0) {
  339. if cfg.Durable != "" && js.opts.featureFlags.useDurableConsumerCreate {
  340. // if user set the useDurableConsumerCreate flag, use the legacy DURABLE.CREATE endpoint
  341. ccSubj = fmt.Sprintf(apiDurableCreateT, stream, consumerName)
  342. } else if cfg.FilterSubject == _EMPTY_ || cfg.FilterSubject == ">" {
  343. // if filter subject is empty or ">", use the endpoint without filter subject
  344. ccSubj = fmt.Sprintf(apiConsumerCreateT, stream, consumerName)
  345. } else {
  346. // if filter subject is not empty, use the endpoint with filter subject
  347. ccSubj = fmt.Sprintf(apiConsumerCreateWithFilterSubjectT, stream, consumerName, cfg.FilterSubject)
  348. }
  349. } else {
  350. if cfg.Durable != "" {
  351. // if Durable is set, use the DURABLE.CREATE endpoint
  352. ccSubj = fmt.Sprintf(apiDurableCreateT, stream, consumerName)
  353. } else {
  354. // if Durable is not set, use the legacy ephemeral endpoint
  355. ccSubj = fmt.Sprintf(apiLegacyConsumerCreateT, stream)
  356. }
  357. }
  358. resp, err := js.apiRequestWithContext(o.ctx, js.apiSubj(ccSubj), req)
  359. if err != nil {
  360. if err == ErrNoResponders {
  361. err = ErrJetStreamNotEnabled
  362. }
  363. return nil, err
  364. }
  365. var info consumerResponse
  366. err = json.Unmarshal(resp.Data, &info)
  367. if err != nil {
  368. return nil, err
  369. }
  370. if info.Error != nil {
  371. if errors.Is(info.Error, ErrStreamNotFound) {
  372. return nil, ErrStreamNotFound
  373. }
  374. if errors.Is(info.Error, ErrConsumerNotFound) {
  375. return nil, ErrConsumerNotFound
  376. }
  377. return nil, info.Error
  378. }
  379. // check whether multiple filter subjects (if used) are reflected in the returned ConsumerInfo
  380. if len(cfg.FilterSubjects) != 0 && len(info.Config.FilterSubjects) == 0 {
  381. return nil, ErrConsumerMultipleFilterSubjectsNotSupported
  382. }
  383. return info.ConsumerInfo, nil
  384. }
  385. // consumerDeleteResponse is the response for a Consumer delete request.
  386. type consumerDeleteResponse struct {
  387. apiResponse
  388. Success bool `json:"success,omitempty"`
  389. }
  390. func checkStreamName(stream string) error {
  391. if stream == _EMPTY_ {
  392. return ErrStreamNameRequired
  393. }
  394. if strings.ContainsAny(stream, ". ") {
  395. return ErrInvalidStreamName
  396. }
  397. return nil
  398. }
  399. // Check that the consumer name is not empty and is valid (does not contain "." and " ").
  400. // Additional consumer name validation is done in nats-server.
  401. // Returns ErrConsumerNameRequired if consumer name is empty, ErrInvalidConsumerName is invalid, otherwise nil
  402. func checkConsumerName(consumer string) error {
  403. if consumer == _EMPTY_ {
  404. return ErrConsumerNameRequired
  405. }
  406. if strings.ContainsAny(consumer, ". ") {
  407. return ErrInvalidConsumerName
  408. }
  409. return nil
  410. }
  411. // DeleteConsumer deletes a Consumer.
  412. func (js *js) DeleteConsumer(stream, consumer string, opts ...JSOpt) error {
  413. if err := checkStreamName(stream); err != nil {
  414. return err
  415. }
  416. if err := checkConsumerName(consumer); err != nil {
  417. return err
  418. }
  419. o, cancel, err := getJSContextOpts(js.opts, opts...)
  420. if err != nil {
  421. return err
  422. }
  423. if cancel != nil {
  424. defer cancel()
  425. }
  426. dcSubj := js.apiSubj(fmt.Sprintf(apiConsumerDeleteT, stream, consumer))
  427. r, err := js.apiRequestWithContext(o.ctx, dcSubj, nil)
  428. if err != nil {
  429. return err
  430. }
  431. var resp consumerDeleteResponse
  432. if err := json.Unmarshal(r.Data, &resp); err != nil {
  433. return err
  434. }
  435. if resp.Error != nil {
  436. if errors.Is(resp.Error, ErrConsumerNotFound) {
  437. return ErrConsumerNotFound
  438. }
  439. return resp.Error
  440. }
  441. return nil
  442. }
  443. // ConsumerInfo returns information about a Consumer.
  444. func (js *js) ConsumerInfo(stream, consumer string, opts ...JSOpt) (*ConsumerInfo, error) {
  445. if err := checkStreamName(stream); err != nil {
  446. return nil, err
  447. }
  448. if err := checkConsumerName(consumer); err != nil {
  449. return nil, err
  450. }
  451. o, cancel, err := getJSContextOpts(js.opts, opts...)
  452. if err != nil {
  453. return nil, err
  454. }
  455. if cancel != nil {
  456. defer cancel()
  457. }
  458. return js.getConsumerInfoContext(o.ctx, stream, consumer)
  459. }
  460. // consumerLister fetches pages of ConsumerInfo objects. This object is not
  461. // safe to use for multiple threads.
  462. type consumerLister struct {
  463. stream string
  464. js *js
  465. err error
  466. offset int
  467. page []*ConsumerInfo
  468. pageInfo *apiPaged
  469. }
  470. // consumersRequest is the type used for Consumers requests.
  471. type consumersRequest struct {
  472. apiPagedRequest
  473. }
  474. // consumerListResponse is the response for a Consumers List request.
  475. type consumerListResponse struct {
  476. apiResponse
  477. apiPaged
  478. Consumers []*ConsumerInfo `json:"consumers"`
  479. }
  480. // Next fetches the next ConsumerInfo page.
  481. func (c *consumerLister) Next() bool {
  482. if c.err != nil {
  483. return false
  484. }
  485. if err := checkStreamName(c.stream); err != nil {
  486. c.err = err
  487. return false
  488. }
  489. if c.pageInfo != nil && c.offset >= c.pageInfo.Total {
  490. return false
  491. }
  492. req, err := json.Marshal(consumersRequest{
  493. apiPagedRequest: apiPagedRequest{Offset: c.offset},
  494. })
  495. if err != nil {
  496. c.err = err
  497. return false
  498. }
  499. var cancel context.CancelFunc
  500. ctx := c.js.opts.ctx
  501. if ctx == nil {
  502. ctx, cancel = context.WithTimeout(context.Background(), c.js.opts.wait)
  503. defer cancel()
  504. }
  505. clSubj := c.js.apiSubj(fmt.Sprintf(apiConsumerListT, c.stream))
  506. r, err := c.js.apiRequestWithContext(ctx, clSubj, req)
  507. if err != nil {
  508. c.err = err
  509. return false
  510. }
  511. var resp consumerListResponse
  512. if err := json.Unmarshal(r.Data, &resp); err != nil {
  513. c.err = err
  514. return false
  515. }
  516. if resp.Error != nil {
  517. c.err = resp.Error
  518. return false
  519. }
  520. c.pageInfo = &resp.apiPaged
  521. c.page = resp.Consumers
  522. c.offset += len(c.page)
  523. return true
  524. }
  525. // Page returns the current ConsumerInfo page.
  526. func (c *consumerLister) Page() []*ConsumerInfo {
  527. return c.page
  528. }
  529. // Err returns any errors found while fetching pages.
  530. func (c *consumerLister) Err() error {
  531. return c.err
  532. }
  533. // Consumers is used to retrieve a list of ConsumerInfo objects.
  534. func (jsc *js) Consumers(stream string, opts ...JSOpt) <-chan *ConsumerInfo {
  535. o, cancel, err := getJSContextOpts(jsc.opts, opts...)
  536. if err != nil {
  537. return nil
  538. }
  539. ch := make(chan *ConsumerInfo)
  540. l := &consumerLister{js: &js{nc: jsc.nc, opts: o}, stream: stream}
  541. go func() {
  542. if cancel != nil {
  543. defer cancel()
  544. }
  545. defer close(ch)
  546. for l.Next() {
  547. for _, info := range l.Page() {
  548. select {
  549. case ch <- info:
  550. case <-o.ctx.Done():
  551. return
  552. }
  553. }
  554. }
  555. }()
  556. return ch
  557. }
  558. // ConsumersInfo is used to retrieve a list of ConsumerInfo objects.
  559. // DEPRECATED: Use Consumers() instead.
  560. func (jsc *js) ConsumersInfo(stream string, opts ...JSOpt) <-chan *ConsumerInfo {
  561. return jsc.Consumers(stream, opts...)
  562. }
  563. type consumerNamesLister struct {
  564. stream string
  565. js *js
  566. err error
  567. offset int
  568. page []string
  569. pageInfo *apiPaged
  570. }
  571. // consumerNamesListResponse is the response for a Consumers Names List request.
  572. type consumerNamesListResponse struct {
  573. apiResponse
  574. apiPaged
  575. Consumers []string `json:"consumers"`
  576. }
  577. // Next fetches the next consumer names page.
  578. func (c *consumerNamesLister) Next() bool {
  579. if c.err != nil {
  580. return false
  581. }
  582. if err := checkStreamName(c.stream); err != nil {
  583. c.err = err
  584. return false
  585. }
  586. if c.pageInfo != nil && c.offset >= c.pageInfo.Total {
  587. return false
  588. }
  589. var cancel context.CancelFunc
  590. ctx := c.js.opts.ctx
  591. if ctx == nil {
  592. ctx, cancel = context.WithTimeout(context.Background(), c.js.opts.wait)
  593. defer cancel()
  594. }
  595. req, err := json.Marshal(consumersRequest{
  596. apiPagedRequest: apiPagedRequest{Offset: c.offset},
  597. })
  598. if err != nil {
  599. c.err = err
  600. return false
  601. }
  602. clSubj := c.js.apiSubj(fmt.Sprintf(apiConsumerNamesT, c.stream))
  603. r, err := c.js.apiRequestWithContext(ctx, clSubj, req)
  604. if err != nil {
  605. c.err = err
  606. return false
  607. }
  608. var resp consumerNamesListResponse
  609. if err := json.Unmarshal(r.Data, &resp); err != nil {
  610. c.err = err
  611. return false
  612. }
  613. if resp.Error != nil {
  614. c.err = resp.Error
  615. return false
  616. }
  617. c.pageInfo = &resp.apiPaged
  618. c.page = resp.Consumers
  619. c.offset += len(c.page)
  620. return true
  621. }
  622. // Page returns the current ConsumerInfo page.
  623. func (c *consumerNamesLister) Page() []string {
  624. return c.page
  625. }
  626. // Err returns any errors found while fetching pages.
  627. func (c *consumerNamesLister) Err() error {
  628. return c.err
  629. }
  630. // ConsumerNames is used to retrieve a list of Consumer names.
  631. func (jsc *js) ConsumerNames(stream string, opts ...JSOpt) <-chan string {
  632. o, cancel, err := getJSContextOpts(jsc.opts, opts...)
  633. if err != nil {
  634. return nil
  635. }
  636. ch := make(chan string)
  637. l := &consumerNamesLister{stream: stream, js: &js{nc: jsc.nc, opts: o}}
  638. go func() {
  639. if cancel != nil {
  640. defer cancel()
  641. }
  642. defer close(ch)
  643. for l.Next() {
  644. for _, info := range l.Page() {
  645. select {
  646. case ch <- info:
  647. case <-o.ctx.Done():
  648. return
  649. }
  650. }
  651. }
  652. }()
  653. return ch
  654. }
  655. // streamCreateResponse stream creation.
  656. type streamCreateResponse struct {
  657. apiResponse
  658. *StreamInfo
  659. }
  660. func (js *js) AddStream(cfg *StreamConfig, opts ...JSOpt) (*StreamInfo, error) {
  661. if cfg == nil {
  662. return nil, ErrStreamConfigRequired
  663. }
  664. if err := checkStreamName(cfg.Name); err != nil {
  665. return nil, err
  666. }
  667. o, cancel, err := getJSContextOpts(js.opts, opts...)
  668. if err != nil {
  669. return nil, err
  670. }
  671. if cancel != nil {
  672. defer cancel()
  673. }
  674. // In case we need to change anything, copy so we do not change the caller's version.
  675. ncfg := *cfg
  676. // If we have a mirror and an external domain, convert to ext.APIPrefix.
  677. if cfg.Mirror != nil && cfg.Mirror.Domain != _EMPTY_ {
  678. // Copy so we do not change the caller's version.
  679. ncfg.Mirror = ncfg.Mirror.copy()
  680. if err := ncfg.Mirror.convertDomain(); err != nil {
  681. return nil, err
  682. }
  683. }
  684. // Check sources for the same.
  685. if len(ncfg.Sources) > 0 {
  686. ncfg.Sources = append([]*StreamSource(nil), ncfg.Sources...)
  687. for i, ss := range ncfg.Sources {
  688. if ss.Domain != _EMPTY_ {
  689. ncfg.Sources[i] = ss.copy()
  690. if err := ncfg.Sources[i].convertDomain(); err != nil {
  691. return nil, err
  692. }
  693. }
  694. }
  695. }
  696. req, err := json.Marshal(&ncfg)
  697. if err != nil {
  698. return nil, err
  699. }
  700. csSubj := js.apiSubj(fmt.Sprintf(apiStreamCreateT, cfg.Name))
  701. r, err := js.apiRequestWithContext(o.ctx, csSubj, req)
  702. if err != nil {
  703. return nil, err
  704. }
  705. var resp streamCreateResponse
  706. if err := json.Unmarshal(r.Data, &resp); err != nil {
  707. return nil, err
  708. }
  709. if resp.Error != nil {
  710. if errors.Is(resp.Error, ErrStreamNameAlreadyInUse) {
  711. return nil, ErrStreamNameAlreadyInUse
  712. }
  713. return nil, resp.Error
  714. }
  715. // check that input subject transform (if used) is reflected in the returned ConsumerInfo
  716. if cfg.SubjectTransform != nil && resp.StreamInfo.Config.SubjectTransform == nil {
  717. return nil, ErrStreamSubjectTransformNotSupported
  718. }
  719. if len(cfg.Sources) != 0 {
  720. if len(cfg.Sources) != len(resp.Config.Sources) {
  721. return nil, ErrStreamSourceNotSupported
  722. }
  723. for i := range cfg.Sources {
  724. if len(cfg.Sources[i].SubjectTransforms) != 0 && len(resp.Sources[i].SubjectTransforms) == 0 {
  725. return nil, ErrStreamSourceMultipleSubjectTransformsNotSupported
  726. }
  727. }
  728. }
  729. return resp.StreamInfo, nil
  730. }
  731. type (
  732. // StreamInfoRequest contains additional option to return
  733. StreamInfoRequest struct {
  734. apiPagedRequest
  735. // DeletedDetails when true includes information about deleted messages
  736. DeletedDetails bool `json:"deleted_details,omitempty"`
  737. // SubjectsFilter when set, returns information on the matched subjects
  738. SubjectsFilter string `json:"subjects_filter,omitempty"`
  739. }
  740. streamInfoResponse = struct {
  741. apiResponse
  742. apiPaged
  743. *StreamInfo
  744. }
  745. )
  746. func (js *js) StreamInfo(stream string, opts ...JSOpt) (*StreamInfo, error) {
  747. if err := checkStreamName(stream); err != nil {
  748. return nil, err
  749. }
  750. o, cancel, err := getJSContextOpts(js.opts, opts...)
  751. if err != nil {
  752. return nil, err
  753. }
  754. if cancel != nil {
  755. defer cancel()
  756. }
  757. var i int
  758. var subjectMessagesMap map[string]uint64
  759. var req []byte
  760. var requestPayload bool
  761. var siOpts StreamInfoRequest
  762. if o.streamInfoOpts != nil {
  763. requestPayload = true
  764. siOpts = *o.streamInfoOpts
  765. }
  766. for {
  767. if requestPayload {
  768. siOpts.Offset = i
  769. if req, err = json.Marshal(&siOpts); err != nil {
  770. return nil, err
  771. }
  772. }
  773. siSubj := js.apiSubj(fmt.Sprintf(apiStreamInfoT, stream))
  774. r, err := js.apiRequestWithContext(o.ctx, siSubj, req)
  775. if err != nil {
  776. return nil, err
  777. }
  778. var resp streamInfoResponse
  779. if err := json.Unmarshal(r.Data, &resp); err != nil {
  780. return nil, err
  781. }
  782. if resp.Error != nil {
  783. if errors.Is(resp.Error, ErrStreamNotFound) {
  784. return nil, ErrStreamNotFound
  785. }
  786. return nil, resp.Error
  787. }
  788. var total int
  789. // for backwards compatibility
  790. if resp.Total != 0 {
  791. total = resp.Total
  792. } else {
  793. total = len(resp.State.Subjects)
  794. }
  795. if requestPayload && len(resp.StreamInfo.State.Subjects) > 0 {
  796. if subjectMessagesMap == nil {
  797. subjectMessagesMap = make(map[string]uint64, total)
  798. }
  799. for k, j := range resp.State.Subjects {
  800. subjectMessagesMap[k] = j
  801. i++
  802. }
  803. }
  804. if i >= total {
  805. if requestPayload {
  806. resp.StreamInfo.State.Subjects = subjectMessagesMap
  807. }
  808. return resp.StreamInfo, nil
  809. }
  810. }
  811. }
  812. // StreamInfo shows config and current state for this stream.
  813. type StreamInfo struct {
  814. Config StreamConfig `json:"config"`
  815. Created time.Time `json:"created"`
  816. State StreamState `json:"state"`
  817. Cluster *ClusterInfo `json:"cluster,omitempty"`
  818. Mirror *StreamSourceInfo `json:"mirror,omitempty"`
  819. Sources []*StreamSourceInfo `json:"sources,omitempty"`
  820. Alternates []*StreamAlternate `json:"alternates,omitempty"`
  821. }
  822. // StreamAlternate is an alternate stream represented by a mirror.
  823. type StreamAlternate struct {
  824. Name string `json:"name"`
  825. Domain string `json:"domain,omitempty"`
  826. Cluster string `json:"cluster"`
  827. }
  828. // StreamSourceInfo shows information about an upstream stream source.
  829. type StreamSourceInfo struct {
  830. Name string `json:"name"`
  831. Lag uint64 `json:"lag"`
  832. Active time.Duration `json:"active"`
  833. External *ExternalStream `json:"external"`
  834. Error *APIError `json:"error"`
  835. FilterSubject string `json:"filter_subject,omitempty"`
  836. SubjectTransforms []SubjectTransformConfig `json:"subject_transforms,omitempty"`
  837. }
  838. // StreamState is information about the given stream.
  839. type StreamState struct {
  840. Msgs uint64 `json:"messages"`
  841. Bytes uint64 `json:"bytes"`
  842. FirstSeq uint64 `json:"first_seq"`
  843. FirstTime time.Time `json:"first_ts"`
  844. LastSeq uint64 `json:"last_seq"`
  845. LastTime time.Time `json:"last_ts"`
  846. Consumers int `json:"consumer_count"`
  847. Deleted []uint64 `json:"deleted"`
  848. NumDeleted int `json:"num_deleted"`
  849. NumSubjects uint64 `json:"num_subjects"`
  850. Subjects map[string]uint64 `json:"subjects"`
  851. }
  852. // ClusterInfo shows information about the underlying set of servers
  853. // that make up the stream or consumer.
  854. type ClusterInfo struct {
  855. Name string `json:"name,omitempty"`
  856. Leader string `json:"leader,omitempty"`
  857. Replicas []*PeerInfo `json:"replicas,omitempty"`
  858. }
  859. // PeerInfo shows information about all the peers in the cluster that
  860. // are supporting the stream or consumer.
  861. type PeerInfo struct {
  862. Name string `json:"name"`
  863. Current bool `json:"current"`
  864. Offline bool `json:"offline,omitempty"`
  865. Active time.Duration `json:"active"`
  866. Lag uint64 `json:"lag,omitempty"`
  867. }
  868. // UpdateStream updates a Stream.
  869. func (js *js) UpdateStream(cfg *StreamConfig, opts ...JSOpt) (*StreamInfo, error) {
  870. if cfg == nil {
  871. return nil, ErrStreamConfigRequired
  872. }
  873. if err := checkStreamName(cfg.Name); err != nil {
  874. return nil, err
  875. }
  876. o, cancel, err := getJSContextOpts(js.opts, opts...)
  877. if err != nil {
  878. return nil, err
  879. }
  880. if cancel != nil {
  881. defer cancel()
  882. }
  883. req, err := json.Marshal(cfg)
  884. if err != nil {
  885. return nil, err
  886. }
  887. usSubj := js.apiSubj(fmt.Sprintf(apiStreamUpdateT, cfg.Name))
  888. r, err := js.apiRequestWithContext(o.ctx, usSubj, req)
  889. if err != nil {
  890. return nil, err
  891. }
  892. var resp streamInfoResponse
  893. if err := json.Unmarshal(r.Data, &resp); err != nil {
  894. return nil, err
  895. }
  896. if resp.Error != nil {
  897. if errors.Is(resp.Error, ErrStreamNotFound) {
  898. return nil, ErrStreamNotFound
  899. }
  900. return nil, resp.Error
  901. }
  902. // check that input subject transform (if used) is reflected in the returned StreamInfo
  903. if cfg.SubjectTransform != nil && resp.StreamInfo.Config.SubjectTransform == nil {
  904. return nil, ErrStreamSubjectTransformNotSupported
  905. }
  906. if len(cfg.Sources) != 0 {
  907. if len(cfg.Sources) != len(resp.Config.Sources) {
  908. return nil, ErrStreamSourceNotSupported
  909. }
  910. for i := range cfg.Sources {
  911. if len(cfg.Sources[i].SubjectTransforms) != 0 && len(resp.Sources[i].SubjectTransforms) == 0 {
  912. return nil, ErrStreamSourceMultipleSubjectTransformsNotSupported
  913. }
  914. }
  915. }
  916. return resp.StreamInfo, nil
  917. }
  918. // streamDeleteResponse is the response for a Stream delete request.
  919. type streamDeleteResponse struct {
  920. apiResponse
  921. Success bool `json:"success,omitempty"`
  922. }
  923. // DeleteStream deletes a Stream.
  924. func (js *js) DeleteStream(name string, opts ...JSOpt) error {
  925. if err := checkStreamName(name); err != nil {
  926. return err
  927. }
  928. o, cancel, err := getJSContextOpts(js.opts, opts...)
  929. if err != nil {
  930. return err
  931. }
  932. if cancel != nil {
  933. defer cancel()
  934. }
  935. dsSubj := js.apiSubj(fmt.Sprintf(apiStreamDeleteT, name))
  936. r, err := js.apiRequestWithContext(o.ctx, dsSubj, nil)
  937. if err != nil {
  938. return err
  939. }
  940. var resp streamDeleteResponse
  941. if err := json.Unmarshal(r.Data, &resp); err != nil {
  942. return err
  943. }
  944. if resp.Error != nil {
  945. if errors.Is(resp.Error, ErrStreamNotFound) {
  946. return ErrStreamNotFound
  947. }
  948. return resp.Error
  949. }
  950. return nil
  951. }
  952. type apiMsgGetRequest struct {
  953. Seq uint64 `json:"seq,omitempty"`
  954. LastFor string `json:"last_by_subj,omitempty"`
  955. NextFor string `json:"next_by_subj,omitempty"`
  956. }
  957. // RawStreamMsg is a raw message stored in JetStream.
  958. type RawStreamMsg struct {
  959. Subject string
  960. Sequence uint64
  961. Header Header
  962. Data []byte
  963. Time time.Time
  964. }
  965. // storedMsg is a raw message stored in JetStream.
  966. type storedMsg struct {
  967. Subject string `json:"subject"`
  968. Sequence uint64 `json:"seq"`
  969. Header []byte `json:"hdrs,omitempty"`
  970. Data []byte `json:"data,omitempty"`
  971. Time time.Time `json:"time"`
  972. }
  973. // apiMsgGetResponse is the response for a Stream get request.
  974. type apiMsgGetResponse struct {
  975. apiResponse
  976. Message *storedMsg `json:"message,omitempty"`
  977. }
  978. // GetLastMsg retrieves the last raw stream message stored in JetStream by subject.
  979. func (js *js) GetLastMsg(name, subject string, opts ...JSOpt) (*RawStreamMsg, error) {
  980. return js.getMsg(name, &apiMsgGetRequest{LastFor: subject}, opts...)
  981. }
  982. // GetMsg retrieves a raw stream message stored in JetStream by sequence number.
  983. func (js *js) GetMsg(name string, seq uint64, opts ...JSOpt) (*RawStreamMsg, error) {
  984. return js.getMsg(name, &apiMsgGetRequest{Seq: seq}, opts...)
  985. }
  986. // Low level getMsg
  987. func (js *js) getMsg(name string, mreq *apiMsgGetRequest, opts ...JSOpt) (*RawStreamMsg, error) {
  988. o, cancel, err := getJSContextOpts(js.opts, opts...)
  989. if err != nil {
  990. return nil, err
  991. }
  992. if cancel != nil {
  993. defer cancel()
  994. }
  995. if err := checkStreamName(name); err != nil {
  996. return nil, err
  997. }
  998. var apiSubj string
  999. if o.directGet && mreq.LastFor != _EMPTY_ {
  1000. apiSubj = apiDirectMsgGetLastBySubjectT
  1001. dsSubj := js.apiSubj(fmt.Sprintf(apiSubj, name, mreq.LastFor))
  1002. r, err := js.apiRequestWithContext(o.ctx, dsSubj, nil)
  1003. if err != nil {
  1004. return nil, err
  1005. }
  1006. return convertDirectGetMsgResponseToMsg(name, r)
  1007. }
  1008. if o.directGet {
  1009. apiSubj = apiDirectMsgGetT
  1010. mreq.NextFor = o.directNextFor
  1011. } else {
  1012. apiSubj = apiMsgGetT
  1013. }
  1014. req, err := json.Marshal(mreq)
  1015. if err != nil {
  1016. return nil, err
  1017. }
  1018. dsSubj := js.apiSubj(fmt.Sprintf(apiSubj, name))
  1019. r, err := js.apiRequestWithContext(o.ctx, dsSubj, req)
  1020. if err != nil {
  1021. return nil, err
  1022. }
  1023. if o.directGet {
  1024. return convertDirectGetMsgResponseToMsg(name, r)
  1025. }
  1026. var resp apiMsgGetResponse
  1027. if err := json.Unmarshal(r.Data, &resp); err != nil {
  1028. return nil, err
  1029. }
  1030. if resp.Error != nil {
  1031. if errors.Is(resp.Error, ErrMsgNotFound) {
  1032. return nil, ErrMsgNotFound
  1033. }
  1034. if errors.Is(resp.Error, ErrStreamNotFound) {
  1035. return nil, ErrStreamNotFound
  1036. }
  1037. return nil, resp.Error
  1038. }
  1039. msg := resp.Message
  1040. var hdr Header
  1041. if len(msg.Header) > 0 {
  1042. hdr, err = DecodeHeadersMsg(msg.Header)
  1043. if err != nil {
  1044. return nil, err
  1045. }
  1046. }
  1047. return &RawStreamMsg{
  1048. Subject: msg.Subject,
  1049. Sequence: msg.Sequence,
  1050. Header: hdr,
  1051. Data: msg.Data,
  1052. Time: msg.Time,
  1053. }, nil
  1054. }
  1055. func convertDirectGetMsgResponseToMsg(name string, r *Msg) (*RawStreamMsg, error) {
  1056. // Check for 404/408. We would get a no-payload message and a "Status" header
  1057. if len(r.Data) == 0 {
  1058. val := r.Header.Get(statusHdr)
  1059. if val != _EMPTY_ {
  1060. switch val {
  1061. case noMessagesSts:
  1062. return nil, ErrMsgNotFound
  1063. default:
  1064. desc := r.Header.Get(descrHdr)
  1065. if desc == _EMPTY_ {
  1066. desc = "unable to get message"
  1067. }
  1068. return nil, fmt.Errorf("nats: %s", desc)
  1069. }
  1070. }
  1071. }
  1072. // Check for headers that give us the required information to
  1073. // reconstruct the message.
  1074. if len(r.Header) == 0 {
  1075. return nil, fmt.Errorf("nats: response should have headers")
  1076. }
  1077. stream := r.Header.Get(JSStream)
  1078. if stream == _EMPTY_ {
  1079. return nil, fmt.Errorf("nats: missing stream header")
  1080. }
  1081. // Mirrors can now answer direct gets, so removing check for name equality.
  1082. // TODO(dlc) - We could have server also have a header with origin and check that?
  1083. seqStr := r.Header.Get(JSSequence)
  1084. if seqStr == _EMPTY_ {
  1085. return nil, fmt.Errorf("nats: missing sequence header")
  1086. }
  1087. seq, err := strconv.ParseUint(seqStr, 10, 64)
  1088. if err != nil {
  1089. return nil, fmt.Errorf("nats: invalid sequence header '%s': %v", seqStr, err)
  1090. }
  1091. timeStr := r.Header.Get(JSTimeStamp)
  1092. if timeStr == _EMPTY_ {
  1093. return nil, fmt.Errorf("nats: missing timestamp header")
  1094. }
  1095. // Temporary code: the server in main branch is sending with format
  1096. // "2006-01-02 15:04:05.999999999 +0000 UTC", but will be changed
  1097. // to use format RFC3339Nano. Because of server test deps/cycle,
  1098. // support both until the server PR lands.
  1099. tm, err := time.Parse(time.RFC3339Nano, timeStr)
  1100. if err != nil {
  1101. tm, err = time.Parse("2006-01-02 15:04:05.999999999 +0000 UTC", timeStr)
  1102. if err != nil {
  1103. return nil, fmt.Errorf("nats: invalid timestamp header '%s': %v", timeStr, err)
  1104. }
  1105. }
  1106. subj := r.Header.Get(JSSubject)
  1107. if subj == _EMPTY_ {
  1108. return nil, fmt.Errorf("nats: missing subject header")
  1109. }
  1110. return &RawStreamMsg{
  1111. Subject: subj,
  1112. Sequence: seq,
  1113. Header: r.Header,
  1114. Data: r.Data,
  1115. Time: tm,
  1116. }, nil
  1117. }
  1118. type msgDeleteRequest struct {
  1119. Seq uint64 `json:"seq"`
  1120. NoErase bool `json:"no_erase,omitempty"`
  1121. }
  1122. // msgDeleteResponse is the response for a Stream delete request.
  1123. type msgDeleteResponse struct {
  1124. apiResponse
  1125. Success bool `json:"success,omitempty"`
  1126. }
  1127. // DeleteMsg deletes a message from a stream.
  1128. // The message is marked as erased, but not overwritten
  1129. func (js *js) DeleteMsg(name string, seq uint64, opts ...JSOpt) error {
  1130. o, cancel, err := getJSContextOpts(js.opts, opts...)
  1131. if err != nil {
  1132. return err
  1133. }
  1134. if cancel != nil {
  1135. defer cancel()
  1136. }
  1137. return js.deleteMsg(o.ctx, name, &msgDeleteRequest{Seq: seq, NoErase: true})
  1138. }
  1139. // SecureDeleteMsg deletes a message from a stream. The deleted message is overwritten with random data
  1140. // As a result, this operation is slower than DeleteMsg()
  1141. func (js *js) SecureDeleteMsg(name string, seq uint64, opts ...JSOpt) error {
  1142. o, cancel, err := getJSContextOpts(js.opts, opts...)
  1143. if err != nil {
  1144. return err
  1145. }
  1146. if cancel != nil {
  1147. defer cancel()
  1148. }
  1149. return js.deleteMsg(o.ctx, name, &msgDeleteRequest{Seq: seq})
  1150. }
  1151. func (js *js) deleteMsg(ctx context.Context, stream string, req *msgDeleteRequest) error {
  1152. if err := checkStreamName(stream); err != nil {
  1153. return err
  1154. }
  1155. reqJSON, err := json.Marshal(req)
  1156. if err != nil {
  1157. return err
  1158. }
  1159. dsSubj := js.apiSubj(fmt.Sprintf(apiMsgDeleteT, stream))
  1160. r, err := js.apiRequestWithContext(ctx, dsSubj, reqJSON)
  1161. if err != nil {
  1162. return err
  1163. }
  1164. var resp msgDeleteResponse
  1165. if err := json.Unmarshal(r.Data, &resp); err != nil {
  1166. return err
  1167. }
  1168. if resp.Error != nil {
  1169. return resp.Error
  1170. }
  1171. return nil
  1172. }
  1173. // StreamPurgeRequest is optional request information to the purge API.
  1174. type StreamPurgeRequest struct {
  1175. // Purge up to but not including sequence.
  1176. Sequence uint64 `json:"seq,omitempty"`
  1177. // Subject to match against messages for the purge command.
  1178. Subject string `json:"filter,omitempty"`
  1179. // Number of messages to keep.
  1180. Keep uint64 `json:"keep,omitempty"`
  1181. }
  1182. type streamPurgeResponse struct {
  1183. apiResponse
  1184. Success bool `json:"success,omitempty"`
  1185. Purged uint64 `json:"purged"`
  1186. }
  1187. // PurgeStream purges messages on a Stream.
  1188. func (js *js) PurgeStream(stream string, opts ...JSOpt) error {
  1189. if err := checkStreamName(stream); err != nil {
  1190. return err
  1191. }
  1192. var req *StreamPurgeRequest
  1193. var ok bool
  1194. for _, opt := range opts {
  1195. // For PurgeStream, only request body opt is relevant
  1196. if req, ok = opt.(*StreamPurgeRequest); ok {
  1197. break
  1198. }
  1199. }
  1200. return js.purgeStream(stream, req)
  1201. }
  1202. func (js *js) purgeStream(stream string, req *StreamPurgeRequest, opts ...JSOpt) error {
  1203. o, cancel, err := getJSContextOpts(js.opts, opts...)
  1204. if err != nil {
  1205. return err
  1206. }
  1207. if cancel != nil {
  1208. defer cancel()
  1209. }
  1210. var b []byte
  1211. if req != nil {
  1212. if b, err = json.Marshal(req); err != nil {
  1213. return err
  1214. }
  1215. }
  1216. psSubj := js.apiSubj(fmt.Sprintf(apiStreamPurgeT, stream))
  1217. r, err := js.apiRequestWithContext(o.ctx, psSubj, b)
  1218. if err != nil {
  1219. return err
  1220. }
  1221. var resp streamPurgeResponse
  1222. if err := json.Unmarshal(r.Data, &resp); err != nil {
  1223. return err
  1224. }
  1225. if resp.Error != nil {
  1226. if errors.Is(resp.Error, ErrBadRequest) {
  1227. return fmt.Errorf("%w: %s", ErrBadRequest, "invalid purge request body")
  1228. }
  1229. return resp.Error
  1230. }
  1231. return nil
  1232. }
  1233. // streamLister fetches pages of StreamInfo objects. This object is not safe
  1234. // to use for multiple threads.
  1235. type streamLister struct {
  1236. js *js
  1237. page []*StreamInfo
  1238. err error
  1239. offset int
  1240. pageInfo *apiPaged
  1241. }
  1242. // streamListResponse list of detailed stream information.
  1243. // A nil request is valid and means all streams.
  1244. type streamListResponse struct {
  1245. apiResponse
  1246. apiPaged
  1247. Streams []*StreamInfo `json:"streams"`
  1248. }
  1249. // streamNamesRequest is used for Stream Name requests.
  1250. type streamNamesRequest struct {
  1251. apiPagedRequest
  1252. // These are filters that can be applied to the list.
  1253. Subject string `json:"subject,omitempty"`
  1254. }
  1255. // Next fetches the next StreamInfo page.
  1256. func (s *streamLister) Next() bool {
  1257. if s.err != nil {
  1258. return false
  1259. }
  1260. if s.pageInfo != nil && s.offset >= s.pageInfo.Total {
  1261. return false
  1262. }
  1263. req, err := json.Marshal(streamNamesRequest{
  1264. apiPagedRequest: apiPagedRequest{Offset: s.offset},
  1265. Subject: s.js.opts.streamListSubject,
  1266. })
  1267. if err != nil {
  1268. s.err = err
  1269. return false
  1270. }
  1271. var cancel context.CancelFunc
  1272. ctx := s.js.opts.ctx
  1273. if ctx == nil {
  1274. ctx, cancel = context.WithTimeout(context.Background(), s.js.opts.wait)
  1275. defer cancel()
  1276. }
  1277. slSubj := s.js.apiSubj(apiStreamListT)
  1278. r, err := s.js.apiRequestWithContext(ctx, slSubj, req)
  1279. if err != nil {
  1280. s.err = err
  1281. return false
  1282. }
  1283. var resp streamListResponse
  1284. if err := json.Unmarshal(r.Data, &resp); err != nil {
  1285. s.err = err
  1286. return false
  1287. }
  1288. if resp.Error != nil {
  1289. s.err = resp.Error
  1290. return false
  1291. }
  1292. s.pageInfo = &resp.apiPaged
  1293. s.page = resp.Streams
  1294. s.offset += len(s.page)
  1295. return true
  1296. }
  1297. // Page returns the current StreamInfo page.
  1298. func (s *streamLister) Page() []*StreamInfo {
  1299. return s.page
  1300. }
  1301. // Err returns any errors found while fetching pages.
  1302. func (s *streamLister) Err() error {
  1303. return s.err
  1304. }
  1305. // Streams can be used to retrieve a list of StreamInfo objects.
  1306. func (jsc *js) Streams(opts ...JSOpt) <-chan *StreamInfo {
  1307. o, cancel, err := getJSContextOpts(jsc.opts, opts...)
  1308. if err != nil {
  1309. return nil
  1310. }
  1311. ch := make(chan *StreamInfo)
  1312. l := &streamLister{js: &js{nc: jsc.nc, opts: o}}
  1313. go func() {
  1314. if cancel != nil {
  1315. defer cancel()
  1316. }
  1317. defer close(ch)
  1318. for l.Next() {
  1319. for _, info := range l.Page() {
  1320. select {
  1321. case ch <- info:
  1322. case <-o.ctx.Done():
  1323. return
  1324. }
  1325. }
  1326. }
  1327. }()
  1328. return ch
  1329. }
  1330. // StreamsInfo can be used to retrieve a list of StreamInfo objects.
  1331. // DEPRECATED: Use Streams() instead.
  1332. func (jsc *js) StreamsInfo(opts ...JSOpt) <-chan *StreamInfo {
  1333. return jsc.Streams(opts...)
  1334. }
  1335. type streamNamesLister struct {
  1336. js *js
  1337. err error
  1338. offset int
  1339. page []string
  1340. pageInfo *apiPaged
  1341. }
  1342. // Next fetches the next stream names page.
  1343. func (l *streamNamesLister) Next() bool {
  1344. if l.err != nil {
  1345. return false
  1346. }
  1347. if l.pageInfo != nil && l.offset >= l.pageInfo.Total {
  1348. return false
  1349. }
  1350. var cancel context.CancelFunc
  1351. ctx := l.js.opts.ctx
  1352. if ctx == nil {
  1353. ctx, cancel = context.WithTimeout(context.Background(), l.js.opts.wait)
  1354. defer cancel()
  1355. }
  1356. req, err := json.Marshal(streamNamesRequest{
  1357. apiPagedRequest: apiPagedRequest{Offset: l.offset},
  1358. Subject: l.js.opts.streamListSubject,
  1359. })
  1360. if err != nil {
  1361. l.err = err
  1362. return false
  1363. }
  1364. r, err := l.js.apiRequestWithContext(ctx, l.js.apiSubj(apiStreams), req)
  1365. if err != nil {
  1366. l.err = err
  1367. return false
  1368. }
  1369. var resp streamNamesResponse
  1370. if err := json.Unmarshal(r.Data, &resp); err != nil {
  1371. l.err = err
  1372. return false
  1373. }
  1374. if resp.Error != nil {
  1375. l.err = resp.Error
  1376. return false
  1377. }
  1378. l.pageInfo = &resp.apiPaged
  1379. l.page = resp.Streams
  1380. l.offset += len(l.page)
  1381. return true
  1382. }
  1383. // Page returns the current ConsumerInfo page.
  1384. func (l *streamNamesLister) Page() []string {
  1385. return l.page
  1386. }
  1387. // Err returns any errors found while fetching pages.
  1388. func (l *streamNamesLister) Err() error {
  1389. return l.err
  1390. }
  1391. // StreamNames is used to retrieve a list of Stream names.
  1392. func (jsc *js) StreamNames(opts ...JSOpt) <-chan string {
  1393. o, cancel, err := getJSContextOpts(jsc.opts, opts...)
  1394. if err != nil {
  1395. return nil
  1396. }
  1397. ch := make(chan string)
  1398. l := &streamNamesLister{js: &js{nc: jsc.nc, opts: o}}
  1399. go func() {
  1400. if cancel != nil {
  1401. defer cancel()
  1402. }
  1403. defer close(ch)
  1404. for l.Next() {
  1405. for _, info := range l.Page() {
  1406. select {
  1407. case ch <- info:
  1408. case <-o.ctx.Done():
  1409. return
  1410. }
  1411. }
  1412. }
  1413. }()
  1414. return ch
  1415. }
  1416. // StreamNameBySubject returns a stream name that matches the subject.
  1417. func (jsc *js) StreamNameBySubject(subj string, opts ...JSOpt) (string, error) {
  1418. o, cancel, err := getJSContextOpts(jsc.opts, opts...)
  1419. if err != nil {
  1420. return "", err
  1421. }
  1422. if cancel != nil {
  1423. defer cancel()
  1424. }
  1425. var slr streamNamesResponse
  1426. req := &streamRequest{subj}
  1427. j, err := json.Marshal(req)
  1428. if err != nil {
  1429. return _EMPTY_, err
  1430. }
  1431. resp, err := jsc.apiRequestWithContext(o.ctx, jsc.apiSubj(apiStreams), j)
  1432. if err != nil {
  1433. if err == ErrNoResponders {
  1434. err = ErrJetStreamNotEnabled
  1435. }
  1436. return _EMPTY_, err
  1437. }
  1438. if err := json.Unmarshal(resp.Data, &slr); err != nil {
  1439. return _EMPTY_, err
  1440. }
  1441. if slr.Error != nil || len(slr.Streams) != 1 {
  1442. return _EMPTY_, ErrNoMatchingStream
  1443. }
  1444. return slr.Streams[0], nil
  1445. }
  1446. func getJSContextOpts(defs *jsOpts, opts ...JSOpt) (*jsOpts, context.CancelFunc, error) {
  1447. var o jsOpts
  1448. for _, opt := range opts {
  1449. if err := opt.configureJSContext(&o); err != nil {
  1450. return nil, nil, err
  1451. }
  1452. }
  1453. // Check for option collisions. Right now just timeout and context.
  1454. if o.ctx != nil && o.wait != 0 {
  1455. return nil, nil, ErrContextAndTimeout
  1456. }
  1457. if o.wait == 0 && o.ctx == nil {
  1458. o.wait = defs.wait
  1459. }
  1460. var cancel context.CancelFunc
  1461. if o.ctx == nil && o.wait > 0 {
  1462. o.ctx, cancel = context.WithTimeout(context.Background(), o.wait)
  1463. }
  1464. if o.pre == _EMPTY_ {
  1465. o.pre = defs.pre
  1466. }
  1467. return &o, cancel, nil
  1468. }