Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

client: add a StaticWatcher utility constructor #116

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions client/setec/static.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
// Copyright (c) Tailscale Inc & AUTHORS
// SPDX-License-Identifier: BSD-3-Clause

package setec

import (
"bytes"
"fmt"
"os"
)

// StaticSecret returns a Secret that vends a static string value.
// This is useful as a placeholder for development, migration, and testing.
// The value reported by a static secret never changes.
func StaticSecret(value string) Secret {
return func() []byte { return []byte(value) }
}

// StaticWatcher returns a Watcher that vends a static string value.
// This is useful as a placeholder for development, migration, and testing.
// The value reported by a static watcher never changes, and the watcher
// channel is never ready.
func StaticWatcher(value string) Watcher {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the only new bit, the rest is moved from store.go

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After discussion, I am going to propose a different approach.

return Watcher{secret: StaticSecret(value)}
}

// StaticFile returns a Secret that vends the contents of path. The contents
// of the file are returned exactly as stored.
//
// This is useful as a placeholder for development, migration, and testing.
// The value reported by this secret is the contents of path at the
// time this function is called, and never changes.
func StaticFile(path string) (Secret, error) {
bs, err := os.ReadFile(path)
if err != nil {
return nil, fmt.Errorf("reading static secret: %w", err)
}
return func() []byte { return bs }, nil
}

// StaticTextFile returns a secret that vends the contents of path, which are
// treated as text with leading and trailing whitespace trimmed.
//
// This is useful as a placeholder for development, migration, and testing.
// The value reported by a static secret never changes.
func StaticTextFile(path string) (Secret, error) {
bs, err := os.ReadFile(path)
if err != nil {
return nil, fmt.Errorf("reading static secret: %w", err)
}
text := bytes.TrimSpace(bs)
return func() []byte { return text }, nil
}
37 changes: 0 additions & 37 deletions client/setec/store.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,13 @@
package setec

import (
"bytes"
"context"
"encoding/json"
"errors"
"expvar"
"fmt"
"log"
"math/rand"
"os"
"sync"
"time"

Expand Down Expand Up @@ -492,41 +490,6 @@ func (s Secret) GetString() string {
return string(s())
}

// StaticSecret returns a Secret that vends a static string value.
// This is useful as a placeholder for development, migration, and testing.
// The value reported by a static secret never changes.
func StaticSecret(value string) Secret {
return func() []byte { return []byte(value) }
}

// StaticFile returns a Secret that vends the contents of path. The contents
// of the file are returned exactly as stored.
//
// This is useful as a placeholder for development, migration, and testing.
// The value reported by this secret is the contents of path at the
// time this function is called, and never changes.
func StaticFile(path string) (Secret, error) {
bs, err := os.ReadFile(path)
if err != nil {
return nil, fmt.Errorf("reading static secret: %w", err)
}
return func() []byte { return bs }, nil
}

// StaticTextFile returns a secret that vends the contents of path, which are
// treated as text with leading and trailing whitespace trimmed.
//
// This is useful as a placeholder for development, migration, and testing.
// The value reported by a static secret never changes.
func StaticTextFile(path string) (Secret, error) {
bs, err := os.ReadFile(path)
if err != nil {
return nil, fmt.Errorf("reading static secret: %w", err)
}
text := bytes.TrimSpace(bs)
return func() []byte { return text }, nil
}

// hasExpired reports whether cs is an undeclared secret whose last access time
// was longer ago than the expiry window.
func (s *Store) hasExpired(cs *cachedSecret) bool {
Expand Down