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.

Sign up for GitHub

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

Jump to bottom

optional-components/stac-public-access: add public write permission for POST /stac/search request #405

Merged
merged 3 commits into from
Nov 30, 2023
Merged

optional-components/stac-public-access: add public write permission for POST /stac/search request #405

merged 3 commits into from
Nov 30, 2023

Conversation

fmigneault
Copy link
Collaborator

Overview

Provide public access to STAC search as intended.

Changes

Non-breaking changes

  • optional-components/stac-public-access: add public write permission for POST /stac/search request.

    Since pystac_client, a common interface to interact with STAC API, employs POST method by default to perform search, the missing permission caused an unexpected error for users that are not aware of the specific permission control of Magpie. Since nothing is created by that endpoint, but rather, the POST'ed body employs the convenient JSON format to provide search criteria, it is safe to set this permission when the STAC service was configured to be publicly searchable.

Breaking changes

  • n/a

Related Issue / Discussion

  • Highlighted by @TimeaBagosiCrim when interacting with STAC using pystac_client.

@fmigneault fmigneault self-assigned this Nov 15, 2023
@github-actions github-actions bot added component/magpie Related to https://github.com/Ouranosinc/Magpie documentation Improvements or additions to documentation labels Nov 15, 2023
@fmigneault fmigneault added component/STAC Features or components related to STAC component/magpie Related to https://github.com/Ouranosinc/Magpie and removed documentation Improvements or additions to documentation component/magpie Related to https://github.com/Ouranosinc/Magpie labels Nov 15, 2023
@github-actions github-actions bot added ci/operations Continuous Integration components documentation Improvements or additions to documentation labels Nov 15, 2023
@crim-jenkins-bot
Copy link
Collaborator

E2E Test Results

DACCS-iac Pipeline Results

Build URL : http://daccs-jenkins.crim.ca:80/job/DACCS-iac-birdhouse/2249/
Result : failure

BIRDHOUSE_DEPLOY_BRANCH : stac-search-permission
DACCS_CONFIGS_BRANCH : master
PAVICS_E2E_WORKFLOW_TESTS_BRANCH : master
PAVICS_SDI_BRANCH : master

DESTROY_INFRA_ON_EXIT : true
PAVICS_HOST : https://host-140-154.rdext.crim.ca

PAVICS-e2e-workflow-tests Pipeline Results

Tests URL : http://daccs-jenkins.crim.ca:80/job/PAVICS-e2e-workflow-tests/job/master/1419/

NOTEBOOK TEST RESULTS 
    
