appengine/gaeauth/server/internal/authdbimpl/helpers.go

// Copyright 2015 The LUCI Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package authdbimpl

import (
	"context"

	"go.chromium.org/luci/gae/service/info"
	"go.chromium.org/luci/server/auth/service"
)

// authService is interface for service.AuthService.
//
// Unit tests inject fake implementation into the testing context.
type authService interface {
	EnsureSubscription(ctx context.Context, subscription, pushURL string) error
	DeleteSubscription(ctx context.Context, subscription string) error
	PullPubSub(ctx context.Context, subscription string) (*service.Notification, error)
	ProcessPubSubPush(ctx context.Context, body []byte) (*service.Notification, error)
	GetLatestSnapshotRevision(ctx context.Context) (int64, error)
	GetSnapshot(ctx context.Context, rev int64) (*service.Snapshot, error)
}

type contextKey int

// setAuthService injects authService implementation into the context.
//
// Used in unit tests.
func setAuthService(ctx context.Context, s authService) context.Context {
	return context.WithValue(ctx, contextKey(0), s)
}

// getAuthService returns authService implementation injected into the context
// via setAuthService or *service.AuthService otherwise.
func getAuthService(ctx context.Context, url string) authService {
	if s, _ := ctx.Value(contextKey(0)).(authService); s != nil {
		return s
	}
	return &service.AuthService{URL: url}
}

// defaultNS returns GAE context configured to use default namespace.
//
// All publicly callable functions must use it to switch to default namespace.
// All internal functions expect the context to be in the default namespace.
//
// Idempotent.
func defaultNS(ctx context.Context) context.Context {
	return info.MustNamespace(ctx, "")
}