DOCS-2475: Add additional headers #3141

npentrel · 2024-07-18T22:03:12Z

No description provided.

npentrel · 2024-07-18T22:04:56Z

docs/build/configure/triggers.md

-| `Robot-ID` | The machine that triggered the request. |
-| `Location-ID` | The location of the machine that triggered the request. |
-| `Org-ID` | The organization that triggered the request. |
+| `Org-Id` | The ID of the organization that triggered the request. |


@maxhorowitz : I've not been able to confirm these all work:

Here is an example of a trigger from ingested binary data. I don't get the associated component type, name, method name, and min-time received, max time received.

127.0.0.1 - - [18/Jul/2024 17:49:42] "POST /?data_type=binary&event_type=part_data_ingested HTTP/1.1" 200 - ImmutableMultiDict([('data_type', 'binary'), ('event_type', 'part_data_ingested')]) Host: d99b-71-167-222-76.ngrok-free.app User-Agent: Go-http-client/2.0 Content-Length: 375 Accept-Encoding: gzip Content-Type: application/json Location-Id: vw3iu72d8n Org-Id: bccf8f8f-e3c4-4f72-ab9a-fc547757f352 Part-Id: 422afb68-21d0-487c-a135-01d81ff54407 Robot-Id: 584b3120-0da5-4014-b843-8a685e9cab2d X-Forwarded-For: 2600:1900:2000:a3::1:900 X-Forwarded-Host: d99b-71-167-222-76.ngrok-free.app X-Forwarded-Proto: https

And then here's an example of part_online, why is it sending Org-ID and Part-ID rather than the actual values?

127.0.0.1 - - [18/Jul/2024 17:46:08] "GET /?event_type=part_online HTTP/1.1" 200 - ImmutableMultiDict([('event_type', 'part_online')]) Host: d99b-71-167-222-76.ngrok-free.app User-Agent: Go-http-client/2.0 Accept: application/json Accept-Encoding: gzip Content-Type: application/json Location-Id: vw3iu72d8n Location-Name: First Location Machine-Name: guardian Org-Id: Org-ID Organization-Name: Robot Land Part-Id: Part-ID Part-Name: guardian-main Robot-Id: 584b3120-0da5-4014-b843-8a685e9cab2d X-Forwarded-For: 2600:1900:2000:a6::1:901 X-Forwarded-Host: d99b-71-167-222-76.ngrok-free.app X-Forwarded-Proto: https

1st message -

component type, name, method name, min-time received, and max time received were moved to the data ingested POST request body - I am sorry if I grazed over this in a previous review - it was a change that was made during the introduction of POST request for part data ingested webhooks

2nd message -

https://viam.atlassian.net/browse/APP-5608

npentrel · 2024-07-18T22:20:31Z

docs/build/configure/triggers.md

+| `Org-Id` | The ID of the organization that triggered the request. | `part_data_ingested` |
+| `Organization-Name` | The name of the organization that triggered the request. | `part_online`, `part_offline` |


@maxhorowitz also why is this so awkward? Shouldn't they all return org-id, org name, location id, location name, etc?

TLDR is this is a bug - ticket is here - is this something you'd like prio'd ?

No all good. Was just wondering if it had been an oversight. No urgency from my end

maxhorowitz · 2024-07-22T20:39:48Z

docs/build/configure/triggers.md

+
+
+@app.route("/", methods=['GET', 'POST'])
+def hello_http_get():


add post too?

Oh it'll do both but I can rename the function to not mention get 😅

maxhorowitz · 2024-07-22T20:41:33Z

docs/build/configure/triggers.md

+        "Org-Id": headers.get('org-id', 'no value'),
+        "Organization-Name": headers.get('organization-name', 'no value'),
+        "Location-Id": headers.get('location-id', 'no value'),
+        "Location-Name": headers.get('location-name', 'no value'),
+        "Part-Id": headers.get('part-id', 'no value'),
+        "Part-Name": headers.get('part-name', 'no value'),
+        "Robot-Id": headers.get('robot-id', 'no value'),
+        "Machine-Name": headers.get('machine-name', 'no value'),
+        "Component-Type": headers.get('component-type', 'no value'),
+        "Component-Name": headers.get('component-name', 'no value'),
+        "Method-Name": headers.get('method-name', 'no value'),
+        "Min-Time-Received": headers.get('min-time-received', 'no value'),
+        "Max-Time-Received": headers.get('max-time-received', 'no value'),
+        "Data-Type": request.args.get('data_type', 'no value')


