-
Notifications
You must be signed in to change notification settings - Fork 3.9k
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
🎉 New source: Google PageSpeed Insights [low-code CDK] #19813
Changes from 2 commits
d122b18
23e475c
69dfd85
82f8a35
42b523a
ef17464
ca6b4a9
9b157e3
4d56afe
1944b14
54f35d9
208ba77
9d1d571
5b904be
3d868dd
fa1d8f3
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
* | ||
!Dockerfile | ||
!main.py | ||
!source_google_pagespeed_insights | ||
!setup.py | ||
!secrets |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
FROM python:3.9.11-alpine3.15 as base | ||
|
||
# build and load all requirements | ||
FROM base as builder | ||
WORKDIR /airbyte/integration_code | ||
|
||
# upgrade pip to the latest version | ||
RUN apk --no-cache upgrade \ | ||
&& pip install --upgrade pip \ | ||
&& apk --no-cache add tzdata build-base | ||
|
||
|
||
COPY setup.py ./ | ||
# install necessary packages to a temporary folder | ||
RUN pip install --prefix=/install . | ||
|
||
# build a clean environment | ||
FROM base | ||
WORKDIR /airbyte/integration_code | ||
|
||
# copy all loaded and built libraries to a pure basic image | ||
COPY --from=builder /install /usr/local | ||
# add default timezone settings | ||
COPY --from=builder /usr/share/zoneinfo/Etc/UTC /etc/localtime | ||
RUN echo "Etc/UTC" > /etc/timezone | ||
|
||
# bash is installed for more convenient debugging. | ||
RUN apk --no-cache add bash | ||
|
||
# copy payload code only | ||
COPY main.py ./ | ||
COPY source_google_pagespeed_insights ./source_google_pagespeed_insights | ||
|
||
ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py" | ||
ENTRYPOINT ["python", "/airbyte/integration_code/main.py"] | ||
|
||
LABEL io.airbyte.version=0.1.0 | ||
LABEL io.airbyte.name=airbyte/source-google-pagespeed-insights |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
# Google Pagespeed Insights Source | ||
|
||
This is the repository for the Google Pagespeed Insights configuration based source connector. | ||
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/google-pagespeed-insights). | ||
|
||
## Local development | ||
|
||
#### Building via Gradle | ||
You can also build the connector in Gradle. This is typically used in CI and not needed for your development workflow. | ||
|
||
To build using Gradle, from the Airbyte repository root, run: | ||
``` | ||
./gradlew :airbyte-integrations:connectors:source-google-pagespeed-insights:build | ||
``` | ||
|
||
#### Create credentials | ||
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/google-pagespeed-insights) | ||
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_google_pagespeed_insights/spec.yaml` file. | ||
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information. | ||
See `integration_tests/sample_config.json` for a sample config file. | ||
|
||
**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source google-pagespeed-insights test creds` | ||
and place them into `secrets/config.json`. | ||
|
||
### Locally running the connector docker image | ||
|
||
#### Build | ||
First, make sure you build the latest Docker image: | ||
``` | ||
docker build . -t airbyte/source-google-pagespeed-insights:dev | ||
``` | ||
|
||
You can also build the connector image via Gradle: | ||
``` | ||
./gradlew :airbyte-integrations:connectors:source-google-pagespeed-insights:airbyteDocker | ||
``` | ||
When building via Gradle, the docker image name and tag, respectively, are the values of the `io.airbyte.name` and `io.airbyte.version` `LABEL`s in | ||
the Dockerfile. | ||
|
||
#### Run | ||
Then run any of the connector commands as follows: | ||
``` | ||
docker run --rm airbyte/source-google-pagespeed-insights:dev spec | ||
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-google-pagespeed-insights:dev check --config /secrets/config.json | ||
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-google-pagespeed-insights:dev discover --config /secrets/config.json | ||
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-google-pagespeed-insights:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json | ||
``` | ||
## Testing | ||
|
||
#### Acceptance Tests | ||
Customize `acceptance-test-config.yml` file to configure tests. See [Source Acceptance Tests](https://docs.airbyte.io/connector-development/testing-connectors/source-acceptance-tests-reference) for more information. | ||
If your connector requires to create or destroy resources for use during acceptance tests create fixtures for it and place them inside integration_tests/acceptance.py. | ||
|
||
To run your integration tests with docker | ||
|
||
### Using gradle to run tests | ||
All commands should be run from airbyte project root. | ||
To run unit tests: | ||
``` | ||
./gradlew :airbyte-integrations:connectors:source-google-pagespeed-insights:unitTest | ||
``` | ||
To run acceptance and custom integration tests: | ||
``` | ||
./gradlew :airbyte-integrations:connectors:source-google-pagespeed-insights:integrationTest | ||
``` | ||
|
||
## Dependency Management | ||
All of your dependencies should go in `setup.py`, NOT `requirements.txt`. The requirements file is only used to connect internal Airbyte dependencies in the monorepo for local development. | ||
We split dependencies between two groups, dependencies that are: | ||
* required for your connector to work need to go to `MAIN_REQUIREMENTS` list. | ||
* required for the testing need to go to `TEST_REQUIREMENTS` list | ||
|
||
### Publishing a new version of the connector | ||
You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what? | ||
1. Make sure your changes are passing unit and integration tests. | ||
1. Bump the connector version in `Dockerfile` -- just increment the value of the `LABEL io.airbyte.version` appropriately (we use [SemVer](https://semver.org/)). | ||
1. Create a Pull Request. | ||
1. Pat yourself on the back for being an awesome contributor. | ||
1. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# | ||
# Copyright (c) 2022 Airbyte, Inc., all rights reserved. | ||
# |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# See [Source Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/source-acceptance-tests-reference) | ||
# for more information about how to configure these tests | ||
connector_image: airbyte/source-google-pagespeed-insights:dev | ||
acceptance_tests: | ||
spec: | ||
tests: | ||
- spec_path: "source_google_pagespeed_insights/spec.yaml" | ||
connection: | ||
tests: | ||
- config_path: "secrets/config.json" | ||
status: "succeed" | ||
- config_path: "integration_tests/invalid_config.json" | ||
status: "failed" | ||
discovery: | ||
tests: | ||
- config_path: "secrets/config.json" | ||
basic_read: | ||
tests: | ||
- config_path: "secrets/config.json" | ||
configured_catalog_path: "integration_tests/configured_catalog.json" | ||
empty_streams: [] | ||
incremental: | ||
bypass_reason: "This connector does not implement incremental sync" | ||
full_refresh: | ||
tests: | ||
- config_path: "secrets/config.json" | ||
configured_catalog_path: "integration_tests/configured_catalog.json" |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
#!/usr/bin/env sh | ||
|
||
# Build latest connector image | ||
docker build . -t $(cat acceptance-test-config.yml | grep "connector_image" | head -n 1 | cut -d: -f2-) | ||
|
||
# Pull latest acctest image | ||
docker pull airbyte/source-acceptance-test:latest | ||
|
||
# Run | ||
docker run --rm -it \ | ||
-v /var/run/docker.sock:/var/run/docker.sock \ | ||
-v /tmp:/tmp \ | ||
-v $(pwd):/test_input \ | ||
airbyte/source-acceptance-test \ | ||
--acceptance-test-config /test_input | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
plugins { | ||
id 'airbyte-python' | ||
id 'airbyte-docker' | ||
id 'airbyte-source-acceptance-test' | ||
} | ||
|
||
airbytePython { | ||
moduleDirectory 'source_google_pagespeed_insights' | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# | ||
# Copyright (c) 2022 Airbyte, Inc., all rights reserved. | ||
# |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# | ||
# Copyright (c) 2022 Airbyte, Inc., all rights reserved. | ||
# | ||
|
||
|
||
import pytest | ||
|
||
pytest_plugins = ("source_acceptance_test.plugin",) | ||
|
||
|
||
@pytest.fixture(scope="session", autouse=True) | ||
def connector_setup(): | ||
"""This fixture is a placeholder for external resources that acceptance test might require.""" | ||
yield |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
{ | ||
"streams": [ | ||
{ | ||
"stream": { | ||
"name": "pagespeed", | ||
"json_schema": {}, | ||
"supported_sync_modes": ["full_refresh"] | ||
}, | ||
"sync_mode": "full_refresh", | ||
"destination_sync_mode": "overwrite" | ||
}, | ||
{ | ||
"stream": { | ||
"name": "origin_pagespeed", | ||
"json_schema": {}, | ||
"supported_sync_modes": ["full_refresh"] | ||
}, | ||
"sync_mode": "full_refresh", | ||
"destination_sync_mode": "overwrite" | ||
} | ||
] | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"api_key": "invalid_key", | ||
"url": "https://www.google.com" | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"api_key": "sample", | ||
"url": "https://www.google.com" | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# | ||
# Copyright (c) 2022 Airbyte, Inc., all rights reserved. | ||
# | ||
|
||
|
||
import sys | ||
|
||
from airbyte_cdk.entrypoint import launch | ||
from source_google_pagespeed_insights import SourceGooglePagespeedInsights | ||
|
||
if __name__ == "__main__": | ||
source = SourceGooglePagespeedInsights() | ||
launch(source, sys.argv[1:]) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
-e ../../bases/source-acceptance-test | ||
-e . |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
# | ||
# Copyright (c) 2022 Airbyte, Inc., all rights reserved. | ||
# | ||
|
||
|
||
from setuptools import find_packages, setup | ||
|
||
MAIN_REQUIREMENTS = [ | ||
"airbyte-cdk~=0.1", | ||
] | ||
|
||
TEST_REQUIREMENTS = [ | ||
"pytest~=6.1", | ||
"pytest-mock~=3.6.1", | ||
"source-acceptance-test", | ||
] | ||
|
||
setup( | ||
name="source_google_pagespeed_insights", | ||
description="Source implementation for Google Pagespeed Insights.", | ||
author="Airbyte", | ||
author_email="contact@airbyte.io", | ||
packages=find_packages(), | ||
install_requires=MAIN_REQUIREMENTS, | ||
package_data={"": ["*.json", "*.yaml", "schemas/*.json", "schemas/shared/*.json"]}, | ||
extras_require={ | ||
"tests": TEST_REQUIREMENTS, | ||
}, | ||
) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
# | ||
# Copyright (c) 2022 Airbyte, Inc., all rights reserved. | ||
# | ||
|
||
|
||
from .source import SourceGooglePagespeedInsights | ||
|
||
__all__ = ["SourceGooglePagespeedInsights"] |
Original file line number | Diff line number | Diff line change | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,63 @@ | ||||||||||||||||||
version: "0.1.0" | ||||||||||||||||||
definitions: | ||||||||||||||||||
selector: | ||||||||||||||||||
extractor: | ||||||||||||||||||
field_pointer: [] | ||||||||||||||||||
requester: | ||||||||||||||||||
url_base: "https://www.googleapis.com/pagespeedonline/v5/" | ||||||||||||||||||
http_method: "GET" | ||||||||||||||||||
request_options_provider: | ||||||||||||||||||
request_parameters: | ||||||||||||||||||
key: "{{ config['api_key'] }}" | ||||||||||||||||||
url: "{{ config['url'] }}" | ||||||||||||||||||
category: seo | ||||||||||||||||||
cateogry: accessibility | ||||||||||||||||||
cateogry: best-practices | ||||||||||||||||||
cateogry: performance | ||||||||||||||||||
cateogry: pwa | ||||||||||||||||||
strategy: desktop | ||||||||||||||||||
strategy: mobile | ||||||||||||||||||
retriever: | ||||||||||||||||||
record_selector: | ||||||||||||||||||
$ref: "*ref(definitions.selector)" | ||||||||||||||||||
paginator: | ||||||||||||||||||
type: NoPagination | ||||||||||||||||||
requester: | ||||||||||||||||||
$ref: "*ref(definitions.requester)" | ||||||||||||||||||
base_stream: | ||||||||||||||||||
retriever: | ||||||||||||||||||
$ref: "*ref(definitions.retriever)" | ||||||||||||||||||
pagespeed_stream: | ||||||||||||||||||
$ref: "*ref(definitions.base_stream)" | ||||||||||||||||||
$options: | ||||||||||||||||||
name: "pagespeed" | ||||||||||||||||||
path: "/runPagespeed" | ||||||||||||||||||
origin_pagespeed_stream: | ||||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Open for discussion comment: Should we keep those in a single, since all the information is returned in a single API call? This would avoid making 2 requests to get the same data. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The "problem" I had when using one stream was, that the check - command takes so long. So, the "normal" request without "origin" - prefix takes between 20 and 40 seconds. But the integration tests time out after 30 seconds. I also thought, that it might be inconvenient for the user to wait for so long? The "origin" request however returns after some seconds. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is odd! As far as I can see, both streams make the exact same request to the API I think, so they should take the same time? Either way, if the 30 secondes itself is the issue, it can be raised! You can update the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ok I'll increase the timeout than. If you prefix the url with origin, only a very reduced (aggregates) report is generated and then returned. Therefore it takes way less time. See this faq here: https://developers.google.com/speed/docs/insights/faq?hl=en I'll make this clearer in the docs There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Interesting! However the page (faq) you're mentioning seems deprecated, and the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I've seen that as well. I tried it with postman however and with origin: you only get the main values (fcp, lcs, etc), whereas without origin we get the whole report. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes, this could work! I would put a huge warning in the documentation that this syntax may be deprecated at any time by google so that users are aware of the risks involved! |
||||||||||||||||||
$ref: "*ref(definitions.base_stream)" | ||||||||||||||||||
$options: | ||||||||||||||||||
name: "origin_pagespeed" | ||||||||||||||||||
path: "/runPagespeed" | ||||||||||||||||||
retriever: | ||||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As far as I can see, it does not look like we override any parameter here, so we should remove this block |
||||||||||||||||||
$ref: "*ref(definitions.base_stream.retriever)" | ||||||||||||||||||
requester: | ||||||||||||||||||
url_base: "https://www.googleapis.com/pagespeedonline/v5/" | ||||||||||||||||||
http_method: "GET" | ||||||||||||||||||
request_options_provider: | ||||||||||||||||||
request_parameters: | ||||||||||||||||||
key: "{{ config['api_key'] }}" | ||||||||||||||||||
url: "origin:{{ config['url'] }}" | ||||||||||||||||||
category: seo | ||||||||||||||||||
cateogry: accessibility | ||||||||||||||||||
cateogry: best-practices | ||||||||||||||||||
cateogry: performance | ||||||||||||||||||
cateogry: pwa | ||||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||
strategy: desktop | ||||||||||||||||||
strategy: mobile | ||||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. After testing this a bit, it looks like the API only accepts one of these at the same time, not both. When both are added, the numbers seem to default to the I think we should make this into a config option. I think we should also include in the record which strategy we were using, as the API does not seem to return any indication of the one used. |
||||||||||||||||||
|
||||||||||||||||||
streams: | ||||||||||||||||||
- "*ref(definitions.pagespeed_stream)" | ||||||||||||||||||
- "*ref(definitions.origin_pagespeed_stream)" | ||||||||||||||||||
|
||||||||||||||||||
check: | ||||||||||||||||||
stream_names: | ||||||||||||||||||
- "origin_pagespeed" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think there is a typo here: