OpenFn / OpenFn/kit

File path support for jobs in project import/export

Open
#561 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
21
Forks
23
Avg merge
1d 22h
Merged PRs (30d)
17

Description

Description

When using a file path for job body in project.yaml As instructed here in versions portability proposal v4, The job editor on lightning fails to render the actual job code, instead it displays the literal file path.

Steps to Reproduce
  1. Clone OpenFn/demo-openhie project locally
  2. Open project.yml and edit Transform-data-to-FHIR-standard body path to file://./jobs/expression.js
  3. Save and commit your changes
  4. Login on demo.openfn.org as demo users demo@openfn.org
  5. On dashboard open OpenHIE Workflow
  6. Click on Transform-data-to-FHIR-standard step to open the job editor
  7. Observe that the editor displays the file path instead of the job code
Expected Behavior

The Lightning Job Editor should accurately interpret the specified file path in the project.yaml file, rendering and displaying the corresponding job code.

Screenshots

https://github.com/OpenFn/Lightning/assets/6592749/02badd41-2436-46da-b30b-575b6d4511dc

Screenshot 2024-01-11 at 8 36 19 PM
Additional information

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 tracing project import/export handling in the kit repository, especially the packages/deploy area mentioned in the issue, and compare it with the project.yaml file path example and jobs/expression.js fixture. Verify how the file:// path reaches the job editor. Done means the editor renders the referenced job code and project export writes the appropriate path.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 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.