@corva/create-app 0.50.0-1 → 0.50.0-3

package/templates/ui/javascript/src/__mocks__/mockAppSettingsProps.js

@@ -0,0 +1,290 @@
+/**
+ * This is a real example of the props that'll come
+ * to the AppSettings component. You'll need to manually update it
+ * if in the future some new properties are added
+ */
+
+export const mockAppSettingsProps = {
+  onSettingChange: jest.fn(),
+  onSettingsChange: jest.fn(),
+  app: {
+    id: -1,
+    app: {
+      app_key: 'company.app_key.ui',
+      platform: 'dev_center',
+    },
+    settings: {
+      package: '0.1.0',
+      rigId: 1,
+      wellId: 2,
+      isExampleCheckboxChecked: true,
+    },
+    package: {
+      manifest: {
+        format: 1,
+        license: {
+          type: 'MIT',
+          url: 'https://www.oandgexample.com/license/',
+        },
+        developer: {
+          name: 'Company Name',
+          identifier: 'companyIdentifier',
+          authors: [],
+        },
+        application: {
+          type: 'ui',
+          key: 'company.app_key.ui',
+          visibility: 'private',
+          name: 'dev center app name',
+          description: 'This is the description of my app. You can do great things with it!',
+          summary: 'More information about this app goes here',
+          category: 'analytics',
+          website: 'https://www.oandgexample.com/my-app/',
+          segments: ['drilling', 'completion'],
+          ui: {
+            initial_size: {
+              w: 4,
+              h: 10,
+            },
+          },
+        },
+        settings: {
+          entrypoint: {
+            file: 'src/index.js',
+            function: 'handler',
+          },
+          environment: {},
+          runtime: 'ui',
+          app: {
+            scheduler_type: 1,
+            cron_string: '*/5 * * * *',
+          },
+        },
+        datasets: {},
+      },
+      build: 'company.app_key.ui-0.1.0',
+      version: '0.1.0',
+    },
+  },
+  appData: {
+    id: -1,
+    rig: {
+      name: 'Test Rig Name',
+      id: '1',
+      asset_id: 3,
+    },
+    well: {
+      name: 'Test Well Name',
+      settings: {
+        basin: 'Test Basin Name',
+        county: 'Pecos',
+        timezone: 'America/Chicago',
+        top_hole: {
+          raw: '50.123456,-102.865431',
+          coordinates: [50.123456, -102.865431],
+        },
+        api_number: '12-345-67689',
+        bottom_hole: {},
+        mud_company: 'Mud Company Name',
+        spud_release: [
+          {
+            id: '1111111111-2222-3a3a-4b4b-afc5c7c8f245',
+            spud: '01/08/2023 00:46',
+            rig_up: '01/08/2023 00:10',
+            release: '',
+          },
+        ],
+        string_design: '5',
+        contractor_name: 'Test Contractor Name',
+        target_formation: 'Test Traget Formation',
+        last_mongo_refresh: '2023-02-24T16:16:06.383Z',
+        rig_classification: 'land',
+        directional_driller: 'Test Directional Driller',
+        drilling_afe_number: 'AB12356',
+        day_shift_start_time: '06:00',
+        off_bottom_tolerance: 1,
+        target_formation_standard: 'Test Traget Formation',
+        completion_day_shift_start_time: '06:00',
+        associations_last_active_at_updated_at: '2023-02-24T16:15:40.000Z',
+      },
+      asset_id: 4,
+      last_active_at: '2023-02-24T16:20:29.000Z',
+      id: '2',
+      companyId: '6',
+    },
+    fracFleet: null,
+    wells: null,
+    isLoading: false,
+    appHash: '-1-2-1-NaN-NaN-NaN',
+  },
+  settings: {
+    package: '0.1.0',
+    rigId: 1,
+    wellId: 2,
+    isExampleCheckboxChecked: true,
+  },
+  layoutEnvironment: {
+    type: 'general',
+    pdfReportMode: false,
+  },
+  currentUser: {
+    id: 1,
+    company_id: 3,
+    first_name: 'John',
+    last_name: 'Doe',
+    email: 'john.doe@company.ai',
+    mobile: '',
+    created_at: '2020-11-03T08:42:53.161Z',
+    terms_acceptance_at: '2021-10-20T13:28:6.385Z',
+    profile_photo: null,
+    recently_viewed_asset_ids: [64],
+    unit_system: null,
+    role: 'user',
+    title: null,
+    group: null,
+    favorite_asset_id: null,
+    current_segment: null,
+    theme: 'dark',
+    messaging_id: '1',
+    restricted_assets: [],
+    restricted_programs: [],
+    settings: {
+      favorites: {},
+      sms_blacklisted: false,
+      restricted_assets: [],
+      restricted_programs: [],
+      participates_in_beta_apps: false,
+      last_new_dashboard_shares_check: '2021-11-24T18:57:13.679Z',
+    },
+    last_sign_in_at: '2023-02-23T10:19:06.349Z',
+    locked_access: false,
+    unit_ids: [],
+    intercom_admin_id: null,
+    resource: [],
+    intercom_user_hash: 'intercom_user_hash',
+    profile_groups: [],
+    preference: {
+      id: 6,
+      user: {
+        id: 1,
+        company_id: 3,
+        first_name: 'John',
+        last_name: 'Doe',
+        email: 'john.doe@company.ai',
+        role: 'user',
+        created_at: '2020-11-03T08:42:53.161Z',
+        updated_at: '2023-02-23T12:26:46.835Z',
+        recently_viewed_asset_ids: [64],
+        unit_system: null,
+        mobile: '',
+        terms_acceptance_at: '2021-10-20T13:28:6.385Z',
+        messaging_id: '1',
+        settings: {
+          favorites: {},
+          sms_blacklisted: false,
+          restricted_assets: [],
+          restricted_programs: [],
+          participates_in_beta_apps: false,
+          last_new_dashboard_shares_check: '2021-11-24T18:57:13.679Z',
+        },
+        theme: 'dark',
+        title: null,
+        group: null,
+        profile_photo: null,
+        favorite_asset_id: null,
+        current_segment: null,
+        state: 'active',
+        created_by: null,
+        provisioner: 'internal',
+        intercom_admin_id: null,
+        resource: [],
+      },
+      push_notifications_enabled: true,
+      emails_enabled: true,
+      sms_enabled: true,
+      alert_levels: ['info', 'warning', 'critical'],
+      play_alerts_sound: true,
+      show_intercom_icon: true,
+      segment: ['drilling', 'completion'],
+      disable_create_dashboard: false,
+      disable_costs: false,
+      disable_documents: false,
+      realtime_operation_mode: false,
+      disable_file_upload: false,
+      stay_on_app_store: false,
+    },
+    company: {
+      id: 3,
+      name: 'Test Company Name',
+      time_zone: 'America/Chicago',
+      language: 'en',
+      provider: 'company',
+      unit_system: {
+        yp: 'hsf',
+        oil: 'bbl',
+        area: 'ft2',
+        mass: 'lb',
+        time: 'min',
+        angle: 'deg',
+        force: 'klbf',
+        power: 'hp',
+        speed: 'ft/min',
+        length: 'm',
+        system: 'imperial',
+        torque: 'ft-klbf',
+        volume: 'gal',
+        current: 'mA',
+        density: 'ppg',
+        gravity: 'g',
+        voltage: 'mV',
+        porosity: 'pu',
+        pressure: 'psi',
+        velocity: 'ft/min',
+        gasVolume: 'Mscf',
+        gravityRMS: 'gRMS',
+        msePressure: 'ksi',
+        oilFlowRate: 'bbl/min',
+        resistivity: 'ohmm',
+        shortLength: 'in',
+        temperature: 'F',
+        massFlowRate: 'lb/min',
+        permiability: 'md',
+        concentration: 'ppm',
+        fluidVelocity: 'ft/min',
+        massPerLength: 'lb-ft',
+        anglePerLength: 'dp100f',
+        lengthPerAngle: 'in/rev',
+        volumeFlowRate: 'gal/min',
+        angularVelocity: 'rpm',
+        inversePressure: 'i-psi',
+        acousticSlowness: 'us/ft',
+        formationDensity: 'g/l',
+        gasConcentration: 'Units (0-5000u)',
+        pressureGradient: 'psi/ft',
+        massConcentration: 'lb/gal',
+        revolutionPerVolume: 'rpg',
+        spontaneousPotential: 'mV',
+        chemMassConcentration: 'lb/Mgal',
+        chemVolumeConcentration: 'gal/Mgal',
+      },
+      dev_center_enabled: true,
+      workflows_enabled: true,
+      with_subscription: false,
+      competitor_analysis_enabled: true,
+    },
+    groups: [
+      {
+        id: 5,
+        name: 'user',
+        company_id: 3,
+      },
+      {
+        id: 9,
+        name: 'customGroup',
+        company_id: 3,
+      },
+    ],
+  },
+  user: {},
+  company: {},
+};

