posit-dev / posit-dev/connectapi

Consider other options for `search_content()` return type (vs converting all to R6 objects)

Open
#474 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
R
Stars
54
Forks
27
Avg merge
1d 3m
Merged PRs (30d)
1

Description

Added in https://github.com/posit-dev/connectapi/pull/463, search_content() returns a list of Content R6 objects.

Creation of R6 objects can be slow (adds about a second of latency with ~7000 items). Is there a faster way to do this?

From https://github.com/posit-dev/connectapi/pull/470#discussion_r2439793528

Eventually we will probably want to convert the Content class to S3 and modify all of the functions that use the R6 class to use S3.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the implementation introduced in pull request #463 and the design discussion in pull request #470. Measure the latency of search_content() with about 7,000 items, compare alternatives to constructing Content R6 objects, and review the longer-term S3 migration implications. Done means an agreed, faster return strategy with its impact on existing Content consumers documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
r
Domain
api, performance
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.