Skip to content

fix(utils): handle missing or invalid externalRef.yaml #157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
nios-x wants to merge 1 commit into from
Closed

fix(utils): handle missing or invalid externalRef.yaml #157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 2 additions & 9 deletions src/components/licenseDetailForm.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ import {
fetchSimilarLicenses,
} from '../api/api';
import 'react-toastify/dist/ReactToastify.css';
import { loadYaml } from '../utils/loadYaml';
import { loadExternalRefFields } from '../utils/loadYaml';
import { resolveComponentPath } from '../utils/componentPathMap';

function LicenseDetailForm({
Expand All @@ -49,14 +49,7 @@ function LicenseDetailForm({
const [similarLicenses, setSimilarLicenses] = useState([]);

useEffect(() => {
const fetchConfig = async () => {
const config = await loadYaml(
`${import.meta.env.VITE_DOMAIN_SUBDIRECTORY ? `/${import.meta.env.VITE_DOMAIN_SUBDIRECTORY}` : ''}/externalRef.yaml`,
);
setFields(config.license.fields);
};

fetchConfig();
loadExternalRefFields('license').then(setFields);
}, []);

const {
Expand Down
11 changes: 2 additions & 9 deletions src/pages/createLicense.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import {
fetchSimilarLicenses,
fetchObligationPreviews,
} from '../api/api';
import { loadYaml } from '../utils/loadYaml';
import { loadExternalRefFields } from '../utils/loadYaml';
import { resolveComponentPath } from '../utils/componentPathMap';
import SimilarityResultList from '../components/SimilarityResultList';

Expand Down Expand Up @@ -49,14 +49,7 @@ function CreateLicense() {
const navigate = useNavigate();

useEffect(() => {
const fetchConfig = async () => {
const config = await loadYaml(
`${import.meta.env.VITE_DOMAIN_SUBDIRECTORY ? `/${import.meta.env.VITE_DOMAIN_SUBDIRECTORY}` : ''}/externalRef.yaml`,
);
setFields(config.license.fields);
};

fetchConfig();
loadExternalRefFields('license').then(setFields);
}, []);

useEffect(() => {
Expand Down
11 changes: 2 additions & 9 deletions src/pages/createObligation.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import { useNavigate } from 'react-router-dom';
import CustomSelect from '../components/customStyleSelect';
import SimilarityResultList from '../components/SimilarityResultList';
import { resolveComponentPath } from '../utils/componentPathMap';
import { loadYaml } from '../utils/loadYaml';
import { loadExternalRefFields } from '../utils/loadYaml';

import {
postObligation,
Expand All @@ -36,14 +36,7 @@ function CreateObligation() {
label: `${l.shortname} (Id:${l.id})`,
}));
useEffect(() => {
const fetchConfig = async () => {
const config = await loadYaml(
`${import.meta.env.VITE_DOMAIN_SUBDIRECTORY ? `/${import.meta.env.VITE_DOMAIN_SUBDIRECTORY}` : ''}/externalRef.yaml`,
);
setFields(config.obligation.fields);
};

fetchConfig();
loadExternalRefFields('obligation').then(setFields);
}, []);

const navigate = useNavigate();
Expand Down
11 changes: 2 additions & 9 deletions src/pages/obligationDetailForm.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ import {
fetchObligationCategories
} from '../api/api';
import SimilarityResultList from '../components/SimilarityResultList';
import { loadYaml } from '../utils/loadYaml';
import { loadExternalRefFields } from '../utils/loadYaml';
import { resolveComponentPath } from '../utils/componentPathMap';

function ObligationDetailForm({
Expand Down Expand Up @@ -217,14 +217,7 @@ function ObligationDetailForm({

const [fields, setFields] = useState([]);
useEffect(() => {
const fetchConfig = async () => {
const config = await loadYaml(
`${import.meta.env.VITE_DOMAIN_SUBDIRECTORY ? `/${import.meta.env.VITE_DOMAIN_SUBDIRECTORY}` : ''}/externalRef.yaml`,
);
setFields(config.obligation.fields);
};

fetchConfig();
loadExternalRefFields('obligation').then(setFields);
}, []);

const handleChangeExt = e => {
Expand Down
40 changes: 37 additions & 3 deletions src/utils/loadYaml.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,44 @@
// SPDX-FileCopyrightText: © 2025 Siemens AG
// SPDX-FileContributor: Sourav Bhowmik <sourav.bhowmik@siemens.com>

import yaml from 'js-yaml';
import { load } from 'js-yaml';

export const loadYaml = async filePath => {
const response = await fetch(filePath);
const text = await response.text();
return yaml.load(text);
if (!response.ok) {
throw new Error(`HTTP ${response.status}`);
}
const config = load(await response.text());
// A missing file can be answered with index.html by the SPA fallback,
// which parses as a plain string rather than a mapping.
if (config === null || typeof config !== 'object') {
throw new Error('file is missing or is not a YAML mapping');
}
return config;
};

const externalRefPath = () => {
const subdirectory = import.meta.env.VITE_DOMAIN_SUBDIRECTORY;
return `${subdirectory ? `/${subdirectory}` : ''}/externalRef.yaml`;
};

// Returns the custom external_ref fields configured for `entity`
// ('license' or 'obligation'), or an empty list if the config can't be used.
export const loadExternalRefFields = async entity => {
try {
const config = await loadYaml(externalRefPath());
const fields = config[entity]?.fields;
if (!Array.isArray(fields)) {
throw new Error(`no "${entity}.fields" list found`);
}
return fields;
} catch (err) {
// externalRef.yaml is optional, so this is a developer hint, not a user-facing error.
// eslint-disable-next-line no-console
console.warn(
`Could not load external reference fields from externalRef.yaml (${err.message}). ` +
'Copy public/externalRef.example.yaml to public/externalRef.yaml to add custom fields.',
);
return [];
}
};