Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ADD] OpenSPP adaptor #409

Merged
merged 10 commits into from
Nov 9, 2023
Merged

Conversation

nhatnm0612
Copy link
Contributor

Summary

Add new adaptor for OpenSPP

Details

Create new adaptor following documents.

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, has the migration tool been run and the
    migration guide followed?
  • Are there any unit tests? Should there be?
  • Is there a changeset associated with this PR? Should there be? Note that
    dev only changes don't need a changeset.

Copy link
Member

@taylordowns2000 taylordowns2000 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hi @nhatnm0612 , thanks for this! a few quick things before this gets to code review:

  1. check your package.json... if nothing else, the name should be language-openspp (not "template")
  2. check your changelog! (this should be the first entry.)
  3. check the configuration schema... is this the right way to set up a credential for use with OpenSPP?

otherwise, at first glance, this looks really cool!

@nhatnm0612
Copy link
Contributor Author

nhatnm0612 commented Oct 20, 2023

hi @nhatnm0612 , thanks for this! a few quick things before this gets to code review:

  1. check your package.json... if nothing else, the name should be language-openspp (not "template")
  2. check your changelog! (this should be the first entry.)
  3. check the configuration schema... is this the right way to set up a credential for use with OpenSPP?

otherwise, at first glance, this looks really cool!

hi @taylordowns2000 , thanks for your suggestions, I have fixed these

Copy link
Member

@taylordowns2000 taylordowns2000 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hi @nhatnm0612 , this is looking really good. a few small changes and then one conversation to be had with @josephjclark or @mtuchi about how you're doing authentication and then passing around a connection.

i'd recommend that you either go with the approach shown in the salesforce adaptor or wait for Joe's feedback on your style here.

thanks again. this is looking really good! is it all working as expected with the new CLI?

packages/openspp/package.json Outdated Show resolved Hide resolved
packages/openspp/src/Adaptor.js Outdated Show resolved Hide resolved
packages/openspp/src/Adaptor.js Outdated Show resolved Hide resolved
packages/openspp/src/Adaptor.js Outdated Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

replace with openspp rectangular logo 512x190

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@taylordowns2000 hi, I did change the logos

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This new image is 567x120. @taylordowns2000 how precise do we need to be about the logo size?

Copy link
Contributor Author

@nhatnm0612 nhatnm0612 Nov 4, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is the best I could find in the weekend, I will ask someone during the next week

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll edit something together for you on Monday

packages/openspp/assets/square.png Outdated Show resolved Hide resolved
Copy link
Collaborator

@josephjclark josephjclark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is looking much better @nhatnm0612! Thank you for your efforts and your patience.

I've spotted a few more things that look important so please address the outstanding comments when you can.

I would love to be able to do some sort of testing of this. I don't know OpenSPP and there are no unit tests (obviously unit tests are hard because they rely on the OpenSPP backend, so don't worry about those).

Would it be possible to write a sample job which runs against the OpenSPP sandbox and exercises a few of these functions? You can call it job.example.js and include it under the test directory.

packages/openspp/README.md Outdated Show resolved Hide resolved
packages/openspp/src/Adaptor.js Outdated Show resolved Hide resolved
packages/openspp/src/Adaptor.js Outdated Show resolved Hide resolved
packages/openspp/src/Adaptor.js Outdated Show resolved Hide resolved
packages/openspp/src/Adaptor.js Outdated Show resolved Hide resolved
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This new image is 567x120. @taylordowns2000 how precise do we need to be about the logo size?

packages/openspp/src/Adaptor.js Outdated Show resolved Hide resolved
packages/openspp/src/Adaptor.js Outdated Show resolved Hide resolved
packages/openspp/src/Adaptor.js Outdated Show resolved Hide resolved
Copy link
Collaborator

@josephjclark josephjclark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you again, we're very very nearly there!

Two small tweaks to the readme. I'll edit you that image - I'm not sure if I can add it directly to your fork but I'll try it as soon as I get a chance.

The biggest one is we still need some kind of sample code which runs against the OpenSPP sandbox. I'd really like to run some kind of test on this before we merge it. Just one or two operation calls would suffice.

packages/openspp/README.md Outdated Show resolved Hide resolved
packages/openspp/README.md Outdated Show resolved Hide resolved
@nhatnm0612
Copy link
Contributor Author

Thank you again, we're very very nearly there!

Two small tweaks to the readme. I'll edit you that image - I'm not sure if I can add it directly to your fork but I'll try it as soon as I get a chance.

The biggest one is we still need some kind of sample code which runs against the OpenSPP sandbox. I'd really like to run some kind of test on this before we merge it. Just one or two operation calls would suffice.

about the image, I am asking for the correct size, please wait.
about the sample code, I am doing this 😄

@nhatnm0612
Copy link
Contributor Author

hi @taylordowns2000 @josephjclark , I updated the image & also did some test cases, please take a look, thank you all for your patient with a javascript newbie like me 😄

@josephjclark
Copy link
Collaborator

@nhatnm0612 thank you for the image! And your Javascript is doing great, it's been a pleasure to work with you on this

Copy link
Collaborator

@josephjclark josephjclark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for this! It's looking great. We'll merge and release it ASAP (we have a lot going on this week but I'm sure we can get this out today for you)

@josephjclark josephjclark changed the base branch from main to openspp November 9, 2023 09:15
@josephjclark josephjclark merged commit 846499d into OpenFn:openspp Nov 9, 2023
@nhatnm0612
Copy link
Contributor Author

Thank you for this! It's looking great. We'll merge and release it ASAP (we have a lot going on this week but I'm sure we can get this out today for you)

thanks, a lot, for all the efforts you paid to me

@josephjclark
Copy link
Collaborator

Hi @nhatnm0612 - this adaptor is now released and available to the world! https://www.npmjs.com/package/@openfn/language-openspp

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants