Release 0.1 (frain-dev#74)

* added API to resend failed events (frain-dev#61)
* added API to resend failed events frain-dev#56
* updated response description when event is retried
* added golden files
* updated retry handling for multiple endpoints
* Fixed CI
* refactored resend flow
* resolved merge conflicts
* Added resend to API
Co-authored-by: Subomi Oluwalana <subomioluwalana71@gmail.com>

* - Paginate events (frain-dev#67)
- Change event table description to attempt count
- Connect API for event retry
- Connect event retry API
* Fixed Docker build (frain-dev#71)
* added events count to apps API (frain-dev#73)

* Fixes (frain-dev#72)
* - Paginate events
- Change event table description to attempt count
- Connect API for event retry
- Connect event retry API

* - update axios base url
- add event response data to details section
- connect go to docs to github repo
- add number of endpoints to apps table
- fix issue with app crashing on clicking scheduled events

* update app meta data

* add number of events to apps table

* Update LICENSE to MPL 2.0

* Updated README.md

Co-authored-by: Smart Mekiliuwa <st.nonso@gmail.com>
Co-authored-by: Emmanuel AIna <emmanuel.ainaj@gmail.com>

Author: 3 people

Dockerfile

@@ -27,6 +27,7 @@ FROM gcr.io/distroless/base
 COPY --from=build-env /go/bin/cmd /
 COPY --from=build-env /go/src/frain-dev/convoy/convoy.json /convoy.json
 
-ENTRYPOINT ["/cmd", "server", "--config", "convoy.json"]
+ENTRYPOINT ["/cmd"] 
+CMD [ "server", "--config", "convoy.json" ]
 
 EXPOSE 8080

LICENSE

@@ -1,5 +1,5 @@
 # Convoy
-Convoy is a fast & secure webhooks service. It receives event data from a HTTP API and sends these event data to the configured endpoints.
+Convoy is a fast & secure webhooks service. It receives event data from a HTTP API and sends these event data to the configured endpoints. To get started download the [openapi spec](https://github.com/frain-dev/convoy/blob/main/openapi.yaml) into Postman or Insomnia.
 
 Installation
 -----------------
@@ -25,9 +25,6 @@ Concepts
 3. **Delivery Attempts:** A delivery attempt represents an attempt to send an event to it's respective app's endpoint. It contains the `event body`, `status code` and `response body` received on attempt. The amount of attempts on a failed delivery depends on your configured retry strategy.
 
 
-How it Works
------------------
-
 Configuration
 -----------------
 Convoy is configured using a json file with a sample configuration below: 

README.md

@@ -29,6 +29,8 @@ type Application struct {
 	UpdatedAt primitive.DateTime `json:"updated_at,omitempty" bson:"updated_at,omitempty"`
 	DeletedAt primitive.DateTime `json:"deleted_at,omitempty" bson:"deleted_at,omitempty"`
 
+	Events int64 `json:"events" bson:"-"`
+
 	DocumentStatus DocumentStatus `json:"-" bson:"document_status"`
 }
 

application.go

@@ -305,7 +305,7 @@ func createMessageCommand(a *app) *cobra.Command {
 					NumTrials:       0,
 					IntervalSeconds: intervalSeconds,
 					RetryLimit:      retryLimit,
-					NextSendTime:    primitive.NewDateTimeFromTime(time.Now().Add(time.Duration(intervalSeconds) * time.Second)),
+					NextSendTime:    primitive.NewDateTimeFromTime(time.Now()),
 				},
 				AppMetadata: &convoy.AppMetadata{
 					OrgID:     appData.OrgID,

cmd/create.go

@@ -1,26 +1,26 @@
 {
-	"database": {
-		"dsn": "mongodb://root:rootpassword@mongodb:27017"
-	},
-	"queue": {
-		"type": "redis",
-		"redis": {
-			"dsn": "redis://redis_server:6379"
-		}
-	},
-	"server": {
-		"http": {
-			"port": 5005
-		}
-	},
-	"auth": {
-		"type": "none"
-	},
-	"strategy": {
-		"type": "default",
-		"default": {
-			"intervalSeconds": 120,
-			"retryLimit": 10
-		}
-	}
+  "database": {
+    "dsn": "mongodb://root:rootpassword@mongodb:27017"
+  },
+  "queue": {
+    "type": "redis",
+    "redis": {
+      "dsn": "redis://redis_server:6379"
+    }
+  },
+  "server": {
+    "http": {
+      "port": 5005
+    }
+  },
+  "auth": {
+    "type": "none"
+  },
+  "strategy": {
+    "type": "default",
+    "default": {
+      "intervalSeconds": 120,
+      "retryLimit": 10
+    }
+  }
 }

convoy-docker.json

@@ -1,6 +1,6 @@
 {
   "database": {
-    "dsn": "mongodb://root:rootpassword@localhost:27017"
+    "dsn": "mongodb://root:rootpassword@localhost:27037"
   },
   "queue": {
     "type": "redis",

convoy.json

@@ -72,6 +72,17 @@ func (db *appRepo) LoadApplications(ctx context.Context, orgId string) ([]convoy
 		return apps, err
 	}
 
+	msgCollection := db.innerDB.Collection(MsgCollection)
+	for i, app := range apps {
+		filter = bson.M{"app_id": app.UID, "document_status": bson.M{"$ne": convoy.DeletedDocumentStatus}}
+		count, err := msgCollection.CountDocuments(ctx, filter)
+		if err != nil {
+			log.Errorf("failed to count events in %s. Reason: %s", app.UID, err)
+			return apps, err
+		}
+		apps[i].Events = count
+	}
+
 	return apps, nil
 }
 
@@ -89,6 +100,17 @@ func (db *appRepo) LoadApplicationsPagedByOrgId(ctx context.Context, orgId strin
 		applications = make([]convoy.Application, 0)
 	}
 
+	msgCollection := db.innerDB.Collection(MsgCollection)
+	for i, app := range applications {
+		filter = bson.M{"app_id": app.UID, "document_status": bson.M{"$ne": convoy.DeletedDocumentStatus}}
+		count, err := msgCollection.CountDocuments(ctx, filter)
+		if err != nil {
+			log.Errorf("failed to count events in %s. Reason: %s", app.UID, err)
+			return applications, pager.PaginationData{}, err
+		}
+		applications[i].Events = count
+	}
+
 	return applications, paginatedData.Pagination, nil
 }
 
@@ -125,6 +147,17 @@ func (db *appRepo) SearchApplicationsByOrgId(ctx context.Context, orgId string,
 		return apps, err
 	}
 
+	msgCollection := db.innerDB.Collection(MsgCollection)
+	for i, app := range apps {
+		filter = bson.M{"app_id": app.UID, "document_status": bson.M{"$ne": convoy.DeletedDocumentStatus}}
+		count, err := msgCollection.CountDocuments(ctx, filter)
+		if err != nil {
+			log.Errorf("failed to count events in %s. Reason: %s", app.UID, err)
+			return apps, err
+		}
+		apps[i].Events = count
+	}
+
 	return apps, nil
 }
 
@@ -139,7 +172,17 @@ func (db *appRepo) FindApplicationByID(ctx context.Context,
 		Decode(&app)
 	if errors.Is(err, mongo.ErrNoDocuments) {
 		err = convoy.ErrApplicationNotFound
+		return app, err
+	}
+
+	msgCollection := db.innerDB.Collection(MsgCollection)
+	filter = bson.M{"app_id": app.UID, "document_status": bson.M{"$ne": convoy.DeletedDocumentStatus}}
+	count, err := msgCollection.CountDocuments(ctx, filter)
+	if err != nil {
+		log.Errorf("failed to count events in %s. Reason: %s", app.UID, err)
+		return app, err
 	}
+	app.Events = count
 
 	return app, err
 }

datastore/application.go

@@ -1,44 +1,29 @@
 version: "3"
 
 services:
-  web:
-    build:
-      context: .
-      dockerfile: Dockerfile
-    entrypoint: ["./cmd", "server", "--config", "convoy-docker.json"]
-    ports:
-      - 5005:5005
-    links:
-      - mongodb:localhost
-    #      - redis_server:localhost
-    depends_on:
-      - mongodb
-      - redis_server
+    web:
+        build:
+            context: .
+            dockerfile: Dockerfile
+        entrypoint: ["./cmd", "server", "--config", "convoy.json"]
+        ports:
+            - 5005:5005
+        volumes:
+            - ./convoy-docker.json:/convoy.json
+        restart: on-failure
+        depends_on:
+            - mongodb
+            - redis_server
 
-  # nats:
-  #   image: nats
-  #   ports:
-  #     - "8222:8222"
-  # nats-1:
-  #   image: nats
-  #   command: "--cluster nats://0.0.0.0:6222 --routes=nats://ruser:T0pS3cr3t@nats:6222"
-  #   depends_on: ["nats"]
-  # nats-2:
-  #   image: nats
-  #   command: "--cluster nats://0.0.0.0:6222 --routes=nats://ruser:T0pS3cr3t@nats:6222"
-  #   depends_on: ["nats"]
+    mongodb:
+        image: mongo:latest
+        environment:
+            MONGO_INITDB_ROOT_USERNAME: root
+            MONGO_INITDB_ROOT_PASSWORD: rootpassword
+        volumes:
+            - ./data/mongo:/data/db
 
-  mongodb:
-    image: mongo:latest
-    environment:
-      MONGO_INITDB_ROOT_USERNAME: root
-      MONGO_INITDB_ROOT_PASSWORD: rootpassword
-    ports:
-      - "27037:27017"
-    volumes:
-      - ./data/mongo:/data/db
-
-  redis_server:
-    image: redis:alpine
-    ports:
-      - "8379:6379"
+        redis_server:
+            image: redis:alpine
+            ports:
+                - "8379:6379"

docker-compose.yml

@@ -132,6 +132,12 @@ func (a *applicationHandler) GetAppMessage(w http.ResponseWriter, r *http.Reques
 		*getMessageFromContext(r.Context()), http.StatusOK))
 }
 
+func (a *applicationHandler) ResendAppMessage(w http.ResponseWriter, r *http.Request) {
+
+	_ = render.Render(w, r, newServerResponse("App event processed for retry successfully",
+		*getMessageFromContext(r.Context()), http.StatusOK))
+}
+
 func (a *applicationHandler) GetAppMessagesPaged(w http.ResponseWriter, r *http.Request) {
 
 	_ = render.Render(w, r, newServerResponse("App events fetched successfully",

server/application.go

@@ -93,7 +93,7 @@ func ensureNewMessage(appRepo convoy.ApplicationRepository, msgRepo convoy.Messa
 					NumTrials:       0,
 					IntervalSeconds: intervalSeconds,
 					RetryLimit:      retryLimit,
-					NextSendTime:    primitive.NewDateTimeFromTime(time.Now().Add(time.Duration(intervalSeconds) * time.Second)),
+					NextSendTime:    primitive.NewDateTimeFromTime(time.Now()),
 				},
 				MessageAttempts: make([]convoy.MessageAttempt, 0),
 				CreatedAt:       primitive.NewDateTimeFromTime(time.Now()),
@@ -141,30 +141,12 @@ func fetchAllMessages(msgRepo convoy.MessageRepository) func(next http.Handler)
 	}
 }
 
-func fetchAppMessages(appRepo convoy.ApplicationRepository, msgRepo convoy.MessageRepository) func(next http.Handler) http.Handler {
+func fetchAppMessages(msgRepo convoy.MessageRepository) func(next http.Handler) http.Handler {
 	return func(next http.Handler) http.Handler {
-
 		return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 
 			pageable := getPageableFromContext(r.Context())
-
-			appID := chi.URLParam(r, "appID")
-			app, err := appRepo.FindApplicationByID(r.Context(), appID)
-			if err != nil {
-
-				msg := "an error occurred while retrieving app details"
-				statusCode := http.StatusInternalServerError
-
-				if errors.Is(err, convoy.ErrApplicationNotFound) {
-					msg = err.Error()
-					statusCode = http.StatusNotFound
-				}
-
-				log.Errorln("error while fetching app - ", err)
-
-				_ = render.Render(w, r, newErrorResponse(msg, statusCode))
-				return
-			}
+			app := getApplicationFromContext(r.Context())
 
 			m, paginationData, err := msgRepo.LoadMessagesPagedByAppId(r.Context(), app.UID, pageable)
 			if err != nil {
@@ -250,3 +232,33 @@ func findMessageDeliveryAttempt(attempts *[]convoy.MessageAttempt, id string) (*
 	}
 	return nil, convoy.ErrMessageDeliveryAttemptNotFound
 }
+
+func resendMessage(msgRepo convoy.MessageRepository) func(next http.Handler) http.Handler {
+	return func(next http.Handler) http.Handler {
+
+		return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+
+			msg := getMessageFromContext(r.Context())
+
+			if msg.Status == convoy.SuccessMessageStatus {
+				_ = render.Render(w, r, newErrorResponse("event already sent", http.StatusBadRequest))
+				return
+			}
+
+			if msg.Status != convoy.FailureMessageStatus {
+				_ = render.Render(w, r, newErrorResponse("cannot resend event that did not fail previously", http.StatusBadRequest))
+				return
+			}
+
+			msg.Status = convoy.ScheduledMessageStatus
+			err := msgRepo.UpdateStatusOfMessages(r.Context(), []convoy.Message{*msg}, convoy.ScheduledMessageStatus)
+			if err != nil {
+				_ = render.Render(w, r, newErrorResponse("an error occurred while trying to resend event", http.StatusInternalServerError))
+				return
+			}
+
+			r = r.WithContext(setMessageInContext(r.Context(), msg))
+			next.ServeHTTP(w, r)
+		})
+	}
+}