@opengeoweb/sigmet-airmet v9.16.0

Content

• Installation
• Use
  • API
  • Configuration
    • Configuration file location
    • Configuration schema location
    • Configuration typescript types
    • Add a new configuration key
    • Using a new configuration key
• Documentation

Table of contents generated with markdown-toc

sigmet-airmet

React component library with Sigmet and Airmet components for the opengeoweb project. This library was generated with Nx.

Installation

npm install @opengeoweb/sigmet-airmet

Use

You can use any component exported from sigmet-airmet by importing them, for example:

import { MetInfoWrapper } from '@opengeoweb/sigmet-airmet'

API

Documentation of the API can be found on Swagger (make sure you're connected to the KNMI network).

The front-end uses the axios library to fetch data from the api. Importing components from the sigmet-airmet lib should be wrapped by the ApiProvider component with a specified baseURL. Example:

import { ApiProvider } from '@opengeoweb/api';
import { MetInfoWrapper } from '@opengeoweb/sigmet-airmet';

const sigmetProductConfig = {
  location_indicator_mwo: 'EHDB',
  fir_areas: {
    EHAA: {
      fir_name: 'AMSTERDAM FIR',
      location_indicator_atsr: 'EHAA',
      location_indicator_atsu: 'EHAA',
      area_preset: 'NL_FIR',
      max_hours_of_validity: 4,
      hours_before_validity: 4,
      tc_max_hours_of_validity: 6,
      tc_hours_before_validity: 12,
      va_max_hours_of_validity: 6,
      va_hours_before_validity: 12,
      adjacent_firs: ['EKDK', 'EDWW', 'EDGG', 'EBBU', 'EGTT', 'EGPX'],
      units: [
        {
          unit_type: 'level_unit',
          allowed_units: ['FT', 'FL'],
        },
        {
          unit_type: 'movement_unit',
          allowed_units: ['KT'],
        },
      ],
    },
  },
  active_firs: ['EHAA'],
};

const myAuth = {
  username: 'string',
  token: 'string',
  refresh_token: 'string',
};

const Component = () => {
  const [auth, onSetAuth] = React.useState(myAuth);

  return (
      <ApiProvider
        baseURL="http://test.com"
        appURL="http://app.com"
        auth={auth}
        onSetAuth={onSetAuth}
        createApi={createApi}
        authTokenURL="url/tokenrefresh"
      >
        <MetInfoWrapper productType='sigmet' productConfig={sigmetProductConfig} />
      </ApiProvider>
  )}

Configuration

Every country has different rules for aviation so a configuration file is required to let the module work correctly. Airmet uses basic configuration which has been expanded for sigmet to contain more custom properties. The validation rules are stored in schema files following the conventions of https://json-schema.org/. The npm packages ajv and ajv-merge-patch (to extend validation by using the merge prop) have been used to validate the configuration files against the schemas. The configurations are passed by the productConfig prop of the MetInfoWrapper component. When the module is rendered, it will first validate the given configuration. When that's valid, it will continue with fetching some requests to the backend and start the module.

Currently the validation is strict meaning that every missing or wrongly typed prop results in an error. All errors should be readable and give hints to the developer.

Configuration file location

These are the default configuration files for both products. They are being used in the stories and snapshots.

• airmet: libs/sigmet-airmet/src/lib/utils/config/airmet.config.json
• sigmet: libs/sigmet-airmet/src/lib/utils/config/sigmet.config.json

Configuration schema location

Schema files define all required properties and types for the configuration files. Sigmet and airmet share some properties, these can be found in firArea.schema.json.

• firArea.schema: tools/build-static-schemas/firArea.schema.json Defines the shared properties and validations of sigmet and airmet.
• airmet.schema: tools/build-static-schemas/airmet.schema.json Defines the airmet config validations. Airmet uses the firArea scheme and adds unique properties via the $merge prop: "$merge": { "source": { "$ref": "firArea.schema.json" }
• sigmet.schema: tools/build-static-schemas/sigmet.schema.json Defines the sigmet config validations. Sigmet uses the firArea scheme and adds unique properties via the $merge prop: "$merge": { "source": { "$ref": "firArea.schema.json" }

These schema files are build using the schema building tool in tools/build-static-schemas/generateStaticSchemas.js, see tools/build-static-schemas/Readme.md

Configuration typescript types

The SigmetConfig and AirmetConfig types can be found in libs/sigmet-airmet/src/lib/types.ts and are leading in defining the configuration files.

Add a new configuration key

Follow these steps to add a new key to the configuration file. Make sure to run storybook by nx storybook sigmet-airmet to test the validations.

Note: Before being able to see your changes to the validation in storybook, ensure you compile the validation schemas as described in [tools/build-static-schemas/Readme.md](https://gitlab.com/opengeoweb/opengeoweb/-/tree/master/tools/build-static-schemas)

In this example, we're going to add a new property called my_new_config: an array with strings that is used by sigmet and airmet.

1. Since the new prop is used by both sigmet and airmet, we want to add it to the FIRArea typescript type. Inside libs/sigmet-airmet/src/lib/types.ts add the following:

export type FIRArea = {
  // ...rest of props
  units: AllowedUnits[];
  my_new_config: string[];
};

If you now run nx typecheck sigmet-airmet it will fail, and that's expected as we added a new required prop but we have not added it to our configs. We will fix this later

2. Add the new validation to the schema. This validation should check for an empty array and if the array is filled with a string. Inside tools/build-static-schemas/firArea.schema.json under properties register the new prop my_new_config property.

"my_new_config": {
  "type": "array",
  "items": {
    "type": "string"
  },
  "minItems": 1
}

2.1. Make the my_new_config prop also required by adding it to the required list:

"required": [
    // ...other,
    "units",
    "my_new_config"
  ],

2.2 Time to test out the validations. First airmet, go to http://localhost:4400/?path=/story/demo-airmet--airmet-dialog-demo. We expect there to be an error since you added a new required property but the story is still working. The same goes for sigmet http://localhost:4400/?path=/story/demo-sigmet--sigmet-dialog-demo. This is because we are merging the firArea scheme, but this overwrites the required list. To fix this, open tools/build-static-schemas/sigmet.schema.json and add my_new_config to the required prop in the fir_areas key. Do the same in tools/build-static-schemas/airmet.schema.json Afterwards an error should show for both.

"required": [
    // ...other,
    "units",
    "my_new_config"
  ],

3. Now we know the validations are working, it's time to add my_new_config to the configuration files. After this both stories of sigmet and airmet should work again without errors:

• inside libs/sigmet-airmet/src/lib/utils/config/sigmet.config.json add "my_new_config": ["test"]
• inside libs/sigmet-airmet/src/lib/utils/config/airmet.config.json add "my_new_config": ["test"]

4. Next fix the typescript errors. When running nx typecheck sigmet-airmet it will complain on missing props inside the libs/sigmet-airmet/src/lib/components/ProductForms/utils.spec.tsx test. Add the new config keys to config examples. After this typescript should be fixed. We will add tests later for this file when we want to use the new property.
5. In general we should test that the property is passed in, has the correct type and the correct minimum number of items. These tests should be added for both sigmet and airmet ensuring we don't break either of the modules in future. Add these tests in libs/sigmet-airmet/src/lib/utils/config/config.spec.ts.
6. Last but not least, don't forget to add the new keys in the config on the place where sigmet/airmet is used. In the case of opengeoweb, the config files are currently located in the assets folder in apps/geoweb/src/assets

Using a new configuration key

Every config key can be used throughout the aviationmodule. If you followed the previous steps we have a new property that is validated and can be used, but does not have any logic yet.

1. Create a new method inside libs/sigmet-airmet/src/lib/components/ProductForms/utils.tsx. This method should have the config as param to extract the value to use inside the code. Afterwards add the tests in libs/sigmet-airmet/src/lib/components/ProductForms/utils.spec.tsx.

export const getMyNewConfigTest = (
fir: string,
config: ProductConfig,
): string[] => {
const {
  my_new_config,
} = config.fir_areas[fir];

return my_new_config;
};

2. Decide on which component the configuration should be used. Let's take StartGeometry as example. This component needs a productConfig prop. Open the component and extend the props of the component with ConfigurableFormFieldProps like interface StartGeometryProps extends ConfigurableFormFieldProps and remove unneeded double props. The StartGeometry component is imported in [Sigmet/Airmet]Form, in these files pass the productConfig key. Afterwards you can use the prop inside StartGeometry like

const StartGeometry: React.FC<StartGeometryProps> = ({
  // other props
  setDrawModeType,
  productConfig
}: StartGeometryProps) => {
  const myConfigValues  = getMyNewConfigTest(productConfig)

3. After all is working add the unit tests and make sure typescript linting will pass again, as ConfigurableFormFieldProps makes sure you're not forgetting to pass the config.

Documentation

https://opengeoweb.gitlab.io/opengeoweb/docs/sigmet-airmet/