uniqush-push

Uniqush is an open-source system that provides a unified push service for server-side notifications to mobile devices. Instead of integrating multiple different push service APIs into your application, you run uniqush-push on your own server. It acts as an abstraction layer that communicates with various mobile platform push services via a single interface.

Key Characteristics:

• Self-hosted: Unlike SaaS solutions (e.g., Urban Airship), Uniqush is a system you run on your own infrastructure.
• Language Agnostic: It provides RESTful APIs, meaning you can communicate with it using any language that has an HTTP client library.
• Dependency-free: It is distributed as a binary; you do not need to install the Go compiler to run it.

You interact with uniqush-push through its RESTful APIs using the HTTP protocol. This allows your application to send push notifications by making standard HTTP requests.

For specific endpoint details and request/response schemas, refer to the official API documentation.

Uniqush-push requires a Redis server to store user data.

Critical Requirement: You must ensure that Redis persistence is enabled. This ensures that user data is saved correctly during shutdowns and can be backed up.

To enable persistence, your redis.conf should be configured according to the Redis persistence documentation. Ensure the configuration includes settings similar to the **PERSISTENCE** section found in standard Redis configuration examples.

The PushBackEnd implements an automated error handling and retry mechanism:

1. Error Processing: An internal goroutine listens on errChan and processes various error types (e.g., RetryError, PushServiceProviderUpdate, InvalidRegistrationUpdate).
2. Retry Logic: If a *push.RetryError is encountered, the backend will automatically retry the push. It uses an exponential backoff strategy, doubling the wait time after each failure, up to a maximum interval of 1 minute.
3. Automatic Cleanup: Certain errors trigger automatic database updates. For example, InvalidRegistrationUpdate or UnsubscribeUpdate will automatically call Unsubscribe to remove the invalid delivery point from the database.

To use the RestAPI in a Go application, construct it using NewRestAPI and start it with Run.

// Example initialization
api := NewRestAPI(psm, loggers, "1.0.0", backend)

// Create a channel to handle graceful shutdown
stopChan := make(chan bool)

// Run the API on a specific address
go api.Run(":8080", stopChan)

func NewRestAPI(psm *push.PushServiceManager, loggers []log.Logger, version string, backend *PushBackEnd) *RestAPI {
	ret := new(RestAPI)
	ret.psm = psm
	ret.loggers = loggers
	ret.version = version
	ret.backend = backend
	ret.waitGroup = new(sync.WaitGroup)
	return ret
}

// ...

func (api *RestAPI) Run(addr string, stopChan chan<- bool) {
	// ...
	err := http.ListenAndServe(addr, nil)
	if err != nil {
		api.loggers[LoggerWeb].Fatalf("HTTPServerError \"%v\"", err)
	}
}

Uniqush-push abstracts the following push services:

• GCM (Google Cloud Messaging) for Android
• FCM (Firebase Cloud Messaging) for Android
• APNS (Apple Push Notification service) for iOS
• ADM (Amazon Device Messaging) for Amazon Kindle tablets