adobe / helix-redirect Goto Github PK

View Code? Open in Web Editor NEW

1.0 33.0 2.0 33.11 MB

Serve 3xx and internal redirects for Project Helix

License: Apache License 2.0

JavaScript 100.00%

helix redirect url-rewrite helix2 service

helix-redirect's Introduction

Helix Redirect

Serve 3xx and internal redirects for Project Helix

Status

Installation

Usage

helix-redirect is a service that will be called from helix-dispatch. It reads a repository's helix-redirects.yaml, retrieves all linked redirect spreadsheets, evaluates the current URL against the configured redirect rules and returns either a 3xx redirect or a 204 (no content) response to indicate that no redirect rules apply to the current URL.

curl https://adobeioruntime.net/api/v1/web/helix/helix-services/redirect@v1

For more, see the API documentation.

Development

Deploying Helix Redirect

Deploying Helix Redirect requires the wsk command line client, authenticated to a namespace of your choice. For Project Helix, we use the helix namespace.

All commits to main that pass the testing will be deployed automatically. All commits to branches that will pass the testing will get commited as /helix-services/redirect@ci<num> and tagged with the CI build number.

helix-redirect's People

Contributors

Stargazers

Watchers

Forkers

isabella232 ghas-results

helix-redirect's Issues

ignore leading and trailing spaces in URLs in spreadsheets

it seems to be common that users have leading and trailing whitespaces in URLs in spreadsheet.
i believe it would be better to .trim() those.

Empty destination in spreadsheet yields infinite redirect

currently it seems that an empty destination column seems to redirect to itself, instead the better behavior would probably be to consider the entry invalid and ignore it.

Dependency Dashboard

This issue provides visibility into Renovate updates and their statuses. Learn more

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

Check this box to trigger a request for Renovate to run again on this repository

migrate to helix-deploy

see adobe/project-helix#508

migrate code to use helix-deploy adapter
update CI to use helix-deploy

support for passing along search/query params

there are a few usecases where query params are appended to a URL that are not actually evaluated on the server for example campaign ids in martech stacks. in that case it would be great to just pass on the query params and append those to the destination.

Other config additions will still be effective, just slower as they are processed as part of the dispatch loop.

fetch json via fastly

in order to use the content-proxy cache in fastly, the redirect json should be read via fastly.