common: move `field()` to util and remove export of common's `field` in adaptors #1173

hunterachieng · 2025-04-30T08:30:59Z

Summary

Move field() function to util in common

Fixes #1118

Details

Add technical details of what you've changed (and why).

AI Usage

Please disclose how you've used AI in this work (it's cool, we just want to
know!):

You can read more details in our
Responsible AI Policy

Review Checklist

Before merging, the reviewer should check the following items:

Does the PR do what it claims to do?
If this is a new adaptor, added the adaptor on marketing website ?
If this PR includes breaking changes, do we need to update any jobs in
production? Is it safe to release?
Are there any unit tests?
Is there a changeset associated with this PR? Should there be? Note that
dev only changes don't need a changeset.
Have you ticked a box under AI Usage?

Signed-off-by: Hunter Achieng <[email protected]>

This reverts commit 91116c8.

Signed-off-by: Hunter Achieng <[email protected]>

* feat: update rapidpro Signed-off-by: Hunter Achieng <[email protected]> * feat: add changeset Signed-off-by: Hunter Achieng <[email protected]> * fix: remove config and fix r`return await` Signed-off-by: Hunter Achieng <[email protected]> * fix: update changeset Signed-off-by: Hunter Achieng <[email protected]> * fix: remove export of http Signed-off-by: Hunter Achieng <[email protected]> * fix: update changeset with removal of http export Signed-off-by: Hunter Achieng <[email protected]> * fix: remove nock Signed-off-by: Hunter Achieng <[email protected]> --------- Signed-off-by: Hunter Achieng <[email protected]>

Signed-off-by: Hunter Achieng <[email protected]>

…ptors into feature/1120-common-migration

…1171) * feat: use common-request Signed-off-by: Hunter Achieng <[email protected]> * feat: add changeset Signed-off-by: Hunter Achieng <[email protected]> * fix: update changeset Signed-off-by: Hunter Achieng <[email protected]> * fix: update changeset Signed-off-by: Hunter Achieng <[email protected]> --------- Signed-off-by: Hunter Achieng <[email protected]>

…ommon-migration Signed-off-by: Hunter Achieng <[email protected]>

…ptors into feature/1120-common-migration Signed-off-by: Hunter Achieng <[email protected]>

common: remove deprecated expandreferences and update common versions

Signed-off-by: Hunter Achieng <[email protected]>

josephjclark · 2025-04-30T16:14:32Z

packages/http/src/util.js

