Skip to content

Commit

Permalink
🚨🚨✨ Source Facebook Pages: Upgrade Facebook API to v19.0 (#36015)
Browse files Browse the repository at this point in the history
Co-authored-by: airt <[email protected]>
  • Loading branch information
tolik0 and airt authored Mar 18, 2024
1 parent 80332d8 commit e8c51cb
Show file tree
Hide file tree
Showing 19 changed files with 1,207 additions and 656 deletions.
38 changes: 0 additions & 38 deletions airbyte-integrations/connectors/source-facebook-pages/Dockerfile

This file was deleted.

64 changes: 57 additions & 7 deletions airbyte-integrations/connectors/source-facebook-pages/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,70 @@ and place them into `secrets/config.json`.
### Locally running the connector docker image


#### Build
**Via [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md) (recommended):**


#### Use `airbyte-ci` to build your connector
The Airbyte way of building this connector is to use our `airbyte-ci` tool.
You can follow install instructions [here](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md#L1).
Then running the following command will build your connector:

```bash
airbyte-ci connectors --name=source-facebook-pages build
airbyte-ci connectors --name source-facebook-pages build
```
Once the command is done, you will find your connector image in your local docker registry: `airbyte/source-facebook-pages:dev`.

##### Customizing our build process
When contributing on our connector you might need to customize the build process to add a system dependency or set an env var.
You can customize our build process by adding a `build_customization.py` module to your connector.
This module should contain a `pre_connector_install` and `post_connector_install` async function that will mutate the base image and the connector container respectively.
It will be imported at runtime by our build process and the functions will be called if they exist.

Here is an example of a `build_customization.py` module:
```python
from __future__ import annotations

from typing import TYPE_CHECKING

if TYPE_CHECKING:
# Feel free to check the dagger documentation for more information on the Container object and its methods.
# https://dagger-io.readthedocs.io/en/sdk-python-v0.6.4/
from dagger import Container


async def pre_connector_install(base_image_container: Container) -> Container:
return await base_image_container.with_env_variable("MY_PRE_BUILD_ENV_VAR", "my_pre_build_env_var_value")

async def post_connector_install(connector_container: Container) -> Container:
return await connector_container.with_env_variable("MY_POST_BUILD_ENV_VAR", "my_post_build_env_var_value")
```

An image will be built with the tag `airbyte/source-facebook-pages:dev`.
#### Build your own connector image
This connector is built using our dynamic built process in `airbyte-ci`.
The base image used to build it is defined within the metadata.yaml file under the `connectorBuildOptions`.
The build logic is defined using [Dagger](https://dagger.io/) [here](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/pipelines/builds/python_connectors.py).
It does not rely on a Dockerfile.

If you would like to patch our connector and build your own a simple approach would be to:

1. Create your own Dockerfile based on the latest version of the connector image.
```Dockerfile
FROM airbyte/source-facebook-pages:latest

COPY . ./airbyte/integration_code
RUN pip install ./airbyte/integration_code

**Via `docker build`:**
# The entrypoint and default env vars are already set in the base image
# ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
# ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]
```
Please use this as an example. This is not optimized.

2. Build your image:
```bash
docker build -t airbyte/source-facebook-pages:dev .
# Running the spec command against your patched connector
docker run airbyte/source-facebook-pages:dev spec
```

#### Run
Then run any of the connector commands as follows:
```
Expand Down Expand Up @@ -64,4 +115,3 @@ You've checked out the repo, implemented a million dollar feature, and you're re
5. Create a Pull Request: use [our PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention).
6. Pat yourself on the back for being an awesome contributor.
7. 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
Expand Up @@ -5,27 +5,38 @@ data:
allowedHosts:
hosts:
- graph.facebook.com
connectorBuildOptions:
baseImage: docker.io/airbyte/python-connector-base:1.2.0@sha256:c22a9d97464b69d6ef01898edf3f8612dc11614f05a84984451dde195f337db9
connectorSubtype: api
connectorType: source
definitionId: 010eb12f-837b-4685-892d-0a39f76a98f5
dockerImageTag: 0.3.0
dockerImageTag: 1.0.0
dockerRepository: airbyte/source-facebook-pages
documentationUrl: https://docs.airbyte.com/integrations/sources/facebook-pages
githubIssueLabel: source-facebook-pages
icon: facebook.svg
license: ELv2
name: Facebook Pages
remoteRegistries:
pypi:
enabled: true
packageName: airbyte-source-facebook-pages
registries:
cloud:
enabled: false # hide from cloud until https://github.com/airbytehq/airbyte/issues/25515 is finished
enabled: false
oss:
enabled: true
releaseStage: beta
remoteRegistries:
pypi:
enabled: true
packageName: airbyte-source-facebook-pages
supportLevel: community
releases:
breakingChanges:
1.0.0:
message: >-
This version updates the API version from v15 to v19. Deprecated fields have been removed and new fields have been added for the stream `Page`.
upgradeDeadline: 2024-04-18
scopedImpact:
- scopeType: stream
impactedScopes: ["page"]
tags:
- language:python
- cdk:low-code
Expand Down
Loading

0 comments on commit e8c51cb

Please sign in to comment.