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

Đang mở
#117 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
typescript
Lĩnh vực
api, full-stack

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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
Ngôn ngữ chính
TypeScript
Star
6
Fork
5
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của oracle-samples/ofs-sample-plugins

Tất cả issue của oracle-samples/ofs-sample-plugins

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.