etquia/packages/proto-loader/src/util.ts

Dummy package for the grpc-node repository

/**
 * @license
 * Copyright 2018 gRPC authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

import * as fs from 'fs';
import * as path from 'path';
import * as Protobuf from 'protobufjs';

function addIncludePathResolver(root: Protobuf.Root, includePaths: string[]) {
  const originalResolvePath = root.resolvePath;
  root.resolvePath = (origin: string, target: string) => {
    if (path.isAbsolute(target)) {
      return target;
    }
    for (const directory of includePaths) {
      const fullPath: string = path.join(directory, target);
      try {
        fs.accessSync(fullPath, fs.constants.R_OK);
        return fullPath;
      } catch (err) {
        continue;
      }
    }
    process.emitWarning(`${target} not found in any of the include paths ${includePaths}`);
    return originalResolvePath(origin, target);
  };
}

export type Options = Protobuf.IParseOptions &
  Protobuf.IConversionOptions & {
    includeDirs?: string[];
  };

export async function loadProtosWithOptions(
  filename: string | string[],
  options?: Options
): Promise<Protobuf.Root> {
  const root: Protobuf.Root = new Protobuf.Root();
  options = options || {};
  if (!!options.includeDirs) {
    if (!Array.isArray(options.includeDirs)) {
      return Promise.reject(
        new Error('The includeDirs option must be an array')
      );
    }
    addIncludePathResolver(root, options.includeDirs as string[]);
  }
  const loadedRoot = await root.load(filename, options);
  loadedRoot.resolveAll();
  return loadedRoot;
}

export function loadProtosWithOptionsSync(
  filename: string | string[],
  options?: Options
): Protobuf.Root {
  const root: Protobuf.Root = new Protobuf.Root();
  options = options || {};
  if (!!options.includeDirs) {
    if (!Array.isArray(options.includeDirs)) {
      throw new Error('The includeDirs option must be an array');
    }
    addIncludePathResolver(root, options.includeDirs as string[]);
  }
  const loadedRoot = root.loadSync(filename, options);
  loadedRoot.resolveAll();
  return loadedRoot;
}

/**
 * Load Google's well-known proto files that aren't exposed by Protobuf.js.
 */
export function addCommonProtos(): void {
  // Protobuf.js exposes: any, duration, empty, field_mask, struct, timestamp,
  // and wrappers. compiler/plugin is excluded in Protobuf.js and here.

  // Using constant strings for compatibility with tools like Webpack
  const apiDescriptor = require('protobufjs/google/protobuf/api.json');
  const descriptorDescriptor = require('protobufjs/google/protobuf/descriptor.json');
  const sourceContextDescriptor = require('protobufjs/google/protobuf/source_context.json');
  const typeDescriptor = require('protobufjs/google/protobuf/type.json');

  Protobuf.common(
    'api',
    apiDescriptor.nested.google.nested.protobuf.nested
  );
  Protobuf.common(
    'descriptor',
    descriptorDescriptor.nested.google.nested.protobuf.nested
  );
  Protobuf.common(
    'source_context',
    sourceContextDescriptor.nested.google.nested.protobuf.nested
  );
  Protobuf.common(
    'type',
    typeDescriptor.nested.google.nested.protobuf.nested
  );
}