NASA-AMMOS / NASA-AMMOS/plandev

Removing TypeScript Command Expansion

Open
#1,863 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

breaking change
Dominant language
Java
Stars
128
Forks
33
Avg merge
1d 17h
Merged PRs (30d)
12

Description

As of PlanDev 4.4.0, we intend to deprecate and remove support for the TypeScript Command Expansion DSL in the Sequencing service, and move to Sequence Templates as the primary supported method for expanding PlanDev activities into command sequences. This change is intended to reduce the maintenance burden of a feature that is no longer in active use by any of our known stakeholders, while allowing us to focus development on the Sequence Template workflow.

In previous versions, the aerie_ui service supported the environment variable PUBLIC_COMMAND_EXPANSION_MODE, which could be set to either "typescript" or "templating" to select between the two command expansion modes. Starting in PlanDev 4.4.0, this variable will be removed and Sequence Template expansion will be the only supported behavior.

After migrating to PlanDev 4.4.0:

  • TypeScript expansion rules, expansion sets, and expansion runs will no longer be accessible through the PlanDev UI.
  • TypeScript expansion rules will no longer be supported for generating new command expansions through the UI or API.
  • Existing Typescript expansion rule, set, and run data will be preserved in the database for users who need to refer to historical data. This data will remain accessible through the Hasura UI or API.
  • Previously expanded sequences that have been sent to SeqDev workspaces will not be modified and will remain accessible through SeqDev.
  • Sequence Template expansion will continue to be supported and will become the single command expansion workflow in PlanDev.

Users who currently depend on TypeScript expansion rules should migrate those workflows to Sequence Templates before upgrading to PlanDev 4.4.0. If you are currently using the TypeScript Command Expansion DSL, or have a use case that cannot be migrated to Sequence Templates, please let us know before the PlanDev 4.4.0 release.

PRs

UI: https://github.com/NASA-AMMOS/plandev-ui/pull/1983
Backend: https://github.com/NASA-AMMOS/plandev/pull/1865

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 UI PR #1983 and backend PR #1865 referenced in the issue, then verify how PUBLIC_COMMAND_EXPANSION_MODE and TypeScript expansion access are handled. Done means the TypeScript workflow is removed while historical data, previously expanded SeqDev workspace sequences, and Sequence Template expansion remain supported.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
full-stack
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.