feat: Add chat.getURLPreview endpoint

[matheusbsilva137]

Proposed changes (including videos or screenshots)

• Add chat.getURLPreview endpoint to enable users to retrieve URL previews prior to sending messages.

Issue(s)

Steps to test or reproduce

This endpoint requires url and roomId properties.
Example request (cURL):

curl --request GET 'http://localhost:3000/api/v1/chat.getURLPreview?roomId=650b53843e77b9b901c7cba6&url=https://www.youtube.com/watch?v=no050HN4ojo' \
--header 'X-Auth-Token: AlBrFCgo7ChqzKhTP0dViC-jS7N_HL4vyQT2E-fs9x0' \
--header 'X-User-Id: iGiuqqMDCNMXDhKcY'

Example response

{
"urlPreview": {
  "url": "https://www.youtube.com/watch?v=no050HN4ojo",
  "meta": {
    "oembedUrl": "https://www.youtube.com/watch?v=no050HN4ojo",
    "oembedTitle": "Rocket.Chat - El líder de comunicación de código abierto",
    "oembedAuthorName": "Rocket.Chat",
    "oembedAuthorUrl": "https://www.youtube.com/@RocketChatApp",
    "oembedType": "video",
    "oembedVersion": "1.0",
    "oembedProviderName": "YouTube",
    "oembedProviderUrl": "https://www.youtube.com/",
    "oembedThumbnailUrl": "https://i.ytimg.com/vi/no050HN4ojo/hqdefault.jpg",
    "oembedHtml": "<iframe style=\"max-width: 100%;width:400px;height:225px\" width=\"200\" height=\"113\" src=\"https://www.youtube.com/embed/no050HN4ojo?feature=oembed\" frameborder=\"0\" allow=\"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share\" allowfullscreen title=\"Rocket.Chat - El líder de comunicación de código abierto\"></iframe>"
  },
  "headers": {
    "contentType": "application/json"
  },
  "parsedUrl": {
    "host": "www.youtube.com",
    "hash": null,
    "pathname": "/oembed",
    "protocol": "https:",
    "port": null,
    "query": {
      "maxheight": "200",
      "url": "https://www.youtube.com/watch?v=no050HN4ojo"
    },
    "search": "?maxheight=200&url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3Dno050HN4ojo",
    "hostname": "www.youtube.com",
    "slashes": true,
    "auth": null,
    "path": "/oembed?maxheight=200&url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3Dno050HN4ojo",
    "href": "https://www.youtube.com/oembed?maxheight=200&url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3Dno050HN4ojo"
  },
  "ignoreParse": true
},
"success": true
}

Example request for sending a message with previously generated previews

• The parseUrls param must be sent so that previews are not re-generated (when this param is sent, we use the previews sent to the endpoint, no new ones are generated)

curl -H "X-Auth-Token: AlBrFCgo7ChqzKhTP0dViC-jS7N_HL4vyQT2E-fs9x0" \
   -H "X-User-Id: iGiuqqMDCNMXDhKcY" \
   -H "Content-type:application/json" \
   http://localhost:3000/api/v1/chat.sendMessage \
   -d '{"message": { "rid": "GENERAL", "msg": "This is a test! https://www.youtube.com/watch?v=no050HN4ojo", "urls": [{"url":"https://www.youtube.com/watch?v=no050HN4ojo","meta":{"oembedUrl":"https://www.youtube.com/watch?v=no050HN4ojo","oembedTitle":"Rocket.Chat - El líder de comunicación de código abierto","oembedAuthorName":"Rocket.Chat","oembedAuthorUrl":"https://www.youtube.com/@RocketChatApp","oembedType":"video","oembedVersion":"1.0","oembedProviderName":"YouTube","oembedProviderUrl":"https://www.youtube.com/","oembedThumbnailUrl":"https://i.ytimg.com/vi/no050HN4ojo/hqdefault.jpg","oembedHtml":"<iframe style=\"max-width: 100%;width:400px;height:225px\" width=\"200\" height=\"113\" src=\"https://www.youtube.com/embed/no050HN4ojo?feature=oembed\" frameborder=\"0\" allow=\"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share\" allowfullscreen title=\"Rocket.Chat - El líder de comunicación de código abierto\"></iframe>"},"headers":{"contentType":"application/json"},"parsedUrl":{"host":"www.youtube.com","hash":null,"pathname":"/oembed","protocol":"https:","port":null,"query":{"maxheight":"200","url":"https://www.youtube.com/watch?v=no050HN4ojo"},"search":"?maxheight=200&url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3Dno050HN4ojo","hostname":"www.youtube.com","slashes":true,"auth":null,"path":"/oembed?maxheight=200&url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3Dno050HN4ojo","href":"https://www.youtube.com/oembed?maxheight=200&url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3Dno050HN4ojo"},"ignoreParse":true}], "parseUrls": false }}'

Further comments

Note
Returned URL previews contain the ignoreParse property so that they are not retrieved again when attached to a message and sent.

Note
Removed attachments check on rocketUrlParser since the attachment property is not returned from getUrlMetaWithCache (see this line)

TC-938

[changeset-bot]

🦋 Changeset detected

Latest commit: a73e494

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 30 packages

Name	Type
@rocket.chat/meteor	Patch
@rocket.chat/core-typings	Patch
@rocket.chat/rest-typings	Patch
@rocket.chat/core-services	Patch
@rocket.chat/cron	Patch
@rocket.chat/gazzodown	Patch
@rocket.chat/livechat	Patch
@rocket.chat/model-typings	Patch
@rocket.chat/ui-contexts	Patch
@rocket.chat/account-service	Patch
@rocket.chat/authorization-service	Patch
@rocket.chat/ddp-streamer	Patch
@rocket.chat/omnichannel-transcript	Patch
@rocket.chat/presence-service	Patch
@rocket.chat/queue-worker	Patch
@rocket.chat/stream-hub-service	Patch
@rocket.chat/api-client	Patch
@rocket.chat/license	Patch
@rocket.chat/omnichannel-services	Patch
@rocket.chat/pdf-worker	Patch
@rocket.chat/presence	Patch
rocketchat-services	Patch
@rocket.chat/ddp-client	Patch
@rocket.chat/fuselage-ui-kit	Patch
@rocket.chat/models	Patch
@rocket.chat/ui-client	Patch
@rocket.chat/ui-video-conf	Patch
@rocket.chat/uikit-playground	Patch
@rocket.chat/web-ui-registration	Patch
@rocket.chat/instance-status	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[codecov]

Codecov Report

Attention: 8 lines in your changes are missing coverage. Please review.

Comparison is base (6ca6871) 49.53% compared to head (a73e494) 49.56%.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop   #30478      +/-   ##
===========================================
+ Coverage    49.53%   49.56%   +0.02%     
===========================================
  Files         3311     3311              
  Lines        81470    81473       +3     
  Branches     16706    16706              
===========================================
+ Hits         40360    40385      +25     
+ Misses       36408    36397      -11     
+ Partials      4702     4691      -11     

Flag	Coverage Δ
e2e	53.20% <ø> (+0.02%)	⬆️
e2e-api	40.67% <68.00%> (+0.03%)	⬆️
unit	76.51% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

[kodiakhq]

This PR currently has a merge conflict. Please resolve this and then re-add the ['stat: ready to merge', 'automerge'] label.

[kodiakhq]

This PR currently has a merge conflict. Please resolve this and then re-add the ['stat: ready to merge', 'automerge'] label.