Add sleep/wakeup process to retrieve bucket data during plugin initialization

Aperta
#117 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
typescript
Ambito
api, full-stack

Direzione di ricerca

Start by comparing the sleep/wakeup flow in the referenced geowatch-agent-track implementation. Then trace the plugin descriptor's DATA_TO_RETRIEVE secureData, OFS bucket API calls, device cache/local storage, and plugin page entry point; the work is done when configured string and file properties are retrieved, persisted, displayed, and failure or missing-data cases are handled.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Enhancement Request

Overview

Implement a sleep/wakeup process similar to the geowatch-agent-track plugin that will invoke the OFS API during the plugin initialization to retrieve data from specified buckets.

Background

The geowatch-agent-track plugin (/Volumes/SSD Miquel - SanDisk/visual-code/cat-repos/geowatch-agent/geowatch-agent-track) demonstrates how to retrieve OFS position data during initialization. This enhancement will follow the same pattern but for retrieving bucket properties.

Requirements
Data Retrieval

The plugin should retrieve two types of properties from a specified bucket:

  1. String property - A text/string value stored in the bucket
  2. File property - A file stored in the bucket
Configuration

The bucket and properties to fetch will be defined in the plugin descriptor as secureData with the name DATA_TO_RETRIEVE in the following format:

[
    {
        "bucket_name": "my_data_bucket",
        "properties_to_fetch": {
            "string_property": "string",
            "file_property": "file"
        }
    }
]
Data Storage

After retrieving the data from the OFS API:

  • Store both the string property and file property in the device cache/local storage
  • Persist the data so it's available when the plugin opens
Data Display

When the plugin is opened:

  • Retrieve the previously stored data from device cache/local storage
  • Display both the string property value and the file property on the page
  • Handle cases where no data has been retrieved yet
Implementation Pattern
  • Follow the same sleep/wakeup pattern used in geowatch-agent-track
  • Invoke OFS API during plugin initialization (init process)
  • Handle both string and file property types
  • Store retrieved data in device cache/local storage
  • Display stored data when plugin opens
Technical Approach
  1. Add sleep/wakeup event handlers
  2. Parse DATA_TO_RETRIEVE from secureData
  3. Make API calls to OFS bucket API during initialization
  4. Handle string property retrieval
  5. Handle file property retrieval
  6. Store data in device cache/local storage
  7. On plugin open, retrieve data from local storage
  8. Display retrieved data on the plugin page
  9. Handle errors gracefully (missing bucket, properties, API failures, storage failures)
Reference Implementation

See: /Volumes/SSD Miquel - SanDisk/visual-code/cat-repos/geowatch-agent/geowatch-agent-track

Acceptance Criteria
  • Plugin reads DATA_TO_RETRIEVE configuration from secureData
  • Sleep/wakeup process initializes on plugin load
  • API calls retrieve string property from specified bucket
  • API calls retrieve file property from specified bucket
  • Retrieved data is stored in device cache/local storage
  • Plugin displays stored string property when opened
  • Plugin displays stored file property when opened
  • Handle cases where no cached data exists yet
  • Error handling for missing/invalid configuration
  • Error handling for API failures
  • Error handling for storage access failures
  • Documentation updated with configuration examples
Lingua principale
TypeScript
Stelle
6
Fork
5
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di oracle-samples/ofs-sample-plugins

Tutte le issue di oracle-samples/ofs-sample-plugins

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.