OpenFn / OpenFn/lightning

Support adaptors with version @next

Open
#2,208 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

DevX
Dominant language
Elixir
Stars
296
Forks
86
Avg merge
1d 13h
Merged PRs (30d)
50

Description

I need help!

I am implementing a feature where adaptors may be pre-released with the version @next.

Background

Prerelease adaptors will be developed by an engineer and allow early-access to the adaptor. This lets us run QA inside lightning.

At the moment, we tend to release an adaptor, have implementation try it out in lightning, and then hive feedback which maybe results in a new PR. Not a good process.

Adaptors will be published to npm with the @next tag.

Not all adaptors will have @next tagged builds.

Implementation Notes

Worker support is added in https://github.com/OpenFn/kit/pull/716

Lightning needs to provide access to the next release, if appropriate, in the adaptors dropdown. Something like this:

image

In the select, the next version should be at index 0, the latest version should be at index 1, and all other versions from 2+.

You can literally send next to the worker like a full semver string. The worker knows what to do with it and will handle caching and autoinstalling elegantly.

Lightning's adaptor picker should ignore versions with the -next-<hash> suffix. This is a redundancy that means if a version somehow fails to be deprecated by automation, it won't appear in the drop-down list. You need a regex like /-next-(.+)/

Contributor guide

No contributing guide indexed for this repository

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 by locating Lightning's adaptors dropdown and the code that sends the selected version to the worker. The picker should show @next first when available, the latest version second, and exclude versions matching the -next- suffix. Confirm the worker receives next as the selected version.

Written by the indexing model from the issue text.

Assessment

Tech stack
elixir
Domain
backend, frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.