class Task::CollectGarbage

• Task::CollectGarbage
• Task
• Reference
• Object

Overview

Garbage collection task for ActivityPub objects.

Garbage collection identifies and removes objects that are not connected to the user through preservation rules, described below.

How It Works

1. Identification: Identifies objects that should be preserved based on preservation rules, described below.

2. Deletion: Deletes objects and all associated records (tags, activities, relationships, translations).

3. Optimization: Runs SQLite VACUUM and OPTIMIZE to reclaim freed space.

Preservation Rules

Objects are preserved if they meet any of the following criteria:

• Objects attributed to local users or to remote actors that local users follow

• Objects associated with activities created by local users or by remote actors that local users follow

• Objects with hashtags, mentions, or that are part of threads that local users follow

• Objects in relationships with local users (timelines,

• notifications, the outbox)

• Objects in a thread (unless every object in the thread can be

• deleted)

• Recent objects

Of Note

• Deleting an object will remove many associated records (activities, relationships, tags, translations), but never other objects.

• Either entire threads are preserved or they are eligible for deletion.

Included Modules

• Task::Singleton

Defined in:

Constant Summary

DEFAULT_MAX_AGE_DAYS = 365

DEFAULT_MAX_DELETE_COUNT = 1000

Log = ::Log.for(self)

Constructors

• .current_instance : self

  Returns the current active instance of this singleton task.

Class Method Summary

• .ensure_scheduled

  Ensures the singleton task is scheduled.

• .find_active : self | Nil

  Finds the active instance.

• .followed_hashtags
• .followed_mentions
• .followed_or_following_actors
• .followed_threads
• .get_max_age_days : Int32
• .get_max_age_days=(get_max_age_days : Int32)
• .get_max_delete_count : Int32
• .get_max_delete_count=(get_max_delete_count : Int32)
• .objects_associated_with_followed_actor_activities
• .objects_associated_with_followed_content
• .objects_associated_with_user_activities
• .objects_attributed_to_followed_actors
• .objects_attributed_to_user
• .objects_in_threads

  Finds all objects that are part of the same thread as any preserved object.

• .objects_in_user_relationships
• .objects_to_preserve
• .objects_too_recent_to_delete

Instance Method Summary

• #delete_object_and_associations(object_iri : String)

  Deletes an object and associated records.

• #perform(max_age_days = self.class.get_max_age_days, max_delete_count = self.class.get_max_delete_count)

  Performs garbage collection when scheduled.

• #perform_on_demand(max_age_days = self.class.get_max_age_days, max_delete_count = Int32::MAX)

  Performs garbage collection on-demand.

Constructor Detail

Class Method Detail

Instance Method Detail