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

Extended publish debugging #884

Merged
merged 7 commits into from
Feb 25, 2024
Merged

Extended publish debugging #884

merged 7 commits into from
Feb 25, 2024

Conversation

jdknight
Copy link
Member

rest: refactor request processing

Adjusting the internals for performing session requests inside the Rest helper class. This is to help prepare the implementation for future work which can help debugging using prepared requests, as well as preparing for adjustments for APIv2, which deviates from the "bind path" used in this implementation.

config: provide enum-type check

Introduce a configuration check where a value will attempt to map to a specific enumeration type. This is to support future configuration capabilities which will try to map string values to enums.

switch publish-debug config to be an enum-flag type

Updating the confluence_publish_debug option to now accept string values, used to make to specific debugging enumeration flags in the implementation. This is to prepare for additional debugging modes that can be enabled when publishing.

tests: adjust env bool test to use new option

The unit test used to debug processing a boolean type used the confluence_publish_debug option for checks. However, this configuration type is no longer a boolean, so updating the unit test to use a new type (confluence_publish_force).

support request/response header dumps when publishing

Updates the confluence_publish_debug option to now accept a new value headers, which can be used to dump requests and responses, with their header data, made to a configured Confluence instance.

support deprecated api warnings when publishing

Updates the confluence_publish_debug option to now accept a new value deprecated, which can be used by developers to help warn when using API calls that Atlassian has marked as deprecated.

doc: update new confluence_publish_debug str-options

With updates to confluence_publish_debug to accept string values for various debugging modes, updating the documentation to reflect the new values which can be set.

Adjusting the internals for performing session requests inside the Rest
helper class. This is to help prepare the implementation for future
work which can help debugging using prepared requests, as well as
preparing for adjustments for APIv2, which deviates from the "bind path"
used in this implementation.

Signed-off-by: James Knight <[email protected]>
Introduce a configuration check where a value will attempt to map to a
specific enumeration type. This is to support future configuration
capabilities which will try to map string values to enums.

Signed-off-by: James Knight <[email protected]>
Updating the `confluence_publish_debug` option to now accept string
values, used to make to specific debugging enumeration flags in the
implementation. This is to prepare for additional debugging modes that
can be enabled when publishing.

Signed-off-by: James Knight <[email protected]>
The unit test used to debug processing a boolean type used the
`confluence_publish_debug` option for checks. However, this
configuration type is no longer a boolean, so updating the unit test
to use a new type (`confluence_publish_force`).

Signed-off-by: James Knight <[email protected]>
Updates the `confluence_publish_debug` option to now accept a new value
`headers`, which can be used to dump requests and responses, with their
header data, made to a configured Confluence instance.

Signed-off-by: James Knight <[email protected]>
Updates the `confluence_publish_debug` option to now accept a new value
`deprecated`, which can be used by developers to help warn when using
API calls that Atlassian has marked as deprecated.

Signed-off-by: James Knight <[email protected]>
With updates to `confluence_publish_debug` to accept string values for
various debugging modes, updating the documentation to reflect the new
values which can be set.

Signed-off-by: James Knight <[email protected]>
@jdknight jdknight merged commit ee92614 into main Feb 25, 2024
30 checks passed
@jdknight jdknight deleted the extended-publish-debugging branch February 25, 2024 14:24
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.

1 participant