package/templates/ui/javascript/src/__tests__/App.test.js

@@ -0,0 +1,21 @@
+import { render, screen } from '@testing-library/react';
+
+import App from '../App';
+import { mockAppProps } from '../__mocks__/mockAppProps';
+
+describe('<App />', () => {
+  it('should show correct layout', () => {
+    render(<App {...mockAppProps} />);
+
+    screen.getByText(/checked/i);
+  });
+
+  it('should show correct layout when settings are not provided', () => {
+    const propsWithoutSettings = mockAppProps;
+    delete propsWithoutSettings.isExampleCheckboxChecked;
+
+    render(<App {...propsWithoutSettings} />);
+
+    screen.getByText(/unchecked/i);
+  });
+});

package/templates/ui/javascript/src/__tests__/AppSettings.test.js

@@ -0,0 +1,21 @@
+import { render, screen, act } from '@testing-library/react';
+import userEvent from '@testing-library/user-event';
+
+import AppSettings from '../AppSettings';
+import { mockAppSettingsProps } from '../__mocks__/mockAppSettingsProps';
+
+describe('<AppSettings />', () => {
+  it('should call onChange with a changed setting on settings change', async () => {
+    const handleSettingsChange = jest.fn();
+
+    render(<AppSettings {...mockAppSettingsProps} onSettingChange={handleSettingsChange} />);
+
+    const exampleCheckbox = screen.getByTestId('exampleCheckbox').querySelector('input');
+
+    await act(async () => {
+      await userEvent.click(exampleCheckbox);
+    });
+
+    expect(handleSettingsChange).toBeCalledWith('isExampleCheckboxChecked', false);
+  });
+});

package/templates/ui/javascript/src/__tests__/TestsExample.test.js

@@ -0,0 +1,37 @@
+import { useState } from 'react';
+import { render, screen, waitFor } from '@testing-library/react';
+import { components } from '@corva/ui';
+import userEvent from '@testing-library/user-event';
+
+const Toggle = () => {
+  const [isOn, setIsOn] = useState(false);
+
+  return (
+    <>
+      {isOn ? 'ON' : 'OFF'}
+      <components.Button onClick={() => setIsOn(value => !value)}>toggle</components.Button>
+    </>
+  );
+};
+
+describe('Tests examples', () => {
+  it('should use UTC timezone by default to not depend on the environment timezone', () => {
+    expect(Intl.DateTimeFormat().resolvedOptions().timeZone).toBe('UTC');
+  });
+
+  describe('<Toggle />', () => {
+    it('should be OFF by default', () => {
+      render(<Toggle />);
+
+      expect(screen.getByText('OFF')).toBeInTheDocument();
+    });
+
+    it('should switch to ON after a single press', async () => {
+      render(<Toggle />);
+
+      userEvent.click(screen.getByText('toggle'));
+
+      await waitFor(() => screen.getByText('ON'));
+    });
+  });
+});

package/templates/ui/typescript/config/jest/babelTransform.js

@@ -0,0 +1,16 @@
+/* eslint-disable */
+
+const babelJest = require('babel-jest').default;
+
+module.exports = babelJest.createTransformer({
+  presets: [
+    [
+      require.resolve('babel-preset-react-app'),
+      {
+        runtime: 'automatic',
+      },
+    ],
+  ],
+  babelrc: false,
+  configFile: false,
+});

