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

[Extensions] Makes JobRunner/Parameter/Request/Response classes extend from ActionRequest/Response #352

Merged
merged 3 commits into from
Mar 28, 2023

Conversation

joshpalis
Copy link
Member

Description

This PR enables Job Scheduler to send requests to AD Extension to both parse a ScheduledJobParameter and invoke a ScheduledJobRunner.

The SDK handles identifying and generating the request class specified within the request bytes of the ExtensionActionRequest here. In order to pass the JobParameterRequest/JobRunnerRequest directly, this PR modifies both classes to extend from ActionRequest.

Additionally, this PR removes the ExtensionJobActionResponse class as the SDK already handles serializing the JobRunner/Parameter/Response into a byte array before sending an ExtensionActionResponse back to Job Scheduler here

Check List

  • New functionality includes testing.
    • All tests pass
  • New functionality has been documented.
    • New functionality has javadoc added
  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

…erRequest fully qualified class names, modifes JobParameter/Runner/Request/Response classes to extend from ActionRequest/Response

Signed-off-by: Joshua Palis <jpalis@amazon.com>
Signed-off-by: Joshua Palis <jpalis@amazon.com>
Signed-off-by: Joshua Palis <jpalis@amazon.com>
Copy link
Member

@vibrantvarun vibrantvarun left a comment

Choose a reason for hiding this comment

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

LGTM!

@joshpalis joshpalis merged commit 77b873e into opensearch-project:main Mar 28, 2023
@joshpalis joshpalis deleted the proxy branch March 28, 2023 23:43
vibrantvarun added a commit that referenced this pull request May 10, 2023
…#382)