[2023-11-15T21:47:41.688Z] ============================= test session starts ==============================
[2023-11-15T21:47:41.688Z] platform linux -- Python 3.9.16, pytest-7.3.1, pluggy-1.0.0
[2023-11-15T21:47:41.688Z] rootdir: /home/jenkins/agent/workspace/PAVICS-e2e-workflow-tests_master
[2023-11-15T21:47:41.688Z] plugins: anyio-3.6.1, dash-2.10.0, nbval-0.9.6, tornasync-0.6.0.post2, xdist-3.3.1
[2023-11-15T21:47:41.688Z] collected 255 items
[2023-11-15T21:47:41.688Z] 
[2023-11-15T21:47:52.900Z] notebooks-auth/geoserver.ipynb ..................                        [  7%]
[2023-11-15T21:48:01.526Z] notebooks-auth/test_thredds.ipynb ...........                            [ 11%]
[2023-11-15T21:48:10.181Z] pavics-sdi-master/docs/source/notebooks/WCS_example.ipynb .......        [ 14%]
[2023-11-15T21:48:19.488Z] pavics-sdi-master/docs/source/notebooks/WFS_example.ipynb ......         [ 16%]
[2023-11-15T21:48:28.205Z] pavics-sdi-master/docs/source/notebooks/WMS_example.ipynb ........       [ 19%]
[2023-11-15T22:00:33.852Z] pavics-sdi-master/docs/source/notebooks/climex.ipynb ............        [ 24%]
[2023-11-15T22:00:33.852Z] pavics-sdi-master/docs/source/notebooks/eccc-geoapi-climate-stations.ipynb . [ 24%]
[2023-11-15T22:00:46.369Z] ...............                                                          [ 30%]
[2023-11-15T22:00:57.738Z] pavics-sdi-master/docs/source/notebooks/eccc-geoapi-xclim.ipynb .....    [ 32%]
[2023-11-15T22:01:07.485Z] pavics-sdi-master/docs/source/notebooks/esgf-dap.ipynb ......            [ 34%]
[2023-11-15T22:01:24.492Z] pavics-sdi-master/docs/source/notebooks/forecasts.ipynb ......           [ 37%]
[2023-11-15T22:01:25.877Z] pavics-sdi-master/docs/source/notebooks/jupyter_extensions.ipynb .       [ 37%]
[2023-11-15T22:01:34.446Z] pavics-sdi-master/docs/source/notebooks/opendap.ipynb .......            [ 40%]
[2023-11-15T22:01:38.950Z] pavics-sdi-master/docs/source/notebooks/pavics_thredds.ipynb .....       [ 42%]
[2023-11-15T22:05:54.227Z] pavics-sdi-master/docs/source/notebooks/regridding.ipynb ............... [ 48%]
[2023-11-15T22:07:08.268Z] .............                                                            [ 53%]
[2023-11-15T22:07:12.706Z] pavics-sdi-master/docs/source/notebooks/rendering.ipynb ....             [ 54%]
[2023-11-15T22:07:15.024Z] pavics-sdi-master/docs/source/notebooks/subset-user-input.ipynb ........ [ 58%]
[2023-11-15T22:07:31.634Z] .................                                                        [ 64%]
[2023-11-15T22:07:39.695Z] pavics-sdi-master/docs/source/notebooks/subsetting.ipynb ......          [ 67%]
[2023-11-15T22:07:41.094Z] pavics-sdi-master/docs/source/notebook-components/weaver_example.ipynb . [ 67%]
[2023-11-15T22:07:42.757Z] .FFFFFFFF                                                                [ 70%]
[2023-11-15T22:07:53.602Z] finch-master/docs/source/notebooks/dap_subset.ipynb ...........          [ 75%]
[2023-11-15T22:08:03.094Z] finch-master/docs/source/notebooks/finch-usage.ipynb ......              [ 77%]
[2023-11-15T22:08:05.018Z] PAVICS-landing-master/content/notebooks/climate_indicators/PAVICStutorial_ClimateDataAnalysis-1DataAccess.ipynb . [ 78%]
[2023-11-15T22:08:07.822Z] ......                                                                   [ 80%]
[2023-11-15T22:08:14.401Z] PAVICS-landing-master/content/notebooks/climate_indicators/PAVICStutorial_ClimateDataAnalysis-2Subsetting.ipynb . [ 80%]
[2023-11-15T22:08:30.737Z] .............                                                            [ 85%]
[2023-11-15T22:08:40.737Z] PAVICS-landing-master/content/notebooks/climate_indicators/PAVICStutorial_ClimateDataAnalysis-3Climate-Indicators.ipynb . [ 86%]
[2023-11-15T22:09:22.827Z] ....s.                                                                   [ 88%]
[2023-11-15T22:09:30.958Z] PAVICS-landing-master/content/notebooks/climate_indicators/PAVICStutorial_ClimateDataAnalysis-4Ensembles.ipynb . [ 89%]
[2023-11-15T22:09:46.488Z] ...                                                                      [ 90%]
[2023-11-15T22:10:01.385Z] PAVICS-landing-master/content/notebooks/climate_indicators/PAVICStutorial_ClimateDataAnalysis-5Visualization.ipynb . [ 90%]
[2023-11-15T22:10:25.851Z] ......                                                                   [ 92%]
[2023-11-15T22:10:28.977Z] notebooks/hummingbird.ipynb ............                                 [ 97%]
[2023-11-15T22:13:03.681Z] notebooks/stress-tests.ipynb ......                                      [100%]
[2023-11-15T22:13:03.681Z] 
[2023-11-15T22:13:03.682Z] =================================== FAILURES ===================================

@crim-jenkins-bot
Copy link
Collaborator

E2E Test Results

DACCS-iac Pipeline Results

Build URL : http://daccs-jenkins.crim.ca:80/job/DACCS-iac-birdhouse/2250/
Result : success

BIRDHOUSE_DEPLOY_BRANCH : stac-search-permission
DACCS_CONFIGS_BRANCH : master
PAVICS_E2E_WORKFLOW_TESTS_BRANCH : master
PAVICS_SDI_BRANCH : master

DESTROY_INFRA_ON_EXIT : true
PAVICS_HOST : https://host-140-133.rdext.crim.ca

PAVICS-e2e-workflow-tests Pipeline Results

Tests URL : http://daccs-jenkins.crim.ca:80/job/PAVICS-e2e-workflow-tests/job/master/1420/

NOTEBOOK TEST RESULTS 
    
