microbiomedata / nmdc-schema

National Microbiome Data Collaborative (NMDC) unified data model
https://microbiomedata.github.io/nmdc-schema/
Creative Commons Zero v1.0 Universal
26 stars 8 forks source link

Migrations: Restore adapter method that was discarded during merge #2031

Closed eecavanna closed 1 month ago

eecavanna commented 1 month ago

In commit https://github.com/microbiomedata/nmdc-schema/pull/2006/commits/8c35dc5b2db40e8cb728c90ebc25601d2bbbf090, I implemented an adapter method named do_for_each_document. I opened PR https://github.com/microbiomedata/nmdc-schema/pull/2006 to request that it be "pulled" (merged) into the main branch.

While that PR remained unmerged, in commit https://github.com/microbiomedata/nmdc-schema/pull/2009/commits/3c7a2944fe7afc69967a317e3472359787fcedc1, I implemented an adapter method named set_field_of_each_document. I opened PR https://github.com/microbiomedata/nmdc-schema/pull/2009 to request that it be "pulled" (merged) into the main branch.

Both of those PRs were eventually merged into main. The merging of the latter PR involved some merge conflicts, which @turbomam resolved locally and whose resolution I reviewed/approved.

Today, I noticed that one of the above two methods is missing on the main branch: only the set_field_of_each_document method exists (the do_for_each_document method is missing). ⚠️

I don't know exactly how this happened. I suspect it's related to the order in which the PRs were merged and/or how the merge conflict resolution was performed. Two paths forward here are: (A) determine the root cause of the issue and then restore the discarded code; (B) restore the discarded code. Both paths involve restoring the discarded code, so I'm going to start with that.

eecavanna commented 1 month ago

There's a "schema freeze" in effect right now, but I think all stakeholders were under the impression both of these methods had been merged into main. I expect to have a PR open by the end of the day on Wednesday, June 5.

eecavanna commented 1 month ago

Root cause

In commit 24891307, the two functions were "consolidated" instead of put one after the other.

image