app feature list (#1079)

* metadata helpers and values for txs pages

* update titles to the rest of the pages

* refactor getServerSideProps

* dynamically update metadata for token and dapp page

* test

* 404 error page

* make new config

* make use of new config, delete old one

* feature reporter: dev implementation

* feature reporter: docker integration

* resctructure ENVS.md

* sentry feature

* refinements

* add spaces between sections

* tweaks

* switch to camelCase

* clean up

* remove NEXT_PUBLIC_NETWORK_TOKEN_ADDRESS

* v

.eslintrc.js

@@ -211,7 +211,7 @@ module.exports = {
       object: 'process',
       property: 'env',
       // FIXME: restrict the rule only NEXT_PUBLIC variables
-      message: 'Please use configs/app/config.ts to import any NEXT_PUBLIC environment variables. For other properties please disable this rule for a while.',
+      message: 'Please use configs/app/index.ts to import any NEXT_PUBLIC environment variables. For other properties please disable this rule for a while.',
     } ],
 
     'react/jsx-key': 'error',
@@ -289,7 +289,7 @@ module.exports = {
       },
     },
     {
-      files: [ 'configs/**/*.js', 'configs/**/*.ts', '*.config.ts', 'playwright/**/*.ts', 'deploy/tools/**/*.ts' ],
+      files: [ 'configs/**/*.js', 'configs/**/*.ts', '*.config.ts', 'playwright/**/*.ts', 'deploy/tools/**' ],
       rules: {
         // for configs allow to consume env variables from process.env directly
         'no-restricted-properties': [ 0 ],

Dockerfile

@@ -12,6 +12,14 @@ COPY package.json yarn.lock ./
 RUN apk add git
 RUN yarn --frozen-lockfile
 
+
+### FEATURE REPORTER
+# Install dependencies
+WORKDIR /feature-reporter
+COPY ./deploy/tools/feature-reporter/package.json ./deploy/tools/feature-reporter/yarn.lock ./
+RUN yarn --frozen-lockfile
+
+
 ### ENV VARIABLES CHECKER
 # Install dependencies
 WORKDIR /envs-validator
@@ -52,6 +60,13 @@ RUN ./make_envs_template.sh ./docs/ENVS.md
 RUN yarn build
 
 
+### FEATURE REPORTER
+# Copy dependencies and source code, then build
+COPY --from=deps /feature-reporter/node_modules ./deploy/tools/feature-reporter/node_modules
+RUN cd ./deploy/tools/feature-reporter && yarn compile_config
+RUN cd ./deploy/tools/feature-reporter &&  yarn build
+
+
 ### ENV VARIABLES CHECKER
 # Copy dependencies and source code, then build 
 WORKDIR /envs-validator
@@ -81,6 +96,7 @@ COPY --from=builder /app/next.config.js ./
 COPY --from=builder /app/public ./public
 COPY --from=builder /app/package.json ./package.json
 COPY --from=builder /envs-validator/index.js ./envs-validator.js
+COPY --from=builder /app/deploy/tools/feature-reporter/index.js ./feature-reporter.js
 
 # Copy scripts and ENVs file
 COPY --chmod=+x ./deploy/scripts/entrypoint.sh .

configs/app/api.ts

@@ -0,0 +1,23 @@
+import stripTrailingSlash from 'lib/stripTrailingSlash';
+
+import { getEnvValue } from './utils';
+
+const apiHost = getEnvValue(process.env.NEXT_PUBLIC_API_HOST);
+const apiSchema = getEnvValue(process.env.NEXT_PUBLIC_API_PROTOCOL) || 'https';
+const apiPort = getEnvValue(process.env.NEXT_PUBLIC_API_PORT);
+const apiEndpoint = [
+  apiSchema || 'https',
+  '://',
+  apiHost,
+  apiPort && ':' + apiPort,
+].filter(Boolean).join('');
+const socketSchema = getEnvValue(process.env.NEXT_PUBLIC_API_WEBSOCKET_PROTOCOL) || 'wss';
+
+const api = Object.freeze({
+  host: apiHost,
+  endpoint: apiEndpoint,
+  socket: `${ socketSchema }://${ apiHost }`,
+  basePath: stripTrailingSlash(getEnvValue(process.env.NEXT_PUBLIC_API_BASE_PATH) || ''),
+});
+
+export default api;

configs/app/app.ts

@@ -0,0 +1,23 @@
+import { getEnvValue } from './utils';
+
+const appPort = getEnvValue(process.env.NEXT_PUBLIC_APP_PORT);
+const appSchema = getEnvValue(process.env.NEXT_PUBLIC_APP_PROTOCOL);
+const appHost = getEnvValue(process.env.NEXT_PUBLIC_APP_HOST);
+const baseUrl = [
+  appSchema || 'https',
+  '://',
+  appHost,
+  appPort && ':' + appPort,
+].filter(Boolean).join('');
+const isDev = process.env.NODE_ENV === 'development';
+
+const app = Object.freeze({
+  isDev,
+  protocol: appSchema,
+  host: appHost,
+  port: appPort,
+  baseUrl,
+  useProxy: getEnvValue(process.env.NEXT_PUBLIC_USE_NEXT_JS_PROXY) === 'true',
+});
+
+export default app;

configs/app/chain.ts

@@ -0,0 +1,19 @@
+import { getEnvValue } from './utils';
+
+const DEFAULT_CURRENCY_DECIMALS = 18;
+
+const chain = Object.freeze({
+  id: getEnvValue(process.env.NEXT_PUBLIC_NETWORK_ID),
+  name: getEnvValue(process.env.NEXT_PUBLIC_NETWORK_NAME),
+  shortName: getEnvValue(process.env.NEXT_PUBLIC_NETWORK_SHORT_NAME),
+  currency: {
+    name: getEnvValue(process.env.NEXT_PUBLIC_NETWORK_CURRENCY_NAME),
+    symbol: getEnvValue(process.env.NEXT_PUBLIC_NETWORK_CURRENCY_SYMBOL),
+    decimals: Number(getEnvValue(process.env.NEXT_PUBLIC_NETWORK_CURRENCY_DECIMALS)) || DEFAULT_CURRENCY_DECIMALS,
+  },
+  rpcUrl: getEnvValue(process.env.NEXT_PUBLIC_NETWORK_RPC_URL),
+  isTestnet: getEnvValue(process.env.NEXT_PUBLIC_IS_TESTNET) === 'true',
+  verificationType: getEnvValue(process.env.NEXT_PUBLIC_NETWORK_VERIFICATION_TYPE) || 'mining',
+});
+
+export default chain;

configs/app/features/account.ts

@@ -0,0 +1,33 @@
+import stripTrailingSlash from 'lib/stripTrailingSlash';
+
+import app from '../app';
+import { getEnvValue } from '../utils';
+
+const authUrl = stripTrailingSlash(getEnvValue(process.env.NEXT_PUBLIC_AUTH_URL) || app.baseUrl);
+
+const logoutUrl = (() => {
+  try {
+    const envUrl = getEnvValue(process.env.NEXT_PUBLIC_LOGOUT_URL);
+    const auth0ClientId = getEnvValue(process.env.NEXT_PUBLIC_AUTH0_CLIENT_ID);
+    const returnUrl = authUrl + '/auth/logout';
+
+    if (!envUrl || !auth0ClientId) {
+      throw Error();
+    }
+
+    const url = new URL(envUrl);
+    url.searchParams.set('client_id', auth0ClientId);
+    url.searchParams.set('returnTo', returnUrl);
+
+    return url.toString();
+  } catch (error) {
+    return;
+  }
+})();
+
+export default Object.freeze({
+  title: 'My account',
+  isEnabled: getEnvValue(process.env.NEXT_PUBLIC_IS_ACCOUNT_SUPPORTED) === 'true',
+  authUrl,
+  logoutUrl,
+});

configs/app/features/addressVerification.ts

@@ -0,0 +1,14 @@
+import { getEnvValue } from '../utils';
+import account from './account';
+import verifiedTokens from './verifiedTokens';
+
+const adminServiceApiHost = getEnvValue(process.env.NEXT_PUBLIC_ADMIN_SERVICE_API_HOST);
+
+export default Object.freeze({
+  title: 'Address verification in "My account"',
+  isEnabled: account.isEnabled && verifiedTokens.isEnabled && Boolean(adminServiceApiHost),
+  api: {
+    endpoint: adminServiceApiHost,
+    basePath: '',
+  },
+});