[2023-11-15T21:50:56.799Z] ============================= test session starts ==============================
[2023-11-15T21:50:56.799Z] platform linux -- Python 3.9.16, pytest-7.3.1, pluggy-1.0.0
[2023-11-15T21:50:56.799Z] rootdir: /home/jenkins/agent/workspace/PAVICS-e2e-workflow-tests_master@2
[2023-11-15T21:50:56.799Z] plugins: anyio-3.6.1, dash-2.10.0, nbval-0.9.6, tornasync-0.6.0.post2, xdist-3.3.1
[2023-11-15T21:50:56.799Z] collected 255 items
[2023-11-15T21:50:56.799Z] 
[2023-11-15T21:51:08.640Z] notebooks-auth/geoserver.ipynb ..................                        [  7%]
[2023-11-15T21:51:16.203Z] notebooks-auth/test_thredds.ipynb ...........                            [ 11%]
[2023-11-15T21:51:30.064Z] pavics-sdi-master/docs/source/notebooks/WCS_example.ipynb .......        [ 14%]
[2023-11-15T21:51:45.485Z] pavics-sdi-master/docs/source/notebooks/WFS_example.ipynb ......         [ 16%]
[2023-11-15T21:51:57.250Z] pavics-sdi-master/docs/source/notebooks/WMS_example.ipynb ........       [ 19%]
[2023-11-15T22:02:20.766Z] pavics-sdi-master/docs/source/notebooks/climex.ipynb ............        [ 24%]
[2023-11-15T22:02:20.766Z] pavics-sdi-master/docs/source/notebooks/eccc-geoapi-climate-stations.ipynb . [ 24%]
[2023-11-15T22:02:24.666Z] ...............                                                          [ 30%]
[2023-11-15T22:02:34.569Z] pavics-sdi-master/docs/source/notebooks/eccc-geoapi-xclim.ipynb .....    [ 32%]
[2023-11-15T22:02:41.508Z] pavics-sdi-master/docs/source/notebooks/esgf-dap.ipynb ......            [ 34%]
[2023-11-15T22:02:57.542Z] pavics-sdi-master/docs/source/notebooks/forecasts.ipynb ......           [ 37%]
[2023-11-15T22:02:58.926Z] pavics-sdi-master/docs/source/notebooks/jupyter_extensions.ipynb .       [ 37%]
[2023-11-15T22:03:07.455Z] pavics-sdi-master/docs/source/notebooks/opendap.ipynb .......            [ 40%]
[2023-11-15T22:03:11.970Z] pavics-sdi-master/docs/source/notebooks/pavics_thredds.ipynb .....       [ 42%]
[2023-11-15T22:05:53.930Z] pavics-sdi-master/docs/source/notebooks/regridding.ipynb ............... [ 48%]
[2023-11-15T22:07:09.711Z] .............                                                            [ 53%]
[2023-11-15T22:07:12.440Z] pavics-sdi-master/docs/source/notebooks/rendering.ipynb ....             [ 54%]
[2023-11-15T22:07:15.232Z] pavics-sdi-master/docs/source/notebooks/subset-user-input.ipynb ........ [ 58%]
[2023-11-15T22:07:30.633Z] .................                                                        [ 64%]
[2023-11-15T22:07:39.003Z] pavics-sdi-master/docs/source/notebooks/subsetting.ipynb ......          [ 67%]
[2023-11-15T22:07:40.387Z] pavics-sdi-master/docs/source/notebook-components/weaver_example.ipynb . [ 67%]
[2023-11-15T22:07:51.756Z] .........                                                                [ 70%]
[2023-11-15T22:08:02.561Z] finch-master/docs/source/notebooks/dap_subset.ipynb ...........          [ 75%]
[2023-11-15T22:08:12.661Z] finch-master/docs/source/notebooks/finch-usage.ipynb ......              [ 77%]
[2023-11-15T22:08:14.046Z] PAVICS-landing-master/content/notebooks/climate_indicators/PAVICStutorial_ClimateDataAnalysis-1DataAccess.ipynb . [ 78%]
[2023-11-15T22:08:17.376Z] ......                                                                   [ 80%]
[2023-11-15T22:08:23.955Z] PAVICS-landing-master/content/notebooks/climate_indicators/PAVICStutorial_ClimateDataAnalysis-2Subsetting.ipynb . [ 80%]
[2023-11-15T22:08:39.334Z] .............                                                            [ 85%]
[2023-11-15T22:08:49.388Z] PAVICS-landing-master/content/notebooks/climate_indicators/PAVICStutorial_ClimateDataAnalysis-3Climate-Indicators.ipynb . [ 86%]
[2023-11-15T22:09:29.628Z] ....s.                                                                   [ 88%]
[2023-11-15T22:09:37.751Z] PAVICS-landing-master/content/notebooks/climate_indicators/PAVICStutorial_ClimateDataAnalysis-4Ensembles.ipynb . [ 89%]
[2023-11-15T22:09:54.196Z] ...                                                                      [ 90%]
[2023-11-15T22:10:09.115Z] PAVICS-landing-master/content/notebooks/climate_indicators/PAVICStutorial_ClimateDataAnalysis-5Visualization.ipynb . [ 90%]
[2023-11-15T22:10:31.971Z] ......                                                                   [ 92%]
[2023-11-15T22:10:34.711Z] notebooks/hummingbird.ipynb ............                                 [ 97%]
[2023-11-15T22:13:14.316Z] notebooks/stress-tests.ipynb ......                                      [100%]
[2023-11-15T22:13:14.316Z] 
[2023-11-15T22:13:14.316Z] ================= 254 passed, 1 skipped in 1334.38s (0:22:14) ==================

