You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@skywalking.apache.org by GitBox <gi...@apache.org> on 2023/01/17 22:39:31 UTC
[GitHub] [skywalking-python] Superskyyy opened a new pull request, #269: Fix FastAPI websocket support and add websocket plugin
Superskyyy opened a new pull request, #269:
URL: https://github.com/apache/skywalking-python/pull/269
- FastAPI fix for websocket support and lifespan (https://github.com/apache/skywalking/issues/10018, https://github.com/apache/skywalking/issues/9724)
- Websocket plugin (only trace connection handshake on client side, with comments on how to customize plugin)
closes: https://github.com/apache/skywalking/issues/6733
- Add a missing unit test for urlparser and log filter
<!--
â ī¸ Please make sure to read this template first, pull requests that don't accord with this template
maybe closed without notice.
Texts surrounded by `<` and `>` are meant to be replaced by you, e.g. <framework name>, <issue number>.
Put an `x` in the `[ ]` to mark the item as CHECKED. `[x]`
-->
<!-- ==== đ Remove this line WHEN AND ONLY WHEN you're fixing a bug, follow the checklist đ ====
### Fix <bug description or bug issue link>
- [ ] Add a unit test to verify that the fix works.
- [ ] Explain briefly why the bug exists and how to fix it.
==== đ Remove this line WHEN AND ONLY WHEN you're fixing a bug, follow the checklist đ ==== -->
<!-- ==== đ Remove this line WHEN AND ONLY WHEN you're improving the performance, follow the checklist đ ====
### Improve the performance of <class or module or ...>
- [ ] Add a benchmark for the improvement, refer to [the existing ones](https://github.com/apache/skywalking/blob/master/apm-commons/apm-datacarrier/src/test/java/org/apache/skywalking/apm/commons/datacarrier/LinkedArrayBenchmark.java)
- [ ] The benchmark result.
```text
<Paste the benchmark results here>
```
- [ ] Links/URLs to the theory proof or discussion articles/blogs. <links/URLs here>
==== đ Remove this line WHEN AND ONLY WHEN you're improving the performance, follow the checklist đ ==== -->
<!-- ==== đ Remove this line WHEN AND ONLY WHEN you're adding a new feature, follow the checklist đ ====
### <Feature description>
- [ ] If this is non-trivial feature, paste the links/URLs to the design doc.
- [ ] Update the documentation to include this new feature.
- [ ] Tests(including UT, IT, E2E) are added to verify the new feature.
- [ ] If it's UI related, attach the screenshots below.
==== đ Remove this line WHEN AND ONLY WHEN you're adding a new feature, follow the checklist đ ==== -->
### <Feature description>
- [s] If adding a new plugin, add a component id in [the main repo](https://github.com/apache/skywalking/blob/master/oap-server/server-starter/src/main/resources/component-libraries.yml)
- [s] If adding a new plugin, add a logo in [the UI repo](https://github.com/apache/skywalking-booster-ui/tree/main/src/assets/img/technologies)
- [ ] I have added the library to `pyproject.toml` (plugin group) by running `poetry add library --group plugins`
- [x] I have rebuilt the `Plugins.md` documentation by running `make doc-gen`
- [ ] If this pull request closes/resolves/fixes an existing issue, replace the issue url. Closes: <URL to main repo issue>
- [x] Update the [`CHANGELOG.md`](https://github.com/apache/skywalking-python/blob/master/CHANGELOG.md).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-python] kezhenxu94 commented on pull request #269: Fix FastAPI websocket support and add websocket plugin
Posted by GitBox <gi...@apache.org>.
kezhenxu94 commented on PR #269:
URL: https://github.com/apache/skywalking-python/pull/269#issuecomment-1386532867
@Superskyyy FYI there are conflicts
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-python] kezhenxu94 merged pull request #269: Fix FastAPI websocket support and add websocket plugin
Posted by GitBox <gi...@apache.org>.
kezhenxu94 merged PR #269:
URL: https://github.com/apache/skywalking-python/pull/269
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-python] Superskyyy commented on pull request #269: Fix FastAPI websocket support and add websocket plugin
Posted by GitBox <gi...@apache.org>.
Superskyyy commented on PR #269:
URL: https://github.com/apache/skywalking-python/pull/269#issuecomment-1386524949
Test passed, previously something was wrong with GHA.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [skywalking-python] sonatype-lift[bot] commented on a diff in pull request #269: Fix FastAPI websocket support and add websocket plugin
Posted by GitBox <gi...@apache.org>.
sonatype-lift[bot] commented on code in PR #269:
URL: https://github.com/apache/skywalking-python/pull/269#discussion_r1072900403
##########
tests/plugin/http/sw_websockets/services/consumer.py:
##########
@@ -0,0 +1,38 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+import websockets
+
+import asyncio
+
+if __name__ == '__main__':
+ from fastapi import FastAPI
+ import uvicorn
+
+ app = FastAPI()
+
+ @app.get('/ws')
+ async def websocket_ping():
+ async with websockets.connect('ws://provider:9091/ws', extra_headers=None) as websocket:
+ await websocket.send('Ping')
+
+ response = await websocket.recv()
+ await asyncio.sleep(0.5)
+
+ await websocket.close()
+ return response
+
+ uvicorn.run(app, host='0.0.0.0', port=9090)
Review Comment:
*hardcoded_bind_all_interfaces:* Possible binding to all interfaces.
---
<details><summary><b>âšī¸ Learn about @sonatype-lift commands</b></summary>
You can reply with the following commands. For example, reply with ***@sonatype-lift ignoreall*** to leave out all findings.
| **Command** | **Usage** |
| ------------- | ------------- |
| `@sonatype-lift ignore` | Leave out the above finding from this PR |
| `@sonatype-lift ignoreall` | Leave out all the existing findings from this PR |
| `@sonatype-lift exclude <file\|issue\|path\|tool>` | Exclude specified `file\|issue\|path\|tool` from Lift findings by updating your config.toml file |
**Note:** When talking to LiftBot, you need to **refresh** the page to see its response.
<sub>[Click here](https://github.com/apps/sonatype-lift/installations/new) to add LiftBot to another repo.</sub></details>
---
Was this a good recommendation?
[ [đ Not relevant](https://www.sonatype.com/lift-comment-rating?comment=369095630&lift_comment_rating=1) ] - [ [đ Won't fix](https://www.sonatype.com/lift-comment-rating?comment=369095630&lift_comment_rating=2) ] - [ [đ Not critical, will fix](https://www.sonatype.com/lift-comment-rating?comment=369095630&lift_comment_rating=3) ] - [ [đ Critical, will fix](https://www.sonatype.com/lift-comment-rating?comment=369095630&lift_comment_rating=4) ] - [ [đ Critical, fixing now](https://www.sonatype.com/lift-comment-rating?comment=369095630&lift_comment_rating=5) ]
##########
tests/plugin/http/sw_websockets/services/provider.py:
##########
@@ -0,0 +1,43 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the 'License'); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an 'AS IS' BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+from starlette.websockets import WebSocketDisconnect
+
+if __name__ == '__main__':
+ from fastapi import FastAPI, WebSocket
+ import uvicorn
+
+ app = FastAPI()
+
+
+ @app.websocket('/ws')
+ async def websocket_endpoint(websocket: WebSocket):
+ await websocket.accept()
+ try:
+ while True:
+ msg = await websocket.receive_text()
+ if msg.lower() == 'close':
+ await websocket.close()
+ break
+ else:
+ await websocket.send_text('Pong')
+ except WebSocketDisconnect:
+ ...
+ return 'ok'
+
+
+ uvicorn.run(app, host='0.0.0.0', port=9091)
Review Comment:
*hardcoded_bind_all_interfaces:* Possible binding to all interfaces.
---
<details><summary><b>âšī¸ Learn about @sonatype-lift commands</b></summary>
You can reply with the following commands. For example, reply with ***@sonatype-lift ignoreall*** to leave out all findings.
| **Command** | **Usage** |
| ------------- | ------------- |
| `@sonatype-lift ignore` | Leave out the above finding from this PR |
| `@sonatype-lift ignoreall` | Leave out all the existing findings from this PR |
| `@sonatype-lift exclude <file\|issue\|path\|tool>` | Exclude specified `file\|issue\|path\|tool` from Lift findings by updating your config.toml file |
**Note:** When talking to LiftBot, you need to **refresh** the page to see its response.
<sub>[Click here](https://github.com/apps/sonatype-lift/installations/new) to add LiftBot to another repo.</sub></details>
---
Was this a good recommendation?
[ [đ Not relevant](https://www.sonatype.com/lift-comment-rating?comment=369095633&lift_comment_rating=1) ] - [ [đ Won't fix](https://www.sonatype.com/lift-comment-rating?comment=369095633&lift_comment_rating=2) ] - [ [đ Not critical, will fix](https://www.sonatype.com/lift-comment-rating?comment=369095633&lift_comment_rating=3) ] - [ [đ Critical, will fix](https://www.sonatype.com/lift-comment-rating?comment=369095633&lift_comment_rating=4) ] - [ [đ Critical, fixing now](https://www.sonatype.com/lift-comment-rating?comment=369095633&lift_comment_rating=5) ]
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@skywalking.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org