@@ -195,4 +196,15 @@ export {
   * console.log(id); // Output:'3f4e254e-8f6f-4f8b-9651-1c1c262cc83f'
   */
  uuid,
+  /**
+   * Returns a key, value pair in an array.


This is the blocking problem: we cannot manually duplicate these docs across all adaptors.

These docs need removing :)

* remove common.map * changeset * typo * remove map from salesforce and mogli * changesets

Signed-off-by: Hunter Achieng <[email protected]>

josephjclark

Hi @hunterachieng - I've had a careful look through this and spotted a couple of things.

This is going to be such a huge piece of work 🤦 I'm going to do some user research before we commit more time to this. I don't want to do it if it's not valuable (I think it's a big improvement, but if I'm the only who thinks that then what's the point?)

Based on the time it's taken to do field, can you estimate how long it will take to move the other 10 (I think?) util functions?

packages/mailgun/README.md

packages/mailgun/test/index.js

packages/mailgun/src/utils.js

packages/common/src/util/field.js

josephjclark · 2025-05-06T08:09:16Z

packages/mysql/src/Adaptor.js

@@ -298,9 +298,7 @@ export {
  fn,
  fnIf,
  each,
-  http,


Was removing http here deliberate? Also seen in odoo, so maybe there are others

Yes. We did remove the old http implementation in common, do we need to keep exporting it?

Ah, well yes you're right. But that's not mentioned anywhere in the PR title or description so it surprised me. And I thought that stuff had been done on the epic.

We need to make sure that this is recorded in a changeset because it's super important to document. Maybe you can generate a major changeset for this now?

We'll also need a major changset for every change to field - but maybe we don't need to do that one yet. I'm not sure the easiest way to handle it.

ShouldI go through every adaptor and remove the exportation on http and create a major changeset for each?

Hang on, hang on, there's some confusion here.

When we removed http from rapidpro, we did so because it was exporting the old http namespace. It was version locked to common v1, and we didn't want to export the common v1 http namespace anymore.

That was actually wrong to do - we forgot that we'd updated to the latest common, so we should have left rapidpro to export http. Probably. But don't worry about that for now, I don't want to spend time on rapidpro.

But for other adaptors, we definitely don't want to change common http exports. Not here in this PR. We should not be touching mysql's http export here. If we want to do that, it must be on a new branch.

So for now, please revert all changes to http exports on this branch. We'll look at the in isolation as a separate exercise.

And in future, please try to avoid making unrelated changes in a PR! Try to stay focused on the task in hand.

I will improve on that. I have pushed the fixes

hunterachieng · 2025-05-06T12:01:28Z

On it.

…

On Tue, 6 May 2025, 14:58 Joe Clark, ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In packages/mailgun/src/utils.js <#1173 (comment)>: > @@ -0,0 +1 @@ +export { field } from ***@***.***/language-common/util'; Don't wonder about it- test it! #WWJD — Reply to this email directly, view it on GitHub <#1173 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AS4KQNTHWGGJNXQTQZHSIW325CPWNAVCNFSM6AAAAAB4FALU3CVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDQMJXHE4DQOJZG4> . You are receiving this because you were mentioned.Message ID: ***@***.***>

Signed-off-by: Hunter Achieng <[email protected]>

hunterachieng · 2025-07-07T09:59:09Z

@josephjclark about this PR. Should we still continue with the exports?

hunterachieng and others added 23 commits April 24, 2025 18:28

feat: remove old expandreferences and use the new implementation

295712f

Signed-off-by: Hunter Achieng <[email protected]>

update http to request

91116c8

Signed-off-by: Hunter Achieng <[email protected]>

Revert "update http to request"

0f4f47e

This reverts commit 91116c8.

feat: update expandreference destructure

6d97964

Signed-off-by: Hunter Achieng <[email protected]>

fix: failing tests

9cf7d7c

Signed-off-by: Hunter Achieng <[email protected]>

fix: update expandReferences

afa4c48

Signed-off-by: Hunter Achieng <[email protected]>

fix: update common test

7c0a679

Signed-off-by: Hunter Achieng <[email protected]>

fix: update common version

3e32729

Signed-off-by: Hunter Achieng <[email protected]>

fix: update lock.yaml

13b22fa

Signed-off-by: Hunter Achieng <[email protected]>

fix: update common export and progres post()

20fc025

Signed-off-by: Hunter Achieng <[email protected]>

fix: rename newExpandreferences to expandReferences

23ac8e8

Signed-off-by: Hunter Achieng <[email protected]>

fix: Remove skip from progres tests

c302646

Signed-off-by: Hunter Achieng <[email protected]>

feat: add changeset

ea85695

Signed-off-by: Hunter Achieng <[email protected]>

fix: update common changeset

1a2404c

Signed-off-by: Hunter Achieng <[email protected]>

fix: add path changeset

c4625fa

Signed-off-by: Hunter Achieng <[email protected]>

Merge branch 'feature/1120-common-migration' of github.com:OpenFn/ada…

b6c110e

…ptors into feature/1120-common-migration

Merge branch 'main' of github.com:OpenFn/adaptors into feature/1120-c…

04afd9d

…ommon-migration Signed-off-by: Hunter Achieng <[email protected]>

Merge branch 'feature/1120-common-migration' of github.com:OpenFn/ada…

2a55a3c

…ptors into feature/1120-common-migration Signed-off-by: Hunter Achieng <[email protected]>

Merge pull request #1160 from OpenFn/feature/1120-common-migration

07b84ae

common: remove deprecated expandreferences and update common versions

feat: move field to util

54e82bb

Signed-off-by: Hunter Achieng <[email protected]>

fix: update field import in common tests

84f12a9

Signed-off-by: Hunter Achieng <[email protected]>

hunterachieng requested a review from josephjclark April 30, 2025 08:30

taylordowns2000 added this to Adaptor Development Apr 30, 2025

hunterachieng changed the base branch from main to epic/common-3 April 30, 2025 08:31

fix: add util in http

d582b66

Signed-off-by: Hunter Achieng <[email protected]>

josephjclark reviewed Apr 30, 2025

View reviewed changes

josephjclark added 2 commits May 1, 2025 10:52

common: remove map (#1172)

a4f3740

* remove common.map * changeset * typo * remove map from salesforce and mogli * changesets

remove salesforce changelog

8cef333

hunterachieng added 17 commits May 5, 2025 18:05

fix: update postgresql to use util.field()

a29b2da

Signed-off-by: Hunter Achieng <[email protected]>

fix: update primero to use util.field()

6ae8139

Signed-off-by: Hunter Achieng <[email protected]>

fix: update progres to use util.field()

7f4708b

Signed-off-by: Hunter Achieng <[email protected]>

fix: update rapidpro to use util.field()

7c8492f

Signed-off-by: Hunter Achieng <[email protected]>

fix: update redis to use util.field()

27d6f43

Signed-off-by: Hunter Achieng <[email protected]>

fix: update resourcemap to use util.field()

80448c1

Signed-off-by: Hunter Achieng <[email protected]>

fix: update salesforce to use util.field()

f93ceb1

Signed-off-by: Hunter Achieng <[email protected]>

fix: remove icon in salesforce

a822c03

Signed-off-by: Hunter Achieng <[email protected]>

fix: update satusehat to use util.field()

adf5f1c

Signed-off-by: Hunter Achieng <[email protected]>

fix: update senaite to use util.field()

214c189

Signed-off-by: Hunter Achieng <[email protected]>

fix: update sftp to use util.field()

5176c8c

Signed-off-by: Hunter Achieng <[email protected]>

fix: update surveycto to use util.field()

66811db

Signed-off-by: Hunter Achieng <[email protected]>

fix: update twilio to use util.field()

6bc1d20

Signed-off-by: Hunter Achieng <[email protected]>

fix: update telerivet to use util.field()

752631d

Signed-off-by: Hunter Achieng <[email protected]>

fix: update vtiger to use util.field()

f1f6b3d

Signed-off-by: Hunter Achieng <[email protected]>

fix: update wigal to use util.field()

e191cdd

Signed-off-by: Hunter Achieng <[email protected]>

fix: update zoho to use util.field()

71f6a2f

Signed-off-by: Hunter Achieng <[email protected]>

hunterachieng requested a review from josephjclark May 5, 2025 16:14

josephjclark requested changes May 6, 2025

View reviewed changes

hunterachieng added 4 commits May 6, 2025 21:59

fix: add import for util in index.js

187b481

Signed-off-by: Hunter Achieng <[email protected]>

fix: update field example in common

9b4a7a8

Signed-off-by: Hunter Achieng <[email protected]>

fix: update mailgun example

2861974

Signed-off-by: Hunter Achieng <[email protected]>

fix: update mailgun tests imports

498bb16

Signed-off-by: Hunter Achieng <[email protected]>

hunterachieng changed the title ~~common: move field() to util~~ common: move field() to util and remove export of common's field and http in adaptors May 6, 2025

fix: revert http exports in common

e579825

Signed-off-by: Hunter Achieng <[email protected]>

hunterachieng changed the title ~~common: move field() to util and remove export of common's field and http in adaptors~~ common: move field() to util and remove export of common's field in adaptors May 7, 2025

hunterachieng requested a review from josephjclark May 7, 2025 08:14

Base automatically changed from epic/common-3 to main July 10, 2025 07:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

common: move `field()` to util and remove export of common's `field` in adaptors #1173

common: move `field()` to util and remove export of common's `field` in adaptors #1173

Uh oh!

hunterachieng commented Apr 30, 2025 •

edited

Loading

Uh oh!

josephjclark Apr 30, 2025

Uh oh!

josephjclark May 6, 2025

Uh oh!

josephjclark left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

josephjclark May 6, 2025

Uh oh!

hunterachieng May 6, 2025

Uh oh!

josephjclark May 6, 2025

Uh oh!

hunterachieng May 6, 2025

Uh oh!

josephjclark May 7, 2025

Uh oh!

hunterachieng May 7, 2025

Uh oh!

hunterachieng commented May 6, 2025 via email

Uh oh!

hunterachieng commented Jul 7, 2025

Uh oh!

Uh oh!

@@ @@ -298,9 +298,7 @@ export { @@
                 fn,
                 fnIf,
                 each,
-                http,

common: move field() to util and remove export of common's field in adaptors #1173

Are you sure you want to change the base?

common: move field() to util and remove export of common's field in adaptors #1173

Uh oh!

Conversation

hunterachieng commented Apr 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Details

AI Usage

Review Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

josephjclark left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hunterachieng commented May 6, 2025 via email

Uh oh!

hunterachieng commented Jul 7, 2025

Uh oh!

Uh oh!

common: move `field()` to util and remove export of common's `field` in adaptors #1173

common: move `field()` to util and remove export of common's `field` in adaptors #1173

hunterachieng commented Apr 30, 2025 •

edited

Loading