feat: add support for suspending/resuming a feed

Author: 0x2E

api/api.go

@@ -28,6 +28,14 @@ func Run() {
 	logger := slog.New(slog.NewJSONHandler(os.Stdout, nil))
 
 	r := echo.New()
+
+	if conf.Debug {
+		r.Debug = true
+		r.Use(middleware.BodyDump(func(c echo.Context, reqBody, resBody []byte) {
+			r.Logger.Debugf("req: %s\nresp: %s\n", reqBody, resBody)
+		}))
+	}
+
 	r.HideBanner = true
 	r.HTTPErrorHandler = errorHandler
 	r.Validator = newCustomValidator()

frontend/src/lib/api/feed.ts

@@ -31,9 +31,16 @@ export async function createFeed(data: {
 	});
 }
 
-export async function updateFeed(data: Feed) {
-	return await api.patch('feeds/' + data.id, {
-		json: { name: data.name, link: data.link, group_id: data.group.id }
+export type FeedUpdateForm = {
+	name?: string;
+	link?: string;
+	suspended?: boolean;
+	group_id?: number;
+};
+
+export async function updateFeed(id: number, data: FeedUpdateForm) {
+	return await api.patch('feeds/' + id, {
+		json: data
 	});
 }
 

frontend/src/lib/api/model.ts

@@ -9,6 +9,7 @@ export type Feed = {
 	link: string;
 	failure: string;
 	updated_at: Date;
+	suspended: boolean;
 	group: Group;
 };
 

frontend/src/routes/feeds/ActionAdd.svelte

@@ -23,6 +23,7 @@
 			link: '',
 			failure: '',
 			updated_at: new Date(),
+			suspended: false,
 			group: { id: groups[0].id, name: groups[0].name }
 		};
 	}

frontend/src/routes/feeds/Detail.svelte

@@ -7,7 +7,7 @@
 	import { Label } from '$lib/components/ui/label';
 	import { AlertCircleIcon, Loader2Icon } from 'lucide-svelte';
 	import * as Alert from '$lib/components/ui/alert';
-	import { deleteFeed, refreshFeeds, updateFeed } from '$lib/api/feed';
+	import { deleteFeed, refreshFeeds, updateFeed, type FeedUpdateForm } from '$lib/api/feed';
 	import type { Feed } from '$lib/api/model';
 	import type { groupFeeds } from './+page';
 	import { invalidateAll } from '$app/navigation';
@@ -18,12 +18,12 @@
 	export let groups: groupFeeds[];
 	export let show = false;
 	export let selectedFeed: Feed;
-	let formData: Feed;
+	let formData: FeedUpdateForm;
 	let refreshing = false;
 
 	$: {
 		if (show) {
-			formData = Object.assign({}, selectedFeed);
+			formData = {};
 		}
 	}
 
@@ -55,19 +55,29 @@
 	}
 
 	async function handleUpdate() {
-		if (!formData) return;
-		toast.promise(updateFeed(formData), {
+		toast.promise(updateFeed(selectedFeed.id, formData), {
 			loading: 'Updating',
 			success: () => {
 				invalidateAll();
-				return formData.name + ' has been updated';
+				return 'Update successfully';
 			},
 			error: (e) => {
 				invalidateAll();
 				return (e as Error).message;
 			}
 		});
 	}
+
+	async function handleToggleSuspended() {
+		const data: FeedUpdateForm = { suspended: !selectedFeed.suspended };
+		try {
+			await updateFeed(selectedFeed.id, data);
+			toast.success('Update successfully');
+			invalidateAll();
+		} catch (e) {
+			toast.error((e as Error).message);
+		}
+	}
 </script>
 
 <Sheet.Root bind:open={show}>
@@ -94,7 +104,7 @@
 							id="name"
 							type="text"
 							class="w-full"
-							value={formData.name}
+							value={selectedFeed.name}
 							on:input={(e) => {
 								// two-way bind not works, so do this. https://stackoverflow.com/questions/60825553/svelte-input-binding-breaks-when-a-reactive-value-is-a-reference-type
 								if (e.target instanceof HTMLInputElement) {
@@ -110,7 +120,7 @@
 							id="link"
 							type="text"
 							class="w-full"
-							value={formData.link}
+							value={selectedFeed.link}
 							on:input={(e) => {
 								if (e.target instanceof HTMLInputElement) {
 									formData.link = e.target.value;
@@ -126,10 +136,10 @@
 							items={groups.map((v) => {
 								return { value: v.id, label: v.name };
 							})}
-							onSelectedChange={(v) => v && (formData.group.id = v.value)}
+							onSelectedChange={(v) => v && (formData.group_id = v.value)}
 						>
 							<Select.Trigger>
-								<Select.Value placeholder={formData.group.name} />
+								<Select.Value placeholder={selectedFeed.group.name} />
 							</Select.Trigger>
 							<Select.Content>
 								{#each groups as g}
@@ -142,15 +152,49 @@
 				</form>
 			{/if}
 
-			<Separator class="my-10" />
+			<Separator class="my-6" />
+			<Button
+				variant="secondary"
+				on:click={handleRefresh}
+				disabled={refreshing || selectedFeed.suspended}
+			>
+				{#if refreshing}
+					<Loader2Icon class="mr-2 h-4 w-4 animate-spin" />
+				{:else}
+					Refresh
+				{/if}
+			</Button>
+
+			<Separator class="my-6" />
 			<div class="flex flex-col w-full gap-4">
-				<Button variant="secondary" on:click={handleRefresh} disabled={refreshing}>
-					{#if refreshing}
-						<Loader2Icon class="mr-2 h-4 w-4 animate-spin" />
-					{:else}
-						Refresh
-					{/if}
-				</Button>
+				<AlertDialog.Root>
+					<AlertDialog.Trigger asChild let:builder>
+						<Button builders={[builder]} variant="secondary">
+							{#if selectedFeed.suspended}
+								Resume
+							{:else}
+								Suspend
+							{/if}
+						</Button>
+					</AlertDialog.Trigger>
+					<AlertDialog.Content>
+						<AlertDialog.Header>
+							<AlertDialog.Title>Are you absolutely sure?</AlertDialog.Title>
+							<AlertDialog.Description>
+								{#if selectedFeed.suspended}
+									This will resume the refreshing of <b>{selectedFeed.name}</b>.
+								{:else}
+									This will suspend the refreshing of <b>{selectedFeed.name}</b> untill you resume it.
+								{/if}
+							</AlertDialog.Description>
+						</AlertDialog.Header>
+						<AlertDialog.Footer>
+							<AlertDialog.Cancel>Cancel</AlertDialog.Cancel>
+							<AlertDialog.Action on:click={handleToggleSuspended}>Continue</AlertDialog.Action>
+						</AlertDialog.Footer>
+					</AlertDialog.Content>
+				</AlertDialog.Root>
+
 				<AlertDialog.Root>
 					<AlertDialog.Trigger asChild let:builder>
 						<Button builders={[builder]} variant="destructive">Delete</Button>

model/feed.go

@@ -18,8 +18,17 @@ type Feed struct {
 	LastBuild *time.Time `gorm:"last_build"`
 	// Failure is the reason of failure. If it is not null or empty, the fetch processor
 	// should skip this feed
-	Failure *string `gorm:"failure;default:''"`
+	Failure   *string `gorm:"failure;default:''"`
+	Suspended *bool   `gorm:"suspended;default:false"`
 
 	GroupID uint
 	Group   Group
 }
+
+func (f Feed) IsFailed() bool {
+	return f.Failure != nil && *f.Failure != ""
+}
+
+func (f Feed) IsSuspended() bool {
+	return f.Suspended != nil && *f.Suspended
+}

repo/repo.go

@@ -56,4 +56,8 @@ func Init() {
 		FirstOrCreate(&model.Group{ID: 1, Name: &defaultGroup}).Error; err != nil {
 		panic(err)
 	}
+
+	if conf.Debug {
+		DB = DB.Debug()
+	}
 }

server/feed.go

@@ -54,6 +54,7 @@ func (f Feed) All() (*RespFeedAll, error) {
 			Name:      v.Name,
 			Link:      v.Link,
 			Failure:   v.Failure,
+			Suspended: v.Suspended,
 			UpdatedAt: v.UpdatedAt,
 			Group:     GroupForm{ID: v.GroupID, Name: v.Group.Name},
 		})
@@ -70,11 +71,12 @@ func (f Feed) Get(req *ReqFeedGet) (*RespFeedGet, error) {
 	}
 
 	return &RespFeedGet{
-		ID:      data.ID,
-		Name:    data.Name,
-		Link:    data.Link,
-		Failure: data.Failure,
-		Group:   GroupForm{ID: data.GroupID, Name: data.Group.Name},
+		ID:        data.ID,
+		Name:      data.Name,
+		Link:      data.Link,
+		Failure:   data.Failure,
+		Suspended: data.Suspended,
+		Group:     GroupForm{ID: data.GroupID, Name: data.Group.Name},
 	}, nil
 }
 
@@ -154,8 +156,9 @@ func (f Feed) CheckValidity(req *ReqFeedCheckValidity) (*RespFeedCheckValidity,
 
 func (f Feed) Update(req *ReqFeedUpdate) error {
 	data := &model.Feed{
-		Name: req.Name,
-		Link: req.Link,
+		Name:      req.Name,
+		Link:      req.Link,
+		Suspended: req.Suspended,
 	}
 	if req.GroupID != nil {
 		data.GroupID = *req.GroupID

server/feed_form.go

@@ -7,6 +7,7 @@ type FeedForm struct {
 	Name      *string   `json:"name"`
 	Link      *string   `json:"link"`
 	Failure   *string   `json:"failure"`
+	Suspended *bool     `json:"suspended"`
 	UpdatedAt time.Time `json:"updated_at"`
 	Group     GroupForm `json:"group"`
 }
@@ -43,10 +44,11 @@ type ReqFeedCreate struct {
 }
 
 type ReqFeedUpdate struct {
-	ID      uint    `param:"id" validate:"required"`
-	Name    *string `json:"name"`
-	Link    *string `json:"link"`
-	GroupID *uint   `json:"group_id"`
+	ID        uint    `param:"id" validate:"required"`
+	Name      *string `json:"name"`
+	Link      *string `json:"link"`
+	Suspended *bool   `json:"suspended"`
+	GroupID   *uint   `json:"group_id"`
 }
 
 type ReqFeedDelete struct {

service/pull/pull.go

@@ -72,8 +72,8 @@ func (p *Puller) PullAll(ctx context.Context) error {
 	defer close(routinePool)
 	wg := sync.WaitGroup{}
 	for _, f := range feeds {
-		if f.Failure == nil || *f.Failure != "" {
-			// skip failed and unresolved feeds
+		if f.IsSuspended() || f.IsFailed() {
+			log.Printf("skip %d\n", f.ID)
 			continue
 		}