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

Source MongoDB fetch authorized collections only #9238

Merged

Conversation

VitaliiMaltsev
Copy link
Contributor

@VitaliiMaltsev VitaliiMaltsev commented Dec 31, 2021

What

Airbyte UI should return only those collections for which the user has privileges.

How

Used authorizedCollections:true flag in listCollections Mongo command

Recommended reading order

  1. x.java
  2. y.python

🚨 User Impact 🚨

There should not visible user impact. UI now will show only authorized collections

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/SUMMARY.md
    • docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
    • docs/integrations/README.md
    • airbyte-integrations/builds.md
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command described here
  • After the connector is published, connector added to connector index as described here
  • Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here

Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • PR name follows PR naming conventions

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command described here
  • After the new connector version is published, connector version bumped in the seed directory as described here
  • Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here

Connector Generator

  • Issue acceptance criteria met
  • PR name follows PR naming conventions
  • If adding a new generator, add it to the list of scaffold modules being tested
  • The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:testScaffoldTemplates then checking in your changes
  • Documentation which references the generator is updated as needed.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


vmaltsev seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions github-actions bot added the area/connectors Connector related issues label Dec 31, 2021
@VitaliiMaltsev
Copy link
Contributor Author

VitaliiMaltsev commented Jan 10, 2022

/test connector=connectors/source-mongodb-v2

🕑 connectors/source-mongodb-v2 https://github.com/airbytehq/airbyte/actions/runs/1677239378
✅ connectors/source-mongodb-v2 https://github.com/airbytehq/airbyte/actions/runs/1677239378
No Python unittests run

@octavia-squidington-iii octavia-squidington-iii temporarily deployed to more-secrets January 10, 2022 12:02 Inactive
@VitaliiMaltsev VitaliiMaltsev temporarily deployed to more-secrets January 10, 2022 14:11 Inactive
@VitaliiMaltsev VitaliiMaltsev temporarily deployed to more-secrets January 10, 2022 14:21 Inactive
@VitaliiMaltsev VitaliiMaltsev temporarily deployed to more-secrets January 11, 2022 11:30 Inactive
@VitaliiMaltsev VitaliiMaltsev temporarily deployed to more-secrets January 11, 2022 11:32 Inactive
Comment on lines 144 to 153
Document document = database.getDatabase().runCommand(new Document("listCollections", 1)
.append("authorizedCollections", true).append("nameOnly", true));

return document.toBsonDocument()
.get("cursor").asDocument()
.getArray("firstBatch")
.stream()
.filter(bsonValue -> bsonValue.asDocument().getString("type").getValue().equals("collection"))
.map(bsonValue -> bsonValue.asDocument().getString("name").getValue())
.collect(Collectors.toSet());
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great)

Copy link
Contributor

@tuliren tuliren left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you format the code before merging? I think the indentation of the getAuthorizedCollections method is off.

.get("cursor").asDocument()
.getArray("firstBatch")
.stream()
.filter(bsonValue -> bsonValue.asDocument().getString("type").getValue().equals("collection"))
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpick .The listCollections command can take in a filter parameter to filter on any field in the returned document directly.

Reference: https://docs.mongodb.com/manual/reference/command/listCollections/#definition

I think if you add the filter parameter, you won't need to do the filter here:

Document document = database.getDatabase().runCommand(new Document("listCollections", 1)
  .append("authorizedCollections", true)
  .append("nameOnly", true))
  .append("filter", "{ 'type': 'collection' }")

I am not 100% sure this is the correct syntax though.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpick .The listCollections command can take in a filter parameter to filter on any field in the returned document directly.

Reference: https://docs.mongodb.com/manual/reference/command/listCollections/#definition

I think if you add the filter parameter, you won't need to do the filter here:

Document document = database.getDatabase().runCommand(new Document("listCollections", 1)
  .append("authorizedCollections", true)
  .append("nameOnly", true))
  .append("filter", "{ 'type': 'collection' }")

I am not 100% sure this is the correct syntax though.

added filter into mongo shell command

@VitaliiMaltsev VitaliiMaltsev temporarily deployed to more-secrets January 12, 2022 16:11 Inactive
@VitaliiMaltsev
Copy link
Contributor Author

Can you format the code before merging? I think the indentation of the getAuthorizedCollections method is off.

formatted

@VitaliiMaltsev VitaliiMaltsev temporarily deployed to more-secrets January 12, 2022 17:01 Inactive
@octavia-squidington-iii octavia-squidington-iii temporarily deployed to more-secrets January 12, 2022 17:03 Inactive
vmaltsev added 2 commits January 12, 2022 19:20
…ed-collections

# Conflicts:
#	airbyte-integrations/connectors/destination-snowflake/src/main/java/io/airbyte/integrations/destination/snowflake/SnowflakeInternalStagingConsumerFactory.java
@VitaliiMaltsev VitaliiMaltsev temporarily deployed to more-secrets January 12, 2022 17:26 Inactive
@octavia-squidington-iii octavia-squidington-iii temporarily deployed to more-secrets January 13, 2022 08:11 Inactive
@VitaliiMaltsev
Copy link
Contributor Author

/publish connector=connectors/source-mongodb-v2

@octavia-squidington-iii octavia-squidington-iii temporarily deployed to more-secrets January 13, 2022 13:10 Inactive
@VitaliiMaltsev
Copy link
Contributor Author

VitaliiMaltsev commented Jan 13, 2022

/publish connector=connectors/source-mongodb-v2

🕑 connectors/source-mongodb-v2 https://github.com/airbytehq/airbyte/actions/runs/1692915725
✅ connectors/source-mongodb-v2 https://github.com/airbytehq/airbyte/actions/runs/1692915725

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Source Mongo DB: Failed to fetch schema if user doesn't have permissions for all collections in db
5 participants