Name live data source code consistently: Live, LiveIntegration and LiveSource
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Refactor
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- typescript
- Domain
- backend, developer-experience, frontend
Research direction
Read the naming table and Phase 1 list, then trace the listed TypeScript types, variables, and live integration file; the issue does not name their paths. Start with the non-breaking renames and check that table names and metric names stay unchanged. Done means Phase 1 is merged and new code follows the naming table, with a plan for each locked Phase 2 name.
Written by the indexing model from the issue text.
Description
Why
Live data source code uses several names for the same concepts. One configured source is called LiveSource*, ApiSource*, ExternalConnectionApiSource and apiSource depending on the file. Integration-level things are sometimes named after a source (LiveSourceSetupKind, LIVE_SOURCE_CATALOG). Readers can't tell from a name what it belongs to.
Target naming
| Prefix | Means | Example |
|---|---|---|
Live* |
the shared engine, used by every integration | LiveCalls, LiveHttpRequest |
LiveIntegration* |
one integration kind (GA4, PostHog) | LiveIntegrationType, LIVE_INTEGRATION_CATALOG |
LiveSource* |
one source configured in a project | LiveSourceFields, LiveSourceSettings |
ExternalConnection* |
only the generic storage and auth container | ExternalConnectionModel |
ApiSource*, ApiQuerySource* |
legacy; kept only where renaming breaks something | ApiSourceExplore (swagger) |
No new ApiSource* names, and no ExternalConnection* names in live engine code.
Phase 1: non-breaking (internal TypeScript only)
- Integration-level names:
LiveSourceSetupKind,LiveSourceCatalogEntry,LiveSourceAgentQueryGuide, the frontendLIVE_SOURCE_CATALOG, and the fileliveSourceIntegrations.tsmove toLiveIntegration*. - Backend
ApiSource*names that aren't in swagger: the call limiter, call and lease types, table type constants (table names unchanged), metric variables (metric names unchanged),ApiSourceQueryContext/Issue, andApiSourceOf<C>(toLiveSourceSettings<C>). - Live engine code that says
ExternalConnection*when it means a source's settings usesLiveSourceSettings. - Then the
apiSourcevariables (about 570 uses), once the types above have landed.
Phase 2: breaking (later, planned with release safety)
- Swagger schemas:
ApiSourceExplore,ApiSourceQuery,ApiSourceCapabilities,ApiSourcePushdown,ApiSourcePayload,ApiSourceSchemaScan,ApiSourceSchemaEvent,ApiSourceFieldRule,ApiSourceIncompatibility,ApiSourceMetricAggregation,ExternalConnectionApiSource,ExternalConnectionApiUsage. - The stored
connectorkey on each source's settings (needs a migration and an API that accepts both). - Metric, trace, job and analytics event names (
apiConnector,lightdash.apiConnector,api_source_*metrics), plus the product analytics charts that read them. - Table names and
ApiQuerySource*.
Done when
- Phase 1 is merged, and new code follows the table above (it's written into the add-live-integration skill).
- Phase 2 has a plan for each locked name: rename with compatibility, or keep with a reason.
Follows the live integration redesign in #32675. An earlier, broader attempt (SPK-2906) was cancelled.
- Dominant language
- TypeScript
- Stars
- 6.2k
- Forks
- 809
- Avg merge
- 12h 13m
- Merged PRs (30d)
- 854
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from lightdash/lightdash
-
CLI OAuth login fails behind an authenticating proxy: GET /api/v1/user omits Proxy-AuthorizationOpen
Difficulty 1/5 Under an hour Newbie friendliness 85/100
lightdash/lightdash#33086 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
lightdash/lightdash#32851 · 1 comment ·
Maintainers usually reply within 1 day
-
✨ feature-request
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
lightdash/lightdash#32207 · 1 comment ·
Maintainers usually reply within 1 day
-
✨ feature-request
Difficulty 1/5 Under an hour Newbie friendliness 84/100
lightdash/lightdash#31273 · 2 comments ·
Maintainers usually reply within 1 day
-
cloudy-needs-review
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
lightdash/lightdash#31043 · 2 comments ·
Maintainers usually reply within 1 day
All issues in lightdash/lightdash
Similar issues
-
[功能请求] 设置选项语言调整Open功能请求
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
antithesishq/bombadil#473 ·
Maintainers usually reply within 2 days
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
ardia-browser/ardia#3291 ·
Maintainers usually reply within 1 day
-
The structured output reference promises null results for refusals that carry validation detailsOpenbug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
kind:refactor needs-decision spec waiting-on-owner
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
superhighfives/nylon-impossible#793 · 3 comments ·
Maintainers usually reply within 1 day