[tap-frontapp] - fix libraries and dependabot issues #27
Conversation
setup.py
Outdated
| @@ -25,4 +25,4 @@ | |||
| "schemas": ["tap_frontapp/schemas/*.json"] | |||
| }, | |||
| include_package_data=True | |||
| ) | |||
| ) | |||
tap_frontapp/__init__.py
Outdated
| # Stream-level metadata select the stream | ||
| metadata.append({ | ||
| "metadata": { | ||
| "selected": True # Make sure to select every stream |
There was a problem hiding this comment.
@gl-romil selected is a non-discoverable metadata which can't written or read by the tap. Please refer getting-started documentation. Also I find some required discoverable metadata is missing from the catalog, refer docs for more details.
There was a problem hiding this comment.
Replaced 'selected' with discoverable metadata fields.
Added missing 'inclusion', inclusion-reason' , and 'selected-by-default'.
tap_frontapp/__init__.py
Outdated
| # Creating a dict to change before converting | ||
| catalog_dict = catalog.to_dict() | ||
|
|
||
| required_streams = [ |
There was a problem hiding this comment.
You can use streams.METRIC_API_DESCRIPTION_KEY instead of introducing new variable which already defines these stream names to required.
There was a problem hiding this comment.
Replaced static stream list with streams.METRIC_API_DESCRIPTION_KEY.keys()
romilqlik
force-pushed
the
feature/SAC-27536-frontapp-libraries
branch
from
976e331 to
9f6165a
Compare
tap_frontapp/__init__.py
Outdated
| # Stream-level metadata select the stream | ||
| metadata.append({ | ||
| "metadata": { | ||
| "selected": True # Make sure to select every stream |
There was a problem hiding this comment.
Replaced 'selected' with discoverable metadata fields.
Added missing 'inclusion', inclusion-reason' , and 'selected-by-default'.
tap_frontapp/__init__.py
Outdated
| # Creating a dict to change before converting | ||
| catalog_dict = catalog.to_dict() | ||
|
|
||
| required_streams = [ |
There was a problem hiding this comment.
Replaced static stream list with streams.METRIC_API_DESCRIPTION_KEY.keys()
romilqlik
force-pushed
the
feature/SAC-27536-frontapp-libraries
branch
from
2b2a85e to
9f6165a
Compare
* [SAC-27536] Refactored discovery and sync- logic * [SAC-27535] Final clean up: discovery fixes,init and sync * Update discover.py Removed type annotations from the file as per review * Update schemas.py Removed type annotations from file as per review * Update sync.py Removed type annotations as per review * Update sync.py * Update __init__.py Removed type annotations as per comment * Update __init__.py * Update __init__.py Removed unnecessary header as per review * Update __init__.py * Update __init__.py Removed header comment * Update sync.py Removed file level docstring * Update test_client.py Add EOF --------- Co-authored-by: gl-romil <[email protected]>
tap_frontapp/discover.py
Outdated
| def discover(): | ||
| """Run the discovery mode, prepare the catalog file and return the catalog.""" | ||
| schemas, field_metadata = get_schemas() | ||
| print("Schemas loaded:", schemas.keys()) |
There was a problem hiding this comment.
Please replace print() but LOGGER.info()
There was a problem hiding this comment.
Also we need to do credential validation as we discussed for tap-braintree.
Added LOGGER.info
Credentials Validation
tap_frontapp/__init__.py
Outdated
| def validate_credentials(token): | ||
| """Validates the FrontApp token using a simple API call""" | ||
| headers = {"Authorization": f"Bearer {token}"} | ||
| try: | ||
| response = requests.get("https://api2.frontapp.com/me", headers=headers, timeout=10) | ||
| if response.status_code == 200: | ||
| LOGGER.info("Frontapp credentials validated successfully.") | ||
| else: | ||
| LOGGER.critical("Invalid Frontapp credentials. Status code: %s", response.status_code) | ||
| sys.exit(1) | ||
| except requests.exceptions.RequestException as err: | ||
| LOGGER.critical("Credential validation failed: %s", str(err)) | ||
| sys.exit(1) |
Moved validate_credentials
tests/unittests/test_client.py
Outdated
|
|
||
| if __name__ == "__main__": | ||
| unittest.main() |
There was a problem hiding this comment.
Please remove this but not holding PR for this.
Description of change
Updated FrontApp tap with Schema fixes and unit tests.
Fixed and streamlined 'init.py by ensuring all streams and their fields have proper metadata with 'selected: true' at both stream and field levels (breadcrum[]).
Added .circleci/config.yml to trigger CircleCI pipeline
Manual QA steps
Ran Discovery
Ran full sync
Validated against FrontApp API docs.
Unit test executed
Risks
None
Rollback steps
AI generated code
https://internal.qlik.dev/general/ways-of-working/code-reviews/#guidelines-for-ai-generated-code