@tlvu tlvu changed the title add write permission to STAC API search endpoint on public config optional-components/stac-public-access: add public write permission for POST /stac/search request Nov 16, 2023
tlvu
tlvu approved these changes Nov 16, 2023
View reviewed changes
Copy link
Collaborator

@tlvu tlvu left a comment

Choose a reason for hiding this comment

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

LGTM.

I changed the PR title to match the new section title entry in CHANGES.md. I think we should keep this in-sync to ease tracing of the changes.

@fmigneault
Copy link
Collaborator Author

@mishaschwartz Will leave you the change to review just in case, but I will probably merge it tomorrow.

@tlvu If you got the chance to check #403 as well, I would try to combine them into a single release since they are all related to STAC.

@crim-jenkins-bot
Copy link
Collaborator

E2E Test Results

DACCS-iac Pipeline Results

Build URL : http://daccs-jenkins.crim.ca:80/job/DACCS-iac-birdhouse/2287/
Result : success

BIRDHOUSE_DEPLOY_BRANCH : stac-search-permission
DACCS_CONFIGS_BRANCH : master
PAVICS_E2E_WORKFLOW_TESTS_BRANCH : master
PAVICS_SDI_BRANCH : master

DESTROY_INFRA_ON_EXIT : true
PAVICS_HOST : https://host-140-154.rdext.crim.ca

PAVICS-e2e-workflow-tests Pipeline Results

Tests URL : http://daccs-jenkins.crim.ca:80/job/PAVICS-e2e-workflow-tests/job/master/1426/

NOTEBOOK TEST RESULTS 
    