ComponentName, ComponentType, MethodName, MachineName, LocationName, OrgName, FileID, FilePath are each parsed from within the request's body, not headers

maxhorowitz · 2024-07-25T18:36:18Z

FYI closing https://viam.atlassian.net/browse/APP-5608 today 👍

npentrel · 2024-07-26T15:23:44Z

docs/build/configure/triggers.md

-| `Method-Name` | The name of the method from which data was ingested. Only for `part_data_ingested` triggers. |
-| `Min-Time-Received` | Indicates the earliest time a piece of data was received. |
-| `Max-Time-Received` | Indicates the latest time a piece of data was received. |
+| Header Key | Description | Trigger types |


@maxhorowitz are these the correct trigger types for each header key?

docs/build/configure/triggers.md

viambot · 2024-07-26T21:16:25Z

You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/3141

maxhorowitz

Cross checked with the code and everything seems correct to me - as long as you've manually tested that lambda against a trigger we're good to merge! Thank you

npentrel · 2024-07-29T15:04:03Z

yep all tested

DOCS-2475: Add additional headers

66f59f2

viambot added the safe to build This pull request is marked safe to build from a trusted zone label Jul 18, 2024

npentrel commented Jul 18, 2024

View reviewed changes

Add which headers are sent with which event type

7d39bb0

npentrel commented Jul 18, 2024

View reviewed changes

npentrel added 2 commits July 19, 2024 11:57

linter

23e7284

Update scripts

1ff8164

maxhorowitz reviewed Jul 22, 2024

View reviewed changes

npentrel requested a review from maxhorowitz July 26, 2024 15:09

npentrel force-pushed the DOCS-2475 branch 3 times, most recently from f00e808 to 627dffd Compare July 26, 2024 15:23

npentrel commented Jul 26, 2024

View reviewed changes

Update

f695be1

npentrel force-pushed the DOCS-2475 branch from 627dffd to f695be1 Compare July 26, 2024 15:24

npentrel commented Jul 26, 2024

View reviewed changes

docs/build/configure/triggers.md Outdated Show resolved Hide resolved

npentrel added 2 commits July 26, 2024 21:11

Update docs/build/configure/triggers.md

1c6d5b7

Formatting

9254ceb

maxhorowitz approved these changes Jul 29, 2024

View reviewed changes

npentrel merged commit df07fac into viamrobotics:main Jul 29, 2024
8 checks passed

npentrel deleted the DOCS-2475 branch July 29, 2024 15:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOCS-2475: Add additional headers #3141

DOCS-2475: Add additional headers #3141

npentrel commented Jul 18, 2024

npentrel Jul 18, 2024

npentrel Jul 18, 2024 •

edited

Loading

maxhorowitz Jul 22, 2024

npentrel Jul 18, 2024

maxhorowitz Jul 22, 2024

npentrel Jul 22, 2024

maxhorowitz Jul 22, 2024

npentrel Jul 22, 2024

maxhorowitz Jul 22, 2024

maxhorowitz commented Jul 25, 2024

npentrel Jul 26, 2024

viambot commented Jul 26, 2024

maxhorowitz left a comment

npentrel commented Jul 29, 2024

		\| `Org-Id` \| The ID of the organization that triggered the request. \| `part_data_ingested` \|
		\| `Organization-Name` \| The name of the organization that triggered the request. \| `part_online`, `part_offline` \|



		@app.route("/", methods=['GET', 'POST'])
		def hello_http_get():

DOCS-2475: Add additional headers #3141

DOCS-2475: Add additional headers #3141

Conversation

npentrel commented Jul 18, 2024

Choose a reason for hiding this comment

npentrel Jul 18, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

1st message -

2nd message -

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

maxhorowitz commented Jul 25, 2024

Choose a reason for hiding this comment

viambot commented Jul 26, 2024

maxhorowitz left a comment

Choose a reason for hiding this comment

npentrel commented Jul 29, 2024

npentrel Jul 18, 2024 •

edited

Loading