settings schema.json #1874
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| // Copyright 2025, Command Line Inc. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "fmt" | ||
| "log" | ||
| "os" | ||
|
|
||
| "github.com/invopop/jsonschema" | ||
| "github.com/wavetermdev/waveterm/pkg/util/utilfn" | ||
| "github.com/wavetermdev/waveterm/pkg/wconfig" | ||
| ) | ||
|
|
||
| const WaveSchemaSettingsFileName = "schema/settings.json" | ||
|
|
||
| func main() { | ||
| settingsSchema := jsonschema.Reflect(&wconfig.SettingsType{}) | ||
|
|
||
| jsonSettingsSchema, err := json.MarshalIndent(settingsSchema, "", " ") | ||
| if err != nil { | ||
| log.Fatalf("failed to parse local schema: %v", err) | ||
| } | ||
| /* | ||
| err = os.MkdirAll(WaveSchemaSettingsFileName, 0755) | ||
| if err != nil { | ||
| log.Fatalf("failed to create schema dir: %v", err) | ||
| } | ||
| */ | ||
| written, err := utilfn.WriteFileIfDifferent(WaveSchemaSettingsFileName, jsonSettingsSchema) | ||
| if !written { | ||
| fmt.Fprintf(os.Stderr, "no changes to %s\n", WaveSchemaSettingsFileName) | ||
| } | ||
| if err != nil { | ||
| log.Fatalf("failed to write local schema: %v", err) | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,38 @@ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // Copyright 2025, Command Line Inc. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| // SPDX-License-Identifier: Apache-2.0 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| import { getApi } from "@/app/store/global"; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| import { getWebServerEndpoint } from "@/util/endpoints"; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| type EndpointInfo = { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| uri: string; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| fileMatch: Array<string>; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| schema: object; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| }; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const allFilepaths: Map<string, Array<string>> = new Map(); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| allFilepaths.set(`${getWebServerEndpoint()}/schema/settings.json`, [`${getApi().getConfigDir()}/settings.json`]); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| async function getSchemaEndpointInfo(endpoint: string): Promise<EndpointInfo> { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| let schema: Object; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
There was a problem hiding this comment. Replace Object type with a more specific type. As flagged by static analysis, using - let schema: Object;
+ let schema: JSONSchema;📝 Committable suggestion
Suggested change
🧰 Tools🪛 Biome (1.9.4)[error] 17-17: Don't use 'Object' as a type. Prefer explicitly define the object shape. This type means "any non-nullable value", which is slightly better than 'unknown', but it's still a broad type. (lint/complexity/noBannedTypes) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| try { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const data = await fetch(endpoint); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const fullSchema: object = await data.json(); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const schemaRef: string = fullSchema?.["$ref"]; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| schema = fullSchema?.[schemaRef]; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } catch (e) { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| console.log("cannot find schema:", e); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| schema = {}; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+18
to
+26
There was a problem hiding this comment. 🛠️ Refactor suggestion Improve error handling and add timeout for fetch. The current error handling is too broad and simply logs to console. Consider:
try {
- const data = await fetch(endpoint);
+ const controller = new AbortController();
+ const timeoutId = setTimeout(() => controller.abort(), 5000);
+ const data = await fetch(endpoint, {
+ signal: controller.signal,
+ });
+ clearTimeout(timeoutId);
+
+ if (!data.ok) {
+ throw new Error(`Failed to fetch schema: ${data.statusText}`);
+ }
+
const fullSchema: object = await data.json();
const schemaRef: string = fullSchema?.["$ref"];
schema = fullSchema?.[schemaRef];
} catch (e) {
- console.log("cannot find schema:", e);
- schema = {};
+ if (e instanceof Error) {
+ console.error("Schema fetch error:", e.message);
+ }
+ throw new Error("Failed to load schema configuration");
}📝 Committable suggestion
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const fileMatch = allFilepaths.get(endpoint) ?? []; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| return { | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| uri: endpoint, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| fileMatch, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| schema, | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| }; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| const SchemaEndpoints = Array.from(allFilepaths.keys()); | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| export { getSchemaEndpointInfo, SchemaEndpoints }; | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Codebase verification
Focus on Adding Validation for Configuration Paths
The search confirms that the configuration directory (via
getApi().getConfigDir()) is used consistently across the codebase (in at least three locations) without any validation. Consider adding checks to ensure the returned paths are valid and handle cases where they might be undefined or malformed.connections.jsonis directly derived from the config without checks.ai.jsonis similarly derived without validation.🔗 Analysis chain
Add validation for configuration paths.
The current implementation assumes the configuration directory and endpoints are always valid. Consider adding validation to handle cases where these paths might be undefined or invalid.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
Length of output: 916