OpenFn / OpenFn/lightning

Show when credentials are misconfigured (basic UI)

Open
#4,015 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

On the Credentials settings page, it would be great to inform users of any credentials that are misconfigured

Image

We should show an error icon or something next to the name when there's an issue.

A credential is misconfigured when:

  • It has no values
  • All required values are set
  • It does not provide an env it needs to (this is something like: look at all the projects with access, get a list of all the envs across those projects, and ensure the credential provides a value for each env
  • If it's oauth and expired maybe?

The envs thing is the big one - this is a quite a big issue in sandboxes right now.

This isn't the best place to show this information. We should probably add indicators to Workflow tables and the Workflow Diagram when a credential is misconfigured.

But this feels like the easiest place to start? We can add the logic to health check a credential, dump it in the settings page (which is useful if not intuitive), and then work it into nicer UX solutions later.

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 at the Credentials settings page and trace how credentials, required values, project access, environments, and OAuth expiry are represented. Define the health-check result and display behavior for empty or incomplete credentials; done when misconfigured credentials are visibly indicated there and the listed cases are covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
elixir
Domain
full-stack
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.