[2023-11-21T17:59:38.082Z] ============================= test session starts ==============================
[2023-11-21T17:59:38.082Z] platform linux -- Python 3.9.16, pytest-7.3.1, pluggy-1.0.0
[2023-11-21T17:59:38.082Z] rootdir: /home/jenkins/agent/workspace/PAVICS-e2e-workflow-tests_master
[2023-11-21T17:59:38.082Z] plugins: anyio-3.6.1, dash-2.10.0, nbval-0.9.6, tornasync-0.6.0.post2, xdist-3.3.1
[2023-11-21T17:59:38.082Z] collected 255 items
[2023-11-21T17:59:38.082Z] 
[2023-11-21T17:59:48.218Z] notebooks-auth/geoserver.ipynb ..................                        [  7%]
[2023-11-21T17:59:56.645Z] notebooks-auth/test_thredds.ipynb ...........                            [ 11%]
[2023-11-21T18:00:07.683Z] pavics-sdi-master/docs/source/notebooks/WCS_example.ipynb .......        [ 14%]
[2023-11-21T18:00:18.408Z] pavics-sdi-master/docs/source/notebooks/WFS_example.ipynb ......         [ 16%]
[2023-11-21T18:00:25.515Z] pavics-sdi-master/docs/source/notebooks/WMS_example.ipynb ........       [ 19%]
[2023-11-21T18:07:59.580Z] pavics-sdi-master/docs/source/notebooks/climex.ipynb ............        [ 24%]
[2023-11-21T18:07:59.580Z] pavics-sdi-master/docs/source/notebooks/eccc-geoapi-climate-stations.ipynb . [ 24%]
[2023-11-21T18:08:00.102Z] ...............                                                          [ 30%]
[2023-11-21T18:08:09.746Z] pavics-sdi-master/docs/source/notebooks/eccc-geoapi-xclim.ipynb .....    [ 32%]
[2023-11-21T18:08:17.649Z] pavics-sdi-master/docs/source/notebooks/esgf-dap.ipynb ......            [ 34%]
[2023-11-21T18:08:34.671Z] pavics-sdi-master/docs/source/notebooks/forecasts.ipynb ......           [ 37%]
[2023-11-21T18:08:36.318Z] pavics-sdi-master/docs/source/notebooks/jupyter_extensions.ipynb .       [ 37%]
[2023-11-21T18:08:41.328Z] pavics-sdi-master/docs/source/notebooks/opendap.ipynb .......            [ 40%]
[2023-11-21T18:08:46.086Z] pavics-sdi-master/docs/source/notebooks/pavics_thredds.ipynb .....       [ 42%]
[2023-11-21T18:12:33.845Z] pavics-sdi-master/docs/source/notebooks/regridding.ipynb ............... [ 48%]
[2023-11-21T18:13:49.866Z] .............                                                            [ 53%]
[2023-11-21T18:13:51.511Z] pavics-sdi-master/docs/source/notebooks/rendering.ipynb ....             [ 54%]
[2023-11-21T18:13:53.726Z] pavics-sdi-master/docs/source/notebooks/subset-user-input.ipynb ........ [ 58%]
[2023-11-21T18:14:09.355Z] .................                                                        [ 64%]
[2023-11-21T18:14:17.692Z] pavics-sdi-master/docs/source/notebooks/subsetting.ipynb ......          [ 67%]
[2023-11-21T18:14:19.076Z] pavics-sdi-master/docs/source/notebook-components/weaver_example.ipynb . [ 67%]
[2023-11-21T18:14:42.470Z] .........                                                                [ 70%]
[2023-11-21T18:14:51.782Z] finch-master/docs/source/notebooks/dap_subset.ipynb ...........          [ 75%]
[2023-11-21T18:15:01.117Z] finch-master/docs/source/notebooks/finch-usage.ipynb ......              [ 77%]
[2023-11-21T18:15:02.495Z] PAVICS-landing-master/content/notebooks/climate_indicators/PAVICStutorial_ClimateDataAnalysis-1DataAccess.ipynb . [ 78%]
[2023-11-21T18:15:06.176Z] ......                                                                   [ 80%]
[2023-11-21T18:15:14.395Z] PAVICS-landing-master/content/notebooks/climate_indicators/PAVICStutorial_ClimateDataAnalysis-2Subsetting.ipynb . [ 80%]
[2023-11-21T18:15:31.189Z] .............                                                            [ 85%]
[2023-11-21T18:15:41.176Z] PAVICS-landing-master/content/notebooks/climate_indicators/PAVICStutorial_ClimateDataAnalysis-3Climate-Indicators.ipynb . [ 86%]
[2023-11-21T18:16:14.814Z] ....s.                                                                   [ 88%]
[2023-11-21T18:16:22.957Z] PAVICS-landing-master/content/notebooks/climate_indicators/PAVICStutorial_ClimateDataAnalysis-4Ensembles.ipynb . [ 89%]
[2023-11-21T18:16:36.236Z] ...                                                                      [ 90%]
[2023-11-21T18:16:51.230Z] PAVICS-landing-master/content/notebooks/climate_indicators/PAVICStutorial_ClimateDataAnalysis-5Visualization.ipynb . [ 90%]
[2023-11-21T18:17:13.756Z] ......                                                                   [ 92%]
[2023-11-21T18:17:15.111Z] notebooks/hummingbird.ipynb ............                                 [ 97%]
[2023-11-21T18:19:54.705Z] notebooks/stress-tests.ipynb ......                                      [100%]
[2023-11-21T18:19:54.705Z] 
[2023-11-21T18:19:54.705Z] ================= 254 passed, 1 skipped in 1214.79s (0:20:14) ==================

@fmigneault fmigneault mentioned this pull request Nov 24, 2023
Merged
@fmigneault fmigneault merged commit 7120b98 into master Nov 30, 2023
3 checks passed
@fmigneault fmigneault deleted the stac-search-permission branch November 30, 2023 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tlvu tlvu tlvu approved these changes

@dchandan dchandan dchandan approved these changes

@mishaschwartz mishaschwartz mishaschwartz approved these changes

Assignees

@fmigneault fmigneault

Labels
ci/operations Continuous Integration components component/magpie Related to https://github.com/Ouranosinc/Magpie component/STAC Features or components related to STAC documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@fmigneault @crim-jenkins-bot @mishaschwartz @dchandan @tlvu