Project

General

Profile

Actions

Feature #23062

closed

Disable workflow→collection linking until we're ready to make clients ready

Added by Brett Smith 8 months ago. Updated 6 months ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
API
Target version:
Story points:
-
Release relationship:
Auto

Description

Context:

  • We want to make workflows be collections. See #19132. This is a good idea.
  • We did the API changes in #21074.
  • Clients need a lot of development to make the most of the API changes. See #23057.
  • We don't have development capacity to do that work soon.

For our next release, I want to walk back from the API changes without losing the work completely.

  • Mark all the tests added in #21074 as skipped, with a note they should be unskipped as part of #23057.
  • Add tests that validate that workflows cannot set collection_uuid on create or update. It should always be null. These tests should come with a prominent comment that they should be removed as part of #23057.
  • The documentation for the collection_uuid attribute of workflows should document: "This attribute is always null. It is reserved for future development."
  • Remove the rest of the documentation. Under the circumstances I think I'd be okay with commenting out. Removing it completely is fine as long as we have a note somewhere findable about the commit that added/removed it, so it's easier to recover later.

Subtasks 1 (0 open1 closed)

Task #23068: Review 23062-disable-wf-linkingResolvedTom Clegg08/01/2025Actions

Related issues 2 (1 open1 closed)

Related to Arvados - Feature #21074: "workflow" records link to a collection with the actual workflowResolvedPeter AmstutzActions
Related to Arvados - Idea #23057: Registered workflows become collections throughout ArvadosNewActions
Actions #1

Updated by Brett Smith 8 months ago

  • Related to Feature #21074: "workflow" records link to a collection with the actual workflow added
Actions #2

Updated by Brett Smith 8 months ago

  • Related to Idea #23057: Registered workflows become collections throughout Arvados added
Actions #3

Updated by Brett Smith 8 months ago

  • Target version set to Development 2025-08-06
  • Assigned To set to Tom Clegg
Actions #4

Updated by Brett Smith 8 months ago

  • Subtask #23068 added
Actions #6

Updated by Tom Clegg 8 months ago

  • All agreed upon points are implemented / addressed. Describe changes from pre-implementation design.
    • ✅ disable workflow->collection linking
    • ✅ add test to confirm collection_uuid cannot be set to non-null
    • ✅ comment out "Workflows linked to Collections" section on doc page
    • ✅ change collection_uuid doc description to "reserved", comment out future description
    • ✨ instead of skipping the tests, add $enable_workflow_collection_linking_for_tests global so the now-unreachable code still gets tested
  • Anything not implemented (discovered or discussed during work) has a follow-up story.
    • n/a
  • Code is tested and passing, both automated and manual, what manual testing was done is described.
    • ✅ see above
  • New or changed UI/UX has gotten feedback from stakeholders.
    • n/a
  • Documentation has been updated.
    • ✅ see above
  • Behaves appropriately at the intended scale (describe intended scale).
    • ✅ n/a
  • Considered backwards and forwards compatibility issues between client and server.
    • ✅ n/a
  • Follows our coding standards and GUI style guidelines.
Actions #7

Updated by Brett Smith 8 months ago

Tom Clegg wrote in #note-6:

  • ✨ instead of skipping the tests, add $enable_workflow_collection_linking_for_tests global so the now-unreachable code still gets tested

A little bit cheeky but sure, LGTM, thanks.

Actions #8

Updated by Tom Clegg 8 months ago

  • Status changed from New to Resolved
Actions

Also available in: Atom PDF