package/templates/ui/typescript/config/jest/cssTransform.js

@@ -0,0 +1,16 @@
+/* eslint-disable */
+
+// This is a custom Jest transformer turning style imports into empty objects.
+// http://facebook.github.io/jest/docs/en/webpack.html
+
+module.exports = {
+  process() {
+    return {
+      code: 'module.exports = {};',
+    };
+  },
+  getCacheKey() {
+    // The output is always the same.
+    return 'cssTransform';
+  },
+};

package/templates/ui/typescript/config/jest/fileTransform.js

@@ -0,0 +1,48 @@
+/* eslint-disable */
+
+const path = require('path');
+
+// This is a custom Jest transformer turning file imports into filenames.
+// http://facebook.github.io/jest/docs/en/webpack.html
+
+const toPascalCase = str => {
+  const allWordsIterator = str.matchAll(/\w+/g);
+
+  return Array.from(allWordsIterator).reduce((acc, matchResult) => {
+    const word = matchResult[0];
+    return acc + word[0].toUpperCase() + word.slice(1).toLowerCase();
+  }, '');
+};
+
+module.exports = {
+  process(src, filename) {
+    const assetFilename = JSON.stringify(path.basename(filename));
+
+    if (filename.match(/\.svg$/)) {
+      // Based on how SVGR generates a component name:
+      // https://github.com/smooth-code/svgr/blob/01b194cf967347d43d4cbe6b434404731b87cf27/packages/core/src/state.js#L6
+      const pascalCaseFilename = toPascalCase(path.parse(filename).name);
+      const componentName = `Svg${pascalCaseFilename}`;
+      return {
+        code: `const React = require('react');
+        module.exports = {
+          __esModule: true,
+          default: ${assetFilename},
+          ReactComponent: React.forwardRef(function ${componentName}(props, ref) {
+            return {
+              $$typeof: Symbol.for('react.element'),
+              type: 'svg',
+              ref: ref,
+              key: null,
+              props: Object.assign({}, props, {
+                children: ${assetFilename}
+              })
+            };
+          }),
+        };`,
+      };
+    }
+
+    return { code: `module.exports = ${assetFilename};` };
+  },
+};

package/templates/ui/typescript/config/jest/globalSetup.js

@@ -0,0 +1,5 @@
+module.exports = async () => {
+  // use UTC timezone to not break tests when you run them on
+  // an environemnt with a different timezone
+  process.env.TZ = 'UTC';
+};

package/templates/ui/typescript/config/jest/setupTests.js

@@ -0,0 +1,11 @@
+/* eslint-disable */
+
+// jest-dom adds custom jest matchers for asserting on DOM nodes.
+// allows you to do things like:
+// expect(element).toHaveTextContent(/react/i)
+// learn more: https://github.com/testing-library/jest-dom
+// eslint-disable-next-line
+import '@testing-library/jest-dom/extend-expect';
+
+// Set UTC timezone for tests to not use the environment timezone
+process.env.TZ = 'UTC';

package/templates/ui/typescript/gitignore

@@ -10,6 +10,7 @@
 
 # production
 /build
+/dist
 
 # misc
 .env
@@ -23,3 +24,4 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+.eslintcache

package/templates/ui/typescript/src/App.tsx

@@ -1,8 +1,8 @@
 import { AppHeader } from '@corva/ui/components';
 
 import { DEFAULT_SETTINGS } from './constants';
-
 import logo from './assets/logo.svg';
+
 import styles from './App.css';
 
 type AppProps = {

package/templates/ui/typescript/src/AppSettings.tsx

@@ -23,6 +23,7 @@ const AppSettings = (props: AppSettingsProps): JSX.Element => {
         label="Example checkbox"
         control={
           <Checkbox
+            data-testid="exampleCheckbox"
             checked={settings.isExampleCheckboxChecked}
             onChange={e => onSettingChange('isExampleCheckboxChecked', e.target.checked)}
           />