Before this PR:
We are in the process of merging approved PRs that will result in TimeLockAgent fully supporting Undertow. This PR should only be merged after all of those are in.
After this PR:
Provide a TimeLockAgent creation method that takes only one registrar (expected to be the Undertow one).
==COMMIT_MSG==
==COMMIT_MSG==
Priority:
P2
Concerns / possible downsides (what feedback would you like?):
Naming maybe, could make create more explicit but I figured the params tell the story and we would likely want to deprecate the other one after we switch off of Dropwizard in tests.
It is possible to bifurcate the code paths (instead of passing _unused -> {} for jersey) but that's a refactor for another day once we are on Undertow in a stable manner for a good period of time.
Is documentation needed?:
No
Compatibility
Does this PR create any API breaks (e.g. at the Java or HTTP layers) - if so, do we have compatibility?:
No
Does this PR change the persisted format of any data - if so, do we have forward and backward compatibility?:
No
The code in this PR may be part of a blue-green deploy. Can upgrades from previous versions safely coexist? (Consider restarts of blue or green nodes.):
Yes
Does this PR rely on statements being true about other products at a deployment - if so, do we have correct product dependencies on these products (or other ways of verifying that these statements are true)?:
No
Does this PR need a schema migration?
No
Testing and Correctness
What, if any, assumptions are made about the current state of the world? If they change over time, how will we find out?:
N/A
What was existing testing like? What have you done to improve it?:
N/A
If this PR contains complex concurrent or asynchronous code, is it correct? The onus is on the PR writer to demonstrate this.:
N/A
If this PR involves acquiring locks or other shared resources, how do we ensure that these are always released?:
N/A
Execution
How would I tell this PR works in production? (Metrics, logs, etc.):
We will test Undertow only with internal service version 4
Has the safety of all log arguments been decided correctly?:
N/A
Will this change significantly affect our spending on metrics or logs?:
N/A
How would I tell that this PR does not work in production? (monitors, etc.):
N/A
If this PR does not work as expected, how do I fix that state? Would rollback be straightforward?:
Recall and rollback
If the above plan is more complex than “recall and rollback”, please tag the support PoC here (if it is the end of the week, tag both the current and next PoC):
Scale
Would this PR be expected to pose a risk at scale? Think of the shopping product at our largest stack.:
No
Would this PR be expected to perform a large number of database calls, and/or expensive database calls (e.g., row range scans, concurrent CAS)?:
No
Would this PR ever, with time and scale, become the wrong thing to do - and if so, how would we know that we need to do something differently?:
No
Development Process
Where should we start reviewing?:
If this PR is in excess of 500 lines excluding versions lock-files, why does it not make sense to split it?:
Please tag any other people who should be aware of this PR:
@jeremyk-91
@sverma30
@raiju
svc-autorelease
commented
4 months ago
General
Before this PR: We are in the process of merging approved PRs that will result in TimeLockAgent fully supporting Undertow. This PR should only be merged after all of those are in. After this PR: Provide a TimeLockAgent creation method that takes only one registrar (expected to be the Undertow one). ==COMMIT_MSG== ==COMMIT_MSG==
Priority: P2 Concerns / possible downsides (what feedback would you like?): Naming maybe, could make create more explicit but I figured the params tell the story and we would likely want to deprecate the other one after we switch off of Dropwizard in tests.
It is possible to bifurcate the code paths (instead of passing _unused -> {} for jersey) but that's a refactor for another day once we are on Undertow in a stable manner for a good period of time. Is documentation needed?: No
Compatibility
Does this PR create any API breaks (e.g. at the Java or HTTP layers) - if so, do we have compatibility?: No Does this PR change the persisted format of any data - if so, do we have forward and backward compatibility?: No The code in this PR may be part of a blue-green deploy. Can upgrades from previous versions safely coexist? (Consider restarts of blue or green nodes.): Yes Does this PR rely on statements being true about other products at a deployment - if so, do we have correct product dependencies on these products (or other ways of verifying that these statements are true)?: No Does this PR need a schema migration? No
Testing and Correctness
What, if any, assumptions are made about the current state of the world? If they change over time, how will we find out?: N/A What was existing testing like? What have you done to improve it?: N/A If this PR contains complex concurrent or asynchronous code, is it correct? The onus is on the PR writer to demonstrate this.: N/A If this PR involves acquiring locks or other shared resources, how do we ensure that these are always released?: N/A
Execution
How would I tell this PR works in production? (Metrics, logs, etc.): We will test Undertow only with internal service version 4 Has the safety of all log arguments been decided correctly?: N/A Will this change significantly affect our spending on metrics or logs?: N/A How would I tell that this PR does not work in production? (monitors, etc.): N/A If this PR does not work as expected, how do I fix that state? Would rollback be straightforward?: Recall and rollback If the above plan is more complex than “recall and rollback”, please tag the support PoC here (if it is the end of the week, tag both the current and next PoC):
Scale
Would this PR be expected to pose a risk at scale? Think of the shopping product at our largest stack.: No Would this PR be expected to perform a large number of database calls, and/or expensive database calls (e.g., row range scans, concurrent CAS)?: No Would this PR ever, with time and scale, become the wrong thing to do - and if so, how would we know that we need to do something differently?: No
Development Process
Where should we start reviewing?:
If this PR is in excess of 500 lines excluding versions lock-files, why does it not make sense to split it?:
Please tag any other people who should be aware of this PR: @jeremyk-91 @sverma30 @raiju