From 240514363f7128e9d7e47ed5140811e0c17ce8bb Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Tue, 10 Jan 2023 16:49:02 +0100 Subject: [PATCH] backend-app-api: lift in url utils from backend-common Signed-off-by: Patrik Oldsberg --- packages/backend-app-api/src/config/config.ts | 4 +-- packages/backend-app-api/src/lib/urls.test.ts | 34 +++++++++++++++++++ packages/backend-app-api/src/lib/urls.ts | 25 ++++++++++++++ 3 files changed, 61 insertions(+), 2 deletions(-) create mode 100644 packages/backend-app-api/src/lib/urls.test.ts create mode 100644 packages/backend-app-api/src/lib/urls.ts diff --git a/packages/backend-app-api/src/config/config.ts b/packages/backend-app-api/src/config/config.ts index 0a8854c17f..0f07be85d2 100644 --- a/packages/backend-app-api/src/config/config.ts +++ b/packages/backend-app-api/src/config/config.ts @@ -27,8 +27,8 @@ import { } from '@backstage/config-loader'; import { AppConfig, Config, ConfigReader } from '@backstage/config'; import { getPackages } from '@manypkg/get-packages'; - -import { isValidUrl } from './urls'; +import { ObservableConfigProxy } from './ObservableConfigProxy'; +import { isValidUrl } from '../lib/urls'; import { setRootLoggerRedactionList } from './logging/rootLogger'; diff --git a/packages/backend-app-api/src/lib/urls.test.ts b/packages/backend-app-api/src/lib/urls.test.ts new file mode 100644 index 0000000000..c2a67fb849 --- /dev/null +++ b/packages/backend-app-api/src/lib/urls.test.ts @@ -0,0 +1,34 @@ +/* + * Copyright 2021 The Backstage Authors + * + * Licensed 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 { isValidUrl } from './urls'; + +describe('isValidUrl', () => { + it('should return true for url', () => { + const validUrl = isValidUrl('http://some.valid.url'); + expect(validUrl).toBe(true); + }); + + it('should return false for absolute path', () => { + const validUrl = isValidUrl('/some/absolute/path'); + expect(validUrl).toBe(false); + }); + + it('should return false for relative path', () => { + const validUrl = isValidUrl('../some/relative/path'); + expect(validUrl).toBe(false); + }); +}); diff --git a/packages/backend-app-api/src/lib/urls.ts b/packages/backend-app-api/src/lib/urls.ts new file mode 100644 index 0000000000..848cea25d9 --- /dev/null +++ b/packages/backend-app-api/src/lib/urls.ts @@ -0,0 +1,25 @@ +/* + * Copyright 2021 The Backstage Authors + * + * Licensed 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. + */ + +export function isValidUrl(url: string): boolean { + try { + // eslint-disable-next-line no-new + new URL(url); + return true; + } catch { + return false; + } +}