* Communication mechanism for js (#289)

* Job Details from Extension for JS

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Communication Mechanism for JS

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Communication mechanism for JS

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Communication mechanism for JS

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Communication mechanism for JS

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Communication mechanism for JS

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Commnunication Mechanism for JS

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Commnunication Mechanism for JS

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Commnunication Mechanism for JS

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Commnunication Mechanism for JS

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Commnunication Mechanism for JS

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Commnunication Mechanism for JS

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Communication Mechanism for JS

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Communication Mechanism for JS

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Communication Mechanism for JS

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Communication Mechanism for JS

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Communication Mechanism for JS

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Communication Mechanism for JS

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Communication Mechanism for JS

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Communication Mechanism for JS

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Communication Mechanism for JS

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Communication Mechanism for JS

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Communication Mechanism for JS

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Communication Mechanism for JS

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Communication Mechanism for JS

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Communication Mechanism for JS

Signed-off-by: Varun Jain <varunudr@amazon.com>

Signed-off-by: Varun Jain <varunudr@amazon.com>

* [Extensions] Synchronize opensearch-plugin-job-details with JobDetailsService map (#299)

* Added JobDetailsService as an indexOperationListener to synchronize metadata index with internal job details m and indicesToListen set.

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Changes indexToJobDetails to a ConcurrentMap, adds getter method for indexToJobDetails

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Addressing PR comments, fixing log message

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Addressing PR comments

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Added test to updateIndexToJobDetails

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Addressing PR comments, changing extensionId to extensionUniqueId

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Addressing PR Comments : Updating Job Details index Name and mapping file to opensearch-job-scheduler-job-details

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Addressing PR comments, enabling extensions to submit more than 1 job details entry to support extensions registering multiple types of jobs, updated all integration, multinode tests now that the rest response value is the document Id

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Renaming TestHelper base URI name

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Addressing PR comments, made multinode test request strings constant

Signed-off-by: Joshua Palis <jpalis@amazon.com>

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* [Extensions] Create a proxy ScheduledJobRunner, ScheduledJobParser to invoke corresponding registered Job Detail actions (#306)

* Draft : Added JobParameterRequest to translate ScheduledJobParser parameters nto compatible inputs for the ExtensionActionRequest. Completed initial proxy scheduled job parser implementation. Added ExtensionJobParameter class to deserialize ExtensionActionResponsebyte array into an object of type ScheduledJobParameter

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Added JobRunnerRequest, modified JobExecutionContext to implement writeable, created initial proxy ScheduledJobRunner, fixed failing tests

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Added generic ExtensionJobActionRequest that extends ExtensionActionRequest, modified JobParameter/Runner request to implement writeable, refactored proxy object creation so that the requests are added to the ExtensionJobActionRequest, which in turn upcasts the request into an ExtensionActionRequest

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Added byte array constructors for the JobRunner/Parameter requests, added javadocs

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Fixing javadocs

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Fixing javadocs

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Added placeholder string for an eventual access token to be sent to extensions to validate prior to invoking an action

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Added ExtensionJobActionResponse, JobParameterResponse, JobRunnerResponse to facilitate the response of extension actions

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Fixing javadocs

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Added JobRunnerResponse handling

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Separating updateIndexToJobProviders into separate methods

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Fixing javadocs

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* SpotlessApply

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Addressing PR comments

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Added tests for serialization/deserialization of JobExecutionContext, JobDocVersion, ExtensionJobParameter, ExtensionJobActionRequest, ExtensionJobActionResponse, JobRunner/JobParameter/Request/Response

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Writing ExtensionActionRequest/Response to bytestream output to test deserialization

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Fixing imports

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Changing to extensionActionResponse constructor

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Adding tests for updateIndexToJobProviders

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Addressing PR comments, added getters for lock duration seconds and jitter values, added javadocs to ScheduleType enum and made this public

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Removing Strings dependency from lock model to fix BWC tests

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Fixes BWC fullRestartClusterTask, rollingUpgradeClusterTask, oldVersionCluster task. mixedClusterTask is still failing

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Modified createProxyScheduledJobRunner to return the document Id of the extension job parameter entry within the registered job index, modifed the ExtensionJobParameter to null check the jitter value and setting this to 0.0 if null

Signed-off-by: Joshua Palis <jpalis@amazon.com>

---------

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* [Extensions] Exposes a GetLock REST API to enable extensions to acquire a lock model for their job execution (#311)

* Added RestGetLockAction API, added AcquireLockRequest, enables extensions to retrieve a lock model object to run their Job

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Adding Lock ID field to RestGetLockAction response

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Added multi node integration tests for GetLockApi

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Making lock service in RestGetLockAction private

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Added Rest integration tests for RestGetLockAction

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Addressing PR comments

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Updating get lock rest path in tests

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Addressing PR comments

Signed-off-by: Joshua Palis <jpalis@amazon.com>

---------

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Communication Mechanism Work Item 6 Release lock api (#312)

* Release lock API

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Release Lock API

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Release Lock API

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Release Lock API

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Reformatting

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Reformatting

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Reformatting

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Addressing Dan's Comments

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Addressing Dan's Comments

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Addressing Sarat's Comments

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Addressing Sarat's Comments

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Fixing test cases

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Fixing test cases

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Fixing ReleaseLocktestcase

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Fixing ReleaseLocktestcase

Signed-off-by: Varun Jain <varunudr@amazon.com>

---------

Signed-off-by: Varun Jain <varunudr@amazon.com>

* Bumping BWC version to 2.7 and Fixing xcontent imports (#322)

* [Extensions] Add all fields of LockModel to RestGetLockAction response (#342)

* Modifies the RestGetLockAction response to include all fields of the lock model object, rather than the lock model object itself

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Removing unused fields

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* reverting field removal

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Adding lockID to back to response

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Adding checks to multinode get lock rest integration tests to ensure that all response fields are populated

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* fixing lock time parsing

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Adds a new Response class to house serde logic for RestGetLockAction response

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Moving parser.nextToken() within AcquireLockResponse.parse()

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Implementing toXContentObject for AcquireLockRequest

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Moving AcquireLockResponse to transpor package

Signed-off-by: Joshua Palis <jpalis@amazon.com>

---------

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Increasing JobDetailsService request timeoufrom 10 to 15, since the initial job detail registration request will initialize the job details metadata index, which takes some time (#346)

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Fixes serde logic for proxy scheduled jobrunner/parser requests/responses (#349)

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Fixes serde logic for JobParameterRequest/JobRunnerRequest. Removes extra trimming of request bytes for the streaminput constructor for the JobParameter/RunnerRequest, as this is already trimmed by the SDK prior to forwarding the actionrequest to the transport action (#351)

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* [Extensions] Makes JobRunner/Parameter/Request/Response classes extend from ActionRequest/Response (#352)

* Replaces ExtensionActionRequest class name with the JobParameter/RunnerRequest fully qualified class names, modifes JobParameter/Runner/Request/Response classes to extend from ActionRequest/Response

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Removes ExtensionJobActionResponse and fixes affected test classes

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Fixing javadocs

Signed-off-by: Joshua Palis <jpalis@amazon.com>

---------

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Consuming breaking changes from moving ExtensionActionRequest (#381)

Signed-off-by: Sarat Vemulapalli <vemulapallisarat@gmail.com>

* spotless

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Fixing apache imports for TestHelpers class

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Modofies ODFERestTestCase to work with 2.x

Signed-off-by: Joshua Palis <jpalis@amazon.com>

* Fixing wipeAllODFEIndices

Signed-off-by: Joshua Palis <jpalis@amazon.com>

---------

Signed-off-by: Varun Jain <varunudr@amazon.com>
Signed-off-by: Joshua Palis <jpalis@amazon.com>
Signed-off-by: Sarat Vemulapalli <vemulapallisarat@gmail.com>
Co-authored-by: Varun Jain <varunudr@amazon.com>
Co-authored-by: Sarat Vemulapalli <vemulapallisarat@gmail.com>
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.

3 participants