forked from keybase/client
-
Notifications
You must be signed in to change notification settings - Fork 0
/
favorites.go
757 lines (692 loc) · 19.8 KB
/
favorites.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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
// Copyright 2016 Keybase Inc. All rights reserved.
// Use of this source code is governed by a BSD
// license that can be found in the LICENSE file.
package libkbfs
import (
"errors"
"fmt"
"os"
"strings"
"sync"
"time"
"github.com/keybase/client/go/kbfs/favorites"
"github.com/keybase/client/go/kbfs/kbfssync"
"github.com/keybase/client/go/kbfs/tlf"
"github.com/keybase/client/go/libkb"
"github.com/keybase/client/go/logger"
"github.com/keybase/client/go/protocol/keybase1"
"github.com/syndtr/goleveldb/leveldb"
"github.com/syndtr/goleveldb/leveldb/storage"
"golang.org/x/net/context"
)
const (
disableFavoritesEnvVar = "KEYBASE_DISABLE_FAVORITES"
favoritesCacheExpirationTime = time.Hour * 24 * 7 // one week
kbfsFavoritesCacheSubfolder = "kbfs_favorites"
favoritesDiskCacheFilename = "kbfsFavorites.leveldb"
favoritesDiskCacheVersion = 2
favoritesDiskCacheStorageVersion = 1
)
var errNoFavoritesCache = errors.New("disk favorites cache not present")
type errIncorrectFavoritesCacheVersion struct {
cache string
version int
}
func (e errIncorrectFavoritesCacheVersion) Error() string {
return fmt.Sprintf("decoding of %s favorites cache failed: version was %d",
e.cache, e.version)
}
// favReq represents a request to access the logged-in user's
// favorites list. A single request can do one or more of the
// following: refresh the current cached list, add a favorite, remove
// a favorite, and get all the favorites. When the request is done,
// the resulting error (or nil) is sent over the done channel. The
// given ctx is used for all network operations.
type favReq struct {
// Request types
clear bool
refresh bool
toAdd []favorites.ToAdd
toDel []favorites.Folder
favs chan<- []favorites.Folder
favsAll chan<- keybase1.FavoritesResult
homeTLFInfo *homeTLFInfo
// Closed when the request is done.
done chan struct{}
// Set before done is closed
err error
// Context
ctx context.Context
}
type homeTLFInfo struct {
PublicTeamID keybase1.TeamID
PrivateTeamID keybase1.TeamID
}
// Favorites manages a user's favorite list.
type Favorites struct {
config Config
disabled bool
log logger.Logger
// homeTLFInfo stores the IDs for the logged-in user's home TLFs
homeTLFInfo homeTLFInfo
// Channels for interacting with the favorites cache
reqChan chan *favReq
wg kbfssync.RepeatedWaitGroup
// cache tracks the favorites for this user, that we know about.
// It may not be consistent with the server's view of the user's
// favorites list, if other devices have modified the list since
// the last refresh and this device is offline.
// When another device modifies the favorites [or new or ignored] list,
// the server will try to alert the other devices to refresh.
favCache map[favorites.Folder]favorites.Data
newCache map[favorites.Folder]favorites.Data
ignoredCache map[favorites.Folder]favorites.Data
cacheExpireTime time.Time
diskCache *LevelDb
inFlightLock sync.Mutex
inFlightAdds map[favorites.Folder]*favReq
muShutdown sync.RWMutex
shutdown bool
}
func newFavoritesWithChan(config Config, reqChan chan *favReq) *Favorites {
disableVal := strings.ToLower(os.Getenv(disableFavoritesEnvVar))
log := config.MakeLogger("FAV")
if len(disableVal) > 0 && disableVal != "0" && disableVal != "false" &&
disableVal != "no" {
log.CDebugf(nil,
"Disable favorites due to env var %s=%s",
disableFavoritesEnvVar, disableVal)
return &Favorites{
config: config,
disabled: true,
log: log,
}
}
f := &Favorites{
config: config,
reqChan: reqChan,
inFlightAdds: make(map[favorites.Folder]*favReq),
log: log,
}
return f
}
// NewFavorites constructs a new Favorites instance.
func NewFavorites(config Config) *Favorites {
return newFavoritesWithChan(config, make(chan *favReq, 100))
}
type favoritesCacheForDisk struct {
version int
favCache map[favorites.Folder]favorites.Data
newCache map[favorites.Folder]favorites.Data
ignoredCache map[favorites.Folder]favorites.Data
}
type favoritesCacheEncryptedForDisk struct {
version int
encryptedCache []byte
}
func (f *Favorites) readCacheFromDisk(ctx context.Context) error {
// Read the encrypted cache from disk
var db *LevelDb
var err error
if f.config.IsTestMode() {
db, err = openLevelDB(storage.NewMemStorage())
} else {
db, err = openVersionedLevelDB(f.log, f.config.StorageRoot(),
kbfsFavoritesCacheSubfolder, favoritesDiskCacheStorageVersion,
favoritesDiskCacheFilename)
}
if err != nil {
return err
}
f.diskCache = db
session, err := f.config.KBPKI().GetCurrentSession(ctx)
if err != nil {
return err
}
user := []byte(string(session.UID))
data, err := db.Get(user, nil)
if err == leveldb.ErrNotFound {
f.log.CInfof(ctx, "No favorites cache found for user %v", user)
return nil
} else if err != nil {
return err
}
// decode the data from the file and ensure its version is correct
var decodedData favoritesCacheEncryptedForDisk
err = f.config.Codec().Decode(data, &decodedData)
if err != nil {
return err
}
if decodedData.version != favoritesDiskCacheStorageVersion {
return errIncorrectFavoritesCacheVersion{cache: "serialized",
version: decodedData.version}
}
// Send the data to the service to be decrypted
decryptedData, err := f.config.KeybaseService().DecryptFavorites(ctx,
decodedData.encryptedCache)
if err != nil {
return err
}
// Decode the data into the a map
var cacheDecoded favoritesCacheForDisk
err = f.config.Codec().Decode(decryptedData, &cacheDecoded)
if err != nil {
return err
}
if cacheDecoded.version != favoritesDiskCacheVersion {
return errIncorrectFavoritesCacheVersion{cache: "encrypted",
version: decodedData.version}
}
f.favCache = cacheDecoded.favCache
f.newCache = cacheDecoded.newCache
f.ignoredCache = cacheDecoded.ignoredCache
return nil
}
func (f *Favorites) writeCacheToDisk(ctx context.Context) error {
if f.diskCache == nil {
return errNoFavoritesCache
}
// Encode the cache map into a byte buffer
cacheForDisk := favoritesCacheForDisk{
favCache: f.favCache,
newCache: f.newCache,
ignoredCache: f.ignoredCache,
version: favoritesDiskCacheVersion,
}
cacheSerialized, err := f.config.Codec().Encode(cacheForDisk)
if err != nil {
return err
}
// Send the byte buffer to the service for encryption
data, err := f.config.KeybaseService().EncryptFavorites(ctx,
cacheSerialized)
if err != nil {
return err
}
// Encode the encrypted data in a versioned struct before writing it to
// the LevelDb.
cacheEncryptedForDisk := favoritesCacheEncryptedForDisk{
encryptedCache: data,
version: favoritesDiskCacheStorageVersion,
}
encodedData, err := f.config.Codec().Encode(cacheEncryptedForDisk)
if err != nil {
return err
}
// Write the encrypted cache to disk
session, err := f.config.KBPKI().GetCurrentSession(ctx)
if err != nil {
return err
}
user := []byte(string(session.UID))
return f.diskCache.Put(user, encodedData, nil)
}
// InitForTest starts the Favorites cache's internal processing loop without
// loading cached favorites from disk.
func (f *Favorites) InitForTest() {
go f.loop()
}
// Initialize loads the favorites cache from disk and starts listening for
// requests asynchronously.
func (f *Favorites) Initialize(ctx context.Context) {
// load cache from disk
err := f.readCacheFromDisk(ctx)
if err != nil {
f.log.CWarningf(nil,
"Failed to read cached favorites from disk: %v", err)
}
// launch background loop
go f.loop()
}
func (f *Favorites) closeReq(req *favReq, err error) {
f.inFlightLock.Lock()
defer f.inFlightLock.Unlock()
req.err = err
close(req.done)
for _, fav := range req.toAdd {
delete(f.inFlightAdds, fav.Folder)
}
}
// sendChangesToEditHistory notes any deleted favorites and removes them
// from this user's kbfsedits.UserHistory.
func (f *Favorites) sendChangesToEditHistory(oldCache map[favorites.Folder]favorites.Data) {
for oldFav := range oldCache {
if _, present := f.favCache[oldFav]; !present {
f.config.UserHistory().ClearTLF(tlf.CanonicalName(oldFav.Name),
oldFav.Type)
}
}
for newFav := range f.favCache {
if _, present := oldCache[newFav]; !present {
f.config.KBFSOps().RefreshEditHistory(newFav)
}
}
}
func favoriteToFolder(fav favorites.Folder, data favorites.Data) keybase1.Folder {
return keybase1.Folder{
Name: fav.Name,
Private: data.Private,
Created: false,
FolderType: data.FolderType,
TeamID: data.TeamID,
}
}
func (f *Favorites) handleReq(req *favReq) (err error) {
defer func() { f.closeReq(req, err) }()
kbpki := f.config.KBPKI()
// Fetch a new list if:
// * The user asked us to refresh
// * We haven't fetched it before
// * It's stale
if (req.refresh || f.favCache == nil || f.config.Clock().Now().After(
f.cacheExpireTime)) && !req.clear {
// load cache from server
favResult, err := kbpki.FavoriteList(req.ctx)
if err != nil {
if req.refresh || f.favCache == nil {
// if we're supposed to refresh the cache and it's not
// working, mark the current cache expired.
now := f.config.Clock().Now()
if now.Before(f.cacheExpireTime) {
f.cacheExpireTime = now
}
return err
}
// If we weren't explicitly asked to refresh, we can return possibly
// stale favorites rather than return nothing.
f.log.CDebugf(req.ctx,
"Serving possibly stale favorites; new data could not be"+
" fetched: %v", err)
} else { // Successfully got new favorites from server.
session, sessionErr := f.config.KBPKI().GetCurrentSession(req.ctx)
oldCache := f.favCache
f.newCache = make(map[favorites.Folder]favorites.Data)
f.favCache = make(map[favorites.Folder]favorites.Data)
f.ignoredCache = make(map[favorites.Folder]favorites.Data)
f.cacheExpireTime = libkb.ForceWallClock(f.config.Clock().Now()).Add(
favoritesCacheExpirationTime)
for _, folder := range favResult.FavoriteFolders {
f.favCache[*favorites.NewFolderFromProtocol(
folder)] = favorites.DataFrom(folder)
if sessionErr != nil && folder.Name == string(session.Name) {
if folder.Private {
f.homeTLFInfo.PrivateTeamID = *folder.TeamID
} else {
f.homeTLFInfo.PublicTeamID = *folder.TeamID
}
}
}
for _, folder := range favResult.IgnoredFolders {
f.ignoredCache[*favorites.NewFolderFromProtocol(
folder)] = favorites.DataFrom(folder)
}
for _, folder := range favResult.NewFolders {
f.newCache[*favorites.NewFolderFromProtocol(
folder)] = favorites.DataFrom(folder)
}
if err == nil {
// Add favorites for the current user, that cannot be deleted.
f.favCache[favorites.Folder{
Name: string(session.Name),
Type: tlf.Private,
}] = favorites.Data{
Name: string(session.Name),
FolderType: tlf.Private.FolderType(),
TeamID: &f.homeTLFInfo.PrivateTeamID,
Private: true,
}
f.favCache[favorites.Folder{
Name: string(session.Name),
Type: tlf.Public,
}] = favorites.Data{
Name: string(session.Name),
FolderType: tlf.Private.FolderType(),
TeamID: &f.homeTLFInfo.PublicTeamID,
Private: false,
}
err = f.writeCacheToDisk(req.ctx)
if err != nil {
f.log.CWarningf(req.ctx,
"Could not write favorites to disk cache: %v", err)
}
}
if oldCache != nil {
f.sendChangesToEditHistory(oldCache)
}
}
} else if req.clear {
f.favCache = nil
return nil
}
for _, fav := range req.toAdd {
_, present := f.favCache[fav.Folder]
if !fav.Created && present {
f.favCache[fav.Folder] = fav.Data
continue
}
err := kbpki.FavoriteAdd(req.ctx, fav.ToKBFolder())
if err != nil {
f.log.CDebugf(req.ctx,
"Failure adding favorite %v: %v", fav, err)
return err
}
f.favCache[fav.Folder] = fav.Data
}
for _, fav := range req.toDel {
// Since our cache isn't necessarily up-to-date, always delete
// the favorite.
folder := fav.ToKBFolder(false)
err := kbpki.FavoriteDelete(req.ctx, folder)
if err != nil {
return err
}
delete(f.favCache, fav)
f.config.UserHistory().ClearTLF(tlf.CanonicalName(fav.Name), fav.Type)
}
if req.favs != nil {
favorites := make([]favorites.Folder, 0, len(f.favCache))
for fav := range f.favCache {
favorites = append(favorites, fav)
}
req.favs <- favorites
}
if req.favsAll != nil {
favFolders := make([]keybase1.Folder, 0, len(f.favCache))
newFolders := make([]keybase1.Folder, 0, len(f.newCache))
ignoredFolders := make([]keybase1.Folder, 0, len(f.ignoredCache))
for fav, data := range f.favCache {
favFolders = append(favFolders, favoriteToFolder(fav, data))
}
for fav, data := range f.newCache {
newFolders = append(newFolders, favoriteToFolder(fav, data))
}
for fav, data := range f.ignoredCache {
ignoredFolders = append(ignoredFolders, favoriteToFolder(fav, data))
}
req.favsAll <- keybase1.FavoritesResult{
NewFolders: newFolders,
IgnoredFolders: ignoredFolders,
FavoriteFolders: favFolders,
}
// TODO: send info on reset users
}
if req.homeTLFInfo != nil {
f.homeTLFInfo = *req.homeTLFInfo
}
return nil
}
func (f *Favorites) loop() {
for req := range f.reqChan {
f.handleReq(req)
f.wg.Done()
}
}
// Shutdown shuts down this Favorites instance.
func (f *Favorites) Shutdown() error {
if f.disabled {
return nil
}
f.muShutdown.Lock()
defer f.muShutdown.Unlock()
f.shutdown = true
close(f.reqChan)
if f.diskCache != nil {
err := f.diskCache.Close()
if err != nil {
f.log.CWarningf(context.Background(),
"Could not close disk favorites cache: %v", err)
}
}
return f.wg.Wait(context.Background())
}
func (f *Favorites) hasShutdown() bool {
f.muShutdown.RLock()
defer f.muShutdown.RUnlock()
return f.shutdown
}
func (f *Favorites) waitOnReq(ctx context.Context,
req *favReq) (retry bool, err error) {
select {
case <-ctx.Done():
return false, ctx.Err()
case <-req.done:
err = req.err
// If the request was canceled due to a context timeout that
// wasn't our own, try it again.
if err == context.Canceled || err == context.DeadlineExceeded {
select {
case <-ctx.Done():
return false, err
default:
return true, nil
}
}
return false, err
}
}
func (f *Favorites) sendReq(ctx context.Context, req *favReq) error {
f.wg.Add(1)
select {
case f.reqChan <- req:
case <-ctx.Done():
f.wg.Done()
err := ctx.Err()
f.closeReq(req, err)
return err
}
// With a direct sendReq call, we'll never have a shared request,
// so no need to check the retry status.
_, err := f.waitOnReq(ctx, req)
return err
}
func (f *Favorites) startOrJoinAddReq(
ctx context.Context, fav favorites.ToAdd) (req *favReq, doSend bool) {
f.inFlightLock.Lock()
defer f.inFlightLock.Unlock()
req, ok := f.inFlightAdds[fav.Folder]
if !ok {
req = &favReq{
ctx: ctx,
toAdd: []favorites.ToAdd{fav},
done: make(chan struct{}),
}
f.inFlightAdds[fav.Folder] = req
doSend = true
}
return req, doSend
}
// Add adds a favorite to your favorites list.
func (f *Favorites) Add(ctx context.Context, fav favorites.ToAdd) error {
if f.disabled {
return nil
}
if f.hasShutdown() {
return ShutdownHappenedError{}
}
doAdd := true
var err error
// Retry until we get an error that wasn't related to someone
// else's context being canceled.
for doAdd {
req, doSend := f.startOrJoinAddReq(ctx, fav)
if doSend {
return f.sendReq(ctx, req)
}
doAdd, err = f.waitOnReq(ctx, req)
}
return err
}
// AddAsync initiates a request to add this favorite to your favorites
// list, if one is not already in flight, but it doesn't wait for the
// result. (It could block while kicking off the request, if lots of
// different favorite operations are in flight.) The given context is
// used only for enqueuing the request on an internal queue, not for
// any resulting I/O.
func (f *Favorites) AddAsync(ctx context.Context, fav favorites.ToAdd) {
if f.disabled || f.hasShutdown() {
return
}
// Use a fresh context, since we want the request to succeed even
// if the original context is canceled.
req, doSend := f.startOrJoinAddReq(context.Background(), fav)
if doSend {
f.wg.Add(1)
select {
case f.reqChan <- req:
case <-ctx.Done():
f.wg.Done()
err := ctx.Err()
f.closeReq(req, err)
return
}
}
}
// Delete deletes a favorite from the favorites list. It is
// idempotent.
func (f *Favorites) Delete(ctx context.Context, fav favorites.Folder) error {
if f.disabled {
return nil
}
if f.hasShutdown() {
return ShutdownHappenedError{}
}
return f.sendReq(ctx, &favReq{
ctx: ctx,
toDel: []favorites.Folder{fav},
done: make(chan struct{}),
})
}
// RefreshCache refreshes the cached list of favorites.
func (f *Favorites) RefreshCache(ctx context.Context) {
if f.disabled || f.hasShutdown() {
return
}
// This request is non-blocking, so use a throw-away done channel
// and context.
req := &favReq{
refresh: true,
done: make(chan struct{}),
ctx: context.Background(),
}
f.wg.Add(1)
select {
case f.reqChan <- req:
case <-ctx.Done():
f.wg.Done()
return
}
}
// ClearCache clears the cached list of favorites.
func (f *Favorites) ClearCache(ctx context.Context) {
if f.disabled || f.hasShutdown() {
return
}
// This request is non-blocking, so use a throw-away done channel
// and context.
req := &favReq{
clear: true,
refresh: false,
done: make(chan struct{}),
ctx: context.Background(),
}
f.wg.Add(1)
select {
case f.reqChan <- req:
case <-ctx.Done():
f.wg.Done()
return
}
}
// Get returns the logged-in user's list of favorites. It uses the cache.
func (f *Favorites) Get(ctx context.Context) ([]favorites.Folder, error) {
if f.disabled {
session, err := f.config.KBPKI().GetCurrentSession(ctx)
if err == nil {
// Add favorites only for the current user.
return []favorites.Folder{
{Name: string(session.Name), Type: tlf.Private},
{Name: string(session.Name), Type: tlf.Public},
}, nil
}
return nil, nil
}
if f.hasShutdown() {
return nil, ShutdownHappenedError{}
}
favChan := make(chan []favorites.Folder, 1)
req := &favReq{
ctx: ctx,
favs: favChan,
done: make(chan struct{}),
}
err := f.sendReq(ctx, req)
if err != nil {
return nil, err
}
return <-favChan, nil
}
// setHomeTLFInfo should be called when a new user logs in so that their home
// TLFs can be returned as favorites.
func (f *Favorites) setHomeTLFInfo(ctx context.Context, info homeTLFInfo) {
if f.hasShutdown() {
return
}
// This request is non-blocking, so use a throw-away done channel
// and context.
req := &favReq{
homeTLFInfo: &info,
done: make(chan struct{}),
ctx: context.Background(),
}
f.wg.Add(1)
select {
case f.reqChan <- req:
case <-ctx.Done():
f.wg.Done()
return
}
}
// GetAll returns the logged-in user's list of favorite, new, and ignored TLFs.
// It uses the cache.
func (f *Favorites) GetAll(ctx context.Context) (keybase1.FavoritesResult,
error) {
if f.disabled {
session, err := f.config.KBPKI().GetCurrentSession(ctx)
if err == nil {
// Add favorites only for the current user.
return keybase1.FavoritesResult{
FavoriteFolders: []keybase1.Folder{
{
Name: string(session.Name),
Private: false,
Created: false,
FolderType: keybase1.FolderType_PUBLIC,
TeamID: &f.homeTLFInfo.PublicTeamID,
},
{
Name: string(session.Name),
Private: true,
Created: false,
FolderType: keybase1.FolderType_PRIVATE,
TeamID: &f.homeTLFInfo.PrivateTeamID,
},
},
}, nil
}
return keybase1.FavoritesResult{}, nil
}
if f.hasShutdown() {
return keybase1.FavoritesResult{}, ShutdownHappenedError{}
}
favChan := make(chan keybase1.FavoritesResult, 1)
req := &favReq{
ctx: ctx,
favsAll: favChan,
done: make(chan struct{}),
}
err := f.sendReq(ctx, req)
if err != nil {
return keybase1.FavoritesResult{}, err
}
return <-favChan, nil
}