mise API - v0.0.0
    Preparing search index...

    Class ProcCache

    Session-scoped cache of feed and instance topology with restorable terminal state.

    Index
    • Records the timestamp of a successful durable save.

      Parameters

      • checkpointAt: string

        ISO timestamp written into the checkpoint.

      Returns void

      Nothing.

    • Every instance the cache holds for a feed, whether or not its parent has arrived: the roll, in id order.

      Parameters

      • feedID: number

        The feed.

      Returns number[]

      The instance ids, ascending.

    • Returns every instance ID belonging to a feed, walking the anchor tree from its roots (breadth-first). Order is roots-first, then descendants.

      Parameters

      • feedID: number

        Feed to enumerate.

      Returns number[]

      All instance IDs in the feed's anchor tree.

    • Marks one feed's load as failed where it stopped. The entry stays annunciated for a minute so the failure is seen, then is forgotten; the next visit starts a fresh walk.

      Parameters

      • feedID: number

        The feed whose walk failed.

      • message: string

        What the failure said.

      • at: number = ...

        When it failed (default now).

      Returns void

    • Records progress of one feed's topology load.

      Parameters

      • feedID: number

        The feed being loaded.

      • loaded: number

        Instances fetched so far.

      • total: number

        The server's count, or zero while unknown.

      Returns void

    • Every feed load worth showing, earliest first: the walks in flight and the failures still remembered. Two feeds can walk at once (an operator and a pane, or two panes), and each is index movement of its own.

      Parameters

      • now: number = ...

        The clock (default now), against which failures expire.

      Returns ProcFeedLoadProgress[]

      The loads, earliest first; empty when nothing moves.

    • Searches cached feeds by title or by name: a term is matched case-insensitively against the title and against the feed's feed_N name, so a bare id (4389), a name (feed_4389) and a title word all find their feed.

      Parameters

      • term: string

        The search term; empty matches every feed.

      Returns ProcFeed[]

      The matching feeds, in cache order.

    • Replaces the visible feed set while preserving topology for retained feeds.

      Parameters

      • feeds: ProcFeed[]

        Authoritative feeds visible to the current identity.

      Returns number[]

      IDs requiring topology reconciliation because they are new, their aggregate job counts changed, or they still have active work.

    • Counts visible feeds in exclusive ownership, sharing, and public buckets.

      Ownership takes precedence over public visibility so the buckets sum to the unique feed total.

      Parameters

      • username: string

        Authenticated username whose owned feeds form user.

      Returns ProcFeedScopeCounts

      Exclusive scope counts whose components sum to total.

    • Creates one feed's persistence-safe snapshot: its instances (terminal status only, no params or output paths) and whether its topology is complete. A per-feed checkpoint shard is exactly this.

      Parameters

      • feedID: number

        The feed to snapshot.

      Returns ProcFeedSnapshot

      The feed's shard content; empty when the feed holds no instances.

    • Drops a feed's topology — its instances, roots and the loaded mark — and keeps its roster row, so a re-walk starts from nothing the cache remembers about the graph while the feed stays where the roster put it.

      Parameters

      • feedID: number

        The feed whose topology is dropped.

      Returns void

    • Merges observed execution metrics onto an instance. Only defined values land, so a refresh that carries no timing never erases what warmup saw.

      Parameters

      • id: number
      • metrics: {
            computeResource?: string;
            finishedAt?: string;
            outputBytes?: number;
            pipelineName?: string | null;
            startedAt?: string;
            workflowID?: number | null;
        }

      Returns void

    • Returns the resolved join parent IDs for an instance, or an empty array when the node has none or they have not been resolved yet.

      Parameters

      • id: number

        Instance ID.

      Returns number[]

      Source instance IDs, or [].

    • Records the resolved topological-join parent IDs for a ts instance. Immutable data — set once when the feed's join edges are first fetched.

      Parameters

      • id: number

        Instance ID of the join (ts) node.

      • ids: number[]

        Source instance IDs it merges (beyond its anchor parent).

      Returns void

    • Finds the closest cached job output containing a CFS path.

      An output path is a directory boundary: /home/alice/run contains /home/alice/run/result.txt, but not /home/alice/run-old.

      Parameters

      • cfsPath: string

        Absolute CFS path to resolve against live-session outputs.

      Returns ProcInstance | undefined

      The closest producing instance, or undefined when no output path known in this session contains the path.

    • Stores the lazily resolved CUBE output path for one instance.

      Parameters

      • id: number

        Plugin-instance ID whose output location was resolved.

      • outputPath: string | null

        Absolute CFS output directory, or null when absent.

      Returns void

      Nothing.

    • Updates cached params for an instance (on first cat).

      Parameters

      • id: number
      • params: Record<string, unknown>

      Returns void

    • Reconstructs the full /proc/jobs path for a given instance ID.

      Parameters

      • id: number

        Instance ID.

      Returns string | null

      Full path string, or null if instance not in cache.

      cache.path_build(64306)
      // '/proc/jobs/feed_1107/pl-dircopy_64267/.../pl-neurofiles-push_64306'
    • A feed's plugin names by first appearance, root first — the shape its pipeline left. A feed that ran dircopy, then dcm2niix, then fastsurfer shares its first two names with every feed that began the same way.

      Read from the feed's roll, not its root walk: while a sweep is still bringing a feed in, an instance whose parent has not arrived counts as depth zero, and the chain settles as the parents land.

      Parameters

      • feedID: number

        The feed.

      Returns string[]

      The names, in order of the shallowest instance that bore each.

    • A feed's jobs collapsed by plugin per place in the pipeline: the shape with counts for weight. Jobs of one plugin under one parent group are one node; a fan of three hundred conversions is a node of 300.

      Parameters

      • feedID: number

        The feed.

      Returns ProcJobGroup[]

      The groups, parents before children, root first.

    • Declares which folder each kind of feed appears in, so an arrival dirties the one listing whose membership actually changed.

      A host may declare only what it knows. An unnamed folder is simply never marked, rather than every folder being marked because the roster could not tell them apart.

      Parameters

      • folders: RosterFolders

        Folders by how this identity sees a feed.

      Returns void

    • Feed IDs that hold any instances or a loaded mark — the feeds a full checkpoint must shard.

      Returns number[]

      Feed IDs with persistent topology state.

    • Updates the cached status for an instance. Terminal (settled) statuses are never overwritten — once finished, a job's status is immutable.

      Parameters

      • id: number

        Instance ID.

      • status: string

        Fresh status observed from the API.

      Returns void

    • Removes instances absent from an authoritative topology sweep.

      Parameters

      • instanceIDs: Set<number>

        Instance IDs returned by the completed CUBE sweep.

      Returns void

      Nothing.

    • The feeds the index read something of in the last while, each as it stands now: its size so far, its status, and the shape of its pipeline so far.

      Parameters

      • now: number = ...

        The clock, for the window.

      Returns ProcLandedFeed[]

      The landed feeds, earliest landing first.

    • Takes the NEW mark off feeds the operator has looked at.

      Parameters

      • feedIDs: number[] | "all"

        The feeds seen, or all.

      Returns number

      How many